/
qat_hw_callback.h
202 lines (182 loc) · 7.4 KB
/
qat_hw_callback.h
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
/* ====================================================================
*
*
* BSD LICENSE
*
* Copyright(c) 2016-2024 Intel Corporation.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Intel Corporation nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*
* ====================================================================
*/
/*****************************************************************************
* @file qat_hw_callback.h
*
* This file provides and interface for async events to engine
*
*****************************************************************************/
#ifndef QAT_HW_CALLBACK_H
# define QAT_HW_CALLBACK_H
# include <sys/types.h>
# include <unistd.h>
# include "cpa.h"
# include "cpa_types.h"
# include "cpa_cy_sym.h"
# include "e_qat.h"
/* Struct for tracking threaded QAT operation completion. */
typedef struct {
volatile int flag;
volatile CpaBoolean verifyResult;
volatile ASYNC_JOB *job;
volatile CpaStatus status;
#if defined(QAT_BORINGSSL)
volatile int qat_svm;
#endif
} op_done_t;
/* Use this variant of op_done to track QAT chained cipher
* operation completion supporting pipelines.
*/
typedef struct {
/* Keep this as first member of the structure.
* to allow inter-changeability by casting pointers.
*/
op_done_t opDone;
volatile unsigned int num_pipes;
volatile unsigned int num_submitted;
volatile unsigned int num_processed;
} op_done_pipe_t;
/* Use this variant of op_done to track
* QAT RSA CRT operation completion.
*/
typedef struct {
/* Keep this as first member of the structure.
* to allow inter-changeability by casting pointers.
*/
op_done_t opDone;
unsigned int req;
volatile unsigned int resp;
} op_done_rsa_crt_t;
/******************************************************************************
* function:
* qat_init_op_done(op_done_t *opDone)
*
* @param opDone [IN] - pointer to op done_t callback structure.
*
* description:
* Initialise the QAT operation "done" callback structure.
*
******************************************************************************/
#if defined(QAT_BORINGSSL)
void qat_init_op_done(op_done_t *opDone, int qat_svm);
#else
void qat_init_op_done(op_done_t *opDone);
#endif
/******************************************************************************
* function:
* qat_init_op_done_pipe(op_done_pipe_t *opdpipe, unsigned int npipes)
*
* @param opdpipe [IN] - pointer to op_done_pipe_t callback structure
* @param npipes [IN] - number of pipes in the pipeline
*
* description:
* Initialise the QAT chained operation "done" callback structure.
* Setup async event notification if required. The function returns
* 1 for success and 0 for failure.
*
******************************************************************************/
int qat_init_op_done_pipe(op_done_pipe_t *opDone, unsigned int npipes);
/******************************************************************************
* function:
* qat_init_op_done_rsa_crt(op_done_rsa_crt_t *opdcrt)
*
* @param opdcrt [IN] - pointer to op_done_rsa_crt_t callback structure.
*
* description:
* Initialise the QAT RSA synchronous operation "done" callback structure.
* The function returns 1 for success and 0 for failure.
*
******************************************************************************/
int qat_init_op_done_rsa_crt(op_done_rsa_crt_t *opdcrt);
/******************************************************************************
* function:
* qat_cleanup_op_done(op_done_t *opDone)
*
* @param opDone [IN] - pointer to op_done_t callback structure.
*
* description:
* Cleanup the data in the "done" callback structure.
*
******************************************************************************/
void qat_cleanup_op_done(op_done_t *opDone);
/******************************************************************************
* function:
* qat_cleanup_op_done_pipe(op_done_pipe_t *opDone)
*
* @param opDone [IN] - pointer to op_done_pipe_t callback structure.
*
* description:
* Cleanup the QAT chained operation "done" callback structure.
*
******************************************************************************/
void qat_cleanup_op_done_pipe(op_done_pipe_t *opDone);
/******************************************************************************
* function:
* qat_cleanup_op_done_rsa_crt(op_done_rsa_crt_t *opdcrt)
*
* @param opdcrt [IN] - pointer to op_done_rsa_crt_t callback structure.
*
* description:
* Cleanup the QAT RSA synchronous operation "done" callback structure.
*
******************************************************************************/
void qat_cleanup_op_done_rsa_crt(op_done_rsa_crt_t *opdcrt);
/******************************************************************************
* function:
* qat_crypto_callbackFn(void *callbackTag, CpaStatus status,
* const CpaCySymOp operationType, void *pOpData,
* CpaBufferList * pDstBuffer, CpaBoolean verifyResult)
*
*
* @param pCallbackTag [IN] - Opaque value provided by user while making
* individual function call. Cast to op_done.
* @param status [IN] - Status of the operation.
* @param operationType [IN] - Identifies the operation type requested.
* @param pOpData [IN] - Pointer to structure with input parameters.
* @param pDstBuffer [IN] - Destination buffer to hold the data output.
* @param verifyResult [IN] - Used to verify digest result.
*
* description:
* Callback function used by cpaCySymPerformOp to indicate completion.
*
******************************************************************************/
void qat_crypto_callbackFn(void *callbackTag, CpaStatus status,
const CpaCySymOp operationType, void *pOpData,
CpaBufferList * pDstBuffer,
CpaBoolean verifyResult);
#endif /* QAT_HW_CALLBACK_H */