1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3 * Header file describing the internal (inter-module) DHD interfaces.
4 *
5 * Provides type definitions and function prototypes used to link the
6 * DHD OS, bus, and protocol modules.
7 *
8 * Copyright (C) 1999-2019, Broadcom.
9 *
10 * Unless you and Broadcom execute a separate written software license
11 * agreement governing use of this software, this software is licensed to you
12 * under the terms of the GNU General Public License version 2 (the "GPL"),
13 * available at http://www.broadcom.com/licenses/GPLv2.php, with the
14 * following added to such license:
15 *
16 * As a special exception, the copyright holders of this software give you
17 * permission to link this software with independent modules, and to copy and
18 * distribute the resulting executable under terms of your choice, provided that
19 * you also meet, for each linked independent module, the terms and conditions of
20 * the license of that module. An independent module is a module which is not
21 * derived from this software. The special exception does not apply to any
22 * modifications of the software.
23 *
24 * Notwithstanding the above, under no circumstances may you combine this
25 * software in any way with any other Broadcom software provided under a license
26 * other than the GPL, without Broadcom's express prior written consent.
27 *
28 *
29 * <<Broadcom-WL-IPTag/Open:>>
30 *
31 * $Id: dhd_bus.h 814378 2019-04-11 02:21:31Z $
32 */
33
34 #ifndef _dhd_bus_h_
35 #define _dhd_bus_h_
36
37 extern int dbus_up(struct dhd_bus *pub);
38 extern int dbus_stop(struct dhd_bus *pub);
39 extern int dbus_send_ctl(struct dhd_bus *pub, uint8 *buf, int len);
40 extern int dbus_recv_ctl(struct dhd_bus *pub, uint8 *buf, int len);
41 /*
42 * Exported from dhd bus module (dhd_usb, dhd_sdio)
43 */
44
45 /* global variable for the bus */
46 extern struct dhd_bus *g_dhd_bus;
47
48 /* Indicate (dis)interest in finding dongles. */
49 extern int dhd_bus_register(void);
50 extern void dhd_bus_unregister(void);
51
52 /* Download firmware image and nvram image */
53 extern int dhd_bus_download_firmware(struct dhd_bus *bus, osl_t *osh,
54 char *fw_path, char *nv_path, char *clm_path, char *conf_path);
55 #if defined(BT_OVER_SDIO)
56 extern int dhd_bus_download_btfw(struct dhd_bus *bus, osl_t *osh, char *btfw_path);
57 #endif /* defined (BT_OVER_SDIO) */
58
59 /* Stop bus module: clear pending frames, disable data flow */
60 extern void dhd_bus_stop(struct dhd_bus *bus, bool enforce_mutex);
61
62 /* Initialize bus module: prepare for communication w/dongle */
63 extern int dhd_bus_init(dhd_pub_t *dhdp, bool enforce_mutex);
64
65 /* Get the Bus Idle Time */
66 extern void dhd_bus_getidletime(dhd_pub_t *dhdp, int *idletime);
67
68 /* Set the Bus Idle Time */
69 extern void dhd_bus_setidletime(dhd_pub_t *dhdp, int idle_time);
70
71 /* Send a data frame to the dongle. Callee disposes of txp. */
72 #ifdef BCMPCIE
73 extern int dhd_bus_txdata(struct dhd_bus *bus, void *txp, uint8 ifidx);
74 #else
75 extern int dhd_bus_txdata(struct dhd_bus *bus, void *txp);
76 #endif // endif
77
78 #ifdef BCMPCIE
79 extern void dhdpcie_cto_recovery_handler(dhd_pub_t *dhd);
80 #endif /* BCMPCIE */
81
82 /* Send/receive a control message to/from the dongle.
83 * Expects caller to enforce a single outstanding transaction.
84 */
85 extern int dhd_bus_txctl(struct dhd_bus *bus, uchar *msg, uint msglen);
86 extern int dhd_bus_rxctl(struct dhd_bus *bus, uchar *msg, uint msglen);
87
88 /* Watchdog timer function */
89 extern bool dhd_bus_watchdog(dhd_pub_t *dhd);
90
91 extern int dhd_bus_oob_intr_register(dhd_pub_t *dhdp);
92 extern void dhd_bus_oob_intr_unregister(dhd_pub_t *dhdp);
93 extern void dhd_bus_oob_intr_set(dhd_pub_t *dhdp, bool enable);
94 extern void dhd_bus_dev_pm_stay_awake(dhd_pub_t *dhdpub);
95 extern void dhd_bus_dev_pm_relax(dhd_pub_t *dhdpub);
96 extern bool dhd_bus_dev_pm_enabled(dhd_pub_t *dhdpub);
97
98 /* Device console input function */
99 extern int dhd_bus_console_in(dhd_pub_t *dhd, uchar *msg, uint msglen);
100 #ifdef CONSOLE_DPC
101 extern int dhd_bus_txcons(dhd_pub_t *dhd, uchar *msg, uint msglen);
102 #endif
103
104 /* Deferred processing for the bus, return TRUE requests reschedule */
105 extern bool dhd_bus_dpc(struct dhd_bus *bus);
106 extern void dhd_bus_isr(bool * InterruptRecognized, bool * QueueMiniportHandleInterrupt, void *arg);
107
108 /* Check for and handle local prot-specific iovar commands */
109 extern int dhd_bus_iovar_op(dhd_pub_t *dhdp, const char *name,
110 void *params, int plen, void *arg, int len, bool set);
111
112 /* Add bus dump output to a buffer */
113 extern void dhd_bus_dump(dhd_pub_t *dhdp, struct bcmstrbuf *strbuf);
114
115 /* Clear any bus counters */
116 extern void dhd_bus_clearcounts(dhd_pub_t *dhdp);
117
118 #if defined(BCMSDIO) && defined(PKT_STATICS)
119 extern void dhd_bus_dump_txpktstatics(struct dhd_bus *bus);
120 extern void dhd_bus_clear_txpktstatics(struct dhd_bus *bus);
121 #endif
122
123 /* return the dongle chipid */
124 extern uint dhd_bus_chip(struct dhd_bus *bus);
125
126 /* return the dongle chiprev */
127 extern uint dhd_bus_chiprev(struct dhd_bus *bus);
128
129 /* Set user-specified nvram parameters. */
130 extern void dhd_bus_set_nvram_params(struct dhd_bus * bus, const char *nvram_params);
131
132 extern void *dhd_bus_pub(struct dhd_bus *bus);
133 extern void *dhd_bus_txq(struct dhd_bus *bus);
134 extern void *dhd_bus_sih(struct dhd_bus *bus);
135 extern uint dhd_bus_hdrlen(struct dhd_bus *bus);
136 #ifdef BCMSDIO
137 extern void dhd_bus_set_dotxinrx(struct dhd_bus *bus, bool val);
138 /* return sdio io status */
139 extern uint8 dhd_bus_is_ioready(struct dhd_bus *bus);
140 #else
141 #define dhd_bus_set_dotxinrx(a, b) do {} while (0)
142 #endif // endif
143
144 #define DHD_SET_BUS_STATE_DOWN(_bus) do { \
145 (_bus)->dhd->busstate = DHD_BUS_DOWN; \
146 } while (0)
147
148 /* Register a dummy SDIO client driver in order to be notified of new SDIO device */
149 extern int dhd_bus_reg_sdio_notify(void* semaphore);
150 extern void dhd_bus_unreg_sdio_notify(void);
151 extern void dhd_txglom_enable(dhd_pub_t *dhdp, bool enable);
152 extern int dhd_bus_get_ids(struct dhd_bus *bus, uint32 *bus_type, uint32 *bus_num,
153 uint32 *slot_num);
154
155 #if defined(DHD_FW_COREDUMP) && (defined(BCMPCIE) || defined(BCMSDIO))
156 extern int dhd_bus_mem_dump(dhd_pub_t *dhd);
157 extern int dhd_bus_get_mem_dump(dhd_pub_t *dhdp);
158 #else
159 #define dhd_bus_mem_dump(x)
160 #define dhd_bus_get_mem_dump(x)
161 #endif /* DHD_FW_COREDUMP && (BCMPCIE || BCMSDIO) */
162
163 #ifdef BCMPCIE
164 enum {
165 /* Scratch buffer confiuguration update */
166 D2H_DMA_SCRATCH_BUF,
167 D2H_DMA_SCRATCH_BUF_LEN,
168
169 /* DMA Indices array buffers for: H2D WR and RD, and D2H WR and RD */
170 H2D_DMA_INDX_WR_BUF, /* update H2D WR dma indices buf base addr to dongle */
171 H2D_DMA_INDX_RD_BUF, /* update H2D RD dma indices buf base addr to dongle */
172 D2H_DMA_INDX_WR_BUF, /* update D2H WR dma indices buf base addr to dongle */
173 D2H_DMA_INDX_RD_BUF, /* update D2H RD dma indices buf base addr to dongle */
174
175 /* DHD sets/gets WR or RD index, in host's H2D and D2H DMA indices buffer */
176 H2D_DMA_INDX_WR_UPD, /* update H2D WR index in H2D WR dma indices buf */
177 H2D_DMA_INDX_RD_UPD, /* update H2D RD index in H2D RD dma indices buf */
178 D2H_DMA_INDX_WR_UPD, /* update D2H WR index in D2H WR dma indices buf */
179 D2H_DMA_INDX_RD_UPD, /* update D2H RD index in D2H RD dma indices buf */
180
181 /* DHD Indices array buffers and update for: H2D flow ring WR */
182 H2D_IFRM_INDX_WR_BUF, /* update H2D WR dma indices buf base addr to dongle */
183 H2D_IFRM_INDX_WR_UPD, /* update H2D WR dma indices buf base addr to dongle */
184
185 /* H2D and D2H Mailbox data update */
186 H2D_MB_DATA,
187 D2H_MB_DATA,
188
189 /* (Common) MsgBuf Ring configuration update */
190 RING_BUF_ADDR, /* update ring base address to dongle */
191 RING_ITEM_LEN, /* update ring item size to dongle */
192 RING_MAX_ITEMS, /* update ring max items to dongle */
193
194 /* Update of WR or RD index, for a MsgBuf Ring */
195 RING_RD_UPD, /* update ring read index from/to dongle */
196 RING_WR_UPD, /* update ring write index from/to dongle */
197
198 TOTAL_LFRAG_PACKET_CNT,
199 MAX_HOST_RXBUFS,
200 HOST_API_VERSION,
201 DNGL_TO_HOST_TRAP_ADDR,
202 HOST_SCB_ADDR, /* update host scb base address to dongle */
203 };
204
205 typedef void (*dhd_mb_ring_t) (struct dhd_bus *, uint32);
206 typedef void (*dhd_mb_ring_2_t) (struct dhd_bus *, uint32, bool);
207 extern void dhd_bus_cmn_writeshared(struct dhd_bus *bus, void * data, uint32 len, uint8 type,
208 uint16 ringid);
209 extern void dhd_bus_ringbell(struct dhd_bus *bus, uint32 value);
210 extern void dhd_bus_ringbell_2(struct dhd_bus *bus, uint32 value, bool devwake);
211 extern void dhd_bus_cmn_readshared(struct dhd_bus *bus, void* data, uint8 type, uint16 ringid);
212 extern uint32 dhd_bus_get_sharedflags(struct dhd_bus *bus);
213 extern void dhd_bus_rx_frame(struct dhd_bus *bus, void* pkt, int ifidx, uint pkt_count);
214 extern void dhd_bus_start_queue(struct dhd_bus *bus);
215 extern void dhd_bus_stop_queue(struct dhd_bus *bus);
216 extern dhd_mb_ring_t dhd_bus_get_mbintr_fn(struct dhd_bus *bus);
217 extern dhd_mb_ring_2_t dhd_bus_get_mbintr_2_fn(struct dhd_bus *bus);
218 extern void dhd_bus_write_flow_ring_states(struct dhd_bus *bus,
219 void * data, uint16 flowid);
220 extern void dhd_bus_read_flow_ring_states(struct dhd_bus *bus,
221 void * data, uint8 flowid);
222 extern int dhd_bus_flow_ring_create_request(struct dhd_bus *bus, void *flow_ring_node);
223 extern void dhd_bus_clean_flow_ring(struct dhd_bus *bus, void *flow_ring_node);
224 extern void dhd_bus_flow_ring_create_response(struct dhd_bus *bus, uint16 flow_id, int32 status);
225 extern int dhd_bus_flow_ring_delete_request(struct dhd_bus *bus, void *flow_ring_node);
226 extern void dhd_bus_flow_ring_delete_response(struct dhd_bus *bus, uint16 flowid, uint32 status);
227 extern int dhd_bus_flow_ring_flush_request(struct dhd_bus *bus, void *flow_ring_node);
228 extern void dhd_bus_flow_ring_flush_response(struct dhd_bus *bus, uint16 flowid, uint32 status);
229 extern uint32 dhd_bus_max_h2d_queues(struct dhd_bus *bus);
230 extern int dhd_bus_schedule_queue(struct dhd_bus *bus, uint16 flow_id, bool txs);
231
232 #ifdef IDLE_TX_FLOW_MGMT
233 extern void dhd_bus_flow_ring_resume_response(struct dhd_bus *bus, uint16 flowid, int32 status);
234 #endif /* IDLE_TX_FLOW_MGMT */
235
236 extern int dhdpcie_bus_clock_start(struct dhd_bus *bus);
237 extern int dhdpcie_bus_clock_stop(struct dhd_bus *bus);
238 extern int dhdpcie_bus_enable_device(struct dhd_bus *bus);
239 extern int dhdpcie_bus_disable_device(struct dhd_bus *bus);
240 extern int dhdpcie_bus_alloc_resource(struct dhd_bus *bus);
241 extern void dhdpcie_bus_free_resource(struct dhd_bus *bus);
242 extern bool dhdpcie_bus_dongle_attach(struct dhd_bus *bus);
243 extern int dhd_bus_release_dongle(struct dhd_bus *bus);
244 extern int dhd_bus_request_irq(struct dhd_bus *bus);
245 extern int dhdpcie_get_pcieirq(struct dhd_bus *bus, unsigned int *irq);
246 extern void dhd_bus_aer_config(struct dhd_bus *bus);
247
248 extern struct device * dhd_bus_to_dev(struct dhd_bus *bus);
249
250 extern int dhdpcie_cto_init(struct dhd_bus *bus, bool enable);
251 extern int dhdpcie_cto_cfg_init(struct dhd_bus *bus, bool enable);
252
253 extern void dhdpcie_ssreset_dis_enum_rst(struct dhd_bus *bus);
254
255 #ifdef DHD_FW_COREDUMP
256 extern int dhd_dongle_mem_dump(void);
257 #endif /* DHD_FW_COREDUMP */
258
259 #ifdef IDLE_TX_FLOW_MGMT
260 extern void dhd_bus_idle_tx_ring_suspend(dhd_pub_t *dhd, uint16 flow_ring_id);
261 #endif /* IDLE_TX_FLOW_MGMT */
262 extern void dhd_bus_handle_mb_data(struct dhd_bus *bus, uint32 d2h_mb_data);
263 #endif /* BCMPCIE */
264
265 /* dump the device trap informtation */
266 extern void dhd_bus_dump_trap_info(struct dhd_bus *bus, struct bcmstrbuf *b);
267 extern void dhd_bus_copy_trap_sig(struct dhd_bus *bus, trap_t *tr);
268 /* Function to set default min res mask */
269 extern bool dhd_bus_set_default_min_res_mask(struct dhd_bus *bus);
270
271 /* Function to reset PMU registers */
272 extern void dhd_bus_pmu_reg_reset(dhd_pub_t *dhdp);
273
274 extern void dhd_bus_ucode_download(struct dhd_bus *bus);
275
276 #ifdef DHD_ULP
277 extern void dhd_bus_ulp_disable_console(dhd_pub_t *dhdp);
278 #endif /* DHD_ULP */
279 extern int dhd_bus_readwrite_bp_addr(dhd_pub_t *dhdp, uint addr, uint size, uint* data, bool read);
280 extern int dhd_get_idletime(dhd_pub_t *dhd);
281 #ifdef BCMPCIE
282 extern void dhd_bus_dump_console_buffer(struct dhd_bus *bus);
283 extern void dhd_bus_intr_count_dump(dhd_pub_t *dhdp);
284 extern void dhd_bus_set_dpc_sched_time(dhd_pub_t *dhdp);
285 extern bool dhd_bus_query_dpc_sched_errors(dhd_pub_t *dhdp);
286 extern int dhd_bus_dmaxfer_lpbk(dhd_pub_t *dhdp, uint32 type);
287 extern bool dhd_bus_check_driver_up(void);
288 extern int dhd_bus_get_cto(dhd_pub_t *dhdp);
289 extern void dhd_bus_set_linkdown(dhd_pub_t *dhdp, bool val);
290 extern int dhd_bus_get_linkdown(dhd_pub_t *dhdp);
291 #else
292 #define dhd_bus_dump_console_buffer(x)
dhd_bus_intr_count_dump(dhd_pub_t * dhdp)293 static INLINE void dhd_bus_intr_count_dump(dhd_pub_t *dhdp) { UNUSED_PARAMETER(dhdp); }
dhd_bus_set_dpc_sched_time(dhd_pub_t * dhdp)294 static INLINE void dhd_bus_set_dpc_sched_time(dhd_pub_t *dhdp) { }
dhd_bus_query_dpc_sched_errors(dhd_pub_t * dhdp)295 static INLINE bool dhd_bus_query_dpc_sched_errors(dhd_pub_t *dhdp) { return 0; }
dhd_bus_dmaxfer_lpbk(dhd_pub_t * dhdp,uint32 type)296 static INLINE int dhd_bus_dmaxfer_lpbk(dhd_pub_t *dhdp, uint32 type) { return 0; }
dhd_bus_check_driver_up(void)297 static INLINE bool dhd_bus_check_driver_up(void) { return FALSE; }
dhd_bus_set_linkdown(dhd_pub_t * dhdp,bool val)298 extern INLINE void dhd_bus_set_linkdown(dhd_pub_t *dhdp, bool val) { }
dhd_bus_get_linkdown(dhd_pub_t * dhdp)299 extern INLINE int dhd_bus_get_linkdown(dhd_pub_t *dhdp) { return 0; }
dhd_bus_get_cto(dhd_pub_t * dhdp)300 static INLINE int dhd_bus_get_cto(dhd_pub_t *dhdp) { return 0; }
301 #endif /* BCMPCIE */
302
303 #if defined(BCMPCIE) && defined(EWP_ETD_PRSRV_LOGS)
304 void dhdpcie_get_etd_preserve_logs(dhd_pub_t *dhd, uint8 *ext_trap_data,
305 void *event_decode_data);
306 #endif // endif
307
308 extern uint16 dhd_get_chipid(dhd_pub_t *dhd);
309
310 #ifdef DHD_WAKE_STATUS
311 extern wake_counts_t* dhd_bus_get_wakecount(dhd_pub_t *dhd);
312 extern int dhd_bus_get_bus_wake(dhd_pub_t * dhd);
313 #endif /* DHD_WAKE_STATUS */
314
315 #ifdef BT_OVER_SDIO
316 /*
317 * SDIO layer clock control functions exposed to be called from other layers.
318 * This is required especially in the case where the BUS is shared between
319 * BT and SDIO and we have to control the clock. The callers of this function
320 * are expected to hold the sdlock
321 */
322 int __dhdsdio_clk_enable(struct dhd_bus *bus, bus_owner_t owner, int can_wait);
323 int __dhdsdio_clk_disable(struct dhd_bus *bus, bus_owner_t owner, int can_wait);
324 void dhdsdio_reset_bt_use_count(struct dhd_bus *bus);
325 #endif /* BT_OVER_SDIO */
326
327 int dhd_bus_perform_flr(struct dhd_bus *bus, bool force_fail);
328 extern bool dhd_bus_get_flr_force_fail(struct dhd_bus *bus);
329
330 extern bool dhd_bus_aspm_enable_rc_ep(struct dhd_bus *bus, bool enable);
331 extern void dhd_bus_l1ss_enable_rc_ep(struct dhd_bus *bus, bool enable);
332
333 bool dhd_bus_is_multibp_capable(struct dhd_bus *bus);
334
335 #ifdef BCMPCIE
336 extern void dhdpcie_advertise_bus_cleanup(dhd_pub_t *dhdp);
337 extern void dhd_msgbuf_iovar_timeout_dump(dhd_pub_t *dhd);
338 #endif /* BCMPCIE */
339
340 extern bool dhd_bus_force_bt_quiesce_enabled(struct dhd_bus *bus);
341
342 #ifdef DHD_SSSR_DUMP
343 extern int dhd_bus_fis_trigger(dhd_pub_t *dhd);
344 extern int dhd_bus_fis_dump(dhd_pub_t *dhd);
345 #endif /* DHD_SSSR_DUMP */
346
347 #ifdef PCIE_FULL_DONGLE
348 extern int dhdpcie_set_dma_ring_indices(dhd_pub_t *dhd, int32 int_val);
349 #endif /* PCIE_FULL_DONGLE */
350
351 #ifdef DHD_USE_BP_RESET
352 extern int dhd_bus_perform_bp_reset(struct dhd_bus *bus);
353 #endif /* DHD_USE_BP_RESET */
354
355 extern void dhd_bwm_bt_quiesce(struct dhd_bus *bus);
356 extern void dhd_bwm_bt_resume(struct dhd_bus *bus);
357 #endif /* _dhd_bus_h_ */
358