FreeBSD/Linux Kernel Cross Reference
sys/dev/qat/qat_api/qat_direct/include/icp_adf_init.h

     /* SPDX-License-Identifier: BSD-3-Clause */
     /* Copyright(c) 2007-2022 Intel Corporation */
     /* $FreeBSD$ */
     /*****************************************************************************
      * @file icp_adf_init.h
      *
      * @description
      *      This file contains the function prototype used to register a subsystem
      *      into the Acceleration Driver Framework (ADF).
     *
     *****************************************************************************/
    #ifndef ICP_ADF_INIT_H
    #define ICP_ADF_INIT_H
    
    #include "icp_accel_devices.h"
    #include "adf_kernel_types.h"
    #include "adf_cfg_common.h"
    
    /*
     * Events that will be sending to subsystem. The order of the enum
     * declaration matters. It should be defined so that the messages can be
     * sent in loop.
     */
    typedef enum icp_adf_subsystemEvent_s {
            ICP_ADF_EVENT_INIT = 0,
            ICP_ADF_EVENT_START,
            ICP_ADF_EVENT_STOP,
            ICP_ADF_EVENT_SHUTDOWN,
            ICP_ADF_EVENT_RESTARING,
            ICP_ADF_EVENT_RESTARTED,
            ICP_ADF_EVENT_ERROR,
            ICP_ADF_EVENT_END
    } icp_adf_subsystemEvent_t;
    
    /*
     * Ring info operation used to enable or disable ring polling by ME
     */
    typedef enum icp_adf_ringInfoOperation_e {
            ICP_ADF_RING_ENABLE = 0,
            ICP_ADF_RING_DISABLE
    } icp_adf_ringInfoOperation_t;
    
    /*
     * Ring generic serivce info private data
     */
    typedef enum icp_adf_ringInfoService_e {
            ICP_ADF_RING_SERVICE_0 = 0,
            ICP_ADF_RING_SERVICE_1,
            ICP_ADF_RING_SERVICE_2,
            ICP_ADF_RING_SERVICE_3,
            ICP_ADF_RING_SERVICE_4,
            ICP_ADF_RING_SERVICE_5,
            ICP_ADF_RING_SERVICE_6,
            ICP_ADF_RING_SERVICE_7,
            ICP_ADF_RING_SERVICE_8,
            ICP_ADF_RING_SERVICE_9,
            ICP_ADF_RING_SERVICE_10,
    } icp_adf_ringInfoService_t;
    
    /*
     * Ring info callback. Function is used to send operation and ring info
     * to enable or disable ring polling by ME
     */
    typedef CpaStatus (*ringInfoCb)(icp_accel_dev_t *accel_dev,
                                    Cpa32U ringNumber,
                                    icp_adf_ringInfoOperation_t operation,
                                    icp_adf_ringInfoService_t info);
    
    /*
     * Registration handle structure
     * Each subservice has to have an instance of it.
     */
    typedef struct subservice_registation_handle_s {
            CpaStatus (*subserviceEventHandler)(icp_accel_dev_t *accel_dev,
                                                icp_adf_subsystemEvent_t event,
                                                void *param);
            struct {
                    Cpa32U subsystemInitBit : 1;
                    Cpa32U subsystemStartBit : 1;
                    Cpa32U subsystemFailedBit : 1;
            } subsystemStatus[ADF_MAX_DEVICES];
            char *subsystem_name;
            struct subservice_registation_handle_s *pNext;
            struct subservice_registation_handle_s *pPrev;
    } subservice_registation_handle_t;
    
    /*
     * icp_adf_subsystemRegister
     *
     * Description:
     *  Function used by subsystem to register within ADF
     *  Should be called during insertion of a subsystem
     *
     * Returns:
     *   CPA_STATUS_SUCCESS   on success
     *   CPA_STATUS_FAIL      on failure
     */
    CpaStatus icp_adf_subsystemRegister(subservice_registation_handle_t *handle);
    
   /*
    * icp_adf_subsystemUnregister
    *
    * Description:
    *  Function used by subsystem to unregister from ADF
    *  Should be called while subsystem in removed
    *  If the subsystem is initialised and/or started
    *  it will be stopped and shutdown by this function
    *
    * Returns:
    *   CPA_STATUS_SUCCESS   on success
    *   CPA_STATUS_FAIL      on failure
    */
   CpaStatus icp_adf_subsystemUnregister(subservice_registation_handle_t *handle);
   
   /*
    * icp_adf_accesLayerRingInfoCbRegister
    *
    * Description:
    *  Function register access layer callback, which sends ring info message
    *
    * Returns:
    *   CPA_STATUS_SUCCESS   on success
    *   CPA_STATUS_FAIL      on failure
    */
   CpaStatus icp_adf_accesLayerRingInfoCbRegister(icp_accel_dev_t *accel_dev,
                                                  ringInfoCb);
   
   /*
    * icp_adf_accesLayerRingInfoCbUnregister
    *
    * Description:
    *  Function unregister access layer callback for ring info message
    *
    * Returns:
    *   CPA_STATUS_SUCCESS   on success
    *   CPA_STATUS_FAIL      on failure
    */
   void icp_adf_accesLayerRingInfoCbUnregister(icp_accel_dev_t *accel_dev);
   
   /*
    * icp_adf_isSubsystemStarted
    *
    * Description:
    * Function returns true if the service is started on a device
    *
    * Returns:
    *   CPA_TRUE   if subsystem is started
    *   CPA_FALSE  if subsystem is not started
    */
   
   CpaBoolean
   icp_adf_isSubsystemStarted(subservice_registation_handle_t *subsystem_hdl);
   
   /*
    * icp_adf_isDevStarted
    *
    * Description:
    * Function returns true if the device is started
    * Returns:
    *   CPA_TRUE   if dev is started
    *   CPA_FALSE  if dev is not started
    */
   CpaBoolean icp_adf_isDevStarted(icp_accel_dev_t *accel_dev);
   
   /*
    * adf_subsystemRestarting
    *
    * Description:
    * Function sends restarting event to all subsystems.
    * This function should be used by error handling function only
    *
    * Returns:
    *   CPA_TRUE   on success
    *   CPA_FALSE  on failure
    */
   CpaStatus adf_subsystemRestarting(icp_accel_dev_t *accel_dev);
   
   /*
    * adf_subsystemRestarted
    *
    * Description:
    * Function sends restarted event to all subsystems.
    * This function should be used by error handling function only
    *
    * Returns:
    *   CPA_TRUE   on success
    *   CPA_FALSE  on failure
    */
   CpaStatus adf_subsystemRestarted(icp_accel_dev_t *accel_dev);
   
   /*
    * adf_subsystemError
    *
    * Description:
    * Function sends error event to all subsystems.
    * This function should be used by error handling funct. only
    *
    * Returns:
    *   CPA_STATUS_SUCCESS   on success
    *   CPA_STATUS_FAIL      on failure
    */
   CpaStatus adf_subsystemError(icp_accel_dev_t *accel_dev);
   
   /*
    * reset_adf_subsystemTable
    *
    * Description:
    * Function to reset subsystem table head, the pointer
    * to the head of the list and lock.
    *
    * Returns: void
    */
   void reset_adf_subsystemTable(void);
   
   #endif /* ICP_ADF_INIT_H */

Cache object: c6f63de5c6570a45d2447c957f24bae5