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