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