1 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
2 /*
3  * Copyright (C) 2005-2014, 2018-2021 Intel Corporation
4  * Copyright (C) 2013-2014 Intel Mobile Communications GmbH
5  * Copyright (C) 2016 Intel Deutschland GmbH
6  */
7 #ifndef __iwl_csr_h__
8 #define __iwl_csr_h__
9 /*
10  * CSR (control and status registers)
11  *
12  * CSR registers are mapped directly into PCI bus space, and are accessible
13  * whenever platform supplies power to device, even when device is in
14  * low power states due to driver-invoked device resets
15  * (e.g. CSR_RESET_REG_FLAG_SW_RESET) or uCode-driven power-saving modes.
16  *
17  * Use iwl_write32() and iwl_read32() family to access these registers;
18  * these provide simple PCI bus access, without waking up the MAC.
19  * Do not use iwl_write_direct32() family for these registers;
20  * no need to "grab nic access" via CSR_GP_CNTRL_REG_FLAG_MAC_ACCESS_REQ.
21  * The MAC (uCode processor, etc.) does not need to be powered up for accessing
22  * the CSR registers.
23  *
24  * NOTE:  Device does need to be awake in order to read this memory
25  *        via CSR_EEPROM and CSR_OTP registers
26  */
27 #define CSR_BASE    (0x000)
28 
29 #define CSR_HW_IF_CONFIG_REG    (CSR_BASE+0x000) /* hardware interface config */
30 #define CSR_INT_COALESCING      (CSR_BASE+0x004) /* accum ints, 32-usec units */
31 #define CSR_INT                 (CSR_BASE+0x008) /* host interrupt status/ack */
32 #define CSR_INT_MASK            (CSR_BASE+0x00c) /* host interrupt enable */
33 #define CSR_FH_INT_STATUS       (CSR_BASE+0x010) /* busmaster int status/ack*/
34 #define CSR_GPIO_IN             (CSR_BASE+0x018) /* read external chip pins */
35 #define CSR_RESET               (CSR_BASE+0x020) /* busmaster enable, NMI, etc*/
36 #define CSR_GP_CNTRL            (CSR_BASE+0x024)
37 
38 /* 2nd byte of CSR_INT_COALESCING, not accessible via iwl_write32()! */
39 #define CSR_INT_PERIODIC_REG	(CSR_BASE+0x005)
40 
41 /*
42  * Hardware revision info
43  * Bit fields:
44  * 31-16:  Reserved
45  *  15-4:  Type of device:  see CSR_HW_REV_TYPE_xxx definitions
46  *  3-2:  Revision step:  0 = A, 1 = B, 2 = C, 3 = D
47  *  1-0:  "Dash" (-) value, as in A-1, etc.
48  */
49 #define CSR_HW_REV              (CSR_BASE+0x028)
50 
51 /*
52  * RF ID revision info
53  * Bit fields:
54  * 31:24: Reserved (set to 0x0)
55  * 23:12: Type
56  * 11:8:  Step (A - 0x0, B - 0x1, etc)
57  * 7:4:   Dash
58  * 3:0:   Flavor
59  */
60 #define CSR_HW_RF_ID		(CSR_BASE+0x09c)
61 
62 /*
63  * EEPROM and OTP (one-time-programmable) memory reads
64  *
65  * NOTE:  Device must be awake, initialized via apm_ops.init(),
66  *        in order to read.
67  */
68 #define CSR_EEPROM_REG          (CSR_BASE+0x02c)
69 #define CSR_EEPROM_GP           (CSR_BASE+0x030)
70 #define CSR_OTP_GP_REG   	(CSR_BASE+0x034)
71 
72 #define CSR_GIO_REG		(CSR_BASE+0x03C)
73 #define CSR_GP_UCODE_REG	(CSR_BASE+0x048)
74 #define CSR_GP_DRIVER_REG	(CSR_BASE+0x050)
75 
76 /*
77  * UCODE-DRIVER GP (general purpose) mailbox registers.
78  * SET/CLR registers set/clear bit(s) if "1" is written.
79  */
80 #define CSR_UCODE_DRV_GP1       (CSR_BASE+0x054)
81 #define CSR_UCODE_DRV_GP1_SET   (CSR_BASE+0x058)
82 #define CSR_UCODE_DRV_GP1_CLR   (CSR_BASE+0x05c)
83 #define CSR_UCODE_DRV_GP2       (CSR_BASE+0x060)
84 
85 #define CSR_MBOX_SET_REG	(CSR_BASE + 0x88)
86 
87 #define CSR_LED_REG             (CSR_BASE+0x094)
88 #define CSR_DRAM_INT_TBL_REG	(CSR_BASE+0x0A0)
89 #define CSR_MAC_SHADOW_REG_CTRL		(CSR_BASE + 0x0A8) /* 6000 and up */
90 #define CSR_MAC_SHADOW_REG_CTRL_RX_WAKE	BIT(20)
91 #define CSR_MAC_SHADOW_REG_CTL2		(CSR_BASE + 0x0AC)
92 #define CSR_MAC_SHADOW_REG_CTL2_RX_WAKE	0xFFFF
93 
94 /* LTR control (since IWL_DEVICE_FAMILY_22000) */
95 #define CSR_LTR_LONG_VAL_AD			(CSR_BASE + 0x0D4)
96 #define CSR_LTR_LONG_VAL_AD_NO_SNOOP_REQ	0x80000000
97 #define CSR_LTR_LONG_VAL_AD_NO_SNOOP_SCALE	0x1c000000
98 #define CSR_LTR_LONG_VAL_AD_NO_SNOOP_VAL	0x03ff0000
99 #define CSR_LTR_LONG_VAL_AD_SNOOP_REQ		0x00008000
100 #define CSR_LTR_LONG_VAL_AD_SNOOP_SCALE		0x00001c00
101 #define CSR_LTR_LONG_VAL_AD_SNOOP_VAL		0x000003ff
102 #define CSR_LTR_LONG_VAL_AD_SCALE_USEC		2
103 
104 /* GIO Chicken Bits (PCI Express bus link power management) */
105 #define CSR_GIO_CHICKEN_BITS    (CSR_BASE+0x100)
106 
107 /* Doorbell NMI (since Bz) */
108 #define CSR_DOORBELL_VECTOR	(CSR_BASE + 0x130)
109 #define CSR_DOORBELL_VECTOR_NMI	BIT(1)
110 
111 /* host chicken bits */
112 #define CSR_HOST_CHICKEN	(CSR_BASE + 0x204)
113 #define CSR_HOST_CHICKEN_PM_IDLE_SRC_DIS_SB_PME	BIT(19)
114 
115 /* Analog phase-lock-loop configuration  */
116 #define CSR_ANA_PLL_CFG         (CSR_BASE+0x20c)
117 
118 /*
119  * CSR HW resources monitor registers
120  */
121 #define CSR_MONITOR_CFG_REG		(CSR_BASE+0x214)
122 #define CSR_MONITOR_STATUS_REG		(CSR_BASE+0x228)
123 #define CSR_MONITOR_XTAL_RESOURCES	(0x00000010)
124 
125 /*
126  * CSR Hardware Revision Workaround Register.  Indicates hardware rev;
127  * "step" determines CCK backoff for txpower calculation.
128  * See also CSR_HW_REV register.
129  * Bit fields:
130  *  3-2:  0 = A, 1 = B, 2 = C, 3 = D step
131  *  1-0:  "Dash" (-) value, as in C-1, etc.
132  */
133 #define CSR_HW_REV_WA_REG		(CSR_BASE+0x22C)
134 
135 #define CSR_DBG_HPET_MEM_REG		(CSR_BASE+0x240)
136 #define CSR_DBG_LINK_PWR_MGMT_REG	(CSR_BASE+0x250)
137 
138 /* Bits for CSR_HW_IF_CONFIG_REG */
139 #define CSR_HW_IF_CONFIG_REG_MSK_MAC_DASH	(0x00000003)
140 #define CSR_HW_IF_CONFIG_REG_MSK_MAC_STEP	(0x0000000C)
141 #define CSR_HW_IF_CONFIG_REG_BIT_MONITOR_SRAM	(0x00000080)
142 #define CSR_HW_IF_CONFIG_REG_MSK_BOARD_VER	(0x000000C0)
143 #define CSR_HW_IF_CONFIG_REG_BIT_MAC_SI		(0x00000100)
144 #define CSR_HW_IF_CONFIG_REG_BIT_RADIO_SI	(0x00000200)
145 #define CSR_HW_IF_CONFIG_REG_D3_DEBUG		(0x00000200)
146 #define CSR_HW_IF_CONFIG_REG_MSK_PHY_TYPE	(0x00000C00)
147 #define CSR_HW_IF_CONFIG_REG_MSK_PHY_DASH	(0x00003000)
148 #define CSR_HW_IF_CONFIG_REG_MSK_PHY_STEP	(0x0000C000)
149 
150 #define CSR_HW_IF_CONFIG_REG_POS_MAC_DASH	(0)
151 #define CSR_HW_IF_CONFIG_REG_POS_MAC_STEP	(2)
152 #define CSR_HW_IF_CONFIG_REG_POS_BOARD_VER	(6)
153 #define CSR_HW_IF_CONFIG_REG_POS_PHY_TYPE	(10)
154 #define CSR_HW_IF_CONFIG_REG_POS_PHY_DASH	(12)
155 #define CSR_HW_IF_CONFIG_REG_POS_PHY_STEP	(14)
156 
157 #define CSR_HW_IF_CONFIG_REG_BIT_HAP_WAKE_L1A	(0x00080000)
158 #define CSR_HW_IF_CONFIG_REG_BIT_EEPROM_OWN_SEM	(0x00200000)
159 #define CSR_HW_IF_CONFIG_REG_BIT_NIC_READY	(0x00400000) /* PCI_OWN_SEM */
160 #define CSR_HW_IF_CONFIG_REG_BIT_NIC_PREPARE_DONE (0x02000000) /* ME_OWN */
161 #define CSR_HW_IF_CONFIG_REG_PREPARE		  (0x08000000) /* WAKE_ME */
162 #define CSR_HW_IF_CONFIG_REG_ENABLE_PME		  (0x10000000)
163 #define CSR_HW_IF_CONFIG_REG_PERSIST_MODE	  (0x40000000) /* PERSISTENCE */
164 
165 #define CSR_MBOX_SET_REG_OS_ALIVE		BIT(5)
166 
167 #define CSR_INT_PERIODIC_DIS			(0x00) /* disable periodic int*/
168 #define CSR_INT_PERIODIC_ENA			(0xFF) /* 255*32 usec ~ 8 msec*/
169 
170 /* interrupt flags in INTA, set by uCode or hardware (e.g. dma),
171  * acknowledged (reset) by host writing "1" to flagged bits. */
172 #define CSR_INT_BIT_FH_RX        (1 << 31) /* Rx DMA, cmd responses, FH_INT[17:16] */
173 #define CSR_INT_BIT_HW_ERR       (1 << 29) /* DMA hardware error FH_INT[31] */
174 #define CSR_INT_BIT_RX_PERIODIC	 (1 << 28) /* Rx periodic */
175 #define CSR_INT_BIT_FH_TX        (1 << 27) /* Tx DMA FH_INT[1:0] */
176 #define CSR_INT_BIT_SCD          (1 << 26) /* TXQ pointer advanced */
177 #define CSR_INT_BIT_SW_ERR       (1 << 25) /* uCode error */
178 #define CSR_INT_BIT_RF_KILL      (1 << 7)  /* HW RFKILL switch GP_CNTRL[27] toggled */
179 #define CSR_INT_BIT_CT_KILL      (1 << 6)  /* Critical temp (chip too hot) rfkill */
180 #define CSR_INT_BIT_SW_RX        (1 << 3)  /* Rx, command responses */
181 #define CSR_INT_BIT_WAKEUP       (1 << 1)  /* NIC controller waking up (pwr mgmt) */
182 #define CSR_INT_BIT_ALIVE        (1 << 0)  /* uCode interrupts once it initializes */
183 
184 #define CSR_INI_SET_MASK	(CSR_INT_BIT_FH_RX   | \
185 				 CSR_INT_BIT_HW_ERR  | \
186 				 CSR_INT_BIT_FH_TX   | \
187 				 CSR_INT_BIT_SW_ERR  | \
188 				 CSR_INT_BIT_RF_KILL | \
189 				 CSR_INT_BIT_SW_RX   | \
190 				 CSR_INT_BIT_WAKEUP  | \
191 				 CSR_INT_BIT_ALIVE   | \
192 				 CSR_INT_BIT_RX_PERIODIC)
193 
194 /* interrupt flags in FH (flow handler) (PCI busmaster DMA) */
195 #define CSR_FH_INT_BIT_ERR       (1 << 31) /* Error */
196 #define CSR_FH_INT_BIT_HI_PRIOR  (1 << 30) /* High priority Rx, bypass coalescing */
197 #define CSR_FH_INT_BIT_RX_CHNL1  (1 << 17) /* Rx channel 1 */
198 #define CSR_FH_INT_BIT_RX_CHNL0  (1 << 16) /* Rx channel 0 */
199 #define CSR_FH_INT_BIT_TX_CHNL1  (1 << 1)  /* Tx channel 1 */
200 #define CSR_FH_INT_BIT_TX_CHNL0  (1 << 0)  /* Tx channel 0 */
201 
202 #define CSR_FH_INT_RX_MASK	(CSR_FH_INT_BIT_HI_PRIOR | \
203 				CSR_FH_INT_BIT_RX_CHNL1 | \
204 				CSR_FH_INT_BIT_RX_CHNL0)
205 
206 #define CSR_FH_INT_TX_MASK	(CSR_FH_INT_BIT_TX_CHNL1 | \
207 				CSR_FH_INT_BIT_TX_CHNL0)
208 
209 /* GPIO */
210 #define CSR_GPIO_IN_BIT_AUX_POWER                   (0x00000200)
211 #define CSR_GPIO_IN_VAL_VAUX_PWR_SRC                (0x00000000)
212 #define CSR_GPIO_IN_VAL_VMAIN_PWR_SRC               (0x00000200)
213 
214 /* RESET */
215 #define CSR_RESET_REG_FLAG_NEVO_RESET                (0x00000001)
216 #define CSR_RESET_REG_FLAG_FORCE_NMI                 (0x00000002)
217 #define CSR_RESET_REG_FLAG_SW_RESET		     (0x00000080)
218 #define CSR_RESET_REG_FLAG_MASTER_DISABLED           (0x00000100)
219 #define CSR_RESET_REG_FLAG_STOP_MASTER               (0x00000200)
220 #define CSR_RESET_LINK_PWR_MGMT_DISABLED             (0x80000000)
221 
222 /*
223  * GP (general purpose) CONTROL REGISTER
224  * Bit fields:
225  *    27:  HW_RF_KILL_SW
226  *         Indicates state of (platform's) hardware RF-Kill switch
227  * 26-24:  POWER_SAVE_TYPE
228  *         Indicates current power-saving mode:
229  *         000 -- No power saving
230  *         001 -- MAC power-down
231  *         010 -- PHY (radio) power-down
232  *         011 -- Error
233  *    10:  XTAL ON request
234  *   9-6:  SYS_CONFIG
235  *         Indicates current system configuration, reflecting pins on chip
236  *         as forced high/low by device circuit board.
237  *     4:  GOING_TO_SLEEP
238  *         Indicates MAC is entering a power-saving sleep power-down.
239  *         Not a good time to access device-internal resources.
240  *     3:  MAC_ACCESS_REQ
241  *         Host sets this to request and maintain MAC wakeup, to allow host
242  *         access to device-internal resources.  Host must wait for
243  *         MAC_CLOCK_READY (and !GOING_TO_SLEEP) before accessing non-CSR
244  *         device registers.
245  *     2:  INIT_DONE
246  *         Host sets this to put device into fully operational D0 power mode.
247  *         Host resets this after SW_RESET to put device into low power mode.
248  *     0:  MAC_CLOCK_READY
249  *         Indicates MAC (ucode processor, etc.) is powered up and can run.
250  *         Internal resources are accessible.
251  *         NOTE:  This does not indicate that the processor is actually running.
252  *         NOTE:  This does not indicate that device has completed
253  *                init or post-power-down restore of internal SRAM memory.
254  *                Use CSR_UCODE_DRV_GP1_BIT_MAC_SLEEP as indication that
255  *                SRAM is restored and uCode is in normal operation mode.
256  *                Later devices (5xxx/6xxx/1xxx) use non-volatile SRAM, and
257  *                do not need to save/restore it.
258  *         NOTE:  After device reset, this bit remains "0" until host sets
259  *                INIT_DONE
260  */
261 #define CSR_GP_CNTRL_REG_FLAG_MAC_CLOCK_READY	     (0x00000001)
262 #define CSR_GP_CNTRL_REG_FLAG_INIT_DONE		     (0x00000004)
263 #define CSR_GP_CNTRL_REG_FLAG_MAC_ACCESS_REQ	     (0x00000008)
264 #define CSR_GP_CNTRL_REG_FLAG_GOING_TO_SLEEP	     (0x00000010)
265 #define CSR_GP_CNTRL_REG_FLAG_XTAL_ON		     (0x00000400)
266 
267 #define CSR_GP_CNTRL_REG_VAL_MAC_ACCESS_EN	     (0x00000001)
268 
269 #define CSR_GP_CNTRL_REG_MSK_POWER_SAVE_TYPE         (0x07000000)
270 #define CSR_GP_CNTRL_REG_FLAG_RFKILL_WAKE_L1A_EN     (0x04000000)
271 #define CSR_GP_CNTRL_REG_FLAG_HW_RF_KILL_SW          (0x08000000)
272 
273 /* From Bz we use these instead during init/reset flow */
274 #define CSR_GP_CNTRL_REG_FLAG_MAC_INIT			BIT(6)
275 #define CSR_GP_CNTRL_REG_FLAG_ROM_START			BIT(7)
276 #define CSR_GP_CNTRL_REG_FLAG_MAC_STATUS		BIT(20)
277 #define CSR_GP_CNTRL_REG_FLAG_BZ_MAC_ACCESS_REQ		BIT(21)
278 #define CSR_GP_CNTRL_REG_FLAG_BUS_MASTER_DISABLE_STATUS	BIT(28)
279 #define CSR_GP_CNTRL_REG_FLAG_BUS_MASTER_DISABLE_REQ	BIT(29)
280 #define CSR_GP_CNTRL_REG_FLAG_SW_RESET			BIT(31)
281 
282 /* HW REV */
283 #define CSR_HW_REV_DASH(_val)          (((_val) & 0x0000003) >> 0)
284 #define CSR_HW_REV_STEP(_val)          (((_val) & 0x000000C) >> 2)
285 #define CSR_HW_REV_TYPE(_val)          (((_val) & 0x000FFF0) >> 4)
286 
287 /* HW RFID */
288 #define CSR_HW_RFID_FLAVOR(_val)       (((_val) & 0x000000F) >> 0)
289 #define CSR_HW_RFID_DASH(_val)         (((_val) & 0x00000F0) >> 4)
290 #define CSR_HW_RFID_STEP(_val)         (((_val) & 0x0000F00) >> 8)
291 #define CSR_HW_RFID_TYPE(_val)         (((_val) & 0x0FFF000) >> 12)
292 #define CSR_HW_RFID_IS_CDB(_val)       (((_val) & 0x10000000) >> 28)
293 #define CSR_HW_RFID_IS_JACKET(_val)    (((_val) & 0x20000000) >> 29)
294 
295 /**
296  *  hw_rev values
297  */
298 enum {
299 	SILICON_A_STEP = 0,
300 	SILICON_B_STEP,
301 	SILICON_C_STEP,
302 };
303 
304 
305 #define CSR_HW_REV_TYPE_MSK		(0x000FFF0)
306 #define CSR_HW_REV_TYPE_5300		(0x0000020)
307 #define CSR_HW_REV_TYPE_5350		(0x0000030)
308 #define CSR_HW_REV_TYPE_5100		(0x0000050)
309 #define CSR_HW_REV_TYPE_5150		(0x0000040)
310 #define CSR_HW_REV_TYPE_1000		(0x0000060)
311 #define CSR_HW_REV_TYPE_6x00		(0x0000070)
312 #define CSR_HW_REV_TYPE_6x50		(0x0000080)
313 #define CSR_HW_REV_TYPE_6150		(0x0000084)
314 #define CSR_HW_REV_TYPE_6x05		(0x00000B0)
315 #define CSR_HW_REV_TYPE_6x30		CSR_HW_REV_TYPE_6x05
316 #define CSR_HW_REV_TYPE_6x35		CSR_HW_REV_TYPE_6x05
317 #define CSR_HW_REV_TYPE_2x30		(0x00000C0)
318 #define CSR_HW_REV_TYPE_2x00		(0x0000100)
319 #define CSR_HW_REV_TYPE_105		(0x0000110)
320 #define CSR_HW_REV_TYPE_135		(0x0000120)
321 #define CSR_HW_REV_TYPE_7265D		(0x0000210)
322 #define CSR_HW_REV_TYPE_NONE		(0x00001F0)
323 #define CSR_HW_REV_TYPE_QNJ		(0x0000360)
324 #define CSR_HW_REV_TYPE_QNJ_B0		(0x0000364)
325 #define CSR_HW_REV_TYPE_QU_B0		(0x0000334)
326 #define CSR_HW_REV_TYPE_QU_C0		(0x0000338)
327 #define CSR_HW_REV_TYPE_QUZ		(0x0000354)
328 #define CSR_HW_REV_TYPE_HR_CDB		(0x0000340)
329 #define CSR_HW_REV_TYPE_SO		(0x0000370)
330 #define CSR_HW_REV_TYPE_TY		(0x0000420)
331 
332 /* RF_ID value */
333 #define CSR_HW_RF_ID_TYPE_JF		(0x00105100)
334 #define CSR_HW_RF_ID_TYPE_HR		(0x0010A000)
335 #define CSR_HW_RF_ID_TYPE_HR1		(0x0010c100)
336 #define CSR_HW_RF_ID_TYPE_HRCDB		(0x00109F00)
337 #define CSR_HW_RF_ID_TYPE_GF		(0x0010D000)
338 #define CSR_HW_RF_ID_TYPE_GF4		(0x0010E000)
339 
340 /* HW_RF CHIP STEP  */
341 #define CSR_HW_RF_STEP(_val) (((_val) >> 8) & 0xF)
342 
343 /* EEPROM REG */
344 #define CSR_EEPROM_REG_READ_VALID_MSK	(0x00000001)
345 #define CSR_EEPROM_REG_BIT_CMD		(0x00000002)
346 #define CSR_EEPROM_REG_MSK_ADDR		(0x0000FFFC)
347 #define CSR_EEPROM_REG_MSK_DATA		(0xFFFF0000)
348 
349 /* EEPROM GP */
350 #define CSR_EEPROM_GP_VALID_MSK		(0x00000007) /* signature */
351 #define CSR_EEPROM_GP_IF_OWNER_MSK	(0x00000180)
352 #define CSR_EEPROM_GP_BAD_SIGNATURE_BOTH_EEP_AND_OTP	(0x00000000)
353 #define CSR_EEPROM_GP_BAD_SIG_EEP_GOOD_SIG_OTP		(0x00000001)
354 #define CSR_EEPROM_GP_GOOD_SIG_EEP_LESS_THAN_4K		(0x00000002)
355 #define CSR_EEPROM_GP_GOOD_SIG_EEP_MORE_THAN_4K		(0x00000004)
356 
357 /* One-time-programmable memory general purpose reg */
358 #define CSR_OTP_GP_REG_DEVICE_SELECT	(0x00010000) /* 0 - EEPROM, 1 - OTP */
359 #define CSR_OTP_GP_REG_OTP_ACCESS_MODE	(0x00020000) /* 0 - absolute, 1 - relative */
360 #define CSR_OTP_GP_REG_ECC_CORR_STATUS_MSK          (0x00100000) /* bit 20 */
361 #define CSR_OTP_GP_REG_ECC_UNCORR_STATUS_MSK        (0x00200000) /* bit 21 */
362 
363 /* GP REG */
364 #define CSR_GP_REG_POWER_SAVE_STATUS_MSK            (0x03000000) /* bit 24/25 */
365 #define CSR_GP_REG_NO_POWER_SAVE            (0x00000000)
366 #define CSR_GP_REG_MAC_POWER_SAVE           (0x01000000)
367 #define CSR_GP_REG_PHY_POWER_SAVE           (0x02000000)
368 #define CSR_GP_REG_POWER_SAVE_ERROR         (0x03000000)
369 
370 
371 /* CSR GIO */
372 #define CSR_GIO_REG_VAL_L0S_DISABLED	(0x00000002)
373 
374 /*
375  * UCODE-DRIVER GP (general purpose) mailbox register 1
376  * Host driver and uCode write and/or read this register to communicate with
377  * each other.
378  * Bit fields:
379  *     4:  UCODE_DISABLE
380  *         Host sets this to request permanent halt of uCode, same as
381  *         sending CARD_STATE command with "halt" bit set.
382  *     3:  CT_KILL_EXIT
383  *         Host sets this to request exit from CT_KILL state, i.e. host thinks
384  *         device temperature is low enough to continue normal operation.
385  *     2:  CMD_BLOCKED
386  *         Host sets this during RF KILL power-down sequence (HW, SW, CT KILL)
387  *         to release uCode to clear all Tx and command queues, enter
388  *         unassociated mode, and power down.
389  *         NOTE:  Some devices also use HBUS_TARG_MBX_C register for this bit.
390  *     1:  SW_BIT_RFKILL
391  *         Host sets this when issuing CARD_STATE command to request
392  *         device sleep.
393  *     0:  MAC_SLEEP
394  *         uCode sets this when preparing a power-saving power-down.
395  *         uCode resets this when power-up is complete and SRAM is sane.
396  *         NOTE:  device saves internal SRAM data to host when powering down,
397  *                and must restore this data after powering back up.
398  *                MAC_SLEEP is the best indication that restore is complete.
399  *                Later devices (5xxx/6xxx/1xxx) use non-volatile SRAM, and
400  *                do not need to save/restore it.
401  */
402 #define CSR_UCODE_DRV_GP1_BIT_MAC_SLEEP             (0x00000001)
403 #define CSR_UCODE_SW_BIT_RFKILL                     (0x00000002)
404 #define CSR_UCODE_DRV_GP1_BIT_CMD_BLOCKED           (0x00000004)
405 #define CSR_UCODE_DRV_GP1_REG_BIT_CT_KILL_EXIT      (0x00000008)
406 #define CSR_UCODE_DRV_GP1_BIT_D3_CFG_COMPLETE       (0x00000020)
407 
408 /* GP Driver */
409 #define CSR_GP_DRIVER_REG_BIT_RADIO_SKU_MSK	    (0x00000003)
410 #define CSR_GP_DRIVER_REG_BIT_RADIO_SKU_3x3_HYB	    (0x00000000)
411 #define CSR_GP_DRIVER_REG_BIT_RADIO_SKU_2x2_HYB	    (0x00000001)
412 #define CSR_GP_DRIVER_REG_BIT_RADIO_SKU_2x2_IPA	    (0x00000002)
413 #define CSR_GP_DRIVER_REG_BIT_CALIB_VERSION6	    (0x00000004)
414 #define CSR_GP_DRIVER_REG_BIT_6050_1x2		    (0x00000008)
415 
416 #define CSR_GP_DRIVER_REG_BIT_RADIO_IQ_INVER	    (0x00000080)
417 
418 /* GIO Chicken Bits (PCI Express bus link power management) */
419 #define CSR_GIO_CHICKEN_BITS_REG_BIT_L1A_NO_L0S_RX  (0x00800000)
420 #define CSR_GIO_CHICKEN_BITS_REG_BIT_DIS_L0S_EXIT_TIMER  (0x20000000)
421 
422 /* LED */
423 #define CSR_LED_BSM_CTRL_MSK (0xFFFFFFDF)
424 #define CSR_LED_REG_TURN_ON (0x60)
425 #define CSR_LED_REG_TURN_OFF (0x20)
426 
427 /* ANA_PLL */
428 #define CSR50_ANA_PLL_CFG_VAL        (0x00880300)
429 
430 /* HPET MEM debug */
431 #define CSR_DBG_HPET_MEM_REG_VAL	(0xFFFF0000)
432 
433 /* DRAM INT TABLE */
434 #define CSR_DRAM_INT_TBL_ENABLE		(1 << 31)
435 #define CSR_DRAM_INIT_TBL_WRITE_POINTER	(1 << 28)
436 #define CSR_DRAM_INIT_TBL_WRAP_CHECK	(1 << 27)
437 
438 /*
439  * SHR target access (Shared block memory space)
440  *
441  * Shared internal registers can be accessed directly from PCI bus through SHR
442  * arbiter without need for the MAC HW to be powered up. This is possible due to
443  * indirect read/write via HEEP_CTRL_WRD_PCIEX_CTRL (0xEC) and
444  * HEEP_CTRL_WRD_PCIEX_DATA (0xF4) registers.
445  *
446  * Use iwl_write32()/iwl_read32() family to access these registers. The MAC HW
447  * need not be powered up so no "grab inc access" is required.
448  */
449 
450 /*
451  * Registers for accessing shared registers (e.g. SHR_APMG_GP1,
452  * SHR_APMG_XTAL_CFG). For example, to read from SHR_APMG_GP1 register (0x1DC),
453  * first, write to the control register:
454  * HEEP_CTRL_WRD_PCIEX_CTRL[15:0] = 0x1DC (offset of the SHR_APMG_GP1 register)
455  * HEEP_CTRL_WRD_PCIEX_CTRL[29:28] = 2 (read access)
456  * second, read from the data register HEEP_CTRL_WRD_PCIEX_DATA[31:0].
457  *
458  * To write the register, first, write to the data register
459  * HEEP_CTRL_WRD_PCIEX_DATA[31:0] and then:
460  * HEEP_CTRL_WRD_PCIEX_CTRL[15:0] = 0x1DC (offset of the SHR_APMG_GP1 register)
461  * HEEP_CTRL_WRD_PCIEX_CTRL[29:28] = 3 (write access)
462  */
463 #define HEEP_CTRL_WRD_PCIEX_CTRL_REG	(CSR_BASE+0x0ec)
464 #define HEEP_CTRL_WRD_PCIEX_DATA_REG	(CSR_BASE+0x0f4)
465 
466 /*
467  * HBUS (Host-side Bus)
468  *
469  * HBUS registers are mapped directly into PCI bus space, but are used
470  * to indirectly access device's internal memory or registers that
471  * may be powered-down.
472  *
473  * Use iwl_write_direct32()/iwl_read_direct32() family for these registers;
474  * host must "grab nic access" via CSR_GP_CNTRL_REG_FLAG_MAC_ACCESS_REQ
475  * to make sure the MAC (uCode processor, etc.) is powered up for accessing
476  * internal resources.
477  *
478  * Do not use iwl_write32()/iwl_read32() family to access these registers;
479  * these provide only simple PCI bus access, without waking up the MAC.
480  */
481 #define HBUS_BASE	(0x400)
482 
483 /*
484  * Registers for accessing device's internal SRAM memory (e.g. SCD SRAM
485  * structures, error log, event log, verifying uCode load).
486  * First write to address register, then read from or write to data register
487  * to complete the job.  Once the address register is set up, accesses to
488  * data registers auto-increment the address by one dword.
489  * Bit usage for address registers (read or write):
490  *  0-31:  memory address within device
491  */
492 #define HBUS_TARG_MEM_RADDR     (HBUS_BASE+0x00c)
493 #define HBUS_TARG_MEM_WADDR     (HBUS_BASE+0x010)
494 #define HBUS_TARG_MEM_WDAT      (HBUS_BASE+0x018)
495 #define HBUS_TARG_MEM_RDAT      (HBUS_BASE+0x01c)
496 
497 /* Mailbox C, used as workaround alternative to CSR_UCODE_DRV_GP1 mailbox */
498 #define HBUS_TARG_MBX_C         (HBUS_BASE+0x030)
499 #define HBUS_TARG_MBX_C_REG_BIT_CMD_BLOCKED         (0x00000004)
500 
501 /*
502  * Registers for accessing device's internal peripheral registers
503  * (e.g. SCD, BSM, etc.).  First write to address register,
504  * then read from or write to data register to complete the job.
505  * Bit usage for address registers (read or write):
506  *  0-15:  register address (offset) within device
507  * 24-25:  (# bytes - 1) to read or write (e.g. 3 for dword)
508  */
509 #define HBUS_TARG_PRPH_WADDR    (HBUS_BASE+0x044)
510 #define HBUS_TARG_PRPH_RADDR    (HBUS_BASE+0x048)
511 #define HBUS_TARG_PRPH_WDAT     (HBUS_BASE+0x04c)
512 #define HBUS_TARG_PRPH_RDAT     (HBUS_BASE+0x050)
513 
514 /* Used to enable DBGM */
515 #define HBUS_TARG_TEST_REG	(HBUS_BASE+0x05c)
516 
517 /*
518  * Per-Tx-queue write pointer (index, really!)
519  * Indicates index to next TFD that driver will fill (1 past latest filled).
520  * Bit usage:
521  *  0-7:  queue write index
522  * 11-8:  queue selector
523  */
524 #define HBUS_TARG_WRPTR         (HBUS_BASE+0x060)
525 
526 /**********************************************************
527  * CSR values
528  **********************************************************/
529  /*
530  * host interrupt timeout value
531  * used with setting interrupt coalescing timer
532  * the CSR_INT_COALESCING is an 8 bit register in 32-usec unit
533  *
534  * default interrupt coalescing timer is 64 x 32 = 2048 usecs
535  */
536 #define IWL_HOST_INT_TIMEOUT_MAX	(0xFF)
537 #define IWL_HOST_INT_TIMEOUT_DEF	(0x40)
538 #define IWL_HOST_INT_TIMEOUT_MIN	(0x0)
539 #define IWL_HOST_INT_OPER_MODE		BIT(31)
540 
541 /*****************************************************************************
542  *                        7000/3000 series SHR DTS addresses                 *
543  *****************************************************************************/
544 
545 /* Diode Results Register Structure: */
546 enum dtd_diode_reg {
547 	DTS_DIODE_REG_DIG_VAL			= 0x000000FF, /* bits [7:0] */
548 	DTS_DIODE_REG_VREF_LOW			= 0x0000FF00, /* bits [15:8] */
549 	DTS_DIODE_REG_VREF_HIGH			= 0x00FF0000, /* bits [23:16] */
550 	DTS_DIODE_REG_VREF_ID			= 0x03000000, /* bits [25:24] */
551 	DTS_DIODE_REG_PASS_ONCE			= 0x80000000, /* bits [31:31] */
552 	DTS_DIODE_REG_FLAGS_MSK			= 0xFF000000, /* bits [31:24] */
553 /* Those are the masks INSIDE the flags bit-field: */
554 	DTS_DIODE_REG_FLAGS_VREFS_ID_POS	= 0,
555 	DTS_DIODE_REG_FLAGS_VREFS_ID		= 0x00000003, /* bits [1:0] */
556 	DTS_DIODE_REG_FLAGS_PASS_ONCE_POS	= 7,
557 	DTS_DIODE_REG_FLAGS_PASS_ONCE		= 0x00000080, /* bits [7:7] */
558 };
559 
560 /*****************************************************************************
561  *                        MSIX related registers                             *
562  *****************************************************************************/
563 
564 #define CSR_MSIX_BASE			(0x2000)
565 #define CSR_MSIX_FH_INT_CAUSES_AD	(CSR_MSIX_BASE + 0x800)
566 #define CSR_MSIX_FH_INT_MASK_AD		(CSR_MSIX_BASE + 0x804)
567 #define CSR_MSIX_HW_INT_CAUSES_AD	(CSR_MSIX_BASE + 0x808)
568 #define CSR_MSIX_HW_INT_MASK_AD		(CSR_MSIX_BASE + 0x80C)
569 #define CSR_MSIX_AUTOMASK_ST_AD		(CSR_MSIX_BASE + 0x810)
570 #define CSR_MSIX_RX_IVAR_AD_REG		(CSR_MSIX_BASE + 0x880)
571 #define CSR_MSIX_IVAR_AD_REG		(CSR_MSIX_BASE + 0x890)
572 #define CSR_MSIX_PENDING_PBA_AD		(CSR_MSIX_BASE + 0x1000)
573 #define CSR_MSIX_RX_IVAR(cause)		(CSR_MSIX_RX_IVAR_AD_REG + (cause))
574 #define CSR_MSIX_IVAR(cause)		(CSR_MSIX_IVAR_AD_REG + (cause))
575 
576 #define MSIX_FH_INT_CAUSES_Q(q)		(q)
577 
578 /*
579  * Causes for the FH register interrupts
580  */
581 enum msix_fh_int_causes {
582 	MSIX_FH_INT_CAUSES_Q0			= BIT(0),
583 	MSIX_FH_INT_CAUSES_Q1			= BIT(1),
584 	MSIX_FH_INT_CAUSES_D2S_CH0_NUM		= BIT(16),
585 	MSIX_FH_INT_CAUSES_D2S_CH1_NUM		= BIT(17),
586 	MSIX_FH_INT_CAUSES_S2D			= BIT(19),
587 	MSIX_FH_INT_CAUSES_FH_ERR		= BIT(21),
588 };
589 
590 /* The low 16 bits are for rx data queue indication */
591 #define MSIX_FH_INT_CAUSES_DATA_QUEUE 0xffff
592 
593 /*
594  * Causes for the HW register interrupts
595  */
596 enum msix_hw_int_causes {
597 	MSIX_HW_INT_CAUSES_REG_ALIVE		= BIT(0),
598 	MSIX_HW_INT_CAUSES_REG_WAKEUP		= BIT(1),
599 	MSIX_HW_INT_CAUSES_REG_IML              = BIT(1),
600 	MSIX_HW_INT_CAUSES_REG_RESET_DONE	= BIT(2),
601 	MSIX_HW_INT_CAUSES_REG_CT_KILL		= BIT(6),
602 	MSIX_HW_INT_CAUSES_REG_RF_KILL		= BIT(7),
603 	MSIX_HW_INT_CAUSES_REG_PERIODIC		= BIT(8),
604 	MSIX_HW_INT_CAUSES_REG_SW_ERR		= BIT(25),
605 	MSIX_HW_INT_CAUSES_REG_SCD		= BIT(26),
606 	MSIX_HW_INT_CAUSES_REG_FH_TX		= BIT(27),
607 	MSIX_HW_INT_CAUSES_REG_HW_ERR		= BIT(29),
608 	MSIX_HW_INT_CAUSES_REG_HAP		= BIT(30),
609 };
610 
611 #define MSIX_MIN_INTERRUPT_VECTORS		2
612 #define MSIX_AUTO_CLEAR_CAUSE			0
613 #define MSIX_NON_AUTO_CLEAR_CAUSE		BIT(7)
614 
615 /*****************************************************************************
616  *                     HW address related registers                          *
617  *****************************************************************************/
618 
619 #define CSR_ADDR_BASE(trans)			((trans)->cfg->mac_addr_from_csr)
620 #define CSR_MAC_ADDR0_OTP(trans)		(CSR_ADDR_BASE(trans) + 0x00)
621 #define CSR_MAC_ADDR1_OTP(trans)		(CSR_ADDR_BASE(trans) + 0x04)
622 #define CSR_MAC_ADDR0_STRAP(trans)		(CSR_ADDR_BASE(trans) + 0x08)
623 #define CSR_MAC_ADDR1_STRAP(trans)		(CSR_ADDR_BASE(trans) + 0x0c)
624 
625 #endif /* !__iwl_csr_h__ */
626