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 <<
27 * Requires NCSI_ATTR_IFINDEX, NCSI_ATTR_ <<
28 * and NCSI_ATTR_CHANNEL_ID. <<
29 * @NCSI_CMD_SET_PACKAGE_MASK: set a whitelist <<
30 * Requires NCSI_ATTR_IFINDEX and NCSI_AT <<
31 * @NCSI_CMD_SET_CHANNEL_MASK: set a whitelist <<
32 * Requires NCSI_ATTR_IFINDEX, NCSI_ATTR_ <<
33 * NCSI_ATTR_CHANNEL_MASK. If NCSI_ATTR_C <<
34 * the primary channel. <<
35 * @NCSI_CMD_MAX: highest command number 26 * @NCSI_CMD_MAX: highest command number
36 */ 27 */
37 enum ncsi_nl_commands { 28 enum ncsi_nl_commands {
38 NCSI_CMD_UNSPEC, 29 NCSI_CMD_UNSPEC,
39 NCSI_CMD_PKG_INFO, 30 NCSI_CMD_PKG_INFO,
40 NCSI_CMD_SET_INTERFACE, 31 NCSI_CMD_SET_INTERFACE,
41 NCSI_CMD_CLEAR_INTERFACE, 32 NCSI_CMD_CLEAR_INTERFACE,
42 NCSI_CMD_SEND_CMD, <<
43 NCSI_CMD_SET_PACKAGE_MASK, <<
44 NCSI_CMD_SET_CHANNEL_MASK, <<
45 33
46 __NCSI_CMD_AFTER_LAST, 34 __NCSI_CMD_AFTER_LAST,
47 NCSI_CMD_MAX = __NCSI_CMD_AFTER_LAST - 35 NCSI_CMD_MAX = __NCSI_CMD_AFTER_LAST - 1
48 }; 36 };
49 37
50 /** 38 /**
51 * enum ncsi_nl_attrs - General NCSI netlink a 39 * enum ncsi_nl_attrs - General NCSI netlink attributes
52 * 40 *
53 * @NCSI_ATTR_UNSPEC: unspecified attributes t 41 * @NCSI_ATTR_UNSPEC: unspecified attributes to catch errors
54 * @NCSI_ATTR_IFINDEX: ifindex of network devi 42 * @NCSI_ATTR_IFINDEX: ifindex of network device using NCSI
55 * @NCSI_ATTR_PACKAGE_LIST: nested array of NC 43 * @NCSI_ATTR_PACKAGE_LIST: nested array of NCSI_PKG_ATTR attributes
56 * @NCSI_ATTR_PACKAGE_ID: package ID 44 * @NCSI_ATTR_PACKAGE_ID: package ID
57 * @NCSI_ATTR_CHANNEL_ID: channel ID 45 * @NCSI_ATTR_CHANNEL_ID: channel ID
58 * @NCSI_ATTR_DATA: command payload <<
59 * @NCSI_ATTR_MULTI_FLAG: flag to signal that <<
60 * NCSI_CMD_SET_PACKAGE_MASK or NCSI_CMD_ <<
61 * @NCSI_ATTR_PACKAGE_MASK: 32-bit mask of all <<
62 * @NCSI_ATTR_CHANNEL_MASK: 32-bit mask of all <<
63 * @NCSI_ATTR_MAX: highest attribute number 46 * @NCSI_ATTR_MAX: highest attribute number
64 */ 47 */
65 enum ncsi_nl_attrs { 48 enum ncsi_nl_attrs {
66 NCSI_ATTR_UNSPEC, 49 NCSI_ATTR_UNSPEC,
67 NCSI_ATTR_IFINDEX, 50 NCSI_ATTR_IFINDEX,
68 NCSI_ATTR_PACKAGE_LIST, 51 NCSI_ATTR_PACKAGE_LIST,
69 NCSI_ATTR_PACKAGE_ID, 52 NCSI_ATTR_PACKAGE_ID,
70 NCSI_ATTR_CHANNEL_ID, 53 NCSI_ATTR_CHANNEL_ID,
71 NCSI_ATTR_DATA, <<
72 NCSI_ATTR_MULTI_FLAG, <<
73 NCSI_ATTR_PACKAGE_MASK, <<
74 NCSI_ATTR_CHANNEL_MASK, <<
75 54
76 __NCSI_ATTR_AFTER_LAST, 55 __NCSI_ATTR_AFTER_LAST,
77 NCSI_ATTR_MAX = __NCSI_ATTR_AFTER_LAST 56 NCSI_ATTR_MAX = __NCSI_ATTR_AFTER_LAST - 1
78 }; 57 };
79 58
80 /** 59 /**
81 * enum ncsi_nl_pkg_attrs - NCSI netlink packa 60 * enum ncsi_nl_pkg_attrs - NCSI netlink package-specific attributes
82 * 61 *
83 * @NCSI_PKG_ATTR_UNSPEC: unspecified attribut 62 * @NCSI_PKG_ATTR_UNSPEC: unspecified attributes to catch errors
84 * @NCSI_PKG_ATTR: nested array of package att 63 * @NCSI_PKG_ATTR: nested array of package attributes
85 * @NCSI_PKG_ATTR_ID: package ID 64 * @NCSI_PKG_ATTR_ID: package ID
86 * @NCSI_PKG_ATTR_FORCED: flag signifying a pa 65 * @NCSI_PKG_ATTR_FORCED: flag signifying a package has been set as preferred
87 * @NCSI_PKG_ATTR_CHANNEL_LIST: nested array o 66 * @NCSI_PKG_ATTR_CHANNEL_LIST: nested array of NCSI_CHANNEL_ATTR attributes
88 * @NCSI_PKG_ATTR_MAX: highest attribute numbe 67 * @NCSI_PKG_ATTR_MAX: highest attribute number
89 */ 68 */
90 enum ncsi_nl_pkg_attrs { 69 enum ncsi_nl_pkg_attrs {
91 NCSI_PKG_ATTR_UNSPEC, 70 NCSI_PKG_ATTR_UNSPEC,
92 NCSI_PKG_ATTR, 71 NCSI_PKG_ATTR,
93 NCSI_PKG_ATTR_ID, 72 NCSI_PKG_ATTR_ID,
94 NCSI_PKG_ATTR_FORCED, 73 NCSI_PKG_ATTR_FORCED,
95 NCSI_PKG_ATTR_CHANNEL_LIST, 74 NCSI_PKG_ATTR_CHANNEL_LIST,
96 75
97 __NCSI_PKG_ATTR_AFTER_LAST, 76 __NCSI_PKG_ATTR_AFTER_LAST,
98 NCSI_PKG_ATTR_MAX = __NCSI_PKG_ATTR_AF 77 NCSI_PKG_ATTR_MAX = __NCSI_PKG_ATTR_AFTER_LAST - 1
99 }; 78 };
100 79
101 /** 80 /**
102 * enum ncsi_nl_channel_attrs - NCSI netlink c 81 * enum ncsi_nl_channel_attrs - NCSI netlink channel-specific attributes
103 * 82 *
104 * @NCSI_CHANNEL_ATTR_UNSPEC: unspecified attr 83 * @NCSI_CHANNEL_ATTR_UNSPEC: unspecified attributes to catch errors
105 * @NCSI_CHANNEL_ATTR: nested array of channel 84 * @NCSI_CHANNEL_ATTR: nested array of channel attributes
106 * @NCSI_CHANNEL_ATTR_ID: channel ID 85 * @NCSI_CHANNEL_ATTR_ID: channel ID
107 * @NCSI_CHANNEL_ATTR_VERSION_MAJOR: channel m 86 * @NCSI_CHANNEL_ATTR_VERSION_MAJOR: channel major version number
108 * @NCSI_CHANNEL_ATTR_VERSION_MINOR: channel m 87 * @NCSI_CHANNEL_ATTR_VERSION_MINOR: channel minor version number
109 * @NCSI_CHANNEL_ATTR_VERSION_STR: channel ver 88 * @NCSI_CHANNEL_ATTR_VERSION_STR: channel version string
110 * @NCSI_CHANNEL_ATTR_LINK_STATE: channel link 89 * @NCSI_CHANNEL_ATTR_LINK_STATE: channel link state flags
111 * @NCSI_CHANNEL_ATTR_ACTIVE: channels with th 90 * @NCSI_CHANNEL_ATTR_ACTIVE: channels with this flag are in
112 * NCSI_CHANNEL_ACTIVE state 91 * NCSI_CHANNEL_ACTIVE state
113 * @NCSI_CHANNEL_ATTR_FORCED: flag signifying 92 * @NCSI_CHANNEL_ATTR_FORCED: flag signifying a channel has been set as
114 * preferred 93 * preferred
115 * @NCSI_CHANNEL_ATTR_VLAN_LIST: nested array 94 * @NCSI_CHANNEL_ATTR_VLAN_LIST: nested array of NCSI_CHANNEL_ATTR_VLAN_IDs
116 * @NCSI_CHANNEL_ATTR_VLAN_ID: VLAN ID being f 95 * @NCSI_CHANNEL_ATTR_VLAN_ID: VLAN ID being filtered on this channel
117 * @NCSI_CHANNEL_ATTR_MAX: highest attribute n 96 * @NCSI_CHANNEL_ATTR_MAX: highest attribute number
118 */ 97 */
119 enum ncsi_nl_channel_attrs { 98 enum ncsi_nl_channel_attrs {
120 NCSI_CHANNEL_ATTR_UNSPEC, 99 NCSI_CHANNEL_ATTR_UNSPEC,
121 NCSI_CHANNEL_ATTR, 100 NCSI_CHANNEL_ATTR,
122 NCSI_CHANNEL_ATTR_ID, 101 NCSI_CHANNEL_ATTR_ID,
123 NCSI_CHANNEL_ATTR_VERSION_MAJOR, 102 NCSI_CHANNEL_ATTR_VERSION_MAJOR,
124 NCSI_CHANNEL_ATTR_VERSION_MINOR, 103 NCSI_CHANNEL_ATTR_VERSION_MINOR,
125 NCSI_CHANNEL_ATTR_VERSION_STR, 104 NCSI_CHANNEL_ATTR_VERSION_STR,
126 NCSI_CHANNEL_ATTR_LINK_STATE, 105 NCSI_CHANNEL_ATTR_LINK_STATE,
127 NCSI_CHANNEL_ATTR_ACTIVE, 106 NCSI_CHANNEL_ATTR_ACTIVE,
128 NCSI_CHANNEL_ATTR_FORCED, 107 NCSI_CHANNEL_ATTR_FORCED,
129 NCSI_CHANNEL_ATTR_VLAN_LIST, 108 NCSI_CHANNEL_ATTR_VLAN_LIST,
130 NCSI_CHANNEL_ATTR_VLAN_ID, 109 NCSI_CHANNEL_ATTR_VLAN_ID,
131 110
132 __NCSI_CHANNEL_ATTR_AFTER_LAST, 111 __NCSI_CHANNEL_ATTR_AFTER_LAST,
133 NCSI_CHANNEL_ATTR_MAX = __NCSI_CHANNEL 112 NCSI_CHANNEL_ATTR_MAX = __NCSI_CHANNEL_ATTR_AFTER_LAST - 1
134 }; 113 };
135 114
136 #endif /* __UAPI_NCSI_NETLINK_H__ */ 115 #endif /* __UAPI_NCSI_NETLINK_H__ */
137 116
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.