ath10k: add support for 10.2 firmware
[cascardo/linux.git] / drivers / net / wireless / ath / ath10k / hw.h
1 /*
2  * Copyright (c) 2005-2011 Atheros Communications Inc.
3  * Copyright (c) 2011-2013 Qualcomm Atheros, Inc.
4  *
5  * Permission to use, copy, modify, and/or distribute this software for any
6  * purpose with or without fee is hereby granted, provided that the above
7  * copyright notice and this permission notice appear in all copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16  */
17
18 #ifndef _HW_H_
19 #define _HW_H_
20
21 #include "targaddrs.h"
22
23 /* QCA988X 1.0 definitions (unsupported) */
24 #define QCA988X_HW_1_0_CHIP_ID_REV      0x0
25
26 /* QCA988X 2.0 definitions */
27 #define QCA988X_HW_2_0_VERSION          0x4100016c
28 #define QCA988X_HW_2_0_CHIP_ID_REV      0x2
29 #define QCA988X_HW_2_0_FW_DIR           "ath10k/QCA988X/hw2.0"
30 #define QCA988X_HW_2_0_FW_FILE          "firmware.bin"
31 #define QCA988X_HW_2_0_FW_3_FILE        "firmware-3.bin"
32 #define QCA988X_HW_2_0_OTP_FILE         "otp.bin"
33 #define QCA988X_HW_2_0_BOARD_DATA_FILE  "board.bin"
34 #define QCA988X_HW_2_0_PATCH_LOAD_ADDR  0x1234
35
36 #define ATH10K_FW_API2_FILE             "firmware-2.bin"
37 #define ATH10K_FW_API3_FILE             "firmware-3.bin"
38
39 /* includes also the null byte */
40 #define ATH10K_FIRMWARE_MAGIC               "QCA-ATH10K"
41
42 struct ath10k_fw_ie {
43         __le32 id;
44         __le32 len;
45         u8 data[0];
46 };
47
48 enum ath10k_fw_ie_type {
49         ATH10K_FW_IE_FW_VERSION = 0,
50         ATH10K_FW_IE_TIMESTAMP = 1,
51         ATH10K_FW_IE_FEATURES = 2,
52         ATH10K_FW_IE_FW_IMAGE = 3,
53         ATH10K_FW_IE_OTP_IMAGE = 4,
54 };
55
56 /* Known pecularities:
57  *  - current FW doesn't support raw rx mode (last tested v599)
58  *  - current FW dumps upon raw tx mode (last tested v599)
59  *  - raw appears in nwifi decap, raw and nwifi appear in ethernet decap
60  *  - raw have FCS, nwifi doesn't
61  *  - ethernet frames have 802.11 header decapped and parts (base hdr, cipher
62  *    param, llc/snap) are aligned to 4byte boundaries each */
63 enum ath10k_hw_txrx_mode {
64         ATH10K_HW_TXRX_RAW = 0,
65         ATH10K_HW_TXRX_NATIVE_WIFI = 1,
66         ATH10K_HW_TXRX_ETHERNET = 2,
67
68         /* Valid for HTT >= 3.0. Used for management frames in TX_FRM. */
69         ATH10K_HW_TXRX_MGMT = 3,
70 };
71
72 enum ath10k_mcast2ucast_mode {
73         ATH10K_MCAST2UCAST_DISABLED = 0,
74         ATH10K_MCAST2UCAST_ENABLED = 1,
75 };
76
77 /* Target specific defines for MAIN firmware */
78 #define TARGET_NUM_VDEVS                        8
79 #define TARGET_NUM_PEER_AST                     2
80 #define TARGET_NUM_WDS_ENTRIES                  32
81 #define TARGET_DMA_BURST_SIZE                   0
82 #define TARGET_MAC_AGGR_DELIM                   0
83 #define TARGET_AST_SKID_LIMIT                   16
84 #define TARGET_NUM_PEERS                        16
85 #define TARGET_NUM_OFFLOAD_PEERS                0
86 #define TARGET_NUM_OFFLOAD_REORDER_BUFS         0
87 #define TARGET_NUM_PEER_KEYS                    2
88 #define TARGET_NUM_TIDS         (2 * ((TARGET_NUM_PEERS) + (TARGET_NUM_VDEVS)))
89 #define TARGET_TX_CHAIN_MASK                    (BIT(0) | BIT(1) | BIT(2))
90 #define TARGET_RX_CHAIN_MASK                    (BIT(0) | BIT(1) | BIT(2))
91 #define TARGET_RX_TIMEOUT_LO_PRI                100
92 #define TARGET_RX_TIMEOUT_HI_PRI                40
93
94 /* Native Wifi decap mode is used to align IP frames to 4-byte boundaries and
95  * avoid a very expensive re-alignment in mac80211. */
96 #define TARGET_RX_DECAP_MODE                    ATH10K_HW_TXRX_NATIVE_WIFI
97
98 #define TARGET_SCAN_MAX_PENDING_REQS            4
99 #define TARGET_BMISS_OFFLOAD_MAX_VDEV           3
100 #define TARGET_ROAM_OFFLOAD_MAX_VDEV            3
101 #define TARGET_ROAM_OFFLOAD_MAX_AP_PROFILES     8
102 #define TARGET_GTK_OFFLOAD_MAX_VDEV             3
103 #define TARGET_NUM_MCAST_GROUPS                 0
104 #define TARGET_NUM_MCAST_TABLE_ELEMS            0
105 #define TARGET_MCAST2UCAST_MODE                 ATH10K_MCAST2UCAST_DISABLED
106 #define TARGET_TX_DBG_LOG_SIZE                  1024
107 #define TARGET_RX_SKIP_DEFRAG_TIMEOUT_DUP_DETECTION_CHECK 0
108 #define TARGET_VOW_CONFIG                       0
109 #define TARGET_NUM_MSDU_DESC                    (1024 + 400)
110 #define TARGET_MAX_FRAG_ENTRIES                 0
111
112 /* Target specific defines for 10.X firmware */
113 #define TARGET_10X_NUM_VDEVS                    16
114 #define TARGET_10X_NUM_PEER_AST                 2
115 #define TARGET_10X_NUM_WDS_ENTRIES              32
116 #define TARGET_10X_DMA_BURST_SIZE               0
117 #define TARGET_10X_MAC_AGGR_DELIM               0
118 #define TARGET_10X_AST_SKID_LIMIT               16
119 #define TARGET_10X_NUM_PEERS                    (128 + (TARGET_10X_NUM_VDEVS))
120 #define TARGET_10X_NUM_PEERS_MAX                128
121 #define TARGET_10X_NUM_OFFLOAD_PEERS            0
122 #define TARGET_10X_NUM_OFFLOAD_REORDER_BUFS     0
123 #define TARGET_10X_NUM_PEER_KEYS                2
124 #define TARGET_10X_NUM_TIDS                     256
125 #define TARGET_10X_TX_CHAIN_MASK                (BIT(0) | BIT(1) | BIT(2))
126 #define TARGET_10X_RX_CHAIN_MASK                (BIT(0) | BIT(1) | BIT(2))
127 #define TARGET_10X_RX_TIMEOUT_LO_PRI            100
128 #define TARGET_10X_RX_TIMEOUT_HI_PRI            40
129 #define TARGET_10X_RX_DECAP_MODE                ATH10K_HW_TXRX_NATIVE_WIFI
130 #define TARGET_10X_SCAN_MAX_PENDING_REQS        4
131 #define TARGET_10X_BMISS_OFFLOAD_MAX_VDEV       2
132 #define TARGET_10X_ROAM_OFFLOAD_MAX_VDEV        2
133 #define TARGET_10X_ROAM_OFFLOAD_MAX_AP_PROFILES 8
134 #define TARGET_10X_GTK_OFFLOAD_MAX_VDEV         3
135 #define TARGET_10X_NUM_MCAST_GROUPS             0
136 #define TARGET_10X_NUM_MCAST_TABLE_ELEMS        0
137 #define TARGET_10X_MCAST2UCAST_MODE             ATH10K_MCAST2UCAST_DISABLED
138 #define TARGET_10X_TX_DBG_LOG_SIZE              1024
139 #define TARGET_10X_RX_SKIP_DEFRAG_TIMEOUT_DUP_DETECTION_CHECK 1
140 #define TARGET_10X_VOW_CONFIG                   0
141 #define TARGET_10X_NUM_MSDU_DESC                (1024 + 400)
142 #define TARGET_10X_MAX_FRAG_ENTRIES             0
143
144 /* Number of Copy Engines supported */
145 #define CE_COUNT 8
146
147 /*
148  * Total number of PCIe MSI interrupts requested for all interrupt sources.
149  * PCIe standard forces this to be a power of 2.
150  * Some Host OS's limit MSI requests that can be granted to 8
151  * so for now we abide by this limit and avoid requesting more
152  * than that.
153  */
154 #define MSI_NUM_REQUEST_LOG2    3
155 #define MSI_NUM_REQUEST         (1<<MSI_NUM_REQUEST_LOG2)
156
157 /*
158  * Granted MSIs are assigned as follows:
159  * Firmware uses the first
160  * Remaining MSIs, if any, are used by Copy Engines
161  * This mapping is known to both Target firmware and Host software.
162  * It may be changed as long as Host and Target are kept in sync.
163  */
164 /* MSI for firmware (errors, etc.) */
165 #define MSI_ASSIGN_FW           0
166
167 /* MSIs for Copy Engines */
168 #define MSI_ASSIGN_CE_INITIAL   1
169 #define MSI_ASSIGN_CE_MAX       7
170
171 /* as of IP3.7.1 */
172 #define RTC_STATE_V_ON                          3
173
174 #define RTC_STATE_COLD_RESET_MASK               0x00000400
175 #define RTC_STATE_V_LSB                         0
176 #define RTC_STATE_V_MASK                        0x00000007
177 #define RTC_STATE_ADDRESS                       0x0000
178 #define PCIE_SOC_WAKE_V_MASK                    0x00000001
179 #define PCIE_SOC_WAKE_ADDRESS                   0x0004
180 #define PCIE_SOC_WAKE_RESET                     0x00000000
181 #define SOC_GLOBAL_RESET_ADDRESS                0x0008
182
183 #define RTC_SOC_BASE_ADDRESS                    0x00004000
184 #define RTC_WMAC_BASE_ADDRESS                   0x00005000
185 #define MAC_COEX_BASE_ADDRESS                   0x00006000
186 #define BT_COEX_BASE_ADDRESS                    0x00007000
187 #define SOC_PCIE_BASE_ADDRESS                   0x00008000
188 #define SOC_CORE_BASE_ADDRESS                   0x00009000
189 #define WLAN_UART_BASE_ADDRESS                  0x0000c000
190 #define WLAN_SI_BASE_ADDRESS                    0x00010000
191 #define WLAN_GPIO_BASE_ADDRESS                  0x00014000
192 #define WLAN_ANALOG_INTF_BASE_ADDRESS           0x0001c000
193 #define WLAN_MAC_BASE_ADDRESS                   0x00020000
194 #define EFUSE_BASE_ADDRESS                      0x00030000
195 #define FPGA_REG_BASE_ADDRESS                   0x00039000
196 #define WLAN_UART2_BASE_ADDRESS                 0x00054c00
197 #define CE_WRAPPER_BASE_ADDRESS                 0x00057000
198 #define CE0_BASE_ADDRESS                        0x00057400
199 #define CE1_BASE_ADDRESS                        0x00057800
200 #define CE2_BASE_ADDRESS                        0x00057c00
201 #define CE3_BASE_ADDRESS                        0x00058000
202 #define CE4_BASE_ADDRESS                        0x00058400
203 #define CE5_BASE_ADDRESS                        0x00058800
204 #define CE6_BASE_ADDRESS                        0x00058c00
205 #define CE7_BASE_ADDRESS                        0x00059000
206 #define DBI_BASE_ADDRESS                        0x00060000
207 #define WLAN_ANALOG_INTF_PCIE_BASE_ADDRESS      0x0006c000
208 #define PCIE_LOCAL_BASE_ADDRESS                 0x00080000
209
210 #define SOC_RESET_CONTROL_ADDRESS               0x00000000
211 #define SOC_RESET_CONTROL_OFFSET                0x00000000
212 #define SOC_RESET_CONTROL_SI0_RST_MASK          0x00000001
213 #define SOC_RESET_CONTROL_CE_RST_MASK           0x00040000
214 #define SOC_RESET_CONTROL_CPU_WARM_RST_MASK     0x00000040
215 #define SOC_CPU_CLOCK_OFFSET                    0x00000020
216 #define SOC_CPU_CLOCK_STANDARD_LSB              0
217 #define SOC_CPU_CLOCK_STANDARD_MASK             0x00000003
218 #define SOC_CLOCK_CONTROL_OFFSET                0x00000028
219 #define SOC_CLOCK_CONTROL_SI0_CLK_MASK          0x00000001
220 #define SOC_SYSTEM_SLEEP_OFFSET                 0x000000c4
221 #define SOC_LPO_CAL_OFFSET                      0x000000e0
222 #define SOC_LPO_CAL_ENABLE_LSB                  20
223 #define SOC_LPO_CAL_ENABLE_MASK                 0x00100000
224 #define SOC_LF_TIMER_CONTROL0_ADDRESS           0x00000050
225 #define SOC_LF_TIMER_CONTROL0_ENABLE_MASK       0x00000004
226
227 #define SOC_CHIP_ID_ADDRESS                     0x000000ec
228 #define SOC_CHIP_ID_REV_LSB                     8
229 #define SOC_CHIP_ID_REV_MASK                    0x00000f00
230
231 #define WLAN_RESET_CONTROL_COLD_RST_MASK        0x00000008
232 #define WLAN_RESET_CONTROL_WARM_RST_MASK        0x00000004
233 #define WLAN_SYSTEM_SLEEP_DISABLE_LSB           0
234 #define WLAN_SYSTEM_SLEEP_DISABLE_MASK          0x00000001
235
236 #define WLAN_GPIO_PIN0_ADDRESS                  0x00000028
237 #define WLAN_GPIO_PIN0_CONFIG_MASK              0x00007800
238 #define WLAN_GPIO_PIN1_ADDRESS                  0x0000002c
239 #define WLAN_GPIO_PIN1_CONFIG_MASK              0x00007800
240 #define WLAN_GPIO_PIN10_ADDRESS                 0x00000050
241 #define WLAN_GPIO_PIN11_ADDRESS                 0x00000054
242 #define WLAN_GPIO_PIN12_ADDRESS                 0x00000058
243 #define WLAN_GPIO_PIN13_ADDRESS                 0x0000005c
244
245 #define CLOCK_GPIO_OFFSET                       0xffffffff
246 #define CLOCK_GPIO_BT_CLK_OUT_EN_LSB            0
247 #define CLOCK_GPIO_BT_CLK_OUT_EN_MASK           0
248
249 #define SI_CONFIG_OFFSET                        0x00000000
250 #define SI_CONFIG_BIDIR_OD_DATA_LSB             18
251 #define SI_CONFIG_BIDIR_OD_DATA_MASK            0x00040000
252 #define SI_CONFIG_I2C_LSB                       16
253 #define SI_CONFIG_I2C_MASK                      0x00010000
254 #define SI_CONFIG_POS_SAMPLE_LSB                7
255 #define SI_CONFIG_POS_SAMPLE_MASK               0x00000080
256 #define SI_CONFIG_INACTIVE_DATA_LSB             5
257 #define SI_CONFIG_INACTIVE_DATA_MASK            0x00000020
258 #define SI_CONFIG_INACTIVE_CLK_LSB              4
259 #define SI_CONFIG_INACTIVE_CLK_MASK             0x00000010
260 #define SI_CONFIG_DIVIDER_LSB                   0
261 #define SI_CONFIG_DIVIDER_MASK                  0x0000000f
262 #define SI_CS_OFFSET                            0x00000004
263 #define SI_CS_DONE_ERR_MASK                     0x00000400
264 #define SI_CS_DONE_INT_MASK                     0x00000200
265 #define SI_CS_START_LSB                         8
266 #define SI_CS_START_MASK                        0x00000100
267 #define SI_CS_RX_CNT_LSB                        4
268 #define SI_CS_RX_CNT_MASK                       0x000000f0
269 #define SI_CS_TX_CNT_LSB                        0
270 #define SI_CS_TX_CNT_MASK                       0x0000000f
271
272 #define SI_TX_DATA0_OFFSET                      0x00000008
273 #define SI_TX_DATA1_OFFSET                      0x0000000c
274 #define SI_RX_DATA0_OFFSET                      0x00000010
275 #define SI_RX_DATA1_OFFSET                      0x00000014
276
277 #define CORE_CTRL_CPU_INTR_MASK                 0x00002000
278 #define CORE_CTRL_ADDRESS                       0x0000
279 #define PCIE_INTR_ENABLE_ADDRESS                0x0008
280 #define PCIE_INTR_CAUSE_ADDRESS                 0x000c
281 #define PCIE_INTR_CLR_ADDRESS                   0x0014
282 #define SCRATCH_3_ADDRESS                       0x0030
283 #define CPU_INTR_ADDRESS                        0x0010
284
285 /* Firmware indications to the Host via SCRATCH_3 register. */
286 #define FW_INDICATOR_ADDRESS    (SOC_CORE_BASE_ADDRESS + SCRATCH_3_ADDRESS)
287 #define FW_IND_EVENT_PENDING                    1
288 #define FW_IND_INITIALIZED                      2
289
290 /* HOST_REG interrupt from firmware */
291 #define PCIE_INTR_FIRMWARE_MASK                 0x00000400
292 #define PCIE_INTR_CE_MASK_ALL                   0x0007f800
293
294 #define DRAM_BASE_ADDRESS                       0x00400000
295
296 #define MISSING 0
297
298 #define SYSTEM_SLEEP_OFFSET                     SOC_SYSTEM_SLEEP_OFFSET
299 #define WLAN_SYSTEM_SLEEP_OFFSET                SOC_SYSTEM_SLEEP_OFFSET
300 #define WLAN_RESET_CONTROL_OFFSET               SOC_RESET_CONTROL_OFFSET
301 #define CLOCK_CONTROL_OFFSET                    SOC_CLOCK_CONTROL_OFFSET
302 #define CLOCK_CONTROL_SI0_CLK_MASK              SOC_CLOCK_CONTROL_SI0_CLK_MASK
303 #define RESET_CONTROL_MBOX_RST_MASK             MISSING
304 #define RESET_CONTROL_SI0_RST_MASK              SOC_RESET_CONTROL_SI0_RST_MASK
305 #define GPIO_BASE_ADDRESS                       WLAN_GPIO_BASE_ADDRESS
306 #define GPIO_PIN0_OFFSET                        WLAN_GPIO_PIN0_ADDRESS
307 #define GPIO_PIN1_OFFSET                        WLAN_GPIO_PIN1_ADDRESS
308 #define GPIO_PIN0_CONFIG_MASK                   WLAN_GPIO_PIN0_CONFIG_MASK
309 #define GPIO_PIN1_CONFIG_MASK                   WLAN_GPIO_PIN1_CONFIG_MASK
310 #define SI_BASE_ADDRESS                         WLAN_SI_BASE_ADDRESS
311 #define SCRATCH_BASE_ADDRESS                    SOC_CORE_BASE_ADDRESS
312 #define LOCAL_SCRATCH_OFFSET                    0x18
313 #define CPU_CLOCK_OFFSET                        SOC_CPU_CLOCK_OFFSET
314 #define LPO_CAL_OFFSET                          SOC_LPO_CAL_OFFSET
315 #define GPIO_PIN10_OFFSET                       WLAN_GPIO_PIN10_ADDRESS
316 #define GPIO_PIN11_OFFSET                       WLAN_GPIO_PIN11_ADDRESS
317 #define GPIO_PIN12_OFFSET                       WLAN_GPIO_PIN12_ADDRESS
318 #define GPIO_PIN13_OFFSET                       WLAN_GPIO_PIN13_ADDRESS
319 #define CPU_CLOCK_STANDARD_LSB                  SOC_CPU_CLOCK_STANDARD_LSB
320 #define CPU_CLOCK_STANDARD_MASK                 SOC_CPU_CLOCK_STANDARD_MASK
321 #define LPO_CAL_ENABLE_LSB                      SOC_LPO_CAL_ENABLE_LSB
322 #define LPO_CAL_ENABLE_MASK                     SOC_LPO_CAL_ENABLE_MASK
323 #define ANALOG_INTF_BASE_ADDRESS                WLAN_ANALOG_INTF_BASE_ADDRESS
324 #define MBOX_BASE_ADDRESS                       MISSING
325 #define INT_STATUS_ENABLE_ERROR_LSB             MISSING
326 #define INT_STATUS_ENABLE_ERROR_MASK            MISSING
327 #define INT_STATUS_ENABLE_CPU_LSB               MISSING
328 #define INT_STATUS_ENABLE_CPU_MASK              MISSING
329 #define INT_STATUS_ENABLE_COUNTER_LSB           MISSING
330 #define INT_STATUS_ENABLE_COUNTER_MASK          MISSING
331 #define INT_STATUS_ENABLE_MBOX_DATA_LSB         MISSING
332 #define INT_STATUS_ENABLE_MBOX_DATA_MASK        MISSING
333 #define ERROR_STATUS_ENABLE_RX_UNDERFLOW_LSB    MISSING
334 #define ERROR_STATUS_ENABLE_RX_UNDERFLOW_MASK   MISSING
335 #define ERROR_STATUS_ENABLE_TX_OVERFLOW_LSB     MISSING
336 #define ERROR_STATUS_ENABLE_TX_OVERFLOW_MASK    MISSING
337 #define COUNTER_INT_STATUS_ENABLE_BIT_LSB       MISSING
338 #define COUNTER_INT_STATUS_ENABLE_BIT_MASK      MISSING
339 #define INT_STATUS_ENABLE_ADDRESS               MISSING
340 #define CPU_INT_STATUS_ENABLE_BIT_LSB           MISSING
341 #define CPU_INT_STATUS_ENABLE_BIT_MASK          MISSING
342 #define HOST_INT_STATUS_ADDRESS                 MISSING
343 #define CPU_INT_STATUS_ADDRESS                  MISSING
344 #define ERROR_INT_STATUS_ADDRESS                MISSING
345 #define ERROR_INT_STATUS_WAKEUP_MASK            MISSING
346 #define ERROR_INT_STATUS_WAKEUP_LSB             MISSING
347 #define ERROR_INT_STATUS_RX_UNDERFLOW_MASK      MISSING
348 #define ERROR_INT_STATUS_RX_UNDERFLOW_LSB       MISSING
349 #define ERROR_INT_STATUS_TX_OVERFLOW_MASK       MISSING
350 #define ERROR_INT_STATUS_TX_OVERFLOW_LSB        MISSING
351 #define COUNT_DEC_ADDRESS                       MISSING
352 #define HOST_INT_STATUS_CPU_MASK                MISSING
353 #define HOST_INT_STATUS_CPU_LSB                 MISSING
354 #define HOST_INT_STATUS_ERROR_MASK              MISSING
355 #define HOST_INT_STATUS_ERROR_LSB               MISSING
356 #define HOST_INT_STATUS_COUNTER_MASK            MISSING
357 #define HOST_INT_STATUS_COUNTER_LSB             MISSING
358 #define RX_LOOKAHEAD_VALID_ADDRESS              MISSING
359 #define WINDOW_DATA_ADDRESS                     MISSING
360 #define WINDOW_READ_ADDR_ADDRESS                MISSING
361 #define WINDOW_WRITE_ADDR_ADDRESS               MISSING
362
363 #define RTC_STATE_V_GET(x) (((x) & RTC_STATE_V_MASK) >> RTC_STATE_V_LSB)
364
365 #endif /* _HW_H_ */