crypto/dpaa2_sec: add sample descriptors
[dpdk.git] / drivers / net / dpaa2 / mc / fsl_dpni_cmd.h
1 /*-
2  * This file is provided under a dual BSD/GPLv2 license. When using or
3  * redistributing this file, you may do so under either license.
4  *
5  *   BSD LICENSE
6  *
7  * Copyright 2013-2016 Freescale Semiconductor Inc.
8  * Copyright (c) 2016 NXP.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions are met:
12  * * Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  * * Redistributions in binary form must reproduce the above copyright
15  * notice, this list of conditions and the following disclaimer in the
16  * documentation and/or other materials provided with the distribution.
17  * * Neither the name of the above-listed copyright holders nor the
18  * names of any contributors may be used to endorse or promote products
19  * derived from this software without specific prior written permission.
20  *
21  *   GPL LICENSE SUMMARY
22  *
23  * ALTERNATIVELY, this software may be distributed under the terms of the
24  * GNU General Public License ("GPL") as published by the Free Software
25  * Foundation, either version 2 of that License or (at your option) any
26  * later version.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
29  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
32  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
34  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
35  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
36  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
37  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38  * POSSIBILITY OF SUCH DAMAGE.
39  */
40 #ifndef _FSL_DPNI_CMD_H
41 #define _FSL_DPNI_CMD_H
42
43 /* DPNI Version */
44 #define DPNI_VER_MAJOR                          7
45 #define DPNI_VER_MINOR                          0
46
47 /* Command IDs */
48 #define DPNI_CMDID_OPEN                                ((0x801 << 4) | (0x1))
49 #define DPNI_CMDID_CLOSE                               ((0x800 << 4) | (0x1))
50 #define DPNI_CMDID_CREATE                              ((0x901 << 4) | (0x1))
51 #define DPNI_CMDID_DESTROY                             ((0x981 << 4) | (0x1))
52 #define DPNI_CMDID_GET_API_VERSION                     ((0xa01 << 4) | (0x1))
53
54 #define DPNI_CMDID_ENABLE                              ((0x002 << 4) | (0x1))
55 #define DPNI_CMDID_DISABLE                             ((0x003 << 4) | (0x1))
56 #define DPNI_CMDID_GET_ATTR                            ((0x004 << 4) | (0x1))
57 #define DPNI_CMDID_RESET                               ((0x005 << 4) | (0x1))
58 #define DPNI_CMDID_IS_ENABLED                          ((0x006 << 4) | (0x1))
59
60 #define DPNI_CMDID_SET_POOLS                           ((0x200 << 4) | (0x1))
61 #define DPNI_CMDID_SET_ERRORS_BEHAVIOR                 ((0x20B << 4) | (0x1))
62
63 #define DPNI_CMDID_GET_QDID                            ((0x210 << 4) | (0x1))
64 #define DPNI_CMDID_GET_LINK_STATE                      ((0x215 << 4) | (0x1))
65 #define DPNI_CMDID_SET_MAX_FRAME_LENGTH                ((0x216 << 4) | (0x1))
66 #define DPNI_CMDID_GET_MAX_FRAME_LENGTH                ((0x217 << 4) | (0x1))
67
68 #define DPNI_CMDID_SET_UNICAST_PROMISC                 ((0x222 << 4) | (0x1))
69 #define DPNI_CMDID_GET_UNICAST_PROMISC                 ((0x223 << 4) | (0x1))
70 #define DPNI_CMDID_SET_PRIM_MAC                        ((0x224 << 4) | (0x1))
71 #define DPNI_CMDID_GET_PRIM_MAC                        ((0x225 << 4) | (0x1))
72
73 #define DPNI_CMDID_SET_RX_TC_DIST                      ((0x235 << 4) | (0x1))
74
75 #define DPNI_CMDID_GET_STATISTICS                      ((0x25D << 4) | (0x1))
76 #define DPNI_CMDID_RESET_STATISTICS                    ((0x25E << 4) | (0x1))
77 #define DPNI_CMDID_GET_QUEUE                           ((0x25F << 4) | (0x1))
78 #define DPNI_CMDID_SET_QUEUE                           ((0x260 << 4) | (0x1))
79
80 #define DPNI_CMDID_GET_PORT_MAC_ADDR                   ((0x263 << 4) | (0x1))
81
82 #define DPNI_CMDID_GET_BUFFER_LAYOUT                   ((0x264 << 4) | (0x1))
83 #define DPNI_CMDID_SET_BUFFER_LAYOUT                   ((0x265 << 4) | (0x1))
84
85 #define DPNI_CMDID_GET_OFFLOAD                         ((0x26B << 4) | (0x1))
86 #define DPNI_CMDID_SET_OFFLOAD                         ((0x26C << 4) | (0x1))
87 #define DPNI_CMDID_SET_TX_CONFIRMATION_MODE            ((0x266 << 4) | (0x1))
88 #define DPNI_CMDID_GET_TX_CONFIRMATION_MODE            ((0x26D << 4) | (0x1))
89
90 /*                cmd, param, offset, width, type, arg_name */
91 #define DPNI_CMD_OPEN(cmd, dpni_id) \
92         MC_CMD_OP(cmd,   0,     0,      32,     int,    dpni_id)
93
94 /*                cmd, param, offset, width, type, arg_name */
95 #define DPNI_CMD_CREATE(cmd, cfg) \
96 do { \
97         MC_CMD_OP(cmd, 0,  0, 32, uint32_t,  (cfg)->options); \
98         MC_CMD_OP(cmd, 0, 32,  8,  uint8_t,  (cfg)->num_queues); \
99         MC_CMD_OP(cmd, 0, 40,  8,  uint8_t,  (cfg)->num_tcs); \
100         MC_CMD_OP(cmd, 0, 48,  8,  uint8_t,  (cfg)->mac_filter_entries); \
101         MC_CMD_OP(cmd, 1,  0,  8,  uint8_t,  (cfg)->vlan_filter_entries); \
102         MC_CMD_OP(cmd, 1, 16,  8,  uint8_t,  (cfg)->qos_entries); \
103         MC_CMD_OP(cmd, 1, 32, 16, uint16_t,  (cfg)->fs_entries); \
104 } while (0)
105
106 /*                cmd, param, offset, width, type, arg_name */
107 #define DPNI_CMD_SET_POOLS(cmd, cfg) \
108 do { \
109         MC_CMD_OP(cmd, 0, 0,  8,  uint8_t,  cfg->num_dpbp); \
110         MC_CMD_OP(cmd, 0, 8,  1,  int,      cfg->pools[0].backup_pool); \
111         MC_CMD_OP(cmd, 0, 9,  1,  int,      cfg->pools[1].backup_pool); \
112         MC_CMD_OP(cmd, 0, 10, 1,  int,      cfg->pools[2].backup_pool); \
113         MC_CMD_OP(cmd, 0, 11, 1,  int,      cfg->pools[3].backup_pool); \
114         MC_CMD_OP(cmd, 0, 12, 1,  int,      cfg->pools[4].backup_pool); \
115         MC_CMD_OP(cmd, 0, 13, 1,  int,      cfg->pools[5].backup_pool); \
116         MC_CMD_OP(cmd, 0, 14, 1,  int,      cfg->pools[6].backup_pool); \
117         MC_CMD_OP(cmd, 0, 15, 1,  int,      cfg->pools[7].backup_pool); \
118         MC_CMD_OP(cmd, 0, 32, 32, int,      cfg->pools[0].dpbp_id); \
119         MC_CMD_OP(cmd, 4, 32, 16, uint16_t, cfg->pools[0].buffer_size);\
120         MC_CMD_OP(cmd, 1, 0,  32, int,      cfg->pools[1].dpbp_id); \
121         MC_CMD_OP(cmd, 4, 48, 16, uint16_t, cfg->pools[1].buffer_size);\
122         MC_CMD_OP(cmd, 1, 32, 32, int,      cfg->pools[2].dpbp_id); \
123         MC_CMD_OP(cmd, 5, 0,  16, uint16_t, cfg->pools[2].buffer_size);\
124         MC_CMD_OP(cmd, 2, 0,  32, int,      cfg->pools[3].dpbp_id); \
125         MC_CMD_OP(cmd, 5, 16, 16, uint16_t, cfg->pools[3].buffer_size);\
126         MC_CMD_OP(cmd, 2, 32, 32, int,      cfg->pools[4].dpbp_id); \
127         MC_CMD_OP(cmd, 5, 32, 16, uint16_t, cfg->pools[4].buffer_size);\
128         MC_CMD_OP(cmd, 3, 0,  32, int,      cfg->pools[5].dpbp_id); \
129         MC_CMD_OP(cmd, 5, 48, 16, uint16_t, cfg->pools[5].buffer_size);\
130         MC_CMD_OP(cmd, 3, 32, 32, int,      cfg->pools[6].dpbp_id); \
131         MC_CMD_OP(cmd, 6, 0,  16, uint16_t, cfg->pools[6].buffer_size);\
132         MC_CMD_OP(cmd, 4, 0,  32, int,      cfg->pools[7].dpbp_id); \
133         MC_CMD_OP(cmd, 6, 16, 16, uint16_t, cfg->pools[7].buffer_size);\
134 } while (0)
135
136 /*                cmd, param, offset, width, type, arg_name */
137 #define DPNI_RSP_IS_ENABLED(cmd, en) \
138         MC_RSP_OP(cmd, 0, 0,  1,  int,      en)
139
140 /* DPNI_CMD_GET_ATTR is not used, no input parameters */
141
142 #define DPNI_RSP_GET_ATTR(cmd, attr) \
143 do { \
144         MC_RSP_OP(cmd, 0,  0, 32, uint32_t, (attr)->options); \
145         MC_RSP_OP(cmd, 0, 32,  8, uint8_t,  (attr)->num_queues); \
146         MC_RSP_OP(cmd, 0, 40,  8, uint8_t,  (attr)->num_tcs); \
147         MC_RSP_OP(cmd, 0, 48,  8, uint8_t,  (attr)->mac_filter_entries); \
148         MC_RSP_OP(cmd, 1,  0,  8, uint8_t, (attr)->vlan_filter_entries); \
149         MC_RSP_OP(cmd, 1, 16,  8, uint8_t,  (attr)->qos_entries); \
150         MC_RSP_OP(cmd, 1, 32, 16, uint16_t, (attr)->fs_entries); \
151         MC_RSP_OP(cmd, 2,  0,  8, uint8_t,  (attr)->qos_key_size); \
152         MC_RSP_OP(cmd, 2,  8,  8, uint8_t,  (attr)->fs_key_size); \
153         MC_RSP_OP(cmd, 2, 16, 16, uint16_t, (attr)->wriop_version); \
154 } while (0)
155
156 /*                cmd, param, offset, width, type, arg_name */
157 #define DPNI_CMD_SET_ERRORS_BEHAVIOR(cmd, cfg) \
158 do { \
159         MC_CMD_OP(cmd, 0, 0,  32, uint32_t, cfg->errors); \
160         MC_CMD_OP(cmd, 0, 32, 4,  enum dpni_error_action, cfg->error_action); \
161         MC_CMD_OP(cmd, 0, 36, 1,  int,      cfg->set_frame_annotation); \
162 } while (0)
163
164 #define DPNI_CMD_GET_BUFFER_LAYOUT(cmd, qtype) \
165         MC_CMD_OP(cmd, 0,  0,  8, enum dpni_queue_type, qtype)
166
167 #define DPNI_RSP_GET_BUFFER_LAYOUT(cmd, layout) \
168 do { \
169         MC_RSP_OP(cmd, 0, 48,  1, char, (layout)->pass_timestamp); \
170         MC_RSP_OP(cmd, 0, 49,  1, char, (layout)->pass_parser_result); \
171         MC_RSP_OP(cmd, 0, 50,  1, char, (layout)->pass_frame_status); \
172         MC_RSP_OP(cmd, 1,  0, 16, uint16_t, (layout)->private_data_size); \
173         MC_RSP_OP(cmd, 1, 16, 16, uint16_t, (layout)->data_align); \
174         MC_RSP_OP(cmd, 1, 32, 16, uint16_t, (layout)->data_head_room); \
175         MC_RSP_OP(cmd, 1, 48, 16, uint16_t, (layout)->data_tail_room); \
176 } while (0)
177
178 #define DPNI_CMD_SET_BUFFER_LAYOUT(cmd, qtype, layout) \
179 do { \
180         MC_CMD_OP(cmd, 0,  0,  8, enum dpni_queue_type, qtype); \
181         MC_CMD_OP(cmd, 0, 32, 16, uint16_t, (layout)->options); \
182         MC_CMD_OP(cmd, 0, 48,  1, char, (layout)->pass_timestamp); \
183         MC_CMD_OP(cmd, 0, 49,  1, char, (layout)->pass_parser_result); \
184         MC_CMD_OP(cmd, 0, 50,  1, char, (layout)->pass_frame_status); \
185         MC_CMD_OP(cmd, 1,  0, 16, uint16_t, (layout)->private_data_size); \
186         MC_CMD_OP(cmd, 1, 16, 16, uint16_t, (layout)->data_align); \
187         MC_CMD_OP(cmd, 1, 32, 16, uint16_t, (layout)->data_head_room); \
188         MC_CMD_OP(cmd, 1, 48, 16, uint16_t, (layout)->data_tail_room); \
189 } while (0)
190
191 #define DPNI_CMD_SET_OFFLOAD(cmd, type, config) \
192 do { \
193         MC_CMD_OP(cmd, 0, 24,  8, enum dpni_offload, type); \
194         MC_CMD_OP(cmd, 0, 32, 32, uint32_t, config); \
195 } while (0)
196
197 #define DPNI_CMD_GET_OFFLOAD(cmd, type) \
198         MC_CMD_OP(cmd, 0, 24,  8, enum dpni_offload, type)
199
200 #define DPNI_RSP_GET_OFFLOAD(cmd, config) \
201         MC_RSP_OP(cmd, 0, 32, 32, uint32_t, config)
202
203 #define DPNI_CMD_GET_QDID(cmd, qtype) \
204         MC_CMD_OP(cmd, 0,  0,  8, enum dpni_queue_type, qtype)
205
206 /*                cmd, param, offset, width, type, arg_name */
207 #define DPNI_RSP_GET_QDID(cmd, qdid) \
208         MC_RSP_OP(cmd, 0, 0,  16, uint16_t, qdid)
209
210
211 /*                cmd, param, offset, width, type, arg_name */
212 #define DPNI_CMD_GET_STATISTICS(cmd, page) \
213         MC_CMD_OP(cmd, 0, 0, 8, uint8_t, page)
214
215 #define DPNI_RSP_GET_STATISTICS(cmd, stat) \
216 do { \
217         MC_RSP_OP(cmd, 0, 0, 64, uint64_t, (stat)->raw.counter[0]); \
218         MC_RSP_OP(cmd, 1, 0, 64, uint64_t, (stat)->raw.counter[1]); \
219         MC_RSP_OP(cmd, 2, 0, 64, uint64_t, (stat)->raw.counter[2]); \
220         MC_RSP_OP(cmd, 3, 0, 64, uint64_t, (stat)->raw.counter[3]); \
221         MC_RSP_OP(cmd, 4, 0, 64, uint64_t, (stat)->raw.counter[4]); \
222         MC_RSP_OP(cmd, 5, 0, 64, uint64_t, (stat)->raw.counter[5]); \
223         MC_RSP_OP(cmd, 6, 0, 64, uint64_t, (stat)->raw.counter[6]); \
224 } while (0)
225
226 /*                cmd, param, offset, width, type, arg_name */
227 #define DPNI_RSP_GET_LINK_STATE(cmd, state) \
228 do { \
229         MC_RSP_OP(cmd, 0, 32,  1, int,      state->up);\
230         MC_RSP_OP(cmd, 1, 0,  32, uint32_t, state->rate);\
231         MC_RSP_OP(cmd, 2, 0,  64, uint64_t, state->options);\
232 } while (0)
233
234 /*                cmd, param, offset, width, type, arg_name */
235 #define DPNI_CMD_SET_MAX_FRAME_LENGTH(cmd, max_frame_length) \
236         MC_CMD_OP(cmd, 0, 0,  16, uint16_t, max_frame_length)
237
238 /*                cmd, param, offset, width, type, arg_name */
239 #define DPNI_RSP_GET_MAX_FRAME_LENGTH(cmd, max_frame_length) \
240         MC_RSP_OP(cmd, 0, 0,  16, uint16_t, max_frame_length)
241
242 /*                cmd, param, offset, width, type, arg_name */
243 #define DPNI_CMD_SET_UNICAST_PROMISC(cmd, en) \
244         MC_CMD_OP(cmd, 0, 0,  1,  int,      en)
245
246 /*                cmd, param, offset, width, type, arg_name */
247 #define DPNI_RSP_GET_UNICAST_PROMISC(cmd, en) \
248         MC_RSP_OP(cmd, 0, 0,  1,  int,      en)
249
250 /*                cmd, param, offset, width, type, arg_name */
251 #define DPNI_CMD_SET_PRIMARY_MAC_ADDR(cmd, mac_addr) \
252 do { \
253         MC_CMD_OP(cmd, 0, 16, 8,  uint8_t,  mac_addr[5]); \
254         MC_CMD_OP(cmd, 0, 24, 8,  uint8_t,  mac_addr[4]); \
255         MC_CMD_OP(cmd, 0, 32, 8,  uint8_t,  mac_addr[3]); \
256         MC_CMD_OP(cmd, 0, 40, 8,  uint8_t,  mac_addr[2]); \
257         MC_CMD_OP(cmd, 0, 48, 8,  uint8_t,  mac_addr[1]); \
258         MC_CMD_OP(cmd, 0, 56, 8,  uint8_t,  mac_addr[0]); \
259 } while (0)
260
261 /*                cmd, param, offset, width, type, arg_name */
262 #define DPNI_RSP_GET_PRIMARY_MAC_ADDR(cmd, mac_addr) \
263 do { \
264         MC_RSP_OP(cmd, 0, 16, 8,  uint8_t,  mac_addr[5]); \
265         MC_RSP_OP(cmd, 0, 24, 8,  uint8_t,  mac_addr[4]); \
266         MC_RSP_OP(cmd, 0, 32, 8,  uint8_t,  mac_addr[3]); \
267         MC_RSP_OP(cmd, 0, 40, 8,  uint8_t,  mac_addr[2]); \
268         MC_RSP_OP(cmd, 0, 48, 8,  uint8_t,  mac_addr[1]); \
269         MC_RSP_OP(cmd, 0, 56, 8,  uint8_t,  mac_addr[0]); \
270 } while (0)
271
272
273 /*                cmd, param, offset, width, type, arg_name */
274 #define DPNI_CMD_SET_RX_TC_DIST(cmd, tc_id, cfg) \
275 do { \
276         MC_CMD_OP(cmd, 0, 0,  16, uint16_t,  cfg->dist_size); \
277         MC_CMD_OP(cmd, 0, 16, 8,  uint8_t,  tc_id); \
278         MC_CMD_OP(cmd, 0, 24, 4,  enum dpni_dist_mode, cfg->dist_mode); \
279         MC_CMD_OP(cmd, 0, 28, 4,  enum dpni_fs_miss_action, \
280                                                   cfg->fs_cfg.miss_action); \
281         MC_CMD_OP(cmd, 0, 48, 16, uint16_t, cfg->fs_cfg.default_flow_id); \
282         MC_CMD_OP(cmd, 6, 0,  64, uint64_t, cfg->key_cfg_iova); \
283 } while (0)
284
285 #define DPNI_CMD_GET_QUEUE(cmd, qtype, tc, index) \
286 do { \
287         MC_CMD_OP(cmd, 0,  0,  8, enum dpni_queue_type, qtype); \
288         MC_CMD_OP(cmd, 0,  8,  8,  uint8_t, tc); \
289         MC_CMD_OP(cmd, 0, 16,  8,  uint8_t, index); \
290 } while (0)
291
292 #define DPNI_RSP_GET_QUEUE(cmd, queue, queue_id) \
293 do { \
294         MC_RSP_OP(cmd, 1,  0, 32, uint32_t, (queue)->destination.id); \
295         MC_RSP_OP(cmd, 1, 48,  8, uint8_t, (queue)->destination.priority); \
296         MC_RSP_OP(cmd, 1, 56,  4, enum dpni_dest, (queue)->destination.type); \
297         MC_RSP_OP(cmd, 1, 62,  1, char, (queue)->flc.stash_control); \
298         MC_RSP_OP(cmd, 1, 63,  1, char, (queue)->destination.hold_active); \
299         MC_RSP_OP(cmd, 2,  0, 64, uint64_t, (queue)->flc.value); \
300         MC_RSP_OP(cmd, 3,  0, 64, uint64_t, (queue)->user_context); \
301         MC_RSP_OP(cmd, 4,  0, 32, uint32_t, (queue_id)->fqid); \
302         MC_RSP_OP(cmd, 4, 32, 16, uint16_t, (queue_id)->qdbin); \
303 } while (0)
304
305 #define DPNI_CMD_SET_QUEUE(cmd, qtype, tc, index, options, queue) \
306 do { \
307         MC_CMD_OP(cmd, 0,  0,  8, enum dpni_queue_type, qtype); \
308         MC_CMD_OP(cmd, 0,  8,  8,  uint8_t, tc); \
309         MC_CMD_OP(cmd, 0, 16,  8,  uint8_t, index); \
310         MC_CMD_OP(cmd, 0, 24,  8,  uint8_t, options); \
311         MC_CMD_OP(cmd, 1,  0, 32, uint32_t, (queue)->destination.id); \
312         MC_CMD_OP(cmd, 1, 48,  8, uint8_t, (queue)->destination.priority); \
313         MC_CMD_OP(cmd, 1, 56,  4, enum dpni_dest, (queue)->destination.type); \
314         MC_CMD_OP(cmd, 1, 62,  1, char, (queue)->flc.stash_control); \
315         MC_CMD_OP(cmd, 1, 63,  1, char, (queue)->destination.hold_active); \
316         MC_CMD_OP(cmd, 2,  0, 64, uint64_t, (queue)->flc.value); \
317         MC_CMD_OP(cmd, 3,  0, 64, uint64_t, (queue)->user_context); \
318 } while (0)
319
320 /*                cmd, param, offset, width, type,      arg_name */
321 #define DPNI_RSP_GET_API_VERSION(cmd, major, minor) \
322 do { \
323         MC_RSP_OP(cmd, 0, 0,  16, uint16_t, major);\
324         MC_RSP_OP(cmd, 0, 16, 16, uint16_t, minor);\
325 } while (0)
326
327
328 #define DPNI_CMD_SET_TX_CONFIRMATION_MODE(cmd, mode) \
329         MC_CMD_OP(cmd, 0, 32, 8, enum dpni_confirmation_mode, mode)
330
331 #define DPNI_RSP_GET_TX_CONFIRMATION_MODE(cmd, mode) \
332         MC_RSP_OP(cmd, 0, 32, 8, enum dpni_confirmation_mode, mode)
333
334 #endif /* _FSL_DPNI_CMD_H */