1 /* 1 /*
2 * Copyright Samuel Mendoza-Jonas, IBM Corpora 2 * Copyright Samuel Mendoza-Jonas, IBM Corporation 2018.
3 * 3 *
4 * This program is free software; you can redi 4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Publi 5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either versio 6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version. 7 * (at your option) any later version.
8 */ 8 */
9 9
10 #ifndef __UAPI_NCSI_NETLINK_H__ 10 #ifndef __UAPI_NCSI_NETLINK_H__
11 #define __UAPI_NCSI_NETLINK_H__ 11 #define __UAPI_NCSI_NETLINK_H__
12 12
13 /** 13 /**
14 * enum ncsi_nl_commands - supported NCSI comm 14 * enum ncsi_nl_commands - supported NCSI commands
15 * 15 *
16 * @NCSI_CMD_UNSPEC: unspecified command to ca 16 * @NCSI_CMD_UNSPEC: unspecified command to catch errors
17 * @NCSI_CMD_PKG_INFO: list package and channe 17 * @NCSI_CMD_PKG_INFO: list package and channel attributes. Requires
18 * NCSI_ATTR_IFINDEX. If NCSI_ATTR_PACKAG 18 * NCSI_ATTR_IFINDEX. If NCSI_ATTR_PACKAGE_ID is specified returns the
19 * specific package and its channels - ot 19 * specific package and its channels - otherwise a dump request returns
20 * all packages and their associated chan 20 * all packages and their associated channels.
21 * @NCSI_CMD_SET_INTERFACE: set preferred pack 21 * @NCSI_CMD_SET_INTERFACE: set preferred package and channel combination.
22 * Requires NCSI_ATTR_IFINDEX and the pre 22 * Requires NCSI_ATTR_IFINDEX and the preferred NCSI_ATTR_PACKAGE_ID and
23 * optionally the preferred NCSI_ATTR_CHA 23 * optionally the preferred NCSI_ATTR_CHANNEL_ID.
24 * @NCSI_CMD_CLEAR_INTERFACE: clear any prefer 24 * @NCSI_CMD_CLEAR_INTERFACE: clear any preferred package/channel combination.
25 * Requires NCSI_ATTR_IFINDEX. 25 * Requires NCSI_ATTR_IFINDEX.
26 * @NCSI_CMD_SEND_CMD: send NC-SI command to n 26 * @NCSI_CMD_SEND_CMD: send NC-SI command to network card.
27 * Requires NCSI_ATTR_IFINDEX, NCSI_ATTR_ 27 * Requires NCSI_ATTR_IFINDEX, NCSI_ATTR_PACKAGE_ID
28 * and NCSI_ATTR_CHANNEL_ID. 28 * and NCSI_ATTR_CHANNEL_ID.
29 * @NCSI_CMD_SET_PACKAGE_MASK: set a whitelist 29 * @NCSI_CMD_SET_PACKAGE_MASK: set a whitelist of allowed packages.
30 * Requires NCSI_ATTR_IFINDEX and NCSI_AT 30 * Requires NCSI_ATTR_IFINDEX and NCSI_ATTR_PACKAGE_MASK.
31 * @NCSI_CMD_SET_CHANNEL_MASK: set a whitelist 31 * @NCSI_CMD_SET_CHANNEL_MASK: set a whitelist of allowed channels.
32 * Requires NCSI_ATTR_IFINDEX, NCSI_ATTR_ 32 * Requires NCSI_ATTR_IFINDEX, NCSI_ATTR_PACKAGE_ID, and
33 * NCSI_ATTR_CHANNEL_MASK. If NCSI_ATTR_C 33 * NCSI_ATTR_CHANNEL_MASK. If NCSI_ATTR_CHANNEL_ID is present it sets
34 * the primary channel. 34 * the primary channel.
35 * @NCSI_CMD_MAX: highest command number 35 * @NCSI_CMD_MAX: highest command number
36 */ 36 */
37 enum ncsi_nl_commands { 37 enum ncsi_nl_commands {
38 NCSI_CMD_UNSPEC, 38 NCSI_CMD_UNSPEC,
39 NCSI_CMD_PKG_INFO, 39 NCSI_CMD_PKG_INFO,
40 NCSI_CMD_SET_INTERFACE, 40 NCSI_CMD_SET_INTERFACE,
41 NCSI_CMD_CLEAR_INTERFACE, 41 NCSI_CMD_CLEAR_INTERFACE,
42 NCSI_CMD_SEND_CMD, 42 NCSI_CMD_SEND_CMD,
43 NCSI_CMD_SET_PACKAGE_MASK, 43 NCSI_CMD_SET_PACKAGE_MASK,
44 NCSI_CMD_SET_CHANNEL_MASK, 44 NCSI_CMD_SET_CHANNEL_MASK,
45 45
46 __NCSI_CMD_AFTER_LAST, 46 __NCSI_CMD_AFTER_LAST,
47 NCSI_CMD_MAX = __NCSI_CMD_AFTER_LAST - 47 NCSI_CMD_MAX = __NCSI_CMD_AFTER_LAST - 1
48 }; 48 };
49 49
50 /** 50 /**
51 * enum ncsi_nl_attrs - General NCSI netlink a 51 * enum ncsi_nl_attrs - General NCSI netlink attributes
52 * 52 *
53 * @NCSI_ATTR_UNSPEC: unspecified attributes t 53 * @NCSI_ATTR_UNSPEC: unspecified attributes to catch errors
54 * @NCSI_ATTR_IFINDEX: ifindex of network devi 54 * @NCSI_ATTR_IFINDEX: ifindex of network device using NCSI
55 * @NCSI_ATTR_PACKAGE_LIST: nested array of NC 55 * @NCSI_ATTR_PACKAGE_LIST: nested array of NCSI_PKG_ATTR attributes
56 * @NCSI_ATTR_PACKAGE_ID: package ID 56 * @NCSI_ATTR_PACKAGE_ID: package ID
57 * @NCSI_ATTR_CHANNEL_ID: channel ID 57 * @NCSI_ATTR_CHANNEL_ID: channel ID
58 * @NCSI_ATTR_DATA: command payload 58 * @NCSI_ATTR_DATA: command payload
59 * @NCSI_ATTR_MULTI_FLAG: flag to signal that 59 * @NCSI_ATTR_MULTI_FLAG: flag to signal that multi-mode should be enabled with
60 * NCSI_CMD_SET_PACKAGE_MASK or NCSI_CMD_ 60 * NCSI_CMD_SET_PACKAGE_MASK or NCSI_CMD_SET_CHANNEL_MASK.
61 * @NCSI_ATTR_PACKAGE_MASK: 32-bit mask of all 61 * @NCSI_ATTR_PACKAGE_MASK: 32-bit mask of allowed packages.
62 * @NCSI_ATTR_CHANNEL_MASK: 32-bit mask of all 62 * @NCSI_ATTR_CHANNEL_MASK: 32-bit mask of allowed channels.
63 * @NCSI_ATTR_MAX: highest attribute number 63 * @NCSI_ATTR_MAX: highest attribute number
64 */ 64 */
65 enum ncsi_nl_attrs { 65 enum ncsi_nl_attrs {
66 NCSI_ATTR_UNSPEC, 66 NCSI_ATTR_UNSPEC,
67 NCSI_ATTR_IFINDEX, 67 NCSI_ATTR_IFINDEX,
68 NCSI_ATTR_PACKAGE_LIST, 68 NCSI_ATTR_PACKAGE_LIST,
69 NCSI_ATTR_PACKAGE_ID, 69 NCSI_ATTR_PACKAGE_ID,
70 NCSI_ATTR_CHANNEL_ID, 70 NCSI_ATTR_CHANNEL_ID,
71 NCSI_ATTR_DATA, 71 NCSI_ATTR_DATA,
72 NCSI_ATTR_MULTI_FLAG, 72 NCSI_ATTR_MULTI_FLAG,
73 NCSI_ATTR_PACKAGE_MASK, 73 NCSI_ATTR_PACKAGE_MASK,
74 NCSI_ATTR_CHANNEL_MASK, 74 NCSI_ATTR_CHANNEL_MASK,
75 75
76 __NCSI_ATTR_AFTER_LAST, 76 __NCSI_ATTR_AFTER_LAST,
77 NCSI_ATTR_MAX = __NCSI_ATTR_AFTER_LAST 77 NCSI_ATTR_MAX = __NCSI_ATTR_AFTER_LAST - 1
78 }; 78 };
79 79
80 /** 80 /**
81 * enum ncsi_nl_pkg_attrs - NCSI netlink packa 81 * enum ncsi_nl_pkg_attrs - NCSI netlink package-specific attributes
82 * 82 *
83 * @NCSI_PKG_ATTR_UNSPEC: unspecified attribut 83 * @NCSI_PKG_ATTR_UNSPEC: unspecified attributes to catch errors
84 * @NCSI_PKG_ATTR: nested array of package att 84 * @NCSI_PKG_ATTR: nested array of package attributes
85 * @NCSI_PKG_ATTR_ID: package ID 85 * @NCSI_PKG_ATTR_ID: package ID
86 * @NCSI_PKG_ATTR_FORCED: flag signifying a pa 86 * @NCSI_PKG_ATTR_FORCED: flag signifying a package has been set as preferred
87 * @NCSI_PKG_ATTR_CHANNEL_LIST: nested array o 87 * @NCSI_PKG_ATTR_CHANNEL_LIST: nested array of NCSI_CHANNEL_ATTR attributes
88 * @NCSI_PKG_ATTR_MAX: highest attribute numbe 88 * @NCSI_PKG_ATTR_MAX: highest attribute number
89 */ 89 */
90 enum ncsi_nl_pkg_attrs { 90 enum ncsi_nl_pkg_attrs {
91 NCSI_PKG_ATTR_UNSPEC, 91 NCSI_PKG_ATTR_UNSPEC,
92 NCSI_PKG_ATTR, 92 NCSI_PKG_ATTR,
93 NCSI_PKG_ATTR_ID, 93 NCSI_PKG_ATTR_ID,
94 NCSI_PKG_ATTR_FORCED, 94 NCSI_PKG_ATTR_FORCED,
95 NCSI_PKG_ATTR_CHANNEL_LIST, 95 NCSI_PKG_ATTR_CHANNEL_LIST,
96 96
97 __NCSI_PKG_ATTR_AFTER_LAST, 97 __NCSI_PKG_ATTR_AFTER_LAST,
98 NCSI_PKG_ATTR_MAX = __NCSI_PKG_ATTR_AF 98 NCSI_PKG_ATTR_MAX = __NCSI_PKG_ATTR_AFTER_LAST - 1
99 }; 99 };
100 100
101 /** 101 /**
102 * enum ncsi_nl_channel_attrs - NCSI netlink c 102 * enum ncsi_nl_channel_attrs - NCSI netlink channel-specific attributes
103 * 103 *
104 * @NCSI_CHANNEL_ATTR_UNSPEC: unspecified attr 104 * @NCSI_CHANNEL_ATTR_UNSPEC: unspecified attributes to catch errors
105 * @NCSI_CHANNEL_ATTR: nested array of channel 105 * @NCSI_CHANNEL_ATTR: nested array of channel attributes
106 * @NCSI_CHANNEL_ATTR_ID: channel ID 106 * @NCSI_CHANNEL_ATTR_ID: channel ID
107 * @NCSI_CHANNEL_ATTR_VERSION_MAJOR: channel m 107 * @NCSI_CHANNEL_ATTR_VERSION_MAJOR: channel major version number
108 * @NCSI_CHANNEL_ATTR_VERSION_MINOR: channel m 108 * @NCSI_CHANNEL_ATTR_VERSION_MINOR: channel minor version number
109 * @NCSI_CHANNEL_ATTR_VERSION_STR: channel ver 109 * @NCSI_CHANNEL_ATTR_VERSION_STR: channel version string
110 * @NCSI_CHANNEL_ATTR_LINK_STATE: channel link 110 * @NCSI_CHANNEL_ATTR_LINK_STATE: channel link state flags
111 * @NCSI_CHANNEL_ATTR_ACTIVE: channels with th 111 * @NCSI_CHANNEL_ATTR_ACTIVE: channels with this flag are in
112 * NCSI_CHANNEL_ACTIVE state 112 * NCSI_CHANNEL_ACTIVE state
113 * @NCSI_CHANNEL_ATTR_FORCED: flag signifying 113 * @NCSI_CHANNEL_ATTR_FORCED: flag signifying a channel has been set as
114 * preferred 114 * preferred
115 * @NCSI_CHANNEL_ATTR_VLAN_LIST: nested array 115 * @NCSI_CHANNEL_ATTR_VLAN_LIST: nested array of NCSI_CHANNEL_ATTR_VLAN_IDs
116 * @NCSI_CHANNEL_ATTR_VLAN_ID: VLAN ID being f 116 * @NCSI_CHANNEL_ATTR_VLAN_ID: VLAN ID being filtered on this channel
117 * @NCSI_CHANNEL_ATTR_MAX: highest attribute n 117 * @NCSI_CHANNEL_ATTR_MAX: highest attribute number
118 */ 118 */
119 enum ncsi_nl_channel_attrs { 119 enum ncsi_nl_channel_attrs {
120 NCSI_CHANNEL_ATTR_UNSPEC, 120 NCSI_CHANNEL_ATTR_UNSPEC,
121 NCSI_CHANNEL_ATTR, 121 NCSI_CHANNEL_ATTR,
122 NCSI_CHANNEL_ATTR_ID, 122 NCSI_CHANNEL_ATTR_ID,
123 NCSI_CHANNEL_ATTR_VERSION_MAJOR, 123 NCSI_CHANNEL_ATTR_VERSION_MAJOR,
124 NCSI_CHANNEL_ATTR_VERSION_MINOR, 124 NCSI_CHANNEL_ATTR_VERSION_MINOR,
125 NCSI_CHANNEL_ATTR_VERSION_STR, 125 NCSI_CHANNEL_ATTR_VERSION_STR,
126 NCSI_CHANNEL_ATTR_LINK_STATE, 126 NCSI_CHANNEL_ATTR_LINK_STATE,
127 NCSI_CHANNEL_ATTR_ACTIVE, 127 NCSI_CHANNEL_ATTR_ACTIVE,
128 NCSI_CHANNEL_ATTR_FORCED, 128 NCSI_CHANNEL_ATTR_FORCED,
129 NCSI_CHANNEL_ATTR_VLAN_LIST, 129 NCSI_CHANNEL_ATTR_VLAN_LIST,
130 NCSI_CHANNEL_ATTR_VLAN_ID, 130 NCSI_CHANNEL_ATTR_VLAN_ID,
131 131
132 __NCSI_CHANNEL_ATTR_AFTER_LAST, 132 __NCSI_CHANNEL_ATTR_AFTER_LAST,
133 NCSI_CHANNEL_ATTR_MAX = __NCSI_CHANNEL 133 NCSI_CHANNEL_ATTR_MAX = __NCSI_CHANNEL_ATTR_AFTER_LAST - 1
134 }; 134 };
135 135
136 #endif /* __UAPI_NCSI_NETLINK_H__ */ 136 #endif /* __UAPI_NCSI_NETLINK_H__ */
137 137
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.