[mirror_iproute2.git] / include / linux / devlink.h

/*
 * include/uapi/linux/devlink.h - Network physical device Netlink interface
 * Copyright (c) 2016 Mellanox Technologies. All rights reserved.
 * Copyright (c) 2016 Jiri Pirko <jiri@mellanox.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 */

#ifndef _LINUX_DEVLINK_H_
#define _LINUX_DEVLINK_H_

#define DEVLINK_GENL_NAME "devlink"
#define DEVLINK_GENL_VERSION 0x1
#define DEVLINK_GENL_MCGRP_CONFIG_NAME "config"

enum devlink_command {
	/* don't change the order or add anything between, this is ABI! */
	DEVLINK_CMD_UNSPEC,

	DEVLINK_CMD_GET,		/* can dump */
	DEVLINK_CMD_SET,
	DEVLINK_CMD_NEW,
	DEVLINK_CMD_DEL,

	DEVLINK_CMD_PORT_GET,		/* can dump */
	DEVLINK_CMD_PORT_SET,
	DEVLINK_CMD_PORT_NEW,
	DEVLINK_CMD_PORT_DEL,

	DEVLINK_CMD_PORT_SPLIT,
	DEVLINK_CMD_PORT_UNSPLIT,

	DEVLINK_CMD_SB_GET,		/* can dump */
	DEVLINK_CMD_SB_SET,
	DEVLINK_CMD_SB_NEW,
	DEVLINK_CMD_SB_DEL,

	DEVLINK_CMD_SB_POOL_GET,	/* can dump */
	DEVLINK_CMD_SB_POOL_SET,
	DEVLINK_CMD_SB_POOL_NEW,
	DEVLINK_CMD_SB_POOL_DEL,

	DEVLINK_CMD_SB_PORT_POOL_GET,	/* can dump */
	DEVLINK_CMD_SB_PORT_POOL_SET,
	DEVLINK_CMD_SB_PORT_POOL_NEW,
	DEVLINK_CMD_SB_PORT_POOL_DEL,

	DEVLINK_CMD_SB_TC_POOL_BIND_GET,	/* can dump */
	DEVLINK_CMD_SB_TC_POOL_BIND_SET,
	DEVLINK_CMD_SB_TC_POOL_BIND_NEW,
	DEVLINK_CMD_SB_TC_POOL_BIND_DEL,

	/* Shared buffer occupancy monitoring commands */
	DEVLINK_CMD_SB_OCC_SNAPSHOT,
	DEVLINK_CMD_SB_OCC_MAX_CLEAR,

	/* add new commands above here */

	__DEVLINK_CMD_MAX,
	DEVLINK_CMD_MAX = __DEVLINK_CMD_MAX - 1
};

enum devlink_port_type {
	DEVLINK_PORT_TYPE_NOTSET,
	DEVLINK_PORT_TYPE_AUTO,
	DEVLINK_PORT_TYPE_ETH,
	DEVLINK_PORT_TYPE_IB,
};

enum devlink_sb_pool_type {
	DEVLINK_SB_POOL_TYPE_INGRESS,
	DEVLINK_SB_POOL_TYPE_EGRESS,
};

/* static threshold - limiting the maximum number of bytes.
 * dynamic threshold - limiting the maximum number of bytes
 *   based on the currently available free space in the shared buffer pool.
 *   In this mode, the maximum quota is calculated based
 *   on the following formula:
 *     max_quota = alpha / (1 + alpha) * Free_Buffer
 *   While Free_Buffer is the amount of none-occupied buffer associated to
 *   the relevant pool.
 *   The value range which can be passed is 0-20 and serves
 *   for computation of alpha by following formula:
 *     alpha = 2 ^ (passed_value - 10)
 */

enum devlink_sb_threshold_type {
	DEVLINK_SB_THRESHOLD_TYPE_STATIC,
	DEVLINK_SB_THRESHOLD_TYPE_DYNAMIC,
};

#define DEVLINK_SB_THRESHOLD_TO_ALPHA_MAX 20

enum devlink_attr {
	/* don't change the order or add anything between, this is ABI! */
	DEVLINK_ATTR_UNSPEC,

	/* bus name + dev name together are a handle for devlink entity */
	DEVLINK_ATTR_BUS_NAME,			/* string */
	DEVLINK_ATTR_DEV_NAME,			/* string */

	DEVLINK_ATTR_PORT_INDEX,		/* u32 */
	DEVLINK_ATTR_PORT_TYPE,			/* u16 */
	DEVLINK_ATTR_PORT_DESIRED_TYPE,		/* u16 */
	DEVLINK_ATTR_PORT_NETDEV_IFINDEX,	/* u32 */
	DEVLINK_ATTR_PORT_NETDEV_NAME,		/* string */
	DEVLINK_ATTR_PORT_IBDEV_NAME,		/* string */
	DEVLINK_ATTR_PORT_SPLIT_COUNT,		/* u32 */
	DEVLINK_ATTR_PORT_SPLIT_GROUP,		/* u32 */
	DEVLINK_ATTR_SB_INDEX,			/* u32 */
	DEVLINK_ATTR_SB_SIZE,			/* u32 */
	DEVLINK_ATTR_SB_INGRESS_POOL_COUNT,	/* u16 */
	DEVLINK_ATTR_SB_EGRESS_POOL_COUNT,	/* u16 */
	DEVLINK_ATTR_SB_INGRESS_TC_COUNT,	/* u16 */
	DEVLINK_ATTR_SB_EGRESS_TC_COUNT,	/* u16 */
	DEVLINK_ATTR_SB_POOL_INDEX,		/* u16 */
	DEVLINK_ATTR_SB_POOL_TYPE,		/* u8 */
	DEVLINK_ATTR_SB_POOL_SIZE,		/* u32 */
	DEVLINK_ATTR_SB_POOL_THRESHOLD_TYPE,	/* u8 */
	DEVLINK_ATTR_SB_THRESHOLD,		/* u32 */
	DEVLINK_ATTR_SB_TC_INDEX,		/* u16 */
	DEVLINK_ATTR_SB_OCC_CUR,		/* u32 */
	DEVLINK_ATTR_SB_OCC_MAX,		/* u32 */

	/* add new attributes above here, update the policy in devlink.c */

	__DEVLINK_ATTR_MAX,
	DEVLINK_ATTR_MAX = __DEVLINK_ATTR_MAX - 1
};

#endif /* _LINUX_DEVLINK_H_ */
Commit	Line	Data
a3c4b484 JP	1	/*
	2	* include/uapi/linux/devlink.h - Network physical device Netlink interface
	3	* Copyright (c) 2016 Mellanox Technologies. All rights reserved.
	4	* Copyright (c) 2016 Jiri Pirko <jiri@mellanox.com>
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* (at your option) any later version.
	10	*/
	11
8a781d7e SH	12	#ifndef _LINUX_DEVLINK_H_
8a781d7e SH	13	#define _LINUX_DEVLINK_H_
a3c4b484 JP	14
	15	#define DEVLINK_GENL_NAME "devlink"
	16	#define DEVLINK_GENL_VERSION 0x1
	17	#define DEVLINK_GENL_MCGRP_CONFIG_NAME "config"
	18
	19	enum devlink_command {
	20	/* don't change the order or add anything between, this is ABI! */
	21	DEVLINK_CMD_UNSPEC,
	22
	23	DEVLINK_CMD_GET, /* can dump */
	24	DEVLINK_CMD_SET,
	25	DEVLINK_CMD_NEW,
	26	DEVLINK_CMD_DEL,
	27
	28	DEVLINK_CMD_PORT_GET, /* can dump */
	29	DEVLINK_CMD_PORT_SET,
	30	DEVLINK_CMD_PORT_NEW,
	31	DEVLINK_CMD_PORT_DEL,
	32
	33	DEVLINK_CMD_PORT_SPLIT,
	34	DEVLINK_CMD_PORT_UNSPLIT,
	35
0c9ffc0b SH	36	DEVLINK_CMD_SB_GET, /* can dump */
	37	DEVLINK_CMD_SB_SET,
	38	DEVLINK_CMD_SB_NEW,
	39	DEVLINK_CMD_SB_DEL,
	40
	41	DEVLINK_CMD_SB_POOL_GET, /* can dump */
	42	DEVLINK_CMD_SB_POOL_SET,
	43	DEVLINK_CMD_SB_POOL_NEW,
	44	DEVLINK_CMD_SB_POOL_DEL,
	45
	46	DEVLINK_CMD_SB_PORT_POOL_GET, /* can dump */
	47	DEVLINK_CMD_SB_PORT_POOL_SET,
	48	DEVLINK_CMD_SB_PORT_POOL_NEW,
	49	DEVLINK_CMD_SB_PORT_POOL_DEL,
	50
	51	DEVLINK_CMD_SB_TC_POOL_BIND_GET, /* can dump */
	52	DEVLINK_CMD_SB_TC_POOL_BIND_SET,
	53	DEVLINK_CMD_SB_TC_POOL_BIND_NEW,
	54	DEVLINK_CMD_SB_TC_POOL_BIND_DEL,
	55
	56	/* Shared buffer occupancy monitoring commands */
	57	DEVLINK_CMD_SB_OCC_SNAPSHOT,
	58	DEVLINK_CMD_SB_OCC_MAX_CLEAR,
	59
a3c4b484 JP	60	/* add new commands above here */
	61
	62	__DEVLINK_CMD_MAX,
	63	DEVLINK_CMD_MAX = __DEVLINK_CMD_MAX - 1
	64	};
	65
	66	enum devlink_port_type {
	67	DEVLINK_PORT_TYPE_NOTSET,
	68	DEVLINK_PORT_TYPE_AUTO,
	69	DEVLINK_PORT_TYPE_ETH,
	70	DEVLINK_PORT_TYPE_IB,
	71	};
	72
0c9ffc0b SH	73	enum devlink_sb_pool_type {
	74	DEVLINK_SB_POOL_TYPE_INGRESS,
	75	DEVLINK_SB_POOL_TYPE_EGRESS,
	76	};
	77
	78	/* static threshold - limiting the maximum number of bytes.
	79	* dynamic threshold - limiting the maximum number of bytes
	80	* based on the currently available free space in the shared buffer pool.
	81	* In this mode, the maximum quota is calculated based
	82	* on the following formula:
	83	* max_quota = alpha / (1 + alpha) * Free_Buffer
	84	* While Free_Buffer is the amount of none-occupied buffer associated to
	85	* the relevant pool.
	86	* The value range which can be passed is 0-20 and serves
	87	* for computation of alpha by following formula:
	88	* alpha = 2 ^ (passed_value - 10)
	89	*/
	90
	91	enum devlink_sb_threshold_type {
	92	DEVLINK_SB_THRESHOLD_TYPE_STATIC,
	93	DEVLINK_SB_THRESHOLD_TYPE_DYNAMIC,
	94	};
	95
	96	#define DEVLINK_SB_THRESHOLD_TO_ALPHA_MAX 20
	97
a3c4b484 JP	98	enum devlink_attr {
	99	/* don't change the order or add anything between, this is ABI! */
	100	DEVLINK_ATTR_UNSPEC,
	101
	102	/* bus name + dev name together are a handle for devlink entity */
	103	DEVLINK_ATTR_BUS_NAME, /* string */
	104	DEVLINK_ATTR_DEV_NAME, /* string */
	105
	106	DEVLINK_ATTR_PORT_INDEX, /* u32 */
	107	DEVLINK_ATTR_PORT_TYPE, /* u16 */
	108	DEVLINK_ATTR_PORT_DESIRED_TYPE, /* u16 */
	109	DEVLINK_ATTR_PORT_NETDEV_IFINDEX, /* u32 */
	110	DEVLINK_ATTR_PORT_NETDEV_NAME, /* string */
	111	DEVLINK_ATTR_PORT_IBDEV_NAME, /* string */
	112	DEVLINK_ATTR_PORT_SPLIT_COUNT, /* u32 */
	113	DEVLINK_ATTR_PORT_SPLIT_GROUP, /* u32 */
0c9ffc0b SH	114	DEVLINK_ATTR_SB_INDEX, /* u32 */
	115	DEVLINK_ATTR_SB_SIZE, /* u32 */
	116	DEVLINK_ATTR_SB_INGRESS_POOL_COUNT, /* u16 */
	117	DEVLINK_ATTR_SB_EGRESS_POOL_COUNT, /* u16 */
	118	DEVLINK_ATTR_SB_INGRESS_TC_COUNT, /* u16 */
	119	DEVLINK_ATTR_SB_EGRESS_TC_COUNT, /* u16 */
	120	DEVLINK_ATTR_SB_POOL_INDEX, /* u16 */
	121	DEVLINK_ATTR_SB_POOL_TYPE, /* u8 */
	122	DEVLINK_ATTR_SB_POOL_SIZE, /* u32 */
	123	DEVLINK_ATTR_SB_POOL_THRESHOLD_TYPE, /* u8 */
	124	DEVLINK_ATTR_SB_THRESHOLD, /* u32 */
	125	DEVLINK_ATTR_SB_TC_INDEX, /* u16 */
	126	DEVLINK_ATTR_SB_OCC_CUR, /* u32 */
	127	DEVLINK_ATTR_SB_OCC_MAX, /* u32 */
a3c4b484 JP	128
	129	/* add new attributes above here, update the policy in devlink.c */
	130
	131	__DEVLINK_ATTR_MAX,
	132	DEVLINK_ATTR_MAX = __DEVLINK_ATTR_MAX - 1
	133	};
	134
8a781d7e	135	#endif /* _LINUX_DEVLINK_H_ */