include/uapi/linux/devlink.h

   1 /* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */
   2 /*
   3  * include/uapi/linux/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  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  */
  12
  13 #ifndef _LINUX_DEVLINK_H_
  14 #define _LINUX_DEVLINK_H_
  15
  16 #define DEVLINK_GENL_NAME "devlink"
  17 #define DEVLINK_GENL_VERSION 0x1
  18 #define DEVLINK_GENL_MCGRP_CONFIG_NAME "config"
  19
  20 enum devlink_command {
  21         /* don't change the order or add anything between, this is ABI! */
  22         DEVLINK_CMD_UNSPEC,
  23
  24         DEVLINK_CMD_GET,                /* can dump */
  25         DEVLINK_CMD_SET,
  26         DEVLINK_CMD_NEW,
  27         DEVLINK_CMD_DEL,
  28
  29         DEVLINK_CMD_PORT_GET,           /* can dump */
  30         DEVLINK_CMD_PORT_SET,
  31         DEVLINK_CMD_PORT_NEW,
  32         DEVLINK_CMD_PORT_DEL,
  33
  34         DEVLINK_CMD_PORT_SPLIT,
  35         DEVLINK_CMD_PORT_UNSPLIT,
  36
  37         DEVLINK_CMD_SB_GET,             /* can dump */
  38         DEVLINK_CMD_SB_SET,
  39         DEVLINK_CMD_SB_NEW,
  40         DEVLINK_CMD_SB_DEL,
  41
  42         DEVLINK_CMD_SB_POOL_GET,        /* can dump */
  43         DEVLINK_CMD_SB_POOL_SET,
  44         DEVLINK_CMD_SB_POOL_NEW,
  45         DEVLINK_CMD_SB_POOL_DEL,
  46
  47         DEVLINK_CMD_SB_PORT_POOL_GET,   /* can dump */
  48         DEVLINK_CMD_SB_PORT_POOL_SET,
  49         DEVLINK_CMD_SB_PORT_POOL_NEW,
  50         DEVLINK_CMD_SB_PORT_POOL_DEL,
  51
  52         DEVLINK_CMD_SB_TC_POOL_BIND_GET,        /* can dump */
  53         DEVLINK_CMD_SB_TC_POOL_BIND_SET,
  54         DEVLINK_CMD_SB_TC_POOL_BIND_NEW,
  55         DEVLINK_CMD_SB_TC_POOL_BIND_DEL,
  56
  57         /* Shared buffer occupancy monitoring commands */
  58         DEVLINK_CMD_SB_OCC_SNAPSHOT,
  59         DEVLINK_CMD_SB_OCC_MAX_CLEAR,
  60
  61         DEVLINK_CMD_ESWITCH_GET,
  62 #define DEVLINK_CMD_ESWITCH_MODE_GET /* obsolete, never use this! */ \
  63         DEVLINK_CMD_ESWITCH_GET
  64
  65         DEVLINK_CMD_ESWITCH_SET,
  66 #define DEVLINK_CMD_ESWITCH_MODE_SET /* obsolete, never use this! */ \
  67         DEVLINK_CMD_ESWITCH_SET
  68
  69         DEVLINK_CMD_DPIPE_TABLE_GET,
  70         DEVLINK_CMD_DPIPE_ENTRIES_GET,
  71         DEVLINK_CMD_DPIPE_HEADERS_GET,
  72         DEVLINK_CMD_DPIPE_TABLE_COUNTERS_SET,
  73         DEVLINK_CMD_RESOURCE_SET,
  74         DEVLINK_CMD_RESOURCE_DUMP,
  75
  76         /* Hot driver reload, makes configuration changes take place. The
  77          * devlink instance is not released during the process.
  78          */
  79         DEVLINK_CMD_RELOAD,
  80
  81         DEVLINK_CMD_PARAM_GET,          /* can dump */
  82         DEVLINK_CMD_PARAM_SET,
  83         DEVLINK_CMD_PARAM_NEW,
  84         DEVLINK_CMD_PARAM_DEL,
  85
  86         DEVLINK_CMD_REGION_GET,
  87         DEVLINK_CMD_REGION_SET,
  88         DEVLINK_CMD_REGION_NEW,
  89         DEVLINK_CMD_REGION_DEL,
  90         DEVLINK_CMD_REGION_READ,
  91
  92         DEVLINK_CMD_PORT_PARAM_GET,     /* can dump */
  93         DEVLINK_CMD_PORT_PARAM_SET,
  94         DEVLINK_CMD_PORT_PARAM_NEW,
  95         DEVLINK_CMD_PORT_PARAM_DEL,
  96
  97         DEVLINK_CMD_INFO_GET,           /* can dump */
  98
  99         DEVLINK_CMD_HEALTH_REPORTER_GET,
 100         DEVLINK_CMD_HEALTH_REPORTER_SET,
 101         DEVLINK_CMD_HEALTH_REPORTER_RECOVER,
 102         DEVLINK_CMD_HEALTH_REPORTER_DIAGNOSE,
 103         DEVLINK_CMD_HEALTH_REPORTER_DUMP_GET,
 104         DEVLINK_CMD_HEALTH_REPORTER_DUMP_CLEAR,
 105
 106         DEVLINK_CMD_FLASH_UPDATE,
 107         DEVLINK_CMD_FLASH_UPDATE_END,           /* notification only */
 108         DEVLINK_CMD_FLASH_UPDATE_STATUS,        /* notification only */
 109
 110         /* add new commands above here */
 111         __DEVLINK_CMD_MAX,
 112         DEVLINK_CMD_MAX = __DEVLINK_CMD_MAX - 1
 113 };
 114
 115 enum devlink_port_type {
 116         DEVLINK_PORT_TYPE_NOTSET,
 117         DEVLINK_PORT_TYPE_AUTO,
 118         DEVLINK_PORT_TYPE_ETH,
 119         DEVLINK_PORT_TYPE_IB,
 120 };
 121
 122 enum devlink_sb_pool_type {
 123         DEVLINK_SB_POOL_TYPE_INGRESS,
 124         DEVLINK_SB_POOL_TYPE_EGRESS,
 125 };
 126
 127 /* static threshold - limiting the maximum number of bytes.
 128  * dynamic threshold - limiting the maximum number of bytes
 129  *   based on the currently available free space in the shared buffer pool.
 130  *   In this mode, the maximum quota is calculated based
 131  *   on the following formula:
 132  *     max_quota = alpha / (1 + alpha) * Free_Buffer
 133  *   While Free_Buffer is the amount of none-occupied buffer associated to
 134  *   the relevant pool.
 135  *   The value range which can be passed is 0-20 and serves
 136  *   for computation of alpha by following formula:
 137  *     alpha = 2 ^ (passed_value - 10)
 138  */
 139
 140 enum devlink_sb_threshold_type {
 141         DEVLINK_SB_THRESHOLD_TYPE_STATIC,
 142         DEVLINK_SB_THRESHOLD_TYPE_DYNAMIC,
 143 };
 144
 145 #define DEVLINK_SB_THRESHOLD_TO_ALPHA_MAX 20
 146
 147 enum devlink_eswitch_mode {
 148         DEVLINK_ESWITCH_MODE_LEGACY,
 149         DEVLINK_ESWITCH_MODE_SWITCHDEV,
 150 };
 151
 152 enum devlink_eswitch_inline_mode {
 153         DEVLINK_ESWITCH_INLINE_MODE_NONE,
 154         DEVLINK_ESWITCH_INLINE_MODE_LINK,
 155         DEVLINK_ESWITCH_INLINE_MODE_NETWORK,
 156         DEVLINK_ESWITCH_INLINE_MODE_TRANSPORT,
 157 };
 158
 159 enum devlink_eswitch_encap_mode {
 160         DEVLINK_ESWITCH_ENCAP_MODE_NONE,
 161         DEVLINK_ESWITCH_ENCAP_MODE_BASIC,
 162 };
 163
 164 enum devlink_port_flavour {
 165         DEVLINK_PORT_FLAVOUR_PHYSICAL, /* Any kind of a port physically
 166                                         * facing the user.
 167                                         */
 168         DEVLINK_PORT_FLAVOUR_CPU, /* CPU port */
 169         DEVLINK_PORT_FLAVOUR_DSA, /* Distributed switch architecture
 170                                    * interconnect port.
 171                                    */
 172 };
 173
 174 enum devlink_param_cmode {
 175         DEVLINK_PARAM_CMODE_RUNTIME,
 176         DEVLINK_PARAM_CMODE_DRIVERINIT,
 177         DEVLINK_PARAM_CMODE_PERMANENT,
 178
 179         /* Add new configuration modes above */
 180         __DEVLINK_PARAM_CMODE_MAX,
 181         DEVLINK_PARAM_CMODE_MAX = __DEVLINK_PARAM_CMODE_MAX - 1
 182 };
 183
 184 enum devlink_param_fw_load_policy_value {
 185         DEVLINK_PARAM_FW_LOAD_POLICY_VALUE_DRIVER,
 186         DEVLINK_PARAM_FW_LOAD_POLICY_VALUE_FLASH,
 187 };
 188
 189 enum devlink_attr {
 190         /* don't change the order or add anything between, this is ABI! */
 191         DEVLINK_ATTR_UNSPEC,
 192
 193         /* bus name + dev name together are a handle for devlink entity */
 194         DEVLINK_ATTR_BUS_NAME,                  /* string */
 195         DEVLINK_ATTR_DEV_NAME,                  /* string */
 196
 197         DEVLINK_ATTR_PORT_INDEX,                /* u32 */
 198         DEVLINK_ATTR_PORT_TYPE,                 /* u16 */
 199         DEVLINK_ATTR_PORT_DESIRED_TYPE,         /* u16 */
 200         DEVLINK_ATTR_PORT_NETDEV_IFINDEX,       /* u32 */
 201         DEVLINK_ATTR_PORT_NETDEV_NAME,          /* string */
 202         DEVLINK_ATTR_PORT_IBDEV_NAME,           /* string */
 203         DEVLINK_ATTR_PORT_SPLIT_COUNT,          /* u32 */
 204         DEVLINK_ATTR_PORT_SPLIT_GROUP,          /* u32 */
 205         DEVLINK_ATTR_SB_INDEX,                  /* u32 */
 206         DEVLINK_ATTR_SB_SIZE,                   /* u32 */
 207         DEVLINK_ATTR_SB_INGRESS_POOL_COUNT,     /* u16 */
 208         DEVLINK_ATTR_SB_EGRESS_POOL_COUNT,      /* u16 */
 209         DEVLINK_ATTR_SB_INGRESS_TC_COUNT,       /* u16 */
 210         DEVLINK_ATTR_SB_EGRESS_TC_COUNT,        /* u16 */
 211         DEVLINK_ATTR_SB_POOL_INDEX,             /* u16 */
 212         DEVLINK_ATTR_SB_POOL_TYPE,              /* u8 */
 213         DEVLINK_ATTR_SB_POOL_SIZE,              /* u32 */
 214         DEVLINK_ATTR_SB_POOL_THRESHOLD_TYPE,    /* u8 */
 215         DEVLINK_ATTR_SB_THRESHOLD,              /* u32 */
 216         DEVLINK_ATTR_SB_TC_INDEX,               /* u16 */
 217         DEVLINK_ATTR_SB_OCC_CUR,                /* u32 */
 218         DEVLINK_ATTR_SB_OCC_MAX,                /* u32 */
 219         DEVLINK_ATTR_ESWITCH_MODE,              /* u16 */
 220         DEVLINK_ATTR_ESWITCH_INLINE_MODE,       /* u8 */
 221
 222         DEVLINK_ATTR_DPIPE_TABLES,              /* nested */
 223         DEVLINK_ATTR_DPIPE_TABLE,               /* nested */
 224         DEVLINK_ATTR_DPIPE_TABLE_NAME,          /* string */
 225         DEVLINK_ATTR_DPIPE_TABLE_SIZE,          /* u64 */
 226         DEVLINK_ATTR_DPIPE_TABLE_MATCHES,       /* nested */
 227         DEVLINK_ATTR_DPIPE_TABLE_ACTIONS,       /* nested */
 228         DEVLINK_ATTR_DPIPE_TABLE_COUNTERS_ENABLED,      /* u8 */
 229
 230         DEVLINK_ATTR_DPIPE_ENTRIES,             /* nested */
 231         DEVLINK_ATTR_DPIPE_ENTRY,               /* nested */
 232         DEVLINK_ATTR_DPIPE_ENTRY_INDEX,         /* u64 */
 233         DEVLINK_ATTR_DPIPE_ENTRY_MATCH_VALUES,  /* nested */
 234         DEVLINK_ATTR_DPIPE_ENTRY_ACTION_VALUES, /* nested */
 235         DEVLINK_ATTR_DPIPE_ENTRY_COUNTER,       /* u64 */
 236
 237         DEVLINK_ATTR_DPIPE_MATCH,               /* nested */
 238         DEVLINK_ATTR_DPIPE_MATCH_VALUE,         /* nested */
 239         DEVLINK_ATTR_DPIPE_MATCH_TYPE,          /* u32 */
 240
 241         DEVLINK_ATTR_DPIPE_ACTION,              /* nested */
 242         DEVLINK_ATTR_DPIPE_ACTION_VALUE,        /* nested */
 243         DEVLINK_ATTR_DPIPE_ACTION_TYPE,         /* u32 */
 244
 245         DEVLINK_ATTR_DPIPE_VALUE,
 246         DEVLINK_ATTR_DPIPE_VALUE_MASK,
 247         DEVLINK_ATTR_DPIPE_VALUE_MAPPING,       /* u32 */
 248
 249         DEVLINK_ATTR_DPIPE_HEADERS,             /* nested */
 250         DEVLINK_ATTR_DPIPE_HEADER,              /* nested */
 251         DEVLINK_ATTR_DPIPE_HEADER_NAME,         /* string */
 252         DEVLINK_ATTR_DPIPE_HEADER_ID,           /* u32 */
 253         DEVLINK_ATTR_DPIPE_HEADER_FIELDS,       /* nested */
 254         DEVLINK_ATTR_DPIPE_HEADER_GLOBAL,       /* u8 */
 255         DEVLINK_ATTR_DPIPE_HEADER_INDEX,        /* u32 */
 256
 257         DEVLINK_ATTR_DPIPE_FIELD,               /* nested */
 258         DEVLINK_ATTR_DPIPE_FIELD_NAME,          /* string */
 259         DEVLINK_ATTR_DPIPE_FIELD_ID,            /* u32 */
 260         DEVLINK_ATTR_DPIPE_FIELD_BITWIDTH,      /* u32 */
 261         DEVLINK_ATTR_DPIPE_FIELD_MAPPING_TYPE,  /* u32 */
 262
 263         DEVLINK_ATTR_PAD,
 264
 265         DEVLINK_ATTR_ESWITCH_ENCAP_MODE,        /* u8 */
 266         DEVLINK_ATTR_RESOURCE_LIST,             /* nested */
 267         DEVLINK_ATTR_RESOURCE,                  /* nested */
 268         DEVLINK_ATTR_RESOURCE_NAME,             /* string */
 269         DEVLINK_ATTR_RESOURCE_ID,               /* u64 */
 270         DEVLINK_ATTR_RESOURCE_SIZE,             /* u64 */
 271         DEVLINK_ATTR_RESOURCE_SIZE_NEW,         /* u64 */
 272         DEVLINK_ATTR_RESOURCE_SIZE_VALID,       /* u8 */
 273         DEVLINK_ATTR_RESOURCE_SIZE_MIN,         /* u64 */
 274         DEVLINK_ATTR_RESOURCE_SIZE_MAX,         /* u64 */
 275         DEVLINK_ATTR_RESOURCE_SIZE_GRAN,        /* u64 */
 276         DEVLINK_ATTR_RESOURCE_UNIT,             /* u8 */
 277         DEVLINK_ATTR_RESOURCE_OCC,              /* u64 */
 278         DEVLINK_ATTR_DPIPE_TABLE_RESOURCE_ID,   /* u64 */
 279         DEVLINK_ATTR_DPIPE_TABLE_RESOURCE_UNITS,/* u64 */
 280
 281         DEVLINK_ATTR_PORT_FLAVOUR,              /* u16 */
 282         DEVLINK_ATTR_PORT_NUMBER,               /* u32 */
 283         DEVLINK_ATTR_PORT_SPLIT_SUBPORT_NUMBER, /* u32 */
 284
 285         DEVLINK_ATTR_PARAM,                     /* nested */
 286         DEVLINK_ATTR_PARAM_NAME,                /* string */
 287         DEVLINK_ATTR_PARAM_GENERIC,             /* flag */
 288         DEVLINK_ATTR_PARAM_TYPE,                /* u8 */
 289         DEVLINK_ATTR_PARAM_VALUES_LIST,         /* nested */
 290         DEVLINK_ATTR_PARAM_VALUE,               /* nested */
 291         DEVLINK_ATTR_PARAM_VALUE_DATA,          /* dynamic */
 292         DEVLINK_ATTR_PARAM_VALUE_CMODE,         /* u8 */
 293
 294         DEVLINK_ATTR_REGION_NAME,               /* string */
 295         DEVLINK_ATTR_REGION_SIZE,               /* u64 */
 296         DEVLINK_ATTR_REGION_SNAPSHOTS,          /* nested */
 297         DEVLINK_ATTR_REGION_SNAPSHOT,           /* nested */
 298         DEVLINK_ATTR_REGION_SNAPSHOT_ID,        /* u32 */
 299
 300         DEVLINK_ATTR_REGION_CHUNKS,             /* nested */
 301         DEVLINK_ATTR_REGION_CHUNK,              /* nested */
 302         DEVLINK_ATTR_REGION_CHUNK_DATA,         /* binary */
 303         DEVLINK_ATTR_REGION_CHUNK_ADDR,         /* u64 */
 304         DEVLINK_ATTR_REGION_CHUNK_LEN,          /* u64 */
 305
 306         DEVLINK_ATTR_INFO_DRIVER_NAME,          /* string */
 307         DEVLINK_ATTR_INFO_SERIAL_NUMBER,        /* string */
 308         DEVLINK_ATTR_INFO_VERSION_FIXED,        /* nested */
 309         DEVLINK_ATTR_INFO_VERSION_RUNNING,      /* nested */
 310         DEVLINK_ATTR_INFO_VERSION_STORED,       /* nested */
 311         DEVLINK_ATTR_INFO_VERSION_NAME,         /* string */
 312         DEVLINK_ATTR_INFO_VERSION_VALUE,        /* string */
 313
 314         DEVLINK_ATTR_SB_POOL_CELL_SIZE,         /* u32 */
 315
 316         DEVLINK_ATTR_FMSG,                      /* nested */
 317         DEVLINK_ATTR_FMSG_OBJ_NEST_START,       /* flag */
 318         DEVLINK_ATTR_FMSG_PAIR_NEST_START,      /* flag */
 319         DEVLINK_ATTR_FMSG_ARR_NEST_START,       /* flag */
 320         DEVLINK_ATTR_FMSG_NEST_END,             /* flag */
 321         DEVLINK_ATTR_FMSG_OBJ_NAME,             /* string */
 322         DEVLINK_ATTR_FMSG_OBJ_VALUE_TYPE,       /* u8 */
 323         DEVLINK_ATTR_FMSG_OBJ_VALUE_DATA,       /* dynamic */
 324
 325         DEVLINK_ATTR_HEALTH_REPORTER,                   /* nested */
 326         DEVLINK_ATTR_HEALTH_REPORTER_NAME,              /* string */
 327         DEVLINK_ATTR_HEALTH_REPORTER_STATE,             /* u8 */
 328         DEVLINK_ATTR_HEALTH_REPORTER_ERR_COUNT,         /* u64 */
 329         DEVLINK_ATTR_HEALTH_REPORTER_RECOVER_COUNT,     /* u64 */
 330         DEVLINK_ATTR_HEALTH_REPORTER_DUMP_TS,           /* u64 */
 331         DEVLINK_ATTR_HEALTH_REPORTER_GRACEFUL_PERIOD,   /* u64 */
 332         DEVLINK_ATTR_HEALTH_REPORTER_AUTO_RECOVER,      /* u8 */
 333
 334         DEVLINK_ATTR_FLASH_UPDATE_FILE_NAME,    /* string */
 335         DEVLINK_ATTR_FLASH_UPDATE_COMPONENT,    /* string */
 336         DEVLINK_ATTR_FLASH_UPDATE_STATUS_MSG,   /* string */
 337         DEVLINK_ATTR_FLASH_UPDATE_STATUS_DONE,  /* u64 */
 338         DEVLINK_ATTR_FLASH_UPDATE_STATUS_TOTAL, /* u64 */
 339
 340         /* add new attributes above here, update the policy in devlink.c */
 341
 342         __DEVLINK_ATTR_MAX,
 343         DEVLINK_ATTR_MAX = __DEVLINK_ATTR_MAX - 1
 344 };
 345
 346 /* Mapping between internal resource described by the field and system
 347  * structure
 348  */
 349 enum devlink_dpipe_field_mapping_type {
 350         DEVLINK_DPIPE_FIELD_MAPPING_TYPE_NONE,
 351         DEVLINK_DPIPE_FIELD_MAPPING_TYPE_IFINDEX,
 352 };
 353
 354 /* Match type - specify the type of the match */
 355 enum devlink_dpipe_match_type {
 356         DEVLINK_DPIPE_MATCH_TYPE_FIELD_EXACT,
 357 };
 358
 359 /* Action type - specify the action type */
 360 enum devlink_dpipe_action_type {
 361         DEVLINK_DPIPE_ACTION_TYPE_FIELD_MODIFY,
 362 };
 363
 364 enum devlink_dpipe_field_ethernet_id {
 365         DEVLINK_DPIPE_FIELD_ETHERNET_DST_MAC,
 366 };
 367
 368 enum devlink_dpipe_field_ipv4_id {
 369         DEVLINK_DPIPE_FIELD_IPV4_DST_IP,
 370 };
 371
 372 enum devlink_dpipe_field_ipv6_id {
 373         DEVLINK_DPIPE_FIELD_IPV6_DST_IP,
 374 };
 375
 376 enum devlink_dpipe_header_id {
 377         DEVLINK_DPIPE_HEADER_ETHERNET,
 378         DEVLINK_DPIPE_HEADER_IPV4,
 379         DEVLINK_DPIPE_HEADER_IPV6,
 380 };
 381
 382 enum devlink_resource_unit {
 383         DEVLINK_RESOURCE_UNIT_ENTRY,
 384 };
 385
 386 #endif /* _LINUX_DEVLINK_H_ */