GNU Linux-libre 4.19.264-gnu1
[releases.git] / drivers / net / wireless / intel / iwlwifi / iwl-prph.h
1 /******************************************************************************
2  *
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.
5  *
6  * GPL LICENSE SUMMARY
7  *
8  * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
9  * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
10  * Copyright(c) 2016        Intel Deutschland GmbH
11  * Copyright (C) 2018 Intel Corporation
12  *
13  * This program is free software; you can redistribute it and/or modify
14  * it under the terms of version 2 of the GNU General Public License as
15  * published by the Free Software Foundation.
16  *
17  * This program is distributed in the hope that it will be useful, but
18  * WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
20  * General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
25  * USA
26  *
27  * The full GNU General Public License is included in this distribution
28  * in the file called COPYING.
29  *
30  * Contact Information:
31  *  Intel Linux Wireless <linuxwifi@intel.com>
32  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
33  *
34  * BSD LICENSE
35  *
36  * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
37  * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
38  * Copyright(c) 2016        Intel Deutschland GmbH
39  * Copyright (C) 2018 Intel Corporation
40  * All rights reserved.
41  *
42  * Redistribution and use in source and binary forms, with or without
43  * modification, are permitted provided that the following conditions
44  * are met:
45  *
46  *  * Redistributions of source code must retain the above copyright
47  *    notice, this list of conditions and the following disclaimer.
48  *  * Redistributions in binary form must reproduce the above copyright
49  *    notice, this list of conditions and the following disclaimer in
50  *    the documentation and/or other materials provided with the
51  *    distribution.
52  *  * Neither the name Intel Corporation nor the names of its
53  *    contributors may be used to endorse or promote products derived
54  *    from this software without specific prior written permission.
55  *
56  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
57  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
58  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
59  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
60  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
61  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
62  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
63  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
64  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
65  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
66  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
67  *****************************************************************************/
68
69 #ifndef __iwl_prph_h__
70 #define __iwl_prph_h__
71 #include <linux/bitfield.h>
72
73 /*
74  * Registers in this file are internal, not PCI bus memory mapped.
75  * Driver accesses these via HBUS_TARG_PRPH_* registers.
76  */
77 #define PRPH_BASE       (0x00000)
78 #define PRPH_END        (0xFFFFF)
79
80 /* APMG (power management) constants */
81 #define APMG_BASE                       (PRPH_BASE + 0x3000)
82 #define APMG_CLK_CTRL_REG               (APMG_BASE + 0x0000)
83 #define APMG_CLK_EN_REG                 (APMG_BASE + 0x0004)
84 #define APMG_CLK_DIS_REG                (APMG_BASE + 0x0008)
85 #define APMG_PS_CTRL_REG                (APMG_BASE + 0x000c)
86 #define APMG_PCIDEV_STT_REG             (APMG_BASE + 0x0010)
87 #define APMG_RFKILL_REG                 (APMG_BASE + 0x0014)
88 #define APMG_RTC_INT_STT_REG            (APMG_BASE + 0x001c)
89 #define APMG_RTC_INT_MSK_REG            (APMG_BASE + 0x0020)
90 #define APMG_DIGITAL_SVR_REG            (APMG_BASE + 0x0058)
91 #define APMG_ANALOG_SVR_REG             (APMG_BASE + 0x006C)
92
93 #define APMS_CLK_VAL_MRB_FUNC_MODE      (0x00000001)
94 #define APMG_CLK_VAL_DMA_CLK_RQT        (0x00000200)
95 #define APMG_CLK_VAL_BSM_CLK_RQT        (0x00000800)
96
97 #define APMG_PS_CTRL_EARLY_PWR_OFF_RESET_DIS    (0x00400000)
98 #define APMG_PS_CTRL_VAL_RESET_REQ              (0x04000000)
99 #define APMG_PS_CTRL_MSK_PWR_SRC                (0x03000000)
100 #define APMG_PS_CTRL_VAL_PWR_SRC_VMAIN          (0x00000000)
101 #define APMG_PS_CTRL_VAL_PWR_SRC_VAUX           (0x02000000)
102 #define APMG_SVR_VOLTAGE_CONFIG_BIT_MSK (0x000001E0) /* bit 8:5 */
103 #define APMG_SVR_DIGITAL_VOLTAGE_1_32           (0x00000060)
104
105 #define APMG_PCIDEV_STT_VAL_PERSIST_DIS (0x00000200)
106 #define APMG_PCIDEV_STT_VAL_L1_ACT_DIS  (0x00000800)
107 #define APMG_PCIDEV_STT_VAL_WAKE_ME     (0x00004000)
108
109 #define APMG_RTC_INT_STT_RFKILL         (0x10000000)
110
111 /* Device system time */
112 #define DEVICE_SYSTEM_TIME_REG 0xA0206C
113
114 /* Device NMI register and value for 8000 family and lower hw's */
115 #define DEVICE_SET_NMI_REG 0x00a01c30
116 #define DEVICE_SET_NMI_VAL_DRV BIT(7)
117 /* Device NMI register and value for 9000 family and above hw's */
118 #define UREG_NIC_SET_NMI_DRIVER 0x00a05c10
119 #define UREG_NIC_SET_NMI_DRIVER_NMI_FROM_DRIVER_MSK 0xff000000
120
121 /* Shared registers (0x0..0x3ff, via target indirect or periphery */
122 #define SHR_BASE        0x00a10000
123
124 /* Shared GP1 register */
125 #define SHR_APMG_GP1_REG                0x01dc
126 #define SHR_APMG_GP1_REG_PRPH           (SHR_BASE + SHR_APMG_GP1_REG)
127 #define SHR_APMG_GP1_WF_XTAL_LP_EN      0x00000004
128 #define SHR_APMG_GP1_CHICKEN_BIT_SELECT 0x80000000
129
130 /* Shared DL_CFG register */
131 #define SHR_APMG_DL_CFG_REG                     0x01c4
132 #define SHR_APMG_DL_CFG_REG_PRPH                (SHR_BASE + SHR_APMG_DL_CFG_REG)
133 #define SHR_APMG_DL_CFG_RTCS_CLK_SELECTOR_MSK   0x000000c0
134 #define SHR_APMG_DL_CFG_RTCS_CLK_INTERNAL_XTAL  0x00000080
135 #define SHR_APMG_DL_CFG_DL_CLOCK_POWER_UP       0x00000100
136
137 /* Shared APMG_XTAL_CFG register */
138 #define SHR_APMG_XTAL_CFG_REG           0x1c0
139 #define SHR_APMG_XTAL_CFG_XTAL_ON_REQ   0x80000000
140
141 /*
142  * Device reset for family 8000
143  * write to bit 24 in order to reset the CPU
144 */
145 #define RELEASE_CPU_RESET               (0x300C)
146 #define RELEASE_CPU_RESET_BIT           BIT(24)
147
148 /*****************************************************************************
149  *                        7000/3000 series SHR DTS addresses                 *
150  *****************************************************************************/
151
152 #define SHR_MISC_WFM_DTS_EN     (0x00a10024)
153 #define DTSC_CFG_MODE           (0x00a10604)
154 #define DTSC_VREF_AVG           (0x00a10648)
155 #define DTSC_VREF5_AVG          (0x00a1064c)
156 #define DTSC_CFG_MODE_PERIODIC  (0x2)
157 #define DTSC_PTAT_AVG           (0x00a10650)
158
159
160 /**
161  * Tx Scheduler
162  *
163  * The Tx Scheduler selects the next frame to be transmitted, choosing TFDs
164  * (Transmit Frame Descriptors) from up to 16 circular Tx queues resident in
165  * host DRAM.  It steers each frame's Tx command (which contains the frame
166  * data) into one of up to 7 prioritized Tx DMA FIFO channels within the
167  * device.  A queue maps to only one (selectable by driver) Tx DMA channel,
168  * but one DMA channel may take input from several queues.
169  *
170  * Tx DMA FIFOs have dedicated purposes.
171  *
172  * For 5000 series and up, they are used differently
173  * (cf. iwl5000_default_queue_to_tx_fifo in iwl-5000.c):
174  *
175  * 0 -- EDCA BK (background) frames, lowest priority
176  * 1 -- EDCA BE (best effort) frames, normal priority
177  * 2 -- EDCA VI (video) frames, higher priority
178  * 3 -- EDCA VO (voice) and management frames, highest priority
179  * 4 -- unused
180  * 5 -- unused
181  * 6 -- unused
182  * 7 -- Commands
183  *
184  * Driver should normally map queues 0-6 to Tx DMA/FIFO channels 0-6.
185  * In addition, driver can map the remaining queues to Tx DMA/FIFO
186  * channels 0-3 to support 11n aggregation via EDCA DMA channels.
187  *
188  * The driver sets up each queue to work in one of two modes:
189  *
190  * 1)  Scheduler-Ack, in which the scheduler automatically supports a
191  *     block-ack (BA) window of up to 64 TFDs.  In this mode, each queue
192  *     contains TFDs for a unique combination of Recipient Address (RA)
193  *     and Traffic Identifier (TID), that is, traffic of a given
194  *     Quality-Of-Service (QOS) priority, destined for a single station.
195  *
196  *     In scheduler-ack mode, the scheduler keeps track of the Tx status of
197  *     each frame within the BA window, including whether it's been transmitted,
198  *     and whether it's been acknowledged by the receiving station.  The device
199  *     automatically processes block-acks received from the receiving STA,
200  *     and reschedules un-acked frames to be retransmitted (successful
201  *     Tx completion may end up being out-of-order).
202  *
203  *     The driver must maintain the queue's Byte Count table in host DRAM
204  *     for this mode.
205  *     This mode does not support fragmentation.
206  *
207  * 2)  FIFO (a.k.a. non-Scheduler-ACK), in which each TFD is processed in order.
208  *     The device may automatically retry Tx, but will retry only one frame
209  *     at a time, until receiving ACK from receiving station, or reaching
210  *     retry limit and giving up.
211  *
212  *     The command queue (#4/#9) must use this mode!
213  *     This mode does not require use of the Byte Count table in host DRAM.
214  *
215  * Driver controls scheduler operation via 3 means:
216  * 1)  Scheduler registers
217  * 2)  Shared scheduler data base in internal SRAM
218  * 3)  Shared data in host DRAM
219  *
220  * Initialization:
221  *
222  * When loading, driver should allocate memory for:
223  * 1)  16 TFD circular buffers, each with space for (typically) 256 TFDs.
224  * 2)  16 Byte Count circular buffers in 16 KBytes contiguous memory
225  *     (1024 bytes for each queue).
226  *
227  * After receiving "Alive" response from uCode, driver must initialize
228  * the scheduler (especially for queue #4/#9, the command queue, otherwise
229  * the driver can't issue commands!):
230  */
231 #define SCD_MEM_LOWER_BOUND             (0x0000)
232
233 /**
234  * Max Tx window size is the max number of contiguous TFDs that the scheduler
235  * can keep track of at one time when creating block-ack chains of frames.
236  * Note that "64" matches the number of ack bits in a block-ack packet.
237  */
238 #define SCD_WIN_SIZE                            64
239 #define SCD_FRAME_LIMIT                         64
240
241 #define SCD_TXFIFO_POS_TID                      (0)
242 #define SCD_TXFIFO_POS_RA                       (4)
243 #define SCD_QUEUE_RA_TID_MAP_RATID_MSK  (0x01FF)
244
245 /* agn SCD */
246 #define SCD_QUEUE_STTS_REG_POS_TXF      (0)
247 #define SCD_QUEUE_STTS_REG_POS_ACTIVE   (3)
248 #define SCD_QUEUE_STTS_REG_POS_WSL      (4)
249 #define SCD_QUEUE_STTS_REG_POS_SCD_ACT_EN (19)
250 #define SCD_QUEUE_STTS_REG_MSK          (0x017F0000)
251
252 #define SCD_QUEUE_CTX_REG1_CREDIT               (0x00FFFF00)
253 #define SCD_QUEUE_CTX_REG1_SUPER_CREDIT         (0xFF000000)
254 #define SCD_QUEUE_CTX_REG1_VAL(_n, _v)          FIELD_PREP(SCD_QUEUE_CTX_REG1_ ## _n, _v)
255
256 #define SCD_QUEUE_CTX_REG2_WIN_SIZE             (0x0000007F)
257 #define SCD_QUEUE_CTX_REG2_FRAME_LIMIT          (0x007F0000)
258 #define SCD_QUEUE_CTX_REG2_VAL(_n, _v)          FIELD_PREP(SCD_QUEUE_CTX_REG2_ ## _n, _v)
259
260 #define SCD_GP_CTRL_ENABLE_31_QUEUES            BIT(0)
261 #define SCD_GP_CTRL_AUTO_ACTIVE_MODE            BIT(18)
262
263 /* Context Data */
264 #define SCD_CONTEXT_MEM_LOWER_BOUND     (SCD_MEM_LOWER_BOUND + 0x600)
265 #define SCD_CONTEXT_MEM_UPPER_BOUND     (SCD_MEM_LOWER_BOUND + 0x6A0)
266
267 /* Tx status */
268 #define SCD_TX_STTS_MEM_LOWER_BOUND     (SCD_MEM_LOWER_BOUND + 0x6A0)
269 #define SCD_TX_STTS_MEM_UPPER_BOUND     (SCD_MEM_LOWER_BOUND + 0x7E0)
270
271 /* Translation Data */
272 #define SCD_TRANS_TBL_MEM_LOWER_BOUND   (SCD_MEM_LOWER_BOUND + 0x7E0)
273 #define SCD_TRANS_TBL_MEM_UPPER_BOUND   (SCD_MEM_LOWER_BOUND + 0x808)
274
275 #define SCD_CONTEXT_QUEUE_OFFSET(x)\
276         (SCD_CONTEXT_MEM_LOWER_BOUND + ((x) * 8))
277
278 #define SCD_TX_STTS_QUEUE_OFFSET(x)\
279         (SCD_TX_STTS_MEM_LOWER_BOUND + ((x) * 16))
280
281 #define SCD_TRANS_TBL_OFFSET_QUEUE(x) \
282         ((SCD_TRANS_TBL_MEM_LOWER_BOUND + ((x) * 2)) & 0xfffc)
283
284 #define SCD_BASE                        (PRPH_BASE + 0xa02c00)
285
286 #define SCD_SRAM_BASE_ADDR      (SCD_BASE + 0x0)
287 #define SCD_DRAM_BASE_ADDR      (SCD_BASE + 0x8)
288 #define SCD_AIT                 (SCD_BASE + 0x0c)
289 #define SCD_TXFACT              (SCD_BASE + 0x10)
290 #define SCD_ACTIVE              (SCD_BASE + 0x14)
291 #define SCD_QUEUECHAIN_SEL      (SCD_BASE + 0xe8)
292 #define SCD_CHAINEXT_EN         (SCD_BASE + 0x244)
293 #define SCD_AGGR_SEL            (SCD_BASE + 0x248)
294 #define SCD_INTERRUPT_MASK      (SCD_BASE + 0x108)
295 #define SCD_GP_CTRL             (SCD_BASE + 0x1a8)
296 #define SCD_EN_CTRL             (SCD_BASE + 0x254)
297
298 /*********************** END TX SCHEDULER *************************************/
299
300 /* Oscillator clock */
301 #define OSC_CLK                         (0xa04068)
302 #define OSC_CLK_FORCE_CONTROL           (0x8)
303
304 #define FH_UCODE_LOAD_STATUS            (0x1AF0)
305
306 /*
307  * Replacing FH_UCODE_LOAD_STATUS
308  * This register is writen by driver and is read by uCode during boot flow.
309  * Note this address is cleared after MAC reset.
310  */
311 #define UREG_UCODE_LOAD_STATUS          (0xa05c40)
312 #define UREG_CPU_INIT_RUN               (0xa05c44)
313
314 #define LMPM_SECURE_UCODE_LOAD_CPU1_HDR_ADDR    (0x1E78)
315 #define LMPM_SECURE_UCODE_LOAD_CPU2_HDR_ADDR    (0x1E7C)
316
317 #define LMPM_SECURE_CPU1_HDR_MEM_SPACE          (0x420000)
318 #define LMPM_SECURE_CPU2_HDR_MEM_SPACE          (0x420400)
319
320 #define LMAC2_PRPH_OFFSET               (0x100000)
321
322 /* Rx FIFO */
323 #define RXF_SIZE_ADDR                   (0xa00c88)
324 #define RXF_RD_D_SPACE                  (0xa00c40)
325 #define RXF_RD_WR_PTR                   (0xa00c50)
326 #define RXF_RD_RD_PTR                   (0xa00c54)
327 #define RXF_RD_FENCE_PTR                (0xa00c4c)
328 #define RXF_SET_FENCE_MODE              (0xa00c14)
329 #define RXF_LD_WR2FENCE         (0xa00c1c)
330 #define RXF_FIFO_RD_FENCE_INC           (0xa00c68)
331 #define RXF_SIZE_BYTE_CND_POS           (7)
332 #define RXF_SIZE_BYTE_CNT_MSK           (0x3ff << RXF_SIZE_BYTE_CND_POS)
333 #define RXF_DIFF_FROM_PREV              (0x200)
334
335 #define RXF_LD_FENCE_OFFSET_ADDR        (0xa00c10)
336 #define RXF_FIFO_RD_FENCE_ADDR          (0xa00c0c)
337
338 /* Tx FIFO */
339 #define TXF_FIFO_ITEM_CNT               (0xa00438)
340 #define TXF_WR_PTR                      (0xa00414)
341 #define TXF_RD_PTR                      (0xa00410)
342 #define TXF_FENCE_PTR                   (0xa00418)
343 #define TXF_LOCK_FENCE                  (0xa00424)
344 #define TXF_LARC_NUM                    (0xa0043c)
345 #define TXF_READ_MODIFY_DATA            (0xa00448)
346 #define TXF_READ_MODIFY_ADDR            (0xa0044c)
347
348 /* UMAC Internal Tx Fifo */
349 #define TXF_CPU2_FIFO_ITEM_CNT          (0xA00538)
350 #define TXF_CPU2_WR_PTR         (0xA00514)
351 #define TXF_CPU2_RD_PTR         (0xA00510)
352 #define TXF_CPU2_FENCE_PTR              (0xA00518)
353 #define TXF_CPU2_LOCK_FENCE             (0xA00524)
354 #define TXF_CPU2_NUM                    (0xA0053C)
355 #define TXF_CPU2_READ_MODIFY_DATA       (0xA00548)
356 #define TXF_CPU2_READ_MODIFY_ADDR       (0xA0054C)
357
358 /* Radio registers access */
359 #define RSP_RADIO_CMD                   (0xa02804)
360 #define RSP_RADIO_RDDAT                 (0xa02814)
361 #define RADIO_RSP_ADDR_POS              (6)
362 #define RADIO_RSP_RD_CMD                (3)
363
364 /* FW monitor */
365 #define MON_BUFF_SAMPLE_CTL             (0xa03c00)
366 #define MON_BUFF_BASE_ADDR              (0xa03c3c)
367 #define MON_BUFF_END_ADDR               (0xa03c40)
368 #define MON_BUFF_WRPTR                  (0xa03c44)
369 #define MON_BUFF_CYCLE_CNT              (0xa03c48)
370
371 #define MON_DMARB_RD_CTL_ADDR           (0xa03c60)
372 #define MON_DMARB_RD_DATA_ADDR          (0xa03c5c)
373
374 #define DBGC_IN_SAMPLE                  (0xa03c00)
375 #define DBGC_OUT_CTRL                   (0xa03c0c)
376
377 /* enable the ID buf for read */
378 #define WFPM_PS_CTL_CLR                 0xA0300C
379 #define WFMP_MAC_ADDR_0                 0xA03080
380 #define WFMP_MAC_ADDR_1                 0xA03084
381 #define LMPM_PMG_EN                     0xA01CEC
382 #define RADIO_REG_SYS_MANUAL_DFT_0      0xAD4078
383 #define RFIC_REG_RD                     0xAD0470
384 #define WFPM_CTRL_REG                   0xA03030
385 #define WFPM_GP2                        0xA030B4
386 enum {
387         ENABLE_WFPM = BIT(31),
388         WFPM_AUX_CTL_AUX_IF_MAC_OWNER_MSK       = 0x80000000,
389 };
390
391 #define AUX_MISC_REG                    0xA200B0
392 enum {
393         HW_STEP_LOCATION_BITS = 24,
394 };
395
396 #define AUX_MISC_MASTER1_EN             0xA20818
397 enum aux_misc_master1_en {
398         AUX_MISC_MASTER1_EN_SBE_MSK     = 0x1,
399 };
400
401 #define AUX_MISC_MASTER1_SMPHR_STATUS   0xA20800
402 #define RSA_ENABLE                      0xA24B08
403 #define PREG_AUX_BUS_WPROT_0            0xA04CC0
404 #define PREG_PRPH_WPROT_0               0xA04CE0
405 #define SB_CPU_1_STATUS                 0xA01E30
406 #define SB_CPU_2_STATUS                 0xA01E34
407 #define UMAG_SB_CPU_1_STATUS            0xA038C0
408 #define UMAG_SB_CPU_2_STATUS            0xA038C4
409 #define UMAG_GEN_HW_STATUS              0xA038C8
410
411 /* For UMAG_GEN_HW_STATUS reg check */
412 enum {
413         UMAG_GEN_HW_IS_FPGA = BIT(1),
414 };
415
416 /* FW chicken bits */
417 #define LMPM_CHICK                      0xA01FF8
418 enum {
419         LMPM_CHICK_EXTENDED_ADDR_SPACE = BIT(0),
420 };
421
422 /* FW chicken bits */
423 #define LMPM_PAGE_PASS_NOTIF                    0xA03824
424 enum {
425         LMPM_PAGE_PASS_NOTIF_POS = BIT(20),
426 };
427
428 #define UREG_CHICK              (0xA05C00)
429 #define UREG_CHICK_MSI_ENABLE   BIT(24)
430 #define UREG_CHICK_MSIX_ENABLE  BIT(25)
431
432 #define HPM_DEBUG                       0xA03440
433 #define PERSISTENCE_BIT                 BIT(12)
434 #define PREG_WFPM_ACCESS                BIT(12)
435 #endif                          /* __iwl_prph_h__ */