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