Linux Audio

Check our new training course

Loading...
Note: File does not exist in v3.1.
   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
  23struct devlink_ops;
  24
  25struct devlink {
  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;
  41	struct device *dev;
  42	possible_net_t _net;
  43	struct mutex lock; /* Serializes access to devlink instance specific objects such as
  44			    * port, sb, dpipe, resource, params, region, traps and more.
  45			    */
  46	u8 reload_failed:1,
  47	   reload_enabled:1,
  48	   registered:1;
  49	char priv[0] __aligned(NETDEV_ALIGN);
  50};
  51
  52struct devlink_port_phys_attrs {
  53	u32 port_number; /* Same value as "split group".
  54			  * A physical port which is visible to the user
  55			  * for a given port flavour.
  56			  */
  57	u32 split_subport_number; /* If the port is split, this is the number of subport. */
  58};
  59
  60struct devlink_port_pci_pf_attrs {
  61	u16 pf;	/* Associated PCI PF for this port. */
  62};
  63
  64struct devlink_port_pci_vf_attrs {
  65	u16 pf;	/* Associated PCI PF for this port. */
  66	u16 vf;	/* Associated PCI VF for of the PCI PF for this port. */
  67};
  68
  69/**
  70 * struct devlink_port_attrs - devlink port object
  71 * @flavour: flavour of the port
  72 * @split: indicates if this is split port
  73 * @splittable: indicates if the port can be split.
  74 * @lanes: maximum number of lanes the port supports. 0 value is not passed to netlink.
  75 * @switch_id: if the port is part of switch, this is buffer with ID, otherwise this is NULL
  76 */
  77struct devlink_port_attrs {
  78	u8 split:1,
  79	   splittable:1;
  80	u32 lanes;
  81	enum devlink_port_flavour flavour;
  82	struct netdev_phys_item_id switch_id;
  83	union {
  84		struct devlink_port_phys_attrs phys;
  85		struct devlink_port_pci_pf_attrs pci_pf;
  86		struct devlink_port_pci_vf_attrs pci_vf;
  87	};
  88};
  89
  90struct devlink_port {
  91	struct list_head list;
  92	struct list_head param_list;
  93	struct devlink *devlink;
  94	unsigned int index;
  95	bool registered;
  96	spinlock_t type_lock; /* Protects type and type_dev
  97			       * pointer consistency.
  98			       */
  99	enum devlink_port_type type;
 100	enum devlink_port_type desired_type;
 101	void *type_dev;
 102	struct devlink_port_attrs attrs;
 103	u8 attrs_set:1,
 104	   switch_port:1;
 105	struct delayed_work type_warn_dw;
 106	struct list_head reporter_list;
 107	struct mutex reporters_lock; /* Protects reporter_list */
 108};
 109
 110struct devlink_sb_pool_info {
 111	enum devlink_sb_pool_type pool_type;
 112	u32 size;
 113	enum devlink_sb_threshold_type threshold_type;
 114	u32 cell_size;
 115};
 116
 117/**
 118 * struct devlink_dpipe_field - dpipe field object
 119 * @name: field name
 120 * @id: index inside the headers field array
 121 * @bitwidth: bitwidth
 122 * @mapping_type: mapping type
 123 */
 124struct devlink_dpipe_field {
 125	const char *name;
 126	unsigned int id;
 127	unsigned int bitwidth;
 128	enum devlink_dpipe_field_mapping_type mapping_type;
 129};
 130
 131/**
 132 * struct devlink_dpipe_header - dpipe header object
 133 * @name: header name
 134 * @id: index, global/local detrmined by global bit
 135 * @fields: fields
 136 * @fields_count: number of fields
 137 * @global: indicates if header is shared like most protocol header
 138 *	    or driver specific
 139 */
 140struct devlink_dpipe_header {
 141	const char *name;
 142	unsigned int id;
 143	struct devlink_dpipe_field *fields;
 144	unsigned int fields_count;
 145	bool global;
 146};
 147
 148/**
 149 * struct devlink_dpipe_match - represents match operation
 150 * @type: type of match
 151 * @header_index: header index (packets can have several headers of same
 152 *		  type like in case of tunnels)
 153 * @header: header
 154 * @fieled_id: field index
 155 */
 156struct devlink_dpipe_match {
 157	enum devlink_dpipe_match_type type;
 158	unsigned int header_index;
 159	struct devlink_dpipe_header *header;
 160	unsigned int field_id;
 161};
 162
 163/**
 164 * struct devlink_dpipe_action - represents action operation
 165 * @type: type of action
 166 * @header_index: header index (packets can have several headers of same
 167 *		  type like in case of tunnels)
 168 * @header: header
 169 * @fieled_id: field index
 170 */
 171struct devlink_dpipe_action {
 172	enum devlink_dpipe_action_type type;
 173	unsigned int header_index;
 174	struct devlink_dpipe_header *header;
 175	unsigned int field_id;
 176};
 177
 178/**
 179 * struct devlink_dpipe_value - represents value of match/action
 180 * @action: action
 181 * @match: match
 182 * @mapping_value: in case the field has some mapping this value
 183 *                 specified the mapping value
 184 * @mapping_valid: specify if mapping value is valid
 185 * @value_size: value size
 186 * @value: value
 187 * @mask: bit mask
 188 */
 189struct devlink_dpipe_value {
 190	union {
 191		struct devlink_dpipe_action *action;
 192		struct devlink_dpipe_match *match;
 193	};
 194	unsigned int mapping_value;
 195	bool mapping_valid;
 196	unsigned int value_size;
 197	void *value;
 198	void *mask;
 199};
 200
 201/**
 202 * struct devlink_dpipe_entry - table entry object
 203 * @index: index of the entry in the table
 204 * @match_values: match values
 205 * @matche_values_count: count of matches tuples
 206 * @action_values: actions values
 207 * @action_values_count: count of actions values
 208 * @counter: value of counter
 209 * @counter_valid: Specify if value is valid from hardware
 210 */
 211struct devlink_dpipe_entry {
 212	u64 index;
 213	struct devlink_dpipe_value *match_values;
 214	unsigned int match_values_count;
 215	struct devlink_dpipe_value *action_values;
 216	unsigned int action_values_count;
 217	u64 counter;
 218	bool counter_valid;
 219};
 220
 221/**
 222 * struct devlink_dpipe_dump_ctx - context provided to driver in order
 223 *				   to dump
 224 * @info: info
 225 * @cmd: devlink command
 226 * @skb: skb
 227 * @nest: top attribute
 228 * @hdr: hdr
 229 */
 230struct devlink_dpipe_dump_ctx {
 231	struct genl_info *info;
 232	enum devlink_command cmd;
 233	struct sk_buff *skb;
 234	struct nlattr *nest;
 235	void *hdr;
 236};
 237
 238struct devlink_dpipe_table_ops;
 239
 240/**
 241 * struct devlink_dpipe_table - table object
 242 * @priv: private
 243 * @name: table name
 244 * @counters_enabled: indicates if counters are active
 245 * @counter_control_extern: indicates if counter control is in dpipe or
 246 *			    external tool
 247 * @resource_valid: Indicate that the resource id is valid
 248 * @resource_id: relative resource this table is related to
 249 * @resource_units: number of resource's unit consumed per table's entry
 250 * @table_ops: table operations
 251 * @rcu: rcu
 252 */
 253struct devlink_dpipe_table {
 254	void *priv;
 255	struct list_head list;
 256	const char *name;
 257	bool counters_enabled;
 258	bool counter_control_extern;
 259	bool resource_valid;
 260	u64 resource_id;
 261	u64 resource_units;
 262	struct devlink_dpipe_table_ops *table_ops;
 263	struct rcu_head rcu;
 264};
 265
 266/**
 267 * struct devlink_dpipe_table_ops - dpipe_table ops
 268 * @actions_dump - dumps all tables actions
 269 * @matches_dump - dumps all tables matches
 270 * @entries_dump - dumps all active entries in the table
 271 * @counters_set_update - when changing the counter status hardware sync
 272 *			  maybe needed to allocate/free counter related
 273 *			  resources
 274 * @size_get - get size
 275 */
 276struct devlink_dpipe_table_ops {
 277	int (*actions_dump)(void *priv, struct sk_buff *skb);
 278	int (*matches_dump)(void *priv, struct sk_buff *skb);
 279	int (*entries_dump)(void *priv, bool counters_enabled,
 280			    struct devlink_dpipe_dump_ctx *dump_ctx);
 281	int (*counters_set_update)(void *priv, bool enable);
 282	u64 (*size_get)(void *priv);
 283};
 284
 285/**
 286 * struct devlink_dpipe_headers - dpipe headers
 287 * @headers - header array can be shared (global bit) or driver specific
 288 * @headers_count - count of headers
 289 */
 290struct devlink_dpipe_headers {
 291	struct devlink_dpipe_header **headers;
 292	unsigned int headers_count;
 293};
 294
 295/**
 296 * struct devlink_resource_size_params - resource's size parameters
 297 * @size_min: minimum size which can be set
 298 * @size_max: maximum size which can be set
 299 * @size_granularity: size granularity
 300 * @size_unit: resource's basic unit
 301 */
 302struct devlink_resource_size_params {
 303	u64 size_min;
 304	u64 size_max;
 305	u64 size_granularity;
 306	enum devlink_resource_unit unit;
 307};
 308
 309static inline void
 310devlink_resource_size_params_init(struct devlink_resource_size_params *size_params,
 311				  u64 size_min, u64 size_max,
 312				  u64 size_granularity,
 313				  enum devlink_resource_unit unit)
 314{
 315	size_params->size_min = size_min;
 316	size_params->size_max = size_max;
 317	size_params->size_granularity = size_granularity;
 318	size_params->unit = unit;
 319}
 320
 321typedef u64 devlink_resource_occ_get_t(void *priv);
 322
 323/**
 324 * struct devlink_resource - devlink resource
 325 * @name: name of the resource
 326 * @id: id, per devlink instance
 327 * @size: size of the resource
 328 * @size_new: updated size of the resource, reload is needed
 329 * @size_valid: valid in case the total size of the resource is valid
 330 *              including its children
 331 * @parent: parent resource
 332 * @size_params: size parameters
 333 * @list: parent list
 334 * @resource_list: list of child resources
 335 */
 336struct devlink_resource {
 337	const char *name;
 338	u64 id;
 339	u64 size;
 340	u64 size_new;
 341	bool size_valid;
 342	struct devlink_resource *parent;
 343	struct devlink_resource_size_params size_params;
 344	struct list_head list;
 345	struct list_head resource_list;
 346	devlink_resource_occ_get_t *occ_get;
 347	void *occ_get_priv;
 348};
 349
 350#define DEVLINK_RESOURCE_ID_PARENT_TOP 0
 351
 352#define __DEVLINK_PARAM_MAX_STRING_VALUE 32
 353enum devlink_param_type {
 354	DEVLINK_PARAM_TYPE_U8,
 355	DEVLINK_PARAM_TYPE_U16,
 356	DEVLINK_PARAM_TYPE_U32,
 357	DEVLINK_PARAM_TYPE_STRING,
 358	DEVLINK_PARAM_TYPE_BOOL,
 359};
 360
 361union devlink_param_value {
 362	u8 vu8;
 363	u16 vu16;
 364	u32 vu32;
 365	char vstr[__DEVLINK_PARAM_MAX_STRING_VALUE];
 366	bool vbool;
 367};
 368
 369struct devlink_param_gset_ctx {
 370	union devlink_param_value val;
 371	enum devlink_param_cmode cmode;
 372};
 373
 374/**
 375 * struct devlink_param - devlink configuration parameter data
 376 * @name: name of the parameter
 377 * @generic: indicates if the parameter is generic or driver specific
 378 * @type: parameter type
 379 * @supported_cmodes: bitmap of supported configuration modes
 380 * @get: get parameter value, used for runtime and permanent
 381 *       configuration modes
 382 * @set: set parameter value, used for runtime and permanent
 383 *       configuration modes
 384 * @validate: validate input value is applicable (within value range, etc.)
 385 *
 386 * This struct should be used by the driver to fill the data for
 387 * a parameter it registers.
 388 */
 389struct devlink_param {
 390	u32 id;
 391	const char *name;
 392	bool generic;
 393	enum devlink_param_type type;
 394	unsigned long supported_cmodes;
 395	int (*get)(struct devlink *devlink, u32 id,
 396		   struct devlink_param_gset_ctx *ctx);
 397	int (*set)(struct devlink *devlink, u32 id,
 398		   struct devlink_param_gset_ctx *ctx);
 399	int (*validate)(struct devlink *devlink, u32 id,
 400			union devlink_param_value val,
 401			struct netlink_ext_ack *extack);
 402};
 403
 404struct devlink_param_item {
 405	struct list_head list;
 406	const struct devlink_param *param;
 407	union devlink_param_value driverinit_value;
 408	bool driverinit_value_valid;
 409	bool published;
 410};
 411
 412enum devlink_param_generic_id {
 413	DEVLINK_PARAM_GENERIC_ID_INT_ERR_RESET,
 414	DEVLINK_PARAM_GENERIC_ID_MAX_MACS,
 415	DEVLINK_PARAM_GENERIC_ID_ENABLE_SRIOV,
 416	DEVLINK_PARAM_GENERIC_ID_REGION_SNAPSHOT,
 417	DEVLINK_PARAM_GENERIC_ID_IGNORE_ARI,
 418	DEVLINK_PARAM_GENERIC_ID_MSIX_VEC_PER_PF_MAX,
 419	DEVLINK_PARAM_GENERIC_ID_MSIX_VEC_PER_PF_MIN,
 420	DEVLINK_PARAM_GENERIC_ID_FW_LOAD_POLICY,
 421	DEVLINK_PARAM_GENERIC_ID_RESET_DEV_ON_DRV_PROBE,
 422	DEVLINK_PARAM_GENERIC_ID_ENABLE_ROCE,
 423
 424	/* add new param generic ids above here*/
 425	__DEVLINK_PARAM_GENERIC_ID_MAX,
 426	DEVLINK_PARAM_GENERIC_ID_MAX = __DEVLINK_PARAM_GENERIC_ID_MAX - 1,
 427};
 428
 429#define DEVLINK_PARAM_GENERIC_INT_ERR_RESET_NAME "internal_error_reset"
 430#define DEVLINK_PARAM_GENERIC_INT_ERR_RESET_TYPE DEVLINK_PARAM_TYPE_BOOL
 431
 432#define DEVLINK_PARAM_GENERIC_MAX_MACS_NAME "max_macs"
 433#define DEVLINK_PARAM_GENERIC_MAX_MACS_TYPE DEVLINK_PARAM_TYPE_U32
 434
 435#define DEVLINK_PARAM_GENERIC_ENABLE_SRIOV_NAME "enable_sriov"
 436#define DEVLINK_PARAM_GENERIC_ENABLE_SRIOV_TYPE DEVLINK_PARAM_TYPE_BOOL
 437
 438#define DEVLINK_PARAM_GENERIC_REGION_SNAPSHOT_NAME "region_snapshot_enable"
 439#define DEVLINK_PARAM_GENERIC_REGION_SNAPSHOT_TYPE DEVLINK_PARAM_TYPE_BOOL
 440
 441#define DEVLINK_PARAM_GENERIC_IGNORE_ARI_NAME "ignore_ari"
 442#define DEVLINK_PARAM_GENERIC_IGNORE_ARI_TYPE DEVLINK_PARAM_TYPE_BOOL
 443
 444#define DEVLINK_PARAM_GENERIC_MSIX_VEC_PER_PF_MAX_NAME "msix_vec_per_pf_max"
 445#define DEVLINK_PARAM_GENERIC_MSIX_VEC_PER_PF_MAX_TYPE DEVLINK_PARAM_TYPE_U32
 446
 447#define DEVLINK_PARAM_GENERIC_MSIX_VEC_PER_PF_MIN_NAME "msix_vec_per_pf_min"
 448#define DEVLINK_PARAM_GENERIC_MSIX_VEC_PER_PF_MIN_TYPE DEVLINK_PARAM_TYPE_U32
 449
 450#define DEVLINK_PARAM_GENERIC_FW_LOAD_POLICY_NAME "fw_load_policy"
 451#define DEVLINK_PARAM_GENERIC_FW_LOAD_POLICY_TYPE DEVLINK_PARAM_TYPE_U8
 452
 453#define DEVLINK_PARAM_GENERIC_RESET_DEV_ON_DRV_PROBE_NAME \
 454	"reset_dev_on_drv_probe"
 455#define DEVLINK_PARAM_GENERIC_RESET_DEV_ON_DRV_PROBE_TYPE DEVLINK_PARAM_TYPE_U8
 456
 457#define DEVLINK_PARAM_GENERIC_ENABLE_ROCE_NAME "enable_roce"
 458#define DEVLINK_PARAM_GENERIC_ENABLE_ROCE_TYPE DEVLINK_PARAM_TYPE_BOOL
 459
 460#define DEVLINK_PARAM_GENERIC(_id, _cmodes, _get, _set, _validate)	\
 461{									\
 462	.id = DEVLINK_PARAM_GENERIC_ID_##_id,				\
 463	.name = DEVLINK_PARAM_GENERIC_##_id##_NAME,			\
 464	.type = DEVLINK_PARAM_GENERIC_##_id##_TYPE,			\
 465	.generic = true,						\
 466	.supported_cmodes = _cmodes,					\
 467	.get = _get,							\
 468	.set = _set,							\
 469	.validate = _validate,						\
 470}
 471
 472#define DEVLINK_PARAM_DRIVER(_id, _name, _type, _cmodes, _get, _set, _validate)	\
 473{									\
 474	.id = _id,							\
 475	.name = _name,							\
 476	.type = _type,							\
 477	.supported_cmodes = _cmodes,					\
 478	.get = _get,							\
 479	.set = _set,							\
 480	.validate = _validate,						\
 481}
 482
 483/* Part number, identifier of board design */
 484#define DEVLINK_INFO_VERSION_GENERIC_BOARD_ID	"board.id"
 485/* Revision of board design */
 486#define DEVLINK_INFO_VERSION_GENERIC_BOARD_REV	"board.rev"
 487/* Maker of the board */
 488#define DEVLINK_INFO_VERSION_GENERIC_BOARD_MANUFACTURE	"board.manufacture"
 489
 490/* Part number, identifier of asic design */
 491#define DEVLINK_INFO_VERSION_GENERIC_ASIC_ID	"asic.id"
 492/* Revision of asic design */
 493#define DEVLINK_INFO_VERSION_GENERIC_ASIC_REV	"asic.rev"
 494
 495/* Overall FW version */
 496#define DEVLINK_INFO_VERSION_GENERIC_FW		"fw"
 497/* Control processor FW version */
 498#define DEVLINK_INFO_VERSION_GENERIC_FW_MGMT	"fw.mgmt"
 499/* FW interface specification version */
 500#define DEVLINK_INFO_VERSION_GENERIC_FW_MGMT_API	"fw.mgmt.api"
 501/* Data path microcode controlling high-speed packet processing */
 502#define DEVLINK_INFO_VERSION_GENERIC_FW_APP	"fw.app"
 503/* UNDI software version */
 504#define DEVLINK_INFO_VERSION_GENERIC_FW_UNDI	"fw.undi"
 505/* NCSI support/handler version */
 506#define DEVLINK_INFO_VERSION_GENERIC_FW_NCSI	"fw.ncsi"
 507/* FW parameter set id */
 508#define DEVLINK_INFO_VERSION_GENERIC_FW_PSID	"fw.psid"
 509/* RoCE FW version */
 510#define DEVLINK_INFO_VERSION_GENERIC_FW_ROCE	"fw.roce"
 511/* Firmware bundle identifier */
 512#define DEVLINK_INFO_VERSION_GENERIC_FW_BUNDLE_ID	"fw.bundle_id"
 513
 514struct devlink_region;
 515struct devlink_info_req;
 516
 517/**
 518 * struct devlink_region_ops - Region operations
 519 * @name: region name
 520 * @destructor: callback used to free snapshot memory when deleting
 521 * @snapshot: callback to request an immediate snapshot. On success,
 522 *            the data variable must be updated to point to the snapshot data.
 523 *            The function will be called while the devlink instance lock is
 524 *            held.
 525 */
 526struct devlink_region_ops {
 527	const char *name;
 528	void (*destructor)(const void *data);
 529	int (*snapshot)(struct devlink *devlink, struct netlink_ext_ack *extack,
 530			u8 **data);
 531};
 532
 533struct devlink_fmsg;
 534struct devlink_health_reporter;
 535
 536enum devlink_health_reporter_state {
 537	DEVLINK_HEALTH_REPORTER_STATE_HEALTHY,
 538	DEVLINK_HEALTH_REPORTER_STATE_ERROR,
 539};
 540
 541/**
 542 * struct devlink_health_reporter_ops - Reporter operations
 543 * @name: reporter name
 544 * @recover: callback to recover from reported error
 545 *           if priv_ctx is NULL, run a full recover
 546 * @dump: callback to dump an object
 547 *        if priv_ctx is NULL, run a full dump
 548 * @diagnose: callback to diagnose the current status
 549 */
 550
 551struct devlink_health_reporter_ops {
 552	char *name;
 553	int (*recover)(struct devlink_health_reporter *reporter,
 554		       void *priv_ctx, struct netlink_ext_ack *extack);
 555	int (*dump)(struct devlink_health_reporter *reporter,
 556		    struct devlink_fmsg *fmsg, void *priv_ctx,
 557		    struct netlink_ext_ack *extack);
 558	int (*diagnose)(struct devlink_health_reporter *reporter,
 559			struct devlink_fmsg *fmsg,
 560			struct netlink_ext_ack *extack);
 561};
 562
 563/**
 564 * struct devlink_trap_policer - Immutable packet trap policer attributes.
 565 * @id: Policer identifier.
 566 * @init_rate: Initial rate in packets / sec.
 567 * @init_burst: Initial burst size in packets.
 568 * @max_rate: Maximum rate.
 569 * @min_rate: Minimum rate.
 570 * @max_burst: Maximum burst size.
 571 * @min_burst: Minimum burst size.
 572 *
 573 * Describes immutable attributes of packet trap policers that drivers register
 574 * with devlink.
 575 */
 576struct devlink_trap_policer {
 577	u32 id;
 578	u64 init_rate;
 579	u64 init_burst;
 580	u64 max_rate;
 581	u64 min_rate;
 582	u64 max_burst;
 583	u64 min_burst;
 584};
 585
 586/**
 587 * struct devlink_trap_group - Immutable packet trap group attributes.
 588 * @name: Trap group name.
 589 * @id: Trap group identifier.
 590 * @generic: Whether the trap group is generic or not.
 591 * @init_policer_id: Initial policer identifier.
 592 *
 593 * Describes immutable attributes of packet trap groups that drivers register
 594 * with devlink.
 595 */
 596struct devlink_trap_group {
 597	const char *name;
 598	u16 id;
 599	bool generic;
 600	u32 init_policer_id;
 601};
 602
 603#define DEVLINK_TRAP_METADATA_TYPE_F_IN_PORT	BIT(0)
 604#define DEVLINK_TRAP_METADATA_TYPE_F_FA_COOKIE	BIT(1)
 605
 606/**
 607 * struct devlink_trap - Immutable packet trap attributes.
 608 * @type: Trap type.
 609 * @init_action: Initial trap action.
 610 * @generic: Whether the trap is generic or not.
 611 * @id: Trap identifier.
 612 * @name: Trap name.
 613 * @init_group_id: Initial group identifier.
 614 * @metadata_cap: Metadata types that can be provided by the trap.
 615 *
 616 * Describes immutable attributes of packet traps that drivers register with
 617 * devlink.
 618 */
 619struct devlink_trap {
 620	enum devlink_trap_type type;
 621	enum devlink_trap_action init_action;
 622	bool generic;
 623	u16 id;
 624	const char *name;
 625	u16 init_group_id;
 626	u32 metadata_cap;
 627};
 628
 629/* All traps must be documented in
 630 * Documentation/networking/devlink/devlink-trap.rst
 631 */
 632enum devlink_trap_generic_id {
 633	DEVLINK_TRAP_GENERIC_ID_SMAC_MC,
 634	DEVLINK_TRAP_GENERIC_ID_VLAN_TAG_MISMATCH,
 635	DEVLINK_TRAP_GENERIC_ID_INGRESS_VLAN_FILTER,
 636	DEVLINK_TRAP_GENERIC_ID_INGRESS_STP_FILTER,
 637	DEVLINK_TRAP_GENERIC_ID_EMPTY_TX_LIST,
 638	DEVLINK_TRAP_GENERIC_ID_PORT_LOOPBACK_FILTER,
 639	DEVLINK_TRAP_GENERIC_ID_BLACKHOLE_ROUTE,
 640	DEVLINK_TRAP_GENERIC_ID_TTL_ERROR,
 641	DEVLINK_TRAP_GENERIC_ID_TAIL_DROP,
 642	DEVLINK_TRAP_GENERIC_ID_NON_IP_PACKET,
 643	DEVLINK_TRAP_GENERIC_ID_UC_DIP_MC_DMAC,
 644	DEVLINK_TRAP_GENERIC_ID_DIP_LB,
 645	DEVLINK_TRAP_GENERIC_ID_SIP_MC,
 646	DEVLINK_TRAP_GENERIC_ID_SIP_LB,
 647	DEVLINK_TRAP_GENERIC_ID_CORRUPTED_IP_HDR,
 648	DEVLINK_TRAP_GENERIC_ID_IPV4_SIP_BC,
 649	DEVLINK_TRAP_GENERIC_ID_IPV6_MC_DIP_RESERVED_SCOPE,
 650	DEVLINK_TRAP_GENERIC_ID_IPV6_MC_DIP_INTERFACE_LOCAL_SCOPE,
 651	DEVLINK_TRAP_GENERIC_ID_MTU_ERROR,
 652	DEVLINK_TRAP_GENERIC_ID_UNRESOLVED_NEIGH,
 653	DEVLINK_TRAP_GENERIC_ID_RPF,
 654	DEVLINK_TRAP_GENERIC_ID_REJECT_ROUTE,
 655	DEVLINK_TRAP_GENERIC_ID_IPV4_LPM_UNICAST_MISS,
 656	DEVLINK_TRAP_GENERIC_ID_IPV6_LPM_UNICAST_MISS,
 657	DEVLINK_TRAP_GENERIC_ID_NON_ROUTABLE,
 658	DEVLINK_TRAP_GENERIC_ID_DECAP_ERROR,
 659	DEVLINK_TRAP_GENERIC_ID_OVERLAY_SMAC_MC,
 660	DEVLINK_TRAP_GENERIC_ID_INGRESS_FLOW_ACTION_DROP,
 661	DEVLINK_TRAP_GENERIC_ID_EGRESS_FLOW_ACTION_DROP,
 662	DEVLINK_TRAP_GENERIC_ID_STP,
 663	DEVLINK_TRAP_GENERIC_ID_LACP,
 664	DEVLINK_TRAP_GENERIC_ID_LLDP,
 665	DEVLINK_TRAP_GENERIC_ID_IGMP_QUERY,
 666	DEVLINK_TRAP_GENERIC_ID_IGMP_V1_REPORT,
 667	DEVLINK_TRAP_GENERIC_ID_IGMP_V2_REPORT,
 668	DEVLINK_TRAP_GENERIC_ID_IGMP_V3_REPORT,
 669	DEVLINK_TRAP_GENERIC_ID_IGMP_V2_LEAVE,
 670	DEVLINK_TRAP_GENERIC_ID_MLD_QUERY,
 671	DEVLINK_TRAP_GENERIC_ID_MLD_V1_REPORT,
 672	DEVLINK_TRAP_GENERIC_ID_MLD_V2_REPORT,
 673	DEVLINK_TRAP_GENERIC_ID_MLD_V1_DONE,
 674	DEVLINK_TRAP_GENERIC_ID_IPV4_DHCP,
 675	DEVLINK_TRAP_GENERIC_ID_IPV6_DHCP,
 676	DEVLINK_TRAP_GENERIC_ID_ARP_REQUEST,
 677	DEVLINK_TRAP_GENERIC_ID_ARP_RESPONSE,
 678	DEVLINK_TRAP_GENERIC_ID_ARP_OVERLAY,
 679	DEVLINK_TRAP_GENERIC_ID_IPV6_NEIGH_SOLICIT,
 680	DEVLINK_TRAP_GENERIC_ID_IPV6_NEIGH_ADVERT,
 681	DEVLINK_TRAP_GENERIC_ID_IPV4_BFD,
 682	DEVLINK_TRAP_GENERIC_ID_IPV6_BFD,
 683	DEVLINK_TRAP_GENERIC_ID_IPV4_OSPF,
 684	DEVLINK_TRAP_GENERIC_ID_IPV6_OSPF,
 685	DEVLINK_TRAP_GENERIC_ID_IPV4_BGP,
 686	DEVLINK_TRAP_GENERIC_ID_IPV6_BGP,
 687	DEVLINK_TRAP_GENERIC_ID_IPV4_VRRP,
 688	DEVLINK_TRAP_GENERIC_ID_IPV6_VRRP,
 689	DEVLINK_TRAP_GENERIC_ID_IPV4_PIM,
 690	DEVLINK_TRAP_GENERIC_ID_IPV6_PIM,
 691	DEVLINK_TRAP_GENERIC_ID_UC_LB,
 692	DEVLINK_TRAP_GENERIC_ID_LOCAL_ROUTE,
 693	DEVLINK_TRAP_GENERIC_ID_EXTERNAL_ROUTE,
 694	DEVLINK_TRAP_GENERIC_ID_IPV6_UC_DIP_LINK_LOCAL_SCOPE,
 695	DEVLINK_TRAP_GENERIC_ID_IPV6_DIP_ALL_NODES,
 696	DEVLINK_TRAP_GENERIC_ID_IPV6_DIP_ALL_ROUTERS,
 697	DEVLINK_TRAP_GENERIC_ID_IPV6_ROUTER_SOLICIT,
 698	DEVLINK_TRAP_GENERIC_ID_IPV6_ROUTER_ADVERT,
 699	DEVLINK_TRAP_GENERIC_ID_IPV6_REDIRECT,
 700	DEVLINK_TRAP_GENERIC_ID_IPV4_ROUTER_ALERT,
 701	DEVLINK_TRAP_GENERIC_ID_IPV6_ROUTER_ALERT,
 702	DEVLINK_TRAP_GENERIC_ID_PTP_EVENT,
 703	DEVLINK_TRAP_GENERIC_ID_PTP_GENERAL,
 704	DEVLINK_TRAP_GENERIC_ID_FLOW_ACTION_SAMPLE,
 705	DEVLINK_TRAP_GENERIC_ID_FLOW_ACTION_TRAP,
 706	DEVLINK_TRAP_GENERIC_ID_EARLY_DROP,
 707
 708	/* Add new generic trap IDs above */
 709	__DEVLINK_TRAP_GENERIC_ID_MAX,
 710	DEVLINK_TRAP_GENERIC_ID_MAX = __DEVLINK_TRAP_GENERIC_ID_MAX - 1,
 711};
 712
 713/* All trap groups must be documented in
 714 * Documentation/networking/devlink/devlink-trap.rst
 715 */
 716enum devlink_trap_group_generic_id {
 717	DEVLINK_TRAP_GROUP_GENERIC_ID_L2_DROPS,
 718	DEVLINK_TRAP_GROUP_GENERIC_ID_L3_DROPS,
 719	DEVLINK_TRAP_GROUP_GENERIC_ID_L3_EXCEPTIONS,
 720	DEVLINK_TRAP_GROUP_GENERIC_ID_BUFFER_DROPS,
 721	DEVLINK_TRAP_GROUP_GENERIC_ID_TUNNEL_DROPS,
 722	DEVLINK_TRAP_GROUP_GENERIC_ID_ACL_DROPS,
 723	DEVLINK_TRAP_GROUP_GENERIC_ID_STP,
 724	DEVLINK_TRAP_GROUP_GENERIC_ID_LACP,
 725	DEVLINK_TRAP_GROUP_GENERIC_ID_LLDP,
 726	DEVLINK_TRAP_GROUP_GENERIC_ID_MC_SNOOPING,
 727	DEVLINK_TRAP_GROUP_GENERIC_ID_DHCP,
 728	DEVLINK_TRAP_GROUP_GENERIC_ID_NEIGH_DISCOVERY,
 729	DEVLINK_TRAP_GROUP_GENERIC_ID_BFD,
 730	DEVLINK_TRAP_GROUP_GENERIC_ID_OSPF,
 731	DEVLINK_TRAP_GROUP_GENERIC_ID_BGP,
 732	DEVLINK_TRAP_GROUP_GENERIC_ID_VRRP,
 733	DEVLINK_TRAP_GROUP_GENERIC_ID_PIM,
 734	DEVLINK_TRAP_GROUP_GENERIC_ID_UC_LB,
 735	DEVLINK_TRAP_GROUP_GENERIC_ID_LOCAL_DELIVERY,
 736	DEVLINK_TRAP_GROUP_GENERIC_ID_EXTERNAL_DELIVERY,
 737	DEVLINK_TRAP_GROUP_GENERIC_ID_IPV6,
 738	DEVLINK_TRAP_GROUP_GENERIC_ID_PTP_EVENT,
 739	DEVLINK_TRAP_GROUP_GENERIC_ID_PTP_GENERAL,
 740	DEVLINK_TRAP_GROUP_GENERIC_ID_ACL_SAMPLE,
 741	DEVLINK_TRAP_GROUP_GENERIC_ID_ACL_TRAP,
 742
 743	/* Add new generic trap group IDs above */
 744	__DEVLINK_TRAP_GROUP_GENERIC_ID_MAX,
 745	DEVLINK_TRAP_GROUP_GENERIC_ID_MAX =
 746		__DEVLINK_TRAP_GROUP_GENERIC_ID_MAX - 1,
 747};
 748
 749#define DEVLINK_TRAP_GENERIC_NAME_SMAC_MC \
 750	"source_mac_is_multicast"
 751#define DEVLINK_TRAP_GENERIC_NAME_VLAN_TAG_MISMATCH \
 752	"vlan_tag_mismatch"
 753#define DEVLINK_TRAP_GENERIC_NAME_INGRESS_VLAN_FILTER \
 754	"ingress_vlan_filter"
 755#define DEVLINK_TRAP_GENERIC_NAME_INGRESS_STP_FILTER \
 756	"ingress_spanning_tree_filter"
 757#define DEVLINK_TRAP_GENERIC_NAME_EMPTY_TX_LIST \
 758	"port_list_is_empty"
 759#define DEVLINK_TRAP_GENERIC_NAME_PORT_LOOPBACK_FILTER \
 760	"port_loopback_filter"
 761#define DEVLINK_TRAP_GENERIC_NAME_BLACKHOLE_ROUTE \
 762	"blackhole_route"
 763#define DEVLINK_TRAP_GENERIC_NAME_TTL_ERROR \
 764	"ttl_value_is_too_small"
 765#define DEVLINK_TRAP_GENERIC_NAME_TAIL_DROP \
 766	"tail_drop"
 767#define DEVLINK_TRAP_GENERIC_NAME_NON_IP_PACKET \
 768	"non_ip"
 769#define DEVLINK_TRAP_GENERIC_NAME_UC_DIP_MC_DMAC \
 770	"uc_dip_over_mc_dmac"
 771#define DEVLINK_TRAP_GENERIC_NAME_DIP_LB \
 772	"dip_is_loopback_address"
 773#define DEVLINK_TRAP_GENERIC_NAME_SIP_MC \
 774	"sip_is_mc"
 775#define DEVLINK_TRAP_GENERIC_NAME_SIP_LB \
 776	"sip_is_loopback_address"
 777#define DEVLINK_TRAP_GENERIC_NAME_CORRUPTED_IP_HDR \
 778	"ip_header_corrupted"
 779#define DEVLINK_TRAP_GENERIC_NAME_IPV4_SIP_BC \
 780	"ipv4_sip_is_limited_bc"
 781#define DEVLINK_TRAP_GENERIC_NAME_IPV6_MC_DIP_RESERVED_SCOPE \
 782	"ipv6_mc_dip_reserved_scope"
 783#define DEVLINK_TRAP_GENERIC_NAME_IPV6_MC_DIP_INTERFACE_LOCAL_SCOPE \
 784	"ipv6_mc_dip_interface_local_scope"
 785#define DEVLINK_TRAP_GENERIC_NAME_MTU_ERROR \
 786	"mtu_value_is_too_small"
 787#define DEVLINK_TRAP_GENERIC_NAME_UNRESOLVED_NEIGH \
 788	"unresolved_neigh"
 789#define DEVLINK_TRAP_GENERIC_NAME_RPF \
 790	"mc_reverse_path_forwarding"
 791#define DEVLINK_TRAP_GENERIC_NAME_REJECT_ROUTE \
 792	"reject_route"
 793#define DEVLINK_TRAP_GENERIC_NAME_IPV4_LPM_UNICAST_MISS \
 794	"ipv4_lpm_miss"
 795#define DEVLINK_TRAP_GENERIC_NAME_IPV6_LPM_UNICAST_MISS \
 796	"ipv6_lpm_miss"
 797#define DEVLINK_TRAP_GENERIC_NAME_NON_ROUTABLE \
 798	"non_routable_packet"
 799#define DEVLINK_TRAP_GENERIC_NAME_DECAP_ERROR \
 800	"decap_error"
 801#define DEVLINK_TRAP_GENERIC_NAME_OVERLAY_SMAC_MC \
 802	"overlay_smac_is_mc"
 803#define DEVLINK_TRAP_GENERIC_NAME_INGRESS_FLOW_ACTION_DROP \
 804	"ingress_flow_action_drop"
 805#define DEVLINK_TRAP_GENERIC_NAME_EGRESS_FLOW_ACTION_DROP \
 806	"egress_flow_action_drop"
 807#define DEVLINK_TRAP_GENERIC_NAME_STP \
 808	"stp"
 809#define DEVLINK_TRAP_GENERIC_NAME_LACP \
 810	"lacp"
 811#define DEVLINK_TRAP_GENERIC_NAME_LLDP \
 812	"lldp"
 813#define DEVLINK_TRAP_GENERIC_NAME_IGMP_QUERY \
 814	"igmp_query"
 815#define DEVLINK_TRAP_GENERIC_NAME_IGMP_V1_REPORT \
 816	"igmp_v1_report"
 817#define DEVLINK_TRAP_GENERIC_NAME_IGMP_V2_REPORT \
 818	"igmp_v2_report"
 819#define DEVLINK_TRAP_GENERIC_NAME_IGMP_V3_REPORT \
 820	"igmp_v3_report"
 821#define DEVLINK_TRAP_GENERIC_NAME_IGMP_V2_LEAVE \
 822	"igmp_v2_leave"
 823#define DEVLINK_TRAP_GENERIC_NAME_MLD_QUERY \
 824	"mld_query"
 825#define DEVLINK_TRAP_GENERIC_NAME_MLD_V1_REPORT \
 826	"mld_v1_report"
 827#define DEVLINK_TRAP_GENERIC_NAME_MLD_V2_REPORT \
 828	"mld_v2_report"
 829#define DEVLINK_TRAP_GENERIC_NAME_MLD_V1_DONE \
 830	"mld_v1_done"
 831#define DEVLINK_TRAP_GENERIC_NAME_IPV4_DHCP \
 832	"ipv4_dhcp"
 833#define DEVLINK_TRAP_GENERIC_NAME_IPV6_DHCP \
 834	"ipv6_dhcp"
 835#define DEVLINK_TRAP_GENERIC_NAME_ARP_REQUEST \
 836	"arp_request"
 837#define DEVLINK_TRAP_GENERIC_NAME_ARP_RESPONSE \
 838	"arp_response"
 839#define DEVLINK_TRAP_GENERIC_NAME_ARP_OVERLAY \
 840	"arp_overlay"
 841#define DEVLINK_TRAP_GENERIC_NAME_IPV6_NEIGH_SOLICIT \
 842	"ipv6_neigh_solicit"
 843#define DEVLINK_TRAP_GENERIC_NAME_IPV6_NEIGH_ADVERT \
 844	"ipv6_neigh_advert"
 845#define DEVLINK_TRAP_GENERIC_NAME_IPV4_BFD \
 846	"ipv4_bfd"
 847#define DEVLINK_TRAP_GENERIC_NAME_IPV6_BFD \
 848	"ipv6_bfd"
 849#define DEVLINK_TRAP_GENERIC_NAME_IPV4_OSPF \
 850	"ipv4_ospf"
 851#define DEVLINK_TRAP_GENERIC_NAME_IPV6_OSPF \
 852	"ipv6_ospf"
 853#define DEVLINK_TRAP_GENERIC_NAME_IPV4_BGP \
 854	"ipv4_bgp"
 855#define DEVLINK_TRAP_GENERIC_NAME_IPV6_BGP \
 856	"ipv6_bgp"
 857#define DEVLINK_TRAP_GENERIC_NAME_IPV4_VRRP \
 858	"ipv4_vrrp"
 859#define DEVLINK_TRAP_GENERIC_NAME_IPV6_VRRP \
 860	"ipv6_vrrp"
 861#define DEVLINK_TRAP_GENERIC_NAME_IPV4_PIM \
 862	"ipv4_pim"
 863#define DEVLINK_TRAP_GENERIC_NAME_IPV6_PIM \
 864	"ipv6_pim"
 865#define DEVLINK_TRAP_GENERIC_NAME_UC_LB \
 866	"uc_loopback"
 867#define DEVLINK_TRAP_GENERIC_NAME_LOCAL_ROUTE \
 868	"local_route"
 869#define DEVLINK_TRAP_GENERIC_NAME_EXTERNAL_ROUTE \
 870	"external_route"
 871#define DEVLINK_TRAP_GENERIC_NAME_IPV6_UC_DIP_LINK_LOCAL_SCOPE \
 872	"ipv6_uc_dip_link_local_scope"
 873#define DEVLINK_TRAP_GENERIC_NAME_IPV6_DIP_ALL_NODES \
 874	"ipv6_dip_all_nodes"
 875#define DEVLINK_TRAP_GENERIC_NAME_IPV6_DIP_ALL_ROUTERS \
 876	"ipv6_dip_all_routers"
 877#define DEVLINK_TRAP_GENERIC_NAME_IPV6_ROUTER_SOLICIT \
 878	"ipv6_router_solicit"
 879#define DEVLINK_TRAP_GENERIC_NAME_IPV6_ROUTER_ADVERT \
 880	"ipv6_router_advert"
 881#define DEVLINK_TRAP_GENERIC_NAME_IPV6_REDIRECT \
 882	"ipv6_redirect"
 883#define DEVLINK_TRAP_GENERIC_NAME_IPV4_ROUTER_ALERT \
 884	"ipv4_router_alert"
 885#define DEVLINK_TRAP_GENERIC_NAME_IPV6_ROUTER_ALERT \
 886	"ipv6_router_alert"
 887#define DEVLINK_TRAP_GENERIC_NAME_PTP_EVENT \
 888	"ptp_event"
 889#define DEVLINK_TRAP_GENERIC_NAME_PTP_GENERAL \
 890	"ptp_general"
 891#define DEVLINK_TRAP_GENERIC_NAME_FLOW_ACTION_SAMPLE \
 892	"flow_action_sample"
 893#define DEVLINK_TRAP_GENERIC_NAME_FLOW_ACTION_TRAP \
 894	"flow_action_trap"
 895#define DEVLINK_TRAP_GENERIC_NAME_EARLY_DROP \
 896	"early_drop"
 897
 898#define DEVLINK_TRAP_GROUP_GENERIC_NAME_L2_DROPS \
 899	"l2_drops"
 900#define DEVLINK_TRAP_GROUP_GENERIC_NAME_L3_DROPS \
 901	"l3_drops"
 902#define DEVLINK_TRAP_GROUP_GENERIC_NAME_L3_EXCEPTIONS \
 903	"l3_exceptions"
 904#define DEVLINK_TRAP_GROUP_GENERIC_NAME_BUFFER_DROPS \
 905	"buffer_drops"
 906#define DEVLINK_TRAP_GROUP_GENERIC_NAME_TUNNEL_DROPS \
 907	"tunnel_drops"
 908#define DEVLINK_TRAP_GROUP_GENERIC_NAME_ACL_DROPS \
 909	"acl_drops"
 910#define DEVLINK_TRAP_GROUP_GENERIC_NAME_STP \
 911	"stp"
 912#define DEVLINK_TRAP_GROUP_GENERIC_NAME_LACP \
 913	"lacp"
 914#define DEVLINK_TRAP_GROUP_GENERIC_NAME_LLDP \
 915	"lldp"
 916#define DEVLINK_TRAP_GROUP_GENERIC_NAME_MC_SNOOPING  \
 917	"mc_snooping"
 918#define DEVLINK_TRAP_GROUP_GENERIC_NAME_DHCP \
 919	"dhcp"
 920#define DEVLINK_TRAP_GROUP_GENERIC_NAME_NEIGH_DISCOVERY \
 921	"neigh_discovery"
 922#define DEVLINK_TRAP_GROUP_GENERIC_NAME_BFD \
 923	"bfd"
 924#define DEVLINK_TRAP_GROUP_GENERIC_NAME_OSPF \
 925	"ospf"
 926#define DEVLINK_TRAP_GROUP_GENERIC_NAME_BGP \
 927	"bgp"
 928#define DEVLINK_TRAP_GROUP_GENERIC_NAME_VRRP \
 929	"vrrp"
 930#define DEVLINK_TRAP_GROUP_GENERIC_NAME_PIM \
 931	"pim"
 932#define DEVLINK_TRAP_GROUP_GENERIC_NAME_UC_LB \
 933	"uc_loopback"
 934#define DEVLINK_TRAP_GROUP_GENERIC_NAME_LOCAL_DELIVERY \
 935	"local_delivery"
 936#define DEVLINK_TRAP_GROUP_GENERIC_NAME_EXTERNAL_DELIVERY \
 937	"external_delivery"
 938#define DEVLINK_TRAP_GROUP_GENERIC_NAME_IPV6 \
 939	"ipv6"
 940#define DEVLINK_TRAP_GROUP_GENERIC_NAME_PTP_EVENT \
 941	"ptp_event"
 942#define DEVLINK_TRAP_GROUP_GENERIC_NAME_PTP_GENERAL \
 943	"ptp_general"
 944#define DEVLINK_TRAP_GROUP_GENERIC_NAME_ACL_SAMPLE \
 945	"acl_sample"
 946#define DEVLINK_TRAP_GROUP_GENERIC_NAME_ACL_TRAP \
 947	"acl_trap"
 948
 949#define DEVLINK_TRAP_GENERIC(_type, _init_action, _id, _group_id,	      \
 950			     _metadata_cap)				      \
 951	{								      \
 952		.type = DEVLINK_TRAP_TYPE_##_type,			      \
 953		.init_action = DEVLINK_TRAP_ACTION_##_init_action,	      \
 954		.generic = true,					      \
 955		.id = DEVLINK_TRAP_GENERIC_ID_##_id,			      \
 956		.name = DEVLINK_TRAP_GENERIC_NAME_##_id,		      \
 957		.init_group_id = _group_id,				      \
 958		.metadata_cap = _metadata_cap,				      \
 959	}
 960
 961#define DEVLINK_TRAP_DRIVER(_type, _init_action, _id, _name, _group_id,	      \
 962			    _metadata_cap)				      \
 963	{								      \
 964		.type = DEVLINK_TRAP_TYPE_##_type,			      \
 965		.init_action = DEVLINK_TRAP_ACTION_##_init_action,	      \
 966		.generic = false,					      \
 967		.id = _id,						      \
 968		.name = _name,						      \
 969		.init_group_id = _group_id,				      \
 970		.metadata_cap = _metadata_cap,				      \
 971	}
 972
 973#define DEVLINK_TRAP_GROUP_GENERIC(_id, _policer_id)			      \
 974	{								      \
 975		.name = DEVLINK_TRAP_GROUP_GENERIC_NAME_##_id,		      \
 976		.id = DEVLINK_TRAP_GROUP_GENERIC_ID_##_id,		      \
 977		.generic = true,					      \
 978		.init_policer_id = _policer_id,				      \
 979	}
 980
 981#define DEVLINK_TRAP_POLICER(_id, _rate, _burst, _max_rate, _min_rate,	      \
 982			     _max_burst, _min_burst)			      \
 983	{								      \
 984		.id = _id,						      \
 985		.init_rate = _rate,					      \
 986		.init_burst = _burst,					      \
 987		.max_rate = _max_rate,					      \
 988		.min_rate = _min_rate,					      \
 989		.max_burst = _max_burst,				      \
 990		.min_burst = _min_burst,				      \
 991	}
 992
 993struct devlink_ops {
 994	int (*reload_down)(struct devlink *devlink, bool netns_change,
 995			   struct netlink_ext_ack *extack);
 996	int (*reload_up)(struct devlink *devlink,
 997			 struct netlink_ext_ack *extack);
 998	int (*port_type_set)(struct devlink_port *devlink_port,
 999			     enum devlink_port_type port_type);
1000	int (*port_split)(struct devlink *devlink, unsigned int port_index,
1001			  unsigned int count, struct netlink_ext_ack *extack);
1002	int (*port_unsplit)(struct devlink *devlink, unsigned int port_index,
1003			    struct netlink_ext_ack *extack);
1004	int (*sb_pool_get)(struct devlink *devlink, unsigned int sb_index,
1005			   u16 pool_index,
1006			   struct devlink_sb_pool_info *pool_info);
1007	int (*sb_pool_set)(struct devlink *devlink, unsigned int sb_index,
1008			   u16 pool_index, u32 size,
1009			   enum devlink_sb_threshold_type threshold_type,
1010			   struct netlink_ext_ack *extack);
1011	int (*sb_port_pool_get)(struct devlink_port *devlink_port,
1012				unsigned int sb_index, u16 pool_index,
1013				u32 *p_threshold);
1014	int (*sb_port_pool_set)(struct devlink_port *devlink_port,
1015				unsigned int sb_index, u16 pool_index,
1016				u32 threshold, struct netlink_ext_ack *extack);
1017	int (*sb_tc_pool_bind_get)(struct devlink_port *devlink_port,
1018				   unsigned int sb_index,
1019				   u16 tc_index,
1020				   enum devlink_sb_pool_type pool_type,
1021				   u16 *p_pool_index, u32 *p_threshold);
1022	int (*sb_tc_pool_bind_set)(struct devlink_port *devlink_port,
1023				   unsigned int sb_index,
1024				   u16 tc_index,
1025				   enum devlink_sb_pool_type pool_type,
1026				   u16 pool_index, u32 threshold,
1027				   struct netlink_ext_ack *extack);
1028	int (*sb_occ_snapshot)(struct devlink *devlink,
1029			       unsigned int sb_index);
1030	int (*sb_occ_max_clear)(struct devlink *devlink,
1031				unsigned int sb_index);
1032	int (*sb_occ_port_pool_get)(struct devlink_port *devlink_port,
1033				    unsigned int sb_index, u16 pool_index,
1034				    u32 *p_cur, u32 *p_max);
1035	int (*sb_occ_tc_port_bind_get)(struct devlink_port *devlink_port,
1036				       unsigned int sb_index,
1037				       u16 tc_index,
1038				       enum devlink_sb_pool_type pool_type,
1039				       u32 *p_cur, u32 *p_max);
1040
1041	int (*eswitch_mode_get)(struct devlink *devlink, u16 *p_mode);
1042	int (*eswitch_mode_set)(struct devlink *devlink, u16 mode,
1043				struct netlink_ext_ack *extack);
1044	int (*eswitch_inline_mode_get)(struct devlink *devlink, u8 *p_inline_mode);
1045	int (*eswitch_inline_mode_set)(struct devlink *devlink, u8 inline_mode,
1046				       struct netlink_ext_ack *extack);
1047	int (*eswitch_encap_mode_get)(struct devlink *devlink,
1048				      enum devlink_eswitch_encap_mode *p_encap_mode);
1049	int (*eswitch_encap_mode_set)(struct devlink *devlink,
1050				      enum devlink_eswitch_encap_mode encap_mode,
1051				      struct netlink_ext_ack *extack);
1052	int (*info_get)(struct devlink *devlink, struct devlink_info_req *req,
1053			struct netlink_ext_ack *extack);
1054	int (*flash_update)(struct devlink *devlink, const char *file_name,
1055			    const char *component,
1056			    struct netlink_ext_ack *extack);
1057	/**
1058	 * @trap_init: Trap initialization function.
1059	 *
1060	 * Should be used by device drivers to initialize the trap in the
1061	 * underlying device. Drivers should also store the provided trap
1062	 * context, so that they could efficiently pass it to
1063	 * devlink_trap_report() when the trap is triggered.
1064	 */
1065	int (*trap_init)(struct devlink *devlink,
1066			 const struct devlink_trap *trap, void *trap_ctx);
1067	/**
1068	 * @trap_fini: Trap de-initialization function.
1069	 *
1070	 * Should be used by device drivers to de-initialize the trap in the
1071	 * underlying device.
1072	 */
1073	void (*trap_fini)(struct devlink *devlink,
1074			  const struct devlink_trap *trap, void *trap_ctx);
1075	/**
1076	 * @trap_action_set: Trap action set function.
1077	 */
1078	int (*trap_action_set)(struct devlink *devlink,
1079			       const struct devlink_trap *trap,
1080			       enum devlink_trap_action action,
1081			       struct netlink_ext_ack *extack);
1082	/**
1083	 * @trap_group_init: Trap group initialization function.
1084	 *
1085	 * Should be used by device drivers to initialize the trap group in the
1086	 * underlying device.
1087	 */
1088	int (*trap_group_init)(struct devlink *devlink,
1089			       const struct devlink_trap_group *group);
1090	/**
1091	 * @trap_group_set: Trap group parameters set function.
1092	 *
1093	 * Note: @policer can be NULL when a policer is being unbound from
1094	 * @group.
1095	 */
1096	int (*trap_group_set)(struct devlink *devlink,
1097			      const struct devlink_trap_group *group,
1098			      const struct devlink_trap_policer *policer,
1099			      struct netlink_ext_ack *extack);
1100	/**
1101	 * @trap_policer_init: Trap policer initialization function.
1102	 *
1103	 * Should be used by device drivers to initialize the trap policer in
1104	 * the underlying device.
1105	 */
1106	int (*trap_policer_init)(struct devlink *devlink,
1107				 const struct devlink_trap_policer *policer);
1108	/**
1109	 * @trap_policer_fini: Trap policer de-initialization function.
1110	 *
1111	 * Should be used by device drivers to de-initialize the trap policer
1112	 * in the underlying device.
1113	 */
1114	void (*trap_policer_fini)(struct devlink *devlink,
1115				  const struct devlink_trap_policer *policer);
1116	/**
1117	 * @trap_policer_set: Trap policer parameters set function.
1118	 */
1119	int (*trap_policer_set)(struct devlink *devlink,
1120				const struct devlink_trap_policer *policer,
1121				u64 rate, u64 burst,
1122				struct netlink_ext_ack *extack);
1123	/**
1124	 * @trap_policer_counter_get: Trap policer counter get function.
1125	 *
1126	 * Should be used by device drivers to report number of packets dropped
1127	 * by the policer.
1128	 */
1129	int (*trap_policer_counter_get)(struct devlink *devlink,
1130					const struct devlink_trap_policer *policer,
1131					u64 *p_drops);
1132	/**
1133	 * @port_function_hw_addr_get: Port function's hardware address get function.
1134	 *
1135	 * Should be used by device drivers to report the hardware address of a function managed
1136	 * by the devlink port. Driver should return -EOPNOTSUPP if it doesn't support port
1137	 * function handling for a particular port.
1138	 *
1139	 * Note: @extack can be NULL when port notifier queries the port function.
1140	 */
1141	int (*port_function_hw_addr_get)(struct devlink *devlink, struct devlink_port *port,
1142					 u8 *hw_addr, int *hw_addr_len,
1143					 struct netlink_ext_ack *extack);
1144	/**
1145	 * @port_function_hw_addr_set: Port function's hardware address set function.
1146	 *
1147	 * Should be used by device drivers to set the hardware address of a function managed
1148	 * by the devlink port. Driver should return -EOPNOTSUPP if it doesn't support port
1149	 * function handling for a particular port.
1150	 */
1151	int (*port_function_hw_addr_set)(struct devlink *devlink, struct devlink_port *port,
1152					 const u8 *hw_addr, int hw_addr_len,
1153					 struct netlink_ext_ack *extack);
1154};
1155
1156static inline void *devlink_priv(struct devlink *devlink)
1157{
1158	BUG_ON(!devlink);
1159	return &devlink->priv;
1160}
1161
1162static inline struct devlink *priv_to_devlink(void *priv)
1163{
1164	BUG_ON(!priv);
1165	return container_of(priv, struct devlink, priv);
1166}
1167
1168static inline struct devlink_port *
1169netdev_to_devlink_port(struct net_device *dev)
1170{
1171	if (dev->netdev_ops->ndo_get_devlink_port)
1172		return dev->netdev_ops->ndo_get_devlink_port(dev);
1173	return NULL;
1174}
1175
1176static inline struct devlink *netdev_to_devlink(struct net_device *dev)
1177{
1178	struct devlink_port *devlink_port = netdev_to_devlink_port(dev);
1179
1180	if (devlink_port)
1181		return devlink_port->devlink;
1182	return NULL;
1183}
1184
1185struct ib_device;
1186
1187struct net *devlink_net(const struct devlink *devlink);
1188void devlink_net_set(struct devlink *devlink, struct net *net);
1189struct devlink *devlink_alloc(const struct devlink_ops *ops, size_t priv_size);
1190int devlink_register(struct devlink *devlink, struct device *dev);
1191void devlink_unregister(struct devlink *devlink);
1192void devlink_reload_enable(struct devlink *devlink);
1193void devlink_reload_disable(struct devlink *devlink);
1194void devlink_free(struct devlink *devlink);
1195int devlink_port_register(struct devlink *devlink,
1196			  struct devlink_port *devlink_port,
1197			  unsigned int port_index);
1198void devlink_port_unregister(struct devlink_port *devlink_port);
1199void devlink_port_type_eth_set(struct devlink_port *devlink_port,
1200			       struct net_device *netdev);
1201void devlink_port_type_ib_set(struct devlink_port *devlink_port,
1202			      struct ib_device *ibdev);
1203void devlink_port_type_clear(struct devlink_port *devlink_port);
1204void devlink_port_attrs_set(struct devlink_port *devlink_port,
1205			    struct devlink_port_attrs *devlink_port_attrs);
1206void devlink_port_attrs_pci_pf_set(struct devlink_port *devlink_port, u16 pf);
1207void devlink_port_attrs_pci_vf_set(struct devlink_port *devlink_port,
1208				   u16 pf, u16 vf);
1209int devlink_sb_register(struct devlink *devlink, unsigned int sb_index,
1210			u32 size, u16 ingress_pools_count,
1211			u16 egress_pools_count, u16 ingress_tc_count,
1212			u16 egress_tc_count);
1213void devlink_sb_unregister(struct devlink *devlink, unsigned int sb_index);
1214int devlink_dpipe_table_register(struct devlink *devlink,
1215				 const char *table_name,
1216				 struct devlink_dpipe_table_ops *table_ops,
1217				 void *priv, bool counter_control_extern);
1218void devlink_dpipe_table_unregister(struct devlink *devlink,
1219				    const char *table_name);
1220int devlink_dpipe_headers_register(struct devlink *devlink,
1221				   struct devlink_dpipe_headers *dpipe_headers);
1222void devlink_dpipe_headers_unregister(struct devlink *devlink);
1223bool devlink_dpipe_table_counter_enabled(struct devlink *devlink,
1224					 const char *table_name);
1225int devlink_dpipe_entry_ctx_prepare(struct devlink_dpipe_dump_ctx *dump_ctx);
1226int devlink_dpipe_entry_ctx_append(struct devlink_dpipe_dump_ctx *dump_ctx,
1227				   struct devlink_dpipe_entry *entry);
1228int devlink_dpipe_entry_ctx_close(struct devlink_dpipe_dump_ctx *dump_ctx);
1229void devlink_dpipe_entry_clear(struct devlink_dpipe_entry *entry);
1230int devlink_dpipe_action_put(struct sk_buff *skb,
1231			     struct devlink_dpipe_action *action);
1232int devlink_dpipe_match_put(struct sk_buff *skb,
1233			    struct devlink_dpipe_match *match);
1234extern struct devlink_dpipe_header devlink_dpipe_header_ethernet;
1235extern struct devlink_dpipe_header devlink_dpipe_header_ipv4;
1236extern struct devlink_dpipe_header devlink_dpipe_header_ipv6;
1237
1238int devlink_resource_register(struct devlink *devlink,
1239			      const char *resource_name,
1240			      u64 resource_size,
1241			      u64 resource_id,
1242			      u64 parent_resource_id,
1243			      const struct devlink_resource_size_params *size_params);
1244void devlink_resources_unregister(struct devlink *devlink,
1245				  struct devlink_resource *resource);
1246int devlink_resource_size_get(struct devlink *devlink,
1247			      u64 resource_id,
1248			      u64 *p_resource_size);
1249int devlink_dpipe_table_resource_set(struct devlink *devlink,
1250				     const char *table_name, u64 resource_id,
1251				     u64 resource_units);
1252void devlink_resource_occ_get_register(struct devlink *devlink,
1253				       u64 resource_id,
1254				       devlink_resource_occ_get_t *occ_get,
1255				       void *occ_get_priv);
1256void devlink_resource_occ_get_unregister(struct devlink *devlink,
1257					 u64 resource_id);
1258int devlink_params_register(struct devlink *devlink,
1259			    const struct devlink_param *params,
1260			    size_t params_count);
1261void devlink_params_unregister(struct devlink *devlink,
1262			       const struct devlink_param *params,
1263			       size_t params_count);
1264void devlink_params_publish(struct devlink *devlink);
1265void devlink_params_unpublish(struct devlink *devlink);
1266int devlink_port_params_register(struct devlink_port *devlink_port,
1267				 const struct devlink_param *params,
1268				 size_t params_count);
1269void devlink_port_params_unregister(struct devlink_port *devlink_port,
1270				    const struct devlink_param *params,
1271				    size_t params_count);
1272int devlink_param_driverinit_value_get(struct devlink *devlink, u32 param_id,
1273				       union devlink_param_value *init_val);
1274int devlink_param_driverinit_value_set(struct devlink *devlink, u32 param_id,
1275				       union devlink_param_value init_val);
1276int
1277devlink_port_param_driverinit_value_get(struct devlink_port *devlink_port,
1278					u32 param_id,
1279					union devlink_param_value *init_val);
1280int devlink_port_param_driverinit_value_set(struct devlink_port *devlink_port,
1281					    u32 param_id,
1282					    union devlink_param_value init_val);
1283void devlink_param_value_changed(struct devlink *devlink, u32 param_id);
1284void devlink_port_param_value_changed(struct devlink_port *devlink_port,
1285				      u32 param_id);
1286void devlink_param_value_str_fill(union devlink_param_value *dst_val,
1287				  const char *src);
1288struct devlink_region *
1289devlink_region_create(struct devlink *devlink,
1290		      const struct devlink_region_ops *ops,
1291		      u32 region_max_snapshots, u64 region_size);
1292void devlink_region_destroy(struct devlink_region *region);
1293int devlink_region_snapshot_id_get(struct devlink *devlink, u32 *id);
1294void devlink_region_snapshot_id_put(struct devlink *devlink, u32 id);
1295int devlink_region_snapshot_create(struct devlink_region *region,
1296				   u8 *data, u32 snapshot_id);
1297int devlink_info_serial_number_put(struct devlink_info_req *req,
1298				   const char *sn);
1299int devlink_info_driver_name_put(struct devlink_info_req *req,
1300				 const char *name);
1301int devlink_info_board_serial_number_put(struct devlink_info_req *req,
1302					 const char *bsn);
1303int devlink_info_version_fixed_put(struct devlink_info_req *req,
1304				   const char *version_name,
1305				   const char *version_value);
1306int devlink_info_version_stored_put(struct devlink_info_req *req,
1307				    const char *version_name,
1308				    const char *version_value);
1309int devlink_info_version_running_put(struct devlink_info_req *req,
1310				     const char *version_name,
1311				     const char *version_value);
1312
1313int devlink_fmsg_obj_nest_start(struct devlink_fmsg *fmsg);
1314int devlink_fmsg_obj_nest_end(struct devlink_fmsg *fmsg);
1315
1316int devlink_fmsg_pair_nest_start(struct devlink_fmsg *fmsg, const char *name);
1317int devlink_fmsg_pair_nest_end(struct devlink_fmsg *fmsg);
1318
1319int devlink_fmsg_arr_pair_nest_start(struct devlink_fmsg *fmsg,
1320				     const char *name);
1321int devlink_fmsg_arr_pair_nest_end(struct devlink_fmsg *fmsg);
1322int devlink_fmsg_binary_pair_nest_start(struct devlink_fmsg *fmsg,
1323					const char *name);
1324int devlink_fmsg_binary_pair_nest_end(struct devlink_fmsg *fmsg);
1325
1326int devlink_fmsg_bool_put(struct devlink_fmsg *fmsg, bool value);
1327int devlink_fmsg_u8_put(struct devlink_fmsg *fmsg, u8 value);
1328int devlink_fmsg_u32_put(struct devlink_fmsg *fmsg, u32 value);
1329int devlink_fmsg_u64_put(struct devlink_fmsg *fmsg, u64 value);
1330int devlink_fmsg_string_put(struct devlink_fmsg *fmsg, const char *value);
1331int devlink_fmsg_binary_put(struct devlink_fmsg *fmsg, const void *value,
1332			    u16 value_len);
1333
1334int devlink_fmsg_bool_pair_put(struct devlink_fmsg *fmsg, const char *name,
1335			       bool value);
1336int devlink_fmsg_u8_pair_put(struct devlink_fmsg *fmsg, const char *name,
1337			     u8 value);
1338int devlink_fmsg_u32_pair_put(struct devlink_fmsg *fmsg, const char *name,
1339			      u32 value);
1340int devlink_fmsg_u64_pair_put(struct devlink_fmsg *fmsg, const char *name,
1341			      u64 value);
1342int devlink_fmsg_string_pair_put(struct devlink_fmsg *fmsg, const char *name,
1343				 const char *value);
1344int devlink_fmsg_binary_pair_put(struct devlink_fmsg *fmsg, const char *name,
1345				 const void *value, u32 value_len);
1346
1347struct devlink_health_reporter *
1348devlink_health_reporter_create(struct devlink *devlink,
1349			       const struct devlink_health_reporter_ops *ops,
1350			       u64 graceful_period, void *priv);
1351
1352struct devlink_health_reporter *
1353devlink_port_health_reporter_create(struct devlink_port *port,
1354				    const struct devlink_health_reporter_ops *ops,
1355				    u64 graceful_period, void *priv);
1356
1357void
1358devlink_health_reporter_destroy(struct devlink_health_reporter *reporter);
1359
1360void
1361devlink_port_health_reporter_destroy(struct devlink_health_reporter *reporter);
1362
1363void *
1364devlink_health_reporter_priv(struct devlink_health_reporter *reporter);
1365int devlink_health_report(struct devlink_health_reporter *reporter,
1366			  const char *msg, void *priv_ctx);
1367void
1368devlink_health_reporter_state_update(struct devlink_health_reporter *reporter,
1369				     enum devlink_health_reporter_state state);
1370void
1371devlink_health_reporter_recovery_done(struct devlink_health_reporter *reporter);
1372
1373bool devlink_is_reload_failed(const struct devlink *devlink);
1374
1375void devlink_flash_update_begin_notify(struct devlink *devlink);
1376void devlink_flash_update_end_notify(struct devlink *devlink);
1377void devlink_flash_update_status_notify(struct devlink *devlink,
1378					const char *status_msg,
1379					const char *component,
1380					unsigned long done,
1381					unsigned long total);
1382
1383int devlink_traps_register(struct devlink *devlink,
1384			   const struct devlink_trap *traps,
1385			   size_t traps_count, void *priv);
1386void devlink_traps_unregister(struct devlink *devlink,
1387			      const struct devlink_trap *traps,
1388			      size_t traps_count);
1389void devlink_trap_report(struct devlink *devlink, struct sk_buff *skb,
1390			 void *trap_ctx, struct devlink_port *in_devlink_port,
1391			 const struct flow_action_cookie *fa_cookie);
1392void *devlink_trap_ctx_priv(void *trap_ctx);
1393int devlink_trap_groups_register(struct devlink *devlink,
1394				 const struct devlink_trap_group *groups,
1395				 size_t groups_count);
1396void devlink_trap_groups_unregister(struct devlink *devlink,
1397				    const struct devlink_trap_group *groups,
1398				    size_t groups_count);
1399int
1400devlink_trap_policers_register(struct devlink *devlink,
1401			       const struct devlink_trap_policer *policers,
1402			       size_t policers_count);
1403void
1404devlink_trap_policers_unregister(struct devlink *devlink,
1405				 const struct devlink_trap_policer *policers,
1406				 size_t policers_count);
1407
1408#if IS_ENABLED(CONFIG_NET_DEVLINK)
1409
1410void devlink_compat_running_version(struct net_device *dev,
1411				    char *buf, size_t len);
1412int devlink_compat_flash_update(struct net_device *dev, const char *file_name);
1413int devlink_compat_phys_port_name_get(struct net_device *dev,
1414				      char *name, size_t len);
1415int devlink_compat_switch_id_get(struct net_device *dev,
1416				 struct netdev_phys_item_id *ppid);
1417
1418#else
1419
1420static inline void
1421devlink_compat_running_version(struct net_device *dev, char *buf, size_t len)
1422{
1423}
1424
1425static inline int
1426devlink_compat_flash_update(struct net_device *dev, const char *file_name)
1427{
1428	return -EOPNOTSUPP;
1429}
1430
1431static inline int
1432devlink_compat_phys_port_name_get(struct net_device *dev,
1433				  char *name, size_t len)
1434{
1435	return -EOPNOTSUPP;
1436}
1437
1438static inline int
1439devlink_compat_switch_id_get(struct net_device *dev,
1440			     struct netdev_phys_item_id *ppid)
1441{
1442	return -EOPNOTSUPP;
1443}
1444
1445#endif
1446
1447#endif /* _NET_DEVLINK_H_ */