/* * Copyright (c) 2003 * Daan Vreeken . All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * 3. All advertising materials mentioning features or use of this software * must display the following acknowledgement: * This product includes software developed by Daan Vreeken. * 4. Neither the name of the author nor the names of any co-contributors * may be used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY Daan Vreeken AND CONTRIBUTORS ``AS IS'' AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL Daan Vreeken OR THE VOICES IN HIS HEAD * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF * THE POSSIBILITY OF SUCH DAMAGE. * */ /************ driver options ************/ /* * If you want to disable Intersil or RFMD support in the driver, uncomment * one of the following line. This will make the driver about 30 KB smaller * since the firmware-images will be left out. (Yes, leaving both out saves * 60KB, but that leaves you with a driver that doesn't support any devices :) */ /* #define ATUWI_NO_INTERSIL */ /* #define ATUWI_NO_RFMD */ /* debug flags used in the driver - don't change */ #define FLAG_COMMANDS 0x00001 /* Atmel USB commands */ #define FLAG_BEACONS 0x00002 /* reception of beacons */ #define FLAG_BEACONSFULL 0x00004 /* verbose */ #define FLAG_SIGNAL 0x00008 /* signal strength of packets */ #define FLAG_TX 0x00010 /* transmittion of packets */ #define FLAG_RX 0x00020 /* reception of packets */ #define FLAG_RXFULL 0x00040 /* verbose */ #define FLAG_MGMT 0x00080 /* managment packets */ #define FLAG_MGMTFULL 0x00100 /* verbose */ #define FLAG_STATE 0x00200 /* scan/join/auth/assoc state */ #define FLAG_INIT 0x00400 /* device initialisation / tear down */ #define FLAG_FW 0x00800 /* firmware loader */ #define FLAG_FWFULL 0x01000 /* verbose */ #define FLAG_IOCTL 0x02000 /* ioctls */ #define FLAG_BPF 0x04000 /* bpf */ #define FLAG_ALL 0x07fff /* all of the above */ /* * The following is the default level of debug verbosity of the driver after * loading it. This value can be changed afterwards by setting sysctl : * hw.atuwi.debug * * Executing the following command will make the driver only show * sysctl -w hw.atuwi.debug=0x200 */ #define ATUWI_INITIAL_DEBUG_LEVEL (FLAG_INIT | FLAG_FW | FLAG_STATE) /* * Uncomment this if you want to debug usb requests made by the driver. * (Hold on to your seatbelts, this will generatee LOTS of text) * * When enabled a new sysctl 'hw.atuwi.debug_usb' will appear. By setting * it to 1 or 0 you can enable USB debug messages. */ /* #define ATUWI_DEBUG_USB */ /************ various performance optimizations ************/ /* * setting ATUWI_NO_OPTIMIZATIONS will set all further options to default * values... * * no optimizations 392.78 KB/sec * with optimizations 485.64 KB/sec * (+/- 23.6% increase) * * Disclaimer : Most speed tests were done by transferring a large file over * FTP with an MTU of 1500. The tests are done on slow (Pentium-133) machines * so small changes in driver-overhead would be easilly noticeable. These * numbers are different for every other PC, I have just put them here to show * in what order of magnitude the differences are. */ /* #define ATUWI_NO_OPTIMIZATIONS */ /* the number of simultaniuously requested RX transfers */ #define ATUWI_RX_LIST_CNT 1 /* * the number of simultaniously started TX transfers * my measurements : * 1 430.82 KB/sec * 2 534.66 KB/sec * 3 536.23 KB/sec * 4 537.80 KB/sec * 6 537.30 KB/sec * 8 535.31 KB/sec * 16 535.68 KB/sec * 128 535.67 KB/sec (before you ask : yes, 128 is silly :) * (+/- 24% increase) */ #define ATUWI_TX_LIST_CNT 8 /* number of simultaniously MGMT TX transfers (always 1, don't change) */ #define ATUWI_MGMT_LIST_CNT 1 /* * save a memcpy on TX by directly constructing packets into a self-allocated * DMA buffer. (normally usbd allocates them and memcpy's data in on transfer) * * measurements : * off 507.50 KB/sec * on 530.14 KB/sec * (+/- 4.5% increase) */ #define ATUWI_NO_COPY_TX /* * Normally, when a packet arrives at the driver (with a call to atuwi_start) * we start up a USB transfer and transfer the packet to the adapter. Then * atuwi_txeof gets called on interrupt and we hand over the mbuf to * usb_tx_done. usb_tx_done will queue the mbuf and schedules a net-isr. * After the interrupt the scheduler will call the net-isr. There the mbuf * is free'd and atuwi_start is called (if there are packets on the TX queue). * This means that on average 2 task-switches are performed for every single * packet we transmit. * If we simply NOT call usb_tx_done when a single transfer is done, but wait * for the other transfers we started simultaneously to complete, we can save * the overhead of the extra task-switching. * * measurements : * off 465.55 KB/sec * on 487.57 KB/sec * (+/- 4.7% increase) */ #define ATUWI_LAZY_TX_NETISR /* * Minimum number of simultaneous transfers before we start being lazy. * Setting this to 0 will make us so lazy we could keep mbuf's around forever * (which you do not want) */ #define ATUWI_LAZY_TX_MIN 1 /* * Maximum number of queued mbufs before we call usb_tx_done (should never * be higher than ATUWI_TX_LIST_CNT) */ #define ATUWI_LAZY_TX_MAX 8 /* * Whether or not we padd usb packets transfered to the adapter. looking at * drivers on other platforms there seems to be something magic about the * padding. * my measurements : * on - 532.55 KB/sec * off - 536.74 KB/sec * I don't see the reason why we should padd bytes here. The adapter seems * to be transmitting packets just fine without the padding. So the default is * to have no padding, but it's at least supplied as an option. This seems to * be necessary with newer firmware versions, but I haven't tested that yet. */ /* #define ATUWI_TX_PADDING */ /* * ATUWI_PROFILING isn't a real optimization. it adds s bunch of sysctl * variables that count the number of function calls and data transfers we * make. with some shell scripts around it you can easilly measure the * performance of the driver and see where bottlenecks might be. */ /* #define ATUWI_PROFILING */ /**** NO user configurable options beyond this point ****/ #ifdef ATUWI_NO_OPTIMIZATIONS #undef ATUWI_LAZY_TX_NETISR #undef ATUWI_TX_PADDING #undef ATUWI_NO_COPY_TX #undef ATUWI_TX_LIST_CNT #define ATUWI_TX_LIST_CNT 1 #undef ATUWI_RX_LIST_CNT #define ATUWI_RX_LIST_CNT 1 #endif /* * TODO - should make this a reasonable number... :) * it's more than 1536 (802.11 & atmel header), but 2000 is too much */ /* #define ATUWI_BUFSZ 1536 */ /* BE CAREFULL! don't forget to add ATUWI_TX_PADDING */ #define ATUWI_BUFSZ 2000 #define ATUWI_MGMT_BUFSZ 200 #define ATUWI_MIN_FRAMELEN 60 #define ATUWI_ENDPT_RX 0x0 #define ATUWI_ENDPT_TX 0x1 #define ATUWI_ENDPT_MAX 0x2 #define ATUWI_TX_TIMEOUT 10000 #define ATUWI_JOIN_TIMEOUT 2000 #define ATUWI_MGMT_INTERVAL 1000 * hz / 1000 #define ATUWI_SCAN_RETRIES 2 #define ATUWI_JOIN_RETRIES 1 #define ATUWI_AUTH_RETRIES 3 #define ATUWI_ASSOC_RETRIES 3 #define ATUWI_IBSS_RETRIES 0 enum atuwi_radio_type { RadioRFMD = 0, RadioIntersil }; struct atuwi_type { u_int16_t atuwi_vid; u_int16_t atuwi_pid; enum atuwi_radio_type atuwi_radio; }; struct atuwi_softc; struct atuwi_chain { struct atuwi_softc *atuwi_sc; usbd_xfer_handle atuwi_xfer; char *atuwi_buf; struct mbuf *atuwi_mbuf; u_int8_t atuwi_idx; u_int16_t atuwi_length; #ifdef ATUWI_LAZY_TX_NETISR u_int8_t atuwi_not_freed; #endif /* ATUWI_LAZY_TX_NETISR */ SLIST_ENTRY(atuwi_chain) atuwi_list; }; struct atuwi_cdata { struct atuwi_chain atuwi_tx_chain[ATUWI_TX_LIST_CNT]; struct atuwi_chain atuwi_rx_chain[ATUWI_RX_LIST_CNT]; struct atuwi_chain atuwi_mgmt_chain[ATUWI_MGMT_LIST_CNT]; SLIST_HEAD(atuwi_list_head, atuwi_chain); struct atuwi_list_head atuwi_rx_free; struct atuwi_list_head atuwi_tx_free; struct atuwi_list_head atuwi_mgmt_free; u_int8_t atuwi_tx_inuse; u_int8_t atuwi_tx_last_idx; }; #define MAX_SSID_LEN 32 #define ATUWI_AVG_TIME 20 enum atuwi_mgmt_state { STATE_NONE = 0, STATE_LISTENING, STATE_JOINING, STATE_AUTHENTICATING, /* infra mode */ STATE_ASSOCIATING, STATE_CREATING_IBSS, /* adhoc mode */ STATE_HAPPY_NETWORKING, STATE_GIVEN_UP }; u_int8_t *atuwi_mgmt_statename[] = {"NONE", "LISTENING", "JOINING", "AUTHENTICATING", "ASSOCIATING", "CREATING IBSS", "HAPPY NETWORKING :)", "GIVEN UP"}; struct atuwi_mgmt { enum atuwi_mgmt_state state; int retry; }; struct atuwi_softc { struct arpcom arpcom; usbd_device_handle atuwi_udev; usbd_interface_handle atuwi_iface; struct ifmedia atuwi_media; int atuwi_ed[ATUWI_ENDPT_MAX]; usbd_pipe_handle atuwi_ep[ATUWI_ENDPT_MAX]; int atuwi_unit; int atuwi_if_flags; struct atuwi_cdata atuwi_cdata; #ifdef ATUWI_LAZY_TX_NETISR int atuwi_lazy_tx_cnt; /* struct mbuf *atuwi_lazy_tx_list[ATUWI_LAZY_TX_MAX]; */ #endif /* ATUWI_LAZY_TX_NETISR */ struct mtx atuwi_mtx; char atuwi_dying; struct timeval atuwi_rx_notice; struct usb_qdat atuwi_qdat; struct bpf_if *atuwi_rawbpf; u_int8_t atuwi_mac_addr[ETHER_ADDR_LEN]; u_int8_t atuwi_bssid[ETHER_ADDR_LEN]; enum atuwi_radio_type atuwi_radio; /* used for debug : FLAG_SIGNAL */ u_int8_t atuwi_signalarr[ATUWI_AVG_TIME]; u_int8_t atuwi_signalptr; u_int16_t atuwi_signaltotal; u_int8_t atuwi_ssid[MAX_SSID_LEN]; u_int8_t atuwi_ssidlen; u_int8_t atuwi_channel; u_int8_t atuwi_mode; u_int8_t atuwi_radio_on; u_int8_t atuwi_encrypt; #define ATUWI_WEP_RX 0x01 #define ATUWI_WEP_TX 0x02 #define ATUWI_WEP_TXRX (0x01 | 0x02) int atuwi_wepkey; int atuwi_wepkeylen; u_int8_t atuwi_wepkeys[4][13]; struct proc *atuwi_mgmt_thread; struct atuwi_mgmt atuwi_mgmt_vars; int atuwi_mgmt_flags; #define ATUWI_TASK_RUNNING 0x01 #define ATUWI_CHANGED_SETTINGS 0x02 #define ATUWI_SEARCHING 0x04 #define ATUWI_FOUND_BSSID 0x08 #define ATUWI_AUTH_OK 0x10 #define ATUWI_ASSOC_OK 0x20 #define ATUWI_NETWORK_OK 0x40 }; /* Commands for uploading the firmware (standard DFU interface) */ #define DFU_DNLOAD UT_WRITE_CLASS_INTERFACE, 0x01 #define DFU_GETSTATUS UT_READ_CLASS_INTERFACE, 0x03 #define DFU_GETSTATE UT_READ_CLASS_INTERFACE, 0x05 #define DFU_REMAP UT_WRITE_VENDOR_INTERFACE, 0x0a /* DFU states */ #define DFUState_AppIdle 0 #define DFUState_AppDetach 1 #define DFUState_DFUIdle 2 #define DFUState_DnLoadSync 3 #define DFUState_DnLoadBusy 4 #define DFUState_DnLoadIdle 5 #define DFUState_ManifestSync 6 #define DFUState_Manifest 7 #define DFUState_ManifestWait 8 #define DFUState_UploadIdle 9 #define DFUState_DFUError 10 #define DFU_MaxBlockSize 1024 /* AT76c503 operating modes */ #define MODE_NONE 0x00 #define MODE_NETCARD 0x01 #define MODE_CONFIG 0x02 #define MODE_DFU 0x03 #define MODE_NOFLASHNETCARD 0x04 /* AT76c503 commands */ #define CMD_SET_MIB 0x01 #define CMD_START_SCAN 0x03 #define CMD_JOIN 0x04 #define CMD_START_IBSS 0x05 #define CMD_RADIO 0x06 #define CMD_RADIO_ON 0x06 #define CMD_RADIO_OFF 0x07 #define CMD_STARTUP 0x0b /* AT76c503 status messages - used in atuwi_wait_completion */ #define STATUS_IDLE 0x00 #define STATUS_COMPLETE 0x01 #define STATUS_UNKNOWN 0x02 #define STATUS_INVALID_PARAMETER 0x03 #define STATUS_FUNCTION_NOT_SUPPORTED 0x04 #define STATUS_TIME_OUT 0x07 #define STATUS_IN_PROGRESS 0x08 #define STATUS_HOST_FAILURE 0xff #define STATUS_SCAN_FAILED 0xf0 /* AT76c503 command header */ struct atuwi_cmd { u_int8_t Cmd; u_int8_t Reserved; u_int16_t Size; }; /* CMD_STARTUP command (0x0b) */ struct atuwi_cmd_card_config { u_int8_t Cmd; u_int8_t Reserved; u_int16_t Size; u_int8_t ExcludeUnencrypted; u_int8_t PromiscuousMode; u_int8_t ShortRetryLimit; u_int8_t EncryptionType; u_int16_t RTS_Threshold; u_int16_t FragThreshold; /* 256 .. 2346 */ u_int8_t BasicRateSet[4]; u_int8_t AutoRateFallback; u_int8_t Channel; u_int8_t PrivacyInvoked; /* wep */ u_int8_t WEP_DefaultKeyID; /* 0 .. 3 */ u_int8_t SSID[MAX_SSID_LEN]; u_int8_t WEP_DefaultKey[4][13]; u_int8_t SSID_Len; u_int8_t ShortPreamble; u_int16_t BeaconPeriod; }; /* CMD_SCAN command (0x03) */ struct atuwi_cmd_do_scan { u_int8_t Cmd; u_int8_t Reserved; u_int16_t Size; u_int8_t BSSID[6]; u_int8_t SSID[MAX_SSID_LEN]; u_int8_t ScanType; u_int8_t Channel; u_int16_t ProbeDelay; u_int16_t MinChannelTime; u_int16_t MaxChannelTime; u_int8_t SSID_Len; u_int8_t InternationalScan; }; #define ATUWI_SCAN_ACTIVE 0x00 #define ATUWI_SCAN_PASSIVE 0x01 /* CMD_JOIN command (0x04) */ struct atuwi_cmd_join { u_int8_t Cmd; u_int8_t Reserved; u_int16_t Size; u_int8_t bssid[6]; u_int8_t essid[32]; u_int8_t bss_type; u_int8_t channel; u_int16_t timeout; u_int8_t essid_size; u_int8_t reserved; }; /* * The At76c503 adapters come with different types of radios on them. * At this moment the driver supports adapters with RFMD and Intersil * radios. */ /* The config structure of an RFMD radio */ struct atuwi_rfmd_conf { u_int8_t CR20[14]; u_int8_t CR21[14]; u_int8_t BB_CR[14]; u_int8_t PidVid[4]; u_int8_t MACAddr[6]; u_int8_t RegulatoryDomain; u_int8_t LowPowerValues[14]; u_int8_t NormalPowerValues[14]; u_int8_t Reserved[3]; /* then we have 84 bytes, somehow Windows reads 95?? */ u_int8_t Rest[11]; }; /* The config structure of an Intersil radio */ struct atuwi_intersil_conf { u_int8_t MACAddr[6]; /* From the HFA3861B manual : */ u_int8_t CR31[14]; /* Manual TX power control (7bit : -64 to 63) */ u_int8_t CR58[14]; /* TX power measurement */ u_int8_t PidVid[4]; u_int8_t RegulatoryDomain; u_int8_t Reserved[1]; }; /* Firmware information request */ struct atuwi_fw { u_int8_t major; u_int8_t minor; u_int8_t patch; u_int8_t build; }; /* The header the AT76c503 puts in front of RX packets (for both managment & data) */ struct at76c503_rx_buffer { u_int16_t wlength; u_int8_t rx_rate; u_int8_t newbss; u_int8_t fragmentation; u_int8_t rssi; u_int8_t link_quality; u_int8_t noise_level; u_int8_t rx_time[4]; }; /* The total packet the AT76c503 spits out looks like this */ struct atuwi_rxpkt { struct at76c503_rx_buffer AtHeader; struct wi_80211_hdr WiHeader; u_int16_t EthType; /* TODO - change this to a more correct value */ u_int8_t Packet[2000]; }; /* The header we have to put in front of a TX packet before sending it to the AT76c503 */ struct at76c503_tx_buffer { u_int16_t wlength; u_int8_t tx_rate; u_int8_t padding; u_int8_t reserved[4]; }; /* The total packet we send to the AT76c503 looks like this */ struct atuwi_txpkt { struct at76c503_tx_buffer AtHeader; struct wi_80211_hdr WiHeader; /* TODO - change this to a more correct value */ u_int8_t Packet[2000]; }; struct wi_80211_beacon { u_int8_t timestamp[8]; u_int16_t interval; u_int16_t flags; u_int8_t data[1500]; }; struct tlv { u_int8_t type; u_int8_t length; u_int8_t value[255]; }; #define TYPE_MASK 0x000c #if 0 #define ATUWI_LOCK(_sc) mtx_lock(&(_sc)->atuwi_mtx) #define ATUWI_UNLOCK(_sc) mtx_unlock(&(_sc)->atuwi_mtx) #else #define ATUWI_LOCK(_sc) #define ATUWI_UNLOCK(_sc) #endif