| /****************************************************************************** |
| * |
| * This file is provided under a dual BSD/GPLv2 license. When using or |
| * redistributing this file, you may do so under either license. |
| * |
| * GPL LICENSE SUMMARY |
| * |
| * Copyright(c) 2005 - 2011 Intel Corporation. All rights reserved. |
| * |
| * This program is free software; you can redistribute it and/or modify |
| * it under the terms of version 2 of the GNU General Public License as |
| * published by the Free Software Foundation. |
| * |
| * This program is distributed in the hope that it will be useful, but |
| * WITHOUT ANY WARRANTY; without even the implied warranty of |
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| * General Public License for more details. |
| * |
| * You should have received a copy of the GNU General Public License |
| * along with this program; if not, write to the Free Software |
| * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, |
| * USA |
| * |
| * The full GNU General Public License is included in this distribution |
| * in the file called LICENSE.GPL. |
| * |
| * Contact Information: |
| * Intel Linux Wireless <ilw@linux.intel.com> |
| * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497 |
| * |
| * BSD LICENSE |
| * |
| * Copyright(c) 2005 - 2011 Intel Corporation. All rights reserved. |
| * All rights reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * |
| * * Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * * Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in |
| * the documentation and/or other materials provided with the |
| * distribution. |
| * * Neither the name Intel Corporation nor the names of its |
| * contributors may be used to endorse or promote products derived |
| * from this software without specific prior written permission. |
| * |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| * |
| *****************************************************************************/ |
| #ifndef __il_csr_h__ |
| #define __il_csr_h__ |
| /* |
| * CSR (control and status registers) |
| * |
| * CSR registers are mapped directly into PCI bus space, and are accessible |
| * whenever platform supplies power to device, even when device is in |
| * low power states due to driver-invoked device resets |
| * (e.g. CSR_RESET_REG_FLAG_SW_RESET) or uCode-driven power-saving modes. |
| * |
| * Use _il_wr() and _il_rd() family to access these registers; |
| * these provide simple PCI bus access, without waking up the MAC. |
| * Do not use il_wr() family for these registers; |
| * no need to "grab nic access" via CSR_GP_CNTRL_REG_FLAG_MAC_ACCESS_REQ. |
| * The MAC (uCode processor, etc.) does not need to be powered up for accessing |
| * the CSR registers. |
| * |
| * NOTE: Device does need to be awake in order to read this memory |
| * via CSR_EEPROM register |
| */ |
| #define CSR_BASE (0x000) |
| |
| #define CSR_HW_IF_CONFIG_REG (CSR_BASE+0x000) /* hardware interface config */ |
| #define CSR_INT_COALESCING (CSR_BASE+0x004) /* accum ints, 32-usec units */ |
| #define CSR_INT (CSR_BASE+0x008) /* host interrupt status/ack */ |
| #define CSR_INT_MASK (CSR_BASE+0x00c) /* host interrupt enable */ |
| #define CSR_FH_INT_STATUS (CSR_BASE+0x010) /* busmaster int status/ack */ |
| #define CSR_GPIO_IN (CSR_BASE+0x018) /* read external chip pins */ |
| #define CSR_RESET (CSR_BASE+0x020) /* busmaster enable, NMI, etc */ |
| #define CSR_GP_CNTRL (CSR_BASE+0x024) |
| |
| /* 2nd byte of CSR_INT_COALESCING, not accessible via _il_wr()! */ |
| #define CSR_INT_PERIODIC_REG (CSR_BASE+0x005) |
| |
| /* |
| * Hardware revision info |
| * Bit fields: |
| * 31-8: Reserved |
| * 7-4: Type of device: see CSR_HW_REV_TYPE_xxx definitions |
| * 3-2: Revision step: 0 = A, 1 = B, 2 = C, 3 = D |
| * 1-0: "Dash" (-) value, as in A-1, etc. |
| * |
| * NOTE: Revision step affects calculation of CCK txpower for 4965. |
| * NOTE: See also CSR_HW_REV_WA_REG (work-around for bug in 4965). |
| */ |
| #define CSR_HW_REV (CSR_BASE+0x028) |
| |
| /* |
| * EEPROM memory reads |
| * |
| * NOTE: Device must be awake, initialized via apm_ops.init(), |
| * in order to read. |
| */ |
| #define CSR_EEPROM_REG (CSR_BASE+0x02c) |
| #define CSR_EEPROM_GP (CSR_BASE+0x030) |
| |
| #define CSR_GIO_REG (CSR_BASE+0x03C) |
| #define CSR_GP_UCODE_REG (CSR_BASE+0x048) |
| #define CSR_GP_DRIVER_REG (CSR_BASE+0x050) |
| |
| /* |
| * UCODE-DRIVER GP (general purpose) mailbox registers. |
| * SET/CLR registers set/clear bit(s) if "1" is written. |
| */ |
| #define CSR_UCODE_DRV_GP1 (CSR_BASE+0x054) |
| #define CSR_UCODE_DRV_GP1_SET (CSR_BASE+0x058) |
| #define CSR_UCODE_DRV_GP1_CLR (CSR_BASE+0x05c) |
| #define CSR_UCODE_DRV_GP2 (CSR_BASE+0x060) |
| |
| #define CSR_LED_REG (CSR_BASE+0x094) |
| #define CSR_DRAM_INT_TBL_REG (CSR_BASE+0x0A0) |
| |
| /* GIO Chicken Bits (PCI Express bus link power management) */ |
| #define CSR_GIO_CHICKEN_BITS (CSR_BASE+0x100) |
| |
| /* Analog phase-lock-loop configuration */ |
| #define CSR_ANA_PLL_CFG (CSR_BASE+0x20c) |
| |
| /* |
| * CSR Hardware Revision Workaround Register. Indicates hardware rev; |
| * "step" determines CCK backoff for txpower calculation. Used for 4965 only. |
| * See also CSR_HW_REV register. |
| * Bit fields: |
| * 3-2: 0 = A, 1 = B, 2 = C, 3 = D step |
| * 1-0: "Dash" (-) value, as in C-1, etc. |
| */ |
| #define CSR_HW_REV_WA_REG (CSR_BASE+0x22C) |
| |
| #define CSR_DBG_HPET_MEM_REG (CSR_BASE+0x240) |
| #define CSR_DBG_LINK_PWR_MGMT_REG (CSR_BASE+0x250) |
| |
| /* Bits for CSR_HW_IF_CONFIG_REG */ |
| #define CSR49_HW_IF_CONFIG_REG_BIT_4965_R (0x00000010) |
| #define CSR_HW_IF_CONFIG_REG_MSK_BOARD_VER (0x00000C00) |
| #define CSR_HW_IF_CONFIG_REG_BIT_MAC_SI (0x00000100) |
| #define CSR_HW_IF_CONFIG_REG_BIT_RADIO_SI (0x00000200) |
| |
| #define CSR39_HW_IF_CONFIG_REG_BIT_3945_MB (0x00000100) |
| #define CSR39_HW_IF_CONFIG_REG_BIT_3945_MM (0x00000200) |
| #define CSR39_HW_IF_CONFIG_REG_BIT_SKU_MRC (0x00000400) |
| #define CSR39_HW_IF_CONFIG_REG_BIT_BOARD_TYPE (0x00000800) |
| #define CSR39_HW_IF_CONFIG_REG_BITS_SILICON_TYPE_A (0x00000000) |
| #define CSR39_HW_IF_CONFIG_REG_BITS_SILICON_TYPE_B (0x00001000) |
| |
| #define CSR_HW_IF_CONFIG_REG_BIT_HAP_WAKE_L1A (0x00080000) |
| #define CSR_HW_IF_CONFIG_REG_BIT_EEPROM_OWN_SEM (0x00200000) |
| #define CSR_HW_IF_CONFIG_REG_BIT_NIC_READY (0x00400000) /* PCI_OWN_SEM */ |
| #define CSR_HW_IF_CONFIG_REG_BIT_NIC_PREPARE_DONE (0x02000000) /* ME_OWN */ |
| #define CSR_HW_IF_CONFIG_REG_PREPARE (0x08000000) /* WAKE_ME */ |
| |
| #define CSR_INT_PERIODIC_DIS (0x00) /* disable periodic int */ |
| #define CSR_INT_PERIODIC_ENA (0xFF) /* 255*32 usec ~ 8 msec */ |
| |
| /* interrupt flags in INTA, set by uCode or hardware (e.g. dma), |
| * acknowledged (reset) by host writing "1" to flagged bits. */ |
| #define CSR_INT_BIT_FH_RX (1 << 31) /* Rx DMA, cmd responses, FH_INT[17:16] */ |
| #define CSR_INT_BIT_HW_ERR (1 << 29) /* DMA hardware error FH_INT[31] */ |
| #define CSR_INT_BIT_RX_PERIODIC (1 << 28) /* Rx periodic */ |
| #define CSR_INT_BIT_FH_TX (1 << 27) /* Tx DMA FH_INT[1:0] */ |
| #define CSR_INT_BIT_SCD (1 << 26) /* TXQ pointer advanced */ |
| #define CSR_INT_BIT_SW_ERR (1 << 25) /* uCode error */ |
| #define CSR_INT_BIT_RF_KILL (1 << 7) /* HW RFKILL switch GP_CNTRL[27] toggled */ |
| #define CSR_INT_BIT_CT_KILL (1 << 6) /* Critical temp (chip too hot) rfkill */ |
| #define CSR_INT_BIT_SW_RX (1 << 3) /* Rx, command responses, 3945 */ |
| #define CSR_INT_BIT_WAKEUP (1 << 1) /* NIC controller waking up (pwr mgmt) */ |
| #define CSR_INT_BIT_ALIVE (1 << 0) /* uCode interrupts once it initializes */ |
| |
| #define CSR_INI_SET_MASK (CSR_INT_BIT_FH_RX | \ |
| CSR_INT_BIT_HW_ERR | \ |
| CSR_INT_BIT_FH_TX | \ |
| CSR_INT_BIT_SW_ERR | \ |
| CSR_INT_BIT_RF_KILL | \ |
| CSR_INT_BIT_SW_RX | \ |
| CSR_INT_BIT_WAKEUP | \ |
| CSR_INT_BIT_ALIVE) |
| |
| /* interrupt flags in FH (flow handler) (PCI busmaster DMA) */ |
| #define CSR_FH_INT_BIT_ERR (1 << 31) /* Error */ |
| #define CSR_FH_INT_BIT_HI_PRIOR (1 << 30) /* High priority Rx, bypass coalescing */ |
| #define CSR39_FH_INT_BIT_RX_CHNL2 (1 << 18) /* Rx channel 2 (3945 only) */ |
| #define CSR_FH_INT_BIT_RX_CHNL1 (1 << 17) /* Rx channel 1 */ |
| #define CSR_FH_INT_BIT_RX_CHNL0 (1 << 16) /* Rx channel 0 */ |
| #define CSR39_FH_INT_BIT_TX_CHNL6 (1 << 6) /* Tx channel 6 (3945 only) */ |
| #define CSR_FH_INT_BIT_TX_CHNL1 (1 << 1) /* Tx channel 1 */ |
| #define CSR_FH_INT_BIT_TX_CHNL0 (1 << 0) /* Tx channel 0 */ |
| |
| #define CSR39_FH_INT_RX_MASK (CSR_FH_INT_BIT_HI_PRIOR | \ |
| CSR39_FH_INT_BIT_RX_CHNL2 | \ |
| CSR_FH_INT_BIT_RX_CHNL1 | \ |
| CSR_FH_INT_BIT_RX_CHNL0) |
| |
| #define CSR39_FH_INT_TX_MASK (CSR39_FH_INT_BIT_TX_CHNL6 | \ |
| CSR_FH_INT_BIT_TX_CHNL1 | \ |
| CSR_FH_INT_BIT_TX_CHNL0) |
| |
| #define CSR49_FH_INT_RX_MASK (CSR_FH_INT_BIT_HI_PRIOR | \ |
| CSR_FH_INT_BIT_RX_CHNL1 | \ |
| CSR_FH_INT_BIT_RX_CHNL0) |
| |
| #define CSR49_FH_INT_TX_MASK (CSR_FH_INT_BIT_TX_CHNL1 | \ |
| CSR_FH_INT_BIT_TX_CHNL0) |
| |
| /* GPIO */ |
| #define CSR_GPIO_IN_BIT_AUX_POWER (0x00000200) |
| #define CSR_GPIO_IN_VAL_VAUX_PWR_SRC (0x00000000) |
| #define CSR_GPIO_IN_VAL_VMAIN_PWR_SRC (0x00000200) |
| |
| /* RESET */ |
| #define CSR_RESET_REG_FLAG_NEVO_RESET (0x00000001) |
| #define CSR_RESET_REG_FLAG_FORCE_NMI (0x00000002) |
| #define CSR_RESET_REG_FLAG_SW_RESET (0x00000080) |
| #define CSR_RESET_REG_FLAG_MASTER_DISABLED (0x00000100) |
| #define CSR_RESET_REG_FLAG_STOP_MASTER (0x00000200) |
| #define CSR_RESET_LINK_PWR_MGMT_DISABLED (0x80000000) |
| |
| /* |
| * GP (general purpose) CONTROL REGISTER |
| * Bit fields: |
| * 27: HW_RF_KILL_SW |
| * Indicates state of (platform's) hardware RF-Kill switch |
| * 26-24: POWER_SAVE_TYPE |
| * Indicates current power-saving mode: |
| * 000 -- No power saving |
| * 001 -- MAC power-down |
| * 010 -- PHY (radio) power-down |
| * 011 -- Error |
| * 9-6: SYS_CONFIG |
| * Indicates current system configuration, reflecting pins on chip |
| * as forced high/low by device circuit board. |
| * 4: GOING_TO_SLEEP |
| * Indicates MAC is entering a power-saving sleep power-down. |
| * Not a good time to access device-internal resources. |
| * 3: MAC_ACCESS_REQ |
| * Host sets this to request and maintain MAC wakeup, to allow host |
| * access to device-internal resources. Host must wait for |
| * MAC_CLOCK_READY (and !GOING_TO_SLEEP) before accessing non-CSR |
| * device registers. |
| * 2: INIT_DONE |
| * Host sets this to put device into fully operational D0 power mode. |
| * Host resets this after SW_RESET to put device into low power mode. |
| * 0: MAC_CLOCK_READY |
| * Indicates MAC (ucode processor, etc.) is powered up and can run. |
| * Internal resources are accessible. |
| * NOTE: This does not indicate that the processor is actually running. |
| * NOTE: This does not indicate that 4965 or 3945 has completed |
| * init or post-power-down restore of internal SRAM memory. |
| * Use CSR_UCODE_DRV_GP1_BIT_MAC_SLEEP as indication that |
| * SRAM is restored and uCode is in normal operation mode. |
| * Later devices (5xxx/6xxx/1xxx) use non-volatile SRAM, and |
| * do not need to save/restore it. |
| * NOTE: After device reset, this bit remains "0" until host sets |
| * INIT_DONE |
| */ |
| #define CSR_GP_CNTRL_REG_FLAG_MAC_CLOCK_READY (0x00000001) |
| #define CSR_GP_CNTRL_REG_FLAG_INIT_DONE (0x00000004) |
| #define CSR_GP_CNTRL_REG_FLAG_MAC_ACCESS_REQ (0x00000008) |
| #define CSR_GP_CNTRL_REG_FLAG_GOING_TO_SLEEP (0x00000010) |
| |
| #define CSR_GP_CNTRL_REG_VAL_MAC_ACCESS_EN (0x00000001) |
| |
| #define CSR_GP_CNTRL_REG_MSK_POWER_SAVE_TYPE (0x07000000) |
| #define CSR_GP_CNTRL_REG_FLAG_MAC_POWER_SAVE (0x04000000) |
| #define CSR_GP_CNTRL_REG_FLAG_HW_RF_KILL_SW (0x08000000) |
| |
| /* EEPROM REG */ |
| #define CSR_EEPROM_REG_READ_VALID_MSK (0x00000001) |
| #define CSR_EEPROM_REG_BIT_CMD (0x00000002) |
| #define CSR_EEPROM_REG_MSK_ADDR (0x0000FFFC) |
| #define CSR_EEPROM_REG_MSK_DATA (0xFFFF0000) |
| |
| /* EEPROM GP */ |
| #define CSR_EEPROM_GP_VALID_MSK (0x00000007) /* signature */ |
| #define CSR_EEPROM_GP_IF_OWNER_MSK (0x00000180) |
| #define CSR_EEPROM_GP_GOOD_SIG_EEP_LESS_THAN_4K (0x00000002) |
| #define CSR_EEPROM_GP_GOOD_SIG_EEP_MORE_THAN_4K (0x00000004) |
| |
| /* GP REG */ |
| #define CSR_GP_REG_POWER_SAVE_STATUS_MSK (0x03000000) /* bit 24/25 */ |
| #define CSR_GP_REG_NO_POWER_SAVE (0x00000000) |
| #define CSR_GP_REG_MAC_POWER_SAVE (0x01000000) |
| #define CSR_GP_REG_PHY_POWER_SAVE (0x02000000) |
| #define CSR_GP_REG_POWER_SAVE_ERROR (0x03000000) |
| |
| /* CSR GIO */ |
| #define CSR_GIO_REG_VAL_L0S_ENABLED (0x00000002) |
| |
| /* |
| * UCODE-DRIVER GP (general purpose) mailbox register 1 |
| * Host driver and uCode write and/or read this register to communicate with |
| * each other. |
| * Bit fields: |
| * 4: UCODE_DISABLE |
| * Host sets this to request permanent halt of uCode, same as |
| * sending CARD_STATE command with "halt" bit set. |
| * 3: CT_KILL_EXIT |
| * Host sets this to request exit from CT_KILL state, i.e. host thinks |
| * device temperature is low enough to continue normal operation. |
| * 2: CMD_BLOCKED |
| * Host sets this during RF KILL power-down sequence (HW, SW, CT KILL) |
| * to release uCode to clear all Tx and command queues, enter |
| * unassociated mode, and power down. |
| * NOTE: Some devices also use HBUS_TARG_MBX_C register for this bit. |
| * 1: SW_BIT_RFKILL |
| * Host sets this when issuing CARD_STATE command to request |
| * device sleep. |
| * 0: MAC_SLEEP |
| * uCode sets this when preparing a power-saving power-down. |
| * uCode resets this when power-up is complete and SRAM is sane. |
| * NOTE: 3945/4965 saves internal SRAM data to host when powering down, |
| * and must restore this data after powering back up. |
| * MAC_SLEEP is the best indication that restore is complete. |
| * Later devices (5xxx/6xxx/1xxx) use non-volatile SRAM, and |
| * do not need to save/restore it. |
| */ |
| #define CSR_UCODE_DRV_GP1_BIT_MAC_SLEEP (0x00000001) |
| #define CSR_UCODE_SW_BIT_RFKILL (0x00000002) |
| #define CSR_UCODE_DRV_GP1_BIT_CMD_BLOCKED (0x00000004) |
| #define CSR_UCODE_DRV_GP1_REG_BIT_CT_KILL_EXIT (0x00000008) |
| |
| /* GIO Chicken Bits (PCI Express bus link power management) */ |
| #define CSR_GIO_CHICKEN_BITS_REG_BIT_L1A_NO_L0S_RX (0x00800000) |
| #define CSR_GIO_CHICKEN_BITS_REG_BIT_DIS_L0S_EXIT_TIMER (0x20000000) |
| |
| /* LED */ |
| #define CSR_LED_BSM_CTRL_MSK (0xFFFFFFDF) |
| #define CSR_LED_REG_TRUN_ON (0x78) |
| #define CSR_LED_REG_TRUN_OFF (0x38) |
| |
| /* ANA_PLL */ |
| #define CSR39_ANA_PLL_CFG_VAL (0x01000000) |
| |
| /* HPET MEM debug */ |
| #define CSR_DBG_HPET_MEM_REG_VAL (0xFFFF0000) |
| |
| /* DRAM INT TBL */ |
| #define CSR_DRAM_INT_TBL_ENABLE (1 << 31) |
| #define CSR_DRAM_INIT_TBL_WRAP_CHECK (1 << 27) |
| |
| /* |
| * HBUS (Host-side Bus) |
| * |
| * HBUS registers are mapped directly into PCI bus space, but are used |
| * to indirectly access device's internal memory or registers that |
| * may be powered-down. |
| * |
| * Use il_wr()/il_rd() family |
| * for these registers; |
| * host must "grab nic access" via CSR_GP_CNTRL_REG_FLAG_MAC_ACCESS_REQ |
| * to make sure the MAC (uCode processor, etc.) is powered up for accessing |
| * internal resources. |
| * |
| * Do not use _il_wr()/_il_rd() family to access these registers; |
| * these provide only simple PCI bus access, without waking up the MAC. |
| */ |
| #define HBUS_BASE (0x400) |
| |
| /* |
| * Registers for accessing device's internal SRAM memory (e.g. SCD SRAM |
| * structures, error log, event log, verifying uCode load). |
| * First write to address register, then read from or write to data register |
| * to complete the job. Once the address register is set up, accesses to |
| * data registers auto-increment the address by one dword. |
| * Bit usage for address registers (read or write): |
| * 0-31: memory address within device |
| */ |
| #define HBUS_TARG_MEM_RADDR (HBUS_BASE+0x00c) |
| #define HBUS_TARG_MEM_WADDR (HBUS_BASE+0x010) |
| #define HBUS_TARG_MEM_WDAT (HBUS_BASE+0x018) |
| #define HBUS_TARG_MEM_RDAT (HBUS_BASE+0x01c) |
| |
| /* Mailbox C, used as workaround alternative to CSR_UCODE_DRV_GP1 mailbox */ |
| #define HBUS_TARG_MBX_C (HBUS_BASE+0x030) |
| #define HBUS_TARG_MBX_C_REG_BIT_CMD_BLOCKED (0x00000004) |
| |
| /* |
| * Registers for accessing device's internal peripheral registers |
| * (e.g. SCD, BSM, etc.). First write to address register, |
| * then read from or write to data register to complete the job. |
| * Bit usage for address registers (read or write): |
| * 0-15: register address (offset) within device |
| * 24-25: (# bytes - 1) to read or write (e.g. 3 for dword) |
| */ |
| #define HBUS_TARG_PRPH_WADDR (HBUS_BASE+0x044) |
| #define HBUS_TARG_PRPH_RADDR (HBUS_BASE+0x048) |
| #define HBUS_TARG_PRPH_WDAT (HBUS_BASE+0x04c) |
| #define HBUS_TARG_PRPH_RDAT (HBUS_BASE+0x050) |
| |
| /* |
| * Per-Tx-queue write pointer (idx, really!) |
| * Indicates idx to next TFD that driver will fill (1 past latest filled). |
| * Bit usage: |
| * 0-7: queue write idx |
| * 11-8: queue selector |
| */ |
| #define HBUS_TARG_WRPTR (HBUS_BASE+0x060) |
| |
| #endif /* !__il_csr_h__ */ |
