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