1 /* hfa384x.h 2 * 3 * Defines the constants and data structures for the hfa384x 4 * 5 * Copyright (C) 1999 AbsoluteValue Systems, Inc. All Rights Reserved. 6 * -------------------------------------------------------------------- 7 * 8 * linux-wlan 9 * 10 * The contents of this file are subject to the Mozilla Public 11 * License Version 1.1 (the "License"); you may not use this file 12 * except in compliance with the License. You may obtain a copy of 13 * the License at http://www.mozilla.org/MPL/ 14 * 15 * Software distributed under the License is distributed on an "AS 16 * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or 17 * implied. See the License for the specific language governing 18 * rights and limitations under the License. 19 * 20 * Alternatively, the contents of this file may be used under the 21 * terms of the GNU Public License version 2 (the "GPL"), in which 22 * case the provisions of the GPL are applicable instead of the 23 * above. If you wish to allow the use of your version of this file 24 * only under the terms of the GPL and not to allow others to use 25 * your version of this file under the MPL, indicate your decision 26 * by deleting the provisions above and replace them with the notice 27 * and other provisions required by the GPL. If you do not delete 28 * the provisions above, a recipient may use your version of this 29 * file under either the MPL or the GPL. 30 * 31 * -------------------------------------------------------------------- 32 * 33 * Inquiries regarding the linux-wlan Open Source project can be 34 * made directly to: 35 * 36 * AbsoluteValue Systems Inc. 37 * info@linux-wlan.com 38 * http://www.linux-wlan.com 39 * 40 * -------------------------------------------------------------------- 41 * 42 * Portions of the development of this software were funded by 43 * Intersil Corporation as part of PRISM(R) chipset product development. 44 * 45 * -------------------------------------------------------------------- 46 * 47 * [Implementation and usage notes] 48 * 49 * [References] 50 * CW10 Programmer's Manual v1.5 51 * IEEE 802.11 D10.0 52 * 53 * -------------------------------------------------------------------- 54 */ 55 56 #ifndef _HFA384x_H 57 #define _HFA384x_H 58 59 #define HFA384x_FIRMWARE_VERSION(a, b, c) (((a) << 16) + ((b) << 8) + (c)) 60 61 #include <linux/if_ether.h> 62 63 /*--- Mins & Maxs -----------------------------------*/ 64 #define HFA384x_PORTID_MAX ((u16)7) 65 #define HFA384x_NUMPORTS_MAX ((u16)(HFA384x_PORTID_MAX+1)) 66 #define HFA384x_PDR_LEN_MAX ((u16)512) /* in bytes, from EK */ 67 #define HFA384x_PDA_RECS_MAX ((u16)200) /* a guess */ 68 #define HFA384x_PDA_LEN_MAX ((u16)1024) /* in bytes, from EK */ 69 #define HFA384x_SCANRESULT_MAX ((u16)31) 70 #define HFA384x_HSCANRESULT_MAX ((u16)31) 71 #define HFA384x_CHINFORESULT_MAX ((u16)16) 72 #define HFA384x_RID_GUESSING_MAXLEN 2048 /* I'm not really sure */ 73 #define HFA384x_RIDDATA_MAXLEN HFA384x_RID_GUESSING_MAXLEN 74 #define HFA384x_USB_RWMEM_MAXLEN 2048 75 76 /*--- Support Constants -----------------------------*/ 77 #define HFA384x_PORTTYPE_IBSS ((u16)0) 78 #define HFA384x_PORTTYPE_BSS ((u16)1) 79 #define HFA384x_PORTTYPE_PSUEDOIBSS ((u16)3) 80 #define HFA384x_WEPFLAGS_PRIVINVOKED ((u16)BIT(0)) 81 #define HFA384x_WEPFLAGS_EXCLUDE ((u16)BIT(1)) 82 #define HFA384x_WEPFLAGS_DISABLE_TXCRYPT ((u16)BIT(4)) 83 #define HFA384x_WEPFLAGS_DISABLE_RXCRYPT ((u16)BIT(7)) 84 #define HFA384x_ROAMMODE_HOSTSCAN_HOSTROAM ((u16)3) 85 #define HFA384x_PORTSTATUS_DISABLED ((u16)1) 86 #define HFA384x_RATEBIT_1 ((u16)1) 87 #define HFA384x_RATEBIT_2 ((u16)2) 88 #define HFA384x_RATEBIT_5dot5 ((u16)4) 89 #define HFA384x_RATEBIT_11 ((u16)8) 90 91 /*--- MAC Internal memory constants and macros ------*/ 92 /* masks and macros used to manipulate MAC internal memory addresses. */ 93 /* MAC internal memory addresses are 23 bit quantities. The MAC uses 94 * a paged address space where the upper 16 bits are the page number 95 * and the lower 7 bits are the offset. There are various Host API 96 * elements that require two 16-bit quantities to specify a MAC 97 * internal memory address. Unfortunately, some of the API's use a 98 * page/offset format where the offset value is JUST the lower seven 99 * bits and the page is the remaining 16 bits. Some of the API's 100 * assume that the 23 bit address has been split at the 16th bit. We 101 * refer to these two formats as AUX format and CMD format. The 102 * macros below help handle some of this. 103 */ 104 105 /* Mask bits for discarding unwanted pieces in a flat address */ 106 #define HFA384x_ADDR_FLAT_AUX_PAGE_MASK (0x007fff80) 107 #define HFA384x_ADDR_FLAT_AUX_OFF_MASK (0x0000007f) 108 #define HFA384x_ADDR_FLAT_CMD_PAGE_MASK (0xffff0000) 109 #define HFA384x_ADDR_FLAT_CMD_OFF_MASK (0x0000ffff) 110 111 /* Mask bits for discarding unwanted pieces in AUX format 112 16-bit address parts */ 113 #define HFA384x_ADDR_AUX_PAGE_MASK (0xffff) 114 #define HFA384x_ADDR_AUX_OFF_MASK (0x007f) 115 116 /* Make a 32-bit flat address from AUX format 16-bit page and offset */ 117 #define HFA384x_ADDR_AUX_MKFLAT(p, o) \ 118 ((((u32)(((u16)(p))&HFA384x_ADDR_AUX_PAGE_MASK)) << 7) | \ 119 ((u32)(((u16)(o))&HFA384x_ADDR_AUX_OFF_MASK))) 120 121 /* Make CMD format offset and page from a 32-bit flat address */ 122 #define HFA384x_ADDR_CMD_MKPAGE(f) \ 123 ((u16)((((u32)(f))&HFA384x_ADDR_FLAT_CMD_PAGE_MASK)>>16)) 124 #define HFA384x_ADDR_CMD_MKOFF(f) \ 125 ((u16)(((u32)(f))&HFA384x_ADDR_FLAT_CMD_OFF_MASK)) 126 127 /*--- Controller Memory addresses -------------------*/ 128 #define HFA3842_PDA_BASE (0x007f0000UL) 129 #define HFA3841_PDA_BASE (0x003f0000UL) 130 #define HFA3841_PDA_BOGUS_BASE (0x00390000UL) 131 132 /*--- Driver Download states -----------------------*/ 133 #define HFA384x_DLSTATE_DISABLED 0 134 #define HFA384x_DLSTATE_RAMENABLED 1 135 #define HFA384x_DLSTATE_FLASHENABLED 2 136 137 /*--- Register Field Masks --------------------------*/ 138 #define HFA384x_CMD_AINFO ((u16)(BIT(14) | BIT(13) | BIT(12) | BIT(11) | BIT(10) | BIT(9) | BIT(8))) 139 #define HFA384x_CMD_MACPORT ((u16)(BIT(10) | BIT(9) | BIT(8))) 140 #define HFA384x_CMD_PROGMODE ((u16)(BIT(9) | BIT(8))) 141 #define HFA384x_CMD_CMDCODE ((u16)(BIT(5) | BIT(4) | BIT(3) | BIT(2) | BIT(1) | BIT(0))) 142 143 #define HFA384x_STATUS_RESULT ((u16)(BIT(14) | BIT(13) | BIT(12) | BIT(11) | BIT(10) | BIT(9) | BIT(8))) 144 145 /*--- Command Code Constants --------------------------*/ 146 /*--- Controller Commands --------------------------*/ 147 #define HFA384x_CMDCODE_INIT ((u16)0x00) 148 #define HFA384x_CMDCODE_ENABLE ((u16)0x01) 149 #define HFA384x_CMDCODE_DISABLE ((u16)0x02) 150 151 /*--- Regulate Commands --------------------------*/ 152 #define HFA384x_CMDCODE_INQ ((u16)0x11) 153 154 /*--- Configure Commands --------------------------*/ 155 #define HFA384x_CMDCODE_DOWNLD ((u16)0x22) 156 157 /*--- Debugging Commands -----------------------------*/ 158 #define HFA384x_CMDCODE_MONITOR ((u16)(0x38)) 159 #define HFA384x_MONITOR_ENABLE ((u16)(0x0b)) 160 #define HFA384x_MONITOR_DISABLE ((u16)(0x0f)) 161 162 /*--- Result Codes --------------------------*/ 163 #define HFA384x_CMD_ERR ((u16)(0x7F)) 164 165 /*--- Programming Modes -------------------------- 166 MODE 0: Disable programming 167 MODE 1: Enable volatile memory programming 168 MODE 2: Enable non-volatile memory programming 169 MODE 3: Program non-volatile memory section 170 --------------------------------------------------*/ 171 #define HFA384x_PROGMODE_DISABLE ((u16)0x00) 172 #define HFA384x_PROGMODE_RAM ((u16)0x01) 173 #define HFA384x_PROGMODE_NV ((u16)0x02) 174 #define HFA384x_PROGMODE_NVWRITE ((u16)0x03) 175 176 /*--- Record ID Constants --------------------------*/ 177 /*-------------------------------------------------------------------- 178 Configuration RIDs: Network Parameters, Static Configuration Entities 179 --------------------------------------------------------------------*/ 180 #define HFA384x_RID_CNFPORTTYPE ((u16)0xFC00) 181 #define HFA384x_RID_CNFOWNMACADDR ((u16)0xFC01) 182 #define HFA384x_RID_CNFDESIREDSSID ((u16)0xFC02) 183 #define HFA384x_RID_CNFOWNCHANNEL ((u16)0xFC03) 184 #define HFA384x_RID_CNFOWNSSID ((u16)0xFC04) 185 #define HFA384x_RID_CNFMAXDATALEN ((u16)0xFC07) 186 187 /*-------------------------------------------------------------------- 188 Configuration RID lengths: Network Params, Static Config Entities 189 This is the length of JUST the DATA part of the RID (does not 190 include the len or code fields) 191 --------------------------------------------------------------------*/ 192 #define HFA384x_RID_CNFOWNMACADDR_LEN ((u16)6) 193 #define HFA384x_RID_CNFDESIREDSSID_LEN ((u16)34) 194 #define HFA384x_RID_CNFOWNSSID_LEN ((u16)34) 195 196 /*-------------------------------------------------------------------- 197 Configuration RIDs: Network Parameters, Dynamic Configuration Entities 198 --------------------------------------------------------------------*/ 199 #define HFA384x_RID_CREATEIBSS ((u16)0xFC81) 200 #define HFA384x_RID_FRAGTHRESH ((u16)0xFC82) 201 #define HFA384x_RID_RTSTHRESH ((u16)0xFC83) 202 #define HFA384x_RID_TXRATECNTL ((u16)0xFC84) 203 #define HFA384x_RID_PROMISCMODE ((u16)0xFC85) 204 205 /*---------------------------------------------------------------------- 206 Information RIDs: NIC Information 207 --------------------------------------------------------------------*/ 208 #define HFA384x_RID_MAXLOADTIME ((u16)0xFD00) 209 #define HFA384x_RID_DOWNLOADBUFFER ((u16)0xFD01) 210 #define HFA384x_RID_PRIIDENTITY ((u16)0xFD02) 211 #define HFA384x_RID_PRISUPRANGE ((u16)0xFD03) 212 #define HFA384x_RID_PRI_CFIACTRANGES ((u16)0xFD04) 213 #define HFA384x_RID_NICSERIALNUMBER ((u16)0xFD0A) 214 #define HFA384x_RID_NICIDENTITY ((u16)0xFD0B) 215 #define HFA384x_RID_MFISUPRANGE ((u16)0xFD0C) 216 #define HFA384x_RID_CFISUPRANGE ((u16)0xFD0D) 217 #define HFA384x_RID_STAIDENTITY ((u16)0xFD20) 218 #define HFA384x_RID_STASUPRANGE ((u16)0xFD21) 219 #define HFA384x_RID_STA_MFIACTRANGES ((u16)0xFD22) 220 #define HFA384x_RID_STA_CFIACTRANGES ((u16)0xFD23) 221 222 /*---------------------------------------------------------------------- 223 Information RID Lengths: NIC Information 224 This is the length of JUST the DATA part of the RID (does not 225 include the len or code fields) 226 --------------------------------------------------------------------*/ 227 #define HFA384x_RID_NICSERIALNUMBER_LEN ((u16)12) 228 229 /*-------------------------------------------------------------------- 230 Information RIDs: MAC Information 231 --------------------------------------------------------------------*/ 232 #define HFA384x_RID_PORTSTATUS ((u16)0xFD40) 233 #define HFA384x_RID_CURRENTSSID ((u16)0xFD41) 234 #define HFA384x_RID_CURRENTBSSID ((u16)0xFD42) 235 #define HFA384x_RID_CURRENTTXRATE ((u16)0xFD44) 236 #define HFA384x_RID_SHORTRETRYLIMIT ((u16)0xFD48) 237 #define HFA384x_RID_LONGRETRYLIMIT ((u16)0xFD49) 238 #define HFA384x_RID_MAXTXLIFETIME ((u16)0xFD4A) 239 #define HFA384x_RID_PRIVACYOPTIMP ((u16)0xFD4F) 240 #define HFA384x_RID_DBMCOMMSQUALITY ((u16)0xFD51) 241 242 /*-------------------------------------------------------------------- 243 Information RID Lengths: MAC Information 244 This is the length of JUST the DATA part of the RID (does not 245 include the len or code fields) 246 --------------------------------------------------------------------*/ 247 #define HFA384x_RID_DBMCOMMSQUALITY_LEN ((u16)sizeof(hfa384x_dbmcommsquality_t)) 248 #define HFA384x_RID_JOINREQUEST_LEN ((u16)sizeof(hfa384x_JoinRequest_data_t)) 249 250 /*-------------------------------------------------------------------- 251 Information RIDs: Modem Information 252 --------------------------------------------------------------------*/ 253 #define HFA384x_RID_CURRENTCHANNEL ((u16)0xFDC1) 254 255 /*-------------------------------------------------------------------- 256 API ENHANCEMENTS (NOT ALREADY IMPLEMENTED) 257 --------------------------------------------------------------------*/ 258 #define HFA384x_RID_CNFWEPDEFAULTKEYID ((u16)0xFC23) 259 #define HFA384x_RID_CNFWEPDEFAULTKEY0 ((u16)0xFC24) 260 #define HFA384x_RID_CNFWEPDEFAULTKEY1 ((u16)0xFC25) 261 #define HFA384x_RID_CNFWEPDEFAULTKEY2 ((u16)0xFC26) 262 #define HFA384x_RID_CNFWEPDEFAULTKEY3 ((u16)0xFC27) 263 #define HFA384x_RID_CNFWEPFLAGS ((u16)0xFC28) 264 #define HFA384x_RID_CNFAUTHENTICATION ((u16)0xFC2A) 265 #define HFA384x_RID_CNFROAMINGMODE ((u16)0xFC2D) 266 #define HFA384x_RID_CNFAPBCNint ((u16)0xFC33) 267 #define HFA384x_RID_CNFDBMADJUST ((u16)0xFC46) 268 #define HFA384x_RID_CNFWPADATA ((u16)0xFC48) 269 #define HFA384x_RID_CNFBASICRATES ((u16)0xFCB3) 270 #define HFA384x_RID_CNFSUPPRATES ((u16)0xFCB4) 271 #define HFA384x_RID_CNFPASSIVESCANCTRL ((u16)0xFCBA) 272 #define HFA384x_RID_TXPOWERMAX ((u16)0xFCBE) 273 #define HFA384x_RID_JOINREQUEST ((u16)0xFCE2) 274 #define HFA384x_RID_AUTHENTICATESTA ((u16)0xFCE3) 275 #define HFA384x_RID_HOSTSCAN ((u16)0xFCE5) 276 277 #define HFA384x_RID_CNFWEPDEFAULTKEY_LEN ((u16)6) 278 #define HFA384x_RID_CNFWEP128DEFAULTKEY_LEN ((u16)14) 279 280 /*-------------------------------------------------------------------- 281 PD Record codes 282 --------------------------------------------------------------------*/ 283 #define HFA384x_PDR_PCB_PARTNUM ((u16)0x0001) 284 #define HFA384x_PDR_PDAVER ((u16)0x0002) 285 #define HFA384x_PDR_NIC_SERIAL ((u16)0x0003) 286 #define HFA384x_PDR_MKK_MEASUREMENTS ((u16)0x0004) 287 #define HFA384x_PDR_NIC_RAMSIZE ((u16)0x0005) 288 #define HFA384x_PDR_MFISUPRANGE ((u16)0x0006) 289 #define HFA384x_PDR_CFISUPRANGE ((u16)0x0007) 290 #define HFA384x_PDR_NICID ((u16)0x0008) 291 #define HFA384x_PDR_MAC_ADDRESS ((u16)0x0101) 292 #define HFA384x_PDR_REGDOMAIN ((u16)0x0103) 293 #define HFA384x_PDR_ALLOWED_CHANNEL ((u16)0x0104) 294 #define HFA384x_PDR_DEFAULT_CHANNEL ((u16)0x0105) 295 #define HFA384x_PDR_TEMPTYPE ((u16)0x0107) 296 #define HFA384x_PDR_IFR_SETTING ((u16)0x0200) 297 #define HFA384x_PDR_RFR_SETTING ((u16)0x0201) 298 #define HFA384x_PDR_HFA3861_BASELINE ((u16)0x0202) 299 #define HFA384x_PDR_HFA3861_SHADOW ((u16)0x0203) 300 #define HFA384x_PDR_HFA3861_IFRF ((u16)0x0204) 301 #define HFA384x_PDR_HFA3861_CHCALSP ((u16)0x0300) 302 #define HFA384x_PDR_HFA3861_CHCALI ((u16)0x0301) 303 #define HFA384x_PDR_MAX_TX_POWER ((u16)0x0302) 304 #define HFA384x_PDR_MASTER_CHAN_LIST ((u16)0x0303) 305 #define HFA384x_PDR_3842_NIC_CONFIG ((u16)0x0400) 306 #define HFA384x_PDR_USB_ID ((u16)0x0401) 307 #define HFA384x_PDR_PCI_ID ((u16)0x0402) 308 #define HFA384x_PDR_PCI_IFCONF ((u16)0x0403) 309 #define HFA384x_PDR_PCI_PMCONF ((u16)0x0404) 310 #define HFA384x_PDR_RFENRGY ((u16)0x0406) 311 #define HFA384x_PDR_USB_POWER_TYPE ((u16)0x0407) 312 #define HFA384x_PDR_USB_MAX_POWER ((u16)0x0409) 313 #define HFA384x_PDR_USB_MANUFACTURER ((u16)0x0410) 314 #define HFA384x_PDR_USB_PRODUCT ((u16)0x0411) 315 #define HFA384x_PDR_ANT_DIVERSITY ((u16)0x0412) 316 #define HFA384x_PDR_HFO_DELAY ((u16)0x0413) 317 #define HFA384x_PDR_SCALE_THRESH ((u16)0x0414) 318 319 #define HFA384x_PDR_HFA3861_MANF_TESTSP ((u16)0x0900) 320 #define HFA384x_PDR_HFA3861_MANF_TESTI ((u16)0x0901) 321 #define HFA384x_PDR_END_OF_PDA ((u16)0x0000) 322 323 /*--- Register Test/Get/Set Field macros ------------------------*/ 324 325 #define HFA384x_CMD_AINFO_SET(value) ((u16)((u16)(value) << 8)) 326 #define HFA384x_CMD_MACPORT_SET(value) ((u16)HFA384x_CMD_AINFO_SET(value)) 327 #define HFA384x_CMD_PROGMODE_SET(value) ((u16)HFA384x_CMD_AINFO_SET((u16)value)) 328 #define HFA384x_CMD_CMDCODE_SET(value) ((u16)(value)) 329 330 #define HFA384x_STATUS_RESULT_SET(value) (((u16)(value)) << 8) 331 332 /* Host Maintained State Info */ 333 #define HFA384x_STATE_PREINIT 0 334 #define HFA384x_STATE_INIT 1 335 #define HFA384x_STATE_RUNNING 2 336 337 /*-------------------------------------------------------------*/ 338 /* Commonly used basic types */ 339 typedef struct hfa384x_bytestr { 340 u16 len; 341 u8 data[0]; 342 } __attribute__ ((packed)) hfa384x_bytestr_t; 343 344 typedef struct hfa384x_bytestr32 { 345 u16 len; 346 u8 data[32]; 347 } __attribute__ ((packed)) hfa384x_bytestr32_t; 348 349 /*-------------------------------------------------------------------- 350 Configuration Record Structures: 351 Network Parameters, Static Configuration Entities 352 --------------------------------------------------------------------*/ 353 354 /*-- Hardware/Firmware Component Information ----------*/ 355 typedef struct hfa384x_compident { 356 u16 id; 357 u16 variant; 358 u16 major; 359 u16 minor; 360 } __attribute__ ((packed)) hfa384x_compident_t; 361 362 typedef struct hfa384x_caplevel { 363 u16 role; 364 u16 id; 365 u16 variant; 366 u16 bottom; 367 u16 top; 368 } __attribute__ ((packed)) hfa384x_caplevel_t; 369 370 /*-- Configuration Record: cnfAuthentication --*/ 371 #define HFA384x_CNFAUTHENTICATION_OPENSYSTEM 0x0001 372 #define HFA384x_CNFAUTHENTICATION_SHAREDKEY 0x0002 373 #define HFA384x_CNFAUTHENTICATION_LEAP 0x0004 374 375 /*-------------------------------------------------------------------- 376 Configuration Record Structures: 377 Network Parameters, Dynamic Configuration Entities 378 --------------------------------------------------------------------*/ 379 380 #define HFA384x_CREATEIBSS_JOINCREATEIBSS 0 381 382 /*-- Configuration Record: HostScanRequest (data portion only) --*/ 383 typedef struct hfa384x_HostScanRequest_data { 384 u16 channelList; 385 u16 txRate; 386 hfa384x_bytestr32_t ssid; 387 } __attribute__ ((packed)) hfa384x_HostScanRequest_data_t; 388 389 /*-- Configuration Record: JoinRequest (data portion only) --*/ 390 typedef struct hfa384x_JoinRequest_data { 391 u8 bssid[WLAN_BSSID_LEN]; 392 u16 channel; 393 } __attribute__ ((packed)) hfa384x_JoinRequest_data_t; 394 395 /*-- Configuration Record: authenticateStation (data portion only) --*/ 396 typedef struct hfa384x_authenticateStation_data { 397 u8 address[ETH_ALEN]; 398 u16 status; 399 u16 algorithm; 400 } __attribute__ ((packed)) hfa384x_authenticateStation_data_t; 401 402 /*-- Configuration Record: WPAData (data portion only) --*/ 403 typedef struct hfa384x_WPAData { 404 u16 datalen; 405 u8 data[0]; /* max 80 */ 406 } __attribute__ ((packed)) hfa384x_WPAData_t; 407 408 /*-------------------------------------------------------------------- 409 Information Record Structures: NIC Information 410 --------------------------------------------------------------------*/ 411 412 /*-- Information Record: DownLoadBuffer --*/ 413 /* NOTE: The page and offset are in AUX format */ 414 typedef struct hfa384x_downloadbuffer { 415 u16 page; 416 u16 offset; 417 u16 len; 418 } __attribute__ ((packed)) hfa384x_downloadbuffer_t; 419 420 /*-------------------------------------------------------------------- 421 Information Record Structures: NIC Information 422 --------------------------------------------------------------------*/ 423 424 #define HFA384x_PSTATUS_CONN_IBSS ((u16)3) 425 426 /*-- Information Record: commsquality --*/ 427 typedef struct hfa384x_commsquality { 428 u16 CQ_currBSS; 429 u16 ASL_currBSS; 430 u16 ANL_currFC; 431 } __attribute__ ((packed)) hfa384x_commsquality_t; 432 433 /*-- Information Record: dmbcommsquality --*/ 434 typedef struct hfa384x_dbmcommsquality { 435 u16 CQdbm_currBSS; 436 u16 ASLdbm_currBSS; 437 u16 ANLdbm_currFC; 438 } __attribute__ ((packed)) hfa384x_dbmcommsquality_t; 439 440 /*-------------------------------------------------------------------- 441 FRAME STRUCTURES: Communication Frames 442 ---------------------------------------------------------------------- 443 Communication Frames: Transmit Frames 444 --------------------------------------------------------------------*/ 445 /*-- Communication Frame: Transmit Frame Structure --*/ 446 typedef struct hfa384x_tx_frame { 447 u16 status; 448 u16 reserved1; 449 u16 reserved2; 450 u32 sw_support; 451 u8 tx_retrycount; 452 u8 tx_rate; 453 u16 tx_control; 454 455 /*-- 802.11 Header Information --*/ 456 457 u16 frame_control; 458 u16 duration_id; 459 u8 address1[6]; 460 u8 address2[6]; 461 u8 address3[6]; 462 u16 sequence_control; 463 u8 address4[6]; 464 u16 data_len; /* little endian format */ 465 466 /*-- 802.3 Header Information --*/ 467 468 u8 dest_addr[6]; 469 u8 src_addr[6]; 470 u16 data_length; /* big endian format */ 471 } __attribute__ ((packed)) hfa384x_tx_frame_t; 472 /*-------------------------------------------------------------------- 473 Communication Frames: Field Masks for Transmit Frames 474 --------------------------------------------------------------------*/ 475 /*-- Status Field --*/ 476 #define HFA384x_TXSTATUS_ACKERR ((u16)BIT(5)) 477 #define HFA384x_TXSTATUS_FORMERR ((u16)BIT(3)) 478 #define HFA384x_TXSTATUS_DISCON ((u16)BIT(2)) 479 #define HFA384x_TXSTATUS_AGEDERR ((u16)BIT(1)) 480 #define HFA384x_TXSTATUS_RETRYERR ((u16)BIT(0)) 481 /*-- Transmit Control Field --*/ 482 #define HFA384x_TX_MACPORT ((u16)(BIT(10) | BIT(9) | BIT(8))) 483 #define HFA384x_TX_STRUCTYPE ((u16)(BIT(4) | BIT(3))) 484 #define HFA384x_TX_TXEX ((u16)BIT(2)) 485 #define HFA384x_TX_TXOK ((u16)BIT(1)) 486 /*-------------------------------------------------------------------- 487 Communication Frames: Test/Get/Set Field Values for Transmit Frames 488 --------------------------------------------------------------------*/ 489 /*-- Status Field --*/ 490 #define HFA384x_TXSTATUS_ISERROR(v) \ 491 (((u16)(v))&\ 492 (HFA384x_TXSTATUS_ACKERR|HFA384x_TXSTATUS_FORMERR|\ 493 HFA384x_TXSTATUS_DISCON|HFA384x_TXSTATUS_AGEDERR|\ 494 HFA384x_TXSTATUS_RETRYERR)) 495 496 #define HFA384x_TX_SET(v, m, s) ((((u16)(v))<<((u16)(s)))&((u16)(m))) 497 498 #define HFA384x_TX_MACPORT_SET(v) HFA384x_TX_SET(v, HFA384x_TX_MACPORT, 8) 499 #define HFA384x_TX_STRUCTYPE_SET(v) HFA384x_TX_SET(v, HFA384x_TX_STRUCTYPE, 3) 500 #define HFA384x_TX_TXEX_SET(v) HFA384x_TX_SET(v, HFA384x_TX_TXEX, 2) 501 #define HFA384x_TX_TXOK_SET(v) HFA384x_TX_SET(v, HFA384x_TX_TXOK, 1) 502 /*-------------------------------------------------------------------- 503 Communication Frames: Receive Frames 504 --------------------------------------------------------------------*/ 505 /*-- Communication Frame: Receive Frame Structure --*/ 506 typedef struct hfa384x_rx_frame { 507 /*-- MAC rx descriptor (hfa384x byte order) --*/ 508 u16 status; 509 u32 time; 510 u8 silence; 511 u8 signal; 512 u8 rate; 513 u8 rx_flow; 514 u16 reserved1; 515 u16 reserved2; 516 517 /*-- 802.11 Header Information (802.11 byte order) --*/ 518 u16 frame_control; 519 u16 duration_id; 520 u8 address1[6]; 521 u8 address2[6]; 522 u8 address3[6]; 523 u16 sequence_control; 524 u8 address4[6]; 525 u16 data_len; /* hfa384x (little endian) format */ 526 527 /*-- 802.3 Header Information --*/ 528 u8 dest_addr[6]; 529 u8 src_addr[6]; 530 u16 data_length; /* IEEE? (big endian) format */ 531 } __attribute__ ((packed)) hfa384x_rx_frame_t; 532 /*-------------------------------------------------------------------- 533 Communication Frames: Field Masks for Receive Frames 534 --------------------------------------------------------------------*/ 535 536 /*-- Status Fields --*/ 537 #define HFA384x_RXSTATUS_MACPORT ((u16)(BIT(10) | BIT(9) | BIT(8))) 538 #define HFA384x_RXSTATUS_FCSERR ((u16)BIT(0)) 539 /*-------------------------------------------------------------------- 540 Communication Frames: Test/Get/Set Field Values for Receive Frames 541 --------------------------------------------------------------------*/ 542 #define HFA384x_RXSTATUS_MACPORT_GET(value) ((u16)((((u16)(value)) & HFA384x_RXSTATUS_MACPORT) >> 8)) 543 #define HFA384x_RXSTATUS_ISFCSERR(value) ((u16)(((u16)(value)) & HFA384x_RXSTATUS_FCSERR)) 544 /*-------------------------------------------------------------------- 545 FRAME STRUCTURES: Information Types and Information Frame Structures 546 ---------------------------------------------------------------------- 547 Information Types 548 --------------------------------------------------------------------*/ 549 #define HFA384x_IT_HANDOVERADDR ((u16)0xF000UL) 550 #define HFA384x_IT_COMMTALLIES ((u16)0xF100UL) 551 #define HFA384x_IT_SCANRESULTS ((u16)0xF101UL) 552 #define HFA384x_IT_CHINFORESULTS ((u16)0xF102UL) 553 #define HFA384x_IT_HOSTSCANRESULTS ((u16)0xF103UL) 554 #define HFA384x_IT_LINKSTATUS ((u16)0xF200UL) 555 #define HFA384x_IT_ASSOCSTATUS ((u16)0xF201UL) 556 #define HFA384x_IT_AUTHREQ ((u16)0xF202UL) 557 #define HFA384x_IT_PSUSERCNT ((u16)0xF203UL) 558 #define HFA384x_IT_KEYIDCHANGED ((u16)0xF204UL) 559 #define HFA384x_IT_ASSOCREQ ((u16)0xF205UL) 560 #define HFA384x_IT_MICFAILURE ((u16)0xF206UL) 561 562 /*-------------------------------------------------------------------- 563 Information Frames Structures 564 ---------------------------------------------------------------------- 565 Information Frames: Notification Frame Structures 566 --------------------------------------------------------------------*/ 567 568 /*-- Inquiry Frame, Diagnose: Communication Tallies --*/ 569 typedef struct hfa384x_CommTallies16 { 570 u16 txunicastframes; 571 u16 txmulticastframes; 572 u16 txfragments; 573 u16 txunicastoctets; 574 u16 txmulticastoctets; 575 u16 txdeferredtrans; 576 u16 txsingleretryframes; 577 u16 txmultipleretryframes; 578 u16 txretrylimitexceeded; 579 u16 txdiscards; 580 u16 rxunicastframes; 581 u16 rxmulticastframes; 582 u16 rxfragments; 583 u16 rxunicastoctets; 584 u16 rxmulticastoctets; 585 u16 rxfcserrors; 586 u16 rxdiscardsnobuffer; 587 u16 txdiscardswrongsa; 588 u16 rxdiscardswepundecr; 589 u16 rxmsginmsgfrag; 590 u16 rxmsginbadmsgfrag; 591 } __attribute__ ((packed)) hfa384x_CommTallies16_t; 592 593 typedef struct hfa384x_CommTallies32 { 594 u32 txunicastframes; 595 u32 txmulticastframes; 596 u32 txfragments; 597 u32 txunicastoctets; 598 u32 txmulticastoctets; 599 u32 txdeferredtrans; 600 u32 txsingleretryframes; 601 u32 txmultipleretryframes; 602 u32 txretrylimitexceeded; 603 u32 txdiscards; 604 u32 rxunicastframes; 605 u32 rxmulticastframes; 606 u32 rxfragments; 607 u32 rxunicastoctets; 608 u32 rxmulticastoctets; 609 u32 rxfcserrors; 610 u32 rxdiscardsnobuffer; 611 u32 txdiscardswrongsa; 612 u32 rxdiscardswepundecr; 613 u32 rxmsginmsgfrag; 614 u32 rxmsginbadmsgfrag; 615 } __attribute__ ((packed)) hfa384x_CommTallies32_t; 616 617 /*-- Inquiry Frame, Diagnose: Scan Results & Subfields--*/ 618 typedef struct hfa384x_ScanResultSub { 619 u16 chid; 620 u16 anl; 621 u16 sl; 622 u8 bssid[WLAN_BSSID_LEN]; 623 u16 bcnint; 624 u16 capinfo; 625 hfa384x_bytestr32_t ssid; 626 u8 supprates[10]; /* 802.11 info element */ 627 u16 proberesp_rate; 628 } __attribute__ ((packed)) hfa384x_ScanResultSub_t; 629 630 typedef struct hfa384x_ScanResult { 631 u16 rsvd; 632 u16 scanreason; 633 hfa384x_ScanResultSub_t result[HFA384x_SCANRESULT_MAX]; 634 } __attribute__ ((packed)) hfa384x_ScanResult_t; 635 636 /*-- Inquiry Frame, Diagnose: ChInfo Results & Subfields--*/ 637 typedef struct hfa384x_ChInfoResultSub { 638 u16 chid; 639 u16 anl; 640 u16 pnl; 641 u16 active; 642 } __attribute__ ((packed)) hfa384x_ChInfoResultSub_t; 643 644 #define HFA384x_CHINFORESULT_BSSACTIVE BIT(0) 645 #define HFA384x_CHINFORESULT_PCFACTIVE BIT(1) 646 647 typedef struct hfa384x_ChInfoResult { 648 u16 scanchannels; 649 hfa384x_ChInfoResultSub_t result[HFA384x_CHINFORESULT_MAX]; 650 } __attribute__ ((packed)) hfa384x_ChInfoResult_t; 651 652 /*-- Inquiry Frame, Diagnose: Host Scan Results & Subfields--*/ 653 typedef struct hfa384x_HScanResultSub { 654 u16 chid; 655 u16 anl; 656 u16 sl; 657 u8 bssid[WLAN_BSSID_LEN]; 658 u16 bcnint; 659 u16 capinfo; 660 hfa384x_bytestr32_t ssid; 661 u8 supprates[10]; /* 802.11 info element */ 662 u16 proberesp_rate; 663 u16 atim; 664 } __attribute__ ((packed)) hfa384x_HScanResultSub_t; 665 666 typedef struct hfa384x_HScanResult { 667 u16 nresult; 668 u16 rsvd; 669 hfa384x_HScanResultSub_t result[HFA384x_HSCANRESULT_MAX]; 670 } __attribute__ ((packed)) hfa384x_HScanResult_t; 671 672 /*-- Unsolicited Frame, MAC Mgmt: LinkStatus --*/ 673 674 #define HFA384x_LINK_NOTCONNECTED ((u16)0) 675 #define HFA384x_LINK_CONNECTED ((u16)1) 676 #define HFA384x_LINK_DISCONNECTED ((u16)2) 677 #define HFA384x_LINK_AP_CHANGE ((u16)3) 678 #define HFA384x_LINK_AP_OUTOFRANGE ((u16)4) 679 #define HFA384x_LINK_AP_INRANGE ((u16)5) 680 #define HFA384x_LINK_ASSOCFAIL ((u16)6) 681 682 typedef struct hfa384x_LinkStatus { 683 u16 linkstatus; 684 } __attribute__ ((packed)) hfa384x_LinkStatus_t; 685 686 /*-- Unsolicited Frame, MAC Mgmt: AssociationStatus (--*/ 687 688 #define HFA384x_ASSOCSTATUS_STAASSOC ((u16)1) 689 #define HFA384x_ASSOCSTATUS_REASSOC ((u16)2) 690 #define HFA384x_ASSOCSTATUS_AUTHFAIL ((u16)5) 691 692 typedef struct hfa384x_AssocStatus { 693 u16 assocstatus; 694 u8 sta_addr[ETH_ALEN]; 695 /* old_ap_addr is only valid if assocstatus == 2 */ 696 u8 old_ap_addr[ETH_ALEN]; 697 u16 reason; 698 u16 reserved; 699 } __attribute__ ((packed)) hfa384x_AssocStatus_t; 700 701 /*-- Unsolicited Frame, MAC Mgmt: AuthRequest (AP Only) --*/ 702 703 typedef struct hfa384x_AuthRequest { 704 u8 sta_addr[ETH_ALEN]; 705 u16 algorithm; 706 } __attribute__ ((packed)) hfa384x_AuthReq_t; 707 708 /*-- Unsolicited Frame, MAC Mgmt: PSUserCount (AP Only) --*/ 709 710 typedef struct hfa384x_PSUserCount { 711 u16 usercnt; 712 } __attribute__ ((packed)) hfa384x_PSUserCount_t; 713 714 typedef struct hfa384x_KeyIDChanged { 715 u8 sta_addr[ETH_ALEN]; 716 u16 keyid; 717 } __attribute__ ((packed)) hfa384x_KeyIDChanged_t; 718 719 /*-- Collection of all Inf frames ---------------*/ 720 typedef union hfa384x_infodata { 721 hfa384x_CommTallies16_t commtallies16; 722 hfa384x_CommTallies32_t commtallies32; 723 hfa384x_ScanResult_t scanresult; 724 hfa384x_ChInfoResult_t chinforesult; 725 hfa384x_HScanResult_t hscanresult; 726 hfa384x_LinkStatus_t linkstatus; 727 hfa384x_AssocStatus_t assocstatus; 728 hfa384x_AuthReq_t authreq; 729 hfa384x_PSUserCount_t psusercnt; 730 hfa384x_KeyIDChanged_t keyidchanged; 731 } __attribute__ ((packed)) hfa384x_infodata_t; 732 733 typedef struct hfa384x_InfFrame { 734 u16 framelen; 735 u16 infotype; 736 hfa384x_infodata_t info; 737 } __attribute__ ((packed)) hfa384x_InfFrame_t; 738 739 /*-------------------------------------------------------------------- 740 USB Packet structures and constants. 741 --------------------------------------------------------------------*/ 742 743 /* Should be sent to the bulkout endpoint */ 744 #define HFA384x_USB_TXFRM 0 745 #define HFA384x_USB_CMDREQ 1 746 #define HFA384x_USB_WRIDREQ 2 747 #define HFA384x_USB_RRIDREQ 3 748 #define HFA384x_USB_WMEMREQ 4 749 #define HFA384x_USB_RMEMREQ 5 750 751 /* Received from the bulkin endpoint */ 752 #define HFA384x_USB_ISTXFRM(a) (((a) & 0x9000) == 0x1000) 753 #define HFA384x_USB_ISRXFRM(a) (!((a) & 0x9000)) 754 #define HFA384x_USB_INFOFRM 0x8000 755 #define HFA384x_USB_CMDRESP 0x8001 756 #define HFA384x_USB_WRIDRESP 0x8002 757 #define HFA384x_USB_RRIDRESP 0x8003 758 #define HFA384x_USB_WMEMRESP 0x8004 759 #define HFA384x_USB_RMEMRESP 0x8005 760 #define HFA384x_USB_BUFAVAIL 0x8006 761 #define HFA384x_USB_ERROR 0x8007 762 763 /*------------------------------------*/ 764 /* Request (bulk OUT) packet contents */ 765 766 typedef struct hfa384x_usb_txfrm { 767 hfa384x_tx_frame_t desc; 768 u8 data[WLAN_DATA_MAXLEN]; 769 } __attribute__ ((packed)) hfa384x_usb_txfrm_t; 770 771 typedef struct hfa384x_usb_cmdreq { 772 u16 type; 773 u16 cmd; 774 u16 parm0; 775 u16 parm1; 776 u16 parm2; 777 u8 pad[54]; 778 } __attribute__ ((packed)) hfa384x_usb_cmdreq_t; 779 780 typedef struct hfa384x_usb_wridreq { 781 u16 type; 782 u16 frmlen; 783 u16 rid; 784 u8 data[HFA384x_RIDDATA_MAXLEN]; 785 } __attribute__ ((packed)) hfa384x_usb_wridreq_t; 786 787 typedef struct hfa384x_usb_rridreq { 788 u16 type; 789 u16 frmlen; 790 u16 rid; 791 u8 pad[58]; 792 } __attribute__ ((packed)) hfa384x_usb_rridreq_t; 793 794 typedef struct hfa384x_usb_wmemreq { 795 u16 type; 796 u16 frmlen; 797 u16 offset; 798 u16 page; 799 u8 data[HFA384x_USB_RWMEM_MAXLEN]; 800 } __attribute__ ((packed)) hfa384x_usb_wmemreq_t; 801 802 typedef struct hfa384x_usb_rmemreq { 803 u16 type; 804 u16 frmlen; 805 u16 offset; 806 u16 page; 807 u8 pad[56]; 808 } __attribute__ ((packed)) hfa384x_usb_rmemreq_t; 809 810 /*------------------------------------*/ 811 /* Response (bulk IN) packet contents */ 812 813 typedef struct hfa384x_usb_rxfrm { 814 hfa384x_rx_frame_t desc; 815 u8 data[WLAN_DATA_MAXLEN]; 816 } __attribute__ ((packed)) hfa384x_usb_rxfrm_t; 817 818 typedef struct hfa384x_usb_infofrm { 819 u16 type; 820 hfa384x_InfFrame_t info; 821 } __attribute__ ((packed)) hfa384x_usb_infofrm_t; 822 823 typedef struct hfa384x_usb_statusresp { 824 u16 type; 825 u16 status; 826 u16 resp0; 827 u16 resp1; 828 u16 resp2; 829 } __attribute__ ((packed)) hfa384x_usb_cmdresp_t; 830 831 typedef hfa384x_usb_cmdresp_t hfa384x_usb_wridresp_t; 832 833 typedef struct hfa384x_usb_rridresp { 834 u16 type; 835 u16 frmlen; 836 u16 rid; 837 u8 data[HFA384x_RIDDATA_MAXLEN]; 838 } __attribute__ ((packed)) hfa384x_usb_rridresp_t; 839 840 typedef hfa384x_usb_cmdresp_t hfa384x_usb_wmemresp_t; 841 842 typedef struct hfa384x_usb_rmemresp { 843 u16 type; 844 u16 frmlen; 845 u8 data[HFA384x_USB_RWMEM_MAXLEN]; 846 } __attribute__ ((packed)) hfa384x_usb_rmemresp_t; 847 848 typedef struct hfa384x_usb_bufavail { 849 u16 type; 850 u16 frmlen; 851 } __attribute__ ((packed)) hfa384x_usb_bufavail_t; 852 853 typedef struct hfa384x_usb_error { 854 u16 type; 855 u16 errortype; 856 } __attribute__ ((packed)) hfa384x_usb_error_t; 857 858 /*----------------------------------------------------------*/ 859 /* Unions for packaging all the known packet types together */ 860 861 typedef union hfa384x_usbout { 862 u16 type; 863 hfa384x_usb_txfrm_t txfrm; 864 hfa384x_usb_cmdreq_t cmdreq; 865 hfa384x_usb_wridreq_t wridreq; 866 hfa384x_usb_rridreq_t rridreq; 867 hfa384x_usb_wmemreq_t wmemreq; 868 hfa384x_usb_rmemreq_t rmemreq; 869 } __attribute__ ((packed)) hfa384x_usbout_t; 870 871 typedef union hfa384x_usbin { 872 u16 type; 873 hfa384x_usb_rxfrm_t rxfrm; 874 hfa384x_usb_txfrm_t txfrm; 875 hfa384x_usb_infofrm_t infofrm; 876 hfa384x_usb_cmdresp_t cmdresp; 877 hfa384x_usb_wridresp_t wridresp; 878 hfa384x_usb_rridresp_t rridresp; 879 hfa384x_usb_wmemresp_t wmemresp; 880 hfa384x_usb_rmemresp_t rmemresp; 881 hfa384x_usb_bufavail_t bufavail; 882 hfa384x_usb_error_t usberror; 883 u8 boguspad[3000]; 884 } __attribute__ ((packed)) hfa384x_usbin_t; 885 886 /*-------------------------------------------------------------------- 887 PD record structures. 888 --------------------------------------------------------------------*/ 889 890 typedef struct hfa384x_pdr_pcb_partnum { 891 u8 num[8]; 892 } __attribute__ ((packed)) hfa384x_pdr_pcb_partnum_t; 893 894 typedef struct hfa384x_pdr_pcb_tracenum { 895 u8 num[8]; 896 } __attribute__ ((packed)) hfa384x_pdr_pcb_tracenum_t; 897 898 typedef struct hfa384x_pdr_nic_serial { 899 u8 num[12]; 900 } __attribute__ ((packed)) hfa384x_pdr_nic_serial_t; 901 902 typedef struct hfa384x_pdr_mkk_measurements { 903 double carrier_freq; 904 double occupied_band; 905 double power_density; 906 double tx_spur_f1; 907 double tx_spur_f2; 908 double tx_spur_f3; 909 double tx_spur_f4; 910 double tx_spur_l1; 911 double tx_spur_l2; 912 double tx_spur_l3; 913 double tx_spur_l4; 914 double rx_spur_f1; 915 double rx_spur_f2; 916 double rx_spur_l1; 917 double rx_spur_l2; 918 } __attribute__ ((packed)) hfa384x_pdr_mkk_measurements_t; 919 920 typedef struct hfa384x_pdr_nic_ramsize { 921 u8 size[12]; /* units of KB */ 922 } __attribute__ ((packed)) hfa384x_pdr_nic_ramsize_t; 923 924 typedef struct hfa384x_pdr_mfisuprange { 925 u16 id; 926 u16 variant; 927 u16 bottom; 928 u16 top; 929 } __attribute__ ((packed)) hfa384x_pdr_mfisuprange_t; 930 931 typedef struct hfa384x_pdr_cfisuprange { 932 u16 id; 933 u16 variant; 934 u16 bottom; 935 u16 top; 936 } __attribute__ ((packed)) hfa384x_pdr_cfisuprange_t; 937 938 typedef struct hfa384x_pdr_nicid { 939 u16 id; 940 u16 variant; 941 u16 major; 942 u16 minor; 943 } __attribute__ ((packed)) hfa384x_pdr_nicid_t; 944 945 typedef struct hfa384x_pdr_refdac_measurements { 946 u16 value[0]; 947 } __attribute__ ((packed)) hfa384x_pdr_refdac_measurements_t; 948 949 typedef struct hfa384x_pdr_vgdac_measurements { 950 u16 value[0]; 951 } __attribute__ ((packed)) hfa384x_pdr_vgdac_measurements_t; 952 953 typedef struct hfa384x_pdr_level_comp_measurements { 954 u16 value[0]; 955 } __attribute__ ((packed)) hfa384x_pdr_level_compc_measurements_t; 956 957 typedef struct hfa384x_pdr_mac_address { 958 u8 addr[6]; 959 } __attribute__ ((packed)) hfa384x_pdr_mac_address_t; 960 961 typedef struct hfa384x_pdr_mkk_callname { 962 u8 callname[8]; 963 } __attribute__ ((packed)) hfa384x_pdr_mkk_callname_t; 964 965 typedef struct hfa384x_pdr_regdomain { 966 u16 numdomains; 967 u16 domain[5]; 968 } __attribute__ ((packed)) hfa384x_pdr_regdomain_t; 969 970 typedef struct hfa384x_pdr_allowed_channel { 971 u16 ch_bitmap; 972 } __attribute__ ((packed)) hfa384x_pdr_allowed_channel_t; 973 974 typedef struct hfa384x_pdr_default_channel { 975 u16 channel; 976 } __attribute__ ((packed)) hfa384x_pdr_default_channel_t; 977 978 typedef struct hfa384x_pdr_privacy_option { 979 u16 available; 980 } __attribute__ ((packed)) hfa384x_pdr_privacy_option_t; 981 982 typedef struct hfa384x_pdr_temptype { 983 u16 type; 984 } __attribute__ ((packed)) hfa384x_pdr_temptype_t; 985 986 typedef struct hfa384x_pdr_refdac_setup { 987 u16 ch_value[14]; 988 } __attribute__ ((packed)) hfa384x_pdr_refdac_setup_t; 989 990 typedef struct hfa384x_pdr_vgdac_setup { 991 u16 ch_value[14]; 992 } __attribute__ ((packed)) hfa384x_pdr_vgdac_setup_t; 993 994 typedef struct hfa384x_pdr_level_comp_setup { 995 u16 ch_value[14]; 996 } __attribute__ ((packed)) hfa384x_pdr_level_comp_setup_t; 997 998 typedef struct hfa384x_pdr_trimdac_setup { 999 u16 trimidac; 1000 u16 trimqdac; 1001 } __attribute__ ((packed)) hfa384x_pdr_trimdac_setup_t; 1002 1003 typedef struct hfa384x_pdr_ifr_setting { 1004 u16 value[3]; 1005 } __attribute__ ((packed)) hfa384x_pdr_ifr_setting_t; 1006 1007 typedef struct hfa384x_pdr_rfr_setting { 1008 u16 value[3]; 1009 } __attribute__ ((packed)) hfa384x_pdr_rfr_setting_t; 1010 1011 typedef struct hfa384x_pdr_hfa3861_baseline { 1012 u16 value[50]; 1013 } __attribute__ ((packed)) hfa384x_pdr_hfa3861_baseline_t; 1014 1015 typedef struct hfa384x_pdr_hfa3861_shadow { 1016 u32 value[32]; 1017 } __attribute__ ((packed)) hfa384x_pdr_hfa3861_shadow_t; 1018 1019 typedef struct hfa384x_pdr_hfa3861_ifrf { 1020 u32 value[20]; 1021 } __attribute__ ((packed)) hfa384x_pdr_hfa3861_ifrf_t; 1022 1023 typedef struct hfa384x_pdr_hfa3861_chcalsp { 1024 u16 value[14]; 1025 } __attribute__ ((packed)) hfa384x_pdr_hfa3861_chcalsp_t; 1026 1027 typedef struct hfa384x_pdr_hfa3861_chcali { 1028 u16 value[17]; 1029 } __attribute__ ((packed)) hfa384x_pdr_hfa3861_chcali_t; 1030 1031 typedef struct hfa384x_pdr_hfa3861_nic_config { 1032 u16 config_bitmap; 1033 } __attribute__ ((packed)) hfa384x_pdr_nic_config_t; 1034 1035 typedef struct hfa384x_pdr_hfo_delay { 1036 u8 hfo_delay; 1037 } __attribute__ ((packed)) hfa384x_hfo_delay_t; 1038 1039 typedef struct hfa384x_pdr_hfa3861_manf_testsp { 1040 u16 value[30]; 1041 } __attribute__ ((packed)) hfa384x_pdr_hfa3861_manf_testsp_t; 1042 1043 typedef struct hfa384x_pdr_hfa3861_manf_testi { 1044 u16 value[30]; 1045 } __attribute__ ((packed)) hfa384x_pdr_hfa3861_manf_testi_t; 1046 1047 typedef struct hfa384x_end_of_pda { 1048 u16 crc; 1049 } __attribute__ ((packed)) hfa384x_pdr_end_of_pda_t; 1050 1051 typedef struct hfa384x_pdrec { 1052 u16 len; /* in words */ 1053 u16 code; 1054 union pdr { 1055 hfa384x_pdr_pcb_partnum_t pcb_partnum; 1056 hfa384x_pdr_pcb_tracenum_t pcb_tracenum; 1057 hfa384x_pdr_nic_serial_t nic_serial; 1058 hfa384x_pdr_mkk_measurements_t mkk_measurements; 1059 hfa384x_pdr_nic_ramsize_t nic_ramsize; 1060 hfa384x_pdr_mfisuprange_t mfisuprange; 1061 hfa384x_pdr_cfisuprange_t cfisuprange; 1062 hfa384x_pdr_nicid_t nicid; 1063 hfa384x_pdr_refdac_measurements_t refdac_measurements; 1064 hfa384x_pdr_vgdac_measurements_t vgdac_measurements; 1065 hfa384x_pdr_level_compc_measurements_t level_compc_measurements; 1066 hfa384x_pdr_mac_address_t mac_address; 1067 hfa384x_pdr_mkk_callname_t mkk_callname; 1068 hfa384x_pdr_regdomain_t regdomain; 1069 hfa384x_pdr_allowed_channel_t allowed_channel; 1070 hfa384x_pdr_default_channel_t default_channel; 1071 hfa384x_pdr_privacy_option_t privacy_option; 1072 hfa384x_pdr_temptype_t temptype; 1073 hfa384x_pdr_refdac_setup_t refdac_setup; 1074 hfa384x_pdr_vgdac_setup_t vgdac_setup; 1075 hfa384x_pdr_level_comp_setup_t level_comp_setup; 1076 hfa384x_pdr_trimdac_setup_t trimdac_setup; 1077 hfa384x_pdr_ifr_setting_t ifr_setting; 1078 hfa384x_pdr_rfr_setting_t rfr_setting; 1079 hfa384x_pdr_hfa3861_baseline_t hfa3861_baseline; 1080 hfa384x_pdr_hfa3861_shadow_t hfa3861_shadow; 1081 hfa384x_pdr_hfa3861_ifrf_t hfa3861_ifrf; 1082 hfa384x_pdr_hfa3861_chcalsp_t hfa3861_chcalsp; 1083 hfa384x_pdr_hfa3861_chcali_t hfa3861_chcali; 1084 hfa384x_pdr_nic_config_t nic_config; 1085 hfa384x_hfo_delay_t hfo_delay; 1086 hfa384x_pdr_hfa3861_manf_testsp_t hfa3861_manf_testsp; 1087 hfa384x_pdr_hfa3861_manf_testi_t hfa3861_manf_testi; 1088 hfa384x_pdr_end_of_pda_t end_of_pda; 1089 1090 } data; 1091 } __attribute__ ((packed)) hfa384x_pdrec_t; 1092 1093 #ifdef __KERNEL__ 1094 /*-------------------------------------------------------------------- 1095 --- MAC state structure, argument to all functions -- 1096 --- Also, a collection of support types -- 1097 --------------------------------------------------------------------*/ 1098 typedef struct hfa384x_statusresult { 1099 u16 status; 1100 u16 resp0; 1101 u16 resp1; 1102 u16 resp2; 1103 } hfa384x_cmdresult_t; 1104 1105 /* USB Control Exchange (CTLX): 1106 * A queue of the structure below is maintained for all of the 1107 * Request/Response type USB packets supported by Prism2. 1108 */ 1109 /* The following hfa384x_* structures are arguments to 1110 * the usercb() for the different CTLX types. 1111 */ 1112 typedef struct hfa384x_rridresult { 1113 u16 rid; 1114 const void *riddata; 1115 unsigned int riddata_len; 1116 } hfa384x_rridresult_t; 1117 1118 enum ctlx_state { 1119 CTLX_START = 0, /* Start state, not queued */ 1120 1121 CTLX_COMPLETE, /* CTLX successfully completed */ 1122 CTLX_REQ_FAILED, /* OUT URB completed w/ error */ 1123 1124 CTLX_PENDING, /* Queued, data valid */ 1125 CTLX_REQ_SUBMITTED, /* OUT URB submitted */ 1126 CTLX_REQ_COMPLETE, /* OUT URB complete */ 1127 CTLX_RESP_COMPLETE /* IN URB received */ 1128 }; 1129 typedef enum ctlx_state CTLX_STATE; 1130 1131 struct hfa384x_usbctlx; 1132 struct hfa384x; 1133 1134 typedef void (*ctlx_cmdcb_t) (struct hfa384x *, const struct hfa384x_usbctlx *); 1135 1136 typedef void (*ctlx_usercb_t) (struct hfa384x *hw, 1137 void *ctlxresult, void *usercb_data); 1138 1139 typedef struct hfa384x_usbctlx { 1140 struct list_head list; 1141 1142 size_t outbufsize; 1143 hfa384x_usbout_t outbuf; /* pkt buf for OUT */ 1144 hfa384x_usbin_t inbuf; /* pkt buf for IN(a copy) */ 1145 1146 CTLX_STATE state; /* Tracks running state */ 1147 1148 struct completion done; 1149 volatile int reapable; /* Food for the reaper task */ 1150 1151 ctlx_cmdcb_t cmdcb; /* Async command callback */ 1152 ctlx_usercb_t usercb; /* Async user callback, */ 1153 void *usercb_data; /* at CTLX completion */ 1154 1155 int variant; /* Identifies cmd variant */ 1156 } hfa384x_usbctlx_t; 1157 1158 typedef struct hfa384x_usbctlxq { 1159 spinlock_t lock; 1160 struct list_head pending; 1161 struct list_head active; 1162 struct list_head completing; 1163 struct list_head reapable; 1164 } hfa384x_usbctlxq_t; 1165 1166 typedef struct hfa484x_metacmd { 1167 u16 cmd; 1168 1169 u16 parm0; 1170 u16 parm1; 1171 u16 parm2; 1172 1173 hfa384x_cmdresult_t result; 1174 } hfa384x_metacmd_t; 1175 1176 #define MAX_GRP_ADDR 32 1177 #define WLAN_COMMENT_MAX 80 /* Max. length of user comment string. */ 1178 1179 #define WLAN_AUTH_MAX 60 /* Max. # of authenticated stations. */ 1180 #define WLAN_ACCESS_MAX 60 /* Max. # of stations in an access list. */ 1181 #define WLAN_ACCESS_NONE 0 /* No stations may be authenticated. */ 1182 #define WLAN_ACCESS_ALL 1 /* All stations may be authenticated. */ 1183 #define WLAN_ACCESS_ALLOW 2 /* Authenticate only "allowed" stations. */ 1184 #define WLAN_ACCESS_DENY 3 /* Do not authenticate "denied" stations. */ 1185 1186 /* XXX These are going away ASAP */ 1187 typedef struct prism2sta_authlist { 1188 unsigned int cnt; 1189 u8 addr[WLAN_AUTH_MAX][ETH_ALEN]; 1190 u8 assoc[WLAN_AUTH_MAX]; 1191 } prism2sta_authlist_t; 1192 1193 typedef struct prism2sta_accesslist { 1194 unsigned int modify; 1195 unsigned int cnt; 1196 u8 addr[WLAN_ACCESS_MAX][ETH_ALEN]; 1197 unsigned int cnt1; 1198 u8 addr1[WLAN_ACCESS_MAX][ETH_ALEN]; 1199 } prism2sta_accesslist_t; 1200 1201 typedef struct hfa384x { 1202 /* USB support data */ 1203 struct usb_device *usb; 1204 struct urb rx_urb; 1205 struct sk_buff *rx_urb_skb; 1206 struct urb tx_urb; 1207 struct urb ctlx_urb; 1208 hfa384x_usbout_t txbuff; 1209 hfa384x_usbctlxq_t ctlxq; 1210 struct timer_list reqtimer; 1211 struct timer_list resptimer; 1212 1213 struct timer_list throttle; 1214 1215 struct tasklet_struct reaper_bh; 1216 struct tasklet_struct completion_bh; 1217 1218 struct work_struct usb_work; 1219 1220 unsigned long usb_flags; 1221 #define THROTTLE_RX 0 1222 #define THROTTLE_TX 1 1223 #define WORK_RX_HALT 2 1224 #define WORK_TX_HALT 3 1225 #define WORK_RX_RESUME 4 1226 #define WORK_TX_RESUME 5 1227 1228 unsigned short req_timer_done:1; 1229 unsigned short resp_timer_done:1; 1230 1231 int endp_in; 1232 int endp_out; 1233 1234 int sniff_fcs; 1235 int sniff_channel; 1236 int sniff_truncate; 1237 int sniffhdr; 1238 1239 wait_queue_head_t cmdq; /* wait queue itself */ 1240 1241 /* Controller state */ 1242 u32 state; 1243 u32 isap; 1244 u8 port_enabled[HFA384x_NUMPORTS_MAX]; 1245 1246 /* Download support */ 1247 unsigned int dlstate; 1248 hfa384x_downloadbuffer_t bufinfo; 1249 u16 dltimeout; 1250 1251 int scanflag; /* to signal scan comlete */ 1252 int join_ap; /* are we joined to a specific ap */ 1253 int join_retries; /* number of join retries till we fail */ 1254 hfa384x_JoinRequest_data_t joinreq; /* join request saved data */ 1255 1256 wlandevice_t *wlandev; 1257 /* Timer to allow for the deferred processing of linkstatus messages */ 1258 struct work_struct link_bh; 1259 1260 struct work_struct commsqual_bh; 1261 hfa384x_commsquality_t qual; 1262 struct timer_list commsqual_timer; 1263 1264 u16 link_status; 1265 u16 link_status_new; 1266 struct sk_buff_head authq; 1267 1268 /* And here we have stuff that used to be in priv */ 1269 1270 /* State variables */ 1271 unsigned int presniff_port_type; 1272 u16 presniff_wepflags; 1273 u32 dot11_desired_bss_type; 1274 1275 int dbmadjust; 1276 1277 /* Group Addresses - right now, there are up to a total 1278 of MAX_GRP_ADDR group addresses */ 1279 u8 dot11_grp_addr[MAX_GRP_ADDR][ETH_ALEN]; 1280 unsigned int dot11_grpcnt; 1281 1282 /* Component Identities */ 1283 hfa384x_compident_t ident_nic; 1284 hfa384x_compident_t ident_pri_fw; 1285 hfa384x_compident_t ident_sta_fw; 1286 hfa384x_compident_t ident_ap_fw; 1287 u16 mm_mods; 1288 1289 /* Supplier compatibility ranges */ 1290 hfa384x_caplevel_t cap_sup_mfi; 1291 hfa384x_caplevel_t cap_sup_cfi; 1292 hfa384x_caplevel_t cap_sup_pri; 1293 hfa384x_caplevel_t cap_sup_sta; 1294 hfa384x_caplevel_t cap_sup_ap; 1295 1296 /* Actor compatibility ranges */ 1297 hfa384x_caplevel_t cap_act_pri_cfi; /* pri f/w to controller interface */ 1298 hfa384x_caplevel_t cap_act_sta_cfi; /* sta f/w to controller interface */ 1299 hfa384x_caplevel_t cap_act_sta_mfi; /* sta f/w to modem interface */ 1300 hfa384x_caplevel_t cap_act_ap_cfi; /* ap f/w to controller interface */ 1301 hfa384x_caplevel_t cap_act_ap_mfi; /* ap f/w to modem interface */ 1302 1303 u32 psusercount; /* Power save user count. */ 1304 hfa384x_CommTallies32_t tallies; /* Communication tallies. */ 1305 u8 comment[WLAN_COMMENT_MAX + 1]; /* User comment */ 1306 1307 /* Channel Info request results (AP only) */ 1308 struct { 1309 atomic_t done; 1310 u8 count; 1311 hfa384x_ChInfoResult_t results; 1312 } channel_info; 1313 1314 hfa384x_InfFrame_t *scanresults; 1315 1316 prism2sta_authlist_t authlist; /* Authenticated station list. */ 1317 unsigned int accessmode; /* Access mode. */ 1318 prism2sta_accesslist_t allow; /* Allowed station list. */ 1319 prism2sta_accesslist_t deny; /* Denied station list. */ 1320 1321 } hfa384x_t; 1322 1323 void hfa384x_create(hfa384x_t *hw, struct usb_device *usb); 1324 void hfa384x_destroy(hfa384x_t *hw); 1325 1326 int 1327 hfa384x_corereset(hfa384x_t *hw, int holdtime, int settletime, int genesis); 1328 int hfa384x_drvr_commtallies(hfa384x_t *hw); 1329 int hfa384x_drvr_disable(hfa384x_t *hw, u16 macport); 1330 int hfa384x_drvr_enable(hfa384x_t *hw, u16 macport); 1331 int hfa384x_drvr_flashdl_enable(hfa384x_t *hw); 1332 int hfa384x_drvr_flashdl_disable(hfa384x_t *hw); 1333 int hfa384x_drvr_flashdl_write(hfa384x_t *hw, u32 daddr, void *buf, u32 len); 1334 int hfa384x_drvr_getconfig(hfa384x_t *hw, u16 rid, void *buf, u16 len); 1335 int hfa384x_drvr_ramdl_enable(hfa384x_t *hw, u32 exeaddr); 1336 int hfa384x_drvr_ramdl_disable(hfa384x_t *hw); 1337 int hfa384x_drvr_ramdl_write(hfa384x_t *hw, u32 daddr, void *buf, u32 len); 1338 int hfa384x_drvr_readpda(hfa384x_t *hw, void *buf, unsigned int len); 1339 int hfa384x_drvr_setconfig(hfa384x_t *hw, u16 rid, void *buf, u16 len); 1340 1341 static inline int hfa384x_drvr_getconfig16(hfa384x_t *hw, u16 rid, void *val) 1342 { 1343 int result = 0; 1344 result = hfa384x_drvr_getconfig(hw, rid, val, sizeof(u16)); 1345 if (result == 0) 1346 *((u16 *) val) = le16_to_cpu(*((u16 *) val)); 1347 return result; 1348 } 1349 1350 static inline int hfa384x_drvr_setconfig16(hfa384x_t *hw, u16 rid, u16 val) 1351 { 1352 u16 value = cpu_to_le16(val); 1353 return hfa384x_drvr_setconfig(hw, rid, &value, sizeof(value)); 1354 } 1355 1356 int 1357 hfa384x_drvr_getconfig_async(hfa384x_t *hw, 1358 u16 rid, ctlx_usercb_t usercb, void *usercb_data); 1359 1360 int 1361 hfa384x_drvr_setconfig_async(hfa384x_t *hw, 1362 u16 rid, 1363 void *buf, 1364 u16 len, ctlx_usercb_t usercb, void *usercb_data); 1365 1366 static inline int 1367 hfa384x_drvr_setconfig16_async(hfa384x_t *hw, u16 rid, u16 val) 1368 { 1369 u16 value = cpu_to_le16(val); 1370 return hfa384x_drvr_setconfig_async(hw, rid, &value, sizeof(value), 1371 NULL, NULL); 1372 } 1373 1374 int hfa384x_drvr_start(hfa384x_t *hw); 1375 int hfa384x_drvr_stop(hfa384x_t *hw); 1376 int 1377 hfa384x_drvr_txframe(hfa384x_t *hw, struct sk_buff *skb, 1378 p80211_hdr_t *p80211_hdr, p80211_metawep_t *p80211_wep); 1379 void hfa384x_tx_timeout(wlandevice_t *wlandev); 1380 1381 int hfa384x_cmd_initialize(hfa384x_t *hw); 1382 int hfa384x_cmd_enable(hfa384x_t *hw, u16 macport); 1383 int hfa384x_cmd_disable(hfa384x_t *hw, u16 macport); 1384 int hfa384x_cmd_allocate(hfa384x_t *hw, u16 len); 1385 int hfa384x_cmd_monitor(hfa384x_t *hw, u16 enable); 1386 int 1387 hfa384x_cmd_download(hfa384x_t *hw, 1388 u16 mode, u16 lowaddr, u16 highaddr, u16 codelen); 1389 1390 #endif /* __KERNEL__ */ 1391 1392 #endif /* _HFA384x_H */ 1393