1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
|
/* SPDX-License-Identifier: BSD-3-Clause */
/* Copyright(c) 2007-2022 Intel Corporation */
/**
***************************************************************************
* @file icp_sal_poll.h
*
* @defgroup SalPoll
*
* @ingroup SalPoll
*
* @description
* Polling APIs for instance polling.
* These functions retrieve requests on appropriate response rings and
* dispatch the associated callbacks. Callbacks are called in the
* context of the polling function itself.
*
*
***************************************************************************/
#ifndef ICP_SAL_POLL_H
#define ICP_SAL_POLL_H
/*************************************************************************
* @ingroup SalPoll
* @description
* Poll a Cy logical instance to retrieve requests that are on the
* response rings associated with that instance and dispatch the
* associated callbacks.
*
* @context
* This functions is called from both the user and kernel context
*
* @assumptions
* None
* @sideEffects
* None
* @reentrant
* No
* @threadSafe
* Yes
*
* @param[in] instanceHandle Instance handle.
* @param[in] response_quota The maximum number of messages that
* will be read in one polling. Setting
* the response quota to zero means that
* all messages on the ring will be read.
*
* @retval CPA_STATUS_SUCCESS Successfully polled a ring with data
* @retval CPA_STATUS_RETRY There are no responses on the rings
* associated with this instance
* @retval CPA_STATUS_FAIL Indicates a failure
*************************************************************************/
CpaStatus icp_sal_CyPollInstance(CpaInstanceHandle instanceHandle,
Cpa32U response_quota);
/*************************************************************************
* @ingroup SalPoll
* @description
* Poll a Sym Cy ring to retrieve requests that are on the
* response rings associated with that instance and dispatch the
* associated callbacks.
*
* @context
* This functions is called from both the user and kernel context
*
* @assumptions
* None
* @sideEffects
* None
* @reentrant
* No
* @threadSafe
* Yes
*
* @param[in] instanceHandle Instance handle.
* @param[in] response_quota The maximum number of messages that
* will be read in one polling. Setting
* the response quota to zero means that
* all messages on the ring will be read.
*
* @retval CPA_STATUS_SUCCESS Successfully polled a ring with data
* @retval CPA_STATUS_RETRY There are no responses on the rings
* associated with this instance
* @retval CPA_STATUS_FAIL Indicates a failure
*************************************************************************/
CpaStatus icp_sal_CyPollSymRing(CpaInstanceHandle instanceHandle,
Cpa32U response_quota);
/*************************************************************************
* @ingroup SalPoll
* @description
* Poll an Asym Cy ring to retrieve requests that are on the
* response rings associated with that instance and dispatch the
* associated callbacks.
*
* @context
* This functions is called from both the user and kernel context
*
* @assumptions
* None
* @sideEffects
* None
* @reentrant
* No
* @threadSafe
* Yes
*
* @param[in] instanceHandle Instance handle.
* @param[in] response_quota The maximum number of messages that
* will be read in one polling. Setting
* the response quota to zero means that
* all messages on the ring will be read.
*
* @retval CPA_STATUS_SUCCESS Successfully polled a ring with data
* @retval CPA_STATUS_RETRY There are no responses on the rings
* associated with this instance
* @retval CPA_STATUS_FAIL Indicates a failure
*************************************************************************/
CpaStatus icp_sal_CyPollAsymRing(CpaInstanceHandle instanceHandle,
Cpa32U response_quota);
/*************************************************************************
* @ingroup SalPoll
* @description
* Poll a Cy NRBG ring to retrieve requests that are on the
* response rings associated with that instance and dispatch the
* associated callbacks.
*
* @context
* This functions is called from both the user and kernel context
*
* @assumptions
* None
* @sideEffects
* None
* @reentrant
* No
* @threadSafe
* Yes
*
* @param[in] instanceHandle Instance handle.
* @param[in] response_quota The maximum number of messages that
* will be read in one polling. Setting
* the response quota to zero means that
* all messages on the ring will be read.
*
* @retval CPA_STATUS_SUCCESS Successfully polled a ring with data
* @retval CPA_STATUS_RETRY There are no responses on the rings
* associated with this instance
* @retval CPA_STATUS_FAIL Indicates a failure
*************************************************************************/
CpaStatus icp_sal_CyPollNRBGRing(CpaInstanceHandle instanceHandle,
Cpa32U response_quota);
/*************************************************************************
* @ingroup SalPoll
* @description
* Poll the high priority symmetric response ring associated with a Cy
* logical instance to retrieve requests and dispatch the
* associated callbacks.
*
* This API is recommended for data plane applications, in which the
* cost of offload - that is, the cycles consumed by the driver in
* sending requests to the hardware, and processing responses - needs
* to be minimized. In particular, use of this API is recommended
* if the following constraints are acceptable to your application:
*
* - Thread safety is not guaranteed. Each software thread should
* have access to its own unique instance (CpaInstanceHandle) to
* avoid contention.
* - The "default" instance (@ref CPA_INSTANCE_HANDLE_SINGLE) is not
* supported on this API. The specific handle should be obtained
* using the instance discovery functions (@ref cpaCyGetNumInstances,
* @ref cpaCyGetInstances).
*
* This polling function should be used with the functions described
* in cpa_cy_sym_dp.h
*
* @context
* This functions is called from both the user and kernel context
*
* @assumptions
* None
* @sideEffects
* None
* @reentrant
* No
* @threadSafe
* No
*
* @param[in] instanceHandle Instance handle.
* @param[in] response_quota The maximum number of messages that
* will be read in one polling. Setting
* the response quota to zero means that
* all messages on the ring will be read.
*
* @retval CPA_STATUS_SUCCESS Successfully polled a ring with data
* @retval CPA_STATUS_RETRY There are no responses on the ring
* associated with this instance
* @retval CPA_STATUS_FAIL Indicates a failure
*************************************************************************/
CpaStatus icp_sal_CyPollDpInstance(const CpaInstanceHandle instanceHandle,
const Cpa32U response_quota);
/*************************************************************************
* @ingroup SalPoll
* @description
* Poll a Dc logical instance to retrieve requests that are on the
* response ring associated with that instance and dispatch the
* associated callbacks.
*
* @context
* This function is called from both the user and kernel context
*
* @assumptions
* None
* @sideEffects
* None
* @reentrant
* No
* @threadSafe
* Yes
*
* @param[in] instanceHandle Instance handle.
* @param[in] response_quota The maximum number of messages that
* will be read in one polling. Setting
* the response quota to zero means that
* all messages on the ring will be read.
*
* @retval CPA_STATUS_SUCCESS Successfully polled a ring with data
* @retval CPA_STATUS_RETRY There are no responses on the ring
* associated with this instance
* @retval CPA_STATUS_FAIL Indicates a failure
*************************************************************************/
CpaStatus icp_sal_DcPollInstance(CpaInstanceHandle instanceHandle,
Cpa32U response_quota);
/*************************************************************************
* @ingroup SalPoll
* @description
* Poll the response ring associated with a Dc logical instance to
* retrieve requests and dispatch the associated callbacks.
*
* This API is recommended for data plane applications, in which the
* cost of offload - that is, the cycles consumed by the driver in
* sending requests to the hardware, and processing responses - needs
* to be minimized. In particular, use of this API is recommended
* if the following constraints are acceptable to your application:
*
* - Thread safety is not guaranteed. Each software thread should
* have access to its own unique instance (CpaInstanceHandle) to
* avoid contention.
* - The "default" instance (@ref CPA_INSTANCE_HANDLE_SINGLE) is not
* supported on this API. The specific handle should be obtained
* using the instance discovery functions (@ref cpaDcGetNumInstances,
* @ref cpaDcGetInstances).
*
* This polling function should be used with the functions described
* in cpa_dc_dp.h
*
* @context
* This functions is called from both the user and kernel context
*
* @assumptions
* None
* @sideEffects
* None
* @reentrant
* No
* @threadSafe
* No
*
* @param[in] instanceHandle Instance handle.
* @param[in] response_quota The maximum number of messages that
* will be read in one polling. Setting
* the response quota to zero means that
* all messages on the ring will be read.
*
* @retval CPA_STATUS_SUCCESS Successfully polled a ring with data
* @retval CPA_STATUS_RETRY There are no responses on the ring
* associated with this instance
* @retval CPA_STATUS_FAIL Indicates a failure
*************************************************************************/
CpaStatus icp_sal_DcPollDpInstance(CpaInstanceHandle dcInstance,
Cpa32U responseQuota);
/*************************************************************************
* @ingroup SalPoll
* @description
* This function polls the rings on the given bank to determine
* if any of the rings contain messages to be read. The
* response quota is per ring.
*
* @context
* This functions is called from both the user and kernel context
*
* @assumptions
* None
* @sideEffects
* None
* @reentrant
* No
* @threadSafe
* Yes
*
* @param[in] accelId Acceleration device Id, also known as
* packageId. This can be obtained using
* instance info functions (
* @ref cpaCyInstanceGetInfo2
* and @ref cpaDcInstanceGetInfo2)
*
* @param[in] bank_number Bank number
*
* @param[in] response_quota The maximum number of messages that
* will be read in one polling. Setting
* the response quota to zero means that
* all messages on the ring will be read.
*
* @retval CPA_STATUS_SUCCESS Successfully polled a ring with data
* @retval CPA_STATUS_RETRY There is no data on any ring on the bank
* or the bank is already being polled
* @retval CPA_STATUS_FAIL Indicates a failure
*************************************************************************/
CpaStatus
icp_sal_pollBank(Cpa32U accelId, Cpa32U bank_number, Cpa32U response_quota);
/*************************************************************************
* @ingroup SalPoll
* @description
* This function polls the rings on all banks to determine
* if any of the rings contain messages to be read. The
* response quota is per ring.
*
* @context
* This functions is called from both the user and kernel context
*
* @assumptions
* None
* @sideEffects
* None
* @reentrant
* No
* @threadSafe
* Yes
*
* @param[in] accelId Acceleration device Id, also known as
* packageId. This can be obtained using
* instance info functions (
* @ref cpaCyInstanceGetInfo2
* and @ref cpaDcInstanceGetInfo2)
*
* @param[in] response_quota The maximum number of messages that
* will be read in one polling. Setting
* the response quota to zero means that
* all messages on the ring will be read.
*
* @retval CPA_STATUS_SUCCESS Successfully polled a ring with data
* @retval CPA_STATUS_RETRY There is no data on any ring on any bank
* or the banks are already being polled
* @retval CPA_STATUS_FAIL Indicates a failure
*************************************************************************/
CpaStatus icp_sal_pollAllBanks(Cpa32U accelId, Cpa32U response_quota);
#endif
|
