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