1 /******************************************************************************
3 * This file is provided under a dual BSD/GPLv2 license. When using or
4 * redistributing this file, you may do so under either license.
8 * Copyright(c) 2005 - 2008 Intel Corporation. All rights reserved.
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of version 2 of the GNU General Public License as
12 * published by the Free Software Foundation.
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
24 * The full GNU General Public License is included in this distribution
25 * in the file called LICENSE.GPL.
27 * Contact Information:
28 * James P. Ketrenos <ipw2100-admin@linux.intel.com>
29 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
33 * Copyright(c) 2005 - 2008 Intel Corporation. All rights reserved.
34 * All rights reserved.
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
40 * * Redistributions of source code must retain the above copyright
41 * notice, this list of conditions and the following disclaimer.
42 * * Redistributions in binary form must reproduce the above copyright
43 * notice, this list of conditions and the following disclaimer in
44 * the documentation and/or other materials provided with the
46 * * Neither the name Intel Corporation nor the names of its
47 * contributors may be used to endorse or promote products derived
48 * from this software without specific prior written permission.
50 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
51 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
52 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
53 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
54 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
55 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
56 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
57 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
58 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
59 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
60 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
62 *****************************************************************************/
63 /*=== CSR (control and status registers) ===*/
64 #define CSR_BASE (0x000)
66 #define CSR_HW_IF_CONFIG_REG (CSR_BASE+0x000) /* hardware interface config */
67 #define CSR_INT_COALESCING (CSR_BASE+0x004) /* accum ints, 32-usec units */
68 #define CSR_INT (CSR_BASE+0x008) /* host interrupt status/ack */
69 #define CSR_INT_MASK (CSR_BASE+0x00c) /* host interrupt enable */
70 #define CSR_FH_INT_STATUS (CSR_BASE+0x010) /* busmaster int status/ack*/
71 #define CSR_GPIO_IN (CSR_BASE+0x018) /* read external chip pins */
72 #define CSR_RESET (CSR_BASE+0x020) /* busmaster enable, NMI, etc*/
73 #define CSR_GP_CNTRL (CSR_BASE+0x024)
76 * Hardware revision info
79 * 7-4: Type of device: 0x0 = 4965, 0xd = 3945
80 * 3-2: Revision step: 0 = A, 1 = B, 2 = C, 3 = D
81 * 1-0: "Dash" value, as in A-1, etc.
83 * NOTE: Revision step affects calculation of CCK txpower for 4965.
85 #define CSR_HW_REV (CSR_BASE+0x028)
88 #define CSR_EEPROM_REG (CSR_BASE+0x02c)
89 #define CSR_EEPROM_GP (CSR_BASE+0x030)
90 #define CSR_GP_UCODE (CSR_BASE+0x044)
91 #define CSR_UCODE_DRV_GP1 (CSR_BASE+0x054)
92 #define CSR_UCODE_DRV_GP1_SET (CSR_BASE+0x058)
93 #define CSR_UCODE_DRV_GP1_CLR (CSR_BASE+0x05c)
94 #define CSR_UCODE_DRV_GP2 (CSR_BASE+0x060)
95 #define CSR_GIO_CHICKEN_BITS (CSR_BASE+0x100)
97 /* Analog phase-lock-loop configuration (3945 only)
99 #define CSR_ANA_PLL_CFG (CSR_BASE+0x20c)
101 * Indicates hardware rev, to determine CCK backoff for txpower calculation.
103 * 3-2: 0 = A, 1 = B, 2 = C, 3 = D step
105 #define CSR_HW_REV_WA_REG (CSR_BASE+0x22C)
107 /* Bits for CSR_HW_IF_CONFIG_REG */
108 #define CSR49_HW_IF_CONFIG_REG_BIT_4965_R (0x00000010)
109 #define CSR49_HW_IF_CONFIG_REG_MSK_BOARD_VER (0x00000C00)
110 #define CSR49_HW_IF_CONFIG_REG_BIT_MAC_SI (0x00000100)
111 #define CSR49_HW_IF_CONFIG_REG_BIT_RADIO_SI (0x00000200)
113 #define CSR39_HW_IF_CONFIG_REG_BIT_3945_MB (0x00000100)
114 #define CSR39_HW_IF_CONFIG_REG_BIT_3945_MM (0x00000200)
115 #define CSR39_HW_IF_CONFIG_REG_BIT_SKU_MRC (0x00000400)
116 #define CSR39_HW_IF_CONFIG_REG_BIT_BOARD_TYPE (0x00000800)
117 #define CSR39_HW_IF_CONFIG_REG_BITS_SILICON_TYPE_A (0x00000000)
118 #define CSR39_HW_IF_CONFIG_REG_BITS_SILICON_TYPE_B (0x00001000)
120 #define CSR_HW_IF_CONFIG_REG_BIT_EEPROM_OWN_SEM (0x00200000)
122 /* interrupt flags in INTA, set by uCode or hardware (e.g. dma),
123 * acknowledged (reset) by host writing "1" to flagged bits. */
124 #define CSR_INT_BIT_FH_RX (1 << 31) /* Rx DMA, cmd responses, FH_INT[17:16] */
125 #define CSR_INT_BIT_HW_ERR (1 << 29) /* DMA hardware error FH_INT[31] */
126 #define CSR_INT_BIT_DNLD (1 << 28) /* uCode Download */
127 #define CSR_INT_BIT_FH_TX (1 << 27) /* Tx DMA FH_INT[1:0] */
128 #define CSR_INT_BIT_SCD (1 << 26) /* TXQ pointer advanced */
129 #define CSR_INT_BIT_SW_ERR (1 << 25) /* uCode error */
130 #define CSR_INT_BIT_RF_KILL (1 << 7) /* HW RFKILL switch GP_CNTRL[27] toggled */
131 #define CSR_INT_BIT_CT_KILL (1 << 6) /* Critical temp (chip too hot) rfkill */
132 #define CSR_INT_BIT_SW_RX (1 << 3) /* Rx, command responses, 3945 */
133 #define CSR_INT_BIT_WAKEUP (1 << 1) /* NIC controller waking up (pwr mgmt) */
134 #define CSR_INT_BIT_ALIVE (1 << 0) /* uCode interrupts once it initializes */
136 #define CSR_INI_SET_MASK (CSR_INT_BIT_FH_RX | \
137 CSR_INT_BIT_HW_ERR | \
138 CSR_INT_BIT_FH_TX | \
139 CSR_INT_BIT_SW_ERR | \
140 CSR_INT_BIT_RF_KILL | \
141 CSR_INT_BIT_SW_RX | \
142 CSR_INT_BIT_WAKEUP | \
145 /* interrupt flags in FH (flow handler) (PCI busmaster DMA) */
146 #define CSR_FH_INT_BIT_ERR (1 << 31) /* Error */
147 #define CSR_FH_INT_BIT_HI_PRIOR (1 << 30) /* High priority Rx, bypass coalescing */
148 #define CSR39_FH_INT_BIT_RX_CHNL2 (1 << 18) /* Rx channel 2 (3945 only) */
149 #define CSR_FH_INT_BIT_RX_CHNL1 (1 << 17) /* Rx channel 1 */
150 #define CSR_FH_INT_BIT_RX_CHNL0 (1 << 16) /* Rx channel 0 */
151 #define CSR39_FH_INT_BIT_TX_CHNL6 (1 << 6) /* Tx channel 6 (3945 only) */
152 #define CSR_FH_INT_BIT_TX_CHNL1 (1 << 1) /* Tx channel 1 */
153 #define CSR_FH_INT_BIT_TX_CHNL0 (1 << 0) /* Tx channel 0 */
155 #define CSR39_FH_INT_RX_MASK (CSR_FH_INT_BIT_HI_PRIOR | \
156 CSR39_FH_INT_BIT_RX_CHNL2 | \
157 CSR_FH_INT_BIT_RX_CHNL1 | \
158 CSR_FH_INT_BIT_RX_CHNL0)
161 #define CSR39_FH_INT_TX_MASK (CSR39_FH_INT_BIT_TX_CHNL6 | \
162 CSR_FH_INT_BIT_TX_CHNL1 | \
163 CSR_FH_INT_BIT_TX_CHNL0)
165 #define CSR49_FH_INT_RX_MASK (CSR_FH_INT_BIT_HI_PRIOR | \
166 CSR_FH_INT_BIT_RX_CHNL1 | \
167 CSR_FH_INT_BIT_RX_CHNL0)
169 #define CSR49_FH_INT_TX_MASK (CSR_FH_INT_BIT_TX_CHNL1 | \
170 CSR_FH_INT_BIT_TX_CHNL0)
174 #define CSR_RESET_REG_FLAG_NEVO_RESET (0x00000001)
175 #define CSR_RESET_REG_FLAG_FORCE_NMI (0x00000002)
176 #define CSR_RESET_REG_FLAG_SW_RESET (0x00000080)
177 #define CSR_RESET_REG_FLAG_MASTER_DISABLED (0x00000100)
178 #define CSR_RESET_REG_FLAG_STOP_MASTER (0x00000200)
180 /* GP (general purpose) CONTROL */
181 #define CSR_GP_CNTRL_REG_FLAG_MAC_CLOCK_READY (0x00000001)
182 #define CSR_GP_CNTRL_REG_FLAG_INIT_DONE (0x00000004)
183 #define CSR_GP_CNTRL_REG_FLAG_MAC_ACCESS_REQ (0x00000008)
184 #define CSR_GP_CNTRL_REG_FLAG_GOING_TO_SLEEP (0x00000010)
186 #define CSR_GP_CNTRL_REG_VAL_MAC_ACCESS_EN (0x00000001)
188 #define CSR_GP_CNTRL_REG_MSK_POWER_SAVE_TYPE (0x07000000)
189 #define CSR_GP_CNTRL_REG_FLAG_MAC_POWER_SAVE (0x04000000)
190 #define CSR_GP_CNTRL_REG_FLAG_HW_RF_KILL_SW (0x08000000)
194 #define CSR_EEPROM_REG_READ_VALID_MSK (0x00000001)
195 #define CSR_EEPROM_REG_BIT_CMD (0x00000002)
198 #define CSR_EEPROM_GP_VALID_MSK (0x00000006)
199 #define CSR_EEPROM_GP_BAD_SIGNATURE (0x00000000)
200 #define CSR_EEPROM_GP_IF_OWNER_MSK (0x00000180)
203 #define CSR_UCODE_DRV_GP1_BIT_MAC_SLEEP (0x00000001)
204 #define CSR_UCODE_SW_BIT_RFKILL (0x00000002)
205 #define CSR_UCODE_DRV_GP1_BIT_CMD_BLOCKED (0x00000004)
206 #define CSR_UCODE_DRV_GP1_REG_BIT_CT_KILL_EXIT (0x00000008)
209 #define CSR_GPIO_IN_BIT_AUX_POWER (0x00000200)
210 #define CSR_GPIO_IN_VAL_VAUX_PWR_SRC (0x00000000)
211 #define CSR_GPIO_IN_VAL_VMAIN_PWR_SRC CSR_GPIO_IN_BIT_AUX_POWER
213 /* GI Chicken Bits */
214 #define CSR_GIO_CHICKEN_BITS_REG_BIT_L1A_NO_L0S_RX (0x00800000)
215 #define CSR_GIO_CHICKEN_BITS_REG_BIT_DIS_L0S_EXIT_TIMER (0x20000000)
217 /*=== HBUS (Host-side Bus) ===*/
218 #define HBUS_BASE (0x400)
220 * Registers for accessing device's internal SRAM memory (e.g. SCD SRAM
221 * structures, error log, event log, verifying uCode load).
222 * First write to address register, then read from or write to data register
223 * to complete the job. Once the address register is set up, accesses to
224 * data registers auto-increment the address by one dword.
225 * Bit usage for address registers (read or write):
226 * 0-31: memory address within device
228 #define HBUS_TARG_MEM_RADDR (HBUS_BASE+0x00c)
229 #define HBUS_TARG_MEM_WADDR (HBUS_BASE+0x010)
230 #define HBUS_TARG_MEM_WDAT (HBUS_BASE+0x018)
231 #define HBUS_TARG_MEM_RDAT (HBUS_BASE+0x01c)
234 * Registers for accessing device's internal peripheral registers
235 * (e.g. SCD, BSM, etc.). First write to address register,
236 * then read from or write to data register to complete the job.
237 * Bit usage for address registers (read or write):
238 * 0-15: register address (offset) within device
239 * 24-25: (# bytes - 1) to read or write (e.g. 3 for dword)
241 #define HBUS_TARG_PRPH_WADDR (HBUS_BASE+0x044)
242 #define HBUS_TARG_PRPH_RADDR (HBUS_BASE+0x048)
243 #define HBUS_TARG_PRPH_WDAT (HBUS_BASE+0x04c)
244 #define HBUS_TARG_PRPH_RDAT (HBUS_BASE+0x050)
247 * Per-Tx-queue write pointer (index, really!) (3945 and 4965).
248 * Indicates index to next TFD that driver will fill (1 past latest filled).
250 * 0-7: queue write index
251 * 11-8: queue selector
253 #define HBUS_TARG_WRPTR (HBUS_BASE+0x060)
254 #define HBUS_TARG_MBX_C (HBUS_BASE+0x030)
256 #define HBUS_TARG_MBX_C_REG_BIT_CMD_BLOCKED (0x00000004)