xref: /openbmc/linux/drivers/net/wireless/st/cw1200/wsm.h (revision 63705da3)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * WSM host interface (HI) interface for ST-Ericsson CW1200 mac80211 drivers
4  *
5  * Copyright (c) 2010, ST-Ericsson
6  * Author: Dmitry Tarnyagin <dmitry.tarnyagin@lockless.no>
7  *
8  * Based on CW1200 UMAC WSM API, which is
9  * Copyright (C) ST-Ericsson SA 2010
10  * Author: Stewart Mathers <stewart.mathers@stericsson.com>
11  */
12 
13 #ifndef CW1200_WSM_H_INCLUDED
14 #define CW1200_WSM_H_INCLUDED
15 
16 #include <linux/spinlock.h>
17 
18 struct cw1200_common;
19 
20 /* Bands */
21 /* Radio band 2.412 -2.484 GHz. */
22 #define WSM_PHY_BAND_2_4G		(0)
23 
24 /* Radio band 4.9375-5.8250 GHz. */
25 #define WSM_PHY_BAND_5G			(1)
26 
27 /* Transmit rates */
28 /* 1   Mbps            ERP-DSSS */
29 #define WSM_TRANSMIT_RATE_1		(0)
30 
31 /* 2   Mbps            ERP-DSSS */
32 #define WSM_TRANSMIT_RATE_2		(1)
33 
34 /* 5.5 Mbps            ERP-CCK */
35 #define WSM_TRANSMIT_RATE_5		(2)
36 
37 /* 11  Mbps            ERP-CCK */
38 #define WSM_TRANSMIT_RATE_11		(3)
39 
40 /* 22  Mbps            ERP-PBCC (Not supported) */
41 /* #define WSM_TRANSMIT_RATE_22		(4) */
42 
43 /* 33  Mbps            ERP-PBCC (Not supported) */
44 /* #define WSM_TRANSMIT_RATE_33		(5) */
45 
46 /* 6   Mbps   (3 Mbps) ERP-OFDM, BPSK coding rate 1/2 */
47 #define WSM_TRANSMIT_RATE_6		(6)
48 
49 /* 9   Mbps (4.5 Mbps) ERP-OFDM, BPSK coding rate 3/4 */
50 #define WSM_TRANSMIT_RATE_9		(7)
51 
52 /* 12  Mbps  (6 Mbps)  ERP-OFDM, QPSK coding rate 1/2 */
53 #define WSM_TRANSMIT_RATE_12		(8)
54 
55 /* 18  Mbps  (9 Mbps)  ERP-OFDM, QPSK coding rate 3/4 */
56 #define WSM_TRANSMIT_RATE_18		(9)
57 
58 /* 24  Mbps (12 Mbps)  ERP-OFDM, 16QAM coding rate 1/2 */
59 #define WSM_TRANSMIT_RATE_24		(10)
60 
61 /* 36  Mbps (18 Mbps)  ERP-OFDM, 16QAM coding rate 3/4 */
62 #define WSM_TRANSMIT_RATE_36		(11)
63 
64 /* 48  Mbps (24 Mbps)  ERP-OFDM, 64QAM coding rate 1/2 */
65 #define WSM_TRANSMIT_RATE_48		(12)
66 
67 /* 54  Mbps (27 Mbps)  ERP-OFDM, 64QAM coding rate 3/4 */
68 #define WSM_TRANSMIT_RATE_54		(13)
69 
70 /* 6.5 Mbps            HT-OFDM, BPSK coding rate 1/2 */
71 #define WSM_TRANSMIT_RATE_HT_6		(14)
72 
73 /* 13  Mbps            HT-OFDM, QPSK coding rate 1/2 */
74 #define WSM_TRANSMIT_RATE_HT_13		(15)
75 
76 /* 19.5 Mbps           HT-OFDM, QPSK coding rate 3/4 */
77 #define WSM_TRANSMIT_RATE_HT_19		(16)
78 
79 /* 26  Mbps            HT-OFDM, 16QAM coding rate 1/2 */
80 #define WSM_TRANSMIT_RATE_HT_26		(17)
81 
82 /* 39  Mbps            HT-OFDM, 16QAM coding rate 3/4 */
83 #define WSM_TRANSMIT_RATE_HT_39		(18)
84 
85 /* 52  Mbps            HT-OFDM, 64QAM coding rate 2/3 */
86 #define WSM_TRANSMIT_RATE_HT_52		(19)
87 
88 /* 58.5 Mbps           HT-OFDM, 64QAM coding rate 3/4 */
89 #define WSM_TRANSMIT_RATE_HT_58		(20)
90 
91 /* 65  Mbps            HT-OFDM, 64QAM coding rate 5/6 */
92 #define WSM_TRANSMIT_RATE_HT_65		(21)
93 
94 /* Scan types */
95 /* Foreground scan */
96 #define WSM_SCAN_TYPE_FOREGROUND	(0)
97 
98 /* Background scan */
99 #define WSM_SCAN_TYPE_BACKGROUND	(1)
100 
101 /* Auto scan */
102 #define WSM_SCAN_TYPE_AUTO		(2)
103 
104 /* Scan flags */
105 /* Forced background scan means if the station cannot */
106 /* enter the power-save mode, it shall force to perform a */
107 /* background scan. Only valid when ScanType is */
108 /* background scan. */
109 #define WSM_SCAN_FLAG_FORCE_BACKGROUND	(BIT(0))
110 
111 /* The WLAN device scans one channel at a time so */
112 /* that disturbance to the data traffic is minimized. */
113 #define WSM_SCAN_FLAG_SPLIT_METHOD	(BIT(1))
114 
115 /* Preamble Type. Long if not set. */
116 #define WSM_SCAN_FLAG_SHORT_PREAMBLE	(BIT(2))
117 
118 /* 11n Tx Mode. Mixed if not set. */
119 #define WSM_SCAN_FLAG_11N_GREENFIELD	(BIT(3))
120 
121 /* Scan constraints */
122 /* Maximum number of channels to be scanned. */
123 #define WSM_SCAN_MAX_NUM_OF_CHANNELS	(48)
124 
125 /* The maximum number of SSIDs that the device can scan for. */
126 #define WSM_SCAN_MAX_NUM_OF_SSIDS	(2)
127 
128 /* Power management modes */
129 /* 802.11 Active mode */
130 #define WSM_PSM_ACTIVE			(0)
131 
132 /* 802.11 PS mode */
133 #define WSM_PSM_PS			BIT(0)
134 
135 /* Fast Power Save bit */
136 #define WSM_PSM_FAST_PS_FLAG		BIT(7)
137 
138 /* Dynamic aka Fast power save */
139 #define WSM_PSM_FAST_PS			(BIT(0) | BIT(7))
140 
141 /* Undetermined */
142 /* Note : Undetermined status is reported when the */
143 /* NULL data frame used to advertise the PM mode to */
144 /* the AP at Pre or Post Background Scan is not Acknowledged */
145 #define WSM_PSM_UNKNOWN			BIT(1)
146 
147 /* Queue IDs */
148 /* best effort/legacy */
149 #define WSM_QUEUE_BEST_EFFORT		(0)
150 
151 /* background */
152 #define WSM_QUEUE_BACKGROUND		(1)
153 
154 /* video */
155 #define WSM_QUEUE_VIDEO			(2)
156 
157 /* voice */
158 #define WSM_QUEUE_VOICE			(3)
159 
160 /* HT TX parameters */
161 /* Non-HT */
162 #define WSM_HT_TX_NON_HT		(0)
163 
164 /* Mixed format */
165 #define WSM_HT_TX_MIXED			(1)
166 
167 /* Greenfield format */
168 #define WSM_HT_TX_GREENFIELD		(2)
169 
170 /* STBC allowed */
171 #define WSM_HT_TX_STBC			(BIT(7))
172 
173 /* EPTA prioirty flags for BT Coex */
174 /* default epta priority */
175 #define WSM_EPTA_PRIORITY_DEFAULT	4
176 /* use for normal data */
177 #define WSM_EPTA_PRIORITY_DATA		4
178 /* use for connect/disconnect/roaming*/
179 #define WSM_EPTA_PRIORITY_MGT		5
180 /* use for action frames */
181 #define WSM_EPTA_PRIORITY_ACTION	5
182 /* use for AC_VI data */
183 #define WSM_EPTA_PRIORITY_VIDEO		5
184 /* use for AC_VO data */
185 #define WSM_EPTA_PRIORITY_VOICE		6
186 /* use for EAPOL exchange */
187 #define WSM_EPTA_PRIORITY_EAPOL		7
188 
189 /* TX status */
190 /* Frame was sent aggregated */
191 /* Only valid for WSM_SUCCESS status. */
192 #define WSM_TX_STATUS_AGGREGATION	(BIT(0))
193 
194 /* Host should requeue this frame later. */
195 /* Valid only when status is WSM_REQUEUE. */
196 #define WSM_TX_STATUS_REQUEUE		(BIT(1))
197 
198 /* Normal Ack */
199 #define WSM_TX_STATUS_NORMAL_ACK	(0<<2)
200 
201 /* No Ack */
202 #define WSM_TX_STATUS_NO_ACK		(1<<2)
203 
204 /* No explicit acknowledgement */
205 #define WSM_TX_STATUS_NO_EXPLICIT_ACK	(2<<2)
206 
207 /* Block Ack */
208 /* Only valid for WSM_SUCCESS status. */
209 #define WSM_TX_STATUS_BLOCK_ACK		(3<<2)
210 
211 /* RX status */
212 /* Unencrypted */
213 #define WSM_RX_STATUS_UNENCRYPTED	(0<<0)
214 
215 /* WEP */
216 #define WSM_RX_STATUS_WEP		(1<<0)
217 
218 /* TKIP */
219 #define WSM_RX_STATUS_TKIP		(2<<0)
220 
221 /* AES */
222 #define WSM_RX_STATUS_AES		(3<<0)
223 
224 /* WAPI */
225 #define WSM_RX_STATUS_WAPI		(4<<0)
226 
227 /* Macro to fetch encryption subfield. */
228 #define WSM_RX_STATUS_ENCRYPTION(status) ((status) & 0x07)
229 
230 /* Frame was part of an aggregation */
231 #define WSM_RX_STATUS_AGGREGATE		(BIT(3))
232 
233 /* Frame was first in the aggregation */
234 #define WSM_RX_STATUS_AGGREGATE_FIRST	(BIT(4))
235 
236 /* Frame was last in the aggregation */
237 #define WSM_RX_STATUS_AGGREGATE_LAST	(BIT(5))
238 
239 /* Indicates a defragmented frame */
240 #define WSM_RX_STATUS_DEFRAGMENTED	(BIT(6))
241 
242 /* Indicates a Beacon frame */
243 #define WSM_RX_STATUS_BEACON		(BIT(7))
244 
245 /* Indicates STA bit beacon TIM field */
246 #define WSM_RX_STATUS_TIM		(BIT(8))
247 
248 /* Indicates Beacon frame's virtual bitmap contains multicast bit */
249 #define WSM_RX_STATUS_MULTICAST		(BIT(9))
250 
251 /* Indicates frame contains a matching SSID */
252 #define WSM_RX_STATUS_MATCHING_SSID	(BIT(10))
253 
254 /* Indicates frame contains a matching BSSI */
255 #define WSM_RX_STATUS_MATCHING_BSSI	(BIT(11))
256 
257 /* Indicates More bit set in Framectl field */
258 #define WSM_RX_STATUS_MORE_DATA		(BIT(12))
259 
260 /* Indicates frame received during a measurement process */
261 #define WSM_RX_STATUS_MEASUREMENT	(BIT(13))
262 
263 /* Indicates frame received as an HT packet */
264 #define WSM_RX_STATUS_HT		(BIT(14))
265 
266 /* Indicates frame received with STBC */
267 #define WSM_RX_STATUS_STBC		(BIT(15))
268 
269 /* Indicates Address 1 field matches dot11StationId */
270 #define WSM_RX_STATUS_ADDRESS1		(BIT(16))
271 
272 /* Indicates Group address present in the Address 1 field */
273 #define WSM_RX_STATUS_GROUP		(BIT(17))
274 
275 /* Indicates Broadcast address present in the Address 1 field */
276 #define WSM_RX_STATUS_BROADCAST		(BIT(18))
277 
278 /* Indicates group key used with encrypted frames */
279 #define WSM_RX_STATUS_GROUP_KEY		(BIT(19))
280 
281 /* Macro to fetch encryption key index. */
282 #define WSM_RX_STATUS_KEY_IDX(status)	(((status >> 20)) & 0x0F)
283 
284 /* Indicates TSF inclusion after 802.11 frame body */
285 #define WSM_RX_STATUS_TSF_INCLUDED	(BIT(24))
286 
287 /* Frame Control field starts at Frame offset + 2 */
288 #define WSM_TX_2BYTES_SHIFT		(BIT(7))
289 
290 /* Join mode */
291 /* IBSS */
292 #define WSM_JOIN_MODE_IBSS		(0)
293 
294 /* BSS */
295 #define WSM_JOIN_MODE_BSS		(1)
296 
297 /* PLCP preamble type */
298 /* For long preamble */
299 #define WSM_JOIN_PREAMBLE_LONG		(0)
300 
301 /* For short preamble (Long for 1Mbps) */
302 #define WSM_JOIN_PREAMBLE_SHORT		(1)
303 
304 /* For short preamble (Long for 1 and 2Mbps) */
305 #define WSM_JOIN_PREAMBLE_SHORT_2	(2)
306 
307 /* Join flags */
308 /* Unsynchronized */
309 #define WSM_JOIN_FLAGS_UNSYNCRONIZED	BIT(0)
310 /* The BSS owner is a P2P GO */
311 #define WSM_JOIN_FLAGS_P2P_GO		BIT(1)
312 /* Force to join BSS with the BSSID and the
313  * SSID specified without waiting for beacons. The
314  * ProbeForJoin parameter is ignored.
315  */
316 #define WSM_JOIN_FLAGS_FORCE		BIT(2)
317 /* Give probe request/response higher
318  * priority over the BT traffic
319  */
320 #define WSM_JOIN_FLAGS_PRIO		BIT(3)
321 /* Issue immediate join confirmation and use
322  * join complete to notify about completion
323  */
324 #define WSM_JOIN_FLAGS_FORCE_WITH_COMPLETE_IND BIT(5)
325 
326 /* Key types */
327 #define WSM_KEY_TYPE_WEP_DEFAULT	(0)
328 #define WSM_KEY_TYPE_WEP_PAIRWISE	(1)
329 #define WSM_KEY_TYPE_TKIP_GROUP		(2)
330 #define WSM_KEY_TYPE_TKIP_PAIRWISE	(3)
331 #define WSM_KEY_TYPE_AES_GROUP		(4)
332 #define WSM_KEY_TYPE_AES_PAIRWISE	(5)
333 #define WSM_KEY_TYPE_WAPI_GROUP		(6)
334 #define WSM_KEY_TYPE_WAPI_PAIRWISE	(7)
335 
336 /* Key indexes */
337 #define WSM_KEY_MAX_INDEX		(10)
338 
339 /* ACK policy */
340 #define WSM_ACK_POLICY_NORMAL		(0)
341 #define WSM_ACK_POLICY_NO_ACK		(1)
342 
343 /* Start modes */
344 #define WSM_START_MODE_AP		(0)	/* Mini AP */
345 #define WSM_START_MODE_P2P_GO		(1)	/* P2P GO */
346 #define WSM_START_MODE_P2P_DEV		(2)	/* P2P device */
347 
348 /* SetAssociationMode MIB flags */
349 #define WSM_ASSOCIATION_MODE_USE_PREAMBLE_TYPE		(BIT(0))
350 #define WSM_ASSOCIATION_MODE_USE_HT_MODE		(BIT(1))
351 #define WSM_ASSOCIATION_MODE_USE_BASIC_RATE_SET		(BIT(2))
352 #define WSM_ASSOCIATION_MODE_USE_MPDU_START_SPACING	(BIT(3))
353 #define WSM_ASSOCIATION_MODE_SNOOP_ASSOC_FRAMES		(BIT(4))
354 
355 /* RcpiRssiThreshold MIB flags */
356 #define WSM_RCPI_RSSI_THRESHOLD_ENABLE	(BIT(0))
357 #define WSM_RCPI_RSSI_USE_RSSI		(BIT(1))
358 #define WSM_RCPI_RSSI_DONT_USE_UPPER	(BIT(2))
359 #define WSM_RCPI_RSSI_DONT_USE_LOWER	(BIT(3))
360 
361 /* Update-ie constants */
362 #define WSM_UPDATE_IE_BEACON		(BIT(0))
363 #define WSM_UPDATE_IE_PROBE_RESP	(BIT(1))
364 #define WSM_UPDATE_IE_PROBE_REQ		(BIT(2))
365 
366 /* WSM events */
367 /* Error */
368 #define WSM_EVENT_ERROR			(0)
369 
370 /* BSS lost */
371 #define WSM_EVENT_BSS_LOST		(1)
372 
373 /* BSS regained */
374 #define WSM_EVENT_BSS_REGAINED		(2)
375 
376 /* Radar detected */
377 #define WSM_EVENT_RADAR_DETECTED	(3)
378 
379 /* RCPI or RSSI threshold triggered */
380 #define WSM_EVENT_RCPI_RSSI		(4)
381 
382 /* BT inactive */
383 #define WSM_EVENT_BT_INACTIVE		(5)
384 
385 /* BT active */
386 #define WSM_EVENT_BT_ACTIVE		(6)
387 
388 /* MIB IDs */
389 /* 4.1  dot11StationId */
390 #define WSM_MIB_ID_DOT11_STATION_ID		0x0000
391 
392 /* 4.2  dot11MaxtransmitMsduLifeTime */
393 #define WSM_MIB_ID_DOT11_MAX_TRANSMIT_LIFTIME	0x0001
394 
395 /* 4.3  dot11MaxReceiveLifeTime */
396 #define WSM_MIB_ID_DOT11_MAX_RECEIVE_LIFETIME	0x0002
397 
398 /* 4.4  dot11SlotTime */
399 #define WSM_MIB_ID_DOT11_SLOT_TIME		0x0003
400 
401 /* 4.5  dot11GroupAddressesTable */
402 #define WSM_MIB_ID_DOT11_GROUP_ADDRESSES_TABLE	0x0004
403 #define WSM_MAX_GRP_ADDRTABLE_ENTRIES		8
404 
405 /* 4.6  dot11WepDefaultKeyId */
406 #define WSM_MIB_ID_DOT11_WEP_DEFAULT_KEY_ID	0x0005
407 
408 /* 4.7  dot11CurrentTxPowerLevel */
409 #define WSM_MIB_ID_DOT11_CURRENT_TX_POWER_LEVEL	0x0006
410 
411 /* 4.8  dot11RTSThreshold */
412 #define WSM_MIB_ID_DOT11_RTS_THRESHOLD		0x0007
413 
414 /* 4.9  NonErpProtection */
415 #define WSM_MIB_ID_NON_ERP_PROTECTION		0x1000
416 
417 /* 4.10 ArpIpAddressesTable */
418 #define WSM_MIB_ID_ARP_IP_ADDRESSES_TABLE	0x1001
419 #define WSM_MAX_ARP_IP_ADDRTABLE_ENTRIES	1
420 
421 /* 4.11 TemplateFrame */
422 #define WSM_MIB_ID_TEMPLATE_FRAME		0x1002
423 
424 /* 4.12 RxFilter */
425 #define WSM_MIB_ID_RX_FILTER			0x1003
426 
427 /* 4.13 BeaconFilterTable */
428 #define WSM_MIB_ID_BEACON_FILTER_TABLE		0x1004
429 
430 /* 4.14 BeaconFilterEnable */
431 #define WSM_MIB_ID_BEACON_FILTER_ENABLE		0x1005
432 
433 /* 4.15 OperationalPowerMode */
434 #define WSM_MIB_ID_OPERATIONAL_POWER_MODE	0x1006
435 
436 /* 4.16 BeaconWakeUpPeriod */
437 #define WSM_MIB_ID_BEACON_WAKEUP_PERIOD		0x1007
438 
439 /* 4.17 RcpiRssiThreshold */
440 #define WSM_MIB_ID_RCPI_RSSI_THRESHOLD		0x1009
441 
442 /* 4.18 StatisticsTable */
443 #define WSM_MIB_ID_STATISTICS_TABLE		0x100A
444 
445 /* 4.19 IbssPsConfig */
446 #define WSM_MIB_ID_IBSS_PS_CONFIG		0x100B
447 
448 /* 4.20 CountersTable */
449 #define WSM_MIB_ID_COUNTERS_TABLE		0x100C
450 
451 /* 4.21 BlockAckPolicy */
452 #define WSM_MIB_ID_BLOCK_ACK_POLICY		0x100E
453 
454 /* 4.22 OverrideInternalTxRate */
455 #define WSM_MIB_ID_OVERRIDE_INTERNAL_TX_RATE	0x100F
456 
457 /* 4.23 SetAssociationMode */
458 #define WSM_MIB_ID_SET_ASSOCIATION_MODE		0x1010
459 
460 /* 4.24 UpdateEptaConfigData */
461 #define WSM_MIB_ID_UPDATE_EPTA_CONFIG_DATA	0x1011
462 
463 /* 4.25 SelectCcaMethod */
464 #define WSM_MIB_ID_SELECT_CCA_METHOD		0x1012
465 
466 /* 4.26 SetUpasdInformation */
467 #define WSM_MIB_ID_SET_UAPSD_INFORMATION	0x1013
468 
469 /* 4.27 SetAutoCalibrationMode  WBF00004073 */
470 #define WSM_MIB_ID_SET_AUTO_CALIBRATION_MODE	0x1015
471 
472 /* 4.28 SetTxRateRetryPolicy */
473 #define WSM_MIB_ID_SET_TX_RATE_RETRY_POLICY	0x1016
474 
475 /* 4.29 SetHostMessageTypeFilter */
476 #define WSM_MIB_ID_SET_HOST_MSG_TYPE_FILTER	0x1017
477 
478 /* 4.30 P2PFindInfo */
479 #define WSM_MIB_ID_P2P_FIND_INFO		0x1018
480 
481 /* 4.31 P2PPsModeInfo */
482 #define WSM_MIB_ID_P2P_PS_MODE_INFO		0x1019
483 
484 /* 4.32 SetEtherTypeDataFrameFilter */
485 #define WSM_MIB_ID_SET_ETHERTYPE_DATAFRAME_FILTER 0x101A
486 
487 /* 4.33 SetUDPPortDataFrameFilter */
488 #define WSM_MIB_ID_SET_UDPPORT_DATAFRAME_FILTER	0x101B
489 
490 /* 4.34 SetMagicDataFrameFilter */
491 #define WSM_MIB_ID_SET_MAGIC_DATAFRAME_FILTER	0x101C
492 
493 /* 4.35 P2PDeviceInfo */
494 #define WSM_MIB_ID_P2P_DEVICE_INFO		0x101D
495 
496 /* 4.36 SetWCDMABand */
497 #define WSM_MIB_ID_SET_WCDMA_BAND		0x101E
498 
499 /* 4.37 GroupTxSequenceCounter */
500 #define WSM_MIB_ID_GRP_SEQ_COUNTER		0x101F
501 
502 /* 4.38 ProtectedMgmtPolicy */
503 #define WSM_MIB_ID_PROTECTED_MGMT_POLICY	0x1020
504 
505 /* 4.39 SetHtProtection */
506 #define WSM_MIB_ID_SET_HT_PROTECTION		0x1021
507 
508 /* 4.40 GPIO Command */
509 #define WSM_MIB_ID_GPIO_COMMAND			0x1022
510 
511 /* 4.41 TSF Counter Value */
512 #define WSM_MIB_ID_TSF_COUNTER			0x1023
513 
514 /* Test Purposes Only */
515 #define WSM_MIB_ID_BLOCK_ACK_INFO		0x100D
516 
517 /* 4.42 UseMultiTxConfMessage */
518 #define WSM_MIB_USE_MULTI_TX_CONF		0x1024
519 
520 /* 4.43 Keep-alive period */
521 #define WSM_MIB_ID_KEEP_ALIVE_PERIOD		0x1025
522 
523 /* 4.44 Disable BSSID filter */
524 #define WSM_MIB_ID_DISABLE_BSSID_FILTER		0x1026
525 
526 /* Frame template types */
527 #define WSM_FRAME_TYPE_PROBE_REQUEST	(0)
528 #define WSM_FRAME_TYPE_BEACON		(1)
529 #define WSM_FRAME_TYPE_NULL		(2)
530 #define WSM_FRAME_TYPE_QOS_NULL		(3)
531 #define WSM_FRAME_TYPE_PS_POLL		(4)
532 #define WSM_FRAME_TYPE_PROBE_RESPONSE	(5)
533 
534 #define WSM_FRAME_GREENFIELD		(0x80)	/* See 4.11 */
535 
536 /* Status */
537 /* The WSM firmware has completed a request */
538 /* successfully. */
539 #define WSM_STATUS_SUCCESS              (0)
540 
541 /* This is a generic failure code if other error codes do */
542 /* not apply. */
543 #define WSM_STATUS_FAILURE              (1)
544 
545 /* A request contains one or more invalid parameters. */
546 #define WSM_INVALID_PARAMETER           (2)
547 
548 /* The request cannot perform because the device is in */
549 /* an inappropriate mode. */
550 #define WSM_ACCESS_DENIED               (3)
551 
552 /* The frame received includes a decryption error. */
553 #define WSM_STATUS_DECRYPTFAILURE       (4)
554 
555 /* A MIC failure is detected in the received packets. */
556 #define WSM_STATUS_MICFAILURE           (5)
557 
558 /* The transmit request failed due to retry limit being */
559 /* exceeded. */
560 #define WSM_STATUS_RETRY_EXCEEDED       (6)
561 
562 /* The transmit request failed due to MSDU life time */
563 /* being exceeded. */
564 #define WSM_STATUS_TX_LIFETIME_EXCEEDED (7)
565 
566 /* The link to the AP is lost. */
567 #define WSM_STATUS_LINK_LOST            (8)
568 
569 /* No key was found for the encrypted frame */
570 #define WSM_STATUS_NO_KEY_FOUND         (9)
571 
572 /* Jammer was detected when transmitting this frame */
573 #define WSM_STATUS_JAMMER_DETECTED      (10)
574 
575 /* The message should be requeued later. */
576 /* This is applicable only to Transmit */
577 #define WSM_REQUEUE                     (11)
578 
579 /* Advanced filtering options */
580 #define WSM_MAX_FILTER_ELEMENTS		(4)
581 
582 #define WSM_FILTER_ACTION_IGNORE	(0)
583 #define WSM_FILTER_ACTION_FILTER_IN	(1)
584 #define WSM_FILTER_ACTION_FILTER_OUT	(2)
585 
586 #define WSM_FILTER_PORT_TYPE_DST	(0)
587 #define WSM_FILTER_PORT_TYPE_SRC	(1)
588 
589 /* Actual header of WSM messages */
590 struct wsm_hdr {
591 	__le16 len;
592 	__le16 id;
593 };
594 
595 #define WSM_TX_SEQ_MAX			(7)
596 #define WSM_TX_SEQ(seq)			\
597 		((seq & WSM_TX_SEQ_MAX) << 13)
598 #define WSM_TX_LINK_ID_MAX		(0x0F)
599 #define WSM_TX_LINK_ID(link_id)		\
600 		((link_id & WSM_TX_LINK_ID_MAX) << 6)
601 
602 #define MAX_BEACON_SKIP_TIME_MS 1000
603 
604 #define WSM_CMD_LAST_CHANCE_TIMEOUT (HZ * 3 / 2)
605 
606 /* ******************************************************************** */
607 /* WSM capability							*/
608 
609 #define WSM_STARTUP_IND_ID 0x0801
610 
611 struct wsm_startup_ind {
612 	u16 input_buffers;
613 	u16 input_buffer_size;
614 	u16 status;
615 	u16 hw_id;
616 	u16 hw_subid;
617 	u16 fw_cap;
618 	u16 fw_type;
619 	u16 fw_api;
620 	u16 fw_build;
621 	u16 fw_ver;
622 	char fw_label[128];
623 	u32 config[4];
624 };
625 
626 /* ******************************************************************** */
627 /* WSM commands								*/
628 
629 /* 3.1 */
630 #define WSM_CONFIGURATION_REQ_ID 0x0009
631 #define WSM_CONFIGURATION_RESP_ID 0x0409
632 
633 struct wsm_tx_power_range {
634 	int min_power_level;
635 	int max_power_level;
636 	u32 stepping;
637 };
638 
639 struct wsm_configuration {
640 	/* [in] */ u32 dot11MaxTransmitMsduLifeTime;
641 	/* [in] */ u32 dot11MaxReceiveLifeTime;
642 	/* [in] */ u32 dot11RtsThreshold;
643 	/* [in, out] */ u8 *dot11StationId;
644 	/* [in] */ const void *dpdData;
645 	/* [in] */ size_t dpdData_size;
646 	/* [out] */ u8 dot11FrequencyBandsSupported;
647 	/* [out] */ u32 supportedRateMask;
648 	/* [out] */ struct wsm_tx_power_range txPowerRange[2];
649 };
650 
651 int wsm_configuration(struct cw1200_common *priv,
652 		      struct wsm_configuration *arg);
653 
654 /* 3.3 */
655 #define WSM_RESET_REQ_ID 0x000A
656 #define WSM_RESET_RESP_ID 0x040A
657 struct wsm_reset {
658 	/* [in] */ int link_id;
659 	/* [in] */ bool reset_statistics;
660 };
661 
662 int wsm_reset(struct cw1200_common *priv, const struct wsm_reset *arg);
663 
664 /* 3.5 */
665 #define WSM_READ_MIB_REQ_ID 0x0005
666 #define WSM_READ_MIB_RESP_ID 0x0405
667 int wsm_read_mib(struct cw1200_common *priv, u16 mib_id, void *buf,
668 		 size_t buf_size);
669 
670 /* 3.7 */
671 #define WSM_WRITE_MIB_REQ_ID 0x0006
672 #define WSM_WRITE_MIB_RESP_ID 0x0406
673 int wsm_write_mib(struct cw1200_common *priv, u16 mib_id, void *buf,
674 		  size_t buf_size);
675 
676 /* 3.9 */
677 #define WSM_START_SCAN_REQ_ID 0x0007
678 #define WSM_START_SCAN_RESP_ID 0x0407
679 
680 struct wsm_ssid {
681 	u8 ssid[32];
682 	u32 length;
683 };
684 
685 struct wsm_scan_ch {
686 	u16 number;
687 	u32 min_chan_time;
688 	u32 max_chan_time;
689 	u32 tx_power_level;
690 };
691 
692 struct wsm_scan {
693 	/* WSM_PHY_BAND_... */
694 	u8 band;
695 
696 	/* WSM_SCAN_TYPE_... */
697 	u8 type;
698 
699 	/* WSM_SCAN_FLAG_... */
700 	u8 flags;
701 
702 	/* WSM_TRANSMIT_RATE_... */
703 	u8 max_tx_rate;
704 
705 	/* Interval period in TUs that the device shall the re- */
706 	/* execute the requested scan. Max value supported by the device */
707 	/* is 256s. */
708 	u32 auto_scan_interval;
709 
710 	/* Number of probe requests (per SSID) sent to one (1) */
711 	/* channel. Zero (0) means that none is send, which */
712 	/* means that a passive scan is to be done. Value */
713 	/* greater than zero (0) means that an active scan is to */
714 	/* be done. */
715 	u32 num_probes;
716 
717 	/* Number of channels to be scanned. */
718 	/* Maximum value is WSM_SCAN_MAX_NUM_OF_CHANNELS. */
719 	u8 num_channels;
720 
721 	/* Number of SSID provided in the scan command (this */
722 	/* is zero (0) in broadcast scan) */
723 	/* The maximum number of SSIDs is WSM_SCAN_MAX_NUM_OF_SSIDS. */
724 	u8 num_ssids;
725 
726 	/* The delay time (in microseconds) period */
727 	/* before sending a probe-request. */
728 	u8 probe_delay;
729 
730 	/* SSIDs to be scanned [numOfSSIDs]; */
731 	struct wsm_ssid *ssids;
732 
733 	/* Channels to be scanned [numOfChannels]; */
734 	struct wsm_scan_ch *ch;
735 };
736 
737 int wsm_scan(struct cw1200_common *priv, const struct wsm_scan *arg);
738 
739 /* 3.11 */
740 #define WSM_STOP_SCAN_REQ_ID 0x0008
741 #define WSM_STOP_SCAN_RESP_ID 0x0408
742 int wsm_stop_scan(struct cw1200_common *priv);
743 
744 /* 3.13 */
745 #define WSM_SCAN_COMPLETE_IND_ID 0x0806
746 struct wsm_scan_complete {
747 	/* WSM_STATUS_... */
748 	u32 status;
749 
750 	/* WSM_PSM_... */
751 	u8 psm;
752 
753 	/* Number of channels that the scan operation completed. */
754 	u8 num_channels;
755 };
756 
757 /* 3.14 */
758 #define WSM_TX_CONFIRM_IND_ID 0x0404
759 #define WSM_MULTI_TX_CONFIRM_ID 0x041E
760 
761 struct wsm_tx_confirm {
762 	/* Packet identifier used in wsm_tx. */
763 	u32 packet_id;
764 
765 	/* WSM_STATUS_... */
766 	u32 status;
767 
768 	/* WSM_TRANSMIT_RATE_... */
769 	u8 tx_rate;
770 
771 	/* The number of times the frame was transmitted */
772 	/* without receiving an acknowledgement. */
773 	u8 ack_failures;
774 
775 	/* WSM_TX_STATUS_... */
776 	u16 flags;
777 
778 	/* The total time in microseconds that the frame spent in */
779 	/* the WLAN device before transmission as completed. */
780 	u32 media_delay;
781 
782 	/* The total time in microseconds that the frame spent in */
783 	/* the WLAN device before transmission was started. */
784 	u32 tx_queue_delay;
785 };
786 
787 /* 3.15 */
788 
789 /* Note that ideology of wsm_tx struct is different against the rest of
790  * WSM API. wsm_hdr is /not/ a caller-adapted struct to be used as an input
791  * argument for WSM call, but a prepared bytestream to be sent to firmware.
792  * It is filled partly in cw1200_tx, partly in low-level WSM code.
793  * Please pay attention once again: ideology is different.
794  *
795  * Legend:
796  * - [in]: cw1200_tx must fill this field.
797  * - [wsm]: the field is filled by low-level WSM.
798  */
799 struct wsm_tx {
800 	/* common WSM header */
801 	struct wsm_hdr hdr;
802 
803 	/* Packet identifier that meant to be used in completion. */
804 	u32 packet_id;  /* Note this is actually a cookie */
805 
806 	/* WSM_TRANSMIT_RATE_... */
807 	u8 max_tx_rate;
808 
809 	/* WSM_QUEUE_... */
810 	u8 queue_id;
811 
812 	/* True: another packet is pending on the host for transmission. */
813 	u8 more;
814 
815 	/* Bit 0 = 0 - Start expiry time from first Tx attempt (default) */
816 	/* Bit 0 = 1 - Start expiry time from receipt of Tx Request */
817 	/* Bits 3:1  - PTA Priority */
818 	/* Bits 6:4  - Tx Rate Retry Policy */
819 	/* Bit 7 - Reserved */
820 	u8 flags;
821 
822 	/* Should be 0. */
823 	u32 reserved;
824 
825 	/* The elapsed time in TUs, after the initial transmission */
826 	/* of an MSDU, after which further attempts to transmit */
827 	/* the MSDU shall be terminated. Overrides the global */
828 	/* dot11MaxTransmitMsduLifeTime setting [optional] */
829 	/* Device will set the default value if this is 0. */
830 	__le32 expire_time;
831 
832 	/* WSM_HT_TX_... */
833 	__le32 ht_tx_parameters;
834 } __packed;
835 
836 /* = sizeof(generic hi hdr) + sizeof(wsm hdr) + sizeof(alignment) */
837 #define WSM_TX_EXTRA_HEADROOM (28)
838 
839 /* 3.16 */
840 #define WSM_RECEIVE_IND_ID 0x0804
841 
842 struct wsm_rx {
843 	/* WSM_STATUS_... */
844 	u32 status;
845 
846 	/* Specifies the channel of the received packet. */
847 	u16 channel_number;
848 
849 	/* WSM_TRANSMIT_RATE_... */
850 	u8 rx_rate;
851 
852 	/* This value is expressed in signed Q8.0 format for */
853 	/* RSSI and unsigned Q7.1 format for RCPI. */
854 	u8 rcpi_rssi;
855 
856 	/* WSM_RX_STATUS_... */
857 	u32 flags;
858 };
859 
860 /* = sizeof(generic hi hdr) + sizeof(wsm hdr) */
861 #define WSM_RX_EXTRA_HEADROOM (16)
862 
863 /* 3.17 */
864 struct wsm_event {
865 	/* WSM_STATUS_... */
866 	/* [out] */ u32 id;
867 
868 	/* Indication parameters. */
869 	/* For error indication, this shall be a 32-bit WSM status. */
870 	/* For RCPI or RSSI indication, this should be an 8-bit */
871 	/* RCPI or RSSI value. */
872 	/* [out] */ u32 data;
873 };
874 
875 struct cw1200_wsm_event {
876 	struct list_head link;
877 	struct wsm_event evt;
878 };
879 
880 /* 3.18 - 3.22 */
881 /* Measurement. Skipped for now. Irrelevent. */
882 
883 typedef void (*wsm_event_cb) (struct cw1200_common *priv,
884 			      struct wsm_event *arg);
885 
886 /* 3.23 */
887 #define WSM_JOIN_REQ_ID 0x000B
888 #define WSM_JOIN_RESP_ID 0x040B
889 
890 struct wsm_join {
891 	/* WSM_JOIN_MODE_... */
892 	u8 mode;
893 
894 	/* WSM_PHY_BAND_... */
895 	u8 band;
896 
897 	/* Specifies the channel number to join. The channel */
898 	/* number will be mapped to an actual frequency */
899 	/* according to the band */
900 	u16 channel_number;
901 
902 	/* Specifies the BSSID of the BSS or IBSS to be joined */
903 	/* or the IBSS to be started. */
904 	u8 bssid[6];
905 
906 	/* ATIM window of IBSS */
907 	/* When ATIM window is zero the initiated IBSS does */
908 	/* not support power saving. */
909 	u16 atim_window;
910 
911 	/* WSM_JOIN_PREAMBLE_... */
912 	u8 preamble_type;
913 
914 	/* Specifies if a probe request should be send with the */
915 	/* specified SSID when joining to the network. */
916 	u8 probe_for_join;
917 
918 	/* DTIM Period (In multiples of beacon interval) */
919 	u8 dtim_period;
920 
921 	/* WSM_JOIN_FLAGS_... */
922 	u8 flags;
923 
924 	/* Length of the SSID */
925 	u32 ssid_len;
926 
927 	/* Specifies the SSID of the IBSS to join or start */
928 	u8 ssid[32];
929 
930 	/* Specifies the time between TBTTs in TUs */
931 	u32 beacon_interval;
932 
933 	/* A bit mask that defines the BSS basic rate set. */
934 	u32 basic_rate_set;
935 };
936 
937 struct wsm_join_cnf {
938 	u32 status;
939 
940 	/* Minimum transmission power level in units of 0.1dBm */
941 	u32 min_power_level;
942 
943 	/* Maximum transmission power level in units of 0.1dBm */
944 	u32 max_power_level;
945 };
946 
947 int wsm_join(struct cw1200_common *priv, struct wsm_join *arg);
948 
949 /* 3.24 */
950 struct wsm_join_complete {
951 	/* WSM_STATUS_... */
952 	u32 status;
953 };
954 
955 /* 3.25 */
956 #define WSM_SET_PM_REQ_ID 0x0010
957 #define WSM_SET_PM_RESP_ID 0x0410
958 struct wsm_set_pm {
959 	/* WSM_PSM_... */
960 	u8 mode;
961 
962 	/* in unit of 500us; 0 to use default */
963 	u8 fast_psm_idle_period;
964 
965 	/* in unit of 500us; 0 to use default */
966 	u8 ap_psm_change_period;
967 
968 	/* in unit of 500us; 0 to disable auto-pspoll */
969 	u8 min_auto_pspoll_period;
970 };
971 
972 int wsm_set_pm(struct cw1200_common *priv, const struct wsm_set_pm *arg);
973 
974 /* 3.27 */
975 struct wsm_set_pm_complete {
976 	u8 psm;			/* WSM_PSM_... */
977 };
978 
979 /* 3.28 */
980 #define WSM_SET_BSS_PARAMS_REQ_ID 0x0011
981 #define WSM_SET_BSS_PARAMS_RESP_ID 0x0411
982 struct wsm_set_bss_params {
983 	/* This resets the beacon loss counters only */
984 	u8 reset_beacon_loss;
985 
986 	/* The number of lost consecutive beacons after which */
987 	/* the WLAN device should indicate the BSS-Lost event */
988 	/* to the WLAN host driver. */
989 	u8 beacon_lost_count;
990 
991 	/* The AID received during the association process. */
992 	u16 aid;
993 
994 	/* The operational rate set mask */
995 	u32 operational_rate_set;
996 };
997 
998 int wsm_set_bss_params(struct cw1200_common *priv,
999 		       const struct wsm_set_bss_params *arg);
1000 
1001 /* 3.30 */
1002 #define WSM_ADD_KEY_REQ_ID         0x000C
1003 #define WSM_ADD_KEY_RESP_ID        0x040C
1004 struct wsm_add_key {
1005 	u8 type;		/* WSM_KEY_TYPE_... */
1006 	u8 index;		/* Key entry index: 0 -- WSM_KEY_MAX_INDEX */
1007 	u16 reserved;
1008 	union {
1009 		struct {
1010 			u8 peer[6];	/* MAC address of the peer station */
1011 			u8 reserved;
1012 			u8 keylen;		/* Key length in bytes */
1013 			u8 keydata[16];		/* Key data */
1014 		} __packed wep_pairwise;
1015 		struct {
1016 			u8 keyid;	/* Unique per key identifier (0..3) */
1017 			u8 keylen;		/* Key length in bytes */
1018 			u16 reserved;
1019 			u8 keydata[16];		/* Key data */
1020 		} __packed wep_group;
1021 		struct {
1022 			u8 peer[6];	/* MAC address of the peer station */
1023 			u16 reserved;
1024 			u8 keydata[16];	/* TKIP key data */
1025 			u8 rx_mic_key[8];		/* Rx MIC key */
1026 			u8 tx_mic_key[8];		/* Tx MIC key */
1027 		} __packed tkip_pairwise;
1028 		struct {
1029 			u8 keydata[16];	/* TKIP key data */
1030 			u8 rx_mic_key[8];		/* Rx MIC key */
1031 			u8 keyid;		/* Key ID */
1032 			u8 reserved[3];
1033 			u8 rx_seqnum[8];	/* Receive Sequence Counter */
1034 		} __packed tkip_group;
1035 		struct {
1036 			u8 peer[6];	/* MAC address of the peer station */
1037 			u16 reserved;
1038 			u8 keydata[16];	/* AES key data */
1039 		} __packed aes_pairwise;
1040 		struct {
1041 			u8 keydata[16];	/* AES key data */
1042 			u8 keyid;		/* Key ID */
1043 			u8 reserved[3];
1044 			u8 rx_seqnum[8];	/* Receive Sequence Counter */
1045 		} __packed aes_group;
1046 		struct {
1047 			u8 peer[6];	/* MAC address of the peer station */
1048 			u8 keyid;		/* Key ID */
1049 			u8 reserved;
1050 			u8 keydata[16];	/* WAPI key data */
1051 			u8 mic_key[16];	/* MIC key data */
1052 		} __packed wapi_pairwise;
1053 		struct {
1054 			u8 keydata[16];	/* WAPI key data */
1055 			u8 mic_key[16];	/* MIC key data */
1056 			u8 keyid;		/* Key ID */
1057 			u8 reserved[3];
1058 		} __packed wapi_group;
1059 	} __packed;
1060 } __packed;
1061 
1062 int wsm_add_key(struct cw1200_common *priv, const struct wsm_add_key *arg);
1063 
1064 /* 3.32 */
1065 #define WSM_REMOVE_KEY_REQ_ID         0x000D
1066 #define WSM_REMOVE_KEY_RESP_ID        0x040D
1067 struct wsm_remove_key {
1068 	u8 index; /* Key entry index : 0-10 */
1069 };
1070 
1071 int wsm_remove_key(struct cw1200_common *priv,
1072 		   const struct wsm_remove_key *arg);
1073 
1074 /* 3.34 */
1075 struct wsm_set_tx_queue_params {
1076 	/* WSM_ACK_POLICY_... */
1077 	u8 ackPolicy;
1078 
1079 	/* Medium Time of TSPEC (in 32us units) allowed per */
1080 	/* One Second Averaging Period for this queue. */
1081 	u16 allowedMediumTime;
1082 
1083 	/* dot11MaxTransmitMsduLifetime to be used for the */
1084 	/* specified queue. */
1085 	u32 maxTransmitLifetime;
1086 };
1087 
1088 struct wsm_tx_queue_params {
1089 	/* NOTE: index is a linux queue id. */
1090 	struct wsm_set_tx_queue_params params[4];
1091 };
1092 
1093 
1094 #define WSM_TX_QUEUE_SET(queue_params, queue, ack_policy, allowed_time,\
1095 		max_life_time)	\
1096 do {							\
1097 	struct wsm_set_tx_queue_params *p = &(queue_params)->params[queue]; \
1098 	p->ackPolicy = (ack_policy);				\
1099 	p->allowedMediumTime = (allowed_time);				\
1100 	p->maxTransmitLifetime = (max_life_time);			\
1101 } while (0)
1102 
1103 int wsm_set_tx_queue_params(struct cw1200_common *priv,
1104 			    const struct wsm_set_tx_queue_params *arg, u8 id);
1105 
1106 /* 3.36 */
1107 #define WSM_EDCA_PARAMS_REQ_ID 0x0013
1108 #define WSM_EDCA_PARAMS_RESP_ID 0x0413
1109 struct wsm_edca_queue_params {
1110 	/* CWmin (in slots) for the access class. */
1111 	u16 cwmin;
1112 
1113 	/* CWmax (in slots) for the access class. */
1114 	u16 cwmax;
1115 
1116 	/* AIFS (in slots) for the access class. */
1117 	u16 aifns;
1118 
1119 	/* TX OP Limit (in microseconds) for the access class. */
1120 	u16 txop_limit;
1121 
1122 	/* dot11MaxReceiveLifetime to be used for the specified */
1123 	/* the access class. Overrides the global */
1124 	/* dot11MaxReceiveLifetime value */
1125 	u32 max_rx_lifetime;
1126 };
1127 
1128 struct wsm_edca_params {
1129 	/* NOTE: index is a linux queue id. */
1130 	struct wsm_edca_queue_params params[4];
1131 	bool uapsd_enable[4];
1132 };
1133 
1134 #define TXOP_UNIT 32
1135 #define WSM_EDCA_SET(__edca, __queue, __aifs, __cw_min, __cw_max, __txop, __lifetime,\
1136 		     __uapsd) \
1137 	do {							\
1138 		struct wsm_edca_queue_params *p = &(__edca)->params[__queue]; \
1139 		p->cwmin = __cw_min;					\
1140 		p->cwmax = __cw_max;					\
1141 		p->aifns = __aifs;					\
1142 		p->txop_limit = ((__txop) * TXOP_UNIT);			\
1143 		p->max_rx_lifetime = __lifetime;			\
1144 		(__edca)->uapsd_enable[__queue] = (__uapsd);		\
1145 	} while (0)
1146 
1147 int wsm_set_edca_params(struct cw1200_common *priv,
1148 			const struct wsm_edca_params *arg);
1149 
1150 int wsm_set_uapsd_param(struct cw1200_common *priv,
1151 			const struct wsm_edca_params *arg);
1152 
1153 /* 3.38 */
1154 /* Set-System info. Skipped for now. Irrelevent. */
1155 
1156 /* 3.40 */
1157 #define WSM_SWITCH_CHANNEL_REQ_ID 0x0016
1158 #define WSM_SWITCH_CHANNEL_RESP_ID 0x0416
1159 
1160 struct wsm_switch_channel {
1161 	/* 1 - means the STA shall not transmit any further */
1162 	/* frames until the channel switch has completed */
1163 	u8 mode;
1164 
1165 	/* Number of TBTTs until channel switch occurs. */
1166 	/* 0 - indicates switch shall occur at any time */
1167 	/* 1 - occurs immediately before the next TBTT */
1168 	u8 switch_count;
1169 
1170 	/* The new channel number to switch to. */
1171 	/* Note this is defined as per section 2.7. */
1172 	u16 channel_number;
1173 };
1174 
1175 int wsm_switch_channel(struct cw1200_common *priv,
1176 		       const struct wsm_switch_channel *arg);
1177 
1178 #define WSM_START_REQ_ID 0x0017
1179 #define WSM_START_RESP_ID 0x0417
1180 
1181 struct wsm_start {
1182 	/* WSM_START_MODE_... */
1183 	/* [in] */ u8 mode;
1184 
1185 	/* WSM_PHY_BAND_... */
1186 	/* [in] */ u8 band;
1187 
1188 	/* Channel number */
1189 	/* [in] */ u16 channel_number;
1190 
1191 	/* Client Traffic window in units of TU */
1192 	/* Valid only when mode == ..._P2P */
1193 	/* [in] */ u32 ct_window;
1194 
1195 	/* Interval between two consecutive */
1196 	/* beacon transmissions in TU. */
1197 	/* [in] */ u32 beacon_interval;
1198 
1199 	/* DTIM period in terms of beacon intervals */
1200 	/* [in] */ u8 dtim_period;
1201 
1202 	/* WSM_JOIN_PREAMBLE_... */
1203 	/* [in] */ u8 preamble;
1204 
1205 	/* The delay time (in microseconds) period */
1206 	/* before sending a probe-request. */
1207 	/* [in] */ u8 probe_delay;
1208 
1209 	/* Length of the SSID */
1210 	/* [in] */ u8 ssid_len;
1211 
1212 	/* SSID of the BSS or P2P_GO to be started now. */
1213 	/* [in] */ u8 ssid[32];
1214 
1215 	/* The basic supported rates for the MiniAP. */
1216 	/* [in] */ u32 basic_rate_set;
1217 };
1218 
1219 int wsm_start(struct cw1200_common *priv, const struct wsm_start *arg);
1220 
1221 #define WSM_BEACON_TRANSMIT_REQ_ID 0x0018
1222 #define WSM_BEACON_TRANSMIT_RESP_ID 0x0418
1223 
1224 struct wsm_beacon_transmit {
1225 	/* 1: enable; 0: disable */
1226 	/* [in] */ u8 enable_beaconing;
1227 };
1228 
1229 int wsm_beacon_transmit(struct cw1200_common *priv,
1230 			const struct wsm_beacon_transmit *arg);
1231 
1232 int wsm_start_find(struct cw1200_common *priv);
1233 
1234 int wsm_stop_find(struct cw1200_common *priv);
1235 
1236 struct wsm_suspend_resume {
1237 	/* See 3.52 */
1238 	/* Link ID */
1239 	/* [out] */ int link_id;
1240 	/* Stop sending further Tx requests down to device for this link */
1241 	/* [out] */ bool stop;
1242 	/* Transmit multicast Frames */
1243 	/* [out] */ bool multicast;
1244 	/* The AC on which Tx to be suspended /resumed. */
1245 	/* This is applicable only for U-APSD */
1246 	/* WSM_QUEUE_... */
1247 	/* [out] */ int queue;
1248 };
1249 
1250 /* 3.54 Update-IE request. */
1251 struct wsm_update_ie {
1252 	/* WSM_UPDATE_IE_... */
1253 	/* [in] */ u16 what;
1254 	/* [in] */ u16 count;
1255 	/* [in] */ u8 *ies;
1256 	/* [in] */ size_t length;
1257 };
1258 
1259 int wsm_update_ie(struct cw1200_common *priv,
1260 		  const struct wsm_update_ie *arg);
1261 
1262 /* 3.56 */
1263 struct wsm_map_link {
1264 	/* MAC address of the remote device */
1265 	/* [in] */ u8 mac_addr[6];
1266 	/* [in] */ u8 link_id;
1267 };
1268 
1269 int wsm_map_link(struct cw1200_common *priv, const struct wsm_map_link *arg);
1270 
1271 /* ******************************************************************** */
1272 /* MIB shortcats							*/
1273 
1274 static inline int wsm_set_output_power(struct cw1200_common *priv,
1275 				       int power_level)
1276 {
1277 	__le32 val = __cpu_to_le32(power_level);
1278 	return wsm_write_mib(priv, WSM_MIB_ID_DOT11_CURRENT_TX_POWER_LEVEL,
1279 			     &val, sizeof(val));
1280 }
1281 
1282 static inline int wsm_set_beacon_wakeup_period(struct cw1200_common *priv,
1283 					       unsigned dtim_interval,
1284 					       unsigned listen_interval)
1285 {
1286 	struct {
1287 		u8 numBeaconPeriods;
1288 		u8 reserved;
1289 		__le16 listenInterval;
1290 	} val = {
1291 		dtim_interval, 0, __cpu_to_le16(listen_interval)
1292 	};
1293 
1294 	if (dtim_interval > 0xFF || listen_interval > 0xFFFF)
1295 		return -EINVAL;
1296 	else
1297 		return wsm_write_mib(priv, WSM_MIB_ID_BEACON_WAKEUP_PERIOD,
1298 				     &val, sizeof(val));
1299 }
1300 
1301 struct wsm_rcpi_rssi_threshold {
1302 	u8 rssiRcpiMode;	/* WSM_RCPI_RSSI_... */
1303 	u8 lowerThreshold;
1304 	u8 upperThreshold;
1305 	u8 rollingAverageCount;
1306 };
1307 
1308 static inline int wsm_set_rcpi_rssi_threshold(struct cw1200_common *priv,
1309 					struct wsm_rcpi_rssi_threshold *arg)
1310 {
1311 	return wsm_write_mib(priv, WSM_MIB_ID_RCPI_RSSI_THRESHOLD, arg,
1312 			     sizeof(*arg));
1313 }
1314 
1315 struct wsm_mib_counters_table {
1316 	__le32 plcp_errors;
1317 	__le32 fcs_errors;
1318 	__le32 tx_packets;
1319 	__le32 rx_packets;
1320 	__le32 rx_packet_errors;
1321 	__le32 rx_decryption_failures;
1322 	__le32 rx_mic_failures;
1323 	__le32 rx_no_key_failures;
1324 	__le32 tx_multicast_frames;
1325 	__le32 tx_frames_success;
1326 	__le32 tx_frame_failures;
1327 	__le32 tx_frames_retried;
1328 	__le32 tx_frames_multi_retried;
1329 	__le32 rx_frame_duplicates;
1330 	__le32 rts_success;
1331 	__le32 rts_failures;
1332 	__le32 ack_failures;
1333 	__le32 rx_multicast_frames;
1334 	__le32 rx_frames_success;
1335 	__le32 rx_cmac_icv_errors;
1336 	__le32 rx_cmac_replays;
1337 	__le32 rx_mgmt_ccmp_replays;
1338 } __packed;
1339 
1340 static inline int wsm_get_counters_table(struct cw1200_common *priv,
1341 					 struct wsm_mib_counters_table *arg)
1342 {
1343 	return wsm_read_mib(priv, WSM_MIB_ID_COUNTERS_TABLE,
1344 			    arg, sizeof(*arg));
1345 }
1346 
1347 static inline int wsm_get_station_id(struct cw1200_common *priv, u8 *mac)
1348 {
1349 	return wsm_read_mib(priv, WSM_MIB_ID_DOT11_STATION_ID, mac, ETH_ALEN);
1350 }
1351 
1352 struct wsm_rx_filter {
1353 	bool promiscuous;
1354 	bool bssid;
1355 	bool fcs;
1356 	bool probeResponder;
1357 };
1358 
1359 static inline int wsm_set_rx_filter(struct cw1200_common *priv,
1360 				    const struct wsm_rx_filter *arg)
1361 {
1362 	__le32 val = 0;
1363 	if (arg->promiscuous)
1364 		val |= __cpu_to_le32(BIT(0));
1365 	if (arg->bssid)
1366 		val |= __cpu_to_le32(BIT(1));
1367 	if (arg->fcs)
1368 		val |= __cpu_to_le32(BIT(2));
1369 	if (arg->probeResponder)
1370 		val |= __cpu_to_le32(BIT(3));
1371 	return wsm_write_mib(priv, WSM_MIB_ID_RX_FILTER, &val, sizeof(val));
1372 }
1373 
1374 int wsm_set_probe_responder(struct cw1200_common *priv, bool enable);
1375 
1376 #define WSM_BEACON_FILTER_IE_HAS_CHANGED	BIT(0)
1377 #define WSM_BEACON_FILTER_IE_NO_LONGER_PRESENT	BIT(1)
1378 #define WSM_BEACON_FILTER_IE_HAS_APPEARED	BIT(2)
1379 
1380 struct wsm_beacon_filter_table_entry {
1381 	u8	ie_id;
1382 	u8	flags;
1383 	u8	oui[3];
1384 	u8	match_data[3];
1385 } __packed;
1386 
1387 struct wsm_mib_beacon_filter_table {
1388 	__le32 num;
1389 	struct wsm_beacon_filter_table_entry entry[10];
1390 } __packed;
1391 
1392 static inline int wsm_set_beacon_filter_table(struct cw1200_common *priv,
1393 					      struct wsm_mib_beacon_filter_table *ft)
1394 {
1395 	size_t size = __le32_to_cpu(ft->num) *
1396 		     sizeof(struct wsm_beacon_filter_table_entry) +
1397 		     sizeof(__le32);
1398 
1399 	return wsm_write_mib(priv, WSM_MIB_ID_BEACON_FILTER_TABLE, ft, size);
1400 }
1401 
1402 #define WSM_BEACON_FILTER_ENABLE	BIT(0) /* Enable/disable beacon filtering */
1403 #define WSM_BEACON_FILTER_AUTO_ERP	BIT(1) /* If 1 FW will handle ERP IE changes internally */
1404 
1405 struct wsm_beacon_filter_control {
1406 	int enabled;
1407 	int bcn_count;
1408 };
1409 
1410 static inline int wsm_beacon_filter_control(struct cw1200_common *priv,
1411 					struct wsm_beacon_filter_control *arg)
1412 {
1413 	struct {
1414 		__le32 enabled;
1415 		__le32 bcn_count;
1416 	} val;
1417 	val.enabled = __cpu_to_le32(arg->enabled);
1418 	val.bcn_count = __cpu_to_le32(arg->bcn_count);
1419 	return wsm_write_mib(priv, WSM_MIB_ID_BEACON_FILTER_ENABLE, &val,
1420 			     sizeof(val));
1421 }
1422 
1423 enum wsm_power_mode {
1424 	wsm_power_mode_active = 0,
1425 	wsm_power_mode_doze = 1,
1426 	wsm_power_mode_quiescent = 2,
1427 };
1428 
1429 struct wsm_operational_mode {
1430 	enum wsm_power_mode power_mode;
1431 	int disable_more_flag_usage;
1432 	int perform_ant_diversity;
1433 };
1434 
1435 static inline int wsm_set_operational_mode(struct cw1200_common *priv,
1436 					const struct wsm_operational_mode *arg)
1437 {
1438 	u8 val = arg->power_mode;
1439 	if (arg->disable_more_flag_usage)
1440 		val |= BIT(4);
1441 	if (arg->perform_ant_diversity)
1442 		val |= BIT(5);
1443 	return wsm_write_mib(priv, WSM_MIB_ID_OPERATIONAL_POWER_MODE, &val,
1444 			     sizeof(val));
1445 }
1446 
1447 struct wsm_template_frame {
1448 	u8 frame_type;
1449 	u8 rate;
1450 	struct sk_buff *skb;
1451 };
1452 
1453 static inline int wsm_set_template_frame(struct cw1200_common *priv,
1454 					 struct wsm_template_frame *arg)
1455 {
1456 	int ret;
1457 	u8 *p = skb_push(arg->skb, 4);
1458 	p[0] = arg->frame_type;
1459 	p[1] = arg->rate;
1460 	((__le16 *)p)[1] = __cpu_to_le16(arg->skb->len - 4);
1461 	ret = wsm_write_mib(priv, WSM_MIB_ID_TEMPLATE_FRAME, p, arg->skb->len);
1462 	skb_pull(arg->skb, 4);
1463 	return ret;
1464 }
1465 
1466 
1467 struct wsm_protected_mgmt_policy {
1468 	bool protectedMgmtEnable;
1469 	bool unprotectedMgmtFramesAllowed;
1470 	bool encryptionForAuthFrame;
1471 };
1472 
1473 static inline int wsm_set_protected_mgmt_policy(struct cw1200_common *priv,
1474 		struct wsm_protected_mgmt_policy *arg)
1475 {
1476 	__le32 val = 0;
1477 	int ret;
1478 	if (arg->protectedMgmtEnable)
1479 		val |= __cpu_to_le32(BIT(0));
1480 	if (arg->unprotectedMgmtFramesAllowed)
1481 		val |= __cpu_to_le32(BIT(1));
1482 	if (arg->encryptionForAuthFrame)
1483 		val |= __cpu_to_le32(BIT(2));
1484 	ret = wsm_write_mib(priv, WSM_MIB_ID_PROTECTED_MGMT_POLICY,
1485 			&val, sizeof(val));
1486 	return ret;
1487 }
1488 
1489 struct wsm_mib_block_ack_policy {
1490 	u8 tx_tid;
1491 	u8 reserved1;
1492 	u8 rx_tid;
1493 	u8 reserved2;
1494 } __packed;
1495 
1496 static inline int wsm_set_block_ack_policy(struct cw1200_common *priv,
1497 					   u8 tx_tid_policy,
1498 					   u8 rx_tid_policy)
1499 {
1500 	struct wsm_mib_block_ack_policy val = {
1501 		.tx_tid = tx_tid_policy,
1502 		.rx_tid = rx_tid_policy,
1503 	};
1504 	return wsm_write_mib(priv, WSM_MIB_ID_BLOCK_ACK_POLICY, &val,
1505 			     sizeof(val));
1506 }
1507 
1508 struct wsm_mib_association_mode {
1509 	u8 flags;		/* WSM_ASSOCIATION_MODE_... */
1510 	u8 preamble;	/* WSM_JOIN_PREAMBLE_... */
1511 	u8 greenfield;	/* 1 for greenfield */
1512 	u8 mpdu_start_spacing;
1513 	__le32 basic_rate_set;
1514 } __packed;
1515 
1516 static inline int wsm_set_association_mode(struct cw1200_common *priv,
1517 					   struct wsm_mib_association_mode *arg)
1518 {
1519 	return wsm_write_mib(priv, WSM_MIB_ID_SET_ASSOCIATION_MODE, arg,
1520 			     sizeof(*arg));
1521 }
1522 
1523 #define WSM_TX_RATE_POLICY_FLAG_TERMINATE_WHEN_FINISHED BIT(2)
1524 #define WSM_TX_RATE_POLICY_FLAG_COUNT_INITIAL_TRANSMIT BIT(3)
1525 struct wsm_tx_rate_retry_policy {
1526 	u8 index;
1527 	u8 short_retries;
1528 	u8 long_retries;
1529 	/* BIT(2) - Terminate retries when Tx rate retry policy
1530 	 *          finishes.
1531 	 * BIT(3) - Count initial frame transmission as part of
1532 	 *          rate retry counting but not as a retry
1533 	 *          attempt
1534 	 */
1535 	u8 flags;
1536 	u8 rate_recoveries;
1537 	u8 reserved[3];
1538 	__le32 rate_count_indices[3];
1539 } __packed;
1540 
1541 struct wsm_set_tx_rate_retry_policy {
1542 	u8 num;
1543 	u8 reserved[3];
1544 	struct wsm_tx_rate_retry_policy tbl[8];
1545 } __packed;
1546 
1547 static inline int wsm_set_tx_rate_retry_policy(struct cw1200_common *priv,
1548 				struct wsm_set_tx_rate_retry_policy *arg)
1549 {
1550 	size_t size = 4 + arg->num * sizeof(struct wsm_tx_rate_retry_policy);
1551 	return wsm_write_mib(priv, WSM_MIB_ID_SET_TX_RATE_RETRY_POLICY, arg,
1552 			     size);
1553 }
1554 
1555 /* 4.32 SetEtherTypeDataFrameFilter */
1556 struct wsm_ether_type_filter_hdr {
1557 	u8 num;		/* Up to WSM_MAX_FILTER_ELEMENTS */
1558 	u8 reserved[3];
1559 } __packed;
1560 
1561 struct wsm_ether_type_filter {
1562 	u8 action;	/* WSM_FILTER_ACTION_XXX */
1563 	u8 reserved;
1564 	__le16 type;	/* Type of ethernet frame */
1565 } __packed;
1566 
1567 static inline int wsm_set_ether_type_filter(struct cw1200_common *priv,
1568 				struct wsm_ether_type_filter_hdr *arg)
1569 {
1570 	size_t size = sizeof(struct wsm_ether_type_filter_hdr) +
1571 		arg->num * sizeof(struct wsm_ether_type_filter);
1572 	return wsm_write_mib(priv, WSM_MIB_ID_SET_ETHERTYPE_DATAFRAME_FILTER,
1573 		arg, size);
1574 }
1575 
1576 /* 4.33 SetUDPPortDataFrameFilter */
1577 struct wsm_udp_port_filter_hdr {
1578 	u8 num;		/* Up to WSM_MAX_FILTER_ELEMENTS */
1579 	u8 reserved[3];
1580 } __packed;
1581 
1582 struct wsm_udp_port_filter {
1583 	u8 action;	/* WSM_FILTER_ACTION_XXX */
1584 	u8 type;		/* WSM_FILTER_PORT_TYPE_XXX */
1585 	__le16 port;		/* Port number */
1586 } __packed;
1587 
1588 static inline int wsm_set_udp_port_filter(struct cw1200_common *priv,
1589 				struct wsm_udp_port_filter_hdr *arg)
1590 {
1591 	size_t size = sizeof(struct wsm_udp_port_filter_hdr) +
1592 		arg->num * sizeof(struct wsm_udp_port_filter);
1593 	return wsm_write_mib(priv, WSM_MIB_ID_SET_UDPPORT_DATAFRAME_FILTER,
1594 		arg, size);
1595 }
1596 
1597 /* Undocumented MIBs: */
1598 /* 4.35 P2PDeviceInfo */
1599 #define D11_MAX_SSID_LEN		(32)
1600 
1601 struct wsm_p2p_device_type {
1602 	__le16 category_id;
1603 	u8 oui[4];
1604 	__le16 subcategory_id;
1605 } __packed;
1606 
1607 struct wsm_p2p_device_info {
1608 	struct wsm_p2p_device_type primaryDevice;
1609 	u8 reserved1[3];
1610 	u8 devname_size;
1611 	u8 local_devname[D11_MAX_SSID_LEN];
1612 	u8 reserved2[3];
1613 	u8 num_secdev_supported;
1614 	struct wsm_p2p_device_type secdevs[];
1615 } __packed;
1616 
1617 /* 4.36 SetWCDMABand - WO */
1618 struct wsm_cdma_band {
1619 	u8 wcdma_band;
1620 	u8 reserved[3];
1621 } __packed;
1622 
1623 /* 4.37 GroupTxSequenceCounter - RO */
1624 struct wsm_group_tx_seq {
1625 	__le32 bits_47_16;
1626 	__le16 bits_15_00;
1627 	__le16 reserved;
1628 } __packed;
1629 
1630 /* 4.39 SetHtProtection - WO */
1631 #define WSM_DUAL_CTS_PROT_ENB		(1 << 0)
1632 #define WSM_NON_GREENFIELD_STA_PRESENT  (1 << 1)
1633 #define WSM_HT_PROT_MODE__NO_PROT	(0 << 2)
1634 #define WSM_HT_PROT_MODE__NON_MEMBER	(1 << 2)
1635 #define WSM_HT_PROT_MODE__20_MHZ	(2 << 2)
1636 #define WSM_HT_PROT_MODE__NON_HT_MIXED	(3 << 2)
1637 #define WSM_LSIG_TXOP_PROT_FULL		(1 << 4)
1638 #define WSM_LARGE_L_LENGTH_PROT		(1 << 5)
1639 
1640 struct wsm_ht_protection {
1641 	__le32 flags;
1642 } __packed;
1643 
1644 /* 4.40 GPIO Command - R/W */
1645 #define WSM_GPIO_COMMAND_SETUP	0
1646 #define WSM_GPIO_COMMAND_READ	1
1647 #define WSM_GPIO_COMMAND_WRITE	2
1648 #define WSM_GPIO_COMMAND_RESET	3
1649 #define WSM_GPIO_ALL_PINS	0xFF
1650 
1651 struct wsm_gpio_command {
1652 	u8 command;
1653 	u8 pin;
1654 	__le16 config;
1655 } __packed;
1656 
1657 /* 4.41 TSFCounter - RO */
1658 struct wsm_tsf_counter {
1659 	__le64 tsf_counter;
1660 } __packed;
1661 
1662 /* 4.43 Keep alive period */
1663 struct wsm_keep_alive_period {
1664 	__le16 period;
1665 	u8 reserved[2];
1666 } __packed;
1667 
1668 static inline int wsm_keep_alive_period(struct cw1200_common *priv,
1669 					int period)
1670 {
1671 	struct wsm_keep_alive_period arg = {
1672 		.period = __cpu_to_le16(period),
1673 	};
1674 	return wsm_write_mib(priv, WSM_MIB_ID_KEEP_ALIVE_PERIOD,
1675 			&arg, sizeof(arg));
1676 };
1677 
1678 /* BSSID filtering */
1679 struct wsm_set_bssid_filtering {
1680 	u8 filter;
1681 	u8 reserved[3];
1682 } __packed;
1683 
1684 static inline int wsm_set_bssid_filtering(struct cw1200_common *priv,
1685 					  bool enabled)
1686 {
1687 	struct wsm_set_bssid_filtering arg = {
1688 		.filter = !enabled,
1689 	};
1690 	return wsm_write_mib(priv, WSM_MIB_ID_DISABLE_BSSID_FILTER,
1691 			&arg, sizeof(arg));
1692 }
1693 
1694 /* Multicast filtering - 4.5 */
1695 struct wsm_mib_multicast_filter {
1696 	__le32 enable;
1697 	__le32 num_addrs;
1698 	u8 macaddrs[WSM_MAX_GRP_ADDRTABLE_ENTRIES][ETH_ALEN];
1699 } __packed;
1700 
1701 static inline int wsm_set_multicast_filter(struct cw1200_common *priv,
1702 					   struct wsm_mib_multicast_filter *fp)
1703 {
1704 	return wsm_write_mib(priv, WSM_MIB_ID_DOT11_GROUP_ADDRESSES_TABLE,
1705 			     fp, sizeof(*fp));
1706 }
1707 
1708 /* ARP IPv4 filtering - 4.10 */
1709 struct wsm_mib_arp_ipv4_filter {
1710 	__le32 enable;
1711 	__be32 ipv4addrs[WSM_MAX_ARP_IP_ADDRTABLE_ENTRIES];
1712 } __packed;
1713 
1714 static inline int wsm_set_arp_ipv4_filter(struct cw1200_common *priv,
1715 					  struct wsm_mib_arp_ipv4_filter *fp)
1716 {
1717 	return wsm_write_mib(priv, WSM_MIB_ID_ARP_IP_ADDRESSES_TABLE,
1718 			    fp, sizeof(*fp));
1719 }
1720 
1721 /* P2P Power Save Mode Info - 4.31 */
1722 struct wsm_p2p_ps_modeinfo {
1723 	u8	opp_ps_ct_window;
1724 	u8	count;
1725 	u8	reserved;
1726 	u8	dtim_count;
1727 	__le32	duration;
1728 	__le32	interval;
1729 	__le32	start_time;
1730 } __packed;
1731 
1732 static inline int wsm_set_p2p_ps_modeinfo(struct cw1200_common *priv,
1733 					  struct wsm_p2p_ps_modeinfo *mi)
1734 {
1735 	return wsm_write_mib(priv, WSM_MIB_ID_P2P_PS_MODE_INFO,
1736 			     mi, sizeof(*mi));
1737 }
1738 
1739 static inline int wsm_get_p2p_ps_modeinfo(struct cw1200_common *priv,
1740 					  struct wsm_p2p_ps_modeinfo *mi)
1741 {
1742 	return wsm_read_mib(priv, WSM_MIB_ID_P2P_PS_MODE_INFO,
1743 			    mi, sizeof(*mi));
1744 }
1745 
1746 /* UseMultiTxConfMessage */
1747 
1748 static inline int wsm_use_multi_tx_conf(struct cw1200_common *priv,
1749 					bool enabled)
1750 {
1751 	__le32 arg = enabled ? __cpu_to_le32(1) : 0;
1752 
1753 	return wsm_write_mib(priv, WSM_MIB_USE_MULTI_TX_CONF,
1754 			&arg, sizeof(arg));
1755 }
1756 
1757 
1758 /* 4.26 SetUpasdInformation */
1759 struct wsm_uapsd_info {
1760 	__le16 uapsd_flags;
1761 	__le16 min_auto_trigger_interval;
1762 	__le16 max_auto_trigger_interval;
1763 	__le16 auto_trigger_step;
1764 };
1765 
1766 static inline int wsm_set_uapsd_info(struct cw1200_common *priv,
1767 				     struct wsm_uapsd_info *arg)
1768 {
1769 	return wsm_write_mib(priv, WSM_MIB_ID_SET_UAPSD_INFORMATION,
1770 				arg, sizeof(*arg));
1771 }
1772 
1773 /* 4.22 OverrideInternalTxRate */
1774 struct wsm_override_internal_txrate {
1775 	u8 internalTxRate;
1776 	u8 nonErpInternalTxRate;
1777 	u8 reserved[2];
1778 } __packed;
1779 
1780 static inline int wsm_set_override_internal_txrate(struct cw1200_common *priv,
1781 				     struct wsm_override_internal_txrate *arg)
1782 {
1783 	return wsm_write_mib(priv, WSM_MIB_ID_OVERRIDE_INTERNAL_TX_RATE,
1784 				arg, sizeof(*arg));
1785 }
1786 
1787 /* ******************************************************************** */
1788 /* WSM TX port control							*/
1789 
1790 void wsm_lock_tx(struct cw1200_common *priv);
1791 void wsm_lock_tx_async(struct cw1200_common *priv);
1792 bool wsm_flush_tx(struct cw1200_common *priv);
1793 void wsm_unlock_tx(struct cw1200_common *priv);
1794 
1795 /* ******************************************************************** */
1796 /* WSM / BH API								*/
1797 
1798 int wsm_handle_exception(struct cw1200_common *priv, u8 *data, size_t len);
1799 int wsm_handle_rx(struct cw1200_common *priv, u16 id, struct wsm_hdr *wsm,
1800 		  struct sk_buff **skb_p);
1801 
1802 /* ******************************************************************** */
1803 /* wsm_buf API								*/
1804 
1805 struct wsm_buf {
1806 	u8 *begin;
1807 	u8 *data;
1808 	u8 *end;
1809 };
1810 
1811 void wsm_buf_init(struct wsm_buf *buf);
1812 void wsm_buf_deinit(struct wsm_buf *buf);
1813 
1814 /* ******************************************************************** */
1815 /* wsm_cmd API								*/
1816 
1817 struct wsm_cmd {
1818 	spinlock_t lock; /* Protect structure from multiple access */
1819 	int done;
1820 	u8 *ptr;
1821 	size_t len;
1822 	void *arg;
1823 	int ret;
1824 	u16 cmd;
1825 };
1826 
1827 /* ******************************************************************** */
1828 /* WSM TX buffer access							*/
1829 
1830 int wsm_get_tx(struct cw1200_common *priv, u8 **data,
1831 	       size_t *tx_len, int *burst);
1832 void wsm_txed(struct cw1200_common *priv, u8 *data);
1833 
1834 /* ******************************************************************** */
1835 /* Queue mapping: WSM <---> linux					*/
1836 /* Linux: VO VI BE BK							*/
1837 /* WSM:   BE BK VI VO							*/
1838 
1839 static inline u8 wsm_queue_id_to_linux(u8 queue_id)
1840 {
1841 	static const u8 queue_mapping[] = {
1842 		2, 3, 1, 0
1843 	};
1844 	return queue_mapping[queue_id];
1845 }
1846 
1847 static inline u8 wsm_queue_id_to_wsm(u8 queue_id)
1848 {
1849 	static const u8 queue_mapping[] = {
1850 		3, 2, 0, 1
1851 	};
1852 	return queue_mapping[queue_id];
1853 }
1854 
1855 #endif /* CW1200_HWIO_H_INCLUDED */
1856