NetBSD/sys/dev/pci/if_wpireg.h

569 lines
14 KiB
C

/* $NetBSD: if_wpireg.h,v 1.3 2007/01/13 09:39:06 degroote Exp $ */
/*-
* Copyright (c) 2006
* Damien Bergamini <damien.bergamini@free.fr>
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
#define WPI_TX_RING_COUNT 256
#define WPI_SVC_RING_COUNT 256
#define WPI_CMD_RING_COUNT 256
#define WPI_RX_RING_COUNT 64
#define WPI_BUF_ALIGN 4096
/*
* Rings must be aligned on a four 4K-pages boundary.
* I had a hard time figuring this out.
*/
#define WPI_RING_DMA_ALIGN 0x4000
/* maximum scatter/gather */
#define WPI_MAX_SCATTER 4
/* maximum Rx buffer size */
#define WPI_RBUF_SIZE (3 * 1024) /* XXX 3000 but must be aligned! */
/*
* Control and status registers.
*/
#define WPI_HWCONFIG 0x000
#define WPI_INTR 0x008
#define WPI_MASK 0x00c
#define WPI_INTR_STATUS 0x010
#define WPI_GPIO_STATUS 0x018
#define WPI_RESET 0x020
#define WPI_GPIO_CTL 0x024
#define WPI_EEPROM_CTL 0x02c
#define WPI_EEPROM_STATUS 0x030
#define WPI_UCODE_CLR 0x05c
#define WPI_TEMPERATURE 0x060
#define WPI_CHICKEN 0x100
#define WPI_PLL_CTL 0x20c
#define WPI_FW_TARGET 0x410
#define WPI_WRITE_MEM_ADDR 0x444
#define WPI_READ_MEM_ADDR 0x448
#define WPI_WRITE_MEM_DATA 0x44c
#define WPI_READ_MEM_DATA 0x450
#define WPI_TX_WIDX 0x460
#define WPI_TX_CTL(qid) (0x940 + (qid) * 8)
#define WPI_TX_BASE(qid) (0x944 + (qid) * 8)
#define WPI_TX_DESC(qid) (0x980 + (qid) * 80)
#define WPI_RX_CONFIG 0xc00
#define WPI_RX_BASE 0xc04
#define WPI_RX_WIDX 0xc20
#define WPI_RX_RIDX_PTR 0xc24
#define WPI_RX_CTL 0xcc0
#define WPI_RX_STATUS 0xcc4
#define WPI_TX_CONFIG(qid) (0xd00 + (qid) * 32)
#define WPI_TX_CREDIT(qid) (0xd04 + (qid) * 32)
#define WPI_TX_STATE(qid) (0xd08 + (qid) * 32)
#define WPI_TX_BASE_PTR 0xe80
#define WPI_MSG_CONFIG 0xe88
#define WPI_TX_STATUS 0xe90
/*
* NIC internal memory offsets.
*/
#define WPI_MEM_MODE 0x2e00
#define WPI_MEM_RA 0x2e04
#define WPI_MEM_TXCFG 0x2e10
#define WPI_MEM_MAGIC4 0x2e14
#define WPI_MEM_MAGIC5 0x2e20
#define WPI_MEM_BYPASS1 0x2e2c
#define WPI_MEM_BYPASS2 0x2e30
#define WPI_MEM_CLOCK1 0x3004
#define WPI_MEM_CLOCK2 0x3008
#define WPI_MEM_POWER 0x300c
#define WPI_MEM_PCIDEV 0x3010
#define WPI_MEM_UCODE_CTL 0x3400
#define WPI_MEM_UCODE_SRC 0x3404
#define WPI_MEM_UCODE_DST 0x3408
#define WPI_MEM_UCODE_SIZE 0x340c
#define WPI_MEM_UCODE_BASE 0x3800
/* possible flags for register WPI_HWCONFIG */
#define WPI_HW_ALM_MB (1 << 8)
#define WPI_HW_ALM_MM (1 << 9)
#define WPI_HW_SKU_MRC (1 << 10)
#define WPI_HW_REV_D (1 << 11)
#define WPI_HW_TYPE_B (1 << 12)
/* possible flags for registers WPI_READ_MEM_ADDR/WPI_WRITE_MEM_ADDR */
#define WPI_MEM_4 ((sizeof (uint32_t) - 1) << 24)
/* possible values for WPI_FW_TARGET */
#define WPI_FW_TEXT 0x00000000
#define WPI_FW_DATA 0x00800000
/* possible flags for WPI_GPIO_STATUS */
#define WPI_POWERED (1 << 9)
/* possible flags for register WPI_RESET */
#define WPI_NEVO_RESET (1 << 0)
#define WPI_SW_RESET (1 << 7)
#define WPI_MASTER_DISABLED (1 << 8)
#define WPI_STOP_MASTER (1 << 9)
/* possible flags for register WPI_GPIO_CTL */
#define WPI_GPIO_CLOCK (1 << 0)
#define WPI_GPIO_INIT (1 << 2)
#define WPI_GPIO_MAC (1 << 3)
#define WPI_GPIO_SLEEP (1 << 4)
#define WPI_GPIO_PWR_STATUS 0x07000000
#define WPI_GPIO_PWR_SLEEP (4 << 24)
/* possible flags for register WPI_CHICKEN */
#define WPI_CHICKEN_RXNOLOS (1 << 23)
/* possible flags for register WPI_PLL_CTL */
#define WPI_PLL_INIT (1 << 24)
/* possible flags for register WPI_UCODE_CLR */
#define WPI_RADIO_OFF (1 << 1)
#define WPI_DISABLE_CMD (1 << 2)
/* possible flags for WPI_RX_STATUS */
#define WPI_RX_IDLE (1 << 24)
/* possible flags for register WPI_UC_CTL */
#define WPI_UC_RUN (1 << 30)
/* possible flags for register WPI_INTR_CSR */
#define WPI_ALIVE_INTR (1 << 0)
#define WPI_WAKEUP_INTR (1 << 1)
#define WPI_SW_ERROR (1 << 25)
#define WPI_TX_INTR (1 << 27)
#define WPI_HW_ERROR (1 << 29)
#define WPI_RX_INTR (1 << 31)
#define WPI_INTR_MASK \
(WPI_SW_ERROR | WPI_HW_ERROR | WPI_TX_INTR | WPI_RX_INTR | \
WPI_ALIVE_INTR | WPI_WAKEUP_INTR)
/* possible flags for register WPI_TX_STATUS */
#define WPI_TX_IDLE(qid) (1 << ((qid) + 24) | 1 << ((qid) + 16))
/* possible flags for register WPI_EEPROM_CTL */
#define WPI_EEPROM_READY (1 << 0)
/* possible flags for register WPI_EEPROM_STATUS */
#define WPI_EEPROM_VERSION 0x00000007
#define WPI_EEPROM_LOCKED 0x00000180
struct wpi_shared {
uint32_t txbase[8];
uint32_t next;
uint32_t reserved[2];
} __attribute__((__packed__));
#define WPI_MAX_SEG_LEN 65520
struct wpi_tx_desc {
uint32_t flags;
#define WPI_PAD32(x) ((((x) + 3) & ~3) - (x))
struct {
uint32_t addr;
uint32_t len;
} __attribute__((__packed__)) segs[WPI_MAX_SCATTER];
uint8_t reserved[28];
} __attribute__((__packed__));
struct wpi_tx_stat {
uint8_t nrts;
uint8_t ntries;
uint8_t nkill;
uint8_t rate;
uint32_t duration;
uint32_t status;
} __attribute__((__packed__));
struct wpi_rx_desc {
uint32_t len;
uint8_t type;
#define WPI_UC_READY 1
#define WPI_RX_DONE 27
#define WPI_TX_DONE 28
#define WPI_START_SCAN 130
#define WPI_STOP_SCAN 132
#define WPI_STATE_CHANGED 161
uint8_t flags;
uint8_t idx;
uint8_t qid;
} __attribute__((__packed__));
struct wpi_rx_stat {
uint8_t len;
#define WPI_STAT_MAXLEN 20
uint8_t id;
uint8_t rssi; /* received signal strength */
#define WPI_RSSI_OFFSET 95
uint8_t agc; /* access gain control */
uint16_t signal;
uint16_t noise;
} __attribute__((__packed__));
struct wpi_rx_head {
uint16_t chan;
uint16_t flags;
uint8_t reserved;
uint8_t rate;
uint16_t len;
} __attribute__((__packed__));
struct wpi_rx_tail {
uint32_t flags;
#define WPI_RX_NO_CRC_ERR (1 << 0)
#define WPI_RX_NO_OVFL_ERR (1 << 1)
/* shortcut for the above */
#define WPI_RX_NOERROR (WPI_RX_NO_CRC_ERR | WPI_RX_NO_OVFL_ERR)
uint64_t tstamp;
uint32_t tbeacon;
} __attribute__((__packed__));
struct wpi_tx_cmd {
uint8_t code;
#define WPI_CMD_CONFIGURE 16
#define WPI_CMD_ASSOCIATE 17
#define WPI_CMD_SET_WME 19
#define WPI_CMD_TSF 20
#define WPI_CMD_ADD_NODE 24
#define WPI_CMD_TX_DATA 28
#define WPI_CMD_MRR_SETUP 71
#define WPI_CMD_SET_LED 72
#define WPI_CMD_SET_POWER_MODE 119
#define WPI_CMD_SCAN 128
#define WPI_CMD_SET_BEACON 145
#define WPI_CMD_BLUETOOTH 155
#define WPI_CMD_TXPOWER 176
uint8_t flags;
uint8_t idx;
uint8_t qid;
uint8_t data[124];
} __attribute__((__packed__));
/* structure for WPI_CMD_CONFIGURE */
struct wpi_config {
uint8_t myaddr[IEEE80211_ADDR_LEN];
uint16_t reserved1;
uint8_t bssid[IEEE80211_ADDR_LEN];
uint16_t reserved2;
uint32_t reserved3[2];
uint8_t mode;
#define WPI_MODE_HOSTAP 1
#define WPI_MODE_STA 3
#define WPI_MODE_IBSS 4
#define WPI_MODE_MONITOR 6
uint8_t reserved4[3];
uint8_t ofdm_mask;
uint8_t cck_mask;
uint16_t state;
#define WPI_STATE_ASSOCIATED 4
uint32_t flags;
#define WPI_CONFIG_24GHZ (1 << 0)
#define WPI_CONFIG_CCK (1 << 1)
#define WPI_CONFIG_AUTO (1 << 2)
#define WPI_CONFIG_SHSLOT (1 << 4)
#define WPI_CONFIG_SHPREAMBLE (1 << 5)
#define WPI_CONFIG_NODIVERSITY (1 << 7)
#define WPI_CONFIG_ANTENNA_A (1 << 8)
#define WPI_CONFIG_ANTENNA_B (1 << 9)
#define WPI_CONFIG_TSF (1 << 15)
uint32_t filter;
#define WPI_FILTER_PROMISC (1 << 0)
#define WPI_FILTER_CTL (1 << 1)
#define WPI_FILTER_MULTICAST (1 << 2)
#define WPI_FILTER_NODECRYPT (1 << 3)
#define WPI_FILTER_BSS (1 << 5)
#define WPI_FILTER_BEACON (1 << 6)
uint8_t chan;
uint8_t reserved6[3];
} __attribute__((__packed__));
/* structure for command WPI_CMD_ASSOCIATE */
struct wpi_assoc {
uint32_t flags;
uint32_t filter;
uint8_t ofdm_mask;
uint8_t cck_mask;
uint16_t reserved;
} __attribute__((__packed__));
/* structure for command WPI_CMD_SET_WME */
struct wpi_wme_setup {
uint32_t flags;
struct {
uint16_t cwmin;
uint16_t cwmax;
uint8_t aifsn;
uint8_t reserved;
uint16_t txop;
} __packed ac[WME_NUM_AC];
} __packed;
/* structure for command WPI_CMD_TSF */
struct wpi_cmd_tsf {
uint64_t tstamp;
uint16_t bintval;
uint16_t atim;
uint32_t binitval;
uint16_t lintval;
uint16_t reserved;
} __attribute__((__packed__));
/* structure for WPI_CMD_ADD_NODE */
struct wpi_node_info {
uint8_t control;
#define WPI_NODE_UPDATE (1 << 0)
uint8_t reserved1[3];
uint8_t bssid[IEEE80211_ADDR_LEN];
uint16_t reserved2;
uint8_t id;
#define WPI_ID_BSS 0
#define WPI_ID_BROADCAST 24
uint8_t sta_mask;
uint16_t reserved3;
uint16_t key_flags;
uint8_t tkip;
uint8_t reserved4;
uint16_t ttak[5];
uint16_t reserved5;
uint8_t key[IEEE80211_KEYBUF_SIZE];
uint32_t flags;
uint32_t mask;
uint16_t tid;
uint8_t rate;
uint8_t reserved6;
uint8_t add_imm;
uint8_t del_imm;
uint16_t add_imm_start;
} __attribute__((__packed__));
/* structure for command WPI_CMD_TX_DATA */
struct wpi_cmd_data {
uint16_t len;
uint16_t lnext;
uint32_t flags;
#define WPI_TX_NEED_RTS (1 << 1)
#define WPI_TX_NEED_ACK (1 << 3)
#define WPI_TX_FULL_TXOP (1 << 7)
#define WPI_TX_AUTO_SEQ (1 << 13)
#define WPI_TX_INSERT_TSTAMP (1 << 16)
uint8_t rate;
uint8_t id;
uint8_t tid;
uint8_t security;
uint8_t key[IEEE80211_KEYBUF_SIZE];
uint8_t tkip[IEEE80211_WEP_MICLEN];
uint32_t fnext;
uint32_t lifetime;
uint8_t ofdm_mask;
uint8_t cck_mask;
uint8_t rts_ntries;
uint8_t data_ntries;
uint16_t timeout;
uint16_t txop;
struct ieee80211_frame wh;
} __attribute__((__packed__));
/* structure for command WPI_CMD_SET_BEACON */
struct wpi_cmd_beacon {
uint16_t len;
uint16_t reserved1;
uint32_t flags; /* same as wpi_cmd_data */
uint8_t rate;
uint8_t id;
uint8_t reserved2[30];
uint32_t lifetime;
uint8_t ofdm_mask;
uint8_t cck_mask;
uint16_t reserved3[3];
uint16_t tim;
uint8_t timsz;
uint8_t reserved4;
struct ieee80211_frame wh;
} __attribute__((__packed__));
/* structure for WPI_CMD_MRR_SETUP */
struct wpi_mrr_setup {
uint32_t which;
#define WPI_MRR_CTL 0
#define WPI_MRR_DATA 1
struct {
uint8_t plcp;
uint8_t flags;
uint8_t ntries;
uint8_t next;
#define WPI_OFDM6 0
#define WPI_OFDM54 7
#define WPI_CCK1 8
#define WPI_CCK2 9
#define WPI_CCK11 11
} __attribute__((__packed__)) rates[WPI_CCK11 + 1];
} __attribute__((__packed__));
/* structure for WPI_CMD_SET_LED */
struct wpi_cmd_led {
uint32_t unit; /* multiplier (in usecs) */
uint8_t which;
#define WPI_LED_ACTIVITY 1
#define WPI_LED_LINK 2
uint8_t off;
uint8_t on;
uint8_t reserved;
} __attribute__((__packed__));
/* structure for WPI_CMD_SET_POWER_MODE */
struct wpi_power {
uint32_t flags;
uint32_t rx_timeout;
uint32_t tx_timeout;
uint32_t sleep[5];
} __attribute__((__packed__));
/* structure for command WPI_CMD_SCAN */
struct wpi_scan_hdr {
uint8_t len;
uint8_t first;
uint8_t reserved1;
uint8_t nchan;
uint16_t quiet;
uint16_t threshold;
uint16_t band;
#define WPI_SCAN_5GHZ 1
uint16_t reserved2[5];
uint32_t flags;
uint32_t filter;
uint16_t pbrlen;
uint16_t reserved4;
uint32_t magic1;
uint8_t rate;
uint8_t id;
uint16_t reserved5;
uint32_t reserved6[7];
uint32_t mask;
uint32_t reserved7[2];
uint8_t reserved8;
uint8_t esslen;
uint8_t essid[134];
/* followed by probe request body */
/* followed by nchan x wpi_scan_chan */
} __attribute__((__packed__));
struct wpi_scan_chan {
uint8_t flags;
uint8_t chan;
#define WPI_CHAN_ACTIVE 3
uint16_t magic; /* XXX */
uint16_t active; /* msecs */
uint16_t passive; /* msecs */
} __attribute__((__packed__));
/* structure for WPI_CMD_BLUETOOTH */
struct wpi_bluetooth {
uint8_t flags;
uint8_t lead;
uint8_t kill;
uint8_t reserved;
uint32_t ack;
uint32_t cts;
} __attribute__((__packed__));
/* structure for command WPI_CMD_TXPOWER */
struct wpi_txpower {
uint32_t reserved1;
uint16_t pwr1[14];
uint32_t reserved2[2];
uint16_t pwr2[14];
uint32_t reserved3[2];
} __attribute__((__packed__));
/* firmware image header */
struct wpi_firmware_hdr {
uint32_t version;
uint32_t textsz;
uint32_t datasz;
uint32_t bootsz;
} __attribute__((__packed__));
/* structure for WPI_UC_READY notification */
struct wpi_ucode_info {
uint32_t version;
uint8_t revision[8];
uint8_t type;
uint8_t subtype;
uint16_t reserved;
uint32_t logptr;
uint32_t errorptr;
uint32_t timestamp;
uint32_t valid;
} __attribute__((__packed__));
/* structure for WPI_START_SCAN notification */
struct wpi_start_scan {
uint64_t tstamp;
uint32_t tbeacon;
uint8_t chan;
uint8_t band;
uint16_t reserved;
uint32_t status;
} __attribute__((__packed__));
/* structure for WPI_STOP_SCAN notification */
struct wpi_stop_scan {
uint8_t nchan;
uint8_t status;
uint8_t reserved;
uint8_t chan;
uint64_t tsf;
} __packed;
#define WPI_EEPROM_MAC 0x015
#define WPI_EEPROM_REVISION 0x035
#define WPI_EEPROM_CAPABILITIES 0x045
#define WPI_EEPROM_TYPE 0x04a
#define WPI_EEPROM_PWR1 0x1ae
#define WPI_EEPROM_PWR2 0x1bc
#define WPI_READ(sc, reg) \
bus_space_read_4((sc)->sc_st, (sc)->sc_sh, (reg))
#define WPI_WRITE(sc, reg, val) \
bus_space_write_4((sc)->sc_st, (sc)->sc_sh, (reg), (val))
#define WPI_WRITE_REGION_4(sc, offset, datap, count) \
bus_space_write_region_4((sc)->sc_st, (sc)->sc_sh, (offset), \
(datap), (count))