libertas: Add auto deep sleep support for SD8385/SD8686/SD8688
[linux-2.6.git] / drivers / net / wireless / libertas / host.h
1 /**
2   * This file contains definitions of WLAN commands.
3   */
4
5 #ifndef _LBS_HOST_H_
6 #define _LBS_HOST_H_
7
8 /** PUBLIC DEFINITIONS */
9 #define DEFAULT_AD_HOC_CHANNEL                  6
10 #define DEFAULT_AD_HOC_CHANNEL_A                36
11
12 #define CMD_OPTION_WAITFORRSP                   0x0002
13
14 /** Host command IDs */
15
16 /* Return command are almost always the same as the host command, but with
17  * bit 15 set high.  There are a few exceptions, though...
18  */
19 #define CMD_RET(cmd)                    (0x8000 | cmd)
20
21 /* Return command convention exceptions: */
22 #define CMD_RET_802_11_ASSOCIATE                0x8012
23
24 /* Command codes */
25 #define CMD_GET_HW_SPEC                         0x0003
26 #define CMD_EEPROM_UPDATE                       0x0004
27 #define CMD_802_11_RESET                        0x0005
28 #define CMD_802_11_SCAN                         0x0006
29 #define CMD_802_11_GET_LOG                      0x000b
30 #define CMD_MAC_MULTICAST_ADR                   0x0010
31 #define CMD_802_11_AUTHENTICATE                 0x0011
32 #define CMD_802_11_EEPROM_ACCESS                0x0059
33 #define CMD_802_11_ASSOCIATE                    0x0050
34 #define CMD_802_11_SET_WEP                      0x0013
35 #define CMD_802_11_GET_STAT                     0x0014
36 #define CMD_802_3_GET_STAT                      0x0015
37 #define CMD_802_11_SNMP_MIB                     0x0016
38 #define CMD_MAC_REG_MAP                         0x0017
39 #define CMD_BBP_REG_MAP                         0x0018
40 #define CMD_MAC_REG_ACCESS                      0x0019
41 #define CMD_BBP_REG_ACCESS                      0x001a
42 #define CMD_RF_REG_ACCESS                       0x001b
43 #define CMD_802_11_RADIO_CONTROL                0x001c
44 #define CMD_802_11_RF_CHANNEL                   0x001d
45 #define CMD_802_11_RF_TX_POWER                  0x001e
46 #define CMD_802_11_RSSI                         0x001f
47 #define CMD_802_11_RF_ANTENNA                   0x0020
48 #define CMD_802_11_PS_MODE                      0x0021
49 #define CMD_802_11_DATA_RATE                    0x0022
50 #define CMD_RF_REG_MAP                          0x0023
51 #define CMD_802_11_DEAUTHENTICATE               0x0024
52 #define CMD_802_11_REASSOCIATE                  0x0025
53 #define CMD_MAC_CONTROL                         0x0028
54 #define CMD_802_11_AD_HOC_START                 0x002b
55 #define CMD_802_11_AD_HOC_JOIN                  0x002c
56 #define CMD_802_11_QUERY_TKIP_REPLY_CNTRS       0x002e
57 #define CMD_802_11_ENABLE_RSN                   0x002f
58 #define CMD_802_11_SET_AFC                      0x003c
59 #define CMD_802_11_GET_AFC                      0x003d
60 #define CMD_802_11_DEEP_SLEEP                  0x003e
61 #define CMD_802_11_AD_HOC_STOP                  0x0040
62 #define CMD_802_11_HOST_SLEEP_CFG               0x0043
63 #define CMD_802_11_WAKEUP_CONFIRM               0x0044
64 #define CMD_802_11_HOST_SLEEP_ACTIVATE          0x0045
65 #define CMD_802_11_BEACON_STOP                  0x0049
66 #define CMD_802_11_MAC_ADDRESS                  0x004d
67 #define CMD_802_11_LED_GPIO_CTRL                0x004e
68 #define CMD_802_11_EEPROM_ACCESS                0x0059
69 #define CMD_802_11_BAND_CONFIG                  0x0058
70 #define CMD_GSPI_BUS_CONFIG                     0x005a
71 #define CMD_802_11D_DOMAIN_INFO                 0x005b
72 #define CMD_802_11_KEY_MATERIAL                 0x005e
73 #define CMD_802_11_SLEEP_PARAMS                 0x0066
74 #define CMD_802_11_INACTIVITY_TIMEOUT           0x0067
75 #define CMD_802_11_SLEEP_PERIOD                 0x0068
76 #define CMD_802_11_TPC_CFG                      0x0072
77 #define CMD_802_11_PA_CFG                       0x0073
78 #define CMD_802_11_FW_WAKE_METHOD               0x0074
79 #define CMD_802_11_SUBSCRIBE_EVENT              0x0075
80 #define CMD_802_11_RATE_ADAPT_RATESET           0x0076
81 #define CMD_802_11_TX_RATE_QUERY                0x007f
82 #define CMD_GET_TSF                             0x0080
83 #define CMD_BT_ACCESS                           0x0087
84 #define CMD_FWT_ACCESS                          0x0095
85 #define CMD_802_11_MONITOR_MODE                 0x0098
86 #define CMD_MESH_ACCESS                         0x009b
87 #define CMD_MESH_CONFIG_OLD                     0x00a3
88 #define CMD_MESH_CONFIG                         0x00ac
89 #define CMD_SET_BOOT2_VER                       0x00a5
90 #define CMD_FUNC_INIT                           0x00a9
91 #define CMD_FUNC_SHUTDOWN                       0x00aa
92 #define CMD_802_11_BEACON_CTRL                  0x00b0
93
94 /* For the IEEE Power Save */
95 #define CMD_SUBCMD_ENTER_PS             0x0030
96 #define CMD_SUBCMD_EXIT_PS              0x0031
97 #define CMD_SUBCMD_SLEEP_CONFIRMED      0x0034
98 #define CMD_SUBCMD_FULL_POWERDOWN       0x0035
99 #define CMD_SUBCMD_FULL_POWERUP         0x0036
100
101 #define CMD_ENABLE_RSN                  0x0001
102 #define CMD_DISABLE_RSN                 0x0000
103
104 #define CMD_ACT_GET                     0x0000
105 #define CMD_ACT_SET                     0x0001
106 #define CMD_ACT_GET_AES                 0x0002
107 #define CMD_ACT_SET_AES                 0x0003
108 #define CMD_ACT_REMOVE_AES              0x0004
109
110 /* Define action or option for CMD_802_11_SET_WEP */
111 #define CMD_ACT_ADD                     0x0002
112 #define CMD_ACT_REMOVE                  0x0004
113 #define CMD_ACT_USE_DEFAULT             0x0008
114
115 #define CMD_TYPE_WEP_40_BIT             0x01
116 #define CMD_TYPE_WEP_104_BIT            0x02
117
118 #define CMD_NUM_OF_WEP_KEYS             4
119
120 #define CMD_WEP_KEY_INDEX_MASK          0x3fff
121
122 /* Define action or option for CMD_802_11_RESET */
123 #define CMD_ACT_HALT                    0x0003
124
125 /* Define action or option for CMD_802_11_SCAN */
126 #define CMD_BSS_TYPE_BSS                0x0001
127 #define CMD_BSS_TYPE_IBSS               0x0002
128 #define CMD_BSS_TYPE_ANY                0x0003
129
130 /* Define action or option for CMD_802_11_SCAN */
131 #define CMD_SCAN_TYPE_ACTIVE            0x0000
132 #define CMD_SCAN_TYPE_PASSIVE           0x0001
133
134 #define CMD_SCAN_RADIO_TYPE_BG          0
135
136 #define CMD_SCAN_PROBE_DELAY_TIME       0
137
138 /* Define action or option for CMD_MAC_CONTROL */
139 #define CMD_ACT_MAC_RX_ON                       0x0001
140 #define CMD_ACT_MAC_TX_ON                       0x0002
141 #define CMD_ACT_MAC_LOOPBACK_ON                 0x0004
142 #define CMD_ACT_MAC_WEP_ENABLE                  0x0008
143 #define CMD_ACT_MAC_INT_ENABLE                  0x0010
144 #define CMD_ACT_MAC_MULTICAST_ENABLE            0x0020
145 #define CMD_ACT_MAC_BROADCAST_ENABLE            0x0040
146 #define CMD_ACT_MAC_PROMISCUOUS_ENABLE          0x0080
147 #define CMD_ACT_MAC_ALL_MULTICAST_ENABLE        0x0100
148 #define CMD_ACT_MAC_STRICT_PROTECTION_ENABLE    0x0400
149
150 /* Event flags for CMD_802_11_SUBSCRIBE_EVENT */
151 #define CMD_SUBSCRIBE_RSSI_LOW          0x0001
152 #define CMD_SUBSCRIBE_SNR_LOW           0x0002
153 #define CMD_SUBSCRIBE_FAILCOUNT         0x0004
154 #define CMD_SUBSCRIBE_BCNMISS           0x0008
155 #define CMD_SUBSCRIBE_RSSI_HIGH         0x0010
156 #define CMD_SUBSCRIBE_SNR_HIGH          0x0020
157
158 #define RADIO_PREAMBLE_LONG     0x00
159 #define RADIO_PREAMBLE_SHORT    0x02
160 #define RADIO_PREAMBLE_AUTO     0x04
161
162 /* Define action or option for CMD_802_11_RF_CHANNEL */
163 #define CMD_OPT_802_11_RF_CHANNEL_GET   0x00
164 #define CMD_OPT_802_11_RF_CHANNEL_SET   0x01
165
166 /* Define action or option for CMD_802_11_DATA_RATE */
167 #define CMD_ACT_SET_TX_AUTO             0x0000
168 #define CMD_ACT_SET_TX_FIX_RATE         0x0001
169 #define CMD_ACT_GET_TX_RATE             0x0002
170
171 #define CMD_ACT_SET_RX                  0x0001
172 #define CMD_ACT_SET_TX                  0x0002
173 #define CMD_ACT_SET_BOTH                0x0003
174 #define CMD_ACT_GET_RX                  0x0004
175 #define CMD_ACT_GET_TX                  0x0008
176 #define CMD_ACT_GET_BOTH                0x000c
177
178 /* Define action or option for CMD_802_11_PS_MODE */
179 #define CMD_TYPE_CAM                    0x0000
180 #define CMD_TYPE_MAX_PSP                0x0001
181 #define CMD_TYPE_FAST_PSP               0x0002
182
183 /* Options for CMD_802_11_FW_WAKE_METHOD */
184 #define CMD_WAKE_METHOD_UNCHANGED       0x0000
185 #define CMD_WAKE_METHOD_COMMAND_INT     0x0001
186 #define CMD_WAKE_METHOD_GPIO            0x0002
187
188 /* Object IDs for CMD_802_11_SNMP_MIB */
189 #define SNMP_MIB_OID_BSS_TYPE           0x0000
190 #define SNMP_MIB_OID_OP_RATE_SET        0x0001
191 #define SNMP_MIB_OID_BEACON_PERIOD      0x0002  /* Reserved on v9+ */
192 #define SNMP_MIB_OID_DTIM_PERIOD        0x0003  /* Reserved on v9+ */
193 #define SNMP_MIB_OID_ASSOC_TIMEOUT      0x0004  /* Reserved on v9+ */
194 #define SNMP_MIB_OID_RTS_THRESHOLD      0x0005
195 #define SNMP_MIB_OID_SHORT_RETRY_LIMIT  0x0006
196 #define SNMP_MIB_OID_LONG_RETRY_LIMIT   0x0007
197 #define SNMP_MIB_OID_FRAG_THRESHOLD     0x0008
198 #define SNMP_MIB_OID_11D_ENABLE         0x0009
199 #define SNMP_MIB_OID_11H_ENABLE         0x000A
200
201 /* Define action or option for CMD_BT_ACCESS */
202 enum cmd_bt_access_opts {
203         /* The bt commands start at 5 instead of 1 because the old dft commands
204          * are mapped to 1-4.  These old commands are no longer maintained and
205          * should not be called.
206          */
207         CMD_ACT_BT_ACCESS_ADD = 5,
208         CMD_ACT_BT_ACCESS_DEL,
209         CMD_ACT_BT_ACCESS_LIST,
210         CMD_ACT_BT_ACCESS_RESET,
211         CMD_ACT_BT_ACCESS_SET_INVERT,
212         CMD_ACT_BT_ACCESS_GET_INVERT
213 };
214
215 /* Define action or option for CMD_FWT_ACCESS */
216 enum cmd_fwt_access_opts {
217         CMD_ACT_FWT_ACCESS_ADD = 1,
218         CMD_ACT_FWT_ACCESS_DEL,
219         CMD_ACT_FWT_ACCESS_LOOKUP,
220         CMD_ACT_FWT_ACCESS_LIST,
221         CMD_ACT_FWT_ACCESS_LIST_ROUTE,
222         CMD_ACT_FWT_ACCESS_LIST_NEIGHBOR,
223         CMD_ACT_FWT_ACCESS_RESET,
224         CMD_ACT_FWT_ACCESS_CLEANUP,
225         CMD_ACT_FWT_ACCESS_TIME,
226 };
227
228 /* Define action or option for CMD_802_11_HOST_SLEEP_CFG */
229 enum cmd_wol_cfg_opts {
230         CMD_ACT_ACTION_NONE = 0,
231         CMD_ACT_SET_WOL_RULE,
232         CMD_ACT_GET_WOL_RULE,
233         CMD_ACT_RESET_WOL_RULE,
234 };
235
236 /* Define action or option for CMD_MESH_ACCESS */
237 enum cmd_mesh_access_opts {
238         CMD_ACT_MESH_GET_TTL = 1,
239         CMD_ACT_MESH_SET_TTL,
240         CMD_ACT_MESH_GET_STATS,
241         CMD_ACT_MESH_GET_ANYCAST,
242         CMD_ACT_MESH_SET_ANYCAST,
243         CMD_ACT_MESH_SET_LINK_COSTS,
244         CMD_ACT_MESH_GET_LINK_COSTS,
245         CMD_ACT_MESH_SET_BCAST_RATE,
246         CMD_ACT_MESH_GET_BCAST_RATE,
247         CMD_ACT_MESH_SET_RREQ_DELAY,
248         CMD_ACT_MESH_GET_RREQ_DELAY,
249         CMD_ACT_MESH_SET_ROUTE_EXP,
250         CMD_ACT_MESH_GET_ROUTE_EXP,
251         CMD_ACT_MESH_SET_AUTOSTART_ENABLED,
252         CMD_ACT_MESH_GET_AUTOSTART_ENABLED,
253         CMD_ACT_MESH_SET_GET_PRB_RSP_LIMIT = 17,
254 };
255
256 /* Define actions and types for CMD_MESH_CONFIG */
257 enum cmd_mesh_config_actions {
258         CMD_ACT_MESH_CONFIG_STOP = 0,
259         CMD_ACT_MESH_CONFIG_START,
260         CMD_ACT_MESH_CONFIG_SET,
261         CMD_ACT_MESH_CONFIG_GET,
262 };
263
264 enum cmd_mesh_config_types {
265         CMD_TYPE_MESH_SET_BOOTFLAG = 1,
266         CMD_TYPE_MESH_SET_BOOTTIME,
267         CMD_TYPE_MESH_SET_DEF_CHANNEL,
268         CMD_TYPE_MESH_SET_MESH_IE,
269         CMD_TYPE_MESH_GET_DEFAULTS,
270         CMD_TYPE_MESH_GET_MESH_IE, /* GET_DEFAULTS is superset of GET_MESHIE */
271 };
272
273 /** Card Event definition */
274 #define MACREG_INT_CODE_TX_PPA_FREE             0
275 #define MACREG_INT_CODE_TX_DMA_DONE             1
276 #define MACREG_INT_CODE_LINK_LOST_W_SCAN        2
277 #define MACREG_INT_CODE_LINK_LOST_NO_SCAN       3
278 #define MACREG_INT_CODE_LINK_SENSED             4
279 #define MACREG_INT_CODE_CMD_FINISHED            5
280 #define MACREG_INT_CODE_MIB_CHANGED             6
281 #define MACREG_INT_CODE_INIT_DONE               7
282 #define MACREG_INT_CODE_DEAUTHENTICATED         8
283 #define MACREG_INT_CODE_DISASSOCIATED           9
284 #define MACREG_INT_CODE_PS_AWAKE                10
285 #define MACREG_INT_CODE_PS_SLEEP                11
286 #define MACREG_INT_CODE_MIC_ERR_MULTICAST       13
287 #define MACREG_INT_CODE_MIC_ERR_UNICAST         14
288 #define MACREG_INT_CODE_WM_AWAKE                15
289 #define MACREG_INT_CODE_DEEP_SLEEP_AWAKE        16
290 #define MACREG_INT_CODE_ADHOC_BCN_LOST          17
291 #define MACREG_INT_CODE_HOST_AWAKE              18
292 #define MACREG_INT_CODE_STOP_TX                 19
293 #define MACREG_INT_CODE_START_TX                20
294 #define MACREG_INT_CODE_CHANNEL_SWITCH          21
295 #define MACREG_INT_CODE_MEASUREMENT_RDY         22
296 #define MACREG_INT_CODE_WMM_CHANGE              23
297 #define MACREG_INT_CODE_BG_SCAN_REPORT          24
298 #define MACREG_INT_CODE_RSSI_LOW                25
299 #define MACREG_INT_CODE_SNR_LOW                 26
300 #define MACREG_INT_CODE_MAX_FAIL                27
301 #define MACREG_INT_CODE_RSSI_HIGH               28
302 #define MACREG_INT_CODE_SNR_HIGH                29
303 #define MACREG_INT_CODE_MESH_AUTO_STARTED       35
304 #define MACREG_INT_CODE_FIRMWARE_READY          48
305
306 #endif