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