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