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