xref: /linux-6.15/include/net/devlink.h (revision 6fd1d51c)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  * include/net/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 #ifndef _NET_DEVLINK_H_
8 #define _NET_DEVLINK_H_
9 
10 #include <linux/device.h>
11 #include <linux/slab.h>
12 #include <linux/gfp.h>
13 #include <linux/list.h>
14 #include <linux/netdevice.h>
15 #include <linux/spinlock.h>
16 #include <linux/workqueue.h>
17 #include <linux/refcount.h>
18 #include <net/net_namespace.h>
19 #include <net/flow_offload.h>
20 #include <uapi/linux/devlink.h>
21 #include <linux/xarray.h>
22 #include <linux/firmware.h>
23 
24 struct devlink;
25 struct devlink_linecard;
26 
27 struct devlink_port_phys_attrs {
28 	u32 port_number; /* Same value as "split group".
29 			  * A physical port which is visible to the user
30 			  * for a given port flavour.
31 			  */
32 	u32 split_subport_number; /* If the port is split, this is the number of subport. */
33 };
34 
35 /**
36  * struct devlink_port_pci_pf_attrs - devlink port's PCI PF attributes
37  * @controller: Associated controller number
38  * @pf: Associated PCI PF number for this port.
39  * @external: when set, indicates if a port is for an external controller
40  */
41 struct devlink_port_pci_pf_attrs {
42 	u32 controller;
43 	u16 pf;
44 	u8 external:1;
45 };
46 
47 /**
48  * struct devlink_port_pci_vf_attrs - devlink port's PCI VF attributes
49  * @controller: Associated controller number
50  * @pf: Associated PCI PF number for this port.
51  * @vf: Associated PCI VF for of the PCI PF for this port.
52  * @external: when set, indicates if a port is for an external controller
53  */
54 struct devlink_port_pci_vf_attrs {
55 	u32 controller;
56 	u16 pf;
57 	u16 vf;
58 	u8 external:1;
59 };
60 
61 /**
62  * struct devlink_port_pci_sf_attrs - devlink port's PCI SF attributes
63  * @controller: Associated controller number
64  * @sf: Associated PCI SF for of the PCI PF for this port.
65  * @pf: Associated PCI PF number for this port.
66  * @external: when set, indicates if a port is for an external controller
67  */
68 struct devlink_port_pci_sf_attrs {
69 	u32 controller;
70 	u32 sf;
71 	u16 pf;
72 	u8 external:1;
73 };
74 
75 /**
76  * struct devlink_port_attrs - devlink port object
77  * @flavour: flavour of the port
78  * @split: indicates if this is split port
79  * @splittable: indicates if the port can be split.
80  * @lanes: maximum number of lanes the port supports. 0 value is not passed to netlink.
81  * @switch_id: if the port is part of switch, this is buffer with ID, otherwise this is NULL
82  * @phys: physical port attributes
83  * @pci_pf: PCI PF port attributes
84  * @pci_vf: PCI VF port attributes
85  * @pci_sf: PCI SF port attributes
86  */
87 struct devlink_port_attrs {
88 	u8 split:1,
89 	   splittable:1;
90 	u32 lanes;
91 	enum devlink_port_flavour flavour;
92 	struct netdev_phys_item_id switch_id;
93 	union {
94 		struct devlink_port_phys_attrs phys;
95 		struct devlink_port_pci_pf_attrs pci_pf;
96 		struct devlink_port_pci_vf_attrs pci_vf;
97 		struct devlink_port_pci_sf_attrs pci_sf;
98 	};
99 };
100 
101 struct devlink_rate {
102 	struct list_head list;
103 	enum devlink_rate_type type;
104 	struct devlink *devlink;
105 	void *priv;
106 	u64 tx_share;
107 	u64 tx_max;
108 
109 	struct devlink_rate *parent;
110 	union {
111 		struct devlink_port *devlink_port;
112 		struct {
113 			char *name;
114 			refcount_t refcnt;
115 		};
116 	};
117 };
118 
119 struct devlink_port {
120 	struct list_head list;
121 	struct list_head param_list;
122 	struct list_head region_list;
123 	struct devlink *devlink;
124 	unsigned int index;
125 	spinlock_t type_lock; /* Protects type and type_dev
126 			       * pointer consistency.
127 			       */
128 	enum devlink_port_type type;
129 	enum devlink_port_type desired_type;
130 	void *type_dev;
131 	struct devlink_port_attrs attrs;
132 	u8 attrs_set:1,
133 	   switch_port:1;
134 	struct delayed_work type_warn_dw;
135 	struct list_head reporter_list;
136 	struct mutex reporters_lock; /* Protects reporter_list */
137 
138 	struct devlink_rate *devlink_rate;
139 	struct devlink_linecard *linecard;
140 };
141 
142 struct devlink_port_new_attrs {
143 	enum devlink_port_flavour flavour;
144 	unsigned int port_index;
145 	u32 controller;
146 	u32 sfnum;
147 	u16 pfnum;
148 	u8 port_index_valid:1,
149 	   controller_valid:1,
150 	   sfnum_valid:1;
151 };
152 
153 struct devlink_info_req;
154 struct devlink_linecard_device;
155 
156 /**
157  * struct devlink_linecard_ops - Linecard operations
158  * @provision: callback to provision the linecard slot with certain
159  *	       type of linecard. As a result of this operation,
160  *	       driver is expected to eventually (could be after
161  *	       the function call returns) call one of:
162  *	       devlink_linecard_provision_set()
163  *	       devlink_linecard_provision_fail()
164  * @unprovision: callback to unprovision the linecard slot. As a result
165  *		 of this operation, driver is expected to eventually
166  *		 (could be after the function call returns) call
167  *	         devlink_linecard_provision_clear()
168  *	         devlink_linecard_provision_fail()
169  * @same_provision: callback to ask the driver if linecard is already
170  *                  provisioned in the same way user asks this linecard to be
171  *                  provisioned.
172  * @types_count: callback to get number of supported types
173  * @types_get: callback to get next type in list
174  * @info_get: callback to get linecard info
175  * @device_info_get: callback to get linecard device info
176  */
177 struct devlink_linecard_ops {
178 	int (*provision)(struct devlink_linecard *linecard, void *priv,
179 			 const char *type, const void *type_priv,
180 			 struct netlink_ext_ack *extack);
181 	int (*unprovision)(struct devlink_linecard *linecard, void *priv,
182 			   struct netlink_ext_ack *extack);
183 	bool (*same_provision)(struct devlink_linecard *linecard, void *priv,
184 			       const char *type, const void *type_priv);
185 	unsigned int (*types_count)(struct devlink_linecard *linecard,
186 				    void *priv);
187 	void (*types_get)(struct devlink_linecard *linecard,
188 			  void *priv, unsigned int index, const char **type,
189 			  const void **type_priv);
190 	int (*info_get)(struct devlink_linecard *linecard, void *priv,
191 			struct devlink_info_req *req,
192 			struct netlink_ext_ack *extack);
193 	int (*device_info_get)(struct devlink_linecard_device *device,
194 			       void *priv, struct devlink_info_req *req,
195 			       struct netlink_ext_ack *extack);
196 };
197 
198 struct devlink_sb_pool_info {
199 	enum devlink_sb_pool_type pool_type;
200 	u32 size;
201 	enum devlink_sb_threshold_type threshold_type;
202 	u32 cell_size;
203 };
204 
205 /**
206  * struct devlink_dpipe_field - dpipe field object
207  * @name: field name
208  * @id: index inside the headers field array
209  * @bitwidth: bitwidth
210  * @mapping_type: mapping type
211  */
212 struct devlink_dpipe_field {
213 	const char *name;
214 	unsigned int id;
215 	unsigned int bitwidth;
216 	enum devlink_dpipe_field_mapping_type mapping_type;
217 };
218 
219 /**
220  * struct devlink_dpipe_header - dpipe header object
221  * @name: header name
222  * @id: index, global/local detrmined by global bit
223  * @fields: fields
224  * @fields_count: number of fields
225  * @global: indicates if header is shared like most protocol header
226  *	    or driver specific
227  */
228 struct devlink_dpipe_header {
229 	const char *name;
230 	unsigned int id;
231 	struct devlink_dpipe_field *fields;
232 	unsigned int fields_count;
233 	bool global;
234 };
235 
236 /**
237  * struct devlink_dpipe_match - represents match operation
238  * @type: type of match
239  * @header_index: header index (packets can have several headers of same
240  *		  type like in case of tunnels)
241  * @header: header
242  * @fieled_id: field index
243  */
244 struct devlink_dpipe_match {
245 	enum devlink_dpipe_match_type type;
246 	unsigned int header_index;
247 	struct devlink_dpipe_header *header;
248 	unsigned int field_id;
249 };
250 
251 /**
252  * struct devlink_dpipe_action - represents action operation
253  * @type: type of action
254  * @header_index: header index (packets can have several headers of same
255  *		  type like in case of tunnels)
256  * @header: header
257  * @fieled_id: field index
258  */
259 struct devlink_dpipe_action {
260 	enum devlink_dpipe_action_type type;
261 	unsigned int header_index;
262 	struct devlink_dpipe_header *header;
263 	unsigned int field_id;
264 };
265 
266 /**
267  * struct devlink_dpipe_value - represents value of match/action
268  * @action: action
269  * @match: match
270  * @mapping_value: in case the field has some mapping this value
271  *                 specified the mapping value
272  * @mapping_valid: specify if mapping value is valid
273  * @value_size: value size
274  * @value: value
275  * @mask: bit mask
276  */
277 struct devlink_dpipe_value {
278 	union {
279 		struct devlink_dpipe_action *action;
280 		struct devlink_dpipe_match *match;
281 	};
282 	unsigned int mapping_value;
283 	bool mapping_valid;
284 	unsigned int value_size;
285 	void *value;
286 	void *mask;
287 };
288 
289 /**
290  * struct devlink_dpipe_entry - table entry object
291  * @index: index of the entry in the table
292  * @match_values: match values
293  * @matche_values_count: count of matches tuples
294  * @action_values: actions values
295  * @action_values_count: count of actions values
296  * @counter: value of counter
297  * @counter_valid: Specify if value is valid from hardware
298  */
299 struct devlink_dpipe_entry {
300 	u64 index;
301 	struct devlink_dpipe_value *match_values;
302 	unsigned int match_values_count;
303 	struct devlink_dpipe_value *action_values;
304 	unsigned int action_values_count;
305 	u64 counter;
306 	bool counter_valid;
307 };
308 
309 /**
310  * struct devlink_dpipe_dump_ctx - context provided to driver in order
311  *				   to dump
312  * @info: info
313  * @cmd: devlink command
314  * @skb: skb
315  * @nest: top attribute
316  * @hdr: hdr
317  */
318 struct devlink_dpipe_dump_ctx {
319 	struct genl_info *info;
320 	enum devlink_command cmd;
321 	struct sk_buff *skb;
322 	struct nlattr *nest;
323 	void *hdr;
324 };
325 
326 struct devlink_dpipe_table_ops;
327 
328 /**
329  * struct devlink_dpipe_table - table object
330  * @priv: private
331  * @name: table name
332  * @counters_enabled: indicates if counters are active
333  * @counter_control_extern: indicates if counter control is in dpipe or
334  *			    external tool
335  * @resource_valid: Indicate that the resource id is valid
336  * @resource_id: relative resource this table is related to
337  * @resource_units: number of resource's unit consumed per table's entry
338  * @table_ops: table operations
339  * @rcu: rcu
340  */
341 struct devlink_dpipe_table {
342 	void *priv;
343 	struct list_head list;
344 	const char *name;
345 	bool counters_enabled;
346 	bool counter_control_extern;
347 	bool resource_valid;
348 	u64 resource_id;
349 	u64 resource_units;
350 	struct devlink_dpipe_table_ops *table_ops;
351 	struct rcu_head rcu;
352 };
353 
354 /**
355  * struct devlink_dpipe_table_ops - dpipe_table ops
356  * @actions_dump - dumps all tables actions
357  * @matches_dump - dumps all tables matches
358  * @entries_dump - dumps all active entries in the table
359  * @counters_set_update - when changing the counter status hardware sync
360  *			  maybe needed to allocate/free counter related
361  *			  resources
362  * @size_get - get size
363  */
364 struct devlink_dpipe_table_ops {
365 	int (*actions_dump)(void *priv, struct sk_buff *skb);
366 	int (*matches_dump)(void *priv, struct sk_buff *skb);
367 	int (*entries_dump)(void *priv, bool counters_enabled,
368 			    struct devlink_dpipe_dump_ctx *dump_ctx);
369 	int (*counters_set_update)(void *priv, bool enable);
370 	u64 (*size_get)(void *priv);
371 };
372 
373 /**
374  * struct devlink_dpipe_headers - dpipe headers
375  * @headers - header array can be shared (global bit) or driver specific
376  * @headers_count - count of headers
377  */
378 struct devlink_dpipe_headers {
379 	struct devlink_dpipe_header **headers;
380 	unsigned int headers_count;
381 };
382 
383 /**
384  * struct devlink_resource_size_params - resource's size parameters
385  * @size_min: minimum size which can be set
386  * @size_max: maximum size which can be set
387  * @size_granularity: size granularity
388  * @size_unit: resource's basic unit
389  */
390 struct devlink_resource_size_params {
391 	u64 size_min;
392 	u64 size_max;
393 	u64 size_granularity;
394 	enum devlink_resource_unit unit;
395 };
396 
397 static inline void
398 devlink_resource_size_params_init(struct devlink_resource_size_params *size_params,
399 				  u64 size_min, u64 size_max,
400 				  u64 size_granularity,
401 				  enum devlink_resource_unit unit)
402 {
403 	size_params->size_min = size_min;
404 	size_params->size_max = size_max;
405 	size_params->size_granularity = size_granularity;
406 	size_params->unit = unit;
407 }
408 
409 typedef u64 devlink_resource_occ_get_t(void *priv);
410 
411 #define DEVLINK_RESOURCE_ID_PARENT_TOP 0
412 
413 #define DEVLINK_RESOURCE_GENERIC_NAME_PORTS "physical_ports"
414 
415 #define __DEVLINK_PARAM_MAX_STRING_VALUE 32
416 enum devlink_param_type {
417 	DEVLINK_PARAM_TYPE_U8,
418 	DEVLINK_PARAM_TYPE_U16,
419 	DEVLINK_PARAM_TYPE_U32,
420 	DEVLINK_PARAM_TYPE_STRING,
421 	DEVLINK_PARAM_TYPE_BOOL,
422 };
423 
424 union devlink_param_value {
425 	u8 vu8;
426 	u16 vu16;
427 	u32 vu32;
428 	char vstr[__DEVLINK_PARAM_MAX_STRING_VALUE];
429 	bool vbool;
430 };
431 
432 struct devlink_param_gset_ctx {
433 	union devlink_param_value val;
434 	enum devlink_param_cmode cmode;
435 };
436 
437 /**
438  * struct devlink_flash_notify - devlink dev flash notify data
439  * @status_msg: current status string
440  * @component: firmware component being updated
441  * @done: amount of work completed of total amount
442  * @total: amount of work expected to be done
443  * @timeout: expected max timeout in seconds
444  *
445  * These are values to be given to userland to be displayed in order
446  * to show current activity in a firmware update process.
447  */
448 struct devlink_flash_notify {
449 	const char *status_msg;
450 	const char *component;
451 	unsigned long done;
452 	unsigned long total;
453 	unsigned long timeout;
454 };
455 
456 /**
457  * struct devlink_param - devlink configuration parameter data
458  * @name: name of the parameter
459  * @generic: indicates if the parameter is generic or driver specific
460  * @type: parameter type
461  * @supported_cmodes: bitmap of supported configuration modes
462  * @get: get parameter value, used for runtime and permanent
463  *       configuration modes
464  * @set: set parameter value, used for runtime and permanent
465  *       configuration modes
466  * @validate: validate input value is applicable (within value range, etc.)
467  *
468  * This struct should be used by the driver to fill the data for
469  * a parameter it registers.
470  */
471 struct devlink_param {
472 	u32 id;
473 	const char *name;
474 	bool generic;
475 	enum devlink_param_type type;
476 	unsigned long supported_cmodes;
477 	int (*get)(struct devlink *devlink, u32 id,
478 		   struct devlink_param_gset_ctx *ctx);
479 	int (*set)(struct devlink *devlink, u32 id,
480 		   struct devlink_param_gset_ctx *ctx);
481 	int (*validate)(struct devlink *devlink, u32 id,
482 			union devlink_param_value val,
483 			struct netlink_ext_ack *extack);
484 };
485 
486 struct devlink_param_item {
487 	struct list_head list;
488 	const struct devlink_param *param;
489 	union devlink_param_value driverinit_value;
490 	bool driverinit_value_valid;
491 };
492 
493 enum devlink_param_generic_id {
494 	DEVLINK_PARAM_GENERIC_ID_INT_ERR_RESET,
495 	DEVLINK_PARAM_GENERIC_ID_MAX_MACS,
496 	DEVLINK_PARAM_GENERIC_ID_ENABLE_SRIOV,
497 	DEVLINK_PARAM_GENERIC_ID_REGION_SNAPSHOT,
498 	DEVLINK_PARAM_GENERIC_ID_IGNORE_ARI,
499 	DEVLINK_PARAM_GENERIC_ID_MSIX_VEC_PER_PF_MAX,
500 	DEVLINK_PARAM_GENERIC_ID_MSIX_VEC_PER_PF_MIN,
501 	DEVLINK_PARAM_GENERIC_ID_FW_LOAD_POLICY,
502 	DEVLINK_PARAM_GENERIC_ID_RESET_DEV_ON_DRV_PROBE,
503 	DEVLINK_PARAM_GENERIC_ID_ENABLE_ROCE,
504 	DEVLINK_PARAM_GENERIC_ID_ENABLE_REMOTE_DEV_RESET,
505 	DEVLINK_PARAM_GENERIC_ID_ENABLE_ETH,
506 	DEVLINK_PARAM_GENERIC_ID_ENABLE_RDMA,
507 	DEVLINK_PARAM_GENERIC_ID_ENABLE_VNET,
508 	DEVLINK_PARAM_GENERIC_ID_ENABLE_IWARP,
509 	DEVLINK_PARAM_GENERIC_ID_IO_EQ_SIZE,
510 	DEVLINK_PARAM_GENERIC_ID_EVENT_EQ_SIZE,
511 
512 	/* add new param generic ids above here*/
513 	__DEVLINK_PARAM_GENERIC_ID_MAX,
514 	DEVLINK_PARAM_GENERIC_ID_MAX = __DEVLINK_PARAM_GENERIC_ID_MAX - 1,
515 };
516 
517 #define DEVLINK_PARAM_GENERIC_INT_ERR_RESET_NAME "internal_error_reset"
518 #define DEVLINK_PARAM_GENERIC_INT_ERR_RESET_TYPE DEVLINK_PARAM_TYPE_BOOL
519 
520 #define DEVLINK_PARAM_GENERIC_MAX_MACS_NAME "max_macs"
521 #define DEVLINK_PARAM_GENERIC_MAX_MACS_TYPE DEVLINK_PARAM_TYPE_U32
522 
523 #define DEVLINK_PARAM_GENERIC_ENABLE_SRIOV_NAME "enable_sriov"
524 #define DEVLINK_PARAM_GENERIC_ENABLE_SRIOV_TYPE DEVLINK_PARAM_TYPE_BOOL
525 
526 #define DEVLINK_PARAM_GENERIC_REGION_SNAPSHOT_NAME "region_snapshot_enable"
527 #define DEVLINK_PARAM_GENERIC_REGION_SNAPSHOT_TYPE DEVLINK_PARAM_TYPE_BOOL
528 
529 #define DEVLINK_PARAM_GENERIC_IGNORE_ARI_NAME "ignore_ari"
530 #define DEVLINK_PARAM_GENERIC_IGNORE_ARI_TYPE DEVLINK_PARAM_TYPE_BOOL
531 
532 #define DEVLINK_PARAM_GENERIC_MSIX_VEC_PER_PF_MAX_NAME "msix_vec_per_pf_max"
533 #define DEVLINK_PARAM_GENERIC_MSIX_VEC_PER_PF_MAX_TYPE DEVLINK_PARAM_TYPE_U32
534 
535 #define DEVLINK_PARAM_GENERIC_MSIX_VEC_PER_PF_MIN_NAME "msix_vec_per_pf_min"
536 #define DEVLINK_PARAM_GENERIC_MSIX_VEC_PER_PF_MIN_TYPE DEVLINK_PARAM_TYPE_U32
537 
538 #define DEVLINK_PARAM_GENERIC_FW_LOAD_POLICY_NAME "fw_load_policy"
539 #define DEVLINK_PARAM_GENERIC_FW_LOAD_POLICY_TYPE DEVLINK_PARAM_TYPE_U8
540 
541 #define DEVLINK_PARAM_GENERIC_RESET_DEV_ON_DRV_PROBE_NAME \
542 	"reset_dev_on_drv_probe"
543 #define DEVLINK_PARAM_GENERIC_RESET_DEV_ON_DRV_PROBE_TYPE DEVLINK_PARAM_TYPE_U8
544 
545 #define DEVLINK_PARAM_GENERIC_ENABLE_ROCE_NAME "enable_roce"
546 #define DEVLINK_PARAM_GENERIC_ENABLE_ROCE_TYPE DEVLINK_PARAM_TYPE_BOOL
547 
548 #define DEVLINK_PARAM_GENERIC_ENABLE_REMOTE_DEV_RESET_NAME "enable_remote_dev_reset"
549 #define DEVLINK_PARAM_GENERIC_ENABLE_REMOTE_DEV_RESET_TYPE DEVLINK_PARAM_TYPE_BOOL
550 
551 #define DEVLINK_PARAM_GENERIC_ENABLE_ETH_NAME "enable_eth"
552 #define DEVLINK_PARAM_GENERIC_ENABLE_ETH_TYPE DEVLINK_PARAM_TYPE_BOOL
553 
554 #define DEVLINK_PARAM_GENERIC_ENABLE_RDMA_NAME "enable_rdma"
555 #define DEVLINK_PARAM_GENERIC_ENABLE_RDMA_TYPE DEVLINK_PARAM_TYPE_BOOL
556 
557 #define DEVLINK_PARAM_GENERIC_ENABLE_VNET_NAME "enable_vnet"
558 #define DEVLINK_PARAM_GENERIC_ENABLE_VNET_TYPE DEVLINK_PARAM_TYPE_BOOL
559 
560 #define DEVLINK_PARAM_GENERIC_ENABLE_IWARP_NAME "enable_iwarp"
561 #define DEVLINK_PARAM_GENERIC_ENABLE_IWARP_TYPE DEVLINK_PARAM_TYPE_BOOL
562 
563 #define DEVLINK_PARAM_GENERIC_IO_EQ_SIZE_NAME "io_eq_size"
564 #define DEVLINK_PARAM_GENERIC_IO_EQ_SIZE_TYPE DEVLINK_PARAM_TYPE_U32
565 
566 #define DEVLINK_PARAM_GENERIC_EVENT_EQ_SIZE_NAME "event_eq_size"
567 #define DEVLINK_PARAM_GENERIC_EVENT_EQ_SIZE_TYPE DEVLINK_PARAM_TYPE_U32
568 
569 #define DEVLINK_PARAM_GENERIC(_id, _cmodes, _get, _set, _validate)	\
570 {									\
571 	.id = DEVLINK_PARAM_GENERIC_ID_##_id,				\
572 	.name = DEVLINK_PARAM_GENERIC_##_id##_NAME,			\
573 	.type = DEVLINK_PARAM_GENERIC_##_id##_TYPE,			\
574 	.generic = true,						\
575 	.supported_cmodes = _cmodes,					\
576 	.get = _get,							\
577 	.set = _set,							\
578 	.validate = _validate,						\
579 }
580 
581 #define DEVLINK_PARAM_DRIVER(_id, _name, _type, _cmodes, _get, _set, _validate)	\
582 {									\
583 	.id = _id,							\
584 	.name = _name,							\
585 	.type = _type,							\
586 	.supported_cmodes = _cmodes,					\
587 	.get = _get,							\
588 	.set = _set,							\
589 	.validate = _validate,						\
590 }
591 
592 /* Part number, identifier of board design */
593 #define DEVLINK_INFO_VERSION_GENERIC_BOARD_ID	"board.id"
594 /* Revision of board design */
595 #define DEVLINK_INFO_VERSION_GENERIC_BOARD_REV	"board.rev"
596 /* Maker of the board */
597 #define DEVLINK_INFO_VERSION_GENERIC_BOARD_MANUFACTURE	"board.manufacture"
598 
599 /* Part number, identifier of asic design */
600 #define DEVLINK_INFO_VERSION_GENERIC_ASIC_ID	"asic.id"
601 /* Revision of asic design */
602 #define DEVLINK_INFO_VERSION_GENERIC_ASIC_REV	"asic.rev"
603 
604 /* Overall FW version */
605 #define DEVLINK_INFO_VERSION_GENERIC_FW		"fw"
606 /* Control processor FW version */
607 #define DEVLINK_INFO_VERSION_GENERIC_FW_MGMT	"fw.mgmt"
608 /* FW interface specification version */
609 #define DEVLINK_INFO_VERSION_GENERIC_FW_MGMT_API	"fw.mgmt.api"
610 /* Data path microcode controlling high-speed packet processing */
611 #define DEVLINK_INFO_VERSION_GENERIC_FW_APP	"fw.app"
612 /* UNDI software version */
613 #define DEVLINK_INFO_VERSION_GENERIC_FW_UNDI	"fw.undi"
614 /* NCSI support/handler version */
615 #define DEVLINK_INFO_VERSION_GENERIC_FW_NCSI	"fw.ncsi"
616 /* FW parameter set id */
617 #define DEVLINK_INFO_VERSION_GENERIC_FW_PSID	"fw.psid"
618 /* RoCE FW version */
619 #define DEVLINK_INFO_VERSION_GENERIC_FW_ROCE	"fw.roce"
620 /* Firmware bundle identifier */
621 #define DEVLINK_INFO_VERSION_GENERIC_FW_BUNDLE_ID	"fw.bundle_id"
622 
623 /**
624  * struct devlink_flash_update_params - Flash Update parameters
625  * @fw: pointer to the firmware data to update from
626  * @component: the flash component to update
627  *
628  * With the exception of fw, drivers must opt-in to parameters by
629  * setting the appropriate bit in the supported_flash_update_params field in
630  * their devlink_ops structure.
631  */
632 struct devlink_flash_update_params {
633 	const struct firmware *fw;
634 	const char *component;
635 	u32 overwrite_mask;
636 };
637 
638 #define DEVLINK_SUPPORT_FLASH_UPDATE_COMPONENT		BIT(0)
639 #define DEVLINK_SUPPORT_FLASH_UPDATE_OVERWRITE_MASK	BIT(1)
640 
641 struct devlink_region;
642 
643 /**
644  * struct devlink_region_ops - Region operations
645  * @name: region name
646  * @destructor: callback used to free snapshot memory when deleting
647  * @snapshot: callback to request an immediate snapshot. On success,
648  *            the data variable must be updated to point to the snapshot data.
649  *            The function will be called while the devlink instance lock is
650  *            held.
651  * @priv: Pointer to driver private data for the region operation
652  */
653 struct devlink_region_ops {
654 	const char *name;
655 	void (*destructor)(const void *data);
656 	int (*snapshot)(struct devlink *devlink,
657 			const struct devlink_region_ops *ops,
658 			struct netlink_ext_ack *extack,
659 			u8 **data);
660 	void *priv;
661 };
662 
663 /**
664  * struct devlink_port_region_ops - Region operations for a port
665  * @name: region name
666  * @destructor: callback used to free snapshot memory when deleting
667  * @snapshot: callback to request an immediate snapshot. On success,
668  *            the data variable must be updated to point to the snapshot data.
669  *            The function will be called while the devlink instance lock is
670  *            held.
671  * @priv: Pointer to driver private data for the region operation
672  */
673 struct devlink_port_region_ops {
674 	const char *name;
675 	void (*destructor)(const void *data);
676 	int (*snapshot)(struct devlink_port *port,
677 			const struct devlink_port_region_ops *ops,
678 			struct netlink_ext_ack *extack,
679 			u8 **data);
680 	void *priv;
681 };
682 
683 struct devlink_fmsg;
684 struct devlink_health_reporter;
685 
686 enum devlink_health_reporter_state {
687 	DEVLINK_HEALTH_REPORTER_STATE_HEALTHY,
688 	DEVLINK_HEALTH_REPORTER_STATE_ERROR,
689 };
690 
691 /**
692  * struct devlink_health_reporter_ops - Reporter operations
693  * @name: reporter name
694  * @recover: callback to recover from reported error
695  *           if priv_ctx is NULL, run a full recover
696  * @dump: callback to dump an object
697  *        if priv_ctx is NULL, run a full dump
698  * @diagnose: callback to diagnose the current status
699  * @test: callback to trigger a test event
700  */
701 
702 struct devlink_health_reporter_ops {
703 	char *name;
704 	int (*recover)(struct devlink_health_reporter *reporter,
705 		       void *priv_ctx, struct netlink_ext_ack *extack);
706 	int (*dump)(struct devlink_health_reporter *reporter,
707 		    struct devlink_fmsg *fmsg, void *priv_ctx,
708 		    struct netlink_ext_ack *extack);
709 	int (*diagnose)(struct devlink_health_reporter *reporter,
710 			struct devlink_fmsg *fmsg,
711 			struct netlink_ext_ack *extack);
712 	int (*test)(struct devlink_health_reporter *reporter,
713 		    struct netlink_ext_ack *extack);
714 };
715 
716 /**
717  * struct devlink_trap_metadata - Packet trap metadata.
718  * @trap_name: Trap name.
719  * @trap_group_name: Trap group name.
720  * @input_dev: Input netdevice.
721  * @dev_tracker: refcount tracker for @input_dev.
722  * @fa_cookie: Flow action user cookie.
723  * @trap_type: Trap type.
724  */
725 struct devlink_trap_metadata {
726 	const char *trap_name;
727 	const char *trap_group_name;
728 
729 	struct net_device *input_dev;
730 	netdevice_tracker dev_tracker;
731 
732 	const struct flow_action_cookie *fa_cookie;
733 	enum devlink_trap_type trap_type;
734 };
735 
736 /**
737  * struct devlink_trap_policer - Immutable packet trap policer attributes.
738  * @id: Policer identifier.
739  * @init_rate: Initial rate in packets / sec.
740  * @init_burst: Initial burst size in packets.
741  * @max_rate: Maximum rate.
742  * @min_rate: Minimum rate.
743  * @max_burst: Maximum burst size.
744  * @min_burst: Minimum burst size.
745  *
746  * Describes immutable attributes of packet trap policers that drivers register
747  * with devlink.
748  */
749 struct devlink_trap_policer {
750 	u32 id;
751 	u64 init_rate;
752 	u64 init_burst;
753 	u64 max_rate;
754 	u64 min_rate;
755 	u64 max_burst;
756 	u64 min_burst;
757 };
758 
759 /**
760  * struct devlink_trap_group - Immutable packet trap group attributes.
761  * @name: Trap group name.
762  * @id: Trap group identifier.
763  * @generic: Whether the trap group is generic or not.
764  * @init_policer_id: Initial policer identifier.
765  *
766  * Describes immutable attributes of packet trap groups that drivers register
767  * with devlink.
768  */
769 struct devlink_trap_group {
770 	const char *name;
771 	u16 id;
772 	bool generic;
773 	u32 init_policer_id;
774 };
775 
776 #define DEVLINK_TRAP_METADATA_TYPE_F_IN_PORT	BIT(0)
777 #define DEVLINK_TRAP_METADATA_TYPE_F_FA_COOKIE	BIT(1)
778 
779 /**
780  * struct devlink_trap - Immutable packet trap attributes.
781  * @type: Trap type.
782  * @init_action: Initial trap action.
783  * @generic: Whether the trap is generic or not.
784  * @id: Trap identifier.
785  * @name: Trap name.
786  * @init_group_id: Initial group identifier.
787  * @metadata_cap: Metadata types that can be provided by the trap.
788  *
789  * Describes immutable attributes of packet traps that drivers register with
790  * devlink.
791  */
792 struct devlink_trap {
793 	enum devlink_trap_type type;
794 	enum devlink_trap_action init_action;
795 	bool generic;
796 	u16 id;
797 	const char *name;
798 	u16 init_group_id;
799 	u32 metadata_cap;
800 };
801 
802 /* All traps must be documented in
803  * Documentation/networking/devlink/devlink-trap.rst
804  */
805 enum devlink_trap_generic_id {
806 	DEVLINK_TRAP_GENERIC_ID_SMAC_MC,
807 	DEVLINK_TRAP_GENERIC_ID_VLAN_TAG_MISMATCH,
808 	DEVLINK_TRAP_GENERIC_ID_INGRESS_VLAN_FILTER,
809 	DEVLINK_TRAP_GENERIC_ID_INGRESS_STP_FILTER,
810 	DEVLINK_TRAP_GENERIC_ID_EMPTY_TX_LIST,
811 	DEVLINK_TRAP_GENERIC_ID_PORT_LOOPBACK_FILTER,
812 	DEVLINK_TRAP_GENERIC_ID_BLACKHOLE_ROUTE,
813 	DEVLINK_TRAP_GENERIC_ID_TTL_ERROR,
814 	DEVLINK_TRAP_GENERIC_ID_TAIL_DROP,
815 	DEVLINK_TRAP_GENERIC_ID_NON_IP_PACKET,
816 	DEVLINK_TRAP_GENERIC_ID_UC_DIP_MC_DMAC,
817 	DEVLINK_TRAP_GENERIC_ID_DIP_LB,
818 	DEVLINK_TRAP_GENERIC_ID_SIP_MC,
819 	DEVLINK_TRAP_GENERIC_ID_SIP_LB,
820 	DEVLINK_TRAP_GENERIC_ID_CORRUPTED_IP_HDR,
821 	DEVLINK_TRAP_GENERIC_ID_IPV4_SIP_BC,
822 	DEVLINK_TRAP_GENERIC_ID_IPV6_MC_DIP_RESERVED_SCOPE,
823 	DEVLINK_TRAP_GENERIC_ID_IPV6_MC_DIP_INTERFACE_LOCAL_SCOPE,
824 	DEVLINK_TRAP_GENERIC_ID_MTU_ERROR,
825 	DEVLINK_TRAP_GENERIC_ID_UNRESOLVED_NEIGH,
826 	DEVLINK_TRAP_GENERIC_ID_RPF,
827 	DEVLINK_TRAP_GENERIC_ID_REJECT_ROUTE,
828 	DEVLINK_TRAP_GENERIC_ID_IPV4_LPM_UNICAST_MISS,
829 	DEVLINK_TRAP_GENERIC_ID_IPV6_LPM_UNICAST_MISS,
830 	DEVLINK_TRAP_GENERIC_ID_NON_ROUTABLE,
831 	DEVLINK_TRAP_GENERIC_ID_DECAP_ERROR,
832 	DEVLINK_TRAP_GENERIC_ID_OVERLAY_SMAC_MC,
833 	DEVLINK_TRAP_GENERIC_ID_INGRESS_FLOW_ACTION_DROP,
834 	DEVLINK_TRAP_GENERIC_ID_EGRESS_FLOW_ACTION_DROP,
835 	DEVLINK_TRAP_GENERIC_ID_STP,
836 	DEVLINK_TRAP_GENERIC_ID_LACP,
837 	DEVLINK_TRAP_GENERIC_ID_LLDP,
838 	DEVLINK_TRAP_GENERIC_ID_IGMP_QUERY,
839 	DEVLINK_TRAP_GENERIC_ID_IGMP_V1_REPORT,
840 	DEVLINK_TRAP_GENERIC_ID_IGMP_V2_REPORT,
841 	DEVLINK_TRAP_GENERIC_ID_IGMP_V3_REPORT,
842 	DEVLINK_TRAP_GENERIC_ID_IGMP_V2_LEAVE,
843 	DEVLINK_TRAP_GENERIC_ID_MLD_QUERY,
844 	DEVLINK_TRAP_GENERIC_ID_MLD_V1_REPORT,
845 	DEVLINK_TRAP_GENERIC_ID_MLD_V2_REPORT,
846 	DEVLINK_TRAP_GENERIC_ID_MLD_V1_DONE,
847 	DEVLINK_TRAP_GENERIC_ID_IPV4_DHCP,
848 	DEVLINK_TRAP_GENERIC_ID_IPV6_DHCP,
849 	DEVLINK_TRAP_GENERIC_ID_ARP_REQUEST,
850 	DEVLINK_TRAP_GENERIC_ID_ARP_RESPONSE,
851 	DEVLINK_TRAP_GENERIC_ID_ARP_OVERLAY,
852 	DEVLINK_TRAP_GENERIC_ID_IPV6_NEIGH_SOLICIT,
853 	DEVLINK_TRAP_GENERIC_ID_IPV6_NEIGH_ADVERT,
854 	DEVLINK_TRAP_GENERIC_ID_IPV4_BFD,
855 	DEVLINK_TRAP_GENERIC_ID_IPV6_BFD,
856 	DEVLINK_TRAP_GENERIC_ID_IPV4_OSPF,
857 	DEVLINK_TRAP_GENERIC_ID_IPV6_OSPF,
858 	DEVLINK_TRAP_GENERIC_ID_IPV4_BGP,
859 	DEVLINK_TRAP_GENERIC_ID_IPV6_BGP,
860 	DEVLINK_TRAP_GENERIC_ID_IPV4_VRRP,
861 	DEVLINK_TRAP_GENERIC_ID_IPV6_VRRP,
862 	DEVLINK_TRAP_GENERIC_ID_IPV4_PIM,
863 	DEVLINK_TRAP_GENERIC_ID_IPV6_PIM,
864 	DEVLINK_TRAP_GENERIC_ID_UC_LB,
865 	DEVLINK_TRAP_GENERIC_ID_LOCAL_ROUTE,
866 	DEVLINK_TRAP_GENERIC_ID_EXTERNAL_ROUTE,
867 	DEVLINK_TRAP_GENERIC_ID_IPV6_UC_DIP_LINK_LOCAL_SCOPE,
868 	DEVLINK_TRAP_GENERIC_ID_IPV6_DIP_ALL_NODES,
869 	DEVLINK_TRAP_GENERIC_ID_IPV6_DIP_ALL_ROUTERS,
870 	DEVLINK_TRAP_GENERIC_ID_IPV6_ROUTER_SOLICIT,
871 	DEVLINK_TRAP_GENERIC_ID_IPV6_ROUTER_ADVERT,
872 	DEVLINK_TRAP_GENERIC_ID_IPV6_REDIRECT,
873 	DEVLINK_TRAP_GENERIC_ID_IPV4_ROUTER_ALERT,
874 	DEVLINK_TRAP_GENERIC_ID_IPV6_ROUTER_ALERT,
875 	DEVLINK_TRAP_GENERIC_ID_PTP_EVENT,
876 	DEVLINK_TRAP_GENERIC_ID_PTP_GENERAL,
877 	DEVLINK_TRAP_GENERIC_ID_FLOW_ACTION_SAMPLE,
878 	DEVLINK_TRAP_GENERIC_ID_FLOW_ACTION_TRAP,
879 	DEVLINK_TRAP_GENERIC_ID_EARLY_DROP,
880 	DEVLINK_TRAP_GENERIC_ID_VXLAN_PARSING,
881 	DEVLINK_TRAP_GENERIC_ID_LLC_SNAP_PARSING,
882 	DEVLINK_TRAP_GENERIC_ID_VLAN_PARSING,
883 	DEVLINK_TRAP_GENERIC_ID_PPPOE_PPP_PARSING,
884 	DEVLINK_TRAP_GENERIC_ID_MPLS_PARSING,
885 	DEVLINK_TRAP_GENERIC_ID_ARP_PARSING,
886 	DEVLINK_TRAP_GENERIC_ID_IP_1_PARSING,
887 	DEVLINK_TRAP_GENERIC_ID_IP_N_PARSING,
888 	DEVLINK_TRAP_GENERIC_ID_GRE_PARSING,
889 	DEVLINK_TRAP_GENERIC_ID_UDP_PARSING,
890 	DEVLINK_TRAP_GENERIC_ID_TCP_PARSING,
891 	DEVLINK_TRAP_GENERIC_ID_IPSEC_PARSING,
892 	DEVLINK_TRAP_GENERIC_ID_SCTP_PARSING,
893 	DEVLINK_TRAP_GENERIC_ID_DCCP_PARSING,
894 	DEVLINK_TRAP_GENERIC_ID_GTP_PARSING,
895 	DEVLINK_TRAP_GENERIC_ID_ESP_PARSING,
896 	DEVLINK_TRAP_GENERIC_ID_BLACKHOLE_NEXTHOP,
897 	DEVLINK_TRAP_GENERIC_ID_DMAC_FILTER,
898 
899 	/* Add new generic trap IDs above */
900 	__DEVLINK_TRAP_GENERIC_ID_MAX,
901 	DEVLINK_TRAP_GENERIC_ID_MAX = __DEVLINK_TRAP_GENERIC_ID_MAX - 1,
902 };
903 
904 /* All trap groups must be documented in
905  * Documentation/networking/devlink/devlink-trap.rst
906  */
907 enum devlink_trap_group_generic_id {
908 	DEVLINK_TRAP_GROUP_GENERIC_ID_L2_DROPS,
909 	DEVLINK_TRAP_GROUP_GENERIC_ID_L3_DROPS,
910 	DEVLINK_TRAP_GROUP_GENERIC_ID_L3_EXCEPTIONS,
911 	DEVLINK_TRAP_GROUP_GENERIC_ID_BUFFER_DROPS,
912 	DEVLINK_TRAP_GROUP_GENERIC_ID_TUNNEL_DROPS,
913 	DEVLINK_TRAP_GROUP_GENERIC_ID_ACL_DROPS,
914 	DEVLINK_TRAP_GROUP_GENERIC_ID_STP,
915 	DEVLINK_TRAP_GROUP_GENERIC_ID_LACP,
916 	DEVLINK_TRAP_GROUP_GENERIC_ID_LLDP,
917 	DEVLINK_TRAP_GROUP_GENERIC_ID_MC_SNOOPING,
918 	DEVLINK_TRAP_GROUP_GENERIC_ID_DHCP,
919 	DEVLINK_TRAP_GROUP_GENERIC_ID_NEIGH_DISCOVERY,
920 	DEVLINK_TRAP_GROUP_GENERIC_ID_BFD,
921 	DEVLINK_TRAP_GROUP_GENERIC_ID_OSPF,
922 	DEVLINK_TRAP_GROUP_GENERIC_ID_BGP,
923 	DEVLINK_TRAP_GROUP_GENERIC_ID_VRRP,
924 	DEVLINK_TRAP_GROUP_GENERIC_ID_PIM,
925 	DEVLINK_TRAP_GROUP_GENERIC_ID_UC_LB,
926 	DEVLINK_TRAP_GROUP_GENERIC_ID_LOCAL_DELIVERY,
927 	DEVLINK_TRAP_GROUP_GENERIC_ID_EXTERNAL_DELIVERY,
928 	DEVLINK_TRAP_GROUP_GENERIC_ID_IPV6,
929 	DEVLINK_TRAP_GROUP_GENERIC_ID_PTP_EVENT,
930 	DEVLINK_TRAP_GROUP_GENERIC_ID_PTP_GENERAL,
931 	DEVLINK_TRAP_GROUP_GENERIC_ID_ACL_SAMPLE,
932 	DEVLINK_TRAP_GROUP_GENERIC_ID_ACL_TRAP,
933 	DEVLINK_TRAP_GROUP_GENERIC_ID_PARSER_ERROR_DROPS,
934 
935 	/* Add new generic trap group IDs above */
936 	__DEVLINK_TRAP_GROUP_GENERIC_ID_MAX,
937 	DEVLINK_TRAP_GROUP_GENERIC_ID_MAX =
938 		__DEVLINK_TRAP_GROUP_GENERIC_ID_MAX - 1,
939 };
940 
941 #define DEVLINK_TRAP_GENERIC_NAME_SMAC_MC \
942 	"source_mac_is_multicast"
943 #define DEVLINK_TRAP_GENERIC_NAME_VLAN_TAG_MISMATCH \
944 	"vlan_tag_mismatch"
945 #define DEVLINK_TRAP_GENERIC_NAME_INGRESS_VLAN_FILTER \
946 	"ingress_vlan_filter"
947 #define DEVLINK_TRAP_GENERIC_NAME_INGRESS_STP_FILTER \
948 	"ingress_spanning_tree_filter"
949 #define DEVLINK_TRAP_GENERIC_NAME_EMPTY_TX_LIST \
950 	"port_list_is_empty"
951 #define DEVLINK_TRAP_GENERIC_NAME_PORT_LOOPBACK_FILTER \
952 	"port_loopback_filter"
953 #define DEVLINK_TRAP_GENERIC_NAME_BLACKHOLE_ROUTE \
954 	"blackhole_route"
955 #define DEVLINK_TRAP_GENERIC_NAME_TTL_ERROR \
956 	"ttl_value_is_too_small"
957 #define DEVLINK_TRAP_GENERIC_NAME_TAIL_DROP \
958 	"tail_drop"
959 #define DEVLINK_TRAP_GENERIC_NAME_NON_IP_PACKET \
960 	"non_ip"
961 #define DEVLINK_TRAP_GENERIC_NAME_UC_DIP_MC_DMAC \
962 	"uc_dip_over_mc_dmac"
963 #define DEVLINK_TRAP_GENERIC_NAME_DIP_LB \
964 	"dip_is_loopback_address"
965 #define DEVLINK_TRAP_GENERIC_NAME_SIP_MC \
966 	"sip_is_mc"
967 #define DEVLINK_TRAP_GENERIC_NAME_SIP_LB \
968 	"sip_is_loopback_address"
969 #define DEVLINK_TRAP_GENERIC_NAME_CORRUPTED_IP_HDR \
970 	"ip_header_corrupted"
971 #define DEVLINK_TRAP_GENERIC_NAME_IPV4_SIP_BC \
972 	"ipv4_sip_is_limited_bc"
973 #define DEVLINK_TRAP_GENERIC_NAME_IPV6_MC_DIP_RESERVED_SCOPE \
974 	"ipv6_mc_dip_reserved_scope"
975 #define DEVLINK_TRAP_GENERIC_NAME_IPV6_MC_DIP_INTERFACE_LOCAL_SCOPE \
976 	"ipv6_mc_dip_interface_local_scope"
977 #define DEVLINK_TRAP_GENERIC_NAME_MTU_ERROR \
978 	"mtu_value_is_too_small"
979 #define DEVLINK_TRAP_GENERIC_NAME_UNRESOLVED_NEIGH \
980 	"unresolved_neigh"
981 #define DEVLINK_TRAP_GENERIC_NAME_RPF \
982 	"mc_reverse_path_forwarding"
983 #define DEVLINK_TRAP_GENERIC_NAME_REJECT_ROUTE \
984 	"reject_route"
985 #define DEVLINK_TRAP_GENERIC_NAME_IPV4_LPM_UNICAST_MISS \
986 	"ipv4_lpm_miss"
987 #define DEVLINK_TRAP_GENERIC_NAME_IPV6_LPM_UNICAST_MISS \
988 	"ipv6_lpm_miss"
989 #define DEVLINK_TRAP_GENERIC_NAME_NON_ROUTABLE \
990 	"non_routable_packet"
991 #define DEVLINK_TRAP_GENERIC_NAME_DECAP_ERROR \
992 	"decap_error"
993 #define DEVLINK_TRAP_GENERIC_NAME_OVERLAY_SMAC_MC \
994 	"overlay_smac_is_mc"
995 #define DEVLINK_TRAP_GENERIC_NAME_INGRESS_FLOW_ACTION_DROP \
996 	"ingress_flow_action_drop"
997 #define DEVLINK_TRAP_GENERIC_NAME_EGRESS_FLOW_ACTION_DROP \
998 	"egress_flow_action_drop"
999 #define DEVLINK_TRAP_GENERIC_NAME_STP \
1000 	"stp"
1001 #define DEVLINK_TRAP_GENERIC_NAME_LACP \
1002 	"lacp"
1003 #define DEVLINK_TRAP_GENERIC_NAME_LLDP \
1004 	"lldp"
1005 #define DEVLINK_TRAP_GENERIC_NAME_IGMP_QUERY \
1006 	"igmp_query"
1007 #define DEVLINK_TRAP_GENERIC_NAME_IGMP_V1_REPORT \
1008 	"igmp_v1_report"
1009 #define DEVLINK_TRAP_GENERIC_NAME_IGMP_V2_REPORT \
1010 	"igmp_v2_report"
1011 #define DEVLINK_TRAP_GENERIC_NAME_IGMP_V3_REPORT \
1012 	"igmp_v3_report"
1013 #define DEVLINK_TRAP_GENERIC_NAME_IGMP_V2_LEAVE \
1014 	"igmp_v2_leave"
1015 #define DEVLINK_TRAP_GENERIC_NAME_MLD_QUERY \
1016 	"mld_query"
1017 #define DEVLINK_TRAP_GENERIC_NAME_MLD_V1_REPORT \
1018 	"mld_v1_report"
1019 #define DEVLINK_TRAP_GENERIC_NAME_MLD_V2_REPORT \
1020 	"mld_v2_report"
1021 #define DEVLINK_TRAP_GENERIC_NAME_MLD_V1_DONE \
1022 	"mld_v1_done"
1023 #define DEVLINK_TRAP_GENERIC_NAME_IPV4_DHCP \
1024 	"ipv4_dhcp"
1025 #define DEVLINK_TRAP_GENERIC_NAME_IPV6_DHCP \
1026 	"ipv6_dhcp"
1027 #define DEVLINK_TRAP_GENERIC_NAME_ARP_REQUEST \
1028 	"arp_request"
1029 #define DEVLINK_TRAP_GENERIC_NAME_ARP_RESPONSE \
1030 	"arp_response"
1031 #define DEVLINK_TRAP_GENERIC_NAME_ARP_OVERLAY \
1032 	"arp_overlay"
1033 #define DEVLINK_TRAP_GENERIC_NAME_IPV6_NEIGH_SOLICIT \
1034 	"ipv6_neigh_solicit"
1035 #define DEVLINK_TRAP_GENERIC_NAME_IPV6_NEIGH_ADVERT \
1036 	"ipv6_neigh_advert"
1037 #define DEVLINK_TRAP_GENERIC_NAME_IPV4_BFD \
1038 	"ipv4_bfd"
1039 #define DEVLINK_TRAP_GENERIC_NAME_IPV6_BFD \
1040 	"ipv6_bfd"
1041 #define DEVLINK_TRAP_GENERIC_NAME_IPV4_OSPF \
1042 	"ipv4_ospf"
1043 #define DEVLINK_TRAP_GENERIC_NAME_IPV6_OSPF \
1044 	"ipv6_ospf"
1045 #define DEVLINK_TRAP_GENERIC_NAME_IPV4_BGP \
1046 	"ipv4_bgp"
1047 #define DEVLINK_TRAP_GENERIC_NAME_IPV6_BGP \
1048 	"ipv6_bgp"
1049 #define DEVLINK_TRAP_GENERIC_NAME_IPV4_VRRP \
1050 	"ipv4_vrrp"
1051 #define DEVLINK_TRAP_GENERIC_NAME_IPV6_VRRP \
1052 	"ipv6_vrrp"
1053 #define DEVLINK_TRAP_GENERIC_NAME_IPV4_PIM \
1054 	"ipv4_pim"
1055 #define DEVLINK_TRAP_GENERIC_NAME_IPV6_PIM \
1056 	"ipv6_pim"
1057 #define DEVLINK_TRAP_GENERIC_NAME_UC_LB \
1058 	"uc_loopback"
1059 #define DEVLINK_TRAP_GENERIC_NAME_LOCAL_ROUTE \
1060 	"local_route"
1061 #define DEVLINK_TRAP_GENERIC_NAME_EXTERNAL_ROUTE \
1062 	"external_route"
1063 #define DEVLINK_TRAP_GENERIC_NAME_IPV6_UC_DIP_LINK_LOCAL_SCOPE \
1064 	"ipv6_uc_dip_link_local_scope"
1065 #define DEVLINK_TRAP_GENERIC_NAME_IPV6_DIP_ALL_NODES \
1066 	"ipv6_dip_all_nodes"
1067 #define DEVLINK_TRAP_GENERIC_NAME_IPV6_DIP_ALL_ROUTERS \
1068 	"ipv6_dip_all_routers"
1069 #define DEVLINK_TRAP_GENERIC_NAME_IPV6_ROUTER_SOLICIT \
1070 	"ipv6_router_solicit"
1071 #define DEVLINK_TRAP_GENERIC_NAME_IPV6_ROUTER_ADVERT \
1072 	"ipv6_router_advert"
1073 #define DEVLINK_TRAP_GENERIC_NAME_IPV6_REDIRECT \
1074 	"ipv6_redirect"
1075 #define DEVLINK_TRAP_GENERIC_NAME_IPV4_ROUTER_ALERT \
1076 	"ipv4_router_alert"
1077 #define DEVLINK_TRAP_GENERIC_NAME_IPV6_ROUTER_ALERT \
1078 	"ipv6_router_alert"
1079 #define DEVLINK_TRAP_GENERIC_NAME_PTP_EVENT \
1080 	"ptp_event"
1081 #define DEVLINK_TRAP_GENERIC_NAME_PTP_GENERAL \
1082 	"ptp_general"
1083 #define DEVLINK_TRAP_GENERIC_NAME_FLOW_ACTION_SAMPLE \
1084 	"flow_action_sample"
1085 #define DEVLINK_TRAP_GENERIC_NAME_FLOW_ACTION_TRAP \
1086 	"flow_action_trap"
1087 #define DEVLINK_TRAP_GENERIC_NAME_EARLY_DROP \
1088 	"early_drop"
1089 #define DEVLINK_TRAP_GENERIC_NAME_VXLAN_PARSING \
1090 	"vxlan_parsing"
1091 #define DEVLINK_TRAP_GENERIC_NAME_LLC_SNAP_PARSING \
1092 	"llc_snap_parsing"
1093 #define DEVLINK_TRAP_GENERIC_NAME_VLAN_PARSING \
1094 	"vlan_parsing"
1095 #define DEVLINK_TRAP_GENERIC_NAME_PPPOE_PPP_PARSING \
1096 	"pppoe_ppp_parsing"
1097 #define DEVLINK_TRAP_GENERIC_NAME_MPLS_PARSING \
1098 	"mpls_parsing"
1099 #define DEVLINK_TRAP_GENERIC_NAME_ARP_PARSING \
1100 	"arp_parsing"
1101 #define DEVLINK_TRAP_GENERIC_NAME_IP_1_PARSING \
1102 	"ip_1_parsing"
1103 #define DEVLINK_TRAP_GENERIC_NAME_IP_N_PARSING \
1104 	"ip_n_parsing"
1105 #define DEVLINK_TRAP_GENERIC_NAME_GRE_PARSING \
1106 	"gre_parsing"
1107 #define DEVLINK_TRAP_GENERIC_NAME_UDP_PARSING \
1108 	"udp_parsing"
1109 #define DEVLINK_TRAP_GENERIC_NAME_TCP_PARSING \
1110 	"tcp_parsing"
1111 #define DEVLINK_TRAP_GENERIC_NAME_IPSEC_PARSING \
1112 	"ipsec_parsing"
1113 #define DEVLINK_TRAP_GENERIC_NAME_SCTP_PARSING \
1114 	"sctp_parsing"
1115 #define DEVLINK_TRAP_GENERIC_NAME_DCCP_PARSING \
1116 	"dccp_parsing"
1117 #define DEVLINK_TRAP_GENERIC_NAME_GTP_PARSING \
1118 	"gtp_parsing"
1119 #define DEVLINK_TRAP_GENERIC_NAME_ESP_PARSING \
1120 	"esp_parsing"
1121 #define DEVLINK_TRAP_GENERIC_NAME_BLACKHOLE_NEXTHOP \
1122 	"blackhole_nexthop"
1123 #define DEVLINK_TRAP_GENERIC_NAME_DMAC_FILTER \
1124 	"dmac_filter"
1125 
1126 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_L2_DROPS \
1127 	"l2_drops"
1128 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_L3_DROPS \
1129 	"l3_drops"
1130 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_L3_EXCEPTIONS \
1131 	"l3_exceptions"
1132 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_BUFFER_DROPS \
1133 	"buffer_drops"
1134 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_TUNNEL_DROPS \
1135 	"tunnel_drops"
1136 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_ACL_DROPS \
1137 	"acl_drops"
1138 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_STP \
1139 	"stp"
1140 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_LACP \
1141 	"lacp"
1142 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_LLDP \
1143 	"lldp"
1144 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_MC_SNOOPING  \
1145 	"mc_snooping"
1146 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_DHCP \
1147 	"dhcp"
1148 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_NEIGH_DISCOVERY \
1149 	"neigh_discovery"
1150 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_BFD \
1151 	"bfd"
1152 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_OSPF \
1153 	"ospf"
1154 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_BGP \
1155 	"bgp"
1156 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_VRRP \
1157 	"vrrp"
1158 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_PIM \
1159 	"pim"
1160 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_UC_LB \
1161 	"uc_loopback"
1162 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_LOCAL_DELIVERY \
1163 	"local_delivery"
1164 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_EXTERNAL_DELIVERY \
1165 	"external_delivery"
1166 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_IPV6 \
1167 	"ipv6"
1168 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_PTP_EVENT \
1169 	"ptp_event"
1170 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_PTP_GENERAL \
1171 	"ptp_general"
1172 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_ACL_SAMPLE \
1173 	"acl_sample"
1174 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_ACL_TRAP \
1175 	"acl_trap"
1176 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_PARSER_ERROR_DROPS \
1177 	"parser_error_drops"
1178 
1179 #define DEVLINK_TRAP_GENERIC(_type, _init_action, _id, _group_id,	      \
1180 			     _metadata_cap)				      \
1181 	{								      \
1182 		.type = DEVLINK_TRAP_TYPE_##_type,			      \
1183 		.init_action = DEVLINK_TRAP_ACTION_##_init_action,	      \
1184 		.generic = true,					      \
1185 		.id = DEVLINK_TRAP_GENERIC_ID_##_id,			      \
1186 		.name = DEVLINK_TRAP_GENERIC_NAME_##_id,		      \
1187 		.init_group_id = _group_id,				      \
1188 		.metadata_cap = _metadata_cap,				      \
1189 	}
1190 
1191 #define DEVLINK_TRAP_DRIVER(_type, _init_action, _id, _name, _group_id,	      \
1192 			    _metadata_cap)				      \
1193 	{								      \
1194 		.type = DEVLINK_TRAP_TYPE_##_type,			      \
1195 		.init_action = DEVLINK_TRAP_ACTION_##_init_action,	      \
1196 		.generic = false,					      \
1197 		.id = _id,						      \
1198 		.name = _name,						      \
1199 		.init_group_id = _group_id,				      \
1200 		.metadata_cap = _metadata_cap,				      \
1201 	}
1202 
1203 #define DEVLINK_TRAP_GROUP_GENERIC(_id, _policer_id)			      \
1204 	{								      \
1205 		.name = DEVLINK_TRAP_GROUP_GENERIC_NAME_##_id,		      \
1206 		.id = DEVLINK_TRAP_GROUP_GENERIC_ID_##_id,		      \
1207 		.generic = true,					      \
1208 		.init_policer_id = _policer_id,				      \
1209 	}
1210 
1211 #define DEVLINK_TRAP_POLICER(_id, _rate, _burst, _max_rate, _min_rate,	      \
1212 			     _max_burst, _min_burst)			      \
1213 	{								      \
1214 		.id = _id,						      \
1215 		.init_rate = _rate,					      \
1216 		.init_burst = _burst,					      \
1217 		.max_rate = _max_rate,					      \
1218 		.min_rate = _min_rate,					      \
1219 		.max_burst = _max_burst,				      \
1220 		.min_burst = _min_burst,				      \
1221 	}
1222 
1223 enum {
1224 	/* device supports reload operations */
1225 	DEVLINK_F_RELOAD = 1UL << 0,
1226 };
1227 
1228 struct devlink_ops {
1229 	/**
1230 	 * @supported_flash_update_params:
1231 	 * mask of parameters supported by the driver's .flash_update
1232 	 * implemementation.
1233 	 */
1234 	u32 supported_flash_update_params;
1235 	unsigned long reload_actions;
1236 	unsigned long reload_limits;
1237 	int (*reload_down)(struct devlink *devlink, bool netns_change,
1238 			   enum devlink_reload_action action,
1239 			   enum devlink_reload_limit limit,
1240 			   struct netlink_ext_ack *extack);
1241 	int (*reload_up)(struct devlink *devlink, enum devlink_reload_action action,
1242 			 enum devlink_reload_limit limit, u32 *actions_performed,
1243 			 struct netlink_ext_ack *extack);
1244 	int (*port_type_set)(struct devlink_port *devlink_port,
1245 			     enum devlink_port_type port_type);
1246 	int (*port_split)(struct devlink *devlink, struct devlink_port *port,
1247 			  unsigned int count, struct netlink_ext_ack *extack);
1248 	int (*port_unsplit)(struct devlink *devlink, struct devlink_port *port,
1249 			    struct netlink_ext_ack *extack);
1250 	int (*sb_pool_get)(struct devlink *devlink, unsigned int sb_index,
1251 			   u16 pool_index,
1252 			   struct devlink_sb_pool_info *pool_info);
1253 	int (*sb_pool_set)(struct devlink *devlink, unsigned int sb_index,
1254 			   u16 pool_index, u32 size,
1255 			   enum devlink_sb_threshold_type threshold_type,
1256 			   struct netlink_ext_ack *extack);
1257 	int (*sb_port_pool_get)(struct devlink_port *devlink_port,
1258 				unsigned int sb_index, u16 pool_index,
1259 				u32 *p_threshold);
1260 	int (*sb_port_pool_set)(struct devlink_port *devlink_port,
1261 				unsigned int sb_index, u16 pool_index,
1262 				u32 threshold, struct netlink_ext_ack *extack);
1263 	int (*sb_tc_pool_bind_get)(struct devlink_port *devlink_port,
1264 				   unsigned int sb_index,
1265 				   u16 tc_index,
1266 				   enum devlink_sb_pool_type pool_type,
1267 				   u16 *p_pool_index, u32 *p_threshold);
1268 	int (*sb_tc_pool_bind_set)(struct devlink_port *devlink_port,
1269 				   unsigned int sb_index,
1270 				   u16 tc_index,
1271 				   enum devlink_sb_pool_type pool_type,
1272 				   u16 pool_index, u32 threshold,
1273 				   struct netlink_ext_ack *extack);
1274 	int (*sb_occ_snapshot)(struct devlink *devlink,
1275 			       unsigned int sb_index);
1276 	int (*sb_occ_max_clear)(struct devlink *devlink,
1277 				unsigned int sb_index);
1278 	int (*sb_occ_port_pool_get)(struct devlink_port *devlink_port,
1279 				    unsigned int sb_index, u16 pool_index,
1280 				    u32 *p_cur, u32 *p_max);
1281 	int (*sb_occ_tc_port_bind_get)(struct devlink_port *devlink_port,
1282 				       unsigned int sb_index,
1283 				       u16 tc_index,
1284 				       enum devlink_sb_pool_type pool_type,
1285 				       u32 *p_cur, u32 *p_max);
1286 
1287 	int (*eswitch_mode_get)(struct devlink *devlink, u16 *p_mode);
1288 	int (*eswitch_mode_set)(struct devlink *devlink, u16 mode,
1289 				struct netlink_ext_ack *extack);
1290 	int (*eswitch_inline_mode_get)(struct devlink *devlink, u8 *p_inline_mode);
1291 	int (*eswitch_inline_mode_set)(struct devlink *devlink, u8 inline_mode,
1292 				       struct netlink_ext_ack *extack);
1293 	int (*eswitch_encap_mode_get)(struct devlink *devlink,
1294 				      enum devlink_eswitch_encap_mode *p_encap_mode);
1295 	int (*eswitch_encap_mode_set)(struct devlink *devlink,
1296 				      enum devlink_eswitch_encap_mode encap_mode,
1297 				      struct netlink_ext_ack *extack);
1298 	int (*info_get)(struct devlink *devlink, struct devlink_info_req *req,
1299 			struct netlink_ext_ack *extack);
1300 	/**
1301 	 * @flash_update: Device flash update function
1302 	 *
1303 	 * Used to perform a flash update for the device. The set of
1304 	 * parameters supported by the driver should be set in
1305 	 * supported_flash_update_params.
1306 	 */
1307 	int (*flash_update)(struct devlink *devlink,
1308 			    struct devlink_flash_update_params *params,
1309 			    struct netlink_ext_ack *extack);
1310 	/**
1311 	 * @trap_init: Trap initialization function.
1312 	 *
1313 	 * Should be used by device drivers to initialize the trap in the
1314 	 * underlying device. Drivers should also store the provided trap
1315 	 * context, so that they could efficiently pass it to
1316 	 * devlink_trap_report() when the trap is triggered.
1317 	 */
1318 	int (*trap_init)(struct devlink *devlink,
1319 			 const struct devlink_trap *trap, void *trap_ctx);
1320 	/**
1321 	 * @trap_fini: Trap de-initialization function.
1322 	 *
1323 	 * Should be used by device drivers to de-initialize the trap in the
1324 	 * underlying device.
1325 	 */
1326 	void (*trap_fini)(struct devlink *devlink,
1327 			  const struct devlink_trap *trap, void *trap_ctx);
1328 	/**
1329 	 * @trap_action_set: Trap action set function.
1330 	 */
1331 	int (*trap_action_set)(struct devlink *devlink,
1332 			       const struct devlink_trap *trap,
1333 			       enum devlink_trap_action action,
1334 			       struct netlink_ext_ack *extack);
1335 	/**
1336 	 * @trap_group_init: Trap group initialization function.
1337 	 *
1338 	 * Should be used by device drivers to initialize the trap group in the
1339 	 * underlying device.
1340 	 */
1341 	int (*trap_group_init)(struct devlink *devlink,
1342 			       const struct devlink_trap_group *group);
1343 	/**
1344 	 * @trap_group_set: Trap group parameters set function.
1345 	 *
1346 	 * Note: @policer can be NULL when a policer is being unbound from
1347 	 * @group.
1348 	 */
1349 	int (*trap_group_set)(struct devlink *devlink,
1350 			      const struct devlink_trap_group *group,
1351 			      const struct devlink_trap_policer *policer,
1352 			      struct netlink_ext_ack *extack);
1353 	/**
1354 	 * @trap_group_action_set: Trap group action set function.
1355 	 *
1356 	 * If this callback is populated, it will take precedence over looping
1357 	 * over all traps in a group and calling .trap_action_set().
1358 	 */
1359 	int (*trap_group_action_set)(struct devlink *devlink,
1360 				     const struct devlink_trap_group *group,
1361 				     enum devlink_trap_action action,
1362 				     struct netlink_ext_ack *extack);
1363 	/**
1364 	 * @trap_drop_counter_get: Trap drop counter get function.
1365 	 *
1366 	 * Should be used by device drivers to report number of packets
1367 	 * that have been dropped, and cannot be passed to the devlink
1368 	 * subsystem by the underlying device.
1369 	 */
1370 	int (*trap_drop_counter_get)(struct devlink *devlink,
1371 				     const struct devlink_trap *trap,
1372 				     u64 *p_drops);
1373 	/**
1374 	 * @trap_policer_init: Trap policer initialization function.
1375 	 *
1376 	 * Should be used by device drivers to initialize the trap policer in
1377 	 * the underlying device.
1378 	 */
1379 	int (*trap_policer_init)(struct devlink *devlink,
1380 				 const struct devlink_trap_policer *policer);
1381 	/**
1382 	 * @trap_policer_fini: Trap policer de-initialization function.
1383 	 *
1384 	 * Should be used by device drivers to de-initialize the trap policer
1385 	 * in the underlying device.
1386 	 */
1387 	void (*trap_policer_fini)(struct devlink *devlink,
1388 				  const struct devlink_trap_policer *policer);
1389 	/**
1390 	 * @trap_policer_set: Trap policer parameters set function.
1391 	 */
1392 	int (*trap_policer_set)(struct devlink *devlink,
1393 				const struct devlink_trap_policer *policer,
1394 				u64 rate, u64 burst,
1395 				struct netlink_ext_ack *extack);
1396 	/**
1397 	 * @trap_policer_counter_get: Trap policer counter get function.
1398 	 *
1399 	 * Should be used by device drivers to report number of packets dropped
1400 	 * by the policer.
1401 	 */
1402 	int (*trap_policer_counter_get)(struct devlink *devlink,
1403 					const struct devlink_trap_policer *policer,
1404 					u64 *p_drops);
1405 	/**
1406 	 * @port_function_hw_addr_get: Port function's hardware address get function.
1407 	 *
1408 	 * Should be used by device drivers to report the hardware address of a function managed
1409 	 * by the devlink port. Driver should return -EOPNOTSUPP if it doesn't support port
1410 	 * function handling for a particular port.
1411 	 *
1412 	 * Note: @extack can be NULL when port notifier queries the port function.
1413 	 */
1414 	int (*port_function_hw_addr_get)(struct devlink_port *port, u8 *hw_addr,
1415 					 int *hw_addr_len,
1416 					 struct netlink_ext_ack *extack);
1417 	/**
1418 	 * @port_function_hw_addr_set: Port function's hardware address set function.
1419 	 *
1420 	 * Should be used by device drivers to set the hardware address of a function managed
1421 	 * by the devlink port. Driver should return -EOPNOTSUPP if it doesn't support port
1422 	 * function handling for a particular port.
1423 	 */
1424 	int (*port_function_hw_addr_set)(struct devlink_port *port,
1425 					 const u8 *hw_addr, int hw_addr_len,
1426 					 struct netlink_ext_ack *extack);
1427 	/**
1428 	 * port_new() - Add a new port function of a specified flavor
1429 	 * @devlink: Devlink instance
1430 	 * @attrs: attributes of the new port
1431 	 * @extack: extack for reporting error messages
1432 	 * @new_port_index: index of the new port
1433 	 *
1434 	 * Devlink core will call this device driver function upon user request
1435 	 * to create a new port function of a specified flavor and optional
1436 	 * attributes
1437 	 *
1438 	 * Notes:
1439 	 *	- Called without devlink instance lock being held. Drivers must
1440 	 *	  implement own means of synchronization
1441 	 *	- On success, drivers must register a port with devlink core
1442 	 *
1443 	 * Return: 0 on success, negative value otherwise.
1444 	 */
1445 	int (*port_new)(struct devlink *devlink,
1446 			const struct devlink_port_new_attrs *attrs,
1447 			struct netlink_ext_ack *extack,
1448 			unsigned int *new_port_index);
1449 	/**
1450 	 * port_del() - Delete a port function
1451 	 * @devlink: Devlink instance
1452 	 * @port_index: port function index to delete
1453 	 * @extack: extack for reporting error messages
1454 	 *
1455 	 * Devlink core will call this device driver function upon user request
1456 	 * to delete a previously created port function
1457 	 *
1458 	 * Notes:
1459 	 *	- Called without devlink instance lock being held. Drivers must
1460 	 *	  implement own means of synchronization
1461 	 *	- On success, drivers must unregister the corresponding devlink
1462 	 *	  port
1463 	 *
1464 	 * Return: 0 on success, negative value otherwise.
1465 	 */
1466 	int (*port_del)(struct devlink *devlink, unsigned int port_index,
1467 			struct netlink_ext_ack *extack);
1468 	/**
1469 	 * port_fn_state_get() - Get the state of a port function
1470 	 * @devlink: Devlink instance
1471 	 * @port: The devlink port
1472 	 * @state: Admin configured state
1473 	 * @opstate: Current operational state
1474 	 * @extack: extack for reporting error messages
1475 	 *
1476 	 * Reports the admin and operational state of a devlink port function
1477 	 *
1478 	 * Return: 0 on success, negative value otherwise.
1479 	 */
1480 	int (*port_fn_state_get)(struct devlink_port *port,
1481 				 enum devlink_port_fn_state *state,
1482 				 enum devlink_port_fn_opstate *opstate,
1483 				 struct netlink_ext_ack *extack);
1484 	/**
1485 	 * port_fn_state_set() - Set the admin state of a port function
1486 	 * @devlink: Devlink instance
1487 	 * @port: The devlink port
1488 	 * @state: Admin state
1489 	 * @extack: extack for reporting error messages
1490 	 *
1491 	 * Set the admin state of a devlink port function
1492 	 *
1493 	 * Return: 0 on success, negative value otherwise.
1494 	 */
1495 	int (*port_fn_state_set)(struct devlink_port *port,
1496 				 enum devlink_port_fn_state state,
1497 				 struct netlink_ext_ack *extack);
1498 
1499 	/**
1500 	 * Rate control callbacks.
1501 	 */
1502 	int (*rate_leaf_tx_share_set)(struct devlink_rate *devlink_rate, void *priv,
1503 				      u64 tx_share, struct netlink_ext_ack *extack);
1504 	int (*rate_leaf_tx_max_set)(struct devlink_rate *devlink_rate, void *priv,
1505 				    u64 tx_max, struct netlink_ext_ack *extack);
1506 	int (*rate_node_tx_share_set)(struct devlink_rate *devlink_rate, void *priv,
1507 				      u64 tx_share, struct netlink_ext_ack *extack);
1508 	int (*rate_node_tx_max_set)(struct devlink_rate *devlink_rate, void *priv,
1509 				    u64 tx_max, struct netlink_ext_ack *extack);
1510 	int (*rate_node_new)(struct devlink_rate *rate_node, void **priv,
1511 			     struct netlink_ext_ack *extack);
1512 	int (*rate_node_del)(struct devlink_rate *rate_node, void *priv,
1513 			     struct netlink_ext_ack *extack);
1514 	int (*rate_leaf_parent_set)(struct devlink_rate *child,
1515 				    struct devlink_rate *parent,
1516 				    void *priv_child, void *priv_parent,
1517 				    struct netlink_ext_ack *extack);
1518 	int (*rate_node_parent_set)(struct devlink_rate *child,
1519 				    struct devlink_rate *parent,
1520 				    void *priv_child, void *priv_parent,
1521 				    struct netlink_ext_ack *extack);
1522 };
1523 
1524 void *devlink_priv(struct devlink *devlink);
1525 struct devlink *priv_to_devlink(void *priv);
1526 struct device *devlink_to_dev(const struct devlink *devlink);
1527 
1528 /* Devlink instance explicit locking */
1529 void devl_lock(struct devlink *devlink);
1530 void devl_unlock(struct devlink *devlink);
1531 void devl_assert_locked(struct devlink *devlink);
1532 bool devl_lock_is_held(struct devlink *devlink);
1533 
1534 int devl_port_register(struct devlink *devlink,
1535 		       struct devlink_port *devlink_port,
1536 		       unsigned int port_index);
1537 void devl_port_unregister(struct devlink_port *devlink_port);
1538 
1539 int devl_rate_leaf_create(struct devlink_port *port, void *priv);
1540 void devl_rate_leaf_destroy(struct devlink_port *devlink_port);
1541 void devl_rate_nodes_destroy(struct devlink *devlink);
1542 
1543 struct ib_device;
1544 
1545 struct net *devlink_net(const struct devlink *devlink);
1546 /* This call is intended for software devices that can create
1547  * devlink instances in other namespaces than init_net.
1548  *
1549  * Drivers that operate on real HW must use devlink_alloc() instead.
1550  */
1551 struct devlink *devlink_alloc_ns(const struct devlink_ops *ops,
1552 				 size_t priv_size, struct net *net,
1553 				 struct device *dev);
1554 static inline struct devlink *devlink_alloc(const struct devlink_ops *ops,
1555 					    size_t priv_size,
1556 					    struct device *dev)
1557 {
1558 	return devlink_alloc_ns(ops, priv_size, &init_net, dev);
1559 }
1560 void devlink_set_features(struct devlink *devlink, u64 features);
1561 void devlink_register(struct devlink *devlink);
1562 void devlink_unregister(struct devlink *devlink);
1563 void devlink_free(struct devlink *devlink);
1564 int devlink_port_register(struct devlink *devlink,
1565 			  struct devlink_port *devlink_port,
1566 			  unsigned int port_index);
1567 void devlink_port_unregister(struct devlink_port *devlink_port);
1568 void devlink_port_type_eth_set(struct devlink_port *devlink_port,
1569 			       struct net_device *netdev);
1570 void devlink_port_type_ib_set(struct devlink_port *devlink_port,
1571 			      struct ib_device *ibdev);
1572 void devlink_port_type_clear(struct devlink_port *devlink_port);
1573 void devlink_port_attrs_set(struct devlink_port *devlink_port,
1574 			    struct devlink_port_attrs *devlink_port_attrs);
1575 void devlink_port_attrs_pci_pf_set(struct devlink_port *devlink_port, u32 controller,
1576 				   u16 pf, bool external);
1577 void devlink_port_attrs_pci_vf_set(struct devlink_port *devlink_port, u32 controller,
1578 				   u16 pf, u16 vf, bool external);
1579 void devlink_port_attrs_pci_sf_set(struct devlink_port *devlink_port,
1580 				   u32 controller, u16 pf, u32 sf,
1581 				   bool external);
1582 int devlink_rate_leaf_create(struct devlink_port *port, void *priv);
1583 void devlink_rate_leaf_destroy(struct devlink_port *devlink_port);
1584 void devlink_rate_nodes_destroy(struct devlink *devlink);
1585 void devlink_port_linecard_set(struct devlink_port *devlink_port,
1586 			       struct devlink_linecard *linecard);
1587 struct devlink_linecard *
1588 devlink_linecard_create(struct devlink *devlink, unsigned int linecard_index,
1589 			const struct devlink_linecard_ops *ops, void *priv);
1590 void devlink_linecard_destroy(struct devlink_linecard *linecard);
1591 struct devlink_linecard_device *
1592 devlink_linecard_device_create(struct devlink_linecard *linecard,
1593 			       unsigned int device_index, void *priv);
1594 void
1595 devlink_linecard_device_destroy(struct devlink_linecard *linecard,
1596 				struct devlink_linecard_device *linecard_device);
1597 void devlink_linecard_provision_set(struct devlink_linecard *linecard,
1598 				    const char *type);
1599 void devlink_linecard_provision_clear(struct devlink_linecard *linecard);
1600 void devlink_linecard_provision_fail(struct devlink_linecard *linecard);
1601 void devlink_linecard_activate(struct devlink_linecard *linecard);
1602 void devlink_linecard_deactivate(struct devlink_linecard *linecard);
1603 int devlink_sb_register(struct devlink *devlink, unsigned int sb_index,
1604 			u32 size, u16 ingress_pools_count,
1605 			u16 egress_pools_count, u16 ingress_tc_count,
1606 			u16 egress_tc_count);
1607 void devlink_sb_unregister(struct devlink *devlink, unsigned int sb_index);
1608 int devlink_dpipe_table_register(struct devlink *devlink,
1609 				 const char *table_name,
1610 				 struct devlink_dpipe_table_ops *table_ops,
1611 				 void *priv, bool counter_control_extern);
1612 void devlink_dpipe_table_unregister(struct devlink *devlink,
1613 				    const char *table_name);
1614 int devlink_dpipe_headers_register(struct devlink *devlink,
1615 				   struct devlink_dpipe_headers *dpipe_headers);
1616 void devlink_dpipe_headers_unregister(struct devlink *devlink);
1617 bool devlink_dpipe_table_counter_enabled(struct devlink *devlink,
1618 					 const char *table_name);
1619 int devlink_dpipe_entry_ctx_prepare(struct devlink_dpipe_dump_ctx *dump_ctx);
1620 int devlink_dpipe_entry_ctx_append(struct devlink_dpipe_dump_ctx *dump_ctx,
1621 				   struct devlink_dpipe_entry *entry);
1622 int devlink_dpipe_entry_ctx_close(struct devlink_dpipe_dump_ctx *dump_ctx);
1623 void devlink_dpipe_entry_clear(struct devlink_dpipe_entry *entry);
1624 int devlink_dpipe_action_put(struct sk_buff *skb,
1625 			     struct devlink_dpipe_action *action);
1626 int devlink_dpipe_match_put(struct sk_buff *skb,
1627 			    struct devlink_dpipe_match *match);
1628 extern struct devlink_dpipe_header devlink_dpipe_header_ethernet;
1629 extern struct devlink_dpipe_header devlink_dpipe_header_ipv4;
1630 extern struct devlink_dpipe_header devlink_dpipe_header_ipv6;
1631 
1632 int devlink_resource_register(struct devlink *devlink,
1633 			      const char *resource_name,
1634 			      u64 resource_size,
1635 			      u64 resource_id,
1636 			      u64 parent_resource_id,
1637 			      const struct devlink_resource_size_params *size_params);
1638 void devlink_resources_unregister(struct devlink *devlink);
1639 int devlink_resource_size_get(struct devlink *devlink,
1640 			      u64 resource_id,
1641 			      u64 *p_resource_size);
1642 int devlink_dpipe_table_resource_set(struct devlink *devlink,
1643 				     const char *table_name, u64 resource_id,
1644 				     u64 resource_units);
1645 void devlink_resource_occ_get_register(struct devlink *devlink,
1646 				       u64 resource_id,
1647 				       devlink_resource_occ_get_t *occ_get,
1648 				       void *occ_get_priv);
1649 void devlink_resource_occ_get_unregister(struct devlink *devlink,
1650 					 u64 resource_id);
1651 int devlink_params_register(struct devlink *devlink,
1652 			    const struct devlink_param *params,
1653 			    size_t params_count);
1654 void devlink_params_unregister(struct devlink *devlink,
1655 			       const struct devlink_param *params,
1656 			       size_t params_count);
1657 int devlink_param_register(struct devlink *devlink,
1658 			   const struct devlink_param *param);
1659 void devlink_param_unregister(struct devlink *devlink,
1660 			      const struct devlink_param *param);
1661 int devlink_param_driverinit_value_get(struct devlink *devlink, u32 param_id,
1662 				       union devlink_param_value *init_val);
1663 int devlink_param_driverinit_value_set(struct devlink *devlink, u32 param_id,
1664 				       union devlink_param_value init_val);
1665 void devlink_param_value_changed(struct devlink *devlink, u32 param_id);
1666 struct devlink_region *
1667 devlink_region_create(struct devlink *devlink,
1668 		      const struct devlink_region_ops *ops,
1669 		      u32 region_max_snapshots, u64 region_size);
1670 struct devlink_region *
1671 devlink_port_region_create(struct devlink_port *port,
1672 			   const struct devlink_port_region_ops *ops,
1673 			   u32 region_max_snapshots, u64 region_size);
1674 void devlink_region_destroy(struct devlink_region *region);
1675 void devlink_port_region_destroy(struct devlink_region *region);
1676 
1677 int devlink_region_snapshot_id_get(struct devlink *devlink, u32 *id);
1678 void devlink_region_snapshot_id_put(struct devlink *devlink, u32 id);
1679 int devlink_region_snapshot_create(struct devlink_region *region,
1680 				   u8 *data, u32 snapshot_id);
1681 int devlink_info_serial_number_put(struct devlink_info_req *req,
1682 				   const char *sn);
1683 int devlink_info_driver_name_put(struct devlink_info_req *req,
1684 				 const char *name);
1685 int devlink_info_board_serial_number_put(struct devlink_info_req *req,
1686 					 const char *bsn);
1687 int devlink_info_version_fixed_put(struct devlink_info_req *req,
1688 				   const char *version_name,
1689 				   const char *version_value);
1690 int devlink_info_version_stored_put(struct devlink_info_req *req,
1691 				    const char *version_name,
1692 				    const char *version_value);
1693 int devlink_info_version_running_put(struct devlink_info_req *req,
1694 				     const char *version_name,
1695 				     const char *version_value);
1696 
1697 int devlink_fmsg_obj_nest_start(struct devlink_fmsg *fmsg);
1698 int devlink_fmsg_obj_nest_end(struct devlink_fmsg *fmsg);
1699 
1700 int devlink_fmsg_pair_nest_start(struct devlink_fmsg *fmsg, const char *name);
1701 int devlink_fmsg_pair_nest_end(struct devlink_fmsg *fmsg);
1702 
1703 int devlink_fmsg_arr_pair_nest_start(struct devlink_fmsg *fmsg,
1704 				     const char *name);
1705 int devlink_fmsg_arr_pair_nest_end(struct devlink_fmsg *fmsg);
1706 int devlink_fmsg_binary_pair_nest_start(struct devlink_fmsg *fmsg,
1707 					const char *name);
1708 int devlink_fmsg_binary_pair_nest_end(struct devlink_fmsg *fmsg);
1709 
1710 int devlink_fmsg_u32_put(struct devlink_fmsg *fmsg, u32 value);
1711 int devlink_fmsg_string_put(struct devlink_fmsg *fmsg, const char *value);
1712 int devlink_fmsg_binary_put(struct devlink_fmsg *fmsg, const void *value,
1713 			    u16 value_len);
1714 
1715 int devlink_fmsg_bool_pair_put(struct devlink_fmsg *fmsg, const char *name,
1716 			       bool value);
1717 int devlink_fmsg_u8_pair_put(struct devlink_fmsg *fmsg, const char *name,
1718 			     u8 value);
1719 int devlink_fmsg_u32_pair_put(struct devlink_fmsg *fmsg, const char *name,
1720 			      u32 value);
1721 int devlink_fmsg_u64_pair_put(struct devlink_fmsg *fmsg, const char *name,
1722 			      u64 value);
1723 int devlink_fmsg_string_pair_put(struct devlink_fmsg *fmsg, const char *name,
1724 				 const char *value);
1725 int devlink_fmsg_binary_pair_put(struct devlink_fmsg *fmsg, const char *name,
1726 				 const void *value, u32 value_len);
1727 
1728 struct devlink_health_reporter *
1729 devlink_health_reporter_create(struct devlink *devlink,
1730 			       const struct devlink_health_reporter_ops *ops,
1731 			       u64 graceful_period, void *priv);
1732 
1733 struct devlink_health_reporter *
1734 devlink_port_health_reporter_create(struct devlink_port *port,
1735 				    const struct devlink_health_reporter_ops *ops,
1736 				    u64 graceful_period, void *priv);
1737 
1738 void
1739 devlink_health_reporter_destroy(struct devlink_health_reporter *reporter);
1740 
1741 void
1742 devlink_port_health_reporter_destroy(struct devlink_health_reporter *reporter);
1743 
1744 void *
1745 devlink_health_reporter_priv(struct devlink_health_reporter *reporter);
1746 int devlink_health_report(struct devlink_health_reporter *reporter,
1747 			  const char *msg, void *priv_ctx);
1748 void
1749 devlink_health_reporter_state_update(struct devlink_health_reporter *reporter,
1750 				     enum devlink_health_reporter_state state);
1751 void
1752 devlink_health_reporter_recovery_done(struct devlink_health_reporter *reporter);
1753 
1754 bool devlink_is_reload_failed(const struct devlink *devlink);
1755 void devlink_remote_reload_actions_performed(struct devlink *devlink,
1756 					     enum devlink_reload_limit limit,
1757 					     u32 actions_performed);
1758 
1759 void devlink_flash_update_status_notify(struct devlink *devlink,
1760 					const char *status_msg,
1761 					const char *component,
1762 					unsigned long done,
1763 					unsigned long total);
1764 void devlink_flash_update_timeout_notify(struct devlink *devlink,
1765 					 const char *status_msg,
1766 					 const char *component,
1767 					 unsigned long timeout);
1768 
1769 int devlink_traps_register(struct devlink *devlink,
1770 			   const struct devlink_trap *traps,
1771 			   size_t traps_count, void *priv);
1772 void devlink_traps_unregister(struct devlink *devlink,
1773 			      const struct devlink_trap *traps,
1774 			      size_t traps_count);
1775 void devlink_trap_report(struct devlink *devlink, struct sk_buff *skb,
1776 			 void *trap_ctx, struct devlink_port *in_devlink_port,
1777 			 const struct flow_action_cookie *fa_cookie);
1778 void *devlink_trap_ctx_priv(void *trap_ctx);
1779 int devlink_trap_groups_register(struct devlink *devlink,
1780 				 const struct devlink_trap_group *groups,
1781 				 size_t groups_count);
1782 void devlink_trap_groups_unregister(struct devlink *devlink,
1783 				    const struct devlink_trap_group *groups,
1784 				    size_t groups_count);
1785 int
1786 devlink_trap_policers_register(struct devlink *devlink,
1787 			       const struct devlink_trap_policer *policers,
1788 			       size_t policers_count);
1789 void
1790 devlink_trap_policers_unregister(struct devlink *devlink,
1791 				 const struct devlink_trap_policer *policers,
1792 				 size_t policers_count);
1793 
1794 #if IS_ENABLED(CONFIG_NET_DEVLINK)
1795 
1796 struct devlink *__must_check devlink_try_get(struct devlink *devlink);
1797 void devlink_put(struct devlink *devlink);
1798 
1799 void devlink_compat_running_version(struct devlink *devlink,
1800 				    char *buf, size_t len);
1801 int devlink_compat_flash_update(struct devlink *devlink, const char *file_name);
1802 int devlink_compat_phys_port_name_get(struct net_device *dev,
1803 				      char *name, size_t len);
1804 int devlink_compat_switch_id_get(struct net_device *dev,
1805 				 struct netdev_phys_item_id *ppid);
1806 
1807 #else
1808 
1809 static inline struct devlink *devlink_try_get(struct devlink *devlink)
1810 {
1811 	return NULL;
1812 }
1813 
1814 static inline void devlink_put(struct devlink *devlink)
1815 {
1816 }
1817 
1818 static inline void
1819 devlink_compat_running_version(struct devlink *devlink, char *buf, size_t len)
1820 {
1821 }
1822 
1823 static inline int
1824 devlink_compat_flash_update(struct devlink *devlink, const char *file_name)
1825 {
1826 	return -EOPNOTSUPP;
1827 }
1828 
1829 static inline int
1830 devlink_compat_phys_port_name_get(struct net_device *dev,
1831 				  char *name, size_t len)
1832 {
1833 	return -EOPNOTSUPP;
1834 }
1835 
1836 static inline int
1837 devlink_compat_switch_id_get(struct net_device *dev,
1838 			     struct netdev_phys_item_id *ppid)
1839 {
1840 	return -EOPNOTSUPP;
1841 }
1842 
1843 #endif
1844 
1845 #endif /* _NET_DEVLINK_H_ */
1846