1 /* SPDX-License-Identifier: GPL-2.0-or-later */
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>
7 #ifndef _NET_DEVLINK_H_
8 #define _NET_DEVLINK_H_
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>
26 struct list_head list
;
27 struct list_head port_list
;
28 struct list_head sb_list
;
29 struct list_head dpipe_table_list
;
30 struct list_head resource_list
;
31 struct list_head param_list
;
32 struct list_head region_list
;
33 struct list_head reporter_list
;
34 struct mutex reporters_lock
; /* protects reporter_list */
35 struct devlink_dpipe_headers
*dpipe_headers
;
36 struct list_head trap_list
;
37 struct list_head trap_group_list
;
38 struct list_head trap_policer_list
;
39 const struct devlink_ops
*ops
;
40 struct xarray snapshot_ids
;
47 char priv
[0] __aligned(NETDEV_ALIGN
);
50 struct devlink_port_phys_attrs
{
51 u32 port_number
; /* Same value as "split group".
52 * A physical port which is visible to the user
53 * for a given port flavour.
55 u32 split_subport_number
;
58 struct devlink_port_pci_pf_attrs
{
59 u16 pf
; /* Associated PCI PF for this port. */
62 struct devlink_port_pci_vf_attrs
{
63 u16 pf
; /* Associated PCI PF for this port. */
64 u16 vf
; /* Associated PCI VF for of the PCI PF for this port. */
67 struct devlink_port_attrs
{
71 enum devlink_port_flavour flavour
;
72 struct netdev_phys_item_id switch_id
;
74 struct devlink_port_phys_attrs phys
;
75 struct devlink_port_pci_pf_attrs pci_pf
;
76 struct devlink_port_pci_vf_attrs pci_vf
;
81 struct list_head list
;
82 struct list_head param_list
;
83 struct devlink
*devlink
;
86 spinlock_t type_lock
; /* Protects type and type_dev
87 * pointer consistency.
89 enum devlink_port_type type
;
90 enum devlink_port_type desired_type
;
92 struct devlink_port_attrs attrs
;
93 struct delayed_work type_warn_dw
;
96 struct devlink_sb_pool_info
{
97 enum devlink_sb_pool_type pool_type
;
99 enum devlink_sb_threshold_type threshold_type
;
104 * struct devlink_dpipe_field - dpipe field object
106 * @id: index inside the headers field array
107 * @bitwidth: bitwidth
108 * @mapping_type: mapping type
110 struct devlink_dpipe_field
{
113 unsigned int bitwidth
;
114 enum devlink_dpipe_field_mapping_type mapping_type
;
118 * struct devlink_dpipe_header - dpipe header object
120 * @id: index, global/local detrmined by global bit
122 * @fields_count: number of fields
123 * @global: indicates if header is shared like most protocol header
126 struct devlink_dpipe_header
{
129 struct devlink_dpipe_field
*fields
;
130 unsigned int fields_count
;
135 * struct devlink_dpipe_match - represents match operation
136 * @type: type of match
137 * @header_index: header index (packets can have several headers of same
138 * type like in case of tunnels)
140 * @fieled_id: field index
142 struct devlink_dpipe_match
{
143 enum devlink_dpipe_match_type type
;
144 unsigned int header_index
;
145 struct devlink_dpipe_header
*header
;
146 unsigned int field_id
;
150 * struct devlink_dpipe_action - represents action operation
151 * @type: type of action
152 * @header_index: header index (packets can have several headers of same
153 * type like in case of tunnels)
155 * @fieled_id: field index
157 struct devlink_dpipe_action
{
158 enum devlink_dpipe_action_type type
;
159 unsigned int header_index
;
160 struct devlink_dpipe_header
*header
;
161 unsigned int field_id
;
165 * struct devlink_dpipe_value - represents value of match/action
168 * @mapping_value: in case the field has some mapping this value
169 * specified the mapping value
170 * @mapping_valid: specify if mapping value is valid
171 * @value_size: value size
175 struct devlink_dpipe_value
{
177 struct devlink_dpipe_action
*action
;
178 struct devlink_dpipe_match
*match
;
180 unsigned int mapping_value
;
182 unsigned int value_size
;
188 * struct devlink_dpipe_entry - table entry object
189 * @index: index of the entry in the table
190 * @match_values: match values
191 * @matche_values_count: count of matches tuples
192 * @action_values: actions values
193 * @action_values_count: count of actions values
194 * @counter: value of counter
195 * @counter_valid: Specify if value is valid from hardware
197 struct devlink_dpipe_entry
{
199 struct devlink_dpipe_value
*match_values
;
200 unsigned int match_values_count
;
201 struct devlink_dpipe_value
*action_values
;
202 unsigned int action_values_count
;
208 * struct devlink_dpipe_dump_ctx - context provided to driver in order
211 * @cmd: devlink command
213 * @nest: top attribute
216 struct devlink_dpipe_dump_ctx
{
217 struct genl_info
*info
;
218 enum devlink_command cmd
;
224 struct devlink_dpipe_table_ops
;
227 * struct devlink_dpipe_table - table object
230 * @counters_enabled: indicates if counters are active
231 * @counter_control_extern: indicates if counter control is in dpipe or
233 * @resource_valid: Indicate that the resource id is valid
234 * @resource_id: relative resource this table is related to
235 * @resource_units: number of resource's unit consumed per table's entry
236 * @table_ops: table operations
239 struct devlink_dpipe_table
{
241 struct list_head list
;
243 bool counters_enabled
;
244 bool counter_control_extern
;
248 struct devlink_dpipe_table_ops
*table_ops
;
253 * struct devlink_dpipe_table_ops - dpipe_table ops
254 * @actions_dump - dumps all tables actions
255 * @matches_dump - dumps all tables matches
256 * @entries_dump - dumps all active entries in the table
257 * @counters_set_update - when changing the counter status hardware sync
258 * maybe needed to allocate/free counter related
260 * @size_get - get size
262 struct devlink_dpipe_table_ops
{
263 int (*actions_dump
)(void *priv
, struct sk_buff
*skb
);
264 int (*matches_dump
)(void *priv
, struct sk_buff
*skb
);
265 int (*entries_dump
)(void *priv
, bool counters_enabled
,
266 struct devlink_dpipe_dump_ctx
*dump_ctx
);
267 int (*counters_set_update
)(void *priv
, bool enable
);
268 u64 (*size_get
)(void *priv
);
272 * struct devlink_dpipe_headers - dpipe headers
273 * @headers - header array can be shared (global bit) or driver specific
274 * @headers_count - count of headers
276 struct devlink_dpipe_headers
{
277 struct devlink_dpipe_header
**headers
;
278 unsigned int headers_count
;
282 * struct devlink_resource_size_params - resource's size parameters
283 * @size_min: minimum size which can be set
284 * @size_max: maximum size which can be set
285 * @size_granularity: size granularity
286 * @size_unit: resource's basic unit
288 struct devlink_resource_size_params
{
291 u64 size_granularity
;
292 enum devlink_resource_unit unit
;
296 devlink_resource_size_params_init(struct devlink_resource_size_params
*size_params
,
297 u64 size_min
, u64 size_max
,
298 u64 size_granularity
,
299 enum devlink_resource_unit unit
)
301 size_params
->size_min
= size_min
;
302 size_params
->size_max
= size_max
;
303 size_params
->size_granularity
= size_granularity
;
304 size_params
->unit
= unit
;
307 typedef u64
devlink_resource_occ_get_t(void *priv
);
310 * struct devlink_resource - devlink resource
311 * @name: name of the resource
312 * @id: id, per devlink instance
313 * @size: size of the resource
314 * @size_new: updated size of the resource, reload is needed
315 * @size_valid: valid in case the total size of the resource is valid
316 * including its children
317 * @parent: parent resource
318 * @size_params: size parameters
320 * @resource_list: list of child resources
322 struct devlink_resource
{
328 struct devlink_resource
*parent
;
329 struct devlink_resource_size_params size_params
;
330 struct list_head list
;
331 struct list_head resource_list
;
332 devlink_resource_occ_get_t
*occ_get
;
336 #define DEVLINK_RESOURCE_ID_PARENT_TOP 0
338 #define __DEVLINK_PARAM_MAX_STRING_VALUE 32
339 enum devlink_param_type
{
340 DEVLINK_PARAM_TYPE_U8
,
341 DEVLINK_PARAM_TYPE_U16
,
342 DEVLINK_PARAM_TYPE_U32
,
343 DEVLINK_PARAM_TYPE_STRING
,
344 DEVLINK_PARAM_TYPE_BOOL
,
347 union devlink_param_value
{
351 char vstr
[__DEVLINK_PARAM_MAX_STRING_VALUE
];
355 struct devlink_param_gset_ctx
{
356 union devlink_param_value val
;
357 enum devlink_param_cmode cmode
;
361 * struct devlink_param - devlink configuration parameter data
362 * @name: name of the parameter
363 * @generic: indicates if the parameter is generic or driver specific
364 * @type: parameter type
365 * @supported_cmodes: bitmap of supported configuration modes
366 * @get: get parameter value, used for runtime and permanent
367 * configuration modes
368 * @set: set parameter value, used for runtime and permanent
369 * configuration modes
370 * @validate: validate input value is applicable (within value range, etc.)
372 * This struct should be used by the driver to fill the data for
373 * a parameter it registers.
375 struct devlink_param
{
379 enum devlink_param_type type
;
380 unsigned long supported_cmodes
;
381 int (*get
)(struct devlink
*devlink
, u32 id
,
382 struct devlink_param_gset_ctx
*ctx
);
383 int (*set
)(struct devlink
*devlink
, u32 id
,
384 struct devlink_param_gset_ctx
*ctx
);
385 int (*validate
)(struct devlink
*devlink
, u32 id
,
386 union devlink_param_value val
,
387 struct netlink_ext_ack
*extack
);
390 struct devlink_param_item
{
391 struct list_head list
;
392 const struct devlink_param
*param
;
393 union devlink_param_value driverinit_value
;
394 bool driverinit_value_valid
;
398 enum devlink_param_generic_id
{
399 DEVLINK_PARAM_GENERIC_ID_INT_ERR_RESET
,
400 DEVLINK_PARAM_GENERIC_ID_MAX_MACS
,
401 DEVLINK_PARAM_GENERIC_ID_ENABLE_SRIOV
,
402 DEVLINK_PARAM_GENERIC_ID_REGION_SNAPSHOT
,
403 DEVLINK_PARAM_GENERIC_ID_IGNORE_ARI
,
404 DEVLINK_PARAM_GENERIC_ID_MSIX_VEC_PER_PF_MAX
,
405 DEVLINK_PARAM_GENERIC_ID_MSIX_VEC_PER_PF_MIN
,
406 DEVLINK_PARAM_GENERIC_ID_FW_LOAD_POLICY
,
407 DEVLINK_PARAM_GENERIC_ID_RESET_DEV_ON_DRV_PROBE
,
408 DEVLINK_PARAM_GENERIC_ID_ENABLE_ROCE
,
410 /* add new param generic ids above here*/
411 __DEVLINK_PARAM_GENERIC_ID_MAX
,
412 DEVLINK_PARAM_GENERIC_ID_MAX
= __DEVLINK_PARAM_GENERIC_ID_MAX
- 1,
415 #define DEVLINK_PARAM_GENERIC_INT_ERR_RESET_NAME "internal_error_reset"
416 #define DEVLINK_PARAM_GENERIC_INT_ERR_RESET_TYPE DEVLINK_PARAM_TYPE_BOOL
418 #define DEVLINK_PARAM_GENERIC_MAX_MACS_NAME "max_macs"
419 #define DEVLINK_PARAM_GENERIC_MAX_MACS_TYPE DEVLINK_PARAM_TYPE_U32
421 #define DEVLINK_PARAM_GENERIC_ENABLE_SRIOV_NAME "enable_sriov"
422 #define DEVLINK_PARAM_GENERIC_ENABLE_SRIOV_TYPE DEVLINK_PARAM_TYPE_BOOL
424 #define DEVLINK_PARAM_GENERIC_REGION_SNAPSHOT_NAME "region_snapshot_enable"
425 #define DEVLINK_PARAM_GENERIC_REGION_SNAPSHOT_TYPE DEVLINK_PARAM_TYPE_BOOL
427 #define DEVLINK_PARAM_GENERIC_IGNORE_ARI_NAME "ignore_ari"
428 #define DEVLINK_PARAM_GENERIC_IGNORE_ARI_TYPE DEVLINK_PARAM_TYPE_BOOL
430 #define DEVLINK_PARAM_GENERIC_MSIX_VEC_PER_PF_MAX_NAME "msix_vec_per_pf_max"
431 #define DEVLINK_PARAM_GENERIC_MSIX_VEC_PER_PF_MAX_TYPE DEVLINK_PARAM_TYPE_U32
433 #define DEVLINK_PARAM_GENERIC_MSIX_VEC_PER_PF_MIN_NAME "msix_vec_per_pf_min"
434 #define DEVLINK_PARAM_GENERIC_MSIX_VEC_PER_PF_MIN_TYPE DEVLINK_PARAM_TYPE_U32
436 #define DEVLINK_PARAM_GENERIC_FW_LOAD_POLICY_NAME "fw_load_policy"
437 #define DEVLINK_PARAM_GENERIC_FW_LOAD_POLICY_TYPE DEVLINK_PARAM_TYPE_U8
439 #define DEVLINK_PARAM_GENERIC_RESET_DEV_ON_DRV_PROBE_NAME \
440 "reset_dev_on_drv_probe"
441 #define DEVLINK_PARAM_GENERIC_RESET_DEV_ON_DRV_PROBE_TYPE DEVLINK_PARAM_TYPE_U8
443 #define DEVLINK_PARAM_GENERIC_ENABLE_ROCE_NAME "enable_roce"
444 #define DEVLINK_PARAM_GENERIC_ENABLE_ROCE_TYPE DEVLINK_PARAM_TYPE_BOOL
446 #define DEVLINK_PARAM_GENERIC(_id, _cmodes, _get, _set, _validate) \
448 .id = DEVLINK_PARAM_GENERIC_ID_##_id, \
449 .name = DEVLINK_PARAM_GENERIC_##_id##_NAME, \
450 .type = DEVLINK_PARAM_GENERIC_##_id##_TYPE, \
452 .supported_cmodes = _cmodes, \
455 .validate = _validate, \
458 #define DEVLINK_PARAM_DRIVER(_id, _name, _type, _cmodes, _get, _set, _validate) \
463 .supported_cmodes = _cmodes, \
466 .validate = _validate, \
469 /* Part number, identifier of board design */
470 #define DEVLINK_INFO_VERSION_GENERIC_BOARD_ID "board.id"
471 /* Revision of board design */
472 #define DEVLINK_INFO_VERSION_GENERIC_BOARD_REV "board.rev"
473 /* Maker of the board */
474 #define DEVLINK_INFO_VERSION_GENERIC_BOARD_MANUFACTURE "board.manufacture"
476 /* Part number, identifier of asic design */
477 #define DEVLINK_INFO_VERSION_GENERIC_ASIC_ID "asic.id"
478 /* Revision of asic design */
479 #define DEVLINK_INFO_VERSION_GENERIC_ASIC_REV "asic.rev"
481 /* Overall FW version */
482 #define DEVLINK_INFO_VERSION_GENERIC_FW "fw"
483 /* Control processor FW version */
484 #define DEVLINK_INFO_VERSION_GENERIC_FW_MGMT "fw.mgmt"
485 /* FW interface specification version */
486 #define DEVLINK_INFO_VERSION_GENERIC_FW_MGMT_API "fw.mgmt.api"
487 /* Data path microcode controlling high-speed packet processing */
488 #define DEVLINK_INFO_VERSION_GENERIC_FW_APP "fw.app"
489 /* UNDI software version */
490 #define DEVLINK_INFO_VERSION_GENERIC_FW_UNDI "fw.undi"
491 /* NCSI support/handler version */
492 #define DEVLINK_INFO_VERSION_GENERIC_FW_NCSI "fw.ncsi"
493 /* FW parameter set id */
494 #define DEVLINK_INFO_VERSION_GENERIC_FW_PSID "fw.psid"
495 /* RoCE FW version */
496 #define DEVLINK_INFO_VERSION_GENERIC_FW_ROCE "fw.roce"
497 /* Firmware bundle identifier */
498 #define DEVLINK_INFO_VERSION_GENERIC_FW_BUNDLE_ID "fw.bundle_id"
500 struct devlink_region
;
501 struct devlink_info_req
;
504 * struct devlink_region_ops - Region operations
506 * @destructor: callback used to free snapshot memory when deleting
507 * @snapshot: callback to request an immediate snapshot. On success,
508 * the data variable must be updated to point to the snapshot data.
509 * The function will be called while the devlink instance lock is
512 struct devlink_region_ops
{
514 void (*destructor
)(const void *data
);
515 int (*snapshot
)(struct devlink
*devlink
, struct netlink_ext_ack
*extack
,
520 struct devlink_health_reporter
;
522 enum devlink_health_reporter_state
{
523 DEVLINK_HEALTH_REPORTER_STATE_HEALTHY
,
524 DEVLINK_HEALTH_REPORTER_STATE_ERROR
,
528 * struct devlink_health_reporter_ops - Reporter operations
529 * @name: reporter name
530 * @recover: callback to recover from reported error
531 * if priv_ctx is NULL, run a full recover
532 * @dump: callback to dump an object
533 * if priv_ctx is NULL, run a full dump
534 * @diagnose: callback to diagnose the current status
537 struct devlink_health_reporter_ops
{
539 int (*recover
)(struct devlink_health_reporter
*reporter
,
540 void *priv_ctx
, struct netlink_ext_ack
*extack
);
541 int (*dump
)(struct devlink_health_reporter
*reporter
,
542 struct devlink_fmsg
*fmsg
, void *priv_ctx
,
543 struct netlink_ext_ack
*extack
);
544 int (*diagnose
)(struct devlink_health_reporter
*reporter
,
545 struct devlink_fmsg
*fmsg
,
546 struct netlink_ext_ack
*extack
);
550 * struct devlink_trap_policer - Immutable packet trap policer attributes.
551 * @id: Policer identifier.
552 * @init_rate: Initial rate in packets / sec.
553 * @init_burst: Initial burst size in packets.
554 * @max_rate: Maximum rate.
555 * @min_rate: Minimum rate.
556 * @max_burst: Maximum burst size.
557 * @min_burst: Minimum burst size.
559 * Describes immutable attributes of packet trap policers that drivers register
562 struct devlink_trap_policer
{
573 * struct devlink_trap_group - Immutable packet trap group attributes.
574 * @name: Trap group name.
575 * @id: Trap group identifier.
576 * @generic: Whether the trap group is generic or not.
577 * @init_policer_id: Initial policer identifier.
579 * Describes immutable attributes of packet trap groups that drivers register
582 struct devlink_trap_group
{
589 #define DEVLINK_TRAP_METADATA_TYPE_F_IN_PORT BIT(0)
590 #define DEVLINK_TRAP_METADATA_TYPE_F_FA_COOKIE BIT(1)
593 * struct devlink_trap - Immutable packet trap attributes.
595 * @init_action: Initial trap action.
596 * @generic: Whether the trap is generic or not.
597 * @id: Trap identifier.
599 * @init_group_id: Initial group identifier.
600 * @metadata_cap: Metadata types that can be provided by the trap.
602 * Describes immutable attributes of packet traps that drivers register with
605 struct devlink_trap
{
606 enum devlink_trap_type type
;
607 enum devlink_trap_action init_action
;
615 /* All traps must be documented in
616 * Documentation/networking/devlink/devlink-trap.rst
618 enum devlink_trap_generic_id
{
619 DEVLINK_TRAP_GENERIC_ID_SMAC_MC
,
620 DEVLINK_TRAP_GENERIC_ID_VLAN_TAG_MISMATCH
,
621 DEVLINK_TRAP_GENERIC_ID_INGRESS_VLAN_FILTER
,
622 DEVLINK_TRAP_GENERIC_ID_INGRESS_STP_FILTER
,
623 DEVLINK_TRAP_GENERIC_ID_EMPTY_TX_LIST
,
624 DEVLINK_TRAP_GENERIC_ID_PORT_LOOPBACK_FILTER
,
625 DEVLINK_TRAP_GENERIC_ID_BLACKHOLE_ROUTE
,
626 DEVLINK_TRAP_GENERIC_ID_TTL_ERROR
,
627 DEVLINK_TRAP_GENERIC_ID_TAIL_DROP
,
628 DEVLINK_TRAP_GENERIC_ID_NON_IP_PACKET
,
629 DEVLINK_TRAP_GENERIC_ID_UC_DIP_MC_DMAC
,
630 DEVLINK_TRAP_GENERIC_ID_DIP_LB
,
631 DEVLINK_TRAP_GENERIC_ID_SIP_MC
,
632 DEVLINK_TRAP_GENERIC_ID_SIP_LB
,
633 DEVLINK_TRAP_GENERIC_ID_CORRUPTED_IP_HDR
,
634 DEVLINK_TRAP_GENERIC_ID_IPV4_SIP_BC
,
635 DEVLINK_TRAP_GENERIC_ID_IPV6_MC_DIP_RESERVED_SCOPE
,
636 DEVLINK_TRAP_GENERIC_ID_IPV6_MC_DIP_INTERFACE_LOCAL_SCOPE
,
637 DEVLINK_TRAP_GENERIC_ID_MTU_ERROR
,
638 DEVLINK_TRAP_GENERIC_ID_UNRESOLVED_NEIGH
,
639 DEVLINK_TRAP_GENERIC_ID_RPF
,
640 DEVLINK_TRAP_GENERIC_ID_REJECT_ROUTE
,
641 DEVLINK_TRAP_GENERIC_ID_IPV4_LPM_UNICAST_MISS
,
642 DEVLINK_TRAP_GENERIC_ID_IPV6_LPM_UNICAST_MISS
,
643 DEVLINK_TRAP_GENERIC_ID_NON_ROUTABLE
,
644 DEVLINK_TRAP_GENERIC_ID_DECAP_ERROR
,
645 DEVLINK_TRAP_GENERIC_ID_OVERLAY_SMAC_MC
,
646 DEVLINK_TRAP_GENERIC_ID_INGRESS_FLOW_ACTION_DROP
,
647 DEVLINK_TRAP_GENERIC_ID_EGRESS_FLOW_ACTION_DROP
,
649 /* Add new generic trap IDs above */
650 __DEVLINK_TRAP_GENERIC_ID_MAX
,
651 DEVLINK_TRAP_GENERIC_ID_MAX
= __DEVLINK_TRAP_GENERIC_ID_MAX
- 1,
654 /* All trap groups must be documented in
655 * Documentation/networking/devlink/devlink-trap.rst
657 enum devlink_trap_group_generic_id
{
658 DEVLINK_TRAP_GROUP_GENERIC_ID_L2_DROPS
,
659 DEVLINK_TRAP_GROUP_GENERIC_ID_L3_DROPS
,
660 DEVLINK_TRAP_GROUP_GENERIC_ID_BUFFER_DROPS
,
661 DEVLINK_TRAP_GROUP_GENERIC_ID_TUNNEL_DROPS
,
662 DEVLINK_TRAP_GROUP_GENERIC_ID_ACL_DROPS
,
664 /* Add new generic trap group IDs above */
665 __DEVLINK_TRAP_GROUP_GENERIC_ID_MAX
,
666 DEVLINK_TRAP_GROUP_GENERIC_ID_MAX
=
667 __DEVLINK_TRAP_GROUP_GENERIC_ID_MAX
- 1,
670 #define DEVLINK_TRAP_GENERIC_NAME_SMAC_MC \
671 "source_mac_is_multicast"
672 #define DEVLINK_TRAP_GENERIC_NAME_VLAN_TAG_MISMATCH \
674 #define DEVLINK_TRAP_GENERIC_NAME_INGRESS_VLAN_FILTER \
675 "ingress_vlan_filter"
676 #define DEVLINK_TRAP_GENERIC_NAME_INGRESS_STP_FILTER \
677 "ingress_spanning_tree_filter"
678 #define DEVLINK_TRAP_GENERIC_NAME_EMPTY_TX_LIST \
680 #define DEVLINK_TRAP_GENERIC_NAME_PORT_LOOPBACK_FILTER \
681 "port_loopback_filter"
682 #define DEVLINK_TRAP_GENERIC_NAME_BLACKHOLE_ROUTE \
684 #define DEVLINK_TRAP_GENERIC_NAME_TTL_ERROR \
685 "ttl_value_is_too_small"
686 #define DEVLINK_TRAP_GENERIC_NAME_TAIL_DROP \
688 #define DEVLINK_TRAP_GENERIC_NAME_NON_IP_PACKET \
690 #define DEVLINK_TRAP_GENERIC_NAME_UC_DIP_MC_DMAC \
691 "uc_dip_over_mc_dmac"
692 #define DEVLINK_TRAP_GENERIC_NAME_DIP_LB \
693 "dip_is_loopback_address"
694 #define DEVLINK_TRAP_GENERIC_NAME_SIP_MC \
696 #define DEVLINK_TRAP_GENERIC_NAME_SIP_LB \
697 "sip_is_loopback_address"
698 #define DEVLINK_TRAP_GENERIC_NAME_CORRUPTED_IP_HDR \
699 "ip_header_corrupted"
700 #define DEVLINK_TRAP_GENERIC_NAME_IPV4_SIP_BC \
701 "ipv4_sip_is_limited_bc"
702 #define DEVLINK_TRAP_GENERIC_NAME_IPV6_MC_DIP_RESERVED_SCOPE \
703 "ipv6_mc_dip_reserved_scope"
704 #define DEVLINK_TRAP_GENERIC_NAME_IPV6_MC_DIP_INTERFACE_LOCAL_SCOPE \
705 "ipv6_mc_dip_interface_local_scope"
706 #define DEVLINK_TRAP_GENERIC_NAME_MTU_ERROR \
707 "mtu_value_is_too_small"
708 #define DEVLINK_TRAP_GENERIC_NAME_UNRESOLVED_NEIGH \
710 #define DEVLINK_TRAP_GENERIC_NAME_RPF \
711 "mc_reverse_path_forwarding"
712 #define DEVLINK_TRAP_GENERIC_NAME_REJECT_ROUTE \
714 #define DEVLINK_TRAP_GENERIC_NAME_IPV4_LPM_UNICAST_MISS \
716 #define DEVLINK_TRAP_GENERIC_NAME_IPV6_LPM_UNICAST_MISS \
718 #define DEVLINK_TRAP_GENERIC_NAME_NON_ROUTABLE \
719 "non_routable_packet"
720 #define DEVLINK_TRAP_GENERIC_NAME_DECAP_ERROR \
722 #define DEVLINK_TRAP_GENERIC_NAME_OVERLAY_SMAC_MC \
724 #define DEVLINK_TRAP_GENERIC_NAME_INGRESS_FLOW_ACTION_DROP \
725 "ingress_flow_action_drop"
726 #define DEVLINK_TRAP_GENERIC_NAME_EGRESS_FLOW_ACTION_DROP \
727 "egress_flow_action_drop"
729 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_L2_DROPS \
731 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_L3_DROPS \
733 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_BUFFER_DROPS \
735 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_TUNNEL_DROPS \
737 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_ACL_DROPS \
740 #define DEVLINK_TRAP_GENERIC(_type, _init_action, _id, _group_id, \
743 .type = DEVLINK_TRAP_TYPE_##_type, \
744 .init_action = DEVLINK_TRAP_ACTION_##_init_action, \
746 .id = DEVLINK_TRAP_GENERIC_ID_##_id, \
747 .name = DEVLINK_TRAP_GENERIC_NAME_##_id, \
748 .init_group_id = _group_id, \
749 .metadata_cap = _metadata_cap, \
752 #define DEVLINK_TRAP_DRIVER(_type, _init_action, _id, _name, _group_id, \
755 .type = DEVLINK_TRAP_TYPE_##_type, \
756 .init_action = DEVLINK_TRAP_ACTION_##_init_action, \
760 .init_group_id = _group_id, \
761 .metadata_cap = _metadata_cap, \
764 #define DEVLINK_TRAP_GROUP_GENERIC(_id, _policer_id) \
766 .name = DEVLINK_TRAP_GROUP_GENERIC_NAME_##_id, \
767 .id = DEVLINK_TRAP_GROUP_GENERIC_ID_##_id, \
769 .init_policer_id = _policer_id, \
772 #define DEVLINK_TRAP_POLICER(_id, _rate, _burst, _max_rate, _min_rate, \
773 _max_burst, _min_burst) \
776 .init_rate = _rate, \
777 .init_burst = _burst, \
778 .max_rate = _max_rate, \
779 .min_rate = _min_rate, \
780 .max_burst = _max_burst, \
781 .min_burst = _min_burst, \
785 int (*reload_down
)(struct devlink
*devlink
, bool netns_change
,
786 struct netlink_ext_ack
*extack
);
787 int (*reload_up
)(struct devlink
*devlink
,
788 struct netlink_ext_ack
*extack
);
789 int (*port_type_set
)(struct devlink_port
*devlink_port
,
790 enum devlink_port_type port_type
);
791 int (*port_split
)(struct devlink
*devlink
, unsigned int port_index
,
792 unsigned int count
, struct netlink_ext_ack
*extack
);
793 int (*port_unsplit
)(struct devlink
*devlink
, unsigned int port_index
,
794 struct netlink_ext_ack
*extack
);
795 int (*sb_pool_get
)(struct devlink
*devlink
, unsigned int sb_index
,
797 struct devlink_sb_pool_info
*pool_info
);
798 int (*sb_pool_set
)(struct devlink
*devlink
, unsigned int sb_index
,
799 u16 pool_index
, u32 size
,
800 enum devlink_sb_threshold_type threshold_type
,
801 struct netlink_ext_ack
*extack
);
802 int (*sb_port_pool_get
)(struct devlink_port
*devlink_port
,
803 unsigned int sb_index
, u16 pool_index
,
805 int (*sb_port_pool_set
)(struct devlink_port
*devlink_port
,
806 unsigned int sb_index
, u16 pool_index
,
807 u32 threshold
, struct netlink_ext_ack
*extack
);
808 int (*sb_tc_pool_bind_get
)(struct devlink_port
*devlink_port
,
809 unsigned int sb_index
,
811 enum devlink_sb_pool_type pool_type
,
812 u16
*p_pool_index
, u32
*p_threshold
);
813 int (*sb_tc_pool_bind_set
)(struct devlink_port
*devlink_port
,
814 unsigned int sb_index
,
816 enum devlink_sb_pool_type pool_type
,
817 u16 pool_index
, u32 threshold
,
818 struct netlink_ext_ack
*extack
);
819 int (*sb_occ_snapshot
)(struct devlink
*devlink
,
820 unsigned int sb_index
);
821 int (*sb_occ_max_clear
)(struct devlink
*devlink
,
822 unsigned int sb_index
);
823 int (*sb_occ_port_pool_get
)(struct devlink_port
*devlink_port
,
824 unsigned int sb_index
, u16 pool_index
,
825 u32
*p_cur
, u32
*p_max
);
826 int (*sb_occ_tc_port_bind_get
)(struct devlink_port
*devlink_port
,
827 unsigned int sb_index
,
829 enum devlink_sb_pool_type pool_type
,
830 u32
*p_cur
, u32
*p_max
);
832 int (*eswitch_mode_get
)(struct devlink
*devlink
, u16
*p_mode
);
833 int (*eswitch_mode_set
)(struct devlink
*devlink
, u16 mode
,
834 struct netlink_ext_ack
*extack
);
835 int (*eswitch_inline_mode_get
)(struct devlink
*devlink
, u8
*p_inline_mode
);
836 int (*eswitch_inline_mode_set
)(struct devlink
*devlink
, u8 inline_mode
,
837 struct netlink_ext_ack
*extack
);
838 int (*eswitch_encap_mode_get
)(struct devlink
*devlink
,
839 enum devlink_eswitch_encap_mode
*p_encap_mode
);
840 int (*eswitch_encap_mode_set
)(struct devlink
*devlink
,
841 enum devlink_eswitch_encap_mode encap_mode
,
842 struct netlink_ext_ack
*extack
);
843 int (*info_get
)(struct devlink
*devlink
, struct devlink_info_req
*req
,
844 struct netlink_ext_ack
*extack
);
845 int (*flash_update
)(struct devlink
*devlink
, const char *file_name
,
846 const char *component
,
847 struct netlink_ext_ack
*extack
);
849 * @trap_init: Trap initialization function.
851 * Should be used by device drivers to initialize the trap in the
852 * underlying device. Drivers should also store the provided trap
853 * context, so that they could efficiently pass it to
854 * devlink_trap_report() when the trap is triggered.
856 int (*trap_init
)(struct devlink
*devlink
,
857 const struct devlink_trap
*trap
, void *trap_ctx
);
859 * @trap_fini: Trap de-initialization function.
861 * Should be used by device drivers to de-initialize the trap in the
864 void (*trap_fini
)(struct devlink
*devlink
,
865 const struct devlink_trap
*trap
, void *trap_ctx
);
867 * @trap_action_set: Trap action set function.
869 int (*trap_action_set
)(struct devlink
*devlink
,
870 const struct devlink_trap
*trap
,
871 enum devlink_trap_action action
);
873 * @trap_group_init: Trap group initialization function.
875 * Should be used by device drivers to initialize the trap group in the
878 int (*trap_group_init
)(struct devlink
*devlink
,
879 const struct devlink_trap_group
*group
);
881 * @trap_group_set: Trap group parameters set function.
883 * Note: @policer can be NULL when a policer is being unbound from
886 int (*trap_group_set
)(struct devlink
*devlink
,
887 const struct devlink_trap_group
*group
,
888 const struct devlink_trap_policer
*policer
);
890 * @trap_policer_init: Trap policer initialization function.
892 * Should be used by device drivers to initialize the trap policer in
893 * the underlying device.
895 int (*trap_policer_init
)(struct devlink
*devlink
,
896 const struct devlink_trap_policer
*policer
);
898 * @trap_policer_fini: Trap policer de-initialization function.
900 * Should be used by device drivers to de-initialize the trap policer
901 * in the underlying device.
903 void (*trap_policer_fini
)(struct devlink
*devlink
,
904 const struct devlink_trap_policer
*policer
);
906 * @trap_policer_set: Trap policer parameters set function.
908 int (*trap_policer_set
)(struct devlink
*devlink
,
909 const struct devlink_trap_policer
*policer
,
911 struct netlink_ext_ack
*extack
);
913 * @trap_policer_counter_get: Trap policer counter get function.
915 * Should be used by device drivers to report number of packets dropped
918 int (*trap_policer_counter_get
)(struct devlink
*devlink
,
919 const struct devlink_trap_policer
*policer
,
923 static inline void *devlink_priv(struct devlink
*devlink
)
926 return &devlink
->priv
;
929 static inline struct devlink
*priv_to_devlink(void *priv
)
932 return container_of(priv
, struct devlink
, priv
);
935 static inline struct devlink_port
*
936 netdev_to_devlink_port(struct net_device
*dev
)
938 if (dev
->netdev_ops
->ndo_get_devlink_port
)
939 return dev
->netdev_ops
->ndo_get_devlink_port(dev
);
943 static inline struct devlink
*netdev_to_devlink(struct net_device
*dev
)
945 struct devlink_port
*devlink_port
= netdev_to_devlink_port(dev
);
948 return devlink_port
->devlink
;
954 struct net
*devlink_net(const struct devlink
*devlink
);
955 void devlink_net_set(struct devlink
*devlink
, struct net
*net
);
956 struct devlink
*devlink_alloc(const struct devlink_ops
*ops
, size_t priv_size
);
957 int devlink_register(struct devlink
*devlink
, struct device
*dev
);
958 void devlink_unregister(struct devlink
*devlink
);
959 void devlink_reload_enable(struct devlink
*devlink
);
960 void devlink_reload_disable(struct devlink
*devlink
);
961 void devlink_free(struct devlink
*devlink
);
962 int devlink_port_register(struct devlink
*devlink
,
963 struct devlink_port
*devlink_port
,
964 unsigned int port_index
);
965 void devlink_port_unregister(struct devlink_port
*devlink_port
);
966 void devlink_port_type_eth_set(struct devlink_port
*devlink_port
,
967 struct net_device
*netdev
);
968 void devlink_port_type_ib_set(struct devlink_port
*devlink_port
,
969 struct ib_device
*ibdev
);
970 void devlink_port_type_clear(struct devlink_port
*devlink_port
);
971 void devlink_port_attrs_set(struct devlink_port
*devlink_port
,
972 enum devlink_port_flavour flavour
,
973 u32 port_number
, bool split
,
974 u32 split_subport_number
,
975 const unsigned char *switch_id
,
976 unsigned char switch_id_len
);
977 void devlink_port_attrs_pci_pf_set(struct devlink_port
*devlink_port
,
978 const unsigned char *switch_id
,
979 unsigned char switch_id_len
, u16 pf
);
980 void devlink_port_attrs_pci_vf_set(struct devlink_port
*devlink_port
,
981 const unsigned char *switch_id
,
982 unsigned char switch_id_len
,
984 int devlink_sb_register(struct devlink
*devlink
, unsigned int sb_index
,
985 u32 size
, u16 ingress_pools_count
,
986 u16 egress_pools_count
, u16 ingress_tc_count
,
987 u16 egress_tc_count
);
988 void devlink_sb_unregister(struct devlink
*devlink
, unsigned int sb_index
);
989 int devlink_dpipe_table_register(struct devlink
*devlink
,
990 const char *table_name
,
991 struct devlink_dpipe_table_ops
*table_ops
,
992 void *priv
, bool counter_control_extern
);
993 void devlink_dpipe_table_unregister(struct devlink
*devlink
,
994 const char *table_name
);
995 int devlink_dpipe_headers_register(struct devlink
*devlink
,
996 struct devlink_dpipe_headers
*dpipe_headers
);
997 void devlink_dpipe_headers_unregister(struct devlink
*devlink
);
998 bool devlink_dpipe_table_counter_enabled(struct devlink
*devlink
,
999 const char *table_name
);
1000 int devlink_dpipe_entry_ctx_prepare(struct devlink_dpipe_dump_ctx
*dump_ctx
);
1001 int devlink_dpipe_entry_ctx_append(struct devlink_dpipe_dump_ctx
*dump_ctx
,
1002 struct devlink_dpipe_entry
*entry
);
1003 int devlink_dpipe_entry_ctx_close(struct devlink_dpipe_dump_ctx
*dump_ctx
);
1004 void devlink_dpipe_entry_clear(struct devlink_dpipe_entry
*entry
);
1005 int devlink_dpipe_action_put(struct sk_buff
*skb
,
1006 struct devlink_dpipe_action
*action
);
1007 int devlink_dpipe_match_put(struct sk_buff
*skb
,
1008 struct devlink_dpipe_match
*match
);
1009 extern struct devlink_dpipe_header devlink_dpipe_header_ethernet
;
1010 extern struct devlink_dpipe_header devlink_dpipe_header_ipv4
;
1011 extern struct devlink_dpipe_header devlink_dpipe_header_ipv6
;
1013 int devlink_resource_register(struct devlink
*devlink
,
1014 const char *resource_name
,
1017 u64 parent_resource_id
,
1018 const struct devlink_resource_size_params
*size_params
);
1019 void devlink_resources_unregister(struct devlink
*devlink
,
1020 struct devlink_resource
*resource
);
1021 int devlink_resource_size_get(struct devlink
*devlink
,
1023 u64
*p_resource_size
);
1024 int devlink_dpipe_table_resource_set(struct devlink
*devlink
,
1025 const char *table_name
, u64 resource_id
,
1026 u64 resource_units
);
1027 void devlink_resource_occ_get_register(struct devlink
*devlink
,
1029 devlink_resource_occ_get_t
*occ_get
,
1030 void *occ_get_priv
);
1031 void devlink_resource_occ_get_unregister(struct devlink
*devlink
,
1033 int devlink_params_register(struct devlink
*devlink
,
1034 const struct devlink_param
*params
,
1035 size_t params_count
);
1036 void devlink_params_unregister(struct devlink
*devlink
,
1037 const struct devlink_param
*params
,
1038 size_t params_count
);
1039 void devlink_params_publish(struct devlink
*devlink
);
1040 void devlink_params_unpublish(struct devlink
*devlink
);
1041 int devlink_port_params_register(struct devlink_port
*devlink_port
,
1042 const struct devlink_param
*params
,
1043 size_t params_count
);
1044 void devlink_port_params_unregister(struct devlink_port
*devlink_port
,
1045 const struct devlink_param
*params
,
1046 size_t params_count
);
1047 int devlink_param_driverinit_value_get(struct devlink
*devlink
, u32 param_id
,
1048 union devlink_param_value
*init_val
);
1049 int devlink_param_driverinit_value_set(struct devlink
*devlink
, u32 param_id
,
1050 union devlink_param_value init_val
);
1052 devlink_port_param_driverinit_value_get(struct devlink_port
*devlink_port
,
1054 union devlink_param_value
*init_val
);
1055 int devlink_port_param_driverinit_value_set(struct devlink_port
*devlink_port
,
1057 union devlink_param_value init_val
);
1058 void devlink_param_value_changed(struct devlink
*devlink
, u32 param_id
);
1059 void devlink_port_param_value_changed(struct devlink_port
*devlink_port
,
1061 void devlink_param_value_str_fill(union devlink_param_value
*dst_val
,
1063 struct devlink_region
*
1064 devlink_region_create(struct devlink
*devlink
,
1065 const struct devlink_region_ops
*ops
,
1066 u32 region_max_snapshots
, u64 region_size
);
1067 void devlink_region_destroy(struct devlink_region
*region
);
1068 int devlink_region_snapshot_id_get(struct devlink
*devlink
, u32
*id
);
1069 void devlink_region_snapshot_id_put(struct devlink
*devlink
, u32 id
);
1070 int devlink_region_snapshot_create(struct devlink_region
*region
,
1071 u8
*data
, u32 snapshot_id
);
1072 int devlink_info_serial_number_put(struct devlink_info_req
*req
,
1074 int devlink_info_driver_name_put(struct devlink_info_req
*req
,
1076 int devlink_info_version_fixed_put(struct devlink_info_req
*req
,
1077 const char *version_name
,
1078 const char *version_value
);
1079 int devlink_info_version_stored_put(struct devlink_info_req
*req
,
1080 const char *version_name
,
1081 const char *version_value
);
1082 int devlink_info_version_running_put(struct devlink_info_req
*req
,
1083 const char *version_name
,
1084 const char *version_value
);
1086 int devlink_fmsg_obj_nest_start(struct devlink_fmsg
*fmsg
);
1087 int devlink_fmsg_obj_nest_end(struct devlink_fmsg
*fmsg
);
1089 int devlink_fmsg_pair_nest_start(struct devlink_fmsg
*fmsg
, const char *name
);
1090 int devlink_fmsg_pair_nest_end(struct devlink_fmsg
*fmsg
);
1092 int devlink_fmsg_arr_pair_nest_start(struct devlink_fmsg
*fmsg
,
1094 int devlink_fmsg_arr_pair_nest_end(struct devlink_fmsg
*fmsg
);
1095 int devlink_fmsg_binary_pair_nest_start(struct devlink_fmsg
*fmsg
,
1097 int devlink_fmsg_binary_pair_nest_end(struct devlink_fmsg
*fmsg
);
1099 int devlink_fmsg_bool_put(struct devlink_fmsg
*fmsg
, bool value
);
1100 int devlink_fmsg_u8_put(struct devlink_fmsg
*fmsg
, u8 value
);
1101 int devlink_fmsg_u32_put(struct devlink_fmsg
*fmsg
, u32 value
);
1102 int devlink_fmsg_u64_put(struct devlink_fmsg
*fmsg
, u64 value
);
1103 int devlink_fmsg_string_put(struct devlink_fmsg
*fmsg
, const char *value
);
1104 int devlink_fmsg_binary_put(struct devlink_fmsg
*fmsg
, const void *value
,
1107 int devlink_fmsg_bool_pair_put(struct devlink_fmsg
*fmsg
, const char *name
,
1109 int devlink_fmsg_u8_pair_put(struct devlink_fmsg
*fmsg
, const char *name
,
1111 int devlink_fmsg_u32_pair_put(struct devlink_fmsg
*fmsg
, const char *name
,
1113 int devlink_fmsg_u64_pair_put(struct devlink_fmsg
*fmsg
, const char *name
,
1115 int devlink_fmsg_string_pair_put(struct devlink_fmsg
*fmsg
, const char *name
,
1117 int devlink_fmsg_binary_pair_put(struct devlink_fmsg
*fmsg
, const char *name
,
1118 const void *value
, u32 value_len
);
1120 struct devlink_health_reporter
*
1121 devlink_health_reporter_create(struct devlink
*devlink
,
1122 const struct devlink_health_reporter_ops
*ops
,
1123 u64 graceful_period
, void *priv
);
1125 devlink_health_reporter_destroy(struct devlink_health_reporter
*reporter
);
1128 devlink_health_reporter_priv(struct devlink_health_reporter
*reporter
);
1129 int devlink_health_report(struct devlink_health_reporter
*reporter
,
1130 const char *msg
, void *priv_ctx
);
1132 devlink_health_reporter_state_update(struct devlink_health_reporter
*reporter
,
1133 enum devlink_health_reporter_state state
);
1135 devlink_health_reporter_recovery_done(struct devlink_health_reporter
*reporter
);
1137 bool devlink_is_reload_failed(const struct devlink
*devlink
);
1139 void devlink_flash_update_begin_notify(struct devlink
*devlink
);
1140 void devlink_flash_update_end_notify(struct devlink
*devlink
);
1141 void devlink_flash_update_status_notify(struct devlink
*devlink
,
1142 const char *status_msg
,
1143 const char *component
,
1145 unsigned long total
);
1147 int devlink_traps_register(struct devlink
*devlink
,
1148 const struct devlink_trap
*traps
,
1149 size_t traps_count
, void *priv
);
1150 void devlink_traps_unregister(struct devlink
*devlink
,
1151 const struct devlink_trap
*traps
,
1152 size_t traps_count
);
1153 void devlink_trap_report(struct devlink
*devlink
, struct sk_buff
*skb
,
1154 void *trap_ctx
, struct devlink_port
*in_devlink_port
,
1155 const struct flow_action_cookie
*fa_cookie
);
1156 void *devlink_trap_ctx_priv(void *trap_ctx
);
1157 int devlink_trap_groups_register(struct devlink
*devlink
,
1158 const struct devlink_trap_group
*groups
,
1159 size_t groups_count
);
1160 void devlink_trap_groups_unregister(struct devlink
*devlink
,
1161 const struct devlink_trap_group
*groups
,
1162 size_t groups_count
);
1164 devlink_trap_policers_register(struct devlink
*devlink
,
1165 const struct devlink_trap_policer
*policers
,
1166 size_t policers_count
);
1168 devlink_trap_policers_unregister(struct devlink
*devlink
,
1169 const struct devlink_trap_policer
*policers
,
1170 size_t policers_count
);
1172 #if IS_ENABLED(CONFIG_NET_DEVLINK)
1174 void devlink_compat_running_version(struct net_device
*dev
,
1175 char *buf
, size_t len
);
1176 int devlink_compat_flash_update(struct net_device
*dev
, const char *file_name
);
1177 int devlink_compat_phys_port_name_get(struct net_device
*dev
,
1178 char *name
, size_t len
);
1179 int devlink_compat_switch_id_get(struct net_device
*dev
,
1180 struct netdev_phys_item_id
*ppid
);
1185 devlink_compat_running_version(struct net_device
*dev
, char *buf
, size_t len
)
1190 devlink_compat_flash_update(struct net_device
*dev
, const char *file_name
)
1196 devlink_compat_phys_port_name_get(struct net_device
*dev
,
1197 char *name
, size_t len
)
1203 devlink_compat_switch_id_get(struct net_device
*dev
,
1204 struct netdev_phys_item_id
*ppid
)
1211 #endif /* _NET_DEVLINK_H_ */