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