WIP FPC-III support
[linux/fpc-iii.git] / drivers / net / wireless / st / cw1200 / wsm.h
blob1ffa47994bb93ccad4cd3980f5f16ba9f3da8e4a
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3 * WSM host interface (HI) interface for ST-Ericsson CW1200 mac80211 drivers
5 * Copyright (c) 2010, ST-Ericsson
6 * Author: Dmitry Tarnyagin <dmitry.tarnyagin@lockless.no>
8 * Based on CW1200 UMAC WSM API, which is
9 * Copyright (C) ST-Ericsson SA 2010
10 * Author: Stewart Mathers <stewart.mathers@stericsson.com>
13 #ifndef CW1200_WSM_H_INCLUDED
14 #define CW1200_WSM_H_INCLUDED
16 #include <linux/spinlock.h>
18 struct cw1200_common;
20 /* Bands */
21 /* Radio band 2.412 -2.484 GHz. */
22 #define WSM_PHY_BAND_2_4G (0)
24 /* Radio band 4.9375-5.8250 GHz. */
25 #define WSM_PHY_BAND_5G (1)
27 /* Transmit rates */
28 /* 1 Mbps ERP-DSSS */
29 #define WSM_TRANSMIT_RATE_1 (0)
31 /* 2 Mbps ERP-DSSS */
32 #define WSM_TRANSMIT_RATE_2 (1)
34 /* 5.5 Mbps ERP-CCK */
35 #define WSM_TRANSMIT_RATE_5 (2)
37 /* 11 Mbps ERP-CCK */
38 #define WSM_TRANSMIT_RATE_11 (3)
40 /* 22 Mbps ERP-PBCC (Not supported) */
41 /* #define WSM_TRANSMIT_RATE_22 (4) */
43 /* 33 Mbps ERP-PBCC (Not supported) */
44 /* #define WSM_TRANSMIT_RATE_33 (5) */
46 /* 6 Mbps (3 Mbps) ERP-OFDM, BPSK coding rate 1/2 */
47 #define WSM_TRANSMIT_RATE_6 (6)
49 /* 9 Mbps (4.5 Mbps) ERP-OFDM, BPSK coding rate 3/4 */
50 #define WSM_TRANSMIT_RATE_9 (7)
52 /* 12 Mbps (6 Mbps) ERP-OFDM, QPSK coding rate 1/2 */
53 #define WSM_TRANSMIT_RATE_12 (8)
55 /* 18 Mbps (9 Mbps) ERP-OFDM, QPSK coding rate 3/4 */
56 #define WSM_TRANSMIT_RATE_18 (9)
58 /* 24 Mbps (12 Mbps) ERP-OFDM, 16QAM coding rate 1/2 */
59 #define WSM_TRANSMIT_RATE_24 (10)
61 /* 36 Mbps (18 Mbps) ERP-OFDM, 16QAM coding rate 3/4 */
62 #define WSM_TRANSMIT_RATE_36 (11)
64 /* 48 Mbps (24 Mbps) ERP-OFDM, 64QAM coding rate 1/2 */
65 #define WSM_TRANSMIT_RATE_48 (12)
67 /* 54 Mbps (27 Mbps) ERP-OFDM, 64QAM coding rate 3/4 */
68 #define WSM_TRANSMIT_RATE_54 (13)
70 /* 6.5 Mbps HT-OFDM, BPSK coding rate 1/2 */
71 #define WSM_TRANSMIT_RATE_HT_6 (14)
73 /* 13 Mbps HT-OFDM, QPSK coding rate 1/2 */
74 #define WSM_TRANSMIT_RATE_HT_13 (15)
76 /* 19.5 Mbps HT-OFDM, QPSK coding rate 3/4 */
77 #define WSM_TRANSMIT_RATE_HT_19 (16)
79 /* 26 Mbps HT-OFDM, 16QAM coding rate 1/2 */
80 #define WSM_TRANSMIT_RATE_HT_26 (17)
82 /* 39 Mbps HT-OFDM, 16QAM coding rate 3/4 */
83 #define WSM_TRANSMIT_RATE_HT_39 (18)
85 /* 52 Mbps HT-OFDM, 64QAM coding rate 2/3 */
86 #define WSM_TRANSMIT_RATE_HT_52 (19)
88 /* 58.5 Mbps HT-OFDM, 64QAM coding rate 3/4 */
89 #define WSM_TRANSMIT_RATE_HT_58 (20)
91 /* 65 Mbps HT-OFDM, 64QAM coding rate 5/6 */
92 #define WSM_TRANSMIT_RATE_HT_65 (21)
94 /* Scan types */
95 /* Foreground scan */
96 #define WSM_SCAN_TYPE_FOREGROUND (0)
98 /* Background scan */
99 #define WSM_SCAN_TYPE_BACKGROUND (1)
101 /* Auto scan */
102 #define WSM_SCAN_TYPE_AUTO (2)
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))
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))
115 /* Preamble Type. Long if not set. */
116 #define WSM_SCAN_FLAG_SHORT_PREAMBLE (BIT(2))
118 /* 11n Tx Mode. Mixed if not set. */
119 #define WSM_SCAN_FLAG_11N_GREENFIELD (BIT(3))
121 /* Scan constraints */
122 /* Maximum number of channels to be scanned. */
123 #define WSM_SCAN_MAX_NUM_OF_CHANNELS (48)
125 /* The maximum number of SSIDs that the device can scan for. */
126 #define WSM_SCAN_MAX_NUM_OF_SSIDS (2)
128 /* Power management modes */
129 /* 802.11 Active mode */
130 #define WSM_PSM_ACTIVE (0)
132 /* 802.11 PS mode */
133 #define WSM_PSM_PS BIT(0)
135 /* Fast Power Save bit */
136 #define WSM_PSM_FAST_PS_FLAG BIT(7)
138 /* Dynamic aka Fast power save */
139 #define WSM_PSM_FAST_PS (BIT(0) | BIT(7))
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)
147 /* Queue IDs */
148 /* best effort/legacy */
149 #define WSM_QUEUE_BEST_EFFORT (0)
151 /* background */
152 #define WSM_QUEUE_BACKGROUND (1)
154 /* video */
155 #define WSM_QUEUE_VIDEO (2)
157 /* voice */
158 #define WSM_QUEUE_VOICE (3)
160 /* HT TX parameters */
161 /* Non-HT */
162 #define WSM_HT_TX_NON_HT (0)
164 /* Mixed format */
165 #define WSM_HT_TX_MIXED (1)
167 /* Greenfield format */
168 #define WSM_HT_TX_GREENFIELD (2)
170 /* STBC allowed */
171 #define WSM_HT_TX_STBC (BIT(7))
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
189 /* TX status */
190 /* Frame was sent aggregated */
191 /* Only valid for WSM_SUCCESS status. */
192 #define WSM_TX_STATUS_AGGREGATION (BIT(0))
194 /* Host should requeue this frame later. */
195 /* Valid only when status is WSM_REQUEUE. */
196 #define WSM_TX_STATUS_REQUEUE (BIT(1))
198 /* Normal Ack */
199 #define WSM_TX_STATUS_NORMAL_ACK (0<<2)
201 /* No Ack */
202 #define WSM_TX_STATUS_NO_ACK (1<<2)
204 /* No explicit acknowledgement */
205 #define WSM_TX_STATUS_NO_EXPLICIT_ACK (2<<2)
207 /* Block Ack */
208 /* Only valid for WSM_SUCCESS status. */
209 #define WSM_TX_STATUS_BLOCK_ACK (3<<2)
211 /* RX status */
212 /* Unencrypted */
213 #define WSM_RX_STATUS_UNENCRYPTED (0<<0)
215 /* WEP */
216 #define WSM_RX_STATUS_WEP (1<<0)
218 /* TKIP */
219 #define WSM_RX_STATUS_TKIP (2<<0)
221 /* AES */
222 #define WSM_RX_STATUS_AES (3<<0)
224 /* WAPI */
225 #define WSM_RX_STATUS_WAPI (4<<0)
227 /* Macro to fetch encryption subfield. */
228 #define WSM_RX_STATUS_ENCRYPTION(status) ((status) & 0x07)
230 /* Frame was part of an aggregation */
231 #define WSM_RX_STATUS_AGGREGATE (BIT(3))
233 /* Frame was first in the aggregation */
234 #define WSM_RX_STATUS_AGGREGATE_FIRST (BIT(4))
236 /* Frame was last in the aggregation */
237 #define WSM_RX_STATUS_AGGREGATE_LAST (BIT(5))
239 /* Indicates a defragmented frame */
240 #define WSM_RX_STATUS_DEFRAGMENTED (BIT(6))
242 /* Indicates a Beacon frame */
243 #define WSM_RX_STATUS_BEACON (BIT(7))
245 /* Indicates STA bit beacon TIM field */
246 #define WSM_RX_STATUS_TIM (BIT(8))
248 /* Indicates Beacon frame's virtual bitmap contains multicast bit */
249 #define WSM_RX_STATUS_MULTICAST (BIT(9))
251 /* Indicates frame contains a matching SSID */
252 #define WSM_RX_STATUS_MATCHING_SSID (BIT(10))
254 /* Indicates frame contains a matching BSSI */
255 #define WSM_RX_STATUS_MATCHING_BSSI (BIT(11))
257 /* Indicates More bit set in Framectl field */
258 #define WSM_RX_STATUS_MORE_DATA (BIT(12))
260 /* Indicates frame received during a measurement process */
261 #define WSM_RX_STATUS_MEASUREMENT (BIT(13))
263 /* Indicates frame received as an HT packet */
264 #define WSM_RX_STATUS_HT (BIT(14))
266 /* Indicates frame received with STBC */
267 #define WSM_RX_STATUS_STBC (BIT(15))
269 /* Indicates Address 1 field matches dot11StationId */
270 #define WSM_RX_STATUS_ADDRESS1 (BIT(16))
272 /* Indicates Group address present in the Address 1 field */
273 #define WSM_RX_STATUS_GROUP (BIT(17))
275 /* Indicates Broadcast address present in the Address 1 field */
276 #define WSM_RX_STATUS_BROADCAST (BIT(18))
278 /* Indicates group key used with encrypted frames */
279 #define WSM_RX_STATUS_GROUP_KEY (BIT(19))
281 /* Macro to fetch encryption key index. */
282 #define WSM_RX_STATUS_KEY_IDX(status) (((status >> 20)) & 0x0F)
284 /* Indicates TSF inclusion after 802.11 frame body */
285 #define WSM_RX_STATUS_TSF_INCLUDED (BIT(24))
287 /* Frame Control field starts at Frame offset + 2 */
288 #define WSM_TX_2BYTES_SHIFT (BIT(7))
290 /* Join mode */
291 /* IBSS */
292 #define WSM_JOIN_MODE_IBSS (0)
294 /* BSS */
295 #define WSM_JOIN_MODE_BSS (1)
297 /* PLCP preamble type */
298 /* For long preamble */
299 #define WSM_JOIN_PREAMBLE_LONG (0)
301 /* For short preamble (Long for 1Mbps) */
302 #define WSM_JOIN_PREAMBLE_SHORT (1)
304 /* For short preamble (Long for 1 and 2Mbps) */
305 #define WSM_JOIN_PREAMBLE_SHORT_2 (2)
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.
316 #define WSM_JOIN_FLAGS_FORCE BIT(2)
317 /* Give probe request/response higher
318 * priority over the BT traffic
320 #define WSM_JOIN_FLAGS_PRIO BIT(3)
321 /* Issue immediate join confirmation and use
322 * join complete to notify about completion
324 #define WSM_JOIN_FLAGS_FORCE_WITH_COMPLETE_IND BIT(5)
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)
336 /* Key indexes */
337 #define WSM_KEY_MAX_INDEX (10)
339 /* ACK policy */
340 #define WSM_ACK_POLICY_NORMAL (0)
341 #define WSM_ACK_POLICY_NO_ACK (1)
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 */
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))
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))
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))
366 /* WSM events */
367 /* Error */
368 #define WSM_EVENT_ERROR (0)
370 /* BSS lost */
371 #define WSM_EVENT_BSS_LOST (1)
373 /* BSS regained */
374 #define WSM_EVENT_BSS_REGAINED (2)
376 /* Radar detected */
377 #define WSM_EVENT_RADAR_DETECTED (3)
379 /* RCPI or RSSI threshold triggered */
380 #define WSM_EVENT_RCPI_RSSI (4)
382 /* BT inactive */
383 #define WSM_EVENT_BT_INACTIVE (5)
385 /* BT active */
386 #define WSM_EVENT_BT_ACTIVE (6)
388 /* MIB IDs */
389 /* 4.1 dot11StationId */
390 #define WSM_MIB_ID_DOT11_STATION_ID 0x0000
392 /* 4.2 dot11MaxtransmitMsduLifeTime */
393 #define WSM_MIB_ID_DOT11_MAX_TRANSMIT_LIFTIME 0x0001
395 /* 4.3 dot11MaxReceiveLifeTime */
396 #define WSM_MIB_ID_DOT11_MAX_RECEIVE_LIFETIME 0x0002
398 /* 4.4 dot11SlotTime */
399 #define WSM_MIB_ID_DOT11_SLOT_TIME 0x0003
401 /* 4.5 dot11GroupAddressesTable */
402 #define WSM_MIB_ID_DOT11_GROUP_ADDRESSES_TABLE 0x0004
403 #define WSM_MAX_GRP_ADDRTABLE_ENTRIES 8
405 /* 4.6 dot11WepDefaultKeyId */
406 #define WSM_MIB_ID_DOT11_WEP_DEFAULT_KEY_ID 0x0005
408 /* 4.7 dot11CurrentTxPowerLevel */
409 #define WSM_MIB_ID_DOT11_CURRENT_TX_POWER_LEVEL 0x0006
411 /* 4.8 dot11RTSThreshold */
412 #define WSM_MIB_ID_DOT11_RTS_THRESHOLD 0x0007
414 /* 4.9 NonErpProtection */
415 #define WSM_MIB_ID_NON_ERP_PROTECTION 0x1000
417 /* 4.10 ArpIpAddressesTable */
418 #define WSM_MIB_ID_ARP_IP_ADDRESSES_TABLE 0x1001
419 #define WSM_MAX_ARP_IP_ADDRTABLE_ENTRIES 1
421 /* 4.11 TemplateFrame */
422 #define WSM_MIB_ID_TEMPLATE_FRAME 0x1002
424 /* 4.12 RxFilter */
425 #define WSM_MIB_ID_RX_FILTER 0x1003
427 /* 4.13 BeaconFilterTable */
428 #define WSM_MIB_ID_BEACON_FILTER_TABLE 0x1004
430 /* 4.14 BeaconFilterEnable */
431 #define WSM_MIB_ID_BEACON_FILTER_ENABLE 0x1005
433 /* 4.15 OperationalPowerMode */
434 #define WSM_MIB_ID_OPERATIONAL_POWER_MODE 0x1006
436 /* 4.16 BeaconWakeUpPeriod */
437 #define WSM_MIB_ID_BEACON_WAKEUP_PERIOD 0x1007
439 /* 4.17 RcpiRssiThreshold */
440 #define WSM_MIB_ID_RCPI_RSSI_THRESHOLD 0x1009
442 /* 4.18 StatisticsTable */
443 #define WSM_MIB_ID_STATISTICS_TABLE 0x100A
445 /* 4.19 IbssPsConfig */
446 #define WSM_MIB_ID_IBSS_PS_CONFIG 0x100B
448 /* 4.20 CountersTable */
449 #define WSM_MIB_ID_COUNTERS_TABLE 0x100C
451 /* 4.21 BlockAckPolicy */
452 #define WSM_MIB_ID_BLOCK_ACK_POLICY 0x100E
454 /* 4.22 OverrideInternalTxRate */
455 #define WSM_MIB_ID_OVERRIDE_INTERNAL_TX_RATE 0x100F
457 /* 4.23 SetAssociationMode */
458 #define WSM_MIB_ID_SET_ASSOCIATION_MODE 0x1010
460 /* 4.24 UpdateEptaConfigData */
461 #define WSM_MIB_ID_UPDATE_EPTA_CONFIG_DATA 0x1011
463 /* 4.25 SelectCcaMethod */
464 #define WSM_MIB_ID_SELECT_CCA_METHOD 0x1012
466 /* 4.26 SetUpasdInformation */
467 #define WSM_MIB_ID_SET_UAPSD_INFORMATION 0x1013
469 /* 4.27 SetAutoCalibrationMode WBF00004073 */
470 #define WSM_MIB_ID_SET_AUTO_CALIBRATION_MODE 0x1015
472 /* 4.28 SetTxRateRetryPolicy */
473 #define WSM_MIB_ID_SET_TX_RATE_RETRY_POLICY 0x1016
475 /* 4.29 SetHostMessageTypeFilter */
476 #define WSM_MIB_ID_SET_HOST_MSG_TYPE_FILTER 0x1017
478 /* 4.30 P2PFindInfo */
479 #define WSM_MIB_ID_P2P_FIND_INFO 0x1018
481 /* 4.31 P2PPsModeInfo */
482 #define WSM_MIB_ID_P2P_PS_MODE_INFO 0x1019
484 /* 4.32 SetEtherTypeDataFrameFilter */
485 #define WSM_MIB_ID_SET_ETHERTYPE_DATAFRAME_FILTER 0x101A
487 /* 4.33 SetUDPPortDataFrameFilter */
488 #define WSM_MIB_ID_SET_UDPPORT_DATAFRAME_FILTER 0x101B
490 /* 4.34 SetMagicDataFrameFilter */
491 #define WSM_MIB_ID_SET_MAGIC_DATAFRAME_FILTER 0x101C
493 /* 4.35 P2PDeviceInfo */
494 #define WSM_MIB_ID_P2P_DEVICE_INFO 0x101D
496 /* 4.36 SetWCDMABand */
497 #define WSM_MIB_ID_SET_WCDMA_BAND 0x101E
499 /* 4.37 GroupTxSequenceCounter */
500 #define WSM_MIB_ID_GRP_SEQ_COUNTER 0x101F
502 /* 4.38 ProtectedMgmtPolicy */
503 #define WSM_MIB_ID_PROTECTED_MGMT_POLICY 0x1020
505 /* 4.39 SetHtProtection */
506 #define WSM_MIB_ID_SET_HT_PROTECTION 0x1021
508 /* 4.40 GPIO Command */
509 #define WSM_MIB_ID_GPIO_COMMAND 0x1022
511 /* 4.41 TSF Counter Value */
512 #define WSM_MIB_ID_TSF_COUNTER 0x1023
514 /* Test Purposes Only */
515 #define WSM_MIB_ID_BLOCK_ACK_INFO 0x100D
517 /* 4.42 UseMultiTxConfMessage */
518 #define WSM_MIB_USE_MULTI_TX_CONF 0x1024
520 /* 4.43 Keep-alive period */
521 #define WSM_MIB_ID_KEEP_ALIVE_PERIOD 0x1025
523 /* 4.44 Disable BSSID filter */
524 #define WSM_MIB_ID_DISABLE_BSSID_FILTER 0x1026
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)
534 #define WSM_FRAME_GREENFIELD (0x80) /* See 4.11 */
536 /* Status */
537 /* The WSM firmware has completed a request */
538 /* successfully. */
539 #define WSM_STATUS_SUCCESS (0)
541 /* This is a generic failure code if other error codes do */
542 /* not apply. */
543 #define WSM_STATUS_FAILURE (1)
545 /* A request contains one or more invalid parameters. */
546 #define WSM_INVALID_PARAMETER (2)
548 /* The request cannot perform because the device is in */
549 /* an inappropriate mode. */
550 #define WSM_ACCESS_DENIED (3)
552 /* The frame received includes a decryption error. */
553 #define WSM_STATUS_DECRYPTFAILURE (4)
555 /* A MIC failure is detected in the received packets. */
556 #define WSM_STATUS_MICFAILURE (5)
558 /* The transmit request failed due to retry limit being */
559 /* exceeded. */
560 #define WSM_STATUS_RETRY_EXCEEDED (6)
562 /* The transmit request failed due to MSDU life time */
563 /* being exceeded. */
564 #define WSM_STATUS_TX_LIFETIME_EXCEEDED (7)
566 /* The link to the AP is lost. */
567 #define WSM_STATUS_LINK_LOST (8)
569 /* No key was found for the encrypted frame */
570 #define WSM_STATUS_NO_KEY_FOUND (9)
572 /* Jammer was detected when transmitting this frame */
573 #define WSM_STATUS_JAMMER_DETECTED (10)
575 /* The message should be requeued later. */
576 /* This is applicable only to Transmit */
577 #define WSM_REQUEUE (11)
579 /* Advanced filtering options */
580 #define WSM_MAX_FILTER_ELEMENTS (4)
582 #define WSM_FILTER_ACTION_IGNORE (0)
583 #define WSM_FILTER_ACTION_FILTER_IN (1)
584 #define WSM_FILTER_ACTION_FILTER_OUT (2)
586 #define WSM_FILTER_PORT_TYPE_DST (0)
587 #define WSM_FILTER_PORT_TYPE_SRC (1)
589 /* Actual header of WSM messages */
590 struct wsm_hdr {
591 __le16 len;
592 __le16 id;
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)
602 #define MAX_BEACON_SKIP_TIME_MS 1000
604 #define WSM_CMD_LAST_CHANCE_TIMEOUT (HZ * 3 / 2)
606 /* ******************************************************************** */
607 /* WSM capability */
609 #define WSM_STARTUP_IND_ID 0x0801
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];
626 /* ******************************************************************** */
627 /* WSM commands */
629 /* 3.1 */
630 #define WSM_CONFIGURATION_REQ_ID 0x0009
631 #define WSM_CONFIGURATION_RESP_ID 0x0409
633 struct wsm_tx_power_range {
634 int min_power_level;
635 int max_power_level;
636 u32 stepping;
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];
651 int wsm_configuration(struct cw1200_common *priv,
652 struct wsm_configuration *arg);
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;
662 int wsm_reset(struct cw1200_common *priv, const struct wsm_reset *arg);
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);
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);
676 /* 3.9 */
677 #define WSM_START_SCAN_REQ_ID 0x0007
678 #define WSM_START_SCAN_RESP_ID 0x0407
680 struct wsm_ssid {
681 u8 ssid[32];
682 u32 length;
685 struct wsm_scan_ch {
686 u16 number;
687 u32 min_chan_time;
688 u32 max_chan_time;
689 u32 tx_power_level;
692 struct wsm_scan {
693 /* WSM_PHY_BAND_... */
694 u8 band;
696 /* WSM_SCAN_TYPE_... */
697 u8 type;
699 /* WSM_SCAN_FLAG_... */
700 u8 flags;
702 /* WSM_TRANSMIT_RATE_... */
703 u8 max_tx_rate;
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;
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;
717 /* Number of channels to be scanned. */
718 /* Maximum value is WSM_SCAN_MAX_NUM_OF_CHANNELS. */
719 u8 num_channels;
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;
726 /* The delay time (in microseconds) period */
727 /* before sending a probe-request. */
728 u8 probe_delay;
730 /* SSIDs to be scanned [numOfSSIDs]; */
731 struct wsm_ssid *ssids;
733 /* Channels to be scanned [numOfChannels]; */
734 struct wsm_scan_ch *ch;
737 int wsm_scan(struct cw1200_common *priv, const struct wsm_scan *arg);
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);
744 /* 3.13 */
745 #define WSM_SCAN_COMPLETE_IND_ID 0x0806
746 struct wsm_scan_complete {
747 /* WSM_STATUS_... */
748 u32 status;
750 /* WSM_PSM_... */
751 u8 psm;
753 /* Number of channels that the scan operation completed. */
754 u8 num_channels;
757 /* 3.14 */
758 #define WSM_TX_CONFIRM_IND_ID 0x0404
759 #define WSM_MULTI_TX_CONFIRM_ID 0x041E
761 struct wsm_tx_confirm {
762 /* Packet identifier used in wsm_tx. */
763 u32 packet_id;
765 /* WSM_STATUS_... */
766 u32 status;
768 /* WSM_TRANSMIT_RATE_... */
769 u8 tx_rate;
771 /* The number of times the frame was transmitted */
772 /* without receiving an acknowledgement. */
773 u8 ack_failures;
775 /* WSM_TX_STATUS_... */
776 u16 flags;
778 /* The total time in microseconds that the frame spent in */
779 /* the WLAN device before transmission as completed. */
780 u32 media_delay;
782 /* The total time in microseconds that the frame spent in */
783 /* the WLAN device before transmission was started. */
784 u32 tx_queue_delay;
787 /* 3.15 */
788 typedef void (*wsm_tx_confirm_cb) (struct cw1200_common *priv,
789 struct wsm_tx_confirm *arg);
791 /* Note that ideology of wsm_tx struct is different against the rest of
792 * WSM API. wsm_hdr is /not/ a caller-adapted struct to be used as an input
793 * argument for WSM call, but a prepared bytestream to be sent to firmware.
794 * It is filled partly in cw1200_tx, partly in low-level WSM code.
795 * Please pay attention once again: ideology is different.
797 * Legend:
798 * - [in]: cw1200_tx must fill this field.
799 * - [wsm]: the field is filled by low-level WSM.
801 struct wsm_tx {
802 /* common WSM header */
803 struct wsm_hdr hdr;
805 /* Packet identifier that meant to be used in completion. */
806 u32 packet_id; /* Note this is actually a cookie */
808 /* WSM_TRANSMIT_RATE_... */
809 u8 max_tx_rate;
811 /* WSM_QUEUE_... */
812 u8 queue_id;
814 /* True: another packet is pending on the host for transmission. */
815 u8 more;
817 /* Bit 0 = 0 - Start expiry time from first Tx attempt (default) */
818 /* Bit 0 = 1 - Start expiry time from receipt of Tx Request */
819 /* Bits 3:1 - PTA Priority */
820 /* Bits 6:4 - Tx Rate Retry Policy */
821 /* Bit 7 - Reserved */
822 u8 flags;
824 /* Should be 0. */
825 u32 reserved;
827 /* The elapsed time in TUs, after the initial transmission */
828 /* of an MSDU, after which further attempts to transmit */
829 /* the MSDU shall be terminated. Overrides the global */
830 /* dot11MaxTransmitMsduLifeTime setting [optional] */
831 /* Device will set the default value if this is 0. */
832 __le32 expire_time;
834 /* WSM_HT_TX_... */
835 __le32 ht_tx_parameters;
836 } __packed;
838 /* = sizeof(generic hi hdr) + sizeof(wsm hdr) + sizeof(alignment) */
839 #define WSM_TX_EXTRA_HEADROOM (28)
841 /* 3.16 */
842 #define WSM_RECEIVE_IND_ID 0x0804
844 struct wsm_rx {
845 /* WSM_STATUS_... */
846 u32 status;
848 /* Specifies the channel of the received packet. */
849 u16 channel_number;
851 /* WSM_TRANSMIT_RATE_... */
852 u8 rx_rate;
854 /* This value is expressed in signed Q8.0 format for */
855 /* RSSI and unsigned Q7.1 format for RCPI. */
856 u8 rcpi_rssi;
858 /* WSM_RX_STATUS_... */
859 u32 flags;
862 /* = sizeof(generic hi hdr) + sizeof(wsm hdr) */
863 #define WSM_RX_EXTRA_HEADROOM (16)
865 typedef void (*wsm_rx_cb) (struct cw1200_common *priv, struct wsm_rx *arg,
866 struct sk_buff **skb_p);
868 /* 3.17 */
869 struct wsm_event {
870 /* WSM_STATUS_... */
871 /* [out] */ u32 id;
873 /* Indication parameters. */
874 /* For error indication, this shall be a 32-bit WSM status. */
875 /* For RCPI or RSSI indication, this should be an 8-bit */
876 /* RCPI or RSSI value. */
877 /* [out] */ u32 data;
880 struct cw1200_wsm_event {
881 struct list_head link;
882 struct wsm_event evt;
885 /* 3.18 - 3.22 */
886 /* Measurement. Skipped for now. Irrelevent. */
888 typedef void (*wsm_event_cb) (struct cw1200_common *priv,
889 struct wsm_event *arg);
891 /* 3.23 */
892 #define WSM_JOIN_REQ_ID 0x000B
893 #define WSM_JOIN_RESP_ID 0x040B
895 struct wsm_join {
896 /* WSM_JOIN_MODE_... */
897 u8 mode;
899 /* WSM_PHY_BAND_... */
900 u8 band;
902 /* Specifies the channel number to join. The channel */
903 /* number will be mapped to an actual frequency */
904 /* according to the band */
905 u16 channel_number;
907 /* Specifies the BSSID of the BSS or IBSS to be joined */
908 /* or the IBSS to be started. */
909 u8 bssid[6];
911 /* ATIM window of IBSS */
912 /* When ATIM window is zero the initiated IBSS does */
913 /* not support power saving. */
914 u16 atim_window;
916 /* WSM_JOIN_PREAMBLE_... */
917 u8 preamble_type;
919 /* Specifies if a probe request should be send with the */
920 /* specified SSID when joining to the network. */
921 u8 probe_for_join;
923 /* DTIM Period (In multiples of beacon interval) */
924 u8 dtim_period;
926 /* WSM_JOIN_FLAGS_... */
927 u8 flags;
929 /* Length of the SSID */
930 u32 ssid_len;
932 /* Specifies the SSID of the IBSS to join or start */
933 u8 ssid[32];
935 /* Specifies the time between TBTTs in TUs */
936 u32 beacon_interval;
938 /* A bit mask that defines the BSS basic rate set. */
939 u32 basic_rate_set;
942 struct wsm_join_cnf {
943 u32 status;
945 /* Minimum transmission power level in units of 0.1dBm */
946 u32 min_power_level;
948 /* Maximum transmission power level in units of 0.1dBm */
949 u32 max_power_level;
952 int wsm_join(struct cw1200_common *priv, struct wsm_join *arg);
954 /* 3.24 */
955 struct wsm_join_complete {
956 /* WSM_STATUS_... */
957 u32 status;
960 /* 3.25 */
961 #define WSM_SET_PM_REQ_ID 0x0010
962 #define WSM_SET_PM_RESP_ID 0x0410
963 struct wsm_set_pm {
964 /* WSM_PSM_... */
965 u8 mode;
967 /* in unit of 500us; 0 to use default */
968 u8 fast_psm_idle_period;
970 /* in unit of 500us; 0 to use default */
971 u8 ap_psm_change_period;
973 /* in unit of 500us; 0 to disable auto-pspoll */
974 u8 min_auto_pspoll_period;
977 int wsm_set_pm(struct cw1200_common *priv, const struct wsm_set_pm *arg);
979 /* 3.27 */
980 struct wsm_set_pm_complete {
981 u8 psm; /* WSM_PSM_... */
984 /* 3.28 */
985 #define WSM_SET_BSS_PARAMS_REQ_ID 0x0011
986 #define WSM_SET_BSS_PARAMS_RESP_ID 0x0411
987 struct wsm_set_bss_params {
988 /* This resets the beacon loss counters only */
989 u8 reset_beacon_loss;
991 /* The number of lost consecutive beacons after which */
992 /* the WLAN device should indicate the BSS-Lost event */
993 /* to the WLAN host driver. */
994 u8 beacon_lost_count;
996 /* The AID received during the association process. */
997 u16 aid;
999 /* The operational rate set mask */
1000 u32 operational_rate_set;
1003 int wsm_set_bss_params(struct cw1200_common *priv,
1004 const struct wsm_set_bss_params *arg);
1006 /* 3.30 */
1007 #define WSM_ADD_KEY_REQ_ID 0x000C
1008 #define WSM_ADD_KEY_RESP_ID 0x040C
1009 struct wsm_add_key {
1010 u8 type; /* WSM_KEY_TYPE_... */
1011 u8 index; /* Key entry index: 0 -- WSM_KEY_MAX_INDEX */
1012 u16 reserved;
1013 union {
1014 struct {
1015 u8 peer[6]; /* MAC address of the peer station */
1016 u8 reserved;
1017 u8 keylen; /* Key length in bytes */
1018 u8 keydata[16]; /* Key data */
1019 } __packed wep_pairwise;
1020 struct {
1021 u8 keyid; /* Unique per key identifier (0..3) */
1022 u8 keylen; /* Key length in bytes */
1023 u16 reserved;
1024 u8 keydata[16]; /* Key data */
1025 } __packed wep_group;
1026 struct {
1027 u8 peer[6]; /* MAC address of the peer station */
1028 u16 reserved;
1029 u8 keydata[16]; /* TKIP key data */
1030 u8 rx_mic_key[8]; /* Rx MIC key */
1031 u8 tx_mic_key[8]; /* Tx MIC key */
1032 } __packed tkip_pairwise;
1033 struct {
1034 u8 keydata[16]; /* TKIP key data */
1035 u8 rx_mic_key[8]; /* Rx MIC key */
1036 u8 keyid; /* Key ID */
1037 u8 reserved[3];
1038 u8 rx_seqnum[8]; /* Receive Sequence Counter */
1039 } __packed tkip_group;
1040 struct {
1041 u8 peer[6]; /* MAC address of the peer station */
1042 u16 reserved;
1043 u8 keydata[16]; /* AES key data */
1044 } __packed aes_pairwise;
1045 struct {
1046 u8 keydata[16]; /* AES key data */
1047 u8 keyid; /* Key ID */
1048 u8 reserved[3];
1049 u8 rx_seqnum[8]; /* Receive Sequence Counter */
1050 } __packed aes_group;
1051 struct {
1052 u8 peer[6]; /* MAC address of the peer station */
1053 u8 keyid; /* Key ID */
1054 u8 reserved;
1055 u8 keydata[16]; /* WAPI key data */
1056 u8 mic_key[16]; /* MIC key data */
1057 } __packed wapi_pairwise;
1058 struct {
1059 u8 keydata[16]; /* WAPI key data */
1060 u8 mic_key[16]; /* MIC key data */
1061 u8 keyid; /* Key ID */
1062 u8 reserved[3];
1063 } __packed wapi_group;
1064 } __packed;
1065 } __packed;
1067 int wsm_add_key(struct cw1200_common *priv, const struct wsm_add_key *arg);
1069 /* 3.32 */
1070 #define WSM_REMOVE_KEY_REQ_ID 0x000D
1071 #define WSM_REMOVE_KEY_RESP_ID 0x040D
1072 struct wsm_remove_key {
1073 u8 index; /* Key entry index : 0-10 */
1076 int wsm_remove_key(struct cw1200_common *priv,
1077 const struct wsm_remove_key *arg);
1079 /* 3.34 */
1080 struct wsm_set_tx_queue_params {
1081 /* WSM_ACK_POLICY_... */
1082 u8 ackPolicy;
1084 /* Medium Time of TSPEC (in 32us units) allowed per */
1085 /* One Second Averaging Period for this queue. */
1086 u16 allowedMediumTime;
1088 /* dot11MaxTransmitMsduLifetime to be used for the */
1089 /* specified queue. */
1090 u32 maxTransmitLifetime;
1093 struct wsm_tx_queue_params {
1094 /* NOTE: index is a linux queue id. */
1095 struct wsm_set_tx_queue_params params[4];
1099 #define WSM_TX_QUEUE_SET(queue_params, queue, ack_policy, allowed_time,\
1100 max_life_time) \
1101 do { \
1102 struct wsm_set_tx_queue_params *p = &(queue_params)->params[queue]; \
1103 p->ackPolicy = (ack_policy); \
1104 p->allowedMediumTime = (allowed_time); \
1105 p->maxTransmitLifetime = (max_life_time); \
1106 } while (0)
1108 int wsm_set_tx_queue_params(struct cw1200_common *priv,
1109 const struct wsm_set_tx_queue_params *arg, u8 id);
1111 /* 3.36 */
1112 #define WSM_EDCA_PARAMS_REQ_ID 0x0013
1113 #define WSM_EDCA_PARAMS_RESP_ID 0x0413
1114 struct wsm_edca_queue_params {
1115 /* CWmin (in slots) for the access class. */
1116 u16 cwmin;
1118 /* CWmax (in slots) for the access class. */
1119 u16 cwmax;
1121 /* AIFS (in slots) for the access class. */
1122 u16 aifns;
1124 /* TX OP Limit (in microseconds) for the access class. */
1125 u16 txop_limit;
1127 /* dot11MaxReceiveLifetime to be used for the specified */
1128 /* the access class. Overrides the global */
1129 /* dot11MaxReceiveLifetime value */
1130 u32 max_rx_lifetime;
1133 struct wsm_edca_params {
1134 /* NOTE: index is a linux queue id. */
1135 struct wsm_edca_queue_params params[4];
1136 bool uapsd_enable[4];
1139 #define TXOP_UNIT 32
1140 #define WSM_EDCA_SET(__edca, __queue, __aifs, __cw_min, __cw_max, __txop, __lifetime,\
1141 __uapsd) \
1142 do { \
1143 struct wsm_edca_queue_params *p = &(__edca)->params[__queue]; \
1144 p->cwmin = __cw_min; \
1145 p->cwmax = __cw_max; \
1146 p->aifns = __aifs; \
1147 p->txop_limit = ((__txop) * TXOP_UNIT); \
1148 p->max_rx_lifetime = __lifetime; \
1149 (__edca)->uapsd_enable[__queue] = (__uapsd); \
1150 } while (0)
1152 int wsm_set_edca_params(struct cw1200_common *priv,
1153 const struct wsm_edca_params *arg);
1155 int wsm_set_uapsd_param(struct cw1200_common *priv,
1156 const struct wsm_edca_params *arg);
1158 /* 3.38 */
1159 /* Set-System info. Skipped for now. Irrelevent. */
1161 /* 3.40 */
1162 #define WSM_SWITCH_CHANNEL_REQ_ID 0x0016
1163 #define WSM_SWITCH_CHANNEL_RESP_ID 0x0416
1165 struct wsm_switch_channel {
1166 /* 1 - means the STA shall not transmit any further */
1167 /* frames until the channel switch has completed */
1168 u8 mode;
1170 /* Number of TBTTs until channel switch occurs. */
1171 /* 0 - indicates switch shall occur at any time */
1172 /* 1 - occurs immediately before the next TBTT */
1173 u8 switch_count;
1175 /* The new channel number to switch to. */
1176 /* Note this is defined as per section 2.7. */
1177 u16 channel_number;
1180 int wsm_switch_channel(struct cw1200_common *priv,
1181 const struct wsm_switch_channel *arg);
1183 typedef void (*wsm_channel_switch_cb) (struct cw1200_common *priv);
1185 #define WSM_START_REQ_ID 0x0017
1186 #define WSM_START_RESP_ID 0x0417
1188 struct wsm_start {
1189 /* WSM_START_MODE_... */
1190 /* [in] */ u8 mode;
1192 /* WSM_PHY_BAND_... */
1193 /* [in] */ u8 band;
1195 /* Channel number */
1196 /* [in] */ u16 channel_number;
1198 /* Client Traffic window in units of TU */
1199 /* Valid only when mode == ..._P2P */
1200 /* [in] */ u32 ct_window;
1202 /* Interval between two consecutive */
1203 /* beacon transmissions in TU. */
1204 /* [in] */ u32 beacon_interval;
1206 /* DTIM period in terms of beacon intervals */
1207 /* [in] */ u8 dtim_period;
1209 /* WSM_JOIN_PREAMBLE_... */
1210 /* [in] */ u8 preamble;
1212 /* The delay time (in microseconds) period */
1213 /* before sending a probe-request. */
1214 /* [in] */ u8 probe_delay;
1216 /* Length of the SSID */
1217 /* [in] */ u8 ssid_len;
1219 /* SSID of the BSS or P2P_GO to be started now. */
1220 /* [in] */ u8 ssid[32];
1222 /* The basic supported rates for the MiniAP. */
1223 /* [in] */ u32 basic_rate_set;
1226 int wsm_start(struct cw1200_common *priv, const struct wsm_start *arg);
1228 #define WSM_BEACON_TRANSMIT_REQ_ID 0x0018
1229 #define WSM_BEACON_TRANSMIT_RESP_ID 0x0418
1231 struct wsm_beacon_transmit {
1232 /* 1: enable; 0: disable */
1233 /* [in] */ u8 enable_beaconing;
1236 int wsm_beacon_transmit(struct cw1200_common *priv,
1237 const struct wsm_beacon_transmit *arg);
1239 int wsm_start_find(struct cw1200_common *priv);
1241 int wsm_stop_find(struct cw1200_common *priv);
1243 typedef void (*wsm_find_complete_cb) (struct cw1200_common *priv, u32 status);
1245 struct wsm_suspend_resume {
1246 /* See 3.52 */
1247 /* Link ID */
1248 /* [out] */ int link_id;
1249 /* Stop sending further Tx requests down to device for this link */
1250 /* [out] */ bool stop;
1251 /* Transmit multicast Frames */
1252 /* [out] */ bool multicast;
1253 /* The AC on which Tx to be suspended /resumed. */
1254 /* This is applicable only for U-APSD */
1255 /* WSM_QUEUE_... */
1256 /* [out] */ int queue;
1259 typedef void (*wsm_suspend_resume_cb) (struct cw1200_common *priv,
1260 struct wsm_suspend_resume *arg);
1262 /* 3.54 Update-IE request. */
1263 struct wsm_update_ie {
1264 /* WSM_UPDATE_IE_... */
1265 /* [in] */ u16 what;
1266 /* [in] */ u16 count;
1267 /* [in] */ u8 *ies;
1268 /* [in] */ size_t length;
1271 int wsm_update_ie(struct cw1200_common *priv,
1272 const struct wsm_update_ie *arg);
1274 /* 3.56 */
1275 struct wsm_map_link {
1276 /* MAC address of the remote device */
1277 /* [in] */ u8 mac_addr[6];
1278 /* [in] */ u8 link_id;
1281 int wsm_map_link(struct cw1200_common *priv, const struct wsm_map_link *arg);
1283 /* ******************************************************************** */
1284 /* MIB shortcats */
1286 static inline int wsm_set_output_power(struct cw1200_common *priv,
1287 int power_level)
1289 __le32 val = __cpu_to_le32(power_level);
1290 return wsm_write_mib(priv, WSM_MIB_ID_DOT11_CURRENT_TX_POWER_LEVEL,
1291 &val, sizeof(val));
1294 static inline int wsm_set_beacon_wakeup_period(struct cw1200_common *priv,
1295 unsigned dtim_interval,
1296 unsigned listen_interval)
1298 struct {
1299 u8 numBeaconPeriods;
1300 u8 reserved;
1301 __le16 listenInterval;
1302 } val = {
1303 dtim_interval, 0, __cpu_to_le16(listen_interval)
1306 if (dtim_interval > 0xFF || listen_interval > 0xFFFF)
1307 return -EINVAL;
1308 else
1309 return wsm_write_mib(priv, WSM_MIB_ID_BEACON_WAKEUP_PERIOD,
1310 &val, sizeof(val));
1313 struct wsm_rcpi_rssi_threshold {
1314 u8 rssiRcpiMode; /* WSM_RCPI_RSSI_... */
1315 u8 lowerThreshold;
1316 u8 upperThreshold;
1317 u8 rollingAverageCount;
1320 static inline int wsm_set_rcpi_rssi_threshold(struct cw1200_common *priv,
1321 struct wsm_rcpi_rssi_threshold *arg)
1323 return wsm_write_mib(priv, WSM_MIB_ID_RCPI_RSSI_THRESHOLD, arg,
1324 sizeof(*arg));
1327 struct wsm_mib_counters_table {
1328 __le32 plcp_errors;
1329 __le32 fcs_errors;
1330 __le32 tx_packets;
1331 __le32 rx_packets;
1332 __le32 rx_packet_errors;
1333 __le32 rx_decryption_failures;
1334 __le32 rx_mic_failures;
1335 __le32 rx_no_key_failures;
1336 __le32 tx_multicast_frames;
1337 __le32 tx_frames_success;
1338 __le32 tx_frame_failures;
1339 __le32 tx_frames_retried;
1340 __le32 tx_frames_multi_retried;
1341 __le32 rx_frame_duplicates;
1342 __le32 rts_success;
1343 __le32 rts_failures;
1344 __le32 ack_failures;
1345 __le32 rx_multicast_frames;
1346 __le32 rx_frames_success;
1347 __le32 rx_cmac_icv_errors;
1348 __le32 rx_cmac_replays;
1349 __le32 rx_mgmt_ccmp_replays;
1350 } __packed;
1352 static inline int wsm_get_counters_table(struct cw1200_common *priv,
1353 struct wsm_mib_counters_table *arg)
1355 return wsm_read_mib(priv, WSM_MIB_ID_COUNTERS_TABLE,
1356 arg, sizeof(*arg));
1359 static inline int wsm_get_station_id(struct cw1200_common *priv, u8 *mac)
1361 return wsm_read_mib(priv, WSM_MIB_ID_DOT11_STATION_ID, mac, ETH_ALEN);
1364 struct wsm_rx_filter {
1365 bool promiscuous;
1366 bool bssid;
1367 bool fcs;
1368 bool probeResponder;
1371 static inline int wsm_set_rx_filter(struct cw1200_common *priv,
1372 const struct wsm_rx_filter *arg)
1374 __le32 val = 0;
1375 if (arg->promiscuous)
1376 val |= __cpu_to_le32(BIT(0));
1377 if (arg->bssid)
1378 val |= __cpu_to_le32(BIT(1));
1379 if (arg->fcs)
1380 val |= __cpu_to_le32(BIT(2));
1381 if (arg->probeResponder)
1382 val |= __cpu_to_le32(BIT(3));
1383 return wsm_write_mib(priv, WSM_MIB_ID_RX_FILTER, &val, sizeof(val));
1386 int wsm_set_probe_responder(struct cw1200_common *priv, bool enable);
1388 #define WSM_BEACON_FILTER_IE_HAS_CHANGED BIT(0)
1389 #define WSM_BEACON_FILTER_IE_NO_LONGER_PRESENT BIT(1)
1390 #define WSM_BEACON_FILTER_IE_HAS_APPEARED BIT(2)
1392 struct wsm_beacon_filter_table_entry {
1393 u8 ie_id;
1394 u8 flags;
1395 u8 oui[3];
1396 u8 match_data[3];
1397 } __packed;
1399 struct wsm_mib_beacon_filter_table {
1400 __le32 num;
1401 struct wsm_beacon_filter_table_entry entry[10];
1402 } __packed;
1404 static inline int wsm_set_beacon_filter_table(struct cw1200_common *priv,
1405 struct wsm_mib_beacon_filter_table *ft)
1407 size_t size = __le32_to_cpu(ft->num) *
1408 sizeof(struct wsm_beacon_filter_table_entry) +
1409 sizeof(__le32);
1411 return wsm_write_mib(priv, WSM_MIB_ID_BEACON_FILTER_TABLE, ft, size);
1414 #define WSM_BEACON_FILTER_ENABLE BIT(0) /* Enable/disable beacon filtering */
1415 #define WSM_BEACON_FILTER_AUTO_ERP BIT(1) /* If 1 FW will handle ERP IE changes internally */
1417 struct wsm_beacon_filter_control {
1418 int enabled;
1419 int bcn_count;
1422 static inline int wsm_beacon_filter_control(struct cw1200_common *priv,
1423 struct wsm_beacon_filter_control *arg)
1425 struct {
1426 __le32 enabled;
1427 __le32 bcn_count;
1428 } val;
1429 val.enabled = __cpu_to_le32(arg->enabled);
1430 val.bcn_count = __cpu_to_le32(arg->bcn_count);
1431 return wsm_write_mib(priv, WSM_MIB_ID_BEACON_FILTER_ENABLE, &val,
1432 sizeof(val));
1435 enum wsm_power_mode {
1436 wsm_power_mode_active = 0,
1437 wsm_power_mode_doze = 1,
1438 wsm_power_mode_quiescent = 2,
1441 struct wsm_operational_mode {
1442 enum wsm_power_mode power_mode;
1443 int disable_more_flag_usage;
1444 int perform_ant_diversity;
1447 static inline int wsm_set_operational_mode(struct cw1200_common *priv,
1448 const struct wsm_operational_mode *arg)
1450 u8 val = arg->power_mode;
1451 if (arg->disable_more_flag_usage)
1452 val |= BIT(4);
1453 if (arg->perform_ant_diversity)
1454 val |= BIT(5);
1455 return wsm_write_mib(priv, WSM_MIB_ID_OPERATIONAL_POWER_MODE, &val,
1456 sizeof(val));
1459 struct wsm_template_frame {
1460 u8 frame_type;
1461 u8 rate;
1462 struct sk_buff *skb;
1465 static inline int wsm_set_template_frame(struct cw1200_common *priv,
1466 struct wsm_template_frame *arg)
1468 int ret;
1469 u8 *p = skb_push(arg->skb, 4);
1470 p[0] = arg->frame_type;
1471 p[1] = arg->rate;
1472 ((__le16 *)p)[1] = __cpu_to_le16(arg->skb->len - 4);
1473 ret = wsm_write_mib(priv, WSM_MIB_ID_TEMPLATE_FRAME, p, arg->skb->len);
1474 skb_pull(arg->skb, 4);
1475 return ret;
1479 struct wsm_protected_mgmt_policy {
1480 bool protectedMgmtEnable;
1481 bool unprotectedMgmtFramesAllowed;
1482 bool encryptionForAuthFrame;
1485 static inline int wsm_set_protected_mgmt_policy(struct cw1200_common *priv,
1486 struct wsm_protected_mgmt_policy *arg)
1488 __le32 val = 0;
1489 int ret;
1490 if (arg->protectedMgmtEnable)
1491 val |= __cpu_to_le32(BIT(0));
1492 if (arg->unprotectedMgmtFramesAllowed)
1493 val |= __cpu_to_le32(BIT(1));
1494 if (arg->encryptionForAuthFrame)
1495 val |= __cpu_to_le32(BIT(2));
1496 ret = wsm_write_mib(priv, WSM_MIB_ID_PROTECTED_MGMT_POLICY,
1497 &val, sizeof(val));
1498 return ret;
1501 struct wsm_mib_block_ack_policy {
1502 u8 tx_tid;
1503 u8 reserved1;
1504 u8 rx_tid;
1505 u8 reserved2;
1506 } __packed;
1508 static inline int wsm_set_block_ack_policy(struct cw1200_common *priv,
1509 u8 tx_tid_policy,
1510 u8 rx_tid_policy)
1512 struct wsm_mib_block_ack_policy val = {
1513 .tx_tid = tx_tid_policy,
1514 .rx_tid = rx_tid_policy,
1516 return wsm_write_mib(priv, WSM_MIB_ID_BLOCK_ACK_POLICY, &val,
1517 sizeof(val));
1520 struct wsm_mib_association_mode {
1521 u8 flags; /* WSM_ASSOCIATION_MODE_... */
1522 u8 preamble; /* WSM_JOIN_PREAMBLE_... */
1523 u8 greenfield; /* 1 for greenfield */
1524 u8 mpdu_start_spacing;
1525 __le32 basic_rate_set;
1526 } __packed;
1528 static inline int wsm_set_association_mode(struct cw1200_common *priv,
1529 struct wsm_mib_association_mode *arg)
1531 return wsm_write_mib(priv, WSM_MIB_ID_SET_ASSOCIATION_MODE, arg,
1532 sizeof(*arg));
1535 #define WSM_TX_RATE_POLICY_FLAG_TERMINATE_WHEN_FINISHED BIT(2)
1536 #define WSM_TX_RATE_POLICY_FLAG_COUNT_INITIAL_TRANSMIT BIT(3)
1537 struct wsm_tx_rate_retry_policy {
1538 u8 index;
1539 u8 short_retries;
1540 u8 long_retries;
1541 /* BIT(2) - Terminate retries when Tx rate retry policy
1542 * finishes.
1543 * BIT(3) - Count initial frame transmission as part of
1544 * rate retry counting but not as a retry
1545 * attempt
1547 u8 flags;
1548 u8 rate_recoveries;
1549 u8 reserved[3];
1550 __le32 rate_count_indices[3];
1551 } __packed;
1553 struct wsm_set_tx_rate_retry_policy {
1554 u8 num;
1555 u8 reserved[3];
1556 struct wsm_tx_rate_retry_policy tbl[8];
1557 } __packed;
1559 static inline int wsm_set_tx_rate_retry_policy(struct cw1200_common *priv,
1560 struct wsm_set_tx_rate_retry_policy *arg)
1562 size_t size = 4 + arg->num * sizeof(struct wsm_tx_rate_retry_policy);
1563 return wsm_write_mib(priv, WSM_MIB_ID_SET_TX_RATE_RETRY_POLICY, arg,
1564 size);
1567 /* 4.32 SetEtherTypeDataFrameFilter */
1568 struct wsm_ether_type_filter_hdr {
1569 u8 num; /* Up to WSM_MAX_FILTER_ELEMENTS */
1570 u8 reserved[3];
1571 } __packed;
1573 struct wsm_ether_type_filter {
1574 u8 action; /* WSM_FILTER_ACTION_XXX */
1575 u8 reserved;
1576 __le16 type; /* Type of ethernet frame */
1577 } __packed;
1579 static inline int wsm_set_ether_type_filter(struct cw1200_common *priv,
1580 struct wsm_ether_type_filter_hdr *arg)
1582 size_t size = sizeof(struct wsm_ether_type_filter_hdr) +
1583 arg->num * sizeof(struct wsm_ether_type_filter);
1584 return wsm_write_mib(priv, WSM_MIB_ID_SET_ETHERTYPE_DATAFRAME_FILTER,
1585 arg, size);
1588 /* 4.33 SetUDPPortDataFrameFilter */
1589 struct wsm_udp_port_filter_hdr {
1590 u8 num; /* Up to WSM_MAX_FILTER_ELEMENTS */
1591 u8 reserved[3];
1592 } __packed;
1594 struct wsm_udp_port_filter {
1595 u8 action; /* WSM_FILTER_ACTION_XXX */
1596 u8 type; /* WSM_FILTER_PORT_TYPE_XXX */
1597 __le16 port; /* Port number */
1598 } __packed;
1600 static inline int wsm_set_udp_port_filter(struct cw1200_common *priv,
1601 struct wsm_udp_port_filter_hdr *arg)
1603 size_t size = sizeof(struct wsm_udp_port_filter_hdr) +
1604 arg->num * sizeof(struct wsm_udp_port_filter);
1605 return wsm_write_mib(priv, WSM_MIB_ID_SET_UDPPORT_DATAFRAME_FILTER,
1606 arg, size);
1609 /* Undocumented MIBs: */
1610 /* 4.35 P2PDeviceInfo */
1611 #define D11_MAX_SSID_LEN (32)
1613 struct wsm_p2p_device_type {
1614 __le16 category_id;
1615 u8 oui[4];
1616 __le16 subcategory_id;
1617 } __packed;
1619 struct wsm_p2p_device_info {
1620 struct wsm_p2p_device_type primaryDevice;
1621 u8 reserved1[3];
1622 u8 devname_size;
1623 u8 local_devname[D11_MAX_SSID_LEN];
1624 u8 reserved2[3];
1625 u8 num_secdev_supported;
1626 struct wsm_p2p_device_type secdevs[];
1627 } __packed;
1629 /* 4.36 SetWCDMABand - WO */
1630 struct wsm_cdma_band {
1631 u8 wcdma_band;
1632 u8 reserved[3];
1633 } __packed;
1635 /* 4.37 GroupTxSequenceCounter - RO */
1636 struct wsm_group_tx_seq {
1637 __le32 bits_47_16;
1638 __le16 bits_15_00;
1639 __le16 reserved;
1640 } __packed;
1642 /* 4.39 SetHtProtection - WO */
1643 #define WSM_DUAL_CTS_PROT_ENB (1 << 0)
1644 #define WSM_NON_GREENFIELD_STA_PRESENT (1 << 1)
1645 #define WSM_HT_PROT_MODE__NO_PROT (0 << 2)
1646 #define WSM_HT_PROT_MODE__NON_MEMBER (1 << 2)
1647 #define WSM_HT_PROT_MODE__20_MHZ (2 << 2)
1648 #define WSM_HT_PROT_MODE__NON_HT_MIXED (3 << 2)
1649 #define WSM_LSIG_TXOP_PROT_FULL (1 << 4)
1650 #define WSM_LARGE_L_LENGTH_PROT (1 << 5)
1652 struct wsm_ht_protection {
1653 __le32 flags;
1654 } __packed;
1656 /* 4.40 GPIO Command - R/W */
1657 #define WSM_GPIO_COMMAND_SETUP 0
1658 #define WSM_GPIO_COMMAND_READ 1
1659 #define WSM_GPIO_COMMAND_WRITE 2
1660 #define WSM_GPIO_COMMAND_RESET 3
1661 #define WSM_GPIO_ALL_PINS 0xFF
1663 struct wsm_gpio_command {
1664 u8 command;
1665 u8 pin;
1666 __le16 config;
1667 } __packed;
1669 /* 4.41 TSFCounter - RO */
1670 struct wsm_tsf_counter {
1671 __le64 tsf_counter;
1672 } __packed;
1674 /* 4.43 Keep alive period */
1675 struct wsm_keep_alive_period {
1676 __le16 period;
1677 u8 reserved[2];
1678 } __packed;
1680 static inline int wsm_keep_alive_period(struct cw1200_common *priv,
1681 int period)
1683 struct wsm_keep_alive_period arg = {
1684 .period = __cpu_to_le16(period),
1686 return wsm_write_mib(priv, WSM_MIB_ID_KEEP_ALIVE_PERIOD,
1687 &arg, sizeof(arg));
1690 /* BSSID filtering */
1691 struct wsm_set_bssid_filtering {
1692 u8 filter;
1693 u8 reserved[3];
1694 } __packed;
1696 static inline int wsm_set_bssid_filtering(struct cw1200_common *priv,
1697 bool enabled)
1699 struct wsm_set_bssid_filtering arg = {
1700 .filter = !enabled,
1702 return wsm_write_mib(priv, WSM_MIB_ID_DISABLE_BSSID_FILTER,
1703 &arg, sizeof(arg));
1706 /* Multicast filtering - 4.5 */
1707 struct wsm_mib_multicast_filter {
1708 __le32 enable;
1709 __le32 num_addrs;
1710 u8 macaddrs[WSM_MAX_GRP_ADDRTABLE_ENTRIES][ETH_ALEN];
1711 } __packed;
1713 static inline int wsm_set_multicast_filter(struct cw1200_common *priv,
1714 struct wsm_mib_multicast_filter *fp)
1716 return wsm_write_mib(priv, WSM_MIB_ID_DOT11_GROUP_ADDRESSES_TABLE,
1717 fp, sizeof(*fp));
1720 /* ARP IPv4 filtering - 4.10 */
1721 struct wsm_mib_arp_ipv4_filter {
1722 __le32 enable;
1723 __be32 ipv4addrs[WSM_MAX_ARP_IP_ADDRTABLE_ENTRIES];
1724 } __packed;
1726 static inline int wsm_set_arp_ipv4_filter(struct cw1200_common *priv,
1727 struct wsm_mib_arp_ipv4_filter *fp)
1729 return wsm_write_mib(priv, WSM_MIB_ID_ARP_IP_ADDRESSES_TABLE,
1730 fp, sizeof(*fp));
1733 /* P2P Power Save Mode Info - 4.31 */
1734 struct wsm_p2p_ps_modeinfo {
1735 u8 opp_ps_ct_window;
1736 u8 count;
1737 u8 reserved;
1738 u8 dtim_count;
1739 __le32 duration;
1740 __le32 interval;
1741 __le32 start_time;
1742 } __packed;
1744 static inline int wsm_set_p2p_ps_modeinfo(struct cw1200_common *priv,
1745 struct wsm_p2p_ps_modeinfo *mi)
1747 return wsm_write_mib(priv, WSM_MIB_ID_P2P_PS_MODE_INFO,
1748 mi, sizeof(*mi));
1751 static inline int wsm_get_p2p_ps_modeinfo(struct cw1200_common *priv,
1752 struct wsm_p2p_ps_modeinfo *mi)
1754 return wsm_read_mib(priv, WSM_MIB_ID_P2P_PS_MODE_INFO,
1755 mi, sizeof(*mi));
1758 /* UseMultiTxConfMessage */
1760 static inline int wsm_use_multi_tx_conf(struct cw1200_common *priv,
1761 bool enabled)
1763 __le32 arg = enabled ? __cpu_to_le32(1) : 0;
1765 return wsm_write_mib(priv, WSM_MIB_USE_MULTI_TX_CONF,
1766 &arg, sizeof(arg));
1770 /* 4.26 SetUpasdInformation */
1771 struct wsm_uapsd_info {
1772 __le16 uapsd_flags;
1773 __le16 min_auto_trigger_interval;
1774 __le16 max_auto_trigger_interval;
1775 __le16 auto_trigger_step;
1778 static inline int wsm_set_uapsd_info(struct cw1200_common *priv,
1779 struct wsm_uapsd_info *arg)
1781 return wsm_write_mib(priv, WSM_MIB_ID_SET_UAPSD_INFORMATION,
1782 arg, sizeof(*arg));
1785 /* 4.22 OverrideInternalTxRate */
1786 struct wsm_override_internal_txrate {
1787 u8 internalTxRate;
1788 u8 nonErpInternalTxRate;
1789 u8 reserved[2];
1790 } __packed;
1792 static inline int wsm_set_override_internal_txrate(struct cw1200_common *priv,
1793 struct wsm_override_internal_txrate *arg)
1795 return wsm_write_mib(priv, WSM_MIB_ID_OVERRIDE_INTERNAL_TX_RATE,
1796 arg, sizeof(*arg));
1799 /* ******************************************************************** */
1800 /* WSM TX port control */
1802 void wsm_lock_tx(struct cw1200_common *priv);
1803 void wsm_lock_tx_async(struct cw1200_common *priv);
1804 bool wsm_flush_tx(struct cw1200_common *priv);
1805 void wsm_unlock_tx(struct cw1200_common *priv);
1807 /* ******************************************************************** */
1808 /* WSM / BH API */
1810 int wsm_handle_exception(struct cw1200_common *priv, u8 *data, size_t len);
1811 int wsm_handle_rx(struct cw1200_common *priv, u16 id, struct wsm_hdr *wsm,
1812 struct sk_buff **skb_p);
1814 /* ******************************************************************** */
1815 /* wsm_buf API */
1817 struct wsm_buf {
1818 u8 *begin;
1819 u8 *data;
1820 u8 *end;
1823 void wsm_buf_init(struct wsm_buf *buf);
1824 void wsm_buf_deinit(struct wsm_buf *buf);
1826 /* ******************************************************************** */
1827 /* wsm_cmd API */
1829 struct wsm_cmd {
1830 spinlock_t lock; /* Protect structure from multiple access */
1831 int done;
1832 u8 *ptr;
1833 size_t len;
1834 void *arg;
1835 int ret;
1836 u16 cmd;
1839 /* ******************************************************************** */
1840 /* WSM TX buffer access */
1842 int wsm_get_tx(struct cw1200_common *priv, u8 **data,
1843 size_t *tx_len, int *burst);
1844 void wsm_txed(struct cw1200_common *priv, u8 *data);
1846 /* ******************************************************************** */
1847 /* Queue mapping: WSM <---> linux */
1848 /* Linux: VO VI BE BK */
1849 /* WSM: BE BK VI VO */
1851 static inline u8 wsm_queue_id_to_linux(u8 queue_id)
1853 static const u8 queue_mapping[] = {
1854 2, 3, 1, 0
1856 return queue_mapping[queue_id];
1859 static inline u8 wsm_queue_id_to_wsm(u8 queue_id)
1861 static const u8 queue_mapping[] = {
1862 3, 2, 0, 1
1864 return queue_mapping[queue_id];
1867 #endif /* CW1200_HWIO_H_INCLUDED */