xref: /linux-6.15/include/uapi/linux/devlink.h (revision 257eeded)
1 /* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */
2 /*
3  * include/uapi/linux/devlink.h - Network physical device Netlink interface
4  * Copyright (c) 2016 Mellanox Technologies. All rights reserved.
5  * Copyright (c) 2016 Jiri Pirko <[email protected]>
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  */
12 
13 #ifndef _UAPI_LINUX_DEVLINK_H_
14 #define _UAPI_LINUX_DEVLINK_H_
15 
16 #define DEVLINK_GENL_NAME "devlink"
17 #define DEVLINK_GENL_VERSION 0x1
18 #define DEVLINK_GENL_MCGRP_CONFIG_NAME "config"
19 
20 enum devlink_command {
21 	/* don't change the order or add anything between, this is ABI! */
22 	DEVLINK_CMD_UNSPEC,
23 
24 	DEVLINK_CMD_GET,		/* can dump */
25 	DEVLINK_CMD_SET,
26 	DEVLINK_CMD_NEW,
27 	DEVLINK_CMD_DEL,
28 
29 	DEVLINK_CMD_PORT_GET,		/* can dump */
30 	DEVLINK_CMD_PORT_SET,
31 	DEVLINK_CMD_PORT_NEW,
32 	DEVLINK_CMD_PORT_DEL,
33 
34 	DEVLINK_CMD_PORT_SPLIT,
35 	DEVLINK_CMD_PORT_UNSPLIT,
36 
37 	DEVLINK_CMD_SB_GET,		/* can dump */
38 	DEVLINK_CMD_SB_SET,
39 	DEVLINK_CMD_SB_NEW,
40 	DEVLINK_CMD_SB_DEL,
41 
42 	DEVLINK_CMD_SB_POOL_GET,	/* can dump */
43 	DEVLINK_CMD_SB_POOL_SET,
44 	DEVLINK_CMD_SB_POOL_NEW,
45 	DEVLINK_CMD_SB_POOL_DEL,
46 
47 	DEVLINK_CMD_SB_PORT_POOL_GET,	/* can dump */
48 	DEVLINK_CMD_SB_PORT_POOL_SET,
49 	DEVLINK_CMD_SB_PORT_POOL_NEW,
50 	DEVLINK_CMD_SB_PORT_POOL_DEL,
51 
52 	DEVLINK_CMD_SB_TC_POOL_BIND_GET,	/* can dump */
53 	DEVLINK_CMD_SB_TC_POOL_BIND_SET,
54 	DEVLINK_CMD_SB_TC_POOL_BIND_NEW,
55 	DEVLINK_CMD_SB_TC_POOL_BIND_DEL,
56 
57 	/* Shared buffer occupancy monitoring commands */
58 	DEVLINK_CMD_SB_OCC_SNAPSHOT,
59 	DEVLINK_CMD_SB_OCC_MAX_CLEAR,
60 
61 	DEVLINK_CMD_ESWITCH_GET,
62 #define DEVLINK_CMD_ESWITCH_MODE_GET /* obsolete, never use this! */ \
63 	DEVLINK_CMD_ESWITCH_GET
64 
65 	DEVLINK_CMD_ESWITCH_SET,
66 #define DEVLINK_CMD_ESWITCH_MODE_SET /* obsolete, never use this! */ \
67 	DEVLINK_CMD_ESWITCH_SET
68 
69 	DEVLINK_CMD_DPIPE_TABLE_GET,
70 	DEVLINK_CMD_DPIPE_ENTRIES_GET,
71 	DEVLINK_CMD_DPIPE_HEADERS_GET,
72 	DEVLINK_CMD_DPIPE_TABLE_COUNTERS_SET,
73 	DEVLINK_CMD_RESOURCE_SET,
74 	DEVLINK_CMD_RESOURCE_DUMP,
75 
76 	/* Hot driver reload, makes configuration changes take place. The
77 	 * devlink instance is not released during the process.
78 	 */
79 	DEVLINK_CMD_RELOAD,
80 
81 	DEVLINK_CMD_PARAM_GET,		/* can dump */
82 	DEVLINK_CMD_PARAM_SET,
83 	DEVLINK_CMD_PARAM_NEW,
84 	DEVLINK_CMD_PARAM_DEL,
85 
86 	DEVLINK_CMD_REGION_GET,
87 	DEVLINK_CMD_REGION_SET,
88 	DEVLINK_CMD_REGION_NEW,
89 	DEVLINK_CMD_REGION_DEL,
90 	DEVLINK_CMD_REGION_READ,
91 
92 	DEVLINK_CMD_PORT_PARAM_GET,	/* can dump */
93 	DEVLINK_CMD_PORT_PARAM_SET,
94 	DEVLINK_CMD_PORT_PARAM_NEW,
95 	DEVLINK_CMD_PORT_PARAM_DEL,
96 
97 	DEVLINK_CMD_INFO_GET,		/* can dump */
98 
99 	DEVLINK_CMD_HEALTH_REPORTER_GET,
100 	DEVLINK_CMD_HEALTH_REPORTER_SET,
101 	DEVLINK_CMD_HEALTH_REPORTER_RECOVER,
102 	DEVLINK_CMD_HEALTH_REPORTER_DIAGNOSE,
103 	DEVLINK_CMD_HEALTH_REPORTER_DUMP_GET,
104 	DEVLINK_CMD_HEALTH_REPORTER_DUMP_CLEAR,
105 
106 	/* add new commands above here */
107 	__DEVLINK_CMD_MAX,
108 	DEVLINK_CMD_MAX = __DEVLINK_CMD_MAX - 1
109 };
110 
111 enum devlink_port_type {
112 	DEVLINK_PORT_TYPE_NOTSET,
113 	DEVLINK_PORT_TYPE_AUTO,
114 	DEVLINK_PORT_TYPE_ETH,
115 	DEVLINK_PORT_TYPE_IB,
116 };
117 
118 enum devlink_sb_pool_type {
119 	DEVLINK_SB_POOL_TYPE_INGRESS,
120 	DEVLINK_SB_POOL_TYPE_EGRESS,
121 };
122 
123 /* static threshold - limiting the maximum number of bytes.
124  * dynamic threshold - limiting the maximum number of bytes
125  *   based on the currently available free space in the shared buffer pool.
126  *   In this mode, the maximum quota is calculated based
127  *   on the following formula:
128  *     max_quota = alpha / (1 + alpha) * Free_Buffer
129  *   While Free_Buffer is the amount of none-occupied buffer associated to
130  *   the relevant pool.
131  *   The value range which can be passed is 0-20 and serves
132  *   for computation of alpha by following formula:
133  *     alpha = 2 ^ (passed_value - 10)
134  */
135 
136 enum devlink_sb_threshold_type {
137 	DEVLINK_SB_THRESHOLD_TYPE_STATIC,
138 	DEVLINK_SB_THRESHOLD_TYPE_DYNAMIC,
139 };
140 
141 #define DEVLINK_SB_THRESHOLD_TO_ALPHA_MAX 20
142 
143 enum devlink_eswitch_mode {
144 	DEVLINK_ESWITCH_MODE_LEGACY,
145 	DEVLINK_ESWITCH_MODE_SWITCHDEV,
146 };
147 
148 enum devlink_eswitch_inline_mode {
149 	DEVLINK_ESWITCH_INLINE_MODE_NONE,
150 	DEVLINK_ESWITCH_INLINE_MODE_LINK,
151 	DEVLINK_ESWITCH_INLINE_MODE_NETWORK,
152 	DEVLINK_ESWITCH_INLINE_MODE_TRANSPORT,
153 };
154 
155 enum devlink_eswitch_encap_mode {
156 	DEVLINK_ESWITCH_ENCAP_MODE_NONE,
157 	DEVLINK_ESWITCH_ENCAP_MODE_BASIC,
158 };
159 
160 enum devlink_port_flavour {
161 	DEVLINK_PORT_FLAVOUR_PHYSICAL, /* Any kind of a port physically
162 					* facing the user.
163 					*/
164 	DEVLINK_PORT_FLAVOUR_CPU, /* CPU port */
165 	DEVLINK_PORT_FLAVOUR_DSA, /* Distributed switch architecture
166 				   * interconnect port.
167 				   */
168 };
169 
170 enum devlink_param_cmode {
171 	DEVLINK_PARAM_CMODE_RUNTIME,
172 	DEVLINK_PARAM_CMODE_DRIVERINIT,
173 	DEVLINK_PARAM_CMODE_PERMANENT,
174 
175 	/* Add new configuration modes above */
176 	__DEVLINK_PARAM_CMODE_MAX,
177 	DEVLINK_PARAM_CMODE_MAX = __DEVLINK_PARAM_CMODE_MAX - 1
178 };
179 
180 enum devlink_param_fw_load_policy_value {
181 	DEVLINK_PARAM_FW_LOAD_POLICY_VALUE_DRIVER,
182 	DEVLINK_PARAM_FW_LOAD_POLICY_VALUE_FLASH,
183 };
184 
185 enum devlink_attr {
186 	/* don't change the order or add anything between, this is ABI! */
187 	DEVLINK_ATTR_UNSPEC,
188 
189 	/* bus name + dev name together are a handle for devlink entity */
190 	DEVLINK_ATTR_BUS_NAME,			/* string */
191 	DEVLINK_ATTR_DEV_NAME,			/* string */
192 
193 	DEVLINK_ATTR_PORT_INDEX,		/* u32 */
194 	DEVLINK_ATTR_PORT_TYPE,			/* u16 */
195 	DEVLINK_ATTR_PORT_DESIRED_TYPE,		/* u16 */
196 	DEVLINK_ATTR_PORT_NETDEV_IFINDEX,	/* u32 */
197 	DEVLINK_ATTR_PORT_NETDEV_NAME,		/* string */
198 	DEVLINK_ATTR_PORT_IBDEV_NAME,		/* string */
199 	DEVLINK_ATTR_PORT_SPLIT_COUNT,		/* u32 */
200 	DEVLINK_ATTR_PORT_SPLIT_GROUP,		/* u32 */
201 	DEVLINK_ATTR_SB_INDEX,			/* u32 */
202 	DEVLINK_ATTR_SB_SIZE,			/* u32 */
203 	DEVLINK_ATTR_SB_INGRESS_POOL_COUNT,	/* u16 */
204 	DEVLINK_ATTR_SB_EGRESS_POOL_COUNT,	/* u16 */
205 	DEVLINK_ATTR_SB_INGRESS_TC_COUNT,	/* u16 */
206 	DEVLINK_ATTR_SB_EGRESS_TC_COUNT,	/* u16 */
207 	DEVLINK_ATTR_SB_POOL_INDEX,		/* u16 */
208 	DEVLINK_ATTR_SB_POOL_TYPE,		/* u8 */
209 	DEVLINK_ATTR_SB_POOL_SIZE,		/* u32 */
210 	DEVLINK_ATTR_SB_POOL_THRESHOLD_TYPE,	/* u8 */
211 	DEVLINK_ATTR_SB_THRESHOLD,		/* u32 */
212 	DEVLINK_ATTR_SB_TC_INDEX,		/* u16 */
213 	DEVLINK_ATTR_SB_OCC_CUR,		/* u32 */
214 	DEVLINK_ATTR_SB_OCC_MAX,		/* u32 */
215 	DEVLINK_ATTR_ESWITCH_MODE,		/* u16 */
216 	DEVLINK_ATTR_ESWITCH_INLINE_MODE,	/* u8 */
217 
218 	DEVLINK_ATTR_DPIPE_TABLES,		/* nested */
219 	DEVLINK_ATTR_DPIPE_TABLE,		/* nested */
220 	DEVLINK_ATTR_DPIPE_TABLE_NAME,		/* string */
221 	DEVLINK_ATTR_DPIPE_TABLE_SIZE,		/* u64 */
222 	DEVLINK_ATTR_DPIPE_TABLE_MATCHES,	/* nested */
223 	DEVLINK_ATTR_DPIPE_TABLE_ACTIONS,	/* nested */
224 	DEVLINK_ATTR_DPIPE_TABLE_COUNTERS_ENABLED,	/* u8 */
225 
226 	DEVLINK_ATTR_DPIPE_ENTRIES,		/* nested */
227 	DEVLINK_ATTR_DPIPE_ENTRY,		/* nested */
228 	DEVLINK_ATTR_DPIPE_ENTRY_INDEX,		/* u64 */
229 	DEVLINK_ATTR_DPIPE_ENTRY_MATCH_VALUES,	/* nested */
230 	DEVLINK_ATTR_DPIPE_ENTRY_ACTION_VALUES,	/* nested */
231 	DEVLINK_ATTR_DPIPE_ENTRY_COUNTER,	/* u64 */
232 
233 	DEVLINK_ATTR_DPIPE_MATCH,		/* nested */
234 	DEVLINK_ATTR_DPIPE_MATCH_VALUE,		/* nested */
235 	DEVLINK_ATTR_DPIPE_MATCH_TYPE,		/* u32 */
236 
237 	DEVLINK_ATTR_DPIPE_ACTION,		/* nested */
238 	DEVLINK_ATTR_DPIPE_ACTION_VALUE,	/* nested */
239 	DEVLINK_ATTR_DPIPE_ACTION_TYPE,		/* u32 */
240 
241 	DEVLINK_ATTR_DPIPE_VALUE,
242 	DEVLINK_ATTR_DPIPE_VALUE_MASK,
243 	DEVLINK_ATTR_DPIPE_VALUE_MAPPING,	/* u32 */
244 
245 	DEVLINK_ATTR_DPIPE_HEADERS,		/* nested */
246 	DEVLINK_ATTR_DPIPE_HEADER,		/* nested */
247 	DEVLINK_ATTR_DPIPE_HEADER_NAME,		/* string */
248 	DEVLINK_ATTR_DPIPE_HEADER_ID,		/* u32 */
249 	DEVLINK_ATTR_DPIPE_HEADER_FIELDS,	/* nested */
250 	DEVLINK_ATTR_DPIPE_HEADER_GLOBAL,	/* u8 */
251 	DEVLINK_ATTR_DPIPE_HEADER_INDEX,	/* u32 */
252 
253 	DEVLINK_ATTR_DPIPE_FIELD,		/* nested */
254 	DEVLINK_ATTR_DPIPE_FIELD_NAME,		/* string */
255 	DEVLINK_ATTR_DPIPE_FIELD_ID,		/* u32 */
256 	DEVLINK_ATTR_DPIPE_FIELD_BITWIDTH,	/* u32 */
257 	DEVLINK_ATTR_DPIPE_FIELD_MAPPING_TYPE,	/* u32 */
258 
259 	DEVLINK_ATTR_PAD,
260 
261 	DEVLINK_ATTR_ESWITCH_ENCAP_MODE,	/* u8 */
262 	DEVLINK_ATTR_RESOURCE_LIST,		/* nested */
263 	DEVLINK_ATTR_RESOURCE,			/* nested */
264 	DEVLINK_ATTR_RESOURCE_NAME,		/* string */
265 	DEVLINK_ATTR_RESOURCE_ID,		/* u64 */
266 	DEVLINK_ATTR_RESOURCE_SIZE,		/* u64 */
267 	DEVLINK_ATTR_RESOURCE_SIZE_NEW,		/* u64 */
268 	DEVLINK_ATTR_RESOURCE_SIZE_VALID,	/* u8 */
269 	DEVLINK_ATTR_RESOURCE_SIZE_MIN,		/* u64 */
270 	DEVLINK_ATTR_RESOURCE_SIZE_MAX,		/* u64 */
271 	DEVLINK_ATTR_RESOURCE_SIZE_GRAN,        /* u64 */
272 	DEVLINK_ATTR_RESOURCE_UNIT,		/* u8 */
273 	DEVLINK_ATTR_RESOURCE_OCC,		/* u64 */
274 	DEVLINK_ATTR_DPIPE_TABLE_RESOURCE_ID,	/* u64 */
275 	DEVLINK_ATTR_DPIPE_TABLE_RESOURCE_UNITS,/* u64 */
276 
277 	DEVLINK_ATTR_PORT_FLAVOUR,		/* u16 */
278 	DEVLINK_ATTR_PORT_NUMBER,		/* u32 */
279 	DEVLINK_ATTR_PORT_SPLIT_SUBPORT_NUMBER,	/* u32 */
280 
281 	DEVLINK_ATTR_PARAM,			/* nested */
282 	DEVLINK_ATTR_PARAM_NAME,		/* string */
283 	DEVLINK_ATTR_PARAM_GENERIC,		/* flag */
284 	DEVLINK_ATTR_PARAM_TYPE,		/* u8 */
285 	DEVLINK_ATTR_PARAM_VALUES_LIST,		/* nested */
286 	DEVLINK_ATTR_PARAM_VALUE,		/* nested */
287 	DEVLINK_ATTR_PARAM_VALUE_DATA,		/* dynamic */
288 	DEVLINK_ATTR_PARAM_VALUE_CMODE,		/* u8 */
289 
290 	DEVLINK_ATTR_REGION_NAME,               /* string */
291 	DEVLINK_ATTR_REGION_SIZE,               /* u64 */
292 	DEVLINK_ATTR_REGION_SNAPSHOTS,          /* nested */
293 	DEVLINK_ATTR_REGION_SNAPSHOT,           /* nested */
294 	DEVLINK_ATTR_REGION_SNAPSHOT_ID,        /* u32 */
295 
296 	DEVLINK_ATTR_REGION_CHUNKS,             /* nested */
297 	DEVLINK_ATTR_REGION_CHUNK,              /* nested */
298 	DEVLINK_ATTR_REGION_CHUNK_DATA,         /* binary */
299 	DEVLINK_ATTR_REGION_CHUNK_ADDR,         /* u64 */
300 	DEVLINK_ATTR_REGION_CHUNK_LEN,          /* u64 */
301 
302 	DEVLINK_ATTR_INFO_DRIVER_NAME,		/* string */
303 	DEVLINK_ATTR_INFO_SERIAL_NUMBER,	/* string */
304 	DEVLINK_ATTR_INFO_VERSION_FIXED,	/* nested */
305 	DEVLINK_ATTR_INFO_VERSION_RUNNING,	/* nested */
306 	DEVLINK_ATTR_INFO_VERSION_STORED,	/* nested */
307 	DEVLINK_ATTR_INFO_VERSION_NAME,		/* string */
308 	DEVLINK_ATTR_INFO_VERSION_VALUE,	/* string */
309 
310 	DEVLINK_ATTR_SB_POOL_CELL_SIZE,		/* u32 */
311 
312 	DEVLINK_ATTR_FMSG,			/* nested */
313 	DEVLINK_ATTR_FMSG_OBJ_NEST_START,	/* flag */
314 	DEVLINK_ATTR_FMSG_PAIR_NEST_START,	/* flag */
315 	DEVLINK_ATTR_FMSG_ARR_NEST_START,	/* flag */
316 	DEVLINK_ATTR_FMSG_NEST_END,		/* flag */
317 	DEVLINK_ATTR_FMSG_OBJ_NAME,		/* string */
318 	DEVLINK_ATTR_FMSG_OBJ_VALUE_TYPE,	/* u8 */
319 	DEVLINK_ATTR_FMSG_OBJ_VALUE_DATA,	/* dynamic */
320 
321 	DEVLINK_ATTR_HEALTH_REPORTER,			/* nested */
322 	DEVLINK_ATTR_HEALTH_REPORTER_NAME,		/* string */
323 	DEVLINK_ATTR_HEALTH_REPORTER_STATE,		/* u8 */
324 	DEVLINK_ATTR_HEALTH_REPORTER_ERR,		/* u64 */
325 	DEVLINK_ATTR_HEALTH_REPORTER_RECOVER,		/* u64 */
326 	DEVLINK_ATTR_HEALTH_REPORTER_DUMP_TS,		/* u64 */
327 	DEVLINK_ATTR_HEALTH_REPORTER_GRACEFUL_PERIOD,	/* u64 */
328 	DEVLINK_ATTR_HEALTH_REPORTER_AUTO_RECOVER,	/* u8 */
329 	/* add new attributes above here, update the policy in devlink.c */
330 
331 	__DEVLINK_ATTR_MAX,
332 	DEVLINK_ATTR_MAX = __DEVLINK_ATTR_MAX - 1
333 };
334 
335 /* Mapping between internal resource described by the field and system
336  * structure
337  */
338 enum devlink_dpipe_field_mapping_type {
339 	DEVLINK_DPIPE_FIELD_MAPPING_TYPE_NONE,
340 	DEVLINK_DPIPE_FIELD_MAPPING_TYPE_IFINDEX,
341 };
342 
343 /* Match type - specify the type of the match */
344 enum devlink_dpipe_match_type {
345 	DEVLINK_DPIPE_MATCH_TYPE_FIELD_EXACT,
346 };
347 
348 /* Action type - specify the action type */
349 enum devlink_dpipe_action_type {
350 	DEVLINK_DPIPE_ACTION_TYPE_FIELD_MODIFY,
351 };
352 
353 enum devlink_dpipe_field_ethernet_id {
354 	DEVLINK_DPIPE_FIELD_ETHERNET_DST_MAC,
355 };
356 
357 enum devlink_dpipe_field_ipv4_id {
358 	DEVLINK_DPIPE_FIELD_IPV4_DST_IP,
359 };
360 
361 enum devlink_dpipe_field_ipv6_id {
362 	DEVLINK_DPIPE_FIELD_IPV6_DST_IP,
363 };
364 
365 enum devlink_dpipe_header_id {
366 	DEVLINK_DPIPE_HEADER_ETHERNET,
367 	DEVLINK_DPIPE_HEADER_IPV4,
368 	DEVLINK_DPIPE_HEADER_IPV6,
369 };
370 
371 enum devlink_resource_unit {
372 	DEVLINK_RESOURCE_UNIT_ENTRY,
373 };
374 
375 #endif /* _UAPI_LINUX_DEVLINK_H_ */
376