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