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