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-2017, Broadcom Corporation 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 698895 2017-05-11 02:55:17Z $ 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 /* Indicate (dis)interest in finding dongles. */ 46 extern int dhd_bus_register(void); 47 extern void dhd_bus_unregister(void); 48 49 /* Download firmware image and nvram image */ 50 extern int dhd_bus_download_firmware(struct dhd_bus *bus, osl_t *osh, 51 char *fw_path, char *nv_path, char *clm_path, char *conf_path); 52 #if defined(BT_OVER_SDIO) 53 extern int dhd_bus_download_btfw(struct dhd_bus *bus, osl_t *osh, char *btfw_path); 54 #endif /* defined (BT_OVER_SDIO) */ 55 56 /* Stop bus module: clear pending frames, disable data flow */ 57 extern void dhd_bus_stop(struct dhd_bus *bus, bool enforce_mutex); 58 59 /* Initialize bus module: prepare for communication w/dongle */ 60 extern int dhd_bus_init(dhd_pub_t *dhdp, bool enforce_mutex); 61 62 /* Get the Bus Idle Time */ 63 extern void dhd_bus_getidletime(dhd_pub_t *dhdp, int *idletime); 64 65 /* Set the Bus Idle Time */ 66 extern void dhd_bus_setidletime(dhd_pub_t *dhdp, int idle_time); 67 68 /* Size of Extended Trap data Buffer */ 69 #ifdef BCMPCIE 70 #define BCMPCIE_EXT_TRAP_DATA_MAXLEN 4096 71 #endif 72 73 /* Send a data frame to the dongle. Callee disposes of txp. */ 74 #ifdef BCMPCIE 75 extern int dhd_bus_txdata(struct dhd_bus *bus, void *txp, uint8 ifidx); 76 #else 77 extern int dhd_bus_txdata(struct dhd_bus *bus, void *txp); 78 #endif 79 80 extern struct device * dhd_bus_to_dev(struct dhd_bus *bus); 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 109 /* Check for and handle local prot-specific iovar commands */ 110 extern int dhd_bus_iovar_op(dhd_pub_t *dhdp, const char *name, 111 void *params, int plen, void *arg, int len, bool set); 112 113 /* Add bus dump output to a buffer */ 114 extern void dhd_bus_dump(dhd_pub_t *dhdp, struct bcmstrbuf *strbuf); 115 116 /* Clear any bus counters */ 117 extern void dhd_bus_clearcounts(dhd_pub_t *dhdp); 118 119 #if defined(BCMSDIO) && defined(PKT_STATICS) 120 extern void dhd_bus_dump_txpktstatics(struct dhd_bus *bus); 121 extern void dhd_bus_clear_txpktstatics(struct dhd_bus *bus); 122 #endif 123 124 /* return the dongle chipid */ 125 extern uint dhd_bus_chip(struct dhd_bus *bus); 126 127 /* return the dongle chiprev */ 128 extern uint dhd_bus_chiprev(struct dhd_bus *bus); 129 130 /* Set user-specified nvram parameters. */ 131 extern void dhd_bus_set_nvram_params(struct dhd_bus * bus, const char *nvram_params); 132 133 extern void *dhd_bus_pub(struct dhd_bus *bus); 134 extern void *dhd_bus_txq(struct dhd_bus *bus); 135 extern const void *dhd_bus_sih(struct dhd_bus *bus); 136 extern uint dhd_bus_hdrlen(struct dhd_bus *bus); 137 #ifdef BCMSDIO 138 extern void dhd_bus_set_dotxinrx(struct dhd_bus *bus, bool val); 139 /* return sdio io status */ 140 extern uint8 dhd_bus_is_ioready(struct dhd_bus *bus); 141 #else 142 #define dhd_bus_set_dotxinrx(a, b) do {} while (0) 143 #endif 144 145 #define DHD_SET_BUS_STATE_DOWN(_bus) 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 device */ 150 extern int dhd_bus_reg_sdio_notify(void* semaphore); 151 extern void dhd_bus_unreg_sdio_notify(void); 152 extern void dhd_txglom_enable(dhd_pub_t *dhdp, bool enable); 153 extern int dhd_bus_get_ids(struct dhd_bus *bus, uint32 *bus_type, uint32 *bus_num, 154 uint32 *slot_num); 155 156 #if defined(DHD_FW_COREDUMP) && (defined(BCMPCIE) || defined(BCMSDIO)) 157 extern int dhd_bus_mem_dump(dhd_pub_t *dhd); 158 #else 159 #define dhd_bus_mem_dump(x) 160 #endif /* DHD_FW_COREDUMP && (BCMPCIE || BCMSDIO) */ 161 162 #ifdef BCMPCIE 163 enum { 164 /* Scratch buffer confiuguration update */ 165 D2H_DMA_SCRATCH_BUF, 166 D2H_DMA_SCRATCH_BUF_LEN, 167 168 /* DMA Indices array buffers for: H2D WR and RD, and D2H WR and RD */ 169 H2D_DMA_INDX_WR_BUF, /* update H2D WR dma indices buf base addr to dongle */ 170 H2D_DMA_INDX_RD_BUF, /* update H2D RD dma indices buf base addr to dongle */ 171 D2H_DMA_INDX_WR_BUF, /* update D2H WR dma indices buf base addr to dongle */ 172 D2H_DMA_INDX_RD_BUF, /* update D2H RD dma indices buf base addr to dongle */ 173 174 /* DHD sets/gets WR or RD index, in host's H2D and D2H DMA indices buffer */ 175 H2D_DMA_INDX_WR_UPD, /* update H2D WR index in H2D WR dma indices buf */ 176 H2D_DMA_INDX_RD_UPD, /* update H2D RD index in H2D RD dma indices buf */ 177 D2H_DMA_INDX_WR_UPD, /* update D2H WR index in D2H WR dma indices buf */ 178 D2H_DMA_INDX_RD_UPD, /* update D2H RD index in D2H RD dma indices buf */ 179 180 /* DHD Indices array buffers and update for: H2D flow ring WR */ 181 H2D_IFRM_INDX_WR_BUF, /* update H2D WR dma indices buf base addr to dongle */ 182 H2D_IFRM_INDX_WR_UPD, /* update H2D WR dma indices buf base addr to dongle */ 183 184 /* H2D and D2H Mailbox data update */ 185 H2D_MB_DATA, 186 D2H_MB_DATA, 187 188 /* (Common) MsgBuf Ring configuration update */ 189 RING_BUF_ADDR, /* update ring base address to dongle */ 190 RING_ITEM_LEN, /* update ring item size to dongle */ 191 RING_MAX_ITEMS, /* update ring max items to dongle */ 192 193 /* Update of WR or RD index, for a MsgBuf Ring */ 194 RING_RD_UPD, /* update ring read index from/to dongle */ 195 RING_WR_UPD, /* update ring write index from/to dongle */ 196 197 TOTAL_LFRAG_PACKET_CNT, 198 MAX_HOST_RXBUFS, 199 HOST_API_VERSION, 200 DNGL_TO_HOST_TRAP_ADDR, 201 #ifdef HOFFLOAD_MODULES 202 WRT_HOST_MODULE_ADDR 203 #endif 204 }; 205 206 typedef void (*dhd_mb_ring_t) (struct dhd_bus *, uint32); 207 typedef void (*dhd_mb_ring_2_t) (struct dhd_bus *, uint32, bool); 208 extern void dhd_bus_cmn_writeshared(struct dhd_bus *bus, void * data, uint32 len, uint8 type, 209 uint16 ringid); 210 extern void dhd_bus_ringbell(struct dhd_bus *bus, uint32 value); 211 extern void dhd_bus_ringbell_2(struct dhd_bus *bus, uint32 value, bool devwake); 212 extern void dhd_bus_cmn_readshared(struct dhd_bus *bus, void* data, uint8 type, uint16 ringid); 213 extern uint32 dhd_bus_get_sharedflags(struct dhd_bus *bus); 214 extern void dhd_bus_rx_frame(struct dhd_bus *bus, void* pkt, int ifidx, uint pkt_count); 215 extern void dhd_bus_start_queue(struct dhd_bus *bus); 216 extern void dhd_bus_stop_queue(struct dhd_bus *bus); 217 extern dhd_mb_ring_t dhd_bus_get_mbintr_fn(struct dhd_bus *bus); 218 extern dhd_mb_ring_2_t dhd_bus_get_mbintr_2_fn(struct dhd_bus *bus); 219 extern void dhd_bus_write_flow_ring_states(struct dhd_bus *bus, 220 void * data, uint16 flowid); 221 extern void dhd_bus_read_flow_ring_states(struct dhd_bus *bus, 222 void * data, uint8 flowid); 223 extern int dhd_bus_flow_ring_create_request(struct dhd_bus *bus, void *flow_ring_node); 224 extern void dhd_bus_clean_flow_ring(struct dhd_bus *bus, void *flow_ring_node); 225 extern void dhd_bus_flow_ring_create_response(struct dhd_bus *bus, uint16 flow_id, int32 status); 226 extern int dhd_bus_flow_ring_delete_request(struct dhd_bus *bus, void *flow_ring_node); 227 extern void dhd_bus_flow_ring_delete_response(struct dhd_bus *bus, uint16 flowid, uint32 status); 228 extern int dhd_bus_flow_ring_flush_request(struct dhd_bus *bus, void *flow_ring_node); 229 extern void dhd_bus_flow_ring_flush_response(struct dhd_bus *bus, uint16 flowid, uint32 status); 230 extern uint32 dhd_bus_max_h2d_queues(struct dhd_bus *bus); 231 extern int dhd_bus_schedule_queue(struct dhd_bus *bus, uint16 flow_id, bool txs); 232 extern void dhd_bus_set_linkdown(dhd_pub_t *dhdp, bool val); 233 234 #ifdef IDLE_TX_FLOW_MGMT 235 extern void dhd_bus_flow_ring_resume_response(struct dhd_bus *bus, uint16 flowid, int32 status); 236 #endif /* IDLE_TX_FLOW_MGMT */ 237 238 239 extern int dhdpcie_bus_clock_start(struct dhd_bus *bus); 240 extern int dhdpcie_bus_clock_stop(struct dhd_bus *bus); 241 extern int dhdpcie_bus_enable_device(struct dhd_bus *bus); 242 extern int dhdpcie_bus_disable_device(struct dhd_bus *bus); 243 extern int dhdpcie_bus_alloc_resource(struct dhd_bus *bus); 244 extern void dhdpcie_bus_free_resource(struct dhd_bus *bus); 245 extern bool dhdpcie_bus_dongle_attach(struct dhd_bus *bus); 246 extern int dhd_bus_release_dongle(struct dhd_bus *bus); 247 extern int dhd_bus_request_irq(struct dhd_bus *bus); 248 extern int dhdpcie_get_pcieirq(struct dhd_bus *bus, unsigned int *irq); 249 250 extern void dhdpcie_cto_init(struct dhd_bus *bus, bool enable); 251 252 253 #ifdef DHD_FW_COREDUMP 254 extern struct dhd_bus *g_dhd_bus; 255 extern int dhd_dongle_mem_dump(void); 256 #endif /* DHD_FW_COREDUMP */ 257 258 #ifdef IDLE_TX_FLOW_MGMT 259 extern void dhd_bus_idle_tx_ring_suspend(dhd_pub_t *dhd, uint16 flow_ring_id); 260 #endif /* IDLE_TX_FLOW_MGMT */ 261 extern void dhd_bus_handle_mb_data(struct dhd_bus *bus, uint32 d2h_mb_data); 262 #endif /* BCMPCIE */ 263 264 /* dump the device trap informtation */ 265 extern void dhd_bus_dump_trap_info(struct dhd_bus *bus, struct bcmstrbuf *b); 266 267 /* Function to set default min res mask */ 268 extern bool dhd_bus_set_default_min_res_mask(struct dhd_bus *bus); 269 270 /* Function to reset PMU registers */ 271 extern void dhd_bus_pmu_reg_reset(dhd_pub_t *dhdp); 272 273 #ifdef DHD_ULP 274 extern void dhd_bus_ulp_disable_console(dhd_pub_t *dhdp); 275 extern void dhd_bus_ucode_download(struct dhd_bus *bus); 276 #endif /* DHD_ULP */ 277 extern int dhd_bus_readwrite_bp_addr(dhd_pub_t *dhdp, uint addr, uint size, uint* data, bool read); 278 279 #ifdef BT_OVER_SDIO 280 /* 281 * SDIO layer clock control functions exposed to be called from other layers. 282 * This is required especially in the case where the BUS is shared between 283 * BT and SDIO and we have to control the clock. The callers of this function 284 * are expected to hold the sdlock 285 */ 286 int __dhdsdio_clk_enable(struct dhd_bus *bus, bus_owner_t owner, int can_wait); 287 int __dhdsdio_clk_disable(struct dhd_bus *bus, bus_owner_t owner, int can_wait); 288 void dhdsdio_reset_bt_use_count(struct dhd_bus *bus); 289 #endif /* BT_OVER_SDIO */ 290 #ifdef BCMPCIE 291 extern void dhd_bus_dump_console_buffer(struct dhd_bus *bus); 292 #else 293 #define dhd_bus_dump_console_buffer(x) 294 #endif /* BCMPCIE */ 295 296 extern uint16 dhd_get_chipid(dhd_pub_t *dhd); 297 298 extern int dhd_get_idletime(dhd_pub_t *dhd); 299 300 #ifdef DHD_WAKE_STATUS 301 extern wake_counts_t* dhd_bus_get_wakecount(dhd_pub_t *dhd); 302 extern int dhd_bus_get_bus_wake(dhd_pub_t * dhd); 303 #endif /* DHD_WAKE_STATUS */ 304 #endif /* _dhd_bus_h_ */ 305