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