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