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

source code of linux/include/net/devlink.h