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