1*4882a593Smuzhiyun /* 2*4882a593Smuzhiyun * Dongle BUS interface Abstraction layer 3*4882a593Smuzhiyun * target serial buses like USB, SDIO, SPI, etc. 4*4882a593Smuzhiyun * 5*4882a593Smuzhiyun * Portions of this code are copyright (c) 2021 Cypress Semiconductor Corporation 6*4882a593Smuzhiyun * 7*4882a593Smuzhiyun * Copyright (C) 1999-2017, Broadcom Corporation 8*4882a593Smuzhiyun * 9*4882a593Smuzhiyun * Unless you and Broadcom execute a separate written software license 10*4882a593Smuzhiyun * agreement governing use of this software, this software is licensed to you 11*4882a593Smuzhiyun * under the terms of the GNU General Public License version 2 (the "GPL"), 12*4882a593Smuzhiyun * available at http://www.broadcom.com/licenses/GPLv2.php, with the 13*4882a593Smuzhiyun * following added to such license: 14*4882a593Smuzhiyun * 15*4882a593Smuzhiyun * As a special exception, the copyright holders of this software give you 16*4882a593Smuzhiyun * permission to link this software with independent modules, and to copy and 17*4882a593Smuzhiyun * distribute the resulting executable under terms of your choice, provided that 18*4882a593Smuzhiyun * you also meet, for each linked independent module, the terms and conditions of 19*4882a593Smuzhiyun * the license of that module. An independent module is a module which is not 20*4882a593Smuzhiyun * derived from this software. The special exception does not apply to any 21*4882a593Smuzhiyun * modifications of the software. 22*4882a593Smuzhiyun * 23*4882a593Smuzhiyun * Notwithstanding the above, under no circumstances may you combine this 24*4882a593Smuzhiyun * software in any way with any other Broadcom software provided under a license 25*4882a593Smuzhiyun * other than the GPL, without Broadcom's express prior written consent. 26*4882a593Smuzhiyun * 27*4882a593Smuzhiyun * 28*4882a593Smuzhiyun * <<Broadcom-WL-IPTag/Open:>> 29*4882a593Smuzhiyun * 30*4882a593Smuzhiyun * $Id: dbus.h 686618 2017-02-23 07:20:43Z $ 31*4882a593Smuzhiyun */ 32*4882a593Smuzhiyun 33*4882a593Smuzhiyun #ifndef __DBUS_H__ 34*4882a593Smuzhiyun #define __DBUS_H__ 35*4882a593Smuzhiyun 36*4882a593Smuzhiyun #include "typedefs.h" 37*4882a593Smuzhiyun 38*4882a593Smuzhiyun #define DBUSTRACE(args) 39*4882a593Smuzhiyun #define DBUSERR(args) 40*4882a593Smuzhiyun #define DBUSINFO(args) 41*4882a593Smuzhiyun #define DBUSDBGLOCK(args) 42*4882a593Smuzhiyun 43*4882a593Smuzhiyun enum { 44*4882a593Smuzhiyun DBUS_OK = 0, 45*4882a593Smuzhiyun DBUS_ERR = -200, 46*4882a593Smuzhiyun DBUS_ERR_TIMEOUT, 47*4882a593Smuzhiyun DBUS_ERR_DISCONNECT, 48*4882a593Smuzhiyun DBUS_ERR_NODEVICE, 49*4882a593Smuzhiyun DBUS_ERR_UNSUPPORTED, 50*4882a593Smuzhiyun DBUS_ERR_PENDING, 51*4882a593Smuzhiyun DBUS_ERR_NOMEM, 52*4882a593Smuzhiyun DBUS_ERR_TXFAIL, 53*4882a593Smuzhiyun DBUS_ERR_TXTIMEOUT, 54*4882a593Smuzhiyun DBUS_ERR_TXDROP, 55*4882a593Smuzhiyun DBUS_ERR_RXFAIL, 56*4882a593Smuzhiyun DBUS_ERR_RXDROP, 57*4882a593Smuzhiyun DBUS_ERR_TXCTLFAIL, 58*4882a593Smuzhiyun DBUS_ERR_RXCTLFAIL, 59*4882a593Smuzhiyun DBUS_ERR_REG_PARAM, 60*4882a593Smuzhiyun DBUS_STATUS_CANCELLED, 61*4882a593Smuzhiyun DBUS_ERR_NVRAM, 62*4882a593Smuzhiyun DBUS_JUMBO_NOMATCH, 63*4882a593Smuzhiyun DBUS_JUMBO_BAD_FORMAT, 64*4882a593Smuzhiyun DBUS_NVRAM_NONTXT, 65*4882a593Smuzhiyun DBUS_ERR_RXZLP 66*4882a593Smuzhiyun }; 67*4882a593Smuzhiyun 68*4882a593Smuzhiyun #define BCM_OTP_SIZE_43236 84 /* number of 16 bit values */ 69*4882a593Smuzhiyun #define BCM_OTP_SW_RGN_43236 24 /* start offset of SW config region */ 70*4882a593Smuzhiyun #define BCM_OTP_ADDR_43236 0x18000800 /* address of otp base */ 71*4882a593Smuzhiyun 72*4882a593Smuzhiyun #define ERR_CBMASK_TXFAIL 0x00000001 73*4882a593Smuzhiyun #define ERR_CBMASK_RXFAIL 0x00000002 74*4882a593Smuzhiyun #define ERR_CBMASK_ALL 0xFFFFFFFF 75*4882a593Smuzhiyun 76*4882a593Smuzhiyun #define DBUS_CBCTL_WRITE 0 77*4882a593Smuzhiyun #define DBUS_CBCTL_READ 1 78*4882a593Smuzhiyun #if defined(INTR_EP_ENABLE) 79*4882a593Smuzhiyun #define DBUS_CBINTR_POLL 2 80*4882a593Smuzhiyun #endif /* defined(INTR_EP_ENABLE) */ 81*4882a593Smuzhiyun 82*4882a593Smuzhiyun #define DBUS_TX_RETRY_LIMIT 3 /* retries for failed txirb */ 83*4882a593Smuzhiyun #define DBUS_TX_TIMEOUT_INTERVAL 250 /* timeout for txirb complete, in ms */ 84*4882a593Smuzhiyun 85*4882a593Smuzhiyun #define DBUS_BUFFER_SIZE_TX 32000 86*4882a593Smuzhiyun #define DBUS_BUFFER_SIZE_RX 24000 87*4882a593Smuzhiyun 88*4882a593Smuzhiyun #define DBUS_BUFFER_SIZE_TX_NOAGG 2048 89*4882a593Smuzhiyun #define DBUS_BUFFER_SIZE_RX_NOAGG 2048 90*4882a593Smuzhiyun 91*4882a593Smuzhiyun /** DBUS types */ 92*4882a593Smuzhiyun enum { 93*4882a593Smuzhiyun DBUS_USB, 94*4882a593Smuzhiyun DBUS_SDIO, 95*4882a593Smuzhiyun DBUS_SPI, 96*4882a593Smuzhiyun DBUS_UNKNOWN 97*4882a593Smuzhiyun }; 98*4882a593Smuzhiyun 99*4882a593Smuzhiyun enum dbus_state { 100*4882a593Smuzhiyun DBUS_STATE_DL_PENDING, 101*4882a593Smuzhiyun DBUS_STATE_DL_DONE, 102*4882a593Smuzhiyun DBUS_STATE_UP, 103*4882a593Smuzhiyun DBUS_STATE_DOWN, 104*4882a593Smuzhiyun DBUS_STATE_PNP_FWDL, 105*4882a593Smuzhiyun DBUS_STATE_DISCONNECT, 106*4882a593Smuzhiyun DBUS_STATE_SLEEP, 107*4882a593Smuzhiyun DBUS_STATE_DL_NEEDED 108*4882a593Smuzhiyun }; 109*4882a593Smuzhiyun 110*4882a593Smuzhiyun enum dbus_pnp_state { 111*4882a593Smuzhiyun DBUS_PNP_DISCONNECT, 112*4882a593Smuzhiyun DBUS_PNP_SLEEP, 113*4882a593Smuzhiyun DBUS_PNP_RESUME 114*4882a593Smuzhiyun }; 115*4882a593Smuzhiyun 116*4882a593Smuzhiyun enum dbus_file { 117*4882a593Smuzhiyun DBUS_FIRMWARE, 118*4882a593Smuzhiyun DBUS_NVFILE 119*4882a593Smuzhiyun }; 120*4882a593Smuzhiyun 121*4882a593Smuzhiyun typedef enum _DEVICE_SPEED { 122*4882a593Smuzhiyun INVALID_SPEED = -1, 123*4882a593Smuzhiyun LOW_SPEED = 1, /**< USB 1.1: 1.5 Mbps */ 124*4882a593Smuzhiyun FULL_SPEED, /**< USB 1.1: 12 Mbps */ 125*4882a593Smuzhiyun HIGH_SPEED, /**< USB 2.0: 480 Mbps */ 126*4882a593Smuzhiyun SUPER_SPEED, /**< USB 3.0: 4.8 Gbps */ 127*4882a593Smuzhiyun } DEVICE_SPEED; 128*4882a593Smuzhiyun 129*4882a593Smuzhiyun typedef struct { 130*4882a593Smuzhiyun int bustype; 131*4882a593Smuzhiyun int vid; 132*4882a593Smuzhiyun int pid; 133*4882a593Smuzhiyun int devid; 134*4882a593Smuzhiyun int chiprev; /**< chip revsion number */ 135*4882a593Smuzhiyun int mtu; 136*4882a593Smuzhiyun int nchan; /**< Data Channels */ 137*4882a593Smuzhiyun int has_2nd_bulk_in_ep; 138*4882a593Smuzhiyun } dbus_attrib_t; 139*4882a593Smuzhiyun 140*4882a593Smuzhiyun /* FIX: Account for errors related to DBUS; 141*4882a593Smuzhiyun * Let upper layer account for packets/bytes 142*4882a593Smuzhiyun */ 143*4882a593Smuzhiyun typedef struct { 144*4882a593Smuzhiyun uint32 rx_errors; 145*4882a593Smuzhiyun uint32 tx_errors; 146*4882a593Smuzhiyun uint32 rx_dropped; 147*4882a593Smuzhiyun uint32 tx_dropped; 148*4882a593Smuzhiyun } dbus_stats_t; 149*4882a593Smuzhiyun 150*4882a593Smuzhiyun /** 151*4882a593Smuzhiyun * Configurable BUS parameters 152*4882a593Smuzhiyun */ 153*4882a593Smuzhiyun enum { 154*4882a593Smuzhiyun DBUS_CONFIG_ID_RXCTL_DEFERRES = 1, 155*4882a593Smuzhiyun DBUS_CONFIG_ID_AGGR_LIMIT, 156*4882a593Smuzhiyun DBUS_CONFIG_ID_KEEPIF_ON_DEVRESET 157*4882a593Smuzhiyun }; 158*4882a593Smuzhiyun 159*4882a593Smuzhiyun typedef struct { 160*4882a593Smuzhiyun uint32 config_id; 161*4882a593Smuzhiyun union { 162*4882a593Smuzhiyun uint32 general_param; 163*4882a593Smuzhiyun bool rxctl_deferrespok; 164*4882a593Smuzhiyun struct { 165*4882a593Smuzhiyun int maxrxsf; 166*4882a593Smuzhiyun int maxrxsize; 167*4882a593Smuzhiyun int maxtxsf; 168*4882a593Smuzhiyun int maxtxsize; 169*4882a593Smuzhiyun } aggr_param; 170*4882a593Smuzhiyun }; 171*4882a593Smuzhiyun } dbus_config_t; 172*4882a593Smuzhiyun 173*4882a593Smuzhiyun /** 174*4882a593Smuzhiyun * External Download Info 175*4882a593Smuzhiyun */ 176*4882a593Smuzhiyun typedef struct dbus_extdl { 177*4882a593Smuzhiyun uint8 *fw; 178*4882a593Smuzhiyun int fwlen; 179*4882a593Smuzhiyun uint8 *vars; 180*4882a593Smuzhiyun int varslen; 181*4882a593Smuzhiyun } dbus_extdl_t; 182*4882a593Smuzhiyun 183*4882a593Smuzhiyun struct dbus_callbacks; 184*4882a593Smuzhiyun struct exec_parms; 185*4882a593Smuzhiyun 186*4882a593Smuzhiyun typedef void *(*probe_cb_t)(void *arg, const char *desc, uint32 bustype, uint32 hdrlen); 187*4882a593Smuzhiyun typedef void (*disconnect_cb_t)(void *arg); 188*4882a593Smuzhiyun typedef void *(*exec_cb_t)(struct exec_parms *args); 189*4882a593Smuzhiyun 190*4882a593Smuzhiyun /** Client callbacks registered during dbus_attach() */ 191*4882a593Smuzhiyun typedef struct dbus_callbacks { 192*4882a593Smuzhiyun void (*send_complete)(void *cbarg, void *info, int status); 193*4882a593Smuzhiyun void (*recv_buf)(void *cbarg, uint8 *buf, int len); 194*4882a593Smuzhiyun void (*recv_pkt)(void *cbarg, void *pkt); 195*4882a593Smuzhiyun void (*txflowcontrol)(void *cbarg, bool onoff); 196*4882a593Smuzhiyun void (*errhandler)(void *cbarg, int err); 197*4882a593Smuzhiyun void (*ctl_complete)(void *cbarg, int type, int status); 198*4882a593Smuzhiyun void (*state_change)(void *cbarg, int state); 199*4882a593Smuzhiyun void *(*pktget)(void *cbarg, uint len, bool send); 200*4882a593Smuzhiyun void (*pktfree)(void *cbarg, void *p, bool send); 201*4882a593Smuzhiyun } dbus_callbacks_t; 202*4882a593Smuzhiyun 203*4882a593Smuzhiyun struct dbus_pub; 204*4882a593Smuzhiyun struct bcmstrbuf; 205*4882a593Smuzhiyun struct dbus_irb; 206*4882a593Smuzhiyun struct dbus_irb_rx; 207*4882a593Smuzhiyun struct dbus_irb_tx; 208*4882a593Smuzhiyun struct dbus_intf_callbacks; 209*4882a593Smuzhiyun 210*4882a593Smuzhiyun typedef struct { 211*4882a593Smuzhiyun void* (*attach)(struct dbus_pub *pub, void *cbarg, struct dbus_intf_callbacks *cbs); 212*4882a593Smuzhiyun void (*detach)(struct dbus_pub *pub, void *bus); 213*4882a593Smuzhiyun 214*4882a593Smuzhiyun int (*up)(void *bus); 215*4882a593Smuzhiyun int (*down)(void *bus); 216*4882a593Smuzhiyun int (*send_irb)(void *bus, struct dbus_irb_tx *txirb); 217*4882a593Smuzhiyun int (*recv_irb)(void *bus, struct dbus_irb_rx *rxirb); 218*4882a593Smuzhiyun int (*cancel_irb)(void *bus, struct dbus_irb_tx *txirb); 219*4882a593Smuzhiyun int (*send_ctl)(void *bus, uint8 *buf, int len); 220*4882a593Smuzhiyun int (*recv_ctl)(void *bus, uint8 *buf, int len); 221*4882a593Smuzhiyun int (*get_stats)(void *bus, dbus_stats_t *stats); 222*4882a593Smuzhiyun int (*get_attrib)(void *bus, dbus_attrib_t *attrib); 223*4882a593Smuzhiyun 224*4882a593Smuzhiyun int (*pnp)(void *bus, int evnt); 225*4882a593Smuzhiyun int (*remove)(void *bus); 226*4882a593Smuzhiyun int (*resume)(void *bus); 227*4882a593Smuzhiyun int (*suspend)(void *bus); 228*4882a593Smuzhiyun int (*stop)(void *bus); 229*4882a593Smuzhiyun int (*reset)(void *bus); 230*4882a593Smuzhiyun 231*4882a593Smuzhiyun /* Access to bus buffers directly */ 232*4882a593Smuzhiyun void *(*pktget)(void *bus, int len); 233*4882a593Smuzhiyun void (*pktfree)(void *bus, void *pkt); 234*4882a593Smuzhiyun 235*4882a593Smuzhiyun int (*iovar_op)(void *bus, const char *name, void *params, int plen, void *arg, int len, 236*4882a593Smuzhiyun bool set); 237*4882a593Smuzhiyun void (*dump)(void *bus, struct bcmstrbuf *strbuf); 238*4882a593Smuzhiyun int (*set_config)(void *bus, dbus_config_t *config); 239*4882a593Smuzhiyun int (*get_config)(void *bus, dbus_config_t *config); 240*4882a593Smuzhiyun 241*4882a593Smuzhiyun bool (*device_exists)(void *bus); 242*4882a593Smuzhiyun bool (*dlneeded)(void *bus); 243*4882a593Smuzhiyun int (*dlstart)(void *bus, uint8 *fw, int len); 244*4882a593Smuzhiyun int (*dlrun)(void *bus); 245*4882a593Smuzhiyun bool (*recv_needed)(void *bus); 246*4882a593Smuzhiyun 247*4882a593Smuzhiyun void *(*exec_rxlock)(void *bus, exec_cb_t func, struct exec_parms *args); 248*4882a593Smuzhiyun void *(*exec_txlock)(void *bus, exec_cb_t func, struct exec_parms *args); 249*4882a593Smuzhiyun 250*4882a593Smuzhiyun int (*tx_timer_init)(void *bus); 251*4882a593Smuzhiyun int (*tx_timer_start)(void *bus, uint timeout); 252*4882a593Smuzhiyun int (*tx_timer_stop)(void *bus); 253*4882a593Smuzhiyun 254*4882a593Smuzhiyun int (*sched_dpc)(void *bus); 255*4882a593Smuzhiyun int (*lock)(void *bus); 256*4882a593Smuzhiyun int (*unlock)(void *bus); 257*4882a593Smuzhiyun int (*sched_probe_cb)(void *bus); 258*4882a593Smuzhiyun 259*4882a593Smuzhiyun int (*shutdown)(void *bus); 260*4882a593Smuzhiyun 261*4882a593Smuzhiyun int (*recv_stop)(void *bus); 262*4882a593Smuzhiyun int (*recv_resume)(void *bus); 263*4882a593Smuzhiyun 264*4882a593Smuzhiyun int (*recv_irb_from_ep)(void *bus, struct dbus_irb_rx *rxirb, uint ep_idx); 265*4882a593Smuzhiyun 266*4882a593Smuzhiyun int (*readreg)(void *bus, uint32 regaddr, int datalen, uint32 *value); 267*4882a593Smuzhiyun 268*4882a593Smuzhiyun /* Add from the bottom */ 269*4882a593Smuzhiyun } dbus_intf_t; 270*4882a593Smuzhiyun 271*4882a593Smuzhiyun typedef struct dbus_pub { 272*4882a593Smuzhiyun struct osl_info *osh; 273*4882a593Smuzhiyun dbus_stats_t stats; 274*4882a593Smuzhiyun dbus_attrib_t attrib; 275*4882a593Smuzhiyun enum dbus_state busstate; 276*4882a593Smuzhiyun DEVICE_SPEED device_speed; 277*4882a593Smuzhiyun int ntxq, nrxq, rxsize; 278*4882a593Smuzhiyun void *bus; 279*4882a593Smuzhiyun struct shared_info *sh; 280*4882a593Smuzhiyun void *dev_info; 281*4882a593Smuzhiyun } dbus_pub_t; 282*4882a593Smuzhiyun 283*4882a593Smuzhiyun #define BUS_INFO(bus, type) (((type *) bus)->pub->bus) 284*4882a593Smuzhiyun 285*4882a593Smuzhiyun #define ALIGNED_LOCAL_VARIABLE(var, align) \ 286*4882a593Smuzhiyun uint8 buffer[SDALIGN+64]; \ 287*4882a593Smuzhiyun uint8 *var = (uint8 *)(((uintptr)&buffer[0]) & ~(align-1)) + align; 288*4882a593Smuzhiyun 289*4882a593Smuzhiyun /* 290*4882a593Smuzhiyun * Public Bus Function Interface 291*4882a593Smuzhiyun */ 292*4882a593Smuzhiyun 293*4882a593Smuzhiyun /* 294*4882a593Smuzhiyun * FIX: Is there better way to pass OS/Host handles to DBUS but still 295*4882a593Smuzhiyun * maintain common interface for all OS?? 296*4882a593Smuzhiyun * Under NDIS, param1 needs to be MiniportHandle 297*4882a593Smuzhiyun * For NDIS60, param2 is WdfDevice 298*4882a593Smuzhiyun * Under Linux, param1 and param2 are NULL; 299*4882a593Smuzhiyun */ 300*4882a593Smuzhiyun extern int dbus_register(int vid, int pid, probe_cb_t prcb, disconnect_cb_t discb, void *prarg, 301*4882a593Smuzhiyun void *param1, void *param2); 302*4882a593Smuzhiyun extern int dbus_deregister(void); 303*4882a593Smuzhiyun 304*4882a593Smuzhiyun extern dbus_pub_t *dbus_attach(struct osl_info *osh, int rxsize, int nrxq, int ntxq, 305*4882a593Smuzhiyun void *cbarg, dbus_callbacks_t *cbs, dbus_extdl_t *extdl, struct shared_info *sh); 306*4882a593Smuzhiyun extern void dbus_detach(dbus_pub_t *pub); 307*4882a593Smuzhiyun 308*4882a593Smuzhiyun extern int dbus_download_firmware(dbus_pub_t *pub); 309*4882a593Smuzhiyun extern int dbus_up(dbus_pub_t *pub); 310*4882a593Smuzhiyun extern int dbus_down(dbus_pub_t *pub); 311*4882a593Smuzhiyun extern int dbus_stop(dbus_pub_t *pub); 312*4882a593Smuzhiyun extern int dbus_shutdown(dbus_pub_t *pub); 313*4882a593Smuzhiyun extern void dbus_flowctrl_rx(dbus_pub_t *pub, bool on); 314*4882a593Smuzhiyun 315*4882a593Smuzhiyun extern int dbus_send_txdata(dbus_pub_t *dbus, void *pktbuf); 316*4882a593Smuzhiyun extern int dbus_send_buf(dbus_pub_t *pub, uint8 *buf, int len, void *info); 317*4882a593Smuzhiyun extern int dbus_send_pkt(dbus_pub_t *pub, void *pkt, void *info); 318*4882a593Smuzhiyun extern int dbus_send_ctl(dbus_pub_t *pub, uint8 *buf, int len); 319*4882a593Smuzhiyun extern int dbus_recv_ctl(dbus_pub_t *pub, uint8 *buf, int len); 320*4882a593Smuzhiyun extern int dbus_recv_bulk(dbus_pub_t *pub, uint32 ep_idx); 321*4882a593Smuzhiyun extern int dbus_poll_intr(dbus_pub_t *pub); 322*4882a593Smuzhiyun extern int dbus_get_stats(dbus_pub_t *pub, dbus_stats_t *stats); 323*4882a593Smuzhiyun extern int dbus_get_attrib(dbus_pub_t *pub, dbus_attrib_t *attrib); 324*4882a593Smuzhiyun extern int dbus_get_device_speed(dbus_pub_t *pub); 325*4882a593Smuzhiyun extern int dbus_set_config(dbus_pub_t *pub, dbus_config_t *config); 326*4882a593Smuzhiyun extern int dbus_get_config(dbus_pub_t *pub, dbus_config_t *config); 327*4882a593Smuzhiyun extern void * dbus_get_devinfo(dbus_pub_t *pub); 328*4882a593Smuzhiyun 329*4882a593Smuzhiyun extern void *dbus_pktget(dbus_pub_t *pub, int len); 330*4882a593Smuzhiyun extern void dbus_pktfree(dbus_pub_t *pub, void* pkt); 331*4882a593Smuzhiyun 332*4882a593Smuzhiyun extern int dbus_set_errmask(dbus_pub_t *pub, uint32 mask); 333*4882a593Smuzhiyun extern int dbus_pnp_sleep(dbus_pub_t *pub); 334*4882a593Smuzhiyun extern int dbus_pnp_resume(dbus_pub_t *pub, int *fw_reload); 335*4882a593Smuzhiyun extern int dbus_pnp_disconnect(dbus_pub_t *pub); 336*4882a593Smuzhiyun 337*4882a593Smuzhiyun extern int dbus_iovar_op(dbus_pub_t *pub, const char *name, 338*4882a593Smuzhiyun void *params, int plen, void *arg, int len, bool set); 339*4882a593Smuzhiyun 340*4882a593Smuzhiyun extern void *dhd_dbus_txq(const dbus_pub_t *pub); 341*4882a593Smuzhiyun extern uint dhd_dbus_hdrlen(const dbus_pub_t *pub); 342*4882a593Smuzhiyun 343*4882a593Smuzhiyun /* 344*4882a593Smuzhiyun * Private Common Bus Interface 345*4882a593Smuzhiyun */ 346*4882a593Smuzhiyun 347*4882a593Smuzhiyun /** IO Request Block (IRB) */ 348*4882a593Smuzhiyun typedef struct dbus_irb { 349*4882a593Smuzhiyun struct dbus_irb *next; /**< it's casted from dbus_irb_tx or dbus_irb_rx struct */ 350*4882a593Smuzhiyun } dbus_irb_t; 351*4882a593Smuzhiyun 352*4882a593Smuzhiyun typedef struct dbus_irb_rx { 353*4882a593Smuzhiyun struct dbus_irb irb; /* Must be first */ 354*4882a593Smuzhiyun uint8 *buf; 355*4882a593Smuzhiyun int buf_len; 356*4882a593Smuzhiyun int actual_len; 357*4882a593Smuzhiyun void *pkt; 358*4882a593Smuzhiyun void *info; 359*4882a593Smuzhiyun void *arg; 360*4882a593Smuzhiyun } dbus_irb_rx_t; 361*4882a593Smuzhiyun 362*4882a593Smuzhiyun typedef struct dbus_irb_tx { 363*4882a593Smuzhiyun struct dbus_irb irb; /** Must be first */ 364*4882a593Smuzhiyun uint8 *buf; /** mutually exclusive with struct member 'pkt' */ 365*4882a593Smuzhiyun int len; /** length of field 'buf' */ 366*4882a593Smuzhiyun void *pkt; /** mutually exclusive with struct member 'buf' */ 367*4882a593Smuzhiyun int retry_count; 368*4882a593Smuzhiyun void *info; 369*4882a593Smuzhiyun void *arg; 370*4882a593Smuzhiyun void *send_buf; /**< linear bufffer for LINUX when aggreagtion is enabled */ 371*4882a593Smuzhiyun } dbus_irb_tx_t; 372*4882a593Smuzhiyun 373*4882a593Smuzhiyun /** 374*4882a593Smuzhiyun * DBUS interface callbacks are different from user callbacks 375*4882a593Smuzhiyun * so, internally, different info can be passed to upper layer 376*4882a593Smuzhiyun */ 377*4882a593Smuzhiyun typedef struct dbus_intf_callbacks { 378*4882a593Smuzhiyun void (*send_irb_timeout)(void *cbarg, dbus_irb_tx_t *txirb); 379*4882a593Smuzhiyun void (*send_irb_complete)(void *cbarg, dbus_irb_tx_t *txirb, int status); 380*4882a593Smuzhiyun void (*recv_irb_complete)(void *cbarg, dbus_irb_rx_t *rxirb, int status); 381*4882a593Smuzhiyun void (*errhandler)(void *cbarg, int err); 382*4882a593Smuzhiyun void (*ctl_complete)(void *cbarg, int type, int status); 383*4882a593Smuzhiyun void (*state_change)(void *cbarg, int state); 384*4882a593Smuzhiyun bool (*isr)(void *cbarg, bool *wantdpc); 385*4882a593Smuzhiyun bool (*dpc)(void *cbarg, bool bounded); 386*4882a593Smuzhiyun void (*watchdog)(void *cbarg); 387*4882a593Smuzhiyun void *(*pktget)(void *cbarg, uint len, bool send); 388*4882a593Smuzhiyun void (*pktfree)(void *cbarg, void *p, bool send); 389*4882a593Smuzhiyun struct dbus_irb* (*getirb)(void *cbarg, bool send); 390*4882a593Smuzhiyun void (*rxerr_indicate)(void *cbarg, bool on); 391*4882a593Smuzhiyun } dbus_intf_callbacks_t; 392*4882a593Smuzhiyun 393*4882a593Smuzhiyun /* 394*4882a593Smuzhiyun * Porting: To support new bus, port these functions below 395*4882a593Smuzhiyun */ 396*4882a593Smuzhiyun 397*4882a593Smuzhiyun /* 398*4882a593Smuzhiyun * Bus specific Interface 399*4882a593Smuzhiyun * Implemented by dbus_usb.c/dbus_sdio.c 400*4882a593Smuzhiyun */ 401*4882a593Smuzhiyun extern int dbus_bus_register(int vid, int pid, probe_cb_t prcb, disconnect_cb_t discb, void *prarg, 402*4882a593Smuzhiyun dbus_intf_t **intf, void *param1, void *param2); 403*4882a593Smuzhiyun extern int dbus_bus_deregister(void); 404*4882a593Smuzhiyun extern void dbus_bus_fw_get(void *bus, uint8 **fw, int *fwlen, int *decomp); 405*4882a593Smuzhiyun 406*4882a593Smuzhiyun /* 407*4882a593Smuzhiyun * Bus-specific and OS-specific Interface 408*4882a593Smuzhiyun * Implemented by dbus_usb_[linux/ndis].c/dbus_sdio_[linux/ndis].c 409*4882a593Smuzhiyun */ 410*4882a593Smuzhiyun extern int dbus_bus_osl_register(int vid, int pid, probe_cb_t prcb, disconnect_cb_t discb, 411*4882a593Smuzhiyun void *prarg, dbus_intf_t **intf, void *param1, void *param2); 412*4882a593Smuzhiyun extern int dbus_bus_osl_deregister(void); 413*4882a593Smuzhiyun 414*4882a593Smuzhiyun /* 415*4882a593Smuzhiyun * Bus-specific, OS-specific, HW-specific Interface 416*4882a593Smuzhiyun * Mainly for SDIO Host HW controller 417*4882a593Smuzhiyun */ 418*4882a593Smuzhiyun extern int dbus_bus_osl_hw_register(int vid, int pid, probe_cb_t prcb, disconnect_cb_t discb, 419*4882a593Smuzhiyun void *prarg, dbus_intf_t **intf); 420*4882a593Smuzhiyun extern int dbus_bus_osl_hw_deregister(void); 421*4882a593Smuzhiyun 422*4882a593Smuzhiyun extern uint usbdev_bulkin_eps(void); 423*4882a593Smuzhiyun #if defined(BCM_REQUEST_FW) 424*4882a593Smuzhiyun extern void *dbus_get_fw_nvfile(int devid, int chiprev, uint8 **fw, int *fwlen, int type, 425*4882a593Smuzhiyun uint16 boardtype, uint16 boardrev); 426*4882a593Smuzhiyun extern void dbus_release_fw_nvfile(void *firmware); 427*4882a593Smuzhiyun #endif /* #if defined(BCM_REQUEST_FW) */ 428*4882a593Smuzhiyun 429*4882a593Smuzhiyun #if defined(EHCI_FASTPATH_TX) || defined(EHCI_FASTPATH_RX) 430*4882a593Smuzhiyun 431*4882a593Smuzhiyun #if (LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 0)) 432*4882a593Smuzhiyun /* Backward compatibility */ 433*4882a593Smuzhiyun typedef unsigned int gfp_t; 434*4882a593Smuzhiyun 435*4882a593Smuzhiyun #define dma_pool pci_pool 436*4882a593Smuzhiyun #define dma_pool_create(name, dev, size, align, alloc) \ 437*4882a593Smuzhiyun pci_pool_create(name, dev, size, align, alloc, GFP_DMA | GFP_ATOMIC) 438*4882a593Smuzhiyun #define dma_pool_destroy(pool) pci_pool_destroy(pool) 439*4882a593Smuzhiyun #define dma_pool_alloc(pool, flags, handle) pci_pool_alloc(pool, flags, handle) 440*4882a593Smuzhiyun #define dma_pool_free(pool, vaddr, addr) pci_pool_free(pool, vaddr, addr) 441*4882a593Smuzhiyun 442*4882a593Smuzhiyun #define dma_map_single(dev, addr, size, dir) pci_map_single(dev, addr, size, dir) 443*4882a593Smuzhiyun #define dma_unmap_single(dev, hnd, size, dir) pci_unmap_single(dev, hnd, size, dir) 444*4882a593Smuzhiyun #define DMA_FROM_DEVICE PCI_DMA_FROMDEVICE 445*4882a593Smuzhiyun #define DMA_TO_DEVICE PCI_DMA_TODEVICE 446*4882a593Smuzhiyun #endif /* (LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 0)) */ 447*4882a593Smuzhiyun 448*4882a593Smuzhiyun /* Availability of these functions varies (when present, they have two arguments) */ 449*4882a593Smuzhiyun #ifndef hc32_to_cpu 450*4882a593Smuzhiyun #define hc32_to_cpu(x) le32_to_cpu(x) 451*4882a593Smuzhiyun #define cpu_to_hc32(x) cpu_to_le32(x) 452*4882a593Smuzhiyun typedef unsigned int __hc32; 453*4882a593Smuzhiyun #else 454*4882a593Smuzhiyun #error Two-argument functions needed 455*4882a593Smuzhiyun #endif // endif 456*4882a593Smuzhiyun 457*4882a593Smuzhiyun /* Private USB opcode base */ 458*4882a593Smuzhiyun #define EHCI_FASTPATH 0x31 459*4882a593Smuzhiyun #define EHCI_SET_EP_BYPASS EHCI_FASTPATH 460*4882a593Smuzhiyun #define EHCI_SET_BYPASS_CB (EHCI_FASTPATH + 1) 461*4882a593Smuzhiyun #define EHCI_SET_BYPASS_DEV (EHCI_FASTPATH + 2) 462*4882a593Smuzhiyun #define EHCI_DUMP_STATE (EHCI_FASTPATH + 3) 463*4882a593Smuzhiyun #define EHCI_SET_BYPASS_POOL (EHCI_FASTPATH + 4) 464*4882a593Smuzhiyun #define EHCI_CLR_EP_BYPASS (EHCI_FASTPATH + 5) 465*4882a593Smuzhiyun 466*4882a593Smuzhiyun /* 467*4882a593Smuzhiyun * EHCI QTD structure (hardware and extension) 468*4882a593Smuzhiyun * NOTE that is does not need to (and does not) match its kernel counterpart 469*4882a593Smuzhiyun */ 470*4882a593Smuzhiyun #define EHCI_QTD_NBUFFERS 5 471*4882a593Smuzhiyun #define EHCI_QTD_ALIGN 32 472*4882a593Smuzhiyun #define EHCI_BULK_PACKET_SIZE 512 473*4882a593Smuzhiyun #define EHCI_QTD_XACTERR_MAX 32 474*4882a593Smuzhiyun 475*4882a593Smuzhiyun struct ehci_qtd { 476*4882a593Smuzhiyun /* Hardware map */ 477*4882a593Smuzhiyun volatile uint32_t qtd_next; 478*4882a593Smuzhiyun volatile uint32_t qtd_altnext; 479*4882a593Smuzhiyun volatile uint32_t qtd_status; 480*4882a593Smuzhiyun #define EHCI_QTD_GET_BYTES(x) (((x)>>16) & 0x7fff) 481*4882a593Smuzhiyun #define EHCI_QTD_IOC 0x00008000 482*4882a593Smuzhiyun #define EHCI_QTD_GET_CERR(x) (((x)>>10) & 0x3) 483*4882a593Smuzhiyun #define EHCI_QTD_SET_CERR(x) ((x) << 10) 484*4882a593Smuzhiyun #define EHCI_QTD_GET_PID(x) (((x)>>8) & 0x3) 485*4882a593Smuzhiyun #define EHCI_QTD_SET_PID(x) ((x) << 8) 486*4882a593Smuzhiyun #define EHCI_QTD_ACTIVE 0x80 487*4882a593Smuzhiyun #define EHCI_QTD_HALTED 0x40 488*4882a593Smuzhiyun #define EHCI_QTD_BUFERR 0x20 489*4882a593Smuzhiyun #define EHCI_QTD_BABBLE 0x10 490*4882a593Smuzhiyun #define EHCI_QTD_XACTERR 0x08 491*4882a593Smuzhiyun #define EHCI_QTD_MISSEDMICRO 0x04 492*4882a593Smuzhiyun volatile uint32_t qtd_buffer[EHCI_QTD_NBUFFERS]; 493*4882a593Smuzhiyun volatile uint32_t qtd_buffer_hi[EHCI_QTD_NBUFFERS]; 494*4882a593Smuzhiyun 495*4882a593Smuzhiyun /* Implementation extension */ 496*4882a593Smuzhiyun dma_addr_t qtd_self; /**< own hardware address */ 497*4882a593Smuzhiyun struct ehci_qtd *obj_next; /**< software link to the next QTD */ 498*4882a593Smuzhiyun void *rpc; /**< pointer to the rpc buffer */ 499*4882a593Smuzhiyun size_t length; /**< length of the data in the buffer */ 500*4882a593Smuzhiyun void *buff; /**< pointer to the reassembly buffer */ 501*4882a593Smuzhiyun int xacterrs; /**< retry counter for qtd xact error */ 502*4882a593Smuzhiyun } __attribute__ ((aligned(EHCI_QTD_ALIGN))); 503*4882a593Smuzhiyun 504*4882a593Smuzhiyun #define EHCI_NULL __constant_cpu_to_le32(1) /* HW null pointer shall be odd */ 505*4882a593Smuzhiyun 506*4882a593Smuzhiyun #define SHORT_READ_Q(token) (EHCI_QTD_GET_BYTES(token) != 0 && EHCI_QTD_GET_PID(token) == 1) 507*4882a593Smuzhiyun 508*4882a593Smuzhiyun /** 509*4882a593Smuzhiyun * Queue Head 510*4882a593Smuzhiyun * NOTE This structure is slightly different from the one in the kernel; but needs to stay 511*4882a593Smuzhiyun * compatible. 512*4882a593Smuzhiyun */ 513*4882a593Smuzhiyun struct ehci_qh { 514*4882a593Smuzhiyun /* Hardware map */ 515*4882a593Smuzhiyun volatile uint32_t qh_link; 516*4882a593Smuzhiyun volatile uint32_t qh_endp; 517*4882a593Smuzhiyun volatile uint32_t qh_endphub; 518*4882a593Smuzhiyun volatile uint32_t qh_curqtd; 519*4882a593Smuzhiyun 520*4882a593Smuzhiyun /* QTD overlay */ 521*4882a593Smuzhiyun volatile uint32_t ow_next; 522*4882a593Smuzhiyun volatile uint32_t ow_altnext; 523*4882a593Smuzhiyun volatile uint32_t ow_status; 524*4882a593Smuzhiyun volatile uint32_t ow_buffer [EHCI_QTD_NBUFFERS]; 525*4882a593Smuzhiyun volatile uint32_t ow_buffer_hi [EHCI_QTD_NBUFFERS]; 526*4882a593Smuzhiyun 527*4882a593Smuzhiyun /* Extension (should match the kernel layout) */ 528*4882a593Smuzhiyun dma_addr_t unused0; 529*4882a593Smuzhiyun void *unused1; 530*4882a593Smuzhiyun struct list_head unused2; 531*4882a593Smuzhiyun struct ehci_qtd *dummy; 532*4882a593Smuzhiyun struct ehci_qh *unused3; 533*4882a593Smuzhiyun 534*4882a593Smuzhiyun struct ehci_hcd *unused4; 535*4882a593Smuzhiyun #if (LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 0)) 536*4882a593Smuzhiyun struct kref unused5; 537*4882a593Smuzhiyun unsigned unused6; 538*4882a593Smuzhiyun 539*4882a593Smuzhiyun uint8_t unused7; 540*4882a593Smuzhiyun 541*4882a593Smuzhiyun /* periodic schedule info */ 542*4882a593Smuzhiyun uint8_t unused8; 543*4882a593Smuzhiyun uint8_t unused9; 544*4882a593Smuzhiyun uint8_t unused10; 545*4882a593Smuzhiyun uint16_t unused11; 546*4882a593Smuzhiyun uint16_t unused12; 547*4882a593Smuzhiyun uint16_t unused13; 548*4882a593Smuzhiyun struct usb_device *unused14; 549*4882a593Smuzhiyun #else 550*4882a593Smuzhiyun unsigned unused5; 551*4882a593Smuzhiyun 552*4882a593Smuzhiyun u8 unused6; 553*4882a593Smuzhiyun 554*4882a593Smuzhiyun /* periodic schedule info */ 555*4882a593Smuzhiyun u8 unused7; 556*4882a593Smuzhiyun u8 unused8; 557*4882a593Smuzhiyun u8 unused9; 558*4882a593Smuzhiyun unsigned short unused10; 559*4882a593Smuzhiyun unsigned short unused11; 560*4882a593Smuzhiyun #define NO_FRAME ((unsigned short)~0) 561*4882a593Smuzhiyun #ifdef EHCI_QUIRK_FIX 562*4882a593Smuzhiyun struct usb_device *unused12; 563*4882a593Smuzhiyun #endif /* EHCI_QUIRK_FIX */ 564*4882a593Smuzhiyun #endif /* (LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 0)) */ 565*4882a593Smuzhiyun struct ehci_qtd *first_qtd; 566*4882a593Smuzhiyun /* Link to the first QTD; this is an optimized equivalent of the qtd_list field */ 567*4882a593Smuzhiyun /* NOTE that ehci_qh in ehci.h shall reserve this word */ 568*4882a593Smuzhiyun } __attribute__ ((aligned(EHCI_QTD_ALIGN))); 569*4882a593Smuzhiyun 570*4882a593Smuzhiyun #if (LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 0)) 571*4882a593Smuzhiyun /** The corresponding structure in the kernel is used to get the QH */ 572*4882a593Smuzhiyun struct hcd_dev { /* usb_device.hcpriv points to this */ 573*4882a593Smuzhiyun struct list_head unused0; 574*4882a593Smuzhiyun struct list_head unused1; 575*4882a593Smuzhiyun 576*4882a593Smuzhiyun /* array of QH pointers */ 577*4882a593Smuzhiyun void *ep[32]; 578*4882a593Smuzhiyun }; 579*4882a593Smuzhiyun #endif /* (LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 0)) */ 580*4882a593Smuzhiyun 581*4882a593Smuzhiyun int optimize_qtd_fill_with_rpc(const dbus_pub_t *pub, int epn, struct ehci_qtd *qtd, void *rpc, 582*4882a593Smuzhiyun int token, int len); 583*4882a593Smuzhiyun int optimize_qtd_fill_with_data(const dbus_pub_t *pub, int epn, struct ehci_qtd *qtd, void *data, 584*4882a593Smuzhiyun int token, int len); 585*4882a593Smuzhiyun int optimize_submit_async(struct ehci_qtd *qtd, int epn); 586*4882a593Smuzhiyun void inline optimize_ehci_qtd_init(struct ehci_qtd *qtd, dma_addr_t dma); 587*4882a593Smuzhiyun struct ehci_qtd *optimize_ehci_qtd_alloc(gfp_t flags); 588*4882a593Smuzhiyun void optimize_ehci_qtd_free(struct ehci_qtd *qtd); 589*4882a593Smuzhiyun void optimize_submit_rx_request(const dbus_pub_t *pub, int epn, struct ehci_qtd *qtd_in, void *buf); 590*4882a593Smuzhiyun #endif /* EHCI_FASTPATH_TX || EHCI_FASTPATH_RX */ 591*4882a593Smuzhiyun 592*4882a593Smuzhiyun void dbus_flowctrl_tx(void *dbi, bool on); 593*4882a593Smuzhiyun #endif /* __DBUS_H__ */ 594