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