1 /* 2 * This file is part of wl1271 3 * 4 * Copyright (C) 1998-2009 Texas Instruments. All rights reserved. 5 * Copyright (C) 2009 Nokia Corporation 6 * 7 * Contact: Luciano Coelho <luciano.coelho@nokia.com> 8 * 9 * This program is free software; you can redistribute it and/or 10 * modify it under the terms of the GNU General Public License 11 * version 2 as published by the Free Software Foundation. 12 * 13 * This program is distributed in the hope that it will be useful, but 14 * WITHOUT ANY WARRANTY; without even the implied warranty of 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 16 * General Public License for more details. 17 * 18 * You should have received a copy of the GNU General Public License 19 * along with this program; if not, write to the Free Software 20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 21 * 02110-1301 USA 22 * 23 */ 24 25 #ifndef __CMD_H__ 26 #define __CMD_H__ 27 28 #include "wl12xx.h" 29 30 struct acx_header; 31 32 int wl1271_cmd_send(struct wl1271 *wl, u16 id, void *buf, size_t len, 33 size_t res_len); 34 int wl1271_cmd_general_parms(struct wl1271 *wl); 35 int wl1271_cmd_radio_parms(struct wl1271 *wl); 36 int wl1271_cmd_ext_radio_parms(struct wl1271 *wl); 37 int wl1271_cmd_join(struct wl1271 *wl, u8 bss_type); 38 int wl1271_cmd_test(struct wl1271 *wl, void *buf, size_t buf_len, u8 answer); 39 int wl1271_cmd_interrogate(struct wl1271 *wl, u16 id, void *buf, size_t len); 40 int wl1271_cmd_configure(struct wl1271 *wl, u16 id, void *buf, size_t len); 41 int wl1271_cmd_data_path(struct wl1271 *wl, bool enable); 42 int wl1271_cmd_ps_mode(struct wl1271 *wl, u8 ps_mode); 43 int wl1271_cmd_read_memory(struct wl1271 *wl, u32 addr, void *answer, 44 size_t len); 45 int wl1271_cmd_template_set(struct wl1271 *wl, u16 template_id, 46 void *buf, size_t buf_len, int index, u32 rates); 47 int wl1271_cmd_build_null_data(struct wl1271 *wl); 48 int wl1271_cmd_build_ps_poll(struct wl1271 *wl, u16 aid); 49 int wl1271_cmd_build_probe_req(struct wl1271 *wl, 50 const u8 *ssid, size_t ssid_len, 51 const u8 *ie, size_t ie_len, u8 band); 52 struct sk_buff *wl1271_cmd_build_ap_probe_req(struct wl1271 *wl, 53 struct sk_buff *skb); 54 int wl1271_cmd_build_arp_rsp(struct wl1271 *wl, __be32 ip_addr); 55 int wl1271_build_qos_null_data(struct wl1271 *wl); 56 int wl1271_cmd_build_klv_null_data(struct wl1271 *wl); 57 int wl1271_cmd_set_sta_default_wep_key(struct wl1271 *wl, u8 id); 58 int wl1271_cmd_set_ap_default_wep_key(struct wl1271 *wl, u8 id); 59 int wl1271_cmd_set_sta_key(struct wl1271 *wl, u16 action, u8 id, u8 key_type, 60 u8 key_size, const u8 *key, const u8 *addr, 61 u32 tx_seq_32, u16 tx_seq_16); 62 int wl1271_cmd_set_ap_key(struct wl1271 *wl, u16 action, u8 id, u8 key_type, 63 u8 key_size, const u8 *key, u8 hlid, u32 tx_seq_32, 64 u16 tx_seq_16); 65 int wl1271_cmd_disconnect(struct wl1271 *wl); 66 int wl1271_cmd_set_sta_state(struct wl1271 *wl); 67 int wl1271_cmd_start_bss(struct wl1271 *wl); 68 int wl1271_cmd_stop_bss(struct wl1271 *wl); 69 int wl1271_cmd_add_sta(struct wl1271 *wl, struct ieee80211_sta *sta, u8 hlid); 70 int wl1271_cmd_remove_sta(struct wl1271 *wl, u8 hlid); 71 72 enum wl1271_commands { 73 CMD_INTERROGATE = 1, /*use this to read information elements*/ 74 CMD_CONFIGURE = 2, /*use this to write information elements*/ 75 CMD_ENABLE_RX = 3, 76 CMD_ENABLE_TX = 4, 77 CMD_DISABLE_RX = 5, 78 CMD_DISABLE_TX = 6, 79 CMD_SCAN = 8, 80 CMD_STOP_SCAN = 9, 81 CMD_START_JOIN = 11, 82 CMD_SET_KEYS = 12, 83 CMD_READ_MEMORY = 13, 84 CMD_WRITE_MEMORY = 14, 85 CMD_SET_TEMPLATE = 19, 86 CMD_TEST = 23, 87 CMD_NOISE_HIST = 28, 88 CMD_LNA_CONTROL = 32, 89 CMD_SET_BCN_MODE = 33, 90 CMD_MEASUREMENT = 34, 91 CMD_STOP_MEASUREMENT = 35, 92 CMD_DISCONNECT = 36, 93 CMD_SET_PS_MODE = 37, 94 CMD_CHANNEL_SWITCH = 38, 95 CMD_STOP_CHANNEL_SWICTH = 39, 96 CMD_AP_DISCOVERY = 40, 97 CMD_STOP_AP_DISCOVERY = 41, 98 CMD_SPS_SCAN = 42, 99 CMD_STOP_SPS_SCAN = 43, 100 CMD_HEALTH_CHECK = 45, 101 CMD_DEBUG = 46, 102 CMD_TRIGGER_SCAN_TO = 47, 103 CMD_CONNECTION_SCAN_CFG = 48, 104 CMD_CONNECTION_SCAN_SSID_CFG = 49, 105 CMD_START_PERIODIC_SCAN = 50, 106 CMD_STOP_PERIODIC_SCAN = 51, 107 CMD_SET_STA_STATE = 52, 108 109 /* AP mode commands */ 110 CMD_BSS_START = 60, 111 CMD_BSS_STOP = 61, 112 CMD_ADD_STA = 62, 113 CMD_REMOVE_STA = 63, 114 115 NUM_COMMANDS, 116 MAX_COMMAND_ID = 0xFFFF, 117 }; 118 119 #define MAX_CMD_PARAMS 572 120 121 enum { 122 CMD_TEMPL_KLV_IDX_NULL_DATA = 0, 123 CMD_TEMPL_KLV_IDX_MAX = 4 124 }; 125 126 enum cmd_templ { 127 CMD_TEMPL_NULL_DATA = 0, 128 CMD_TEMPL_BEACON, 129 CMD_TEMPL_CFG_PROBE_REQ_2_4, 130 CMD_TEMPL_CFG_PROBE_REQ_5, 131 CMD_TEMPL_PROBE_RESPONSE, 132 CMD_TEMPL_QOS_NULL_DATA, 133 CMD_TEMPL_PS_POLL, 134 CMD_TEMPL_KLV, 135 CMD_TEMPL_DISCONNECT, 136 CMD_TEMPL_PROBE_REQ_2_4, /* for firmware internal use only */ 137 CMD_TEMPL_PROBE_REQ_5, /* for firmware internal use only */ 138 CMD_TEMPL_BAR, /* for firmware internal use only */ 139 CMD_TEMPL_CTS, /* 140 * For CTS-to-self (FastCTS) mechanism 141 * for BT/WLAN coexistence (SoftGemini). */ 142 CMD_TEMPL_ARP_RSP, 143 CMD_TEMPL_LINK_MEASUREMENT_REPORT, 144 145 /* AP-mode specific */ 146 CMD_TEMPL_AP_BEACON = 13, 147 CMD_TEMPL_AP_PROBE_RESPONSE, 148 CMD_TEMPL_AP_ARP_RSP, 149 CMD_TEMPL_DEAUTH_AP, 150 151 CMD_TEMPL_MAX = 0xff 152 }; 153 154 /* unit ms */ 155 #define WL1271_COMMAND_TIMEOUT 2000 156 #define WL1271_CMD_TEMPL_MAX_SIZE 252 157 #define WL1271_EVENT_TIMEOUT 750 158 159 struct wl1271_cmd_header { 160 __le16 id; 161 __le16 status; 162 /* payload */ 163 u8 data[0]; 164 } __packed; 165 166 #define WL1271_CMD_MAX_PARAMS 572 167 168 struct wl1271_command { 169 struct wl1271_cmd_header header; 170 u8 parameters[WL1271_CMD_MAX_PARAMS]; 171 } __packed; 172 173 enum { 174 CMD_MAILBOX_IDLE = 0, 175 CMD_STATUS_SUCCESS = 1, 176 CMD_STATUS_UNKNOWN_CMD = 2, 177 CMD_STATUS_UNKNOWN_IE = 3, 178 CMD_STATUS_REJECT_MEAS_SG_ACTIVE = 11, 179 CMD_STATUS_RX_BUSY = 13, 180 CMD_STATUS_INVALID_PARAM = 14, 181 CMD_STATUS_TEMPLATE_TOO_LARGE = 15, 182 CMD_STATUS_OUT_OF_MEMORY = 16, 183 CMD_STATUS_STA_TABLE_FULL = 17, 184 CMD_STATUS_RADIO_ERROR = 18, 185 CMD_STATUS_WRONG_NESTING = 19, 186 CMD_STATUS_TIMEOUT = 21, /* Driver internal use.*/ 187 CMD_STATUS_FW_RESET = 22, /* Driver internal use.*/ 188 MAX_COMMAND_STATUS = 0xff 189 }; 190 191 #define CMDMBOX_HEADER_LEN 4 192 #define CMDMBOX_INFO_ELEM_HEADER_LEN 4 193 194 enum { 195 BSS_TYPE_IBSS = 0, 196 BSS_TYPE_STA_BSS = 2, 197 BSS_TYPE_AP_BSS = 3, 198 MAX_BSS_TYPE = 0xFF 199 }; 200 201 #define WL1271_JOIN_CMD_CTRL_TX_FLUSH 0x80 /* Firmware flushes all Tx */ 202 #define WL1271_JOIN_CMD_TX_SESSION_OFFSET 1 203 #define WL1271_JOIN_CMD_BSS_TYPE_5GHZ 0x10 204 205 struct wl1271_cmd_join { 206 struct wl1271_cmd_header header; 207 208 __le32 bssid_lsb; 209 __le16 bssid_msb; 210 __le16 beacon_interval; /* in TBTTs */ 211 __le32 rx_config_options; 212 __le32 rx_filter_options; 213 214 /* 215 * The target uses this field to determine the rate at 216 * which to transmit control frame responses (such as 217 * ACK or CTS frames). 218 */ 219 __le32 basic_rate_set; 220 __le32 supported_rate_set; 221 u8 dtim_interval; 222 /* 223 * bits 0-2: This bitwise field specifies the type 224 * of BSS to start or join (BSS_TYPE_*). 225 * bit 4: Band - The radio band in which to join 226 * or start. 227 * 0 - 2.4GHz band 228 * 1 - 5GHz band 229 * bits 3, 5-7: Reserved 230 */ 231 u8 bss_type; 232 u8 channel; 233 u8 ssid_len; 234 u8 ssid[IW_ESSID_MAX_SIZE]; 235 u8 ctrl; /* JOIN_CMD_CTRL_* */ 236 u8 reserved[3]; 237 } __packed; 238 239 struct cmd_enabledisable_path { 240 struct wl1271_cmd_header header; 241 242 u8 channel; 243 u8 padding[3]; 244 } __packed; 245 246 #define WL1271_RATE_AUTOMATIC 0 247 248 struct wl1271_cmd_template_set { 249 struct wl1271_cmd_header header; 250 251 __le16 len; 252 u8 template_type; 253 u8 index; /* relevant only for KLV_TEMPLATE type */ 254 __le32 enabled_rates; 255 u8 short_retry_limit; 256 u8 long_retry_limit; 257 u8 aflags; 258 u8 reserved; 259 u8 template_data[WL1271_CMD_TEMPL_MAX_SIZE]; 260 } __packed; 261 262 #define TIM_ELE_ID 5 263 #define PARTIAL_VBM_MAX 251 264 265 struct wl1271_tim { 266 u8 identity; 267 u8 length; 268 u8 dtim_count; 269 u8 dtim_period; 270 u8 bitmap_ctrl; 271 u8 pvb_field[PARTIAL_VBM_MAX]; /* Partial Virtual Bitmap */ 272 } __packed; 273 274 enum wl1271_cmd_ps_mode { 275 STATION_ACTIVE_MODE, 276 STATION_POWER_SAVE_MODE 277 }; 278 279 struct wl1271_cmd_ps_params { 280 struct wl1271_cmd_header header; 281 282 u8 ps_mode; /* STATION_* */ 283 u8 padding[3]; 284 } __packed; 285 286 /* HW encryption keys */ 287 #define NUM_ACCESS_CATEGORIES_COPY 4 288 289 enum wl1271_cmd_key_action { 290 KEY_ADD_OR_REPLACE = 1, 291 KEY_REMOVE = 2, 292 KEY_SET_ID = 3, 293 MAX_KEY_ACTION = 0xffff, 294 }; 295 296 enum wl1271_cmd_key_type { 297 KEY_NONE = 0, 298 KEY_WEP = 1, 299 KEY_TKIP = 2, 300 KEY_AES = 3, 301 KEY_GEM = 4, 302 }; 303 304 /* FIXME: Add description for key-types */ 305 306 struct wl1271_cmd_set_sta_keys { 307 struct wl1271_cmd_header header; 308 309 /* Ignored for default WEP key */ 310 u8 addr[ETH_ALEN]; 311 312 /* key_action_e */ 313 __le16 key_action; 314 315 __le16 reserved_1; 316 317 /* key size in bytes */ 318 u8 key_size; 319 320 /* key_type_e */ 321 u8 key_type; 322 u8 ssid_profile; 323 324 /* 325 * TKIP, AES: frame's key id field. 326 * For WEP default key: key id; 327 */ 328 u8 id; 329 u8 reserved_2[6]; 330 u8 key[MAX_KEY_SIZE]; 331 __le16 ac_seq_num16[NUM_ACCESS_CATEGORIES_COPY]; 332 __le32 ac_seq_num32[NUM_ACCESS_CATEGORIES_COPY]; 333 } __packed; 334 335 enum wl1271_cmd_lid_key_type { 336 UNICAST_LID_TYPE = 0, 337 BROADCAST_LID_TYPE = 1, 338 WEP_DEFAULT_LID_TYPE = 2 339 }; 340 341 struct wl1271_cmd_set_ap_keys { 342 struct wl1271_cmd_header header; 343 344 /* 345 * Indicates whether the HLID is a unicast key set 346 * or broadcast key set. A special value 0xFF is 347 * used to indicate that the HLID is on WEP-default 348 * (multi-hlids). of type wl1271_cmd_lid_key_type. 349 */ 350 u8 hlid; 351 352 /* 353 * In WEP-default network (hlid == 0xFF) used to 354 * indicate which network STA/IBSS/AP role should be 355 * changed 356 */ 357 u8 lid_key_type; 358 359 /* 360 * Key ID - For TKIP and AES key types, this field 361 * indicates the value that should be inserted into 362 * the KeyID field of frames transmitted using this 363 * key entry. For broadcast keys the index use as a 364 * marker for TX/RX key. 365 * For WEP default network (HLID=0xFF), this field 366 * indicates the ID of the key to add or remove. 367 */ 368 u8 key_id; 369 u8 reserved_1; 370 371 /* key_action_e */ 372 __le16 key_action; 373 374 /* key size in bytes */ 375 u8 key_size; 376 377 /* key_type_e */ 378 u8 key_type; 379 380 /* This field holds the security key data to add to the STA table */ 381 u8 key[MAX_KEY_SIZE]; 382 __le16 ac_seq_num16[NUM_ACCESS_CATEGORIES_COPY]; 383 __le32 ac_seq_num32[NUM_ACCESS_CATEGORIES_COPY]; 384 } __packed; 385 386 struct wl1271_cmd_test_header { 387 u8 id; 388 u8 padding[3]; 389 } __packed; 390 391 enum wl1271_channel_tune_bands { 392 WL1271_CHANNEL_TUNE_BAND_2_4, 393 WL1271_CHANNEL_TUNE_BAND_5, 394 WL1271_CHANNEL_TUNE_BAND_4_9 395 }; 396 397 #define WL1271_PD_REFERENCE_POINT_BAND_B_G 0 398 399 #define TEST_CMD_INI_FILE_RADIO_PARAM 0x19 400 #define TEST_CMD_INI_FILE_GENERAL_PARAM 0x1E 401 #define TEST_CMD_INI_FILE_RF_EXTENDED_PARAM 0x26 402 403 struct wl1271_general_parms_cmd { 404 struct wl1271_cmd_header header; 405 406 struct wl1271_cmd_test_header test; 407 408 struct wl1271_ini_general_params general_params; 409 410 u8 sr_debug_table[WL1271_INI_MAX_SMART_REFLEX_PARAM]; 411 u8 sr_sen_n_p; 412 u8 sr_sen_n_p_gain; 413 u8 sr_sen_nrn; 414 u8 sr_sen_prn; 415 u8 padding[3]; 416 } __packed; 417 418 struct wl1271_radio_parms_cmd { 419 struct wl1271_cmd_header header; 420 421 struct wl1271_cmd_test_header test; 422 423 /* Static radio parameters */ 424 struct wl1271_ini_band_params_2 static_params_2; 425 struct wl1271_ini_band_params_5 static_params_5; 426 427 /* Dynamic radio parameters */ 428 struct wl1271_ini_fem_params_2 dyn_params_2; 429 u8 padding2; 430 struct wl1271_ini_fem_params_5 dyn_params_5; 431 u8 padding3[2]; 432 } __packed; 433 434 struct wl1271_ext_radio_parms_cmd { 435 struct wl1271_cmd_header header; 436 437 struct wl1271_cmd_test_header test; 438 439 u8 tx_per_channel_power_compensation_2[CONF_TX_PWR_COMPENSATION_LEN_2]; 440 u8 tx_per_channel_power_compensation_5[CONF_TX_PWR_COMPENSATION_LEN_5]; 441 u8 padding[3]; 442 } __packed; 443 444 /* 445 * There are three types of disconnections: 446 * 447 * DISCONNECT_IMMEDIATE: the fw doesn't send any frames 448 * DISCONNECT_DEAUTH: the fw generates a DEAUTH request with the reason 449 * we have passed 450 * DISCONNECT_DISASSOC: the fw generates a DESASSOC request with the reason 451 * we have passed 452 */ 453 enum wl1271_disconnect_type { 454 DISCONNECT_IMMEDIATE, 455 DISCONNECT_DEAUTH, 456 DISCONNECT_DISASSOC 457 }; 458 459 struct wl1271_cmd_disconnect { 460 struct wl1271_cmd_header header; 461 462 __le32 rx_config_options; 463 __le32 rx_filter_options; 464 465 __le16 reason; 466 u8 type; 467 468 u8 padding; 469 } __packed; 470 471 #define WL1271_CMD_STA_STATE_CONNECTED 1 472 473 struct wl1271_cmd_set_sta_state { 474 struct wl1271_cmd_header header; 475 476 u8 state; 477 u8 padding[3]; 478 } __packed; 479 480 enum wl1271_ssid_type { 481 SSID_TYPE_PUBLIC = 0, 482 SSID_TYPE_HIDDEN = 1 483 }; 484 485 struct wl1271_cmd_bss_start { 486 struct wl1271_cmd_header header; 487 488 /* wl1271_ssid_type */ 489 u8 ssid_type; 490 u8 ssid_len; 491 u8 ssid[IW_ESSID_MAX_SIZE]; 492 u8 padding_1[2]; 493 494 /* Basic rate set */ 495 __le32 basic_rate_set; 496 /* Aging period in seconds*/ 497 __le16 aging_period; 498 499 /* 500 * This field specifies the time between target beacon 501 * transmission times (TBTTs), in time units (TUs). 502 * Valid values are 1 to 1024. 503 */ 504 __le16 beacon_interval; 505 u8 bssid[ETH_ALEN]; 506 u8 bss_index; 507 /* Radio band */ 508 u8 band; 509 u8 channel; 510 /* The host link id for the AP's global queue */ 511 u8 global_hlid; 512 /* The host link id for the AP's broadcast queue */ 513 u8 broadcast_hlid; 514 /* DTIM count */ 515 u8 dtim_interval; 516 /* Beacon expiry time in ms */ 517 u8 beacon_expiry; 518 u8 padding_2[3]; 519 } __packed; 520 521 struct wl1271_cmd_add_sta { 522 struct wl1271_cmd_header header; 523 524 u8 addr[ETH_ALEN]; 525 u8 hlid; 526 u8 aid; 527 u8 psd_type[NUM_ACCESS_CATEGORIES_COPY]; 528 __le32 supported_rates; 529 u8 bss_index; 530 u8 sp_len; 531 u8 wmm; 532 u8 padding1; 533 } __packed; 534 535 struct wl1271_cmd_remove_sta { 536 struct wl1271_cmd_header header; 537 538 u8 hlid; 539 u8 reason_opcode; 540 u8 send_deauth_flag; 541 u8 padding1; 542 } __packed; 543 544 #endif /* __WL1271_CMD_H__ */ 545