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