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
|
/*
* BSD LICENSE
*
* Copyright (C) Cavium networks Ltd. 2017.
*
* 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 Cavium networks 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.
*/
#ifndef _RTE_ARMV8_PMD_PRIVATE_H_
#define _RTE_ARMV8_PMD_PRIVATE_H_
#define ARMV8_CRYPTO_LOG_ERR(fmt, args...) \
RTE_LOG(ERR, CRYPTODEV, "[%s] %s() line %u: " fmt "\n", \
RTE_STR(CRYPTODEV_NAME_ARMV8_CRYPTO_PMD), \
__func__, __LINE__, ## args)
#ifdef RTE_LIBRTE_ARMV8_CRYPTO_DEBUG
#define ARMV8_CRYPTO_LOG_INFO(fmt, args...) \
RTE_LOG(INFO, CRYPTODEV, "[%s] %s() line %u: " fmt "\n", \
RTE_STR(CRYPTODEV_NAME_ARMV8_CRYPTO_PMD), \
__func__, __LINE__, ## args)
#define ARMV8_CRYPTO_LOG_DBG(fmt, args...) \
RTE_LOG(DEBUG, CRYPTODEV, "[%s] %s() line %u: " fmt "\n", \
RTE_STR(CRYPTODEV_NAME_ARMV8_CRYPTO_PMD), \
__func__, __LINE__, ## args)
#define ARMV8_CRYPTO_ASSERT(con) \
do { \
if (!(con)) { \
rte_panic("%s(): " \
con "condition failed, line %u", __func__); \
} \
} while (0)
#else
#define ARMV8_CRYPTO_LOG_INFO(fmt, args...)
#define ARMV8_CRYPTO_LOG_DBG(fmt, args...)
#define ARMV8_CRYPTO_ASSERT(con)
#endif
#define NBBY 8 /* Number of bits in a byte */
#define BYTE_LENGTH(x) ((x) / NBBY) /* Number of bytes in x (round down) */
/** ARMv8 operation order mode enumerator */
enum armv8_crypto_chain_order {
ARMV8_CRYPTO_CHAIN_CIPHER_AUTH,
ARMV8_CRYPTO_CHAIN_AUTH_CIPHER,
ARMV8_CRYPTO_CHAIN_NOT_SUPPORTED,
ARMV8_CRYPTO_CHAIN_LIST_END = ARMV8_CRYPTO_CHAIN_NOT_SUPPORTED
};
/** ARMv8 cipher operation enumerator */
enum armv8_crypto_cipher_operation {
ARMV8_CRYPTO_CIPHER_OP_ENCRYPT = RTE_CRYPTO_CIPHER_OP_ENCRYPT,
ARMV8_CRYPTO_CIPHER_OP_DECRYPT = RTE_CRYPTO_CIPHER_OP_DECRYPT,
ARMV8_CRYPTO_CIPHER_OP_NOT_SUPPORTED,
ARMV8_CRYPTO_CIPHER_OP_LIST_END = ARMV8_CRYPTO_CIPHER_OP_NOT_SUPPORTED
};
enum armv8_crypto_cipher_keylen {
ARMV8_CRYPTO_CIPHER_KEYLEN_128,
ARMV8_CRYPTO_CIPHER_KEYLEN_192,
ARMV8_CRYPTO_CIPHER_KEYLEN_256,
ARMV8_CRYPTO_CIPHER_KEYLEN_NOT_SUPPORTED,
ARMV8_CRYPTO_CIPHER_KEYLEN_LIST_END =
ARMV8_CRYPTO_CIPHER_KEYLEN_NOT_SUPPORTED
};
/** ARMv8 auth mode enumerator */
enum armv8_crypto_auth_mode {
ARMV8_CRYPTO_AUTH_AS_AUTH,
ARMV8_CRYPTO_AUTH_AS_HMAC,
ARMV8_CRYPTO_AUTH_AS_CIPHER,
ARMV8_CRYPTO_AUTH_NOT_SUPPORTED,
ARMV8_CRYPTO_AUTH_LIST_END = ARMV8_CRYPTO_AUTH_NOT_SUPPORTED
};
#define CRYPTO_ORDER_MAX ARMV8_CRYPTO_CHAIN_LIST_END
#define CRYPTO_CIPHER_OP_MAX ARMV8_CRYPTO_CIPHER_OP_LIST_END
#define CRYPTO_CIPHER_KEYLEN_MAX ARMV8_CRYPTO_CIPHER_KEYLEN_LIST_END
#define CRYPTO_CIPHER_MAX RTE_CRYPTO_CIPHER_LIST_END
#define CRYPTO_AUTH_MAX RTE_CRYPTO_AUTH_LIST_END
#define HMAC_IPAD_VALUE (0x36)
#define HMAC_OPAD_VALUE (0x5C)
#define SHA256_AUTH_KEY_LENGTH (BYTE_LENGTH(256))
#define SHA256_BLOCK_SIZE (BYTE_LENGTH(512))
#define SHA1_AUTH_KEY_LENGTH (BYTE_LENGTH(160))
#define SHA1_BLOCK_SIZE (BYTE_LENGTH(512))
#define SHA_AUTH_KEY_MAX SHA256_AUTH_KEY_LENGTH
#define SHA_BLOCK_MAX SHA256_BLOCK_SIZE
typedef int (*crypto_func_t)(uint8_t *, uint8_t *, uint64_t,
uint8_t *, uint8_t *, uint64_t,
crypto_arg_t *);
typedef void (*crypto_key_sched_t)(uint8_t *, const uint8_t *);
/** private data structure for each ARMv8 crypto device */
struct armv8_crypto_private {
unsigned int max_nb_qpairs;
/**< Max number of queue pairs */
unsigned int max_nb_sessions;
/**< Max number of sessions */
};
/** ARMv8 crypto queue pair */
struct armv8_crypto_qp {
uint16_t id;
/**< Queue Pair Identifier */
struct rte_ring *processed_ops;
/**< Ring for placing process packets */
struct rte_mempool *sess_mp;
/**< Session Mempool */
struct rte_cryptodev_stats stats;
/**< Queue pair statistics */
char name[RTE_CRYPTODEV_NAME_LEN];
/**< Unique Queue Pair Name */
} __rte_cache_aligned;
/** ARMv8 crypto private session structure */
struct armv8_crypto_session {
enum armv8_crypto_chain_order chain_order;
/**< chain order mode */
crypto_func_t crypto_func;
/**< cryptographic function to use for this session */
/** Cipher Parameters */
struct {
enum rte_crypto_cipher_operation direction;
/**< cipher operation direction */
enum rte_crypto_cipher_algorithm algo;
/**< cipher algorithm */
int iv_len;
/**< IV length */
struct {
uint8_t data[256];
/**< key data */
size_t length;
/**< key length in bytes */
} key;
crypto_key_sched_t key_sched;
/**< Key schedule function */
} cipher;
/** Authentication Parameters */
struct {
enum rte_crypto_auth_operation operation;
/**< auth operation generate or verify */
enum armv8_crypto_auth_mode mode;
/**< auth operation mode */
union {
struct {
/* Add data if needed */
} auth;
struct {
uint8_t i_key_pad[SHA_BLOCK_MAX]
__rte_cache_aligned;
/**< inner pad (max supported block length) */
uint8_t o_key_pad[SHA_BLOCK_MAX]
__rte_cache_aligned;
/**< outer pad (max supported block length) */
uint8_t key[SHA_AUTH_KEY_MAX];
/**< HMAC key (max supported length)*/
} hmac;
};
} auth;
} __rte_cache_aligned;
/** Set and validate ARMv8 crypto session parameters */
extern int armv8_crypto_set_session_parameters(
struct armv8_crypto_session *sess,
const struct rte_crypto_sym_xform *xform);
/** device specific operations function pointer structure */
extern struct rte_cryptodev_ops *rte_armv8_crypto_pmd_ops;
#endif /* _RTE_ARMV8_PMD_PRIVATE_H_ */
|
