ath10k: drop the fw versioning sanity check
[linux-block.git] / drivers / net / wireless / ath / ath10k / hw.h
CommitLineData
5e3dd157
KV
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
e01ae68c
KV
23/* QCA988X 1.0 definitions (unsupported) */
24#define QCA988X_HW_1_0_CHIP_ID_REV 0x0
25
5e3dd157
KV
26/* QCA988X 2.0 definitions */
27#define QCA988X_HW_2_0_VERSION 0x4100016c
e01ae68c 28#define QCA988X_HW_2_0_CHIP_ID_REV 0x2
5e3dd157
KV
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_OTP_FILE "otp.bin"
32#define QCA988X_HW_2_0_BOARD_DATA_FILE "board.bin"
33#define QCA988X_HW_2_0_PATCH_LOAD_ADDR 0x1234
34
35/* Known pecularities:
36 * - current FW doesn't support raw rx mode (last tested v599)
37 * - current FW dumps upon raw tx mode (last tested v599)
38 * - raw appears in nwifi decap, raw and nwifi appear in ethernet decap
39 * - raw have FCS, nwifi doesn't
40 * - ethernet frames have 802.11 header decapped and parts (base hdr, cipher
41 * param, llc/snap) are aligned to 4byte boundaries each */
42enum ath10k_hw_txrx_mode {
43 ATH10K_HW_TXRX_RAW = 0,
44 ATH10K_HW_TXRX_NATIVE_WIFI = 1,
45 ATH10K_HW_TXRX_ETHERNET = 2,
961d4c38
MK
46
47 /* Valid for HTT >= 3.0. Used for management frames in TX_FRM. */
48 ATH10K_HW_TXRX_MGMT = 3,
5e3dd157
KV
49};
50
51enum ath10k_mcast2ucast_mode {
52 ATH10K_MCAST2UCAST_DISABLED = 0,
53 ATH10K_MCAST2UCAST_ENABLED = 1,
54};
55
56#define TARGET_NUM_VDEVS 8
57#define TARGET_NUM_PEER_AST 2
58#define TARGET_NUM_WDS_ENTRIES 32
59#define TARGET_DMA_BURST_SIZE 0
60#define TARGET_MAC_AGGR_DELIM 0
61#define TARGET_AST_SKID_LIMIT 16
62#define TARGET_NUM_PEERS 16
63#define TARGET_NUM_OFFLOAD_PEERS 0
64#define TARGET_NUM_OFFLOAD_REORDER_BUFS 0
65#define TARGET_NUM_PEER_KEYS 2
66#define TARGET_NUM_TIDS (2 * ((TARGET_NUM_PEERS) + (TARGET_NUM_VDEVS)))
67#define TARGET_TX_CHAIN_MASK (BIT(0) | BIT(1) | BIT(2))
68#define TARGET_RX_CHAIN_MASK (BIT(0) | BIT(1) | BIT(2))
69#define TARGET_RX_TIMEOUT_LO_PRI 100
70#define TARGET_RX_TIMEOUT_HI_PRI 40
4d316c79
MK
71
72/* Native Wifi decap mode is used to align IP frames to 4-byte boundaries and
73 * avoid a very expensive re-alignment in mac80211. */
74#define TARGET_RX_DECAP_MODE ATH10K_HW_TXRX_NATIVE_WIFI
75
5e3dd157
KV
76#define TARGET_SCAN_MAX_PENDING_REQS 4
77#define TARGET_BMISS_OFFLOAD_MAX_VDEV 3
78#define TARGET_ROAM_OFFLOAD_MAX_VDEV 3
79#define TARGET_ROAM_OFFLOAD_MAX_AP_PROFILES 8
80#define TARGET_GTK_OFFLOAD_MAX_VDEV 3
81#define TARGET_NUM_MCAST_GROUPS 0
82#define TARGET_NUM_MCAST_TABLE_ELEMS 0
83#define TARGET_MCAST2UCAST_MODE ATH10K_MCAST2UCAST_DISABLED
84#define TARGET_TX_DBG_LOG_SIZE 1024
85#define TARGET_RX_SKIP_DEFRAG_TIMEOUT_DUP_DETECTION_CHECK 0
86#define TARGET_VOW_CONFIG 0
87#define TARGET_NUM_MSDU_DESC (1024 + 400)
88#define TARGET_MAX_FRAG_ENTRIES 0
89
90
91/* Number of Copy Engines supported */
92#define CE_COUNT 8
93
94/*
95 * Total number of PCIe MSI interrupts requested for all interrupt sources.
96 * PCIe standard forces this to be a power of 2.
97 * Some Host OS's limit MSI requests that can be granted to 8
98 * so for now we abide by this limit and avoid requesting more
99 * than that.
100 */
101#define MSI_NUM_REQUEST_LOG2 3
102#define MSI_NUM_REQUEST (1<<MSI_NUM_REQUEST_LOG2)
103
104/*
105 * Granted MSIs are assigned as follows:
106 * Firmware uses the first
107 * Remaining MSIs, if any, are used by Copy Engines
108 * This mapping is known to both Target firmware and Host software.
109 * It may be changed as long as Host and Target are kept in sync.
110 */
111/* MSI for firmware (errors, etc.) */
112#define MSI_ASSIGN_FW 0
113
114/* MSIs for Copy Engines */
115#define MSI_ASSIGN_CE_INITIAL 1
116#define MSI_ASSIGN_CE_MAX 7
117
118/* as of IP3.7.1 */
119#define RTC_STATE_V_ON 3
120
121#define RTC_STATE_COLD_RESET_MASK 0x00000400
122#define RTC_STATE_V_LSB 0
123#define RTC_STATE_V_MASK 0x00000007
124#define RTC_STATE_ADDRESS 0x0000
125#define PCIE_SOC_WAKE_V_MASK 0x00000001
126#define PCIE_SOC_WAKE_ADDRESS 0x0004
127#define PCIE_SOC_WAKE_RESET 0x00000000
128#define SOC_GLOBAL_RESET_ADDRESS 0x0008
129
130#define RTC_SOC_BASE_ADDRESS 0x00004000
131#define RTC_WMAC_BASE_ADDRESS 0x00005000
132#define MAC_COEX_BASE_ADDRESS 0x00006000
133#define BT_COEX_BASE_ADDRESS 0x00007000
134#define SOC_PCIE_BASE_ADDRESS 0x00008000
135#define SOC_CORE_BASE_ADDRESS 0x00009000
136#define WLAN_UART_BASE_ADDRESS 0x0000c000
137#define WLAN_SI_BASE_ADDRESS 0x00010000
138#define WLAN_GPIO_BASE_ADDRESS 0x00014000
139#define WLAN_ANALOG_INTF_BASE_ADDRESS 0x0001c000
140#define WLAN_MAC_BASE_ADDRESS 0x00020000
141#define EFUSE_BASE_ADDRESS 0x00030000
142#define FPGA_REG_BASE_ADDRESS 0x00039000
143#define WLAN_UART2_BASE_ADDRESS 0x00054c00
144#define CE_WRAPPER_BASE_ADDRESS 0x00057000
145#define CE0_BASE_ADDRESS 0x00057400
146#define CE1_BASE_ADDRESS 0x00057800
147#define CE2_BASE_ADDRESS 0x00057c00
148#define CE3_BASE_ADDRESS 0x00058000
149#define CE4_BASE_ADDRESS 0x00058400
150#define CE5_BASE_ADDRESS 0x00058800
151#define CE6_BASE_ADDRESS 0x00058c00
152#define CE7_BASE_ADDRESS 0x00059000
153#define DBI_BASE_ADDRESS 0x00060000
154#define WLAN_ANALOG_INTF_PCIE_BASE_ADDRESS 0x0006c000
155#define PCIE_LOCAL_BASE_ADDRESS 0x00080000
156
157#define SOC_RESET_CONTROL_OFFSET 0x00000000
158#define SOC_RESET_CONTROL_SI0_RST_MASK 0x00000001
159#define SOC_CPU_CLOCK_OFFSET 0x00000020
160#define SOC_CPU_CLOCK_STANDARD_LSB 0
161#define SOC_CPU_CLOCK_STANDARD_MASK 0x00000003
162#define SOC_CLOCK_CONTROL_OFFSET 0x00000028
163#define SOC_CLOCK_CONTROL_SI0_CLK_MASK 0x00000001
164#define SOC_SYSTEM_SLEEP_OFFSET 0x000000c4
165#define SOC_LPO_CAL_OFFSET 0x000000e0
166#define SOC_LPO_CAL_ENABLE_LSB 20
167#define SOC_LPO_CAL_ENABLE_MASK 0x00100000
168
e01ae68c
KV
169#define SOC_CHIP_ID_ADDRESS 0x000000ec
170#define SOC_CHIP_ID_REV_LSB 8
171#define SOC_CHIP_ID_REV_MASK 0x00000f00
172
5e3dd157
KV
173#define WLAN_RESET_CONTROL_COLD_RST_MASK 0x00000008
174#define WLAN_RESET_CONTROL_WARM_RST_MASK 0x00000004
175#define WLAN_SYSTEM_SLEEP_DISABLE_LSB 0
176#define WLAN_SYSTEM_SLEEP_DISABLE_MASK 0x00000001
177
178#define WLAN_GPIO_PIN0_ADDRESS 0x00000028
179#define WLAN_GPIO_PIN0_CONFIG_MASK 0x00007800
180#define WLAN_GPIO_PIN1_ADDRESS 0x0000002c
181#define WLAN_GPIO_PIN1_CONFIG_MASK 0x00007800
182#define WLAN_GPIO_PIN10_ADDRESS 0x00000050
183#define WLAN_GPIO_PIN11_ADDRESS 0x00000054
184#define WLAN_GPIO_PIN12_ADDRESS 0x00000058
185#define WLAN_GPIO_PIN13_ADDRESS 0x0000005c
186
187#define CLOCK_GPIO_OFFSET 0xffffffff
188#define CLOCK_GPIO_BT_CLK_OUT_EN_LSB 0
189#define CLOCK_GPIO_BT_CLK_OUT_EN_MASK 0
190
191#define SI_CONFIG_OFFSET 0x00000000
192#define SI_CONFIG_BIDIR_OD_DATA_LSB 18
193#define SI_CONFIG_BIDIR_OD_DATA_MASK 0x00040000
194#define SI_CONFIG_I2C_LSB 16
195#define SI_CONFIG_I2C_MASK 0x00010000
196#define SI_CONFIG_POS_SAMPLE_LSB 7
197#define SI_CONFIG_POS_SAMPLE_MASK 0x00000080
198#define SI_CONFIG_INACTIVE_DATA_LSB 5
199#define SI_CONFIG_INACTIVE_DATA_MASK 0x00000020
200#define SI_CONFIG_INACTIVE_CLK_LSB 4
201#define SI_CONFIG_INACTIVE_CLK_MASK 0x00000010
202#define SI_CONFIG_DIVIDER_LSB 0
203#define SI_CONFIG_DIVIDER_MASK 0x0000000f
204#define SI_CS_OFFSET 0x00000004
205#define SI_CS_DONE_ERR_MASK 0x00000400
206#define SI_CS_DONE_INT_MASK 0x00000200
207#define SI_CS_START_LSB 8
208#define SI_CS_START_MASK 0x00000100
209#define SI_CS_RX_CNT_LSB 4
210#define SI_CS_RX_CNT_MASK 0x000000f0
211#define SI_CS_TX_CNT_LSB 0
212#define SI_CS_TX_CNT_MASK 0x0000000f
213
214#define SI_TX_DATA0_OFFSET 0x00000008
215#define SI_TX_DATA1_OFFSET 0x0000000c
216#define SI_RX_DATA0_OFFSET 0x00000010
217#define SI_RX_DATA1_OFFSET 0x00000014
218
219#define CORE_CTRL_CPU_INTR_MASK 0x00002000
220#define CORE_CTRL_ADDRESS 0x0000
221#define PCIE_INTR_ENABLE_ADDRESS 0x0008
222#define PCIE_INTR_CLR_ADDRESS 0x0014
223#define SCRATCH_3_ADDRESS 0x0030
224
225/* Firmware indications to the Host via SCRATCH_3 register. */
226#define FW_INDICATOR_ADDRESS (SOC_CORE_BASE_ADDRESS + SCRATCH_3_ADDRESS)
227#define FW_IND_EVENT_PENDING 1
228#define FW_IND_INITIALIZED 2
229
230/* HOST_REG interrupt from firmware */
231#define PCIE_INTR_FIRMWARE_MASK 0x00000400
232#define PCIE_INTR_CE_MASK_ALL 0x0007f800
233
234#define DRAM_BASE_ADDRESS 0x00400000
235
236#define MISSING 0
237
238#define SYSTEM_SLEEP_OFFSET SOC_SYSTEM_SLEEP_OFFSET
239#define WLAN_SYSTEM_SLEEP_OFFSET SOC_SYSTEM_SLEEP_OFFSET
240#define WLAN_RESET_CONTROL_OFFSET SOC_RESET_CONTROL_OFFSET
241#define CLOCK_CONTROL_OFFSET SOC_CLOCK_CONTROL_OFFSET
242#define CLOCK_CONTROL_SI0_CLK_MASK SOC_CLOCK_CONTROL_SI0_CLK_MASK
243#define RESET_CONTROL_MBOX_RST_MASK MISSING
244#define RESET_CONTROL_SI0_RST_MASK SOC_RESET_CONTROL_SI0_RST_MASK
245#define GPIO_BASE_ADDRESS WLAN_GPIO_BASE_ADDRESS
246#define GPIO_PIN0_OFFSET WLAN_GPIO_PIN0_ADDRESS
247#define GPIO_PIN1_OFFSET WLAN_GPIO_PIN1_ADDRESS
248#define GPIO_PIN0_CONFIG_MASK WLAN_GPIO_PIN0_CONFIG_MASK
249#define GPIO_PIN1_CONFIG_MASK WLAN_GPIO_PIN1_CONFIG_MASK
250#define SI_BASE_ADDRESS WLAN_SI_BASE_ADDRESS
251#define SCRATCH_BASE_ADDRESS SOC_CORE_BASE_ADDRESS
252#define LOCAL_SCRATCH_OFFSET 0x18
253#define CPU_CLOCK_OFFSET SOC_CPU_CLOCK_OFFSET
254#define LPO_CAL_OFFSET SOC_LPO_CAL_OFFSET
255#define GPIO_PIN10_OFFSET WLAN_GPIO_PIN10_ADDRESS
256#define GPIO_PIN11_OFFSET WLAN_GPIO_PIN11_ADDRESS
257#define GPIO_PIN12_OFFSET WLAN_GPIO_PIN12_ADDRESS
258#define GPIO_PIN13_OFFSET WLAN_GPIO_PIN13_ADDRESS
259#define CPU_CLOCK_STANDARD_LSB SOC_CPU_CLOCK_STANDARD_LSB
260#define CPU_CLOCK_STANDARD_MASK SOC_CPU_CLOCK_STANDARD_MASK
261#define LPO_CAL_ENABLE_LSB SOC_LPO_CAL_ENABLE_LSB
262#define LPO_CAL_ENABLE_MASK SOC_LPO_CAL_ENABLE_MASK
263#define ANALOG_INTF_BASE_ADDRESS WLAN_ANALOG_INTF_BASE_ADDRESS
264#define MBOX_BASE_ADDRESS MISSING
265#define INT_STATUS_ENABLE_ERROR_LSB MISSING
266#define INT_STATUS_ENABLE_ERROR_MASK MISSING
267#define INT_STATUS_ENABLE_CPU_LSB MISSING
268#define INT_STATUS_ENABLE_CPU_MASK MISSING
269#define INT_STATUS_ENABLE_COUNTER_LSB MISSING
270#define INT_STATUS_ENABLE_COUNTER_MASK MISSING
271#define INT_STATUS_ENABLE_MBOX_DATA_LSB MISSING
272#define INT_STATUS_ENABLE_MBOX_DATA_MASK MISSING
273#define ERROR_STATUS_ENABLE_RX_UNDERFLOW_LSB MISSING
274#define ERROR_STATUS_ENABLE_RX_UNDERFLOW_MASK MISSING
275#define ERROR_STATUS_ENABLE_TX_OVERFLOW_LSB MISSING
276#define ERROR_STATUS_ENABLE_TX_OVERFLOW_MASK MISSING
277#define COUNTER_INT_STATUS_ENABLE_BIT_LSB MISSING
278#define COUNTER_INT_STATUS_ENABLE_BIT_MASK MISSING
279#define INT_STATUS_ENABLE_ADDRESS MISSING
280#define CPU_INT_STATUS_ENABLE_BIT_LSB MISSING
281#define CPU_INT_STATUS_ENABLE_BIT_MASK MISSING
282#define HOST_INT_STATUS_ADDRESS MISSING
283#define CPU_INT_STATUS_ADDRESS MISSING
284#define ERROR_INT_STATUS_ADDRESS MISSING
285#define ERROR_INT_STATUS_WAKEUP_MASK MISSING
286#define ERROR_INT_STATUS_WAKEUP_LSB MISSING
287#define ERROR_INT_STATUS_RX_UNDERFLOW_MASK MISSING
288#define ERROR_INT_STATUS_RX_UNDERFLOW_LSB MISSING
289#define ERROR_INT_STATUS_TX_OVERFLOW_MASK MISSING
290#define ERROR_INT_STATUS_TX_OVERFLOW_LSB MISSING
291#define COUNT_DEC_ADDRESS MISSING
292#define HOST_INT_STATUS_CPU_MASK MISSING
293#define HOST_INT_STATUS_CPU_LSB MISSING
294#define HOST_INT_STATUS_ERROR_MASK MISSING
295#define HOST_INT_STATUS_ERROR_LSB MISSING
296#define HOST_INT_STATUS_COUNTER_MASK MISSING
297#define HOST_INT_STATUS_COUNTER_LSB MISSING
298#define RX_LOOKAHEAD_VALID_ADDRESS MISSING
299#define WINDOW_DATA_ADDRESS MISSING
300#define WINDOW_READ_ADDR_ADDRESS MISSING
301#define WINDOW_WRITE_ADDR_ADDRESS MISSING
302
303#define RTC_STATE_V_GET(x) (((x) & RTC_STATE_V_MASK) >> RTC_STATE_V_LSB)
304
305#endif /* _HW_H_ */