include/net/devlink.h

   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 <uapi/linux/devlink.h>
  20
  21 struct devlink_ops;
  22
  23 struct devlink {
  24         struct list_head list;
  25         struct list_head port_list;
  26         struct list_head sb_list;
  27         struct list_head dpipe_table_list;
  28         struct list_head resource_list;
  29         struct list_head param_list;
  30         struct list_head region_list;
  31         u32 snapshot_id;
  32         struct list_head reporter_list;
  33         struct mutex reporters_lock; /* protects reporter_list */
  34         struct devlink_dpipe_headers *dpipe_headers;
  35         struct list_head trap_list;
  36         struct list_head trap_group_list;
  37         const struct devlink_ops *ops;
  38         struct device *dev;
  39         possible_net_t _net;
  40         struct mutex lock;
  41         u8 reload_failed:1,
  42            reload_enabled:1,
  43            registered:1;
  44         char priv[0] __aligned(NETDEV_ALIGN);
  45 };
  46
  47 struct devlink_port_phys_attrs {
  48         u32 port_number; /* Same value as "split group".
  49                           * A physical port which is visible to the user
  50                           * for a given port flavour.
  51                           */
  52         u32 split_subport_number;
  53 };
  54
  55 struct devlink_port_pci_pf_attrs {
  56         u16 pf; /* Associated PCI PF for this port. */
  57 };
  58
  59 struct devlink_port_pci_vf_attrs {
  60         u16 pf; /* Associated PCI PF for this port. */
  61         u16 vf; /* Associated PCI VF for of the PCI PF for this port. */
  62 };
  63
  64 struct devlink_port_attrs {
  65         u8 set:1,
  66            split:1,
  67            switch_port:1;
  68         enum devlink_port_flavour flavour;
  69         struct netdev_phys_item_id switch_id;
  70         union {
  71                 struct devlink_port_phys_attrs phys;
  72                 struct devlink_port_pci_pf_attrs pci_pf;
  73                 struct devlink_port_pci_vf_attrs pci_vf;
  74         };
  75 };
  76
  77 struct devlink_port {
  78         struct list_head list;
  79         struct list_head param_list;
  80         struct devlink *devlink;
  81         unsigned int index;
  82         bool registered;
  83         spinlock_t type_lock; /* Protects type and type_dev
  84                                * pointer consistency.
  85                                */
  86         enum devlink_port_type type;
  87         enum devlink_port_type desired_type;
  88         void *type_dev;
  89         struct devlink_port_attrs attrs;
  90         struct delayed_work type_warn_dw;
  91 };
  92
  93 struct devlink_sb_pool_info {
  94         enum devlink_sb_pool_type pool_type;
  95         u32 size;
  96         enum devlink_sb_threshold_type threshold_type;
  97         u32 cell_size;
  98 };
  99
 100 /**
 101  * struct devlink_dpipe_field - dpipe field object
 102  * @name: field name
 103  * @id: index inside the headers field array
 104  * @bitwidth: bitwidth
 105  * @mapping_type: mapping type
 106  */
 107 struct devlink_dpipe_field {
 108         const char *name;
 109         unsigned int id;
 110         unsigned int bitwidth;
 111         enum devlink_dpipe_field_mapping_type mapping_type;
 112 };
 113
 114 /**
 115  * struct devlink_dpipe_header - dpipe header object
 116  * @name: header name
 117  * @id: index, global/local detrmined by global bit
 118  * @fields: fields
 119  * @fields_count: number of fields
 120  * @global: indicates if header is shared like most protocol header
 121  *          or driver specific
 122  */
 123 struct devlink_dpipe_header {
 124         const char *name;
 125         unsigned int id;
 126         struct devlink_dpipe_field *fields;
 127         unsigned int fields_count;
 128         bool global;
 129 };
 130
 131 /**
 132  * struct devlink_dpipe_match - represents match operation
 133  * @type: type of match
 134  * @header_index: header index (packets can have several headers of same
 135  *                type like in case of tunnels)
 136  * @header: header
 137  * @fieled_id: field index
 138  */
 139 struct devlink_dpipe_match {
 140         enum devlink_dpipe_match_type type;
 141         unsigned int header_index;
 142         struct devlink_dpipe_header *header;
 143         unsigned int field_id;
 144 };
 145
 146 /**
 147  * struct devlink_dpipe_action - represents action operation
 148  * @type: type of action
 149  * @header_index: header index (packets can have several headers of same
 150  *                type like in case of tunnels)
 151  * @header: header
 152  * @fieled_id: field index
 153  */
 154 struct devlink_dpipe_action {
 155         enum devlink_dpipe_action_type type;
 156         unsigned int header_index;
 157         struct devlink_dpipe_header *header;
 158         unsigned int field_id;
 159 };
 160
 161 /**
 162  * struct devlink_dpipe_value - represents value of match/action
 163  * @action: action
 164  * @match: match
 165  * @mapping_value: in case the field has some mapping this value
 166  *                 specified the mapping value
 167  * @mapping_valid: specify if mapping value is valid
 168  * @value_size: value size
 169  * @value: value
 170  * @mask: bit mask
 171  */
 172 struct devlink_dpipe_value {
 173         union {
 174                 struct devlink_dpipe_action *action;
 175                 struct devlink_dpipe_match *match;
 176         };
 177         unsigned int mapping_value;
 178         bool mapping_valid;
 179         unsigned int value_size;
 180         void *value;
 181         void *mask;
 182 };
 183
 184 /**
 185  * struct devlink_dpipe_entry - table entry object
 186  * @index: index of the entry in the table
 187  * @match_values: match values
 188  * @matche_values_count: count of matches tuples
 189  * @action_values: actions values
 190  * @action_values_count: count of actions values
 191  * @counter: value of counter
 192  * @counter_valid: Specify if value is valid from hardware
 193  */
 194 struct devlink_dpipe_entry {
 195         u64 index;
 196         struct devlink_dpipe_value *match_values;
 197         unsigned int match_values_count;
 198         struct devlink_dpipe_value *action_values;
 199         unsigned int action_values_count;
 200         u64 counter;
 201         bool counter_valid;
 202 };
 203
 204 /**
 205  * struct devlink_dpipe_dump_ctx - context provided to driver in order
 206  *                                 to dump
 207  * @info: info
 208  * @cmd: devlink command
 209  * @skb: skb
 210  * @nest: top attribute
 211  * @hdr: hdr
 212  */
 213 struct devlink_dpipe_dump_ctx {
 214         struct genl_info *info;
 215         enum devlink_command cmd;
 216         struct sk_buff *skb;
 217         struct nlattr *nest;
 218         void *hdr;
 219 };
 220
 221 struct devlink_dpipe_table_ops;
 222
 223 /**
 224  * struct devlink_dpipe_table - table object
 225  * @priv: private
 226  * @name: table name
 227  * @counters_enabled: indicates if counters are active
 228  * @counter_control_extern: indicates if counter control is in dpipe or
 229  *                          external tool
 230  * @resource_valid: Indicate that the resource id is valid
 231  * @resource_id: relative resource this table is related to
 232  * @resource_units: number of resource's unit consumed per table's entry
 233  * @table_ops: table operations
 234  * @rcu: rcu
 235  */
 236 struct devlink_dpipe_table {
 237         void *priv;
 238         struct list_head list;
 239         const char *name;
 240         bool counters_enabled;
 241         bool counter_control_extern;
 242         bool resource_valid;
 243         u64 resource_id;
 244         u64 resource_units;
 245         struct devlink_dpipe_table_ops *table_ops;
 246         struct rcu_head rcu;
 247 };
 248
 249 /**
 250  * struct devlink_dpipe_table_ops - dpipe_table ops
 251  * @actions_dump - dumps all tables actions
 252  * @matches_dump - dumps all tables matches
 253  * @entries_dump - dumps all active entries in the table
 254  * @counters_set_update - when changing the counter status hardware sync
 255  *                        maybe needed to allocate/free counter related
 256  *                        resources
 257  * @size_get - get size
 258  */
 259 struct devlink_dpipe_table_ops {
 260         int (*actions_dump)(void *priv, struct sk_buff *skb);
 261         int (*matches_dump)(void *priv, struct sk_buff *skb);
 262         int (*entries_dump)(void *priv, bool counters_enabled,
 263                             struct devlink_dpipe_dump_ctx *dump_ctx);
 264         int (*counters_set_update)(void *priv, bool enable);
 265         u64 (*size_get)(void *priv);
 266 };
 267
 268 /**
 269  * struct devlink_dpipe_headers - dpipe headers
 270  * @headers - header array can be shared (global bit) or driver specific
 271  * @headers_count - count of headers
 272  */
 273 struct devlink_dpipe_headers {
 274         struct devlink_dpipe_header **headers;
 275         unsigned int headers_count;
 276 };
 277
 278 /**
 279  * struct devlink_resource_size_params - resource's size parameters
 280  * @size_min: minimum size which can be set
 281  * @size_max: maximum size which can be set
 282  * @size_granularity: size granularity
 283  * @size_unit: resource's basic unit
 284  */
 285 struct devlink_resource_size_params {
 286         u64 size_min;
 287         u64 size_max;
 288         u64 size_granularity;
 289         enum devlink_resource_unit unit;
 290 };
 291
 292 static inline void
 293 devlink_resource_size_params_init(struct devlink_resource_size_params *size_params,
 294                                   u64 size_min, u64 size_max,
 295                                   u64 size_granularity,
 296                                   enum devlink_resource_unit unit)
 297 {
 298         size_params->size_min = size_min;
 299         size_params->size_max = size_max;
 300         size_params->size_granularity = size_granularity;
 301         size_params->unit = unit;
 302 }
 303
 304 typedef u64 devlink_resource_occ_get_t(void *priv);
 305
 306 /**
 307  * struct devlink_resource - devlink resource
 308  * @name: name of the resource
 309  * @id: id, per devlink instance
 310  * @size: size of the resource
 311  * @size_new: updated size of the resource, reload is needed
 312  * @size_valid: valid in case the total size of the resource is valid
 313  *              including its children
 314  * @parent: parent resource
 315  * @size_params: size parameters
 316  * @list: parent list
 317  * @resource_list: list of child resources
 318  */
 319 struct devlink_resource {
 320         const char *name;
 321         u64 id;
 322         u64 size;
 323         u64 size_new;
 324         bool size_valid;
 325         struct devlink_resource *parent;
 326         struct devlink_resource_size_params size_params;
 327         struct list_head list;
 328         struct list_head resource_list;
 329         devlink_resource_occ_get_t *occ_get;
 330         void *occ_get_priv;
 331 };
 332
 333 #define DEVLINK_RESOURCE_ID_PARENT_TOP 0
 334
 335 #define __DEVLINK_PARAM_MAX_STRING_VALUE 32
 336 enum devlink_param_type {
 337         DEVLINK_PARAM_TYPE_U8,
 338         DEVLINK_PARAM_TYPE_U16,
 339         DEVLINK_PARAM_TYPE_U32,
 340         DEVLINK_PARAM_TYPE_STRING,
 341         DEVLINK_PARAM_TYPE_BOOL,
 342 };
 343
 344 union devlink_param_value {
 345         u8 vu8;
 346         u16 vu16;
 347         u32 vu32;
 348         char vstr[__DEVLINK_PARAM_MAX_STRING_VALUE];
 349         bool vbool;
 350 };
 351
 352 struct devlink_param_gset_ctx {
 353         union devlink_param_value val;
 354         enum devlink_param_cmode cmode;
 355 };
 356
 357 /**
 358  * struct devlink_param - devlink configuration parameter data
 359  * @name: name of the parameter
 360  * @generic: indicates if the parameter is generic or driver specific
 361  * @type: parameter type
 362  * @supported_cmodes: bitmap of supported configuration modes
 363  * @get: get parameter value, used for runtime and permanent
 364  *       configuration modes
 365  * @set: set parameter value, used for runtime and permanent
 366  *       configuration modes
 367  * @validate: validate input value is applicable (within value range, etc.)
 368  *
 369  * This struct should be used by the driver to fill the data for
 370  * a parameter it registers.
 371  */
 372 struct devlink_param {
 373         u32 id;
 374         const char *name;
 375         bool generic;
 376         enum devlink_param_type type;
 377         unsigned long supported_cmodes;
 378         int (*get)(struct devlink *devlink, u32 id,
 379                    struct devlink_param_gset_ctx *ctx);
 380         int (*set)(struct devlink *devlink, u32 id,
 381                    struct devlink_param_gset_ctx *ctx);
 382         int (*validate)(struct devlink *devlink, u32 id,
 383                         union devlink_param_value val,
 384                         struct netlink_ext_ack *extack);
 385 };
 386
 387 struct devlink_param_item {
 388         struct list_head list;
 389         const struct devlink_param *param;
 390         union devlink_param_value driverinit_value;
 391         bool driverinit_value_valid;
 392         bool published;
 393 };
 394
 395 enum devlink_param_generic_id {
 396         DEVLINK_PARAM_GENERIC_ID_INT_ERR_RESET,
 397         DEVLINK_PARAM_GENERIC_ID_MAX_MACS,
 398         DEVLINK_PARAM_GENERIC_ID_ENABLE_SRIOV,
 399         DEVLINK_PARAM_GENERIC_ID_REGION_SNAPSHOT,
 400         DEVLINK_PARAM_GENERIC_ID_IGNORE_ARI,
 401         DEVLINK_PARAM_GENERIC_ID_MSIX_VEC_PER_PF_MAX,
 402         DEVLINK_PARAM_GENERIC_ID_MSIX_VEC_PER_PF_MIN,
 403         DEVLINK_PARAM_GENERIC_ID_FW_LOAD_POLICY,
 404         DEVLINK_PARAM_GENERIC_ID_RESET_DEV_ON_DRV_PROBE,
 405
 406         /* add new param generic ids above here*/
 407         __DEVLINK_PARAM_GENERIC_ID_MAX,
 408         DEVLINK_PARAM_GENERIC_ID_MAX = __DEVLINK_PARAM_GENERIC_ID_MAX - 1,
 409 };
 410
 411 #define DEVLINK_PARAM_GENERIC_INT_ERR_RESET_NAME "internal_error_reset"
 412 #define DEVLINK_PARAM_GENERIC_INT_ERR_RESET_TYPE DEVLINK_PARAM_TYPE_BOOL
 413
 414 #define DEVLINK_PARAM_GENERIC_MAX_MACS_NAME "max_macs"
 415 #define DEVLINK_PARAM_GENERIC_MAX_MACS_TYPE DEVLINK_PARAM_TYPE_U32
 416
 417 #define DEVLINK_PARAM_GENERIC_ENABLE_SRIOV_NAME "enable_sriov"
 418 #define DEVLINK_PARAM_GENERIC_ENABLE_SRIOV_TYPE DEVLINK_PARAM_TYPE_BOOL
 419
 420 #define DEVLINK_PARAM_GENERIC_REGION_SNAPSHOT_NAME "region_snapshot_enable"
 421 #define DEVLINK_PARAM_GENERIC_REGION_SNAPSHOT_TYPE DEVLINK_PARAM_TYPE_BOOL
 422
 423 #define DEVLINK_PARAM_GENERIC_IGNORE_ARI_NAME "ignore_ari"
 424 #define DEVLINK_PARAM_GENERIC_IGNORE_ARI_TYPE DEVLINK_PARAM_TYPE_BOOL
 425
 426 #define DEVLINK_PARAM_GENERIC_MSIX_VEC_PER_PF_MAX_NAME "msix_vec_per_pf_max"
 427 #define DEVLINK_PARAM_GENERIC_MSIX_VEC_PER_PF_MAX_TYPE DEVLINK_PARAM_TYPE_U32
 428
 429 #define DEVLINK_PARAM_GENERIC_MSIX_VEC_PER_PF_MIN_NAME "msix_vec_per_pf_min"
 430 #define DEVLINK_PARAM_GENERIC_MSIX_VEC_PER_PF_MIN_TYPE DEVLINK_PARAM_TYPE_U32
 431
 432 #define DEVLINK_PARAM_GENERIC_FW_LOAD_POLICY_NAME "fw_load_policy"
 433 #define DEVLINK_PARAM_GENERIC_FW_LOAD_POLICY_TYPE DEVLINK_PARAM_TYPE_U8
 434
 435 #define DEVLINK_PARAM_GENERIC_RESET_DEV_ON_DRV_PROBE_NAME \
 436         "reset_dev_on_drv_probe"
 437 #define DEVLINK_PARAM_GENERIC_RESET_DEV_ON_DRV_PROBE_TYPE DEVLINK_PARAM_TYPE_U8
 438
 439 #define DEVLINK_PARAM_GENERIC(_id, _cmodes, _get, _set, _validate)      \
 440 {                                                                       \
 441         .id = DEVLINK_PARAM_GENERIC_ID_##_id,                           \
 442         .name = DEVLINK_PARAM_GENERIC_##_id##_NAME,                     \
 443         .type = DEVLINK_PARAM_GENERIC_##_id##_TYPE,                     \
 444         .generic = true,                                                \
 445         .supported_cmodes = _cmodes,                                    \
 446         .get = _get,                                                    \
 447         .set = _set,                                                    \
 448         .validate = _validate,                                          \
 449 }
 450
 451 #define DEVLINK_PARAM_DRIVER(_id, _name, _type, _cmodes, _get, _set, _validate) \
 452 {                                                                       \
 453         .id = _id,                                                      \
 454         .name = _name,                                                  \
 455         .type = _type,                                                  \
 456         .supported_cmodes = _cmodes,                                    \
 457         .get = _get,                                                    \
 458         .set = _set,                                                    \
 459         .validate = _validate,                                          \
 460 }
 461
 462 /* Part number, identifier of board design */
 463 #define DEVLINK_INFO_VERSION_GENERIC_BOARD_ID   "board.id"
 464 /* Revision of board design */
 465 #define DEVLINK_INFO_VERSION_GENERIC_BOARD_REV  "board.rev"
 466 /* Maker of the board */
 467 #define DEVLINK_INFO_VERSION_GENERIC_BOARD_MANUFACTURE  "board.manufacture"
 468
 469 /* Part number, identifier of asic design */
 470 #define DEVLINK_INFO_VERSION_GENERIC_ASIC_ID    "asic.id"
 471 /* Revision of asic design */
 472 #define DEVLINK_INFO_VERSION_GENERIC_ASIC_REV   "asic.rev"
 473
 474 /* Overall FW version */
 475 #define DEVLINK_INFO_VERSION_GENERIC_FW         "fw"
 476 /* Control processor FW version */
 477 #define DEVLINK_INFO_VERSION_GENERIC_FW_MGMT    "fw.mgmt"
 478 /* Data path microcode controlling high-speed packet processing */
 479 #define DEVLINK_INFO_VERSION_GENERIC_FW_APP     "fw.app"
 480 /* UNDI software version */
 481 #define DEVLINK_INFO_VERSION_GENERIC_FW_UNDI    "fw.undi"
 482 /* NCSI support/handler version */
 483 #define DEVLINK_INFO_VERSION_GENERIC_FW_NCSI    "fw.ncsi"
 484
 485 struct devlink_region;
 486 struct devlink_info_req;
 487
 488 typedef void devlink_snapshot_data_dest_t(const void *data);
 489
 490 struct devlink_fmsg;
 491 struct devlink_health_reporter;
 492
 493 enum devlink_health_reporter_state {
 494         DEVLINK_HEALTH_REPORTER_STATE_HEALTHY,
 495         DEVLINK_HEALTH_REPORTER_STATE_ERROR,
 496 };
 497
 498 /**
 499  * struct devlink_health_reporter_ops - Reporter operations
 500  * @name: reporter name
 501  * @recover: callback to recover from reported error
 502  *           if priv_ctx is NULL, run a full recover
 503  * @dump: callback to dump an object
 504  *        if priv_ctx is NULL, run a full dump
 505  * @diagnose: callback to diagnose the current status
 506  */
 507
 508 struct devlink_health_reporter_ops {
 509         char *name;
 510         int (*recover)(struct devlink_health_reporter *reporter,
 511                        void *priv_ctx, struct netlink_ext_ack *extack);
 512         int (*dump)(struct devlink_health_reporter *reporter,
 513                     struct devlink_fmsg *fmsg, void *priv_ctx,
 514                     struct netlink_ext_ack *extack);
 515         int (*diagnose)(struct devlink_health_reporter *reporter,
 516                         struct devlink_fmsg *fmsg,
 517                         struct netlink_ext_ack *extack);
 518 };
 519
 520 /**
 521  * struct devlink_trap_group - Immutable packet trap group attributes.
 522  * @name: Trap group name.
 523  * @id: Trap group identifier.
 524  * @generic: Whether the trap group is generic or not.
 525  *
 526  * Describes immutable attributes of packet trap groups that drivers register
 527  * with devlink.
 528  */
 529 struct devlink_trap_group {
 530         const char *name;
 531         u16 id;
 532         bool generic;
 533 };
 534
 535 #define DEVLINK_TRAP_METADATA_TYPE_F_IN_PORT    BIT(0)
 536
 537 /**
 538  * struct devlink_trap - Immutable packet trap attributes.
 539  * @type: Trap type.
 540  * @init_action: Initial trap action.
 541  * @generic: Whether the trap is generic or not.
 542  * @id: Trap identifier.
 543  * @name: Trap name.
 544  * @group: Immutable packet trap group attributes.
 545  * @metadata_cap: Metadata types that can be provided by the trap.
 546  *
 547  * Describes immutable attributes of packet traps that drivers register with
 548  * devlink.
 549  */
 550 struct devlink_trap {
 551         enum devlink_trap_type type;
 552         enum devlink_trap_action init_action;
 553         bool generic;
 554         u16 id;
 555         const char *name;
 556         struct devlink_trap_group group;
 557         u32 metadata_cap;
 558 };
 559
 560 /* All traps must be documented in
 561  * Documentation/networking/devlink-trap.rst
 562  */
 563 enum devlink_trap_generic_id {
 564         DEVLINK_TRAP_GENERIC_ID_SMAC_MC,
 565         DEVLINK_TRAP_GENERIC_ID_VLAN_TAG_MISMATCH,
 566         DEVLINK_TRAP_GENERIC_ID_INGRESS_VLAN_FILTER,
 567         DEVLINK_TRAP_GENERIC_ID_INGRESS_STP_FILTER,
 568         DEVLINK_TRAP_GENERIC_ID_EMPTY_TX_LIST,
 569         DEVLINK_TRAP_GENERIC_ID_PORT_LOOPBACK_FILTER,
 570         DEVLINK_TRAP_GENERIC_ID_BLACKHOLE_ROUTE,
 571         DEVLINK_TRAP_GENERIC_ID_TTL_ERROR,
 572         DEVLINK_TRAP_GENERIC_ID_TAIL_DROP,
 573         DEVLINK_TRAP_GENERIC_ID_NON_IP_PACKET,
 574         DEVLINK_TRAP_GENERIC_ID_UC_DIP_MC_DMAC,
 575         DEVLINK_TRAP_GENERIC_ID_DIP_LB,
 576         DEVLINK_TRAP_GENERIC_ID_SIP_MC,
 577         DEVLINK_TRAP_GENERIC_ID_SIP_LB,
 578         DEVLINK_TRAP_GENERIC_ID_CORRUPTED_IP_HDR,
 579         DEVLINK_TRAP_GENERIC_ID_IPV4_SIP_BC,
 580         DEVLINK_TRAP_GENERIC_ID_IPV6_MC_DIP_RESERVED_SCOPE,
 581         DEVLINK_TRAP_GENERIC_ID_IPV6_MC_DIP_INTERFACE_LOCAL_SCOPE,
 582         DEVLINK_TRAP_GENERIC_ID_MTU_ERROR,
 583         DEVLINK_TRAP_GENERIC_ID_UNRESOLVED_NEIGH,
 584         DEVLINK_TRAP_GENERIC_ID_RPF,
 585         DEVLINK_TRAP_GENERIC_ID_REJECT_ROUTE,
 586         DEVLINK_TRAP_GENERIC_ID_IPV4_LPM_UNICAST_MISS,
 587         DEVLINK_TRAP_GENERIC_ID_IPV6_LPM_UNICAST_MISS,
 588
 589         /* Add new generic trap IDs above */
 590         __DEVLINK_TRAP_GENERIC_ID_MAX,
 591         DEVLINK_TRAP_GENERIC_ID_MAX = __DEVLINK_TRAP_GENERIC_ID_MAX - 1,
 592 };
 593
 594 /* All trap groups must be documented in
 595  * Documentation/networking/devlink-trap.rst
 596  */
 597 enum devlink_trap_group_generic_id {
 598         DEVLINK_TRAP_GROUP_GENERIC_ID_L2_DROPS,
 599         DEVLINK_TRAP_GROUP_GENERIC_ID_L3_DROPS,
 600         DEVLINK_TRAP_GROUP_GENERIC_ID_BUFFER_DROPS,
 601
 602         /* Add new generic trap group IDs above */
 603         __DEVLINK_TRAP_GROUP_GENERIC_ID_MAX,
 604         DEVLINK_TRAP_GROUP_GENERIC_ID_MAX =
 605                 __DEVLINK_TRAP_GROUP_GENERIC_ID_MAX - 1,
 606 };
 607
 608 #define DEVLINK_TRAP_GENERIC_NAME_SMAC_MC \
 609         "source_mac_is_multicast"
 610 #define DEVLINK_TRAP_GENERIC_NAME_VLAN_TAG_MISMATCH \
 611         "vlan_tag_mismatch"
 612 #define DEVLINK_TRAP_GENERIC_NAME_INGRESS_VLAN_FILTER \
 613         "ingress_vlan_filter"
 614 #define DEVLINK_TRAP_GENERIC_NAME_INGRESS_STP_FILTER \
 615         "ingress_spanning_tree_filter"
 616 #define DEVLINK_TRAP_GENERIC_NAME_EMPTY_TX_LIST \
 617         "port_list_is_empty"
 618 #define DEVLINK_TRAP_GENERIC_NAME_PORT_LOOPBACK_FILTER \
 619         "port_loopback_filter"
 620 #define DEVLINK_TRAP_GENERIC_NAME_BLACKHOLE_ROUTE \
 621         "blackhole_route"
 622 #define DEVLINK_TRAP_GENERIC_NAME_TTL_ERROR \
 623         "ttl_value_is_too_small"
 624 #define DEVLINK_TRAP_GENERIC_NAME_TAIL_DROP \
 625         "tail_drop"
 626 #define DEVLINK_TRAP_GENERIC_NAME_NON_IP_PACKET \
 627         "non_ip"
 628 #define DEVLINK_TRAP_GENERIC_NAME_UC_DIP_MC_DMAC \
 629         "uc_dip_over_mc_dmac"
 630 #define DEVLINK_TRAP_GENERIC_NAME_DIP_LB \
 631         "dip_is_loopback_address"
 632 #define DEVLINK_TRAP_GENERIC_NAME_SIP_MC \
 633         "sip_is_mc"
 634 #define DEVLINK_TRAP_GENERIC_NAME_SIP_LB \
 635         "sip_is_loopback_address"
 636 #define DEVLINK_TRAP_GENERIC_NAME_CORRUPTED_IP_HDR \
 637         "ip_header_corrupted"
 638 #define DEVLINK_TRAP_GENERIC_NAME_IPV4_SIP_BC \
 639         "ipv4_sip_is_limited_bc"
 640 #define DEVLINK_TRAP_GENERIC_NAME_IPV6_MC_DIP_RESERVED_SCOPE \
 641         "ipv6_mc_dip_reserved_scope"
 642 #define DEVLINK_TRAP_GENERIC_NAME_IPV6_MC_DIP_INTERFACE_LOCAL_SCOPE \
 643         "ipv6_mc_dip_interface_local_scope"
 644 #define DEVLINK_TRAP_GENERIC_NAME_MTU_ERROR \
 645         "mtu_value_is_too_small"
 646 #define DEVLINK_TRAP_GENERIC_NAME_UNRESOLVED_NEIGH \
 647         "unresolved_neigh"
 648 #define DEVLINK_TRAP_GENERIC_NAME_RPF \
 649         "mc_reverse_path_forwarding"
 650 #define DEVLINK_TRAP_GENERIC_NAME_REJECT_ROUTE \
 651         "reject_route"
 652 #define DEVLINK_TRAP_GENERIC_NAME_IPV4_LPM_UNICAST_MISS \
 653         "ipv4_lpm_miss"
 654 #define DEVLINK_TRAP_GENERIC_NAME_IPV6_LPM_UNICAST_MISS \
 655         "ipv6_lpm_miss"
 656
 657 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_L2_DROPS \
 658         "l2_drops"
 659 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_L3_DROPS \
 660         "l3_drops"
 661 #define DEVLINK_TRAP_GROUP_GENERIC_NAME_BUFFER_DROPS \
 662         "buffer_drops"
 663
 664 #define DEVLINK_TRAP_GENERIC(_type, _init_action, _id, _group, _metadata_cap) \
 665         {                                                                     \
 666                 .type = DEVLINK_TRAP_TYPE_##_type,                            \
 667                 .init_action = DEVLINK_TRAP_ACTION_##_init_action,            \
 668                 .generic = true,                                              \
 669                 .id = DEVLINK_TRAP_GENERIC_ID_##_id,                          \
 670                 .name = DEVLINK_TRAP_GENERIC_NAME_##_id,                      \
 671                 .group = _group,                                              \
 672                 .metadata_cap = _metadata_cap,                                \
 673         }
 674
 675 #define DEVLINK_TRAP_DRIVER(_type, _init_action, _id, _name, _group,          \
 676                             _metadata_cap)                                    \
 677         {                                                                     \
 678                 .type = DEVLINK_TRAP_TYPE_##_type,                            \
 679                 .init_action = DEVLINK_TRAP_ACTION_##_init_action,            \
 680                 .generic = false,                                             \
 681                 .id = _id,                                                    \
 682                 .name = _name,                                                \
 683                 .group = _group,                                              \
 684                 .metadata_cap = _metadata_cap,                                \
 685         }
 686
 687 #define DEVLINK_TRAP_GROUP_GENERIC(_id)                                       \
 688         {                                                                     \
 689                 .name = DEVLINK_TRAP_GROUP_GENERIC_NAME_##_id,                \
 690                 .id = DEVLINK_TRAP_GROUP_GENERIC_ID_##_id,                    \
 691                 .generic = true,                                              \
 692         }
 693
 694 struct devlink_ops {
 695         int (*reload_down)(struct devlink *devlink, bool netns_change,
 696                            struct netlink_ext_ack *extack);
 697         int (*reload_up)(struct devlink *devlink,
 698                          struct netlink_ext_ack *extack);
 699         int (*port_type_set)(struct devlink_port *devlink_port,
 700                              enum devlink_port_type port_type);
 701         int (*port_split)(struct devlink *devlink, unsigned int port_index,
 702                           unsigned int count, struct netlink_ext_ack *extack);
 703         int (*port_unsplit)(struct devlink *devlink, unsigned int port_index,
 704                             struct netlink_ext_ack *extack);
 705         int (*sb_pool_get)(struct devlink *devlink, unsigned int sb_index,
 706                            u16 pool_index,
 707                            struct devlink_sb_pool_info *pool_info);
 708         int (*sb_pool_set)(struct devlink *devlink, unsigned int sb_index,
 709                            u16 pool_index, u32 size,
 710                            enum devlink_sb_threshold_type threshold_type,
 711                            struct netlink_ext_ack *extack);
 712         int (*sb_port_pool_get)(struct devlink_port *devlink_port,
 713                                 unsigned int sb_index, u16 pool_index,
 714                                 u32 *p_threshold);
 715         int (*sb_port_pool_set)(struct devlink_port *devlink_port,
 716                                 unsigned int sb_index, u16 pool_index,
 717                                 u32 threshold, struct netlink_ext_ack *extack);
 718         int (*sb_tc_pool_bind_get)(struct devlink_port *devlink_port,
 719                                    unsigned int sb_index,
 720                                    u16 tc_index,
 721                                    enum devlink_sb_pool_type pool_type,
 722                                    u16 *p_pool_index, u32 *p_threshold);
 723         int (*sb_tc_pool_bind_set)(struct devlink_port *devlink_port,
 724                                    unsigned int sb_index,
 725                                    u16 tc_index,
 726                                    enum devlink_sb_pool_type pool_type,
 727                                    u16 pool_index, u32 threshold,
 728                                    struct netlink_ext_ack *extack);
 729         int (*sb_occ_snapshot)(struct devlink *devlink,
 730                                unsigned int sb_index);
 731         int (*sb_occ_max_clear)(struct devlink *devlink,
 732                                 unsigned int sb_index);
 733         int (*sb_occ_port_pool_get)(struct devlink_port *devlink_port,
 734                                     unsigned int sb_index, u16 pool_index,
 735                                     u32 *p_cur, u32 *p_max);
 736         int (*sb_occ_tc_port_bind_get)(struct devlink_port *devlink_port,
 737                                        unsigned int sb_index,
 738                                        u16 tc_index,
 739                                        enum devlink_sb_pool_type pool_type,
 740                                        u32 *p_cur, u32 *p_max);
 741
 742         int (*eswitch_mode_get)(struct devlink *devlink, u16 *p_mode);
 743         int (*eswitch_mode_set)(struct devlink *devlink, u16 mode,
 744                                 struct netlink_ext_ack *extack);
 745         int (*eswitch_inline_mode_get)(struct devlink *devlink, u8 *p_inline_mode);
 746         int (*eswitch_inline_mode_set)(struct devlink *devlink, u8 inline_mode,
 747                                        struct netlink_ext_ack *extack);
 748         int (*eswitch_encap_mode_get)(struct devlink *devlink,
 749                                       enum devlink_eswitch_encap_mode *p_encap_mode);
 750         int (*eswitch_encap_mode_set)(struct devlink *devlink,
 751                                       enum devlink_eswitch_encap_mode encap_mode,
 752                                       struct netlink_ext_ack *extack);
 753         int (*info_get)(struct devlink *devlink, struct devlink_info_req *req,
 754                         struct netlink_ext_ack *extack);
 755         int (*flash_update)(struct devlink *devlink, const char *file_name,
 756                             const char *component,
 757                             struct netlink_ext_ack *extack);
 758         /**
 759          * @trap_init: Trap initialization function.
 760          *
 761          * Should be used by device drivers to initialize the trap in the
 762          * underlying device. Drivers should also store the provided trap
 763          * context, so that they could efficiently pass it to
 764          * devlink_trap_report() when the trap is triggered.
 765          */
 766         int (*trap_init)(struct devlink *devlink,
 767                          const struct devlink_trap *trap, void *trap_ctx);
 768         /**
 769          * @trap_fini: Trap de-initialization function.
 770          *
 771          * Should be used by device drivers to de-initialize the trap in the
 772          * underlying device.
 773          */
 774         void (*trap_fini)(struct devlink *devlink,
 775                           const struct devlink_trap *trap, void *trap_ctx);
 776         /**
 777          * @trap_action_set: Trap action set function.
 778          */
 779         int (*trap_action_set)(struct devlink *devlink,
 780                                const struct devlink_trap *trap,
 781                                enum devlink_trap_action action);
 782         /**
 783          * @trap_group_init: Trap group initialization function.
 784          *
 785          * Should be used by device drivers to initialize the trap group in the
 786          * underlying device.
 787          */
 788         int (*trap_group_init)(struct devlink *devlink,
 789                                const struct devlink_trap_group *group);
 790 };
 791
 792 static inline void *devlink_priv(struct devlink *devlink)
 793 {
 794         BUG_ON(!devlink);
 795         return &devlink->priv;
 796 }
 797
 798 static inline struct devlink *priv_to_devlink(void *priv)
 799 {
 800         BUG_ON(!priv);
 801         return container_of(priv, struct devlink, priv);
 802 }
 803
 804 static inline struct devlink_port *
 805 netdev_to_devlink_port(struct net_device *dev)
 806 {
 807         if (dev->netdev_ops->ndo_get_devlink_port)
 808                 return dev->netdev_ops->ndo_get_devlink_port(dev);
 809         return NULL;
 810 }
 811
 812 static inline struct devlink *netdev_to_devlink(struct net_device *dev)
 813 {
 814         struct devlink_port *devlink_port = netdev_to_devlink_port(dev);
 815
 816         if (devlink_port)
 817                 return devlink_port->devlink;
 818         return NULL;
 819 }
 820
 821 struct ib_device;
 822
 823 struct net *devlink_net(const struct devlink *devlink);
 824 void devlink_net_set(struct devlink *devlink, struct net *net);
 825 struct devlink *devlink_alloc(const struct devlink_ops *ops, size_t priv_size);
 826 int devlink_register(struct devlink *devlink, struct device *dev);
 827 void devlink_unregister(struct devlink *devlink);
 828 void devlink_reload_enable(struct devlink *devlink);
 829 void devlink_reload_disable(struct devlink *devlink);
 830 void devlink_free(struct devlink *devlink);
 831 int devlink_port_register(struct devlink *devlink,
 832                           struct devlink_port *devlink_port,
 833                           unsigned int port_index);
 834 void devlink_port_unregister(struct devlink_port *devlink_port);
 835 void devlink_port_type_eth_set(struct devlink_port *devlink_port,
 836                                struct net_device *netdev);
 837 void devlink_port_type_ib_set(struct devlink_port *devlink_port,
 838                               struct ib_device *ibdev);
 839 void devlink_port_type_clear(struct devlink_port *devlink_port);
 840 void devlink_port_attrs_set(struct devlink_port *devlink_port,
 841                             enum devlink_port_flavour flavour,
 842                             u32 port_number, bool split,
 843                             u32 split_subport_number,
 844                             const unsigned char *switch_id,
 845                             unsigned char switch_id_len);
 846 void devlink_port_attrs_pci_pf_set(struct devlink_port *devlink_port,
 847                                    const unsigned char *switch_id,
 848                                    unsigned char switch_id_len, u16 pf);
 849 void devlink_port_attrs_pci_vf_set(struct devlink_port *devlink_port,
 850                                    const unsigned char *switch_id,
 851                                    unsigned char switch_id_len,
 852                                    u16 pf, u16 vf);
 853 int devlink_sb_register(struct devlink *devlink, unsigned int sb_index,
 854                         u32 size, u16 ingress_pools_count,
 855                         u16 egress_pools_count, u16 ingress_tc_count,
 856                         u16 egress_tc_count);
 857 void devlink_sb_unregister(struct devlink *devlink, unsigned int sb_index);
 858 int devlink_dpipe_table_register(struct devlink *devlink,
 859                                  const char *table_name,
 860                                  struct devlink_dpipe_table_ops *table_ops,
 861                                  void *priv, bool counter_control_extern);
 862 void devlink_dpipe_table_unregister(struct devlink *devlink,
 863                                     const char *table_name);
 864 int devlink_dpipe_headers_register(struct devlink *devlink,
 865                                    struct devlink_dpipe_headers *dpipe_headers);
 866 void devlink_dpipe_headers_unregister(struct devlink *devlink);
 867 bool devlink_dpipe_table_counter_enabled(struct devlink *devlink,
 868                                          const char *table_name);
 869 int devlink_dpipe_entry_ctx_prepare(struct devlink_dpipe_dump_ctx *dump_ctx);
 870 int devlink_dpipe_entry_ctx_append(struct devlink_dpipe_dump_ctx *dump_ctx,
 871                                    struct devlink_dpipe_entry *entry);
 872 int devlink_dpipe_entry_ctx_close(struct devlink_dpipe_dump_ctx *dump_ctx);
 873 void devlink_dpipe_entry_clear(struct devlink_dpipe_entry *entry);
 874 int devlink_dpipe_action_put(struct sk_buff *skb,
 875                              struct devlink_dpipe_action *action);
 876 int devlink_dpipe_match_put(struct sk_buff *skb,
 877                             struct devlink_dpipe_match *match);
 878 extern struct devlink_dpipe_header devlink_dpipe_header_ethernet;
 879 extern struct devlink_dpipe_header devlink_dpipe_header_ipv4;
 880 extern struct devlink_dpipe_header devlink_dpipe_header_ipv6;
 881
 882 int devlink_resource_register(struct devlink *devlink,
 883                               const char *resource_name,
 884                               u64 resource_size,
 885                               u64 resource_id,
 886                               u64 parent_resource_id,
 887                               const struct devlink_resource_size_params *size_params);
 888 void devlink_resources_unregister(struct devlink *devlink,
 889                                   struct devlink_resource *resource);
 890 int devlink_resource_size_get(struct devlink *devlink,
 891                               u64 resource_id,
 892                               u64 *p_resource_size);
 893 int devlink_dpipe_table_resource_set(struct devlink *devlink,
 894                                      const char *table_name, u64 resource_id,
 895                                      u64 resource_units);
 896 void devlink_resource_occ_get_register(struct devlink *devlink,
 897                                        u64 resource_id,
 898                                        devlink_resource_occ_get_t *occ_get,
 899                                        void *occ_get_priv);
 900 void devlink_resource_occ_get_unregister(struct devlink *devlink,
 901                                          u64 resource_id);
 902 int devlink_params_register(struct devlink *devlink,
 903                             const struct devlink_param *params,
 904                             size_t params_count);
 905 void devlink_params_unregister(struct devlink *devlink,
 906                                const struct devlink_param *params,
 907                                size_t params_count);
 908 void devlink_params_publish(struct devlink *devlink);
 909 void devlink_params_unpublish(struct devlink *devlink);
 910 int devlink_port_params_register(struct devlink_port *devlink_port,
 911                                  const struct devlink_param *params,
 912                                  size_t params_count);
 913 void devlink_port_params_unregister(struct devlink_port *devlink_port,
 914                                     const struct devlink_param *params,
 915                                     size_t params_count);
 916 int devlink_param_driverinit_value_get(struct devlink *devlink, u32 param_id,
 917                                        union devlink_param_value *init_val);
 918 int devlink_param_driverinit_value_set(struct devlink *devlink, u32 param_id,
 919                                        union devlink_param_value init_val);
 920 int
 921 devlink_port_param_driverinit_value_get(struct devlink_port *devlink_port,
 922                                         u32 param_id,
 923                                         union devlink_param_value *init_val);
 924 int devlink_port_param_driverinit_value_set(struct devlink_port *devlink_port,
 925                                             u32 param_id,
 926                                             union devlink_param_value init_val);
 927 void devlink_param_value_changed(struct devlink *devlink, u32 param_id);
 928 void devlink_port_param_value_changed(struct devlink_port *devlink_port,
 929                                       u32 param_id);
 930 void devlink_param_value_str_fill(union devlink_param_value *dst_val,
 931                                   const char *src);
 932 struct devlink_region *devlink_region_create(struct devlink *devlink,
 933                                              const char *region_name,
 934                                              u32 region_max_snapshots,
 935                                              u64 region_size);
 936 void devlink_region_destroy(struct devlink_region *region);
 937 u32 devlink_region_shapshot_id_get(struct devlink *devlink);
 938 int devlink_region_snapshot_create(struct devlink_region *region,
 939                                    u8 *data, u32 snapshot_id,
 940                                    devlink_snapshot_data_dest_t *data_destructor);
 941 int devlink_info_serial_number_put(struct devlink_info_req *req,
 942                                    const char *sn);
 943 int devlink_info_driver_name_put(struct devlink_info_req *req,
 944                                  const char *name);
 945 int devlink_info_version_fixed_put(struct devlink_info_req *req,
 946                                    const char *version_name,
 947                                    const char *version_value);
 948 int devlink_info_version_stored_put(struct devlink_info_req *req,
 949                                     const char *version_name,
 950                                     const char *version_value);
 951 int devlink_info_version_running_put(struct devlink_info_req *req,
 952                                      const char *version_name,
 953                                      const char *version_value);
 954
 955 int devlink_fmsg_obj_nest_start(struct devlink_fmsg *fmsg);
 956 int devlink_fmsg_obj_nest_end(struct devlink_fmsg *fmsg);
 957
 958 int devlink_fmsg_pair_nest_start(struct devlink_fmsg *fmsg, const char *name);
 959 int devlink_fmsg_pair_nest_end(struct devlink_fmsg *fmsg);
 960
 961 int devlink_fmsg_arr_pair_nest_start(struct devlink_fmsg *fmsg,
 962                                      const char *name);
 963 int devlink_fmsg_arr_pair_nest_end(struct devlink_fmsg *fmsg);
 964
 965 int devlink_fmsg_bool_put(struct devlink_fmsg *fmsg, bool value);
 966 int devlink_fmsg_u8_put(struct devlink_fmsg *fmsg, u8 value);
 967 int devlink_fmsg_u32_put(struct devlink_fmsg *fmsg, u32 value);
 968 int devlink_fmsg_u64_put(struct devlink_fmsg *fmsg, u64 value);
 969 int devlink_fmsg_string_put(struct devlink_fmsg *fmsg, const char *value);
 970 int devlink_fmsg_binary_put(struct devlink_fmsg *fmsg, const void *value,
 971                             u16 value_len);
 972
 973 int devlink_fmsg_bool_pair_put(struct devlink_fmsg *fmsg, const char *name,
 974                                bool value);
 975 int devlink_fmsg_u8_pair_put(struct devlink_fmsg *fmsg, const char *name,
 976                              u8 value);
 977 int devlink_fmsg_u32_pair_put(struct devlink_fmsg *fmsg, const char *name,
 978                               u32 value);
 979 int devlink_fmsg_u64_pair_put(struct devlink_fmsg *fmsg, const char *name,
 980                               u64 value);
 981 int devlink_fmsg_string_pair_put(struct devlink_fmsg *fmsg, const char *name,
 982                                  const char *value);
 983 int devlink_fmsg_binary_pair_put(struct devlink_fmsg *fmsg, const char *name,
 984                                  const void *value, u16 value_len);
 985
 986 struct devlink_health_reporter *
 987 devlink_health_reporter_create(struct devlink *devlink,
 988                                const struct devlink_health_reporter_ops *ops,
 989                                u64 graceful_period, bool auto_recover,
 990                                void *priv);
 991 void
 992 devlink_health_reporter_destroy(struct devlink_health_reporter *reporter);
 993
 994 void *
 995 devlink_health_reporter_priv(struct devlink_health_reporter *reporter);
 996 int devlink_health_report(struct devlink_health_reporter *reporter,
 997                           const char *msg, void *priv_ctx);
 998 void
 999 devlink_health_reporter_state_update(struct devlink_health_reporter *reporter,
1000                                      enum devlink_health_reporter_state state);
1001
1002 bool devlink_is_reload_failed(const struct devlink *devlink);
1003
1004 void devlink_flash_update_begin_notify(struct devlink *devlink);
1005 void devlink_flash_update_end_notify(struct devlink *devlink);
1006 void devlink_flash_update_status_notify(struct devlink *devlink,
1007                                         const char *status_msg,
1008                                         const char *component,
1009                                         unsigned long done,
1010                                         unsigned long total);
1011
1012 int devlink_traps_register(struct devlink *devlink,
1013                            const struct devlink_trap *traps,
1014                            size_t traps_count, void *priv);
1015 void devlink_traps_unregister(struct devlink *devlink,
1016                               const struct devlink_trap *traps,
1017                               size_t traps_count);
1018 void devlink_trap_report(struct devlink *devlink,
1019                          struct sk_buff *skb, void *trap_ctx,
1020                          struct devlink_port *in_devlink_port);
1021 void *devlink_trap_ctx_priv(void *trap_ctx);
1022
1023 #if IS_ENABLED(CONFIG_NET_DEVLINK)
1024
1025 void devlink_compat_running_version(struct net_device *dev,
1026                                     char *buf, size_t len);
1027 int devlink_compat_flash_update(struct net_device *dev, const char *file_name);
1028 int devlink_compat_phys_port_name_get(struct net_device *dev,
1029                                       char *name, size_t len);
1030 int devlink_compat_switch_id_get(struct net_device *dev,
1031                                  struct netdev_phys_item_id *ppid);
1032
1033 #else
1034
1035 static inline void
1036 devlink_compat_running_version(struct net_device *dev, char *buf, size_t len)
1037 {
1038 }
1039
1040 static inline int
1041 devlink_compat_flash_update(struct net_device *dev, const char *file_name)
1042 {
1043         return -EOPNOTSUPP;
1044 }
1045
1046 static inline int
1047 devlink_compat_phys_port_name_get(struct net_device *dev,
1048                                   char *name, size_t len)
1049 {
1050         return -EOPNOTSUPP;
1051 }
1052
1053 static inline int
1054 devlink_compat_switch_id_get(struct net_device *dev,
1055                              struct netdev_phys_item_id *ppid)
1056 {
1057         return -EOPNOTSUPP;
1058 }
1059
1060 #endif
1061
1062 #endif /* _NET_DEVLINK_H_ */