xref: /freebsd/contrib/wpa/src/common/qca-vendor.h (revision 193d9e768ba63fcfb187cfd17f461f7d41345048)
1 /*
2  * Qualcomm Atheros OUI and vendor specific assignments
3  * Copyright (c) 2014-2015, Qualcomm Atheros, Inc.
4  *
5  * This software may be distributed under the terms of the BSD license.
6  * See README for more details.
7  */
8 
9 #ifndef QCA_VENDOR_H
10 #define QCA_VENDOR_H
11 
12 /*
13  * This file is a registry of identifier assignments from the Qualcomm Atheros
14  * OUI 00:13:74 for purposes other than MAC address assignment. New identifiers
15  * can be assigned through normal review process for changes to the upstream
16  * hostap.git repository.
17  */
18 
19 #define OUI_QCA 0x001374
20 
21 /**
22  * enum qca_radiotap_vendor_ids - QCA radiotap vendor namespace IDs
23  */
24 enum qca_radiotap_vendor_ids {
25 	QCA_RADIOTAP_VID_WLANTEST = 0,
26 };
27 
28 /**
29  * enum qca_nl80211_vendor_subcmds - QCA nl80211 vendor command identifiers
30  *
31  * @QCA_NL80211_VENDOR_SUBCMD_UNSPEC: Reserved value 0
32  *
33  * @QCA_NL80211_VENDOR_SUBCMD_TEST: Test command/event
34  *
35  * @QCA_NL80211_VENDOR_SUBCMD_ROAMING: Set roaming policy for drivers that use
36  *	internal BSS-selection. This command uses
37  *	@QCA_WLAN_VENDOR_ATTR_ROAMING_POLICY to specify the new roaming policy
38  *	for the current connection (i.e., changes policy set by the nl80211
39  *	Connect command). @QCA_WLAN_VENDOR_ATTR_MAC_ADDR may optionally be
40  *	included to indicate which BSS to use in case roaming is disabled.
41  *
42  * @QCA_NL80211_VENDOR_SUBCMD_AVOID_FREQUENCY: Recommendation of frequency
43  *	ranges to avoid to reduce issues due to interference or internal
44  *	co-existence information in the driver. The event data structure is
45  *	defined in struct qca_avoid_freq_list.
46  *
47  * @QCA_NL80211_VENDOR_SUBCMD_DFS_CAPABILITY: Command to check driver support
48  *	for DFS offloading.
49  *
50  * @QCA_NL80211_VENDOR_SUBCMD_NAN: NAN command/event which is used to pass
51  *	NAN Request/Response and NAN Indication messages. These messages are
52  *	interpreted between the framework and the firmware component.
53  *
54  * @QCA_NL80211_VENDOR_SUBCMD_KEY_MGMT_SET_KEY: Set key operation that can be
55  *	used to configure PMK to the driver even when not connected. This can
56  *	be used to request offloading of key management operations. Only used
57  *	if device supports QCA_WLAN_VENDOR_FEATURE_KEY_MGMT_OFFLOAD.
58  *
59  * @QCA_NL80211_VENDOR_SUBCMD_KEY_MGMT_ROAM_AUTH: An extended version of
60  *	NL80211_CMD_ROAM event with optional attributes including information
61  *	from offloaded key management operation. Uses
62  *	enum qca_wlan_vendor_attr_roam_auth attributes. Only used
63  *	if device supports QCA_WLAN_VENDOR_FEATURE_KEY_MGMT_OFFLOAD.
64  *
65  * @QCA_NL80211_VENDOR_SUBCMD_DO_ACS: ACS command/event which is used to
66  *	invoke the ACS function in device and pass selected channels to
67  *	hostapd.
68  *
69  * @QCA_NL80211_VENDOR_SUBCMD_GET_FEATURES: Command to get the features
70  *	supported by the driver. enum qca_wlan_vendor_features defines
71  *	the possible features.
72  *
73  * @QCA_NL80211_VENDOR_SUBCMD_DFS_OFFLOAD_CAC_STARTED: Event used by driver,
74  *	which supports DFS offloading, to indicate a channel availability check
75  *	start.
76  *
77  * @QCA_NL80211_VENDOR_SUBCMD_DFS_OFFLOAD_CAC_FINISHED: Event used by driver,
78  *	which supports DFS offloading, to indicate a channel availability check
79  *	completion.
80  *
81  * @QCA_NL80211_VENDOR_SUBCMD_DFS_OFFLOAD_CAC_ABORTED: Event used by driver,
82  *	which supports DFS offloading, to indicate that the channel availability
83  *	check aborted, no change to the channel status.
84  *
85  * @QCA_NL80211_VENDOR_SUBCMD_DFS_OFFLOAD_CAC_NOP_FINISHED: Event used by
86  *	driver, which supports DFS offloading, to indicate that the
87  *	Non-Occupancy Period for this channel is over, channel becomes usable.
88  *
89  * @QCA_NL80211_VENDOR_SUBCMD_DFS_OFFLOAD_RADAR_DETECTED: Event used by driver,
90  *	which supports DFS offloading, to indicate a radar pattern has been
91  *	detected. The channel is now unusable.
92  */
93 enum qca_nl80211_vendor_subcmds {
94 	QCA_NL80211_VENDOR_SUBCMD_UNSPEC = 0,
95 	QCA_NL80211_VENDOR_SUBCMD_TEST = 1,
96 	/* subcmds 2..8 not yet allocated */
97 	QCA_NL80211_VENDOR_SUBCMD_ROAMING = 9,
98 	QCA_NL80211_VENDOR_SUBCMD_AVOID_FREQUENCY = 10,
99 	QCA_NL80211_VENDOR_SUBCMD_DFS_CAPABILITY =  11,
100 	QCA_NL80211_VENDOR_SUBCMD_NAN =  12,
101 	QCA_NL80211_VENDOR_SUBMCD_STATS_EXT = 13,
102 	QCA_NL80211_VENDOR_SUBCMD_LL_STATS_SET = 14,
103 	QCA_NL80211_VENDOR_SUBCMD_LL_STATS_GET = 15,
104 	QCA_NL80211_VENDOR_SUBCMD_LL_STATS_CLR = 16,
105 	QCA_NL80211_VENDOR_SUBCMD_LL_STATS_RADIO_RESULTS = 17,
106 	QCA_NL80211_VENDOR_SUBCMD_LL_STATS_IFACE_RESULTS = 18,
107 	QCA_NL80211_VENDOR_SUBCMD_LL_STATS_PEERS_RESULTS = 19,
108 	QCA_NL80211_VENDOR_SUBCMD_GSCAN_START = 20,
109 	QCA_NL80211_VENDOR_SUBCMD_GSCAN_STOP = 21,
110 	QCA_NL80211_VENDOR_SUBCMD_GSCAN_GET_VALID_CHANNELS = 22,
111 	QCA_NL80211_VENDOR_SUBCMD_GSCAN_GET_CAPABILITIES = 23,
112 	QCA_NL80211_VENDOR_SUBCMD_GSCAN_GET_CACHED_RESULTS = 24,
113 	QCA_NL80211_VENDOR_SUBCMD_GSCAN_SCAN_RESULTS_AVAILABLE = 25,
114 	QCA_NL80211_VENDOR_SUBCMD_GSCAN_FULL_SCAN_RESULT = 26,
115 	QCA_NL80211_VENDOR_SUBCMD_GSCAN_SCAN_EVENT = 27,
116 	QCA_NL80211_VENDOR_SUBCMD_GSCAN_HOTLIST_AP_FOUND = 28,
117 	QCA_NL80211_VENDOR_SUBCMD_GSCAN_SET_BSSID_HOTLIST = 29,
118 	QCA_NL80211_VENDOR_SUBCMD_GSCAN_RESET_BSSID_HOTLIST = 30,
119 	QCA_NL80211_VENDOR_SUBCMD_GSCAN_SIGNIFICANT_CHANGE = 31,
120 	QCA_NL80211_VENDOR_SUBCMD_GSCAN_SET_SIGNIFICANT_CHANGE = 32,
121 	QCA_NL80211_VENDOR_SUBCMD_GSCAN_RESET_SIGNIFICANT_CHANGE = 33,
122 	QCA_NL80211_VENDOR_SUBCMD_TDLS_ENABLE = 34,
123 	QCA_NL80211_VENDOR_SUBCMD_TDLS_DISABLE = 35,
124 	QCA_NL80211_VENDOR_SUBCMD_TDLS_GET_STATUS = 36,
125 	QCA_NL80211_VENDOR_SUBCMD_TDLS_STATE = 37,
126 	QCA_NL80211_VENDOR_SUBCMD_GET_SUPPORTED_FEATURES = 38,
127 	QCA_NL80211_VENDOR_SUBCMD_SCANNING_MAC_OUI = 39,
128 	QCA_NL80211_VENDOR_SUBCMD_NO_DFS_FLAG = 40,
129 	QCA_NL80211_VENDOR_SUBCMD_GSCAN_HOTLIST_AP_LOST = 41,
130 	QCA_NL80211_VENDOR_SUBCMD_GET_CONCURRENCY_MATRIX = 42,
131 	/* 43..49 - reserved for QCA */
132 	QCA_NL80211_VENDOR_SUBCMD_KEY_MGMT_SET_KEY = 50,
133 	QCA_NL80211_VENDOR_SUBCMD_KEY_MGMT_ROAM_AUTH = 51,
134 	QCA_NL80211_VENDOR_SUBCMD_APFIND = 52,
135 	/* 53 - reserved - was used by QCA, but not in use anymore */
136 	QCA_NL80211_VENDOR_SUBCMD_DO_ACS = 54,
137 	QCA_NL80211_VENDOR_SUBCMD_GET_FEATURES = 55,
138 	QCA_NL80211_VENDOR_SUBCMD_DFS_OFFLOAD_CAC_STARTED = 56,
139 	QCA_NL80211_VENDOR_SUBCMD_DFS_OFFLOAD_CAC_FINISHED = 57,
140 	QCA_NL80211_VENDOR_SUBCMD_DFS_OFFLOAD_CAC_ABORTED = 58,
141 	QCA_NL80211_VENDOR_SUBCMD_DFS_OFFLOAD_CAC_NOP_FINISHED = 59,
142 	QCA_NL80211_VENDOR_SUBCMD_DFS_OFFLOAD_RADAR_DETECTED = 60,
143 	/* 61-90 - reserved for QCA */
144 	QCA_NL80211_VENDOR_SUBCMD_DATA_OFFLOAD = 91,
145 	QCA_NL80211_VENDOR_SUBCMD_OCB_SET_CONFIG = 92,
146 	QCA_NL80211_VENDOR_SUBCMD_OCB_SET_UTC_TIME = 93,
147 	QCA_NL80211_VENDOR_SUBCMD_OCB_START_TIMING_ADVERT = 94,
148 	QCA_NL80211_VENDOR_SUBCMD_OCB_STOP_TIMING_ADVERT = 95,
149 	QCA_NL80211_VENDOR_SUBCMD_OCB_GET_TSF_TIMER = 96,
150 	QCA_NL80211_VENDOR_SUBCMD_DCC_GET_STATS = 97,
151 	QCA_NL80211_VENDOR_SUBCMD_DCC_CLEAR_STATS = 98,
152 	QCA_NL80211_VENDOR_SUBCMD_DCC_UPDATE_NDL = 99,
153 	QCA_NL80211_VENDOR_SUBCMD_DCC_STATS_EVENT = 100,
154 	QCA_NL80211_VENDOR_SUBCMD_LINK_PROPERTIES = 101,
155 	QCA_NL80211_VENDOR_SUBCMD_GW_PARAM_CONFIG = 102,
156 	QCA_NL80211_VENDOR_SUBCMD_GET_PREFERRED_FREQ_LIST = 103,
157 	QCA_NL80211_VENDOR_SUBCMD_SET_PROBABLE_OPER_CHANNEL = 104,
158 	QCA_NL80211_VENDOR_SUBCMD_SETBAND = 105,
159 };
160 
161 
162 enum qca_wlan_vendor_attr {
163 	QCA_WLAN_VENDOR_ATTR_INVALID = 0,
164 	/* used by QCA_NL80211_VENDOR_SUBCMD_DFS_CAPABILITY */
165 	QCA_WLAN_VENDOR_ATTR_DFS     = 1,
166 	/* used by QCA_NL80211_VENDOR_SUBCMD_NAN */
167 	QCA_WLAN_VENDOR_ATTR_NAN     = 2,
168 	/* used by QCA_NL80211_VENDOR_SUBCMD_STATS_EXT */
169 	QCA_WLAN_VENDOR_ATTR_STATS_EXT     = 3,
170 	/* used by QCA_NL80211_VENDOR_SUBCMD_STATS_EXT */
171 	QCA_WLAN_VENDOR_ATTR_IFINDEX     = 4,
172 	/* used by QCA_NL80211_VENDOR_SUBCMD_ROAMING, u32 with values defined
173 	 * by enum qca_roaming_policy. */
174 	QCA_WLAN_VENDOR_ATTR_ROAMING_POLICY = 5,
175 	QCA_WLAN_VENDOR_ATTR_MAC_ADDR = 6,
176 	/* used by QCA_NL80211_VENDOR_SUBCMD_GET_FEATURES */
177 	QCA_WLAN_VENDOR_ATTR_FEATURE_FLAGS = 7,
178 	QCA_WLAN_VENDOR_ATTR_TEST = 8,
179 	/* used by QCA_NL80211_VENDOR_SUBCMD_GET_FEATURES */
180 	/* Unsigned 32-bit value. */
181 	QCA_WLAN_VENDOR_ATTR_CONCURRENCY_CAPA = 9,
182 	/* Unsigned 32-bit value */
183 	QCA_WLAN_VENDOR_ATTR_MAX_CONCURRENT_CHANNELS_2_4_BAND = 10,
184 	/* Unsigned 32-bit value */
185 	QCA_WLAN_VENDOR_ATTR_MAX_CONCURRENT_CHANNELS_5_0_BAND = 11,
186 	/* Unsigned 32-bit value from enum qca_set_band. */
187 	QCA_WLAN_VENDOR_ATTR_SETBAND_VALUE = 12,
188 	/* keep last */
189 	QCA_WLAN_VENDOR_ATTR_AFTER_LAST,
190 	QCA_WLAN_VENDOR_ATTR_MAX	= QCA_WLAN_VENDOR_ATTR_AFTER_LAST - 1,
191 };
192 
193 
194 enum qca_roaming_policy {
195 	QCA_ROAMING_NOT_ALLOWED,
196 	QCA_ROAMING_ALLOWED_WITHIN_ESS,
197 };
198 
199 enum qca_wlan_vendor_attr_roam_auth {
200 	QCA_WLAN_VENDOR_ATTR_ROAM_AUTH_INVALID = 0,
201 	QCA_WLAN_VENDOR_ATTR_ROAM_AUTH_BSSID,
202 	QCA_WLAN_VENDOR_ATTR_ROAM_AUTH_REQ_IE,
203 	QCA_WLAN_VENDOR_ATTR_ROAM_AUTH_RESP_IE,
204 	QCA_WLAN_VENDOR_ATTR_ROAM_AUTH_AUTHORIZED,
205 	QCA_WLAN_VENDOR_ATTR_ROAM_AUTH_KEY_REPLAY_CTR,
206 	QCA_WLAN_VENDOR_ATTR_ROAM_AUTH_PTK_KCK,
207 	QCA_WLAN_VENDOR_ATTR_ROAM_AUTH_PTK_KEK,
208 	/* keep last */
209 	QCA_WLAN_VENDOR_ATTR_ROAM_AUTH_AFTER_LAST,
210 	QCA_WLAN_VENDOR_ATTR_ROAM_AUTH_MAX =
211 	QCA_WLAN_VENDOR_ATTR_ROAM_AUTH_AFTER_LAST - 1
212 };
213 
214 enum qca_wlan_vendor_attr_acs_offload {
215 	QCA_WLAN_VENDOR_ATTR_ACS_CHANNEL_INVALID = 0,
216 	QCA_WLAN_VENDOR_ATTR_ACS_PRIMARY_CHANNEL,
217 	QCA_WLAN_VENDOR_ATTR_ACS_SECONDARY_CHANNEL,
218 	QCA_WLAN_VENDOR_ATTR_ACS_HW_MODE,
219 	QCA_WLAN_VENDOR_ATTR_ACS_HT_ENABLED,
220 	QCA_WLAN_VENDOR_ATTR_ACS_HT40_ENABLED,
221 	QCA_WLAN_VENDOR_ATTR_ACS_VHT_ENABLED,
222 	QCA_WLAN_VENDOR_ATTR_ACS_CHWIDTH,
223 	QCA_WLAN_VENDOR_ATTR_ACS_CH_LIST,
224 	QCA_WLAN_VENDOR_ATTR_ACS_VHT_SEG0_CENTER_CHANNEL,
225 	QCA_WLAN_VENDOR_ATTR_ACS_VHT_SEG1_CENTER_CHANNEL,
226 	QCA_WLAN_VENDOR_ATTR_ACS_FREQ_LIST,
227 	/* keep last */
228 	QCA_WLAN_VENDOR_ATTR_ACS_AFTER_LAST,
229 	QCA_WLAN_VENDOR_ATTR_ACS_MAX =
230 	QCA_WLAN_VENDOR_ATTR_ACS_AFTER_LAST - 1
231 };
232 
233 enum qca_wlan_vendor_acs_hw_mode {
234 	QCA_ACS_MODE_IEEE80211B,
235 	QCA_ACS_MODE_IEEE80211G,
236 	QCA_ACS_MODE_IEEE80211A,
237 	QCA_ACS_MODE_IEEE80211AD,
238 	QCA_ACS_MODE_IEEE80211ANY,
239 };
240 
241 /**
242  * enum qca_wlan_vendor_features - Vendor device/driver feature flags
243  *
244  * @QCA_WLAN_VENDOR_FEATURE_KEY_MGMT_OFFLOAD: Device supports key
245  *	management offload, a mechanism where the station's firmware
246  *	does the exchange with the AP to establish the temporal keys
247  *	after roaming, rather than having the user space wpa_supplicant do it.
248  * @QCA_WLAN_VENDOR_FEATURE_SUPPORT_HW_MODE_ANY: Device supports automatic
249  *	band selection based on channel selection results.
250  * @NUM_QCA_WLAN_VENDOR_FEATURES: Number of assigned feature bits
251  */
252 enum qca_wlan_vendor_features {
253 	QCA_WLAN_VENDOR_FEATURE_KEY_MGMT_OFFLOAD	= 0,
254 	QCA_WLAN_VENDOR_FEATURE_SUPPORT_HW_MODE_ANY     = 1,
255 	NUM_QCA_WLAN_VENDOR_FEATURES /* keep last */
256 };
257 
258 /**
259  * enum qca_wlan_vendor_attr_data_offload_ind - Vendor Data Offload Indication
260  *
261  * @QCA_WLAN_VENDOR_ATTR_DATA_OFFLOAD_IND_SESSION: Session corresponding to
262  *	the offloaded data.
263  * @QCA_WLAN_VENDOR_ATTR_DATA_OFFLOAD_IND_PROTOCOL: Protocol of the offloaded
264  *	data.
265  * @QCA_WLAN_VENDOR_ATTR_DATA_OFFLOAD_IND_EVENT: Event type for the data offload
266  *	indication.
267  */
268 enum qca_wlan_vendor_attr_data_offload_ind {
269 	QCA_WLAN_VENDOR_ATTR_DATA_OFFLOAD_IND_INVALID = 0,
270 	QCA_WLAN_VENDOR_ATTR_DATA_OFFLOAD_IND_SESSION,
271 	QCA_WLAN_VENDOR_ATTR_DATA_OFFLOAD_IND_PROTOCOL,
272 	QCA_WLAN_VENDOR_ATTR_DATA_OFFLOAD_IND_EVENT,
273 
274 	/* keep last */
275 	QCA_WLAN_VENDOR_ATTR_DATA_OFFLOAD_IND_AFTER_LAST,
276 	QCA_WLAN_VENDOR_ATTR_DATA_OFFLOAD_IND_MAX =
277 	QCA_WLAN_VENDOR_ATTR_DATA_OFFLOAD_IND_AFTER_LAST - 1
278 };
279 
280 enum qca_vendor_attr_get_preferred_freq_list {
281 	QCA_WLAN_VENDOR_ATTR_GET_PREFERRED_FREQ_LIST_INVALID,
282 	/* A 32-unsigned value; the interface type/mode for which the preferred
283 	 * frequency list is requested (see enum qca_iface_type for possible
284 	 * values); used in GET_PREFERRED_FREQ_LIST command from user-space to
285 	 * kernel and in the kernel response back to user-space.
286 	 */
287 	QCA_WLAN_VENDOR_ATTR_GET_PREFERRED_FREQ_LIST_IFACE_TYPE,
288 	/* An array of 32-unsigned values; values are frequency (MHz); sent
289 	 * from kernel space to user space.
290 	 */
291 	QCA_WLAN_VENDOR_ATTR_GET_PREFERRED_FREQ_LIST,
292 	/* keep last */
293 	QCA_WLAN_VENDOR_ATTR_GET_PREFERRED_FREQ_LIST_AFTER_LAST,
294 	QCA_WLAN_VENDOR_ATTR_GET_PREFERRED_FREQ_LIST_MAX =
295 	QCA_WLAN_VENDOR_ATTR_GET_PREFERRED_FREQ_LIST_AFTER_LAST - 1
296 };
297 
298 enum qca_vendor_attr_probable_oper_channel {
299 	QCA_WLAN_VENDOR_ATTR_PROBABLE_OPER_CHANNEL_INVALID,
300 	/* 32-bit unsigned value; indicates the connection/iface type likely to
301 	 * come on this channel (see enum qca_iface_type).
302 	 */
303 	QCA_WLAN_VENDOR_ATTR_PROBABLE_OPER_CHANNEL_IFACE_TYPE,
304 	/* 32-bit unsigned value; the frequency (MHz) of the probable channel */
305 	QCA_WLAN_VENDOR_ATTR_PROBABLE_OPER_CHANNEL_FREQ,
306 	/* keep last */
307 	QCA_WLAN_VENDOR_ATTR_PROBABLE_OPER_CHANNEL_AFTER_LAST,
308 	QCA_WLAN_VENDOR_ATTR_PROBABLE_OPER_CHANNEL_MAX =
309 	QCA_WLAN_VENDOR_ATTR_PROBABLE_OPER_CHANNEL_AFTER_LAST - 1
310 };
311 
312 enum qca_iface_type {
313 	QCA_IFACE_TYPE_STA,
314 	QCA_IFACE_TYPE_AP,
315 	QCA_IFACE_TYPE_P2P_CLIENT,
316 	QCA_IFACE_TYPE_P2P_GO,
317 	QCA_IFACE_TYPE_IBSS,
318 	QCA_IFACE_TYPE_TDLS,
319 };
320 
321 enum qca_set_band {
322 	QCA_SETBAND_AUTO,
323 	QCA_SETBAND_5G,
324 	QCA_SETBAND_2G,
325 };
326 
327 /* IEEE 802.11 Vendor Specific elements */
328 
329 /**
330  * enum qca_vendor_element_id - QCA Vendor Specific element types
331  *
332  * These values are used to identify QCA Vendor Specific elements. The
333  * payload of the element starts with the three octet OUI (OUI_QCA) and
334  * is followed by a single octet type which is defined by this enum.
335  *
336  * @QCA_VENDOR_ELEM_P2P_PREF_CHAN_LIST: P2P preferred channel list.
337  *	This element can be used to specify preference order for supported
338  *	channels. The channels in this list are in preference order (the first
339  *	one has the highest preference) and are described as a pair of
340  *	(global) Operating Class and Channel Number (each one octet) fields.
341  *
342  *	This extends the standard P2P functionality by providing option to have
343  *	more than one preferred operating channel. When this element is present,
344  *	it replaces the preference indicated in the Operating Channel attribute.
345  *	For supporting other implementations, the Operating Channel attribute is
346  *	expected to be used with the highest preference channel. Similarly, all
347  *	the channels included in this Preferred channel list element are
348  *	expected to be included in the Channel List attribute.
349  *
350  *	This vendor element may be included in GO Negotiation Request, P2P
351  *	Invitation Request, and Provision Discovery Request frames.
352  */
353 enum qca_vendor_element_id {
354 	QCA_VENDOR_ELEM_P2P_PREF_CHAN_LIST = 0,
355 };
356 
357 #endif /* QCA_VENDOR_H */
358