2 * Copyright (c) 2005-2011 Atheros Communications Inc.
3 * Copyright (c) 2011-2013 Qualcomm Atheros, Inc.
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.
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.
21 #include <linux/interrupt.h>
27 * maximum number of bytes that can be handled atomically by DiagRead/DiagWrite
29 #define DIAG_TRANSFER_LIMIT 2048
32 * maximum number of bytes that can be
33 * handled atomically by DiagRead/DiagWrite
35 #define DIAG_TRANSFER_LIMIT 2048
45 * PCI-specific Target state
47 * NOTE: Structure is shared between Host software and Target firmware!
49 * Much of this may be of interest to the Host so
50 * HOST_INTEREST->hi_interconnect_state points here
51 * (and all members are 32-bit quantities in order to
52 * facilitate Host access). In particular, Host software is
53 * required to initialize pipe_cfg_addr and svc_to_pipe_map.
56 /* Pipe configuration Target address */
57 /* NB: ce_pipe_config[CE_COUNT] */
60 /* Service to pipe map Target address */
61 /* NB: service_to_pipe[PIPE_TO_CE_MAP_CN] */
64 /* number of MSI interrupts requested */
67 /* number of MSI interrupts granted */
70 /* Message Signalled Interrupt address */
77 * Data for firmware interrupt;
78 * MSI data for other interrupts are
79 * in various SoC registers
83 /* PCIE_PWR_METHOD_* */
84 u32 power_mgmt_method
;
86 /* PCIE_CONFIG_FLAG_* */
90 /* PCIE_CONFIG_FLAG definitions */
91 #define PCIE_CONFIG_FLAG_ENABLE_L1 0x0000001
93 /* Host software's Copy Engine configuration. */
94 #define CE_ATTR_FLAGS 0
97 * Configuration information for a Copy Engine pipe.
98 * Passed from Host to Target during startup (one per CE).
100 * NOTE: Structure is shared between Host software and Target firmware!
102 struct ce_pipe_config
{
112 * Directions for interconnect pipe configuration.
113 * These definitions may be used during configuration and are shared
114 * between Host and Target.
116 * Pipe Directions are relative to the Host, so PIPEDIR_IN means
117 * "coming IN over air through Target to Host" as with a WiFi Rx operation.
118 * Conversely, PIPEDIR_OUT means "going OUT from Host through Target over air"
119 * as with a WiFi Tx operation. This is somewhat awkward for the "middle-man"
120 * Target since things that are "PIPEDIR_OUT" are coming IN to the Target
121 * over the interconnect.
123 #define PIPEDIR_NONE 0
124 #define PIPEDIR_IN 1 /* Target-->Host, WiFi Rx direction */
125 #define PIPEDIR_OUT 2 /* Host->Target, WiFi Tx direction */
126 #define PIPEDIR_INOUT 3 /* bidirectional */
128 /* Establish a mapping between a service/direction and a pipe. */
129 struct service_to_pipe
{
135 /* Per-pipe state. */
136 struct ath10k_pci_pipe
{
137 /* Handle of underlying Copy Engine */
138 struct ath10k_ce_pipe
*ce_hdl
;
140 /* Our pipe number; facilitiates use of pipe_info ptrs. */
143 /* Convenience back pointer to hif_ce_state. */
144 struct ath10k
*hif_ce_state
;
148 /* protects compl_free and num_send_allowed */
149 spinlock_t pipe_lock
;
151 struct ath10k_pci
*ar_pci
;
152 struct tasklet_struct intr
;
155 struct ath10k_pci_supp_chip
{
161 struct pci_dev
*pdev
;
168 * Number of MSI interrupts granted, 0 --> using legacy PCI line
173 struct tasklet_struct intr_tq
;
174 struct tasklet_struct msi_fw_err
;
176 struct ath10k_pci_pipe pipe_info
[CE_COUNT_MAX
];
178 struct ath10k_hif_cb msg_callbacks_current
;
180 /* Copy Engine used for Diagnostic Accesses */
181 struct ath10k_ce_pipe
*ce_diag
;
183 /* FIXME: document what this really protects */
186 /* Map CE id to ce_state */
187 struct ath10k_ce_pipe ce_states
[CE_COUNT_MAX
];
188 struct timer_list rx_post_retry
;
190 /* Due to HW quirks it is recommended to disable ASPM during device
191 * bootup. To do that the original PCI-E Link Control is stored before
192 * device bootup is executed and re-programmed later.
196 /* Protects ps_awake and ps_wake_refcount */
199 /* The device has a special powersave-oriented register. When device is
200 * considered asleep it drains less power and driver is forbidden from
201 * accessing most MMIO registers. If host were to access them without
202 * waking up the device might scribble over host memory or return
203 * 0xdeadbeef readouts.
205 unsigned long ps_wake_refcount
;
207 /* Waking up takes some time (up to 2ms in some cases) so it can be bad
208 * for latency. To mitigate this the device isn't immediately allowed
209 * to sleep after all references are undone - instead there's a grace
210 * period after which the powersave register is updated unless some
211 * activity to/from device happened in the meantime.
213 * Also see comments on ATH10K_PCI_SLEEP_GRACE_PERIOD_MSEC.
215 struct timer_list ps_timer
;
217 /* MMIO registers are used to communicate with the device. With
218 * intensive traffic accessing powersave register would be a bit
219 * wasteful overhead and would needlessly stall CPU. It is far more
220 * efficient to rely on a variable in RAM and update it only upon
221 * powersave register state changes.
226 static inline struct ath10k_pci
*ath10k_pci_priv(struct ath10k
*ar
)
228 return (struct ath10k_pci
*)ar
->drv_priv
;
231 #define ATH10K_PCI_RX_POST_RETRY_MS 50
232 #define ATH_PCI_RESET_WAIT_MAX 10 /* ms */
233 #define PCIE_WAKE_TIMEOUT 10000 /* 10ms */
237 #define CDC_WAR_MAGIC_STR 0xceef0000
238 #define CDC_WAR_DATA_CE 4
240 /* Wait up to this many Ms for a Diagnostic Access CE operation to complete */
241 #define DIAG_ACCESS_CE_TIMEOUT_MS 10
243 void ath10k_pci_write32(struct ath10k
*ar
, u32 offset
, u32 value
);
244 void ath10k_pci_soc_write32(struct ath10k
*ar
, u32 addr
, u32 val
);
245 void ath10k_pci_reg_write32(struct ath10k
*ar
, u32 addr
, u32 val
);
247 u32
ath10k_pci_read32(struct ath10k
*ar
, u32 offset
);
248 u32
ath10k_pci_soc_read32(struct ath10k
*ar
, u32 addr
);
249 u32
ath10k_pci_reg_read32(struct ath10k
*ar
, u32 addr
);
251 /* QCA6174 is known to have Tx/Rx issues when SOC_WAKE register is poked too
252 * frequently. To avoid this put SoC to sleep after a very conservative grace
253 * period. Adjust with great care.
255 #define ATH10K_PCI_SLEEP_GRACE_PERIOD_MSEC 60