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