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-2010, 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 * $Id: dhd.h,v 1.32.4.7.2.4.14.29 2010/02/23 06:58:21 Exp $ 28 */ 29 30 /**************** 31 * Common types * 32 */ 33 34 #ifndef _dhd_h_ 35 #define _dhd_h_ 36 37 #if defined(LINUX) 38 #include <linux/init.h> 39 #include <linux/kernel.h> 40 #include <linux/slab.h> 41 #include <linux/skbuff.h> 42 #include <linux/netdevice.h> 43 #include <linux/etherdevice.h> 44 #include <linux/random.h> 45 #include <linux/spinlock.h> 46 #include <linux/ethtool.h> 47 #include <asm/uaccess.h> 48 #include <asm/unaligned.h> 49 50 /* The kernel threading is sdio-specific */ 51 #else /* LINUX */ 52 #define ENOMEM 1 53 #define EFAULT 2 54 #define EINVAL 3 55 #define EIO 4 56 #define ETIMEDOUT 5 57 #define ERESTARTSYS 6 58 #endif /* LINUX */ 59 60 #include <wlioctl.h> 61 62 63 /* Forward decls */ 64 struct dhd_bus; 65 struct dhd_prot; 66 struct dhd_info; 67 68 /* The level of bus communication with the dongle */ 69 enum dhd_bus_state { 70 DHD_BUS_DOWN, /* Not ready for frame transfers */ 71 DHD_BUS_LOAD, /* Download access only (CPU reset) */ 72 DHD_BUS_DATA /* Ready for frame transfers */ 73 }; 74 75 enum dhd_bus_wake_state { 76 WAKE_LOCK_OFF, 77 WAKE_LOCK_PRIV, 78 WAKE_LOCK_DPC, 79 WAKE_LOCK_IOCTL, 80 WAKE_LOCK_DOWNLOAD, 81 WAKE_LOCK_TMOUT, 82 WAKE_LOCK_WATCHDOG, 83 WAKE_LOCK_LINK_DOWN_TMOUT, 84 WAKE_LOCK_SOFTAP_SET, 85 WAKE_LOCK_SOFTAP_STOP, 86 WAKE_LOCK_SOFTAP_START, 87 WAKE_LOCK_MAX 88 }; 89 enum dhd_prealloc_index { 90 DHD_PREALLOC_PROT = 0, 91 DHD_PREALLOC_RXBUF, 92 DHD_PREALLOC_DATABUF, 93 DHD_PREALLOC_OSL_BUF 94 }; 95 #ifdef DHD_USE_STATIC_BUF 96 extern void * dhd_os_prealloc(int section, unsigned long size); 97 #endif 98 /* Common structure for module and instance linkage */ 99 typedef struct dhd_pub { 100 /* Linkage ponters */ 101 osl_t *osh; /* OSL handle */ 102 struct dhd_bus *bus; /* Bus module handle */ 103 struct dhd_prot *prot; /* Protocol module handle */ 104 struct dhd_info *info; /* Info module handle */ 105 106 /* Internal dhd items */ 107 bool up; /* Driver up/down (to OS) */ 108 bool txoff; /* Transmit flow-controlled */ 109 bool dongle_reset; /* TRUE = DEVRESET put dongle into reset */ 110 enum dhd_bus_state busstate; 111 uint hdrlen; /* Total DHD header length (proto + bus) */ 112 uint maxctl; /* Max size rxctl request from proto to bus */ 113 uint rxsz; /* Rx buffer size bus module should use */ 114 uint8 wme_dp; /* wme discard priority */ 115 116 /* Dongle media info */ 117 bool iswl; /* Dongle-resident driver is wl */ 118 ulong drv_version; /* Version of dongle-resident driver */ 119 struct ether_addr mac; /* MAC address obtained from dongle */ 120 dngl_stats_t dstats; /* Stats for dongle-based data */ 121 122 /* Additional stats for the bus level */ 123 ulong tx_packets; /* Data packets sent to dongle */ 124 ulong tx_multicast; /* Multicast data packets sent to dongle */ 125 ulong tx_errors; /* Errors in sending data to dongle */ 126 ulong tx_ctlpkts; /* Control packets sent to dongle */ 127 ulong tx_ctlerrs; /* Errors sending control frames to dongle */ 128 ulong rx_packets; /* Packets sent up the network interface */ 129 ulong rx_multicast; /* Multicast packets sent up the network interface */ 130 ulong rx_errors; /* Errors processing rx data packets */ 131 ulong rx_ctlpkts; /* Control frames processed from dongle */ 132 ulong rx_ctlerrs; /* Errors in processing rx control frames */ 133 ulong rx_dropped; /* Packets dropped locally (no memory) */ 134 ulong rx_flushed; /* Packets flushed due to unscheduled sendup thread */ 135 ulong wd_dpc_sched; /* Number of times dhd dpc scheduled by watchdog timer */ 136 137 ulong rx_readahead_cnt; /* Number of packets where header read-ahead was used. */ 138 ulong tx_realloc; /* Number of tx packets we had to realloc for headroom */ 139 ulong fc_packets; /* Number of flow control pkts recvd */ 140 141 /* Last error return */ 142 int bcmerror; 143 uint tickcnt; 144 145 /* Last error from dongle */ 146 int dongle_error; 147 148 uint8 country_code[WLC_CNTRY_BUF_SZ]; 149 } dhd_pub_t; 150 151 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 27)) && defined(CONFIG_PM_SLEEP) 152 153 #define DHD_PM_RESUME_WAIT_INIT(a) DECLARE_WAIT_QUEUE_HEAD(a); 154 #define _DHD_PM_RESUME_WAIT(a, b) do {\ 155 int retry = 0; \ 156 while (dhd_mmc_suspend && retry++ != b) { \ 157 wait_event_interruptible_timeout(a, FALSE, HZ/100); \ 158 } \ 159 } while (0) 160 #define DHD_PM_RESUME_WAIT(a) _DHD_PM_RESUME_WAIT(a, 30) 161 #define DHD_PM_RESUME_WAIT_FOREVER(a) _DHD_PM_RESUME_WAIT(a, ~0) 162 #define DHD_PM_RESUME_RETURN_ERROR(a) do { if (dhd_mmc_suspend) return a; } while (0) 163 #define DHD_PM_RESUME_RETURN do { if (dhd_mmc_suspend) return; } while (0) 164 165 #define DHD_SPINWAIT_SLEEP_INIT(a) DECLARE_WAIT_QUEUE_HEAD(a); 166 #define SPINWAIT_SLEEP(a, exp, us) do { \ 167 uint countdown = (us) + 9; \ 168 while ((exp) && (countdown >= 10)) { \ 169 wait_event_interruptible_timeout(a, FALSE, HZ/100); \ 170 countdown -= 10; \ 171 } \ 172 } while (0) 173 174 #else 175 176 #define DHD_PM_RESUME_WAIT_INIT(a) 177 #define DHD_PM_RESUME_WAIT(a) 178 #define DHD_PM_RESUME_WAIT_FOREVER(a) 179 #define DHD_PM_RESUME_RETURN_ERROR(a) 180 #define DHD_PM_RESUME_RETURN 181 182 #define DHD_SPINWAIT_SLEEP_INIT(a) 183 #define SPINWAIT_SLEEP(a, exp, us) do { \ 184 uint countdown = (us) + 9; \ 185 while ((exp) && (countdown >= 10)) { \ 186 OSL_DELAY(10); \ 187 countdown -= 10; \ 188 } \ 189 } while (0) 190 191 #endif /* LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 27)) && defined(CONFIG_PM_SLEEP) */ 192 #define DHD_IF_VIF 0x01 /* Virtual IF (Hidden from user) */ 193 194 /* Wakelock Functions */ 195 extern int dhd_os_wake_lock(dhd_pub_t *pub); 196 extern int dhd_os_wake_unlock(dhd_pub_t *pub); 197 extern int dhd_os_wake_lock_timeout(dhd_pub_t *pub); 198 extern int dhd_os_wake_lock_timeout_enable(dhd_pub_t *pub); 199 200 typedef struct dhd_if_event { 201 uint8 ifidx; 202 uint8 action; 203 uint8 flags; 204 uint8 bssidx; 205 } dhd_if_event_t; 206 207 /* 208 * Exported from dhd OS modules (dhd_linux/dhd_ndis) 209 */ 210 211 /* To allow osl_attach/detach calls from os-independent modules */ 212 osl_t *dhd_osl_attach(void *pdev, uint bustype); 213 void dhd_osl_detach(osl_t *osh); 214 215 /* Indication from bus module regarding presence/insertion of dongle. 216 * Return dhd_pub_t pointer, used as handle to OS module in later calls. 217 * Returned structure should have bus and prot pointers filled in. 218 * bus_hdrlen specifies required headroom for bus module header. 219 */ 220 extern dhd_pub_t *dhd_attach(osl_t *osh, struct dhd_bus *bus, uint bus_hdrlen); 221 extern int dhd_net_attach(dhd_pub_t *dhdp, int idx); 222 223 /* Indication from bus module regarding removal/absence of dongle */ 224 extern void dhd_detach(dhd_pub_t *dhdp); 225 226 /* Indication from bus module to change flow-control state */ 227 extern void dhd_txflowcontrol(dhd_pub_t *dhdp, int ifidx, bool on); 228 229 extern bool dhd_prec_enq(dhd_pub_t *dhdp, struct pktq *q, void *pkt, int prec); 230 231 /* Receive frame for delivery to OS. Callee disposes of rxp. */ 232 extern void dhd_rx_frame(dhd_pub_t *dhdp, int ifidx, void *rxp, int numpkt); 233 234 /* Return pointer to interface name */ 235 extern char *dhd_ifname(dhd_pub_t *dhdp, int idx); 236 237 /* Request scheduling of the bus dpc */ 238 extern void dhd_sched_dpc(dhd_pub_t *dhdp); 239 240 /* Notify tx completion */ 241 extern void dhd_txcomplete(dhd_pub_t *dhdp, void *txp, bool success); 242 243 /* Query ioctl */ 244 extern int dhdcdc_query_ioctl(dhd_pub_t *dhd, int ifidx, uint cmd, void *buf, uint len); 245 246 /* OS independent layer functions */ 247 extern int dhd_os_proto_block(dhd_pub_t * pub); 248 extern int dhd_os_proto_unblock(dhd_pub_t * pub); 249 extern int dhd_os_ioctl_resp_wait(dhd_pub_t * pub, uint * condition, bool * pending); 250 extern int dhd_os_ioctl_resp_wake(dhd_pub_t * pub); 251 extern unsigned int dhd_os_get_ioctl_resp_timeout(void); 252 extern void dhd_os_set_ioctl_resp_timeout(unsigned int timeout_msec); 253 extern void * dhd_os_open_image(char * filename); 254 extern int dhd_os_get_image_block(char * buf, int len, void * image); 255 extern void dhd_os_close_image(void * image); 256 extern void dhd_os_wd_timer(void *bus, uint wdtick); 257 extern void dhd_os_sdlock(dhd_pub_t * pub); 258 extern void dhd_os_sdunlock(dhd_pub_t * pub); 259 extern void dhd_os_sdlock_txq(dhd_pub_t * pub); 260 extern void dhd_os_sdunlock_txq(dhd_pub_t * pub); 261 extern void dhd_os_sdlock_rxq(dhd_pub_t * pub); 262 extern void dhd_os_sdunlock_rxq(dhd_pub_t * pub); 263 extern void dhd_os_sdlock_sndup_rxq(dhd_pub_t * pub); 264 extern void dhd_customer_gpio_wlan_ctrl(int onoff); 265 extern void dhd_os_sdunlock_sndup_rxq(dhd_pub_t * pub); 266 extern void dhd_os_sdlock_eventq(dhd_pub_t * pub); 267 extern void dhd_os_sdunlock_eventq(dhd_pub_t * pub); 268 #if defined(OOB_INTR_ONLY) 269 extern int dhd_customer_oob_irq_map(unsigned long *irq_flags_ptr); 270 #endif /* defined(OOB_INTR_ONLY) */ 271 extern void dhd_os_sdtxlock(dhd_pub_t * pub); 272 extern void dhd_os_sdtxunlock(dhd_pub_t * pub); 273 274 int setScheduler(struct task_struct *p, int policy, struct sched_param *param); 275 276 typedef struct { 277 uint32 limit; /* Expiration time (usec) */ 278 uint32 increment; /* Current expiration increment (usec) */ 279 uint32 elapsed; /* Current elapsed time (usec) */ 280 uint32 tick; /* O/S tick time (usec) */ 281 } dhd_timeout_t; 282 283 extern void dhd_timeout_start(dhd_timeout_t *tmo, uint usec); 284 extern int dhd_timeout_expired(dhd_timeout_t *tmo); 285 286 extern int dhd_ifname2idx(struct dhd_info *dhd, char *name); 287 extern uint8 *dhd_bssidx2bssid(dhd_pub_t *dhd, int idx); 288 extern int wl_host_event(struct dhd_info *dhd, int *idx, void *pktdata, 289 wl_event_msg_t *, void **data_ptr); 290 extern void wl_event_to_host_order(wl_event_msg_t * evt); 291 292 extern void dhd_common_init(void); 293 294 extern int dhd_add_if(struct dhd_info *dhd, int ifidx, void *handle, 295 char *name, uint8 *mac_addr, uint32 flags, uint8 bssidx); 296 extern void dhd_del_if(struct dhd_info *dhd, int ifidx); 297 298 extern void dhd_vif_add(struct dhd_info *dhd, int ifidx, char * name); 299 extern void dhd_vif_del(struct dhd_info *dhd, int ifidx); 300 301 extern void dhd_event(struct dhd_info *dhd, char *evpkt, int evlen, int ifidx); 302 extern void dhd_vif_sendup(struct dhd_info *dhd, int ifidx, uchar *cp, int len); 303 304 305 /* Send packet to dongle via data channel */ 306 extern int dhd_sendpkt(dhd_pub_t *dhdp, int ifidx, void *pkt); 307 308 /* Send event to host */ 309 extern void dhd_sendup_event(dhd_pub_t *dhdp, wl_event_msg_t *event, void *data); 310 extern int dhd_bus_devreset(dhd_pub_t *dhdp, uint8 flag); 311 extern uint dhd_bus_status(dhd_pub_t *dhdp); 312 extern int dhd_bus_start(dhd_pub_t *dhdp); 313 314 315 316 typedef enum cust_gpio_modes { 317 WLAN_RESET_ON, 318 WLAN_RESET_OFF, 319 WLAN_POWER_ON, 320 WLAN_POWER_OFF 321 } cust_gpio_modes_t; 322 extern int wl_iw_iscan_set_scan_broadcast_prep(struct net_device *dev, uint flag); 323 /* 324 * Insmod parameters for debug/test 325 */ 326 327 /* Watchdog timer interval */ 328 extern uint dhd_watchdog_ms; 329 330 331 /* Use interrupts */ 332 extern uint dhd_intr; 333 334 /* Use polling */ 335 extern uint dhd_poll; 336 337 /* Initial idletime ticks (may be -1 for immediate idle, 0 for no idle) */ 338 extern int dhd_idletime; 339 #define DHD_IDLETIME_TICKS 1 340 341 /* SDIO Drive Strength */ 342 extern uint dhd_sdiod_drive_strength; 343 344 /* Override to force tx queueing all the time */ 345 extern uint dhd_force_tx_queueing; 346 347 #ifdef SDTEST 348 /* Echo packet generator (SDIO), pkts/s */ 349 extern uint dhd_pktgen; 350 351 /* Echo packet len (0 => sawtooth, max 1800) */ 352 extern uint dhd_pktgen_len; 353 #define MAX_PKTGEN_LEN 1800 354 #endif 355 356 357 /* optionally set by a module_param_string() */ 358 #define MOD_PARAM_PATHLEN 2048 359 extern char fw_path[MOD_PARAM_PATHLEN]; 360 extern char nv_path[MOD_PARAM_PATHLEN]; 361 362 /* For supporting multiple interfaces */ 363 #define DHD_MAX_IFS 16 364 #define DHD_DEL_IF -0xe 365 #define DHD_BAD_IF -0xf 366 367 #ifdef APSTA_PINGTEST 368 #define MAX_GUEST 8 369 #endif 370 371 extern void dhd_wait_for_event(dhd_pub_t *dhd, bool *lockvar); 372 extern void dhd_wait_event_wakeup(dhd_pub_t*dhd); 373 374 #endif /* _dhd_h_ */ 375
