1 /* SPDX-License-Identifier: BSD-3-Clause */
2 /* Copyright(c) 2007-2022 Intel Corporation */
3 /**
4  ***************************************************************************
5  * @file lac_sal_ctrl.h
6  *
7  * @ingroup SalCtrl
8  *
9  * Functions to register and deregister qat and service controllers with ADF.
10  *
11  ***************************************************************************/
12 
13 #ifndef LAC_SAL_CTRL_H
14 #define LAC_SAL_CTRL_H
15 
16 /*******************************************************************
17  * @ingroup SalCtrl
18  * @description
19  *    This function is used to check whether the service component
20  *    has been successfully started.
21  *
22  * @context
23  *      This function is called from the icp_sal_userStart() function.
24  *
25  * @assumptions
26  *      None
27  * @sideEffects
28  *      None
29  * @reentrant
30  *      No
31  * @threadSafe
32  *      Yes
33  *
34  ******************************************************************/
35 
36 CpaStatus SalCtrl_AdfServicesStartedCheck(void);
37 
38 /*******************************************************************
39  * @ingroup SalCtrl
40  * @description
41  *    This function is used to check whether the user's parameter
42  *    for concurrent request is valid.
43  *
44  * @context
45  *      This function is called when crypto or compression is init
46  *
47  * @assumptions
48  *      None
49  * @sideEffects
50  *      None
51  * @reentrant
52  *      Yes
53  * @threadSafe
54  *      Yes
55  *
56  ******************************************************************/
57 CpaStatus validateConcurrRequest(Cpa32U numConcurrRequests);
58 
59 /*******************************************************************
60  * @ingroup SalCtrl
61  * @description
62  *    This function is used to register adf services
63  *
64  * @context
65  *      This function is called from do_userStart() function
66  *
67  * @assumptions
68  *      None
69  * @sideEffects
70  *      None
71  * @reentrant
72  *      Yes
73  * @threadSafe
74  *      Yes
75  *
76  ******************************************************************/
77 CpaStatus SalCtrl_AdfServicesRegister(void);
78 
79 /*******************************************************************
80  * @ingroup SalCtrl
81  * @description
82  *    This function is used to unregister adf services.
83  *
84  * @context
85  *      This function is called from do_userStart() function
86  *
87  * @assumptions
88  *      None
89  * @sideEffects
90  *      None
91  * @reentrant
92  *      Yes
93  * @threadSafe
94  *      Yes
95  *
96  ******************************************************************/
97 CpaStatus SalCtrl_AdfServicesUnregister(void);
98 
99 #endif
100