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