xref: /linux-6.15/include/uapi/linux/devlink.h (revision 139752a2)
1 /*
2  * include/uapi/linux/devlink.h - Network physical device Netlink interface
3  * Copyright (c) 2016 Mellanox Technologies. All rights reserved.
4  * Copyright (c) 2016 Jiri Pirko <[email protected]>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  */
11 
12 #ifndef _UAPI_LINUX_DEVLINK_H_
13 #define _UAPI_LINUX_DEVLINK_H_
14 
15 #define DEVLINK_GENL_NAME "devlink"
16 #define DEVLINK_GENL_VERSION 0x1
17 #define DEVLINK_GENL_MCGRP_CONFIG_NAME "config"
18 
19 enum devlink_command {
20 	/* don't change the order or add anything between, this is ABI! */
21 	DEVLINK_CMD_UNSPEC,
22 
23 	DEVLINK_CMD_GET,		/* can dump */
24 	DEVLINK_CMD_SET,
25 	DEVLINK_CMD_NEW,
26 	DEVLINK_CMD_DEL,
27 
28 	DEVLINK_CMD_PORT_GET,		/* can dump */
29 	DEVLINK_CMD_PORT_SET,
30 	DEVLINK_CMD_PORT_NEW,
31 	DEVLINK_CMD_PORT_DEL,
32 
33 	DEVLINK_CMD_PORT_SPLIT,
34 	DEVLINK_CMD_PORT_UNSPLIT,
35 
36 	DEVLINK_CMD_SB_GET,		/* can dump */
37 	DEVLINK_CMD_SB_SET,
38 	DEVLINK_CMD_SB_NEW,
39 	DEVLINK_CMD_SB_DEL,
40 
41 	DEVLINK_CMD_SB_POOL_GET,	/* can dump */
42 	DEVLINK_CMD_SB_POOL_SET,
43 	DEVLINK_CMD_SB_POOL_NEW,
44 	DEVLINK_CMD_SB_POOL_DEL,
45 
46 	DEVLINK_CMD_SB_PORT_POOL_GET,	/* can dump */
47 	DEVLINK_CMD_SB_PORT_POOL_SET,
48 	DEVLINK_CMD_SB_PORT_POOL_NEW,
49 	DEVLINK_CMD_SB_PORT_POOL_DEL,
50 
51 	DEVLINK_CMD_SB_TC_POOL_BIND_GET,	/* can dump */
52 	DEVLINK_CMD_SB_TC_POOL_BIND_SET,
53 	DEVLINK_CMD_SB_TC_POOL_BIND_NEW,
54 	DEVLINK_CMD_SB_TC_POOL_BIND_DEL,
55 
56 	/* Shared buffer occupancy monitoring commands */
57 	DEVLINK_CMD_SB_OCC_SNAPSHOT,
58 	DEVLINK_CMD_SB_OCC_MAX_CLEAR,
59 
60 	DEVLINK_CMD_ESWITCH_GET,
61 #define DEVLINK_CMD_ESWITCH_MODE_GET /* obsolete, never use this! */ \
62 	DEVLINK_CMD_ESWITCH_GET
63 
64 	DEVLINK_CMD_ESWITCH_SET,
65 #define DEVLINK_CMD_ESWITCH_MODE_SET /* obsolete, never use this! */ \
66 	DEVLINK_CMD_ESWITCH_SET
67 
68 	/* add new commands above here */
69 
70 	__DEVLINK_CMD_MAX,
71 	DEVLINK_CMD_MAX = __DEVLINK_CMD_MAX - 1
72 };
73 
74 enum devlink_port_type {
75 	DEVLINK_PORT_TYPE_NOTSET,
76 	DEVLINK_PORT_TYPE_AUTO,
77 	DEVLINK_PORT_TYPE_ETH,
78 	DEVLINK_PORT_TYPE_IB,
79 };
80 
81 enum devlink_sb_pool_type {
82 	DEVLINK_SB_POOL_TYPE_INGRESS,
83 	DEVLINK_SB_POOL_TYPE_EGRESS,
84 };
85 
86 /* static threshold - limiting the maximum number of bytes.
87  * dynamic threshold - limiting the maximum number of bytes
88  *   based on the currently available free space in the shared buffer pool.
89  *   In this mode, the maximum quota is calculated based
90  *   on the following formula:
91  *     max_quota = alpha / (1 + alpha) * Free_Buffer
92  *   While Free_Buffer is the amount of none-occupied buffer associated to
93  *   the relevant pool.
94  *   The value range which can be passed is 0-20 and serves
95  *   for computation of alpha by following formula:
96  *     alpha = 2 ^ (passed_value - 10)
97  */
98 
99 enum devlink_sb_threshold_type {
100 	DEVLINK_SB_THRESHOLD_TYPE_STATIC,
101 	DEVLINK_SB_THRESHOLD_TYPE_DYNAMIC,
102 };
103 
104 #define DEVLINK_SB_THRESHOLD_TO_ALPHA_MAX 20
105 
106 enum devlink_eswitch_mode {
107 	DEVLINK_ESWITCH_MODE_LEGACY,
108 	DEVLINK_ESWITCH_MODE_SWITCHDEV,
109 };
110 
111 enum devlink_eswitch_inline_mode {
112 	DEVLINK_ESWITCH_INLINE_MODE_NONE,
113 	DEVLINK_ESWITCH_INLINE_MODE_LINK,
114 	DEVLINK_ESWITCH_INLINE_MODE_NETWORK,
115 	DEVLINK_ESWITCH_INLINE_MODE_TRANSPORT,
116 };
117 
118 enum devlink_attr {
119 	/* don't change the order or add anything between, this is ABI! */
120 	DEVLINK_ATTR_UNSPEC,
121 
122 	/* bus name + dev name together are a handle for devlink entity */
123 	DEVLINK_ATTR_BUS_NAME,			/* string */
124 	DEVLINK_ATTR_DEV_NAME,			/* string */
125 
126 	DEVLINK_ATTR_PORT_INDEX,		/* u32 */
127 	DEVLINK_ATTR_PORT_TYPE,			/* u16 */
128 	DEVLINK_ATTR_PORT_DESIRED_TYPE,		/* u16 */
129 	DEVLINK_ATTR_PORT_NETDEV_IFINDEX,	/* u32 */
130 	DEVLINK_ATTR_PORT_NETDEV_NAME,		/* string */
131 	DEVLINK_ATTR_PORT_IBDEV_NAME,		/* string */
132 	DEVLINK_ATTR_PORT_SPLIT_COUNT,		/* u32 */
133 	DEVLINK_ATTR_PORT_SPLIT_GROUP,		/* u32 */
134 	DEVLINK_ATTR_SB_INDEX,			/* u32 */
135 	DEVLINK_ATTR_SB_SIZE,			/* u32 */
136 	DEVLINK_ATTR_SB_INGRESS_POOL_COUNT,	/* u16 */
137 	DEVLINK_ATTR_SB_EGRESS_POOL_COUNT,	/* u16 */
138 	DEVLINK_ATTR_SB_INGRESS_TC_COUNT,	/* u16 */
139 	DEVLINK_ATTR_SB_EGRESS_TC_COUNT,	/* u16 */
140 	DEVLINK_ATTR_SB_POOL_INDEX,		/* u16 */
141 	DEVLINK_ATTR_SB_POOL_TYPE,		/* u8 */
142 	DEVLINK_ATTR_SB_POOL_SIZE,		/* u32 */
143 	DEVLINK_ATTR_SB_POOL_THRESHOLD_TYPE,	/* u8 */
144 	DEVLINK_ATTR_SB_THRESHOLD,		/* u32 */
145 	DEVLINK_ATTR_SB_TC_INDEX,		/* u16 */
146 	DEVLINK_ATTR_SB_OCC_CUR,		/* u32 */
147 	DEVLINK_ATTR_SB_OCC_MAX,		/* u32 */
148 	DEVLINK_ATTR_ESWITCH_MODE,		/* u16 */
149 	DEVLINK_ATTR_ESWITCH_INLINE_MODE,	/* u8 */
150 
151 	/* add new attributes above here, update the policy in devlink.c */
152 
153 	__DEVLINK_ATTR_MAX,
154 	DEVLINK_ATTR_MAX = __DEVLINK_ATTR_MAX - 1
155 };
156 
157 #endif /* _UAPI_LINUX_DEVLINK_H_ */
158