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  *
  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
  70 /*
  71  * Registers in this file are internal, not PCI bus memory mapped.
  72  * Driver accesses these via HBUS_TARG_PRPH_* registers.
  73  */
  74 #define PRPH_BASE       (0x00000)
  75 #define PRPH_END        (0xFFFFF)
  76
  77 /* APMG (power management) constants */
  78 #define APMG_BASE                       (PRPH_BASE + 0x3000)
  79 #define APMG_CLK_CTRL_REG               (APMG_BASE + 0x0000)
  80 #define APMG_CLK_EN_REG                 (APMG_BASE + 0x0004)
  81 #define APMG_CLK_DIS_REG                (APMG_BASE + 0x0008)
  82 #define APMG_PS_CTRL_REG                (APMG_BASE + 0x000c)
  83 #define APMG_PCIDEV_STT_REG             (APMG_BASE + 0x0010)
  84 #define APMG_RFKILL_REG                 (APMG_BASE + 0x0014)
  85 #define APMG_RTC_INT_STT_REG            (APMG_BASE + 0x001c)
  86 #define APMG_RTC_INT_MSK_REG            (APMG_BASE + 0x0020)
  87 #define APMG_DIGITAL_SVR_REG            (APMG_BASE + 0x0058)
  88 #define APMG_ANALOG_SVR_REG             (APMG_BASE + 0x006C)
  89
  90 #define APMS_CLK_VAL_MRB_FUNC_MODE      (0x00000001)
  91 #define APMG_CLK_VAL_DMA_CLK_RQT        (0x00000200)
  92 #define APMG_CLK_VAL_BSM_CLK_RQT        (0x00000800)
  93
  94 #define APMG_PS_CTRL_EARLY_PWR_OFF_RESET_DIS    (0x00400000)
  95 #define APMG_PS_CTRL_VAL_RESET_REQ              (0x04000000)
  96 #define APMG_PS_CTRL_MSK_PWR_SRC                (0x03000000)
  97 #define APMG_PS_CTRL_VAL_PWR_SRC_VMAIN          (0x00000000)
  98 #define APMG_PS_CTRL_VAL_PWR_SRC_VAUX           (0x02000000)
  99 #define APMG_SVR_VOLTAGE_CONFIG_BIT_MSK (0x000001E0) /* bit 8:5 */
 100 #define APMG_SVR_DIGITAL_VOLTAGE_1_32           (0x00000060)
 101
 102 #define APMG_PCIDEV_STT_VAL_PERSIST_DIS (0x00000200)
 103 #define APMG_PCIDEV_STT_VAL_L1_ACT_DIS  (0x00000800)
 104 #define APMG_PCIDEV_STT_VAL_WAKE_ME     (0x00004000)
 105
 106 #define APMG_RTC_INT_STT_RFKILL         (0x10000000)
 107
 108 /* Device system time */
 109 #define DEVICE_SYSTEM_TIME_REG 0xA0206C
 110
 111 /* Device NMI register */
 112 #define DEVICE_SET_NMI_REG 0x00a01c30
 113 #define DEVICE_SET_NMI_VAL_HW BIT(0)
 114 #define DEVICE_SET_NMI_VAL_DRV BIT(7)
 115 #define DEVICE_SET_NMI_8000_REG 0x00a01c24
 116 #define DEVICE_SET_NMI_8000_VAL 0x1000000
 117 #define UREG_NIC_SET_NMI_DRIVER 0x00a05c10
 118
 119 /* Shared registers (0x0..0x3ff, via target indirect or periphery */
 120 #define SHR_BASE        0x00a10000
 121
 122 /* Shared GP1 register */
 123 #define SHR_APMG_GP1_REG                0x01dc
 124 #define SHR_APMG_GP1_REG_PRPH           (SHR_BASE + SHR_APMG_GP1_REG)
 125 #define SHR_APMG_GP1_WF_XTAL_LP_EN      0x00000004
 126 #define SHR_APMG_GP1_CHICKEN_BIT_SELECT 0x80000000
 127
 128 /* Shared DL_CFG register */
 129 #define SHR_APMG_DL_CFG_REG                     0x01c4
 130 #define SHR_APMG_DL_CFG_REG_PRPH                (SHR_BASE + SHR_APMG_DL_CFG_REG)
 131 #define SHR_APMG_DL_CFG_RTCS_CLK_SELECTOR_MSK   0x000000c0
 132 #define SHR_APMG_DL_CFG_RTCS_CLK_INTERNAL_XTAL  0x00000080
 133 #define SHR_APMG_DL_CFG_DL_CLOCK_POWER_UP       0x00000100
 134
 135 /* Shared APMG_XTAL_CFG register */
 136 #define SHR_APMG_XTAL_CFG_REG           0x1c0
 137 #define SHR_APMG_XTAL_CFG_XTAL_ON_REQ   0x80000000
 138
 139 /*
 140  * Device reset for family 8000
 141  * write to bit 24 in order to reset the CPU
 142 */
 143 #define RELEASE_CPU_RESET               (0x300C)
 144 #define RELEASE_CPU_RESET_BIT           BIT(24)
 145
 146 /*****************************************************************************
 147  *                        7000/3000 series SHR DTS addresses                 *
 148  *****************************************************************************/
 149
 150 #define SHR_MISC_WFM_DTS_EN     (0x00a10024)
 151 #define DTSC_CFG_MODE           (0x00a10604)
 152 #define DTSC_VREF_AVG           (0x00a10648)
 153 #define DTSC_VREF5_AVG          (0x00a1064c)
 154 #define DTSC_CFG_MODE_PERIODIC  (0x2)
 155 #define DTSC_PTAT_AVG           (0x00a10650)
 156
 157
 158 /**
 159  * Tx Scheduler
 160  *
 161  * The Tx Scheduler selects the next frame to be transmitted, choosing TFDs
 162  * (Transmit Frame Descriptors) from up to 16 circular Tx queues resident in
 163  * host DRAM.  It steers each frame's Tx command (which contains the frame
 164  * data) into one of up to 7 prioritized Tx DMA FIFO channels within the
 165  * device.  A queue maps to only one (selectable by driver) Tx DMA channel,
 166  * but one DMA channel may take input from several queues.
 167  *
 168  * Tx DMA FIFOs have dedicated purposes.
 169  *
 170  * For 5000 series and up, they are used differently
 171  * (cf. iwl5000_default_queue_to_tx_fifo in iwl-5000.c):
 172  *
 173  * 0 -- EDCA BK (background) frames, lowest priority
 174  * 1 -- EDCA BE (best effort) frames, normal priority
 175  * 2 -- EDCA VI (video) frames, higher priority
 176  * 3 -- EDCA VO (voice) and management frames, highest priority
 177  * 4 -- unused
 178  * 5 -- unused
 179  * 6 -- unused
 180  * 7 -- Commands
 181  *
 182  * Driver should normally map queues 0-6 to Tx DMA/FIFO channels 0-6.
 183  * In addition, driver can map the remaining queues to Tx DMA/FIFO
 184  * channels 0-3 to support 11n aggregation via EDCA DMA channels.
 185  *
 186  * The driver sets up each queue to work in one of two modes:
 187  *
 188  * 1)  Scheduler-Ack, in which the scheduler automatically supports a
 189  *     block-ack (BA) window of up to 64 TFDs.  In this mode, each queue
 190  *     contains TFDs for a unique combination of Recipient Address (RA)
 191  *     and Traffic Identifier (TID), that is, traffic of a given
 192  *     Quality-Of-Service (QOS) priority, destined for a single station.
 193  *
 194  *     In scheduler-ack mode, the scheduler keeps track of the Tx status of
 195  *     each frame within the BA window, including whether it's been transmitted,
 196  *     and whether it's been acknowledged by the receiving station.  The device
 197  *     automatically processes block-acks received from the receiving STA,
 198  *     and reschedules un-acked frames to be retransmitted (successful
 199  *     Tx completion may end up being out-of-order).
 200  *
 201  *     The driver must maintain the queue's Byte Count table in host DRAM
 202  *     for this mode.
 203  *     This mode does not support fragmentation.
 204  *
 205  * 2)  FIFO (a.k.a. non-Scheduler-ACK), in which each TFD is processed in order.
 206  *     The device may automatically retry Tx, but will retry only one frame
 207  *     at a time, until receiving ACK from receiving station, or reaching
 208  *     retry limit and giving up.
 209  *
 210  *     The command queue (#4/#9) must use this mode!
 211  *     This mode does not require use of the Byte Count table in host DRAM.
 212  *
 213  * Driver controls scheduler operation via 3 means:
 214  * 1)  Scheduler registers
 215  * 2)  Shared scheduler data base in internal SRAM
 216  * 3)  Shared data in host DRAM
 217  *
 218  * Initialization:
 219  *
 220  * When loading, driver should allocate memory for:
 221  * 1)  16 TFD circular buffers, each with space for (typically) 256 TFDs.
 222  * 2)  16 Byte Count circular buffers in 16 KBytes contiguous memory
 223  *     (1024 bytes for each queue).
 224  *
 225  * After receiving "Alive" response from uCode, driver must initialize
 226  * the scheduler (especially for queue #4/#9, the command queue, otherwise
 227  * the driver can't issue commands!):
 228  */
 229 #define SCD_MEM_LOWER_BOUND             (0x0000)
 230
 231 /**
 232  * Max Tx window size is the max number of contiguous TFDs that the scheduler
 233  * can keep track of at one time when creating block-ack chains of frames.
 234  * Note that "64" matches the number of ack bits in a block-ack packet.
 235  */
 236 #define SCD_WIN_SIZE                            64
 237 #define SCD_FRAME_LIMIT                         64
 238
 239 #define SCD_TXFIFO_POS_TID                      (0)
 240 #define SCD_TXFIFO_POS_RA                       (4)
 241 #define SCD_QUEUE_RA_TID_MAP_RATID_MSK  (0x01FF)
 242
 243 /* agn SCD */
 244 #define SCD_QUEUE_STTS_REG_POS_TXF      (0)
 245 #define SCD_QUEUE_STTS_REG_POS_ACTIVE   (3)
 246 #define SCD_QUEUE_STTS_REG_POS_WSL      (4)
 247 #define SCD_QUEUE_STTS_REG_POS_SCD_ACT_EN (19)
 248 #define SCD_QUEUE_STTS_REG_MSK          (0x017F0000)
 249
 250 #define SCD_QUEUE_CTX_REG1_CREDIT_POS           (8)
 251 #define SCD_QUEUE_CTX_REG1_CREDIT_MSK           (0x00FFFF00)
 252 #define SCD_QUEUE_CTX_REG1_SUPER_CREDIT_POS     (24)
 253 #define SCD_QUEUE_CTX_REG1_SUPER_CREDIT_MSK     (0xFF000000)
 254 #define SCD_QUEUE_CTX_REG2_WIN_SIZE_POS         (0)
 255 #define SCD_QUEUE_CTX_REG2_WIN_SIZE_MSK         (0x0000007F)
 256 #define SCD_QUEUE_CTX_REG2_FRAME_LIMIT_POS      (16)
 257 #define SCD_QUEUE_CTX_REG2_FRAME_LIMIT_MSK      (0x007F0000)
 258 #define SCD_GP_CTRL_ENABLE_31_QUEUES            BIT(0)
 259 #define SCD_GP_CTRL_AUTO_ACTIVE_MODE            BIT(18)
 260
 261 /* Context Data */
 262 #define SCD_CONTEXT_MEM_LOWER_BOUND     (SCD_MEM_LOWER_BOUND + 0x600)
 263 #define SCD_CONTEXT_MEM_UPPER_BOUND     (SCD_MEM_LOWER_BOUND + 0x6A0)
 264
 265 /* Tx status */
 266 #define SCD_TX_STTS_MEM_LOWER_BOUND     (SCD_MEM_LOWER_BOUND + 0x6A0)
 267 #define SCD_TX_STTS_MEM_UPPER_BOUND     (SCD_MEM_LOWER_BOUND + 0x7E0)
 268
 269 /* Translation Data */
 270 #define SCD_TRANS_TBL_MEM_LOWER_BOUND   (SCD_MEM_LOWER_BOUND + 0x7E0)
 271 #define SCD_TRANS_TBL_MEM_UPPER_BOUND   (SCD_MEM_LOWER_BOUND + 0x808)
 272
 273 #define SCD_CONTEXT_QUEUE_OFFSET(x)\
 274         (SCD_CONTEXT_MEM_LOWER_BOUND + ((x) * 8))
 275
 276 #define SCD_TX_STTS_QUEUE_OFFSET(x)\
 277         (SCD_TX_STTS_MEM_LOWER_BOUND + ((x) * 16))
 278
 279 #define SCD_TRANS_TBL_OFFSET_QUEUE(x) \
 280         ((SCD_TRANS_TBL_MEM_LOWER_BOUND + ((x) * 2)) & 0xfffc)
 281
 282 #define SCD_BASE                        (PRPH_BASE + 0xa02c00)
 283
 284 #define SCD_SRAM_BASE_ADDR      (SCD_BASE + 0x0)
 285 #define SCD_DRAM_BASE_ADDR      (SCD_BASE + 0x8)
 286 #define SCD_AIT                 (SCD_BASE + 0x0c)
 287 #define SCD_TXFACT              (SCD_BASE + 0x10)
 288 #define SCD_ACTIVE              (SCD_BASE + 0x14)
 289 #define SCD_QUEUECHAIN_SEL      (SCD_BASE + 0xe8)
 290 #define SCD_CHAINEXT_EN         (SCD_BASE + 0x244)
 291 #define SCD_AGGR_SEL            (SCD_BASE + 0x248)
 292 #define SCD_INTERRUPT_MASK      (SCD_BASE + 0x108)
 293 #define SCD_GP_CTRL             (SCD_BASE + 0x1a8)
 294 #define SCD_EN_CTRL             (SCD_BASE + 0x254)
 295
 296 /*********************** END TX SCHEDULER *************************************/
 297
 298 /* Oscillator clock */
 299 #define OSC_CLK                         (0xa04068)
 300 #define OSC_CLK_FORCE_CONTROL           (0x8)
 301
 302 #define FH_UCODE_LOAD_STATUS            (0x1AF0)
 303
 304 /*
 305  * Replacing FH_UCODE_LOAD_STATUS
 306  * This register is writen by driver and is read by uCode during boot flow.
 307  * Note this address is cleared after MAC reset.
 308  */
 309 #define UREG_UCODE_LOAD_STATUS          (0xa05c40)
 310 #define UREG_CPU_INIT_RUN               (0xa05c44)
 311
 312 #define LMPM_SECURE_UCODE_LOAD_CPU1_HDR_ADDR    (0x1E78)
 313 #define LMPM_SECURE_UCODE_LOAD_CPU2_HDR_ADDR    (0x1E7C)
 314
 315 #define LMPM_SECURE_CPU1_HDR_MEM_SPACE          (0x420000)
 316 #define LMPM_SECURE_CPU2_HDR_MEM_SPACE          (0x420400)
 317
 318 #define LMAC2_PRPH_OFFSET               (0x100000)
 319
 320 /* Rx FIFO */
 321 #define RXF_SIZE_ADDR                   (0xa00c88)
 322 #define RXF_RD_D_SPACE                  (0xa00c40)
 323 #define RXF_RD_WR_PTR                   (0xa00c50)
 324 #define RXF_RD_RD_PTR                   (0xa00c54)
 325 #define RXF_RD_FENCE_PTR                (0xa00c4c)
 326 #define RXF_SET_FENCE_MODE              (0xa00c14)
 327 #define RXF_LD_WR2FENCE         (0xa00c1c)
 328 #define RXF_FIFO_RD_FENCE_INC           (0xa00c68)
 329 #define RXF_SIZE_BYTE_CND_POS           (7)
 330 #define RXF_SIZE_BYTE_CNT_MSK           (0x3ff << RXF_SIZE_BYTE_CND_POS)
 331 #define RXF_DIFF_FROM_PREV              (0x200)
 332
 333 #define RXF_LD_FENCE_OFFSET_ADDR        (0xa00c10)
 334 #define RXF_FIFO_RD_FENCE_ADDR          (0xa00c0c)
 335
 336 /* Tx FIFO */
 337 #define TXF_FIFO_ITEM_CNT               (0xa00438)
 338 #define TXF_WR_PTR                      (0xa00414)
 339 #define TXF_RD_PTR                      (0xa00410)
 340 #define TXF_FENCE_PTR                   (0xa00418)
 341 #define TXF_LOCK_FENCE                  (0xa00424)
 342 #define TXF_LARC_NUM                    (0xa0043c)
 343 #define TXF_READ_MODIFY_DATA            (0xa00448)
 344 #define TXF_READ_MODIFY_ADDR            (0xa0044c)
 345
 346 /* UMAC Internal Tx Fifo */
 347 #define TXF_CPU2_FIFO_ITEM_CNT          (0xA00538)
 348 #define TXF_CPU2_WR_PTR         (0xA00514)
 349 #define TXF_CPU2_RD_PTR         (0xA00510)
 350 #define TXF_CPU2_FENCE_PTR              (0xA00518)
 351 #define TXF_CPU2_LOCK_FENCE             (0xA00524)
 352 #define TXF_CPU2_NUM                    (0xA0053C)
 353 #define TXF_CPU2_READ_MODIFY_DATA       (0xA00548)
 354 #define TXF_CPU2_READ_MODIFY_ADDR       (0xA0054C)
 355
 356 /* Radio registers access */
 357 #define RSP_RADIO_CMD                   (0xa02804)
 358 #define RSP_RADIO_RDDAT                 (0xa02814)
 359 #define RADIO_RSP_ADDR_POS              (6)
 360 #define RADIO_RSP_RD_CMD                (3)
 361
 362 /* FW monitor */
 363 #define MON_BUFF_SAMPLE_CTL             (0xa03c00)
 364 #define MON_BUFF_BASE_ADDR              (0xa03c3c)
 365 #define MON_BUFF_END_ADDR               (0xa03c40)
 366 #define MON_BUFF_WRPTR                  (0xa03c44)
 367 #define MON_BUFF_CYCLE_CNT              (0xa03c48)
 368
 369 #define MON_DMARB_RD_CTL_ADDR           (0xa03c60)
 370 #define MON_DMARB_RD_DATA_ADDR          (0xa03c5c)
 371
 372 #define DBGC_IN_SAMPLE                  (0xa03c00)
 373 #define DBGC_OUT_CTRL                   (0xa03c0c)
 374
 375 /* enable the ID buf for read */
 376 #define WFPM_PS_CTL_CLR                 0xA0300C
 377 #define WFMP_MAC_ADDR_0                 0xA03080
 378 #define WFMP_MAC_ADDR_1                 0xA03084
 379 #define LMPM_PMG_EN                     0xA01CEC
 380 #define RADIO_REG_SYS_MANUAL_DFT_0      0xAD4078
 381 #define RFIC_REG_RD                     0xAD0470
 382 #define WFPM_CTRL_REG                   0xA03030
 383 #define WFPM_GP2                        0xA030B4
 384 enum {
 385         ENABLE_WFPM = BIT(31),
 386         WFPM_AUX_CTL_AUX_IF_MAC_OWNER_MSK       = 0x80000000,
 387 };
 388
 389 #define AUX_MISC_REG                    0xA200B0
 390 enum {
 391         HW_STEP_LOCATION_BITS = 24,
 392 };
 393
 394 #define AUX_MISC_MASTER1_EN             0xA20818
 395 enum aux_misc_master1_en {
 396         AUX_MISC_MASTER1_EN_SBE_MSK     = 0x1,
 397 };
 398
 399 #define AUX_MISC_MASTER1_SMPHR_STATUS   0xA20800
 400 #define RSA_ENABLE                      0xA24B08
 401 #define PREG_AUX_BUS_WPROT_0            0xA04CC0
 402 #define SB_CPU_1_STATUS                 0xA01E30
 403 #define SB_CPU_2_STATUS                 0xA01E34
 404 #define UMAG_SB_CPU_1_STATUS            0xA038C0
 405 #define UMAG_SB_CPU_2_STATUS            0xA038C4
 406
 407 /* FW chicken bits */
 408 #define LMPM_CHICK                      0xA01FF8
 409 enum {
 410         LMPM_CHICK_EXTENDED_ADDR_SPACE = BIT(0),
 411 };
 412
 413 /* FW chicken bits */
 414 #define LMPM_PAGE_PASS_NOTIF                    0xA03824
 415 enum {
 416         LMPM_PAGE_PASS_NOTIF_POS = BIT(20),
 417 };
 418
 419 #define UREG_CHICK              (0xA05C00)
 420 #define UREG_CHICK_MSI_ENABLE   BIT(24)
 421 #define UREG_CHICK_MSIX_ENABLE  BIT(25)
 422 #endif                          /* __iwl_prph_h__ */