drivers/net/wireless/brcm80211/brcmfmac/dhd_bus.h

   1 /*
   2  * Copyright (c) 2010 Broadcom Corporation
   3  *
   4  * Permission to use, copy, modify, and/or distribute this software for any
   5  * purpose with or without fee is hereby granted, provided that the above
   6  * copyright notice and this permission notice appear in all copies.
   7  *
   8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
  11  * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
  13  * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
  14  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15  */
  16
  17 #ifndef _BRCMF_BUS_H_
  18 #define _BRCMF_BUS_H_
  19
  20 #include "dhd_dbg.h"
  21
  22 /* IDs of the 6 default common rings of msgbuf protocol */
  23 #define BRCMF_H2D_MSGRING_CONTROL_SUBMIT        0
  24 #define BRCMF_H2D_MSGRING_RXPOST_SUBMIT         1
  25 #define BRCMF_D2H_MSGRING_CONTROL_COMPLETE      2
  26 #define BRCMF_D2H_MSGRING_TX_COMPLETE           3
  27 #define BRCMF_D2H_MSGRING_RX_COMPLETE           4
  28
  29 #define BRCMF_NROF_H2D_COMMON_MSGRINGS          2
  30 #define BRCMF_NROF_D2H_COMMON_MSGRINGS          3
  31 #define BRCMF_NROF_COMMON_MSGRINGS      (BRCMF_NROF_H2D_COMMON_MSGRINGS + \
  32                                          BRCMF_NROF_D2H_COMMON_MSGRINGS)
  33
  34 /* The level of bus communication with the dongle */
  35 enum brcmf_bus_state {
  36         BRCMF_BUS_UNKNOWN,      /* Not determined yet */
  37         BRCMF_BUS_NOMEDIUM,     /* No medium access to dongle */
  38         BRCMF_BUS_DOWN,         /* Not ready for frame transfers */
  39         BRCMF_BUS_LOAD,         /* Download access only (CPU reset) */
  40         BRCMF_BUS_DATA          /* Ready for frame transfers */
  41 };
  42
  43 /* The level of bus communication with the dongle */
  44 enum brcmf_bus_protocol_type {
  45         BRCMF_PROTO_BCDC,
  46         BRCMF_PROTO_MSGBUF
  47 };
  48
  49 struct brcmf_bus_dcmd {
  50         char *name;
  51         char *param;
  52         int param_len;
  53         struct list_head list;
  54 };
  55
  56 /**
  57  * struct brcmf_bus_ops - bus callback operations.
  58  *
  59  * @preinit: execute bus/device specific dongle init commands (optional).
  60  * @init: prepare for communication with dongle.
  61  * @stop: clear pending frames, disable data flow.
  62  * @txdata: send a data frame to the dongle. When the data
  63  *      has been transferred, the common driver must be
  64  *      notified using brcmf_txcomplete(). The common
  65  *      driver calls this function with interrupts
  66  *      disabled.
  67  * @txctl: transmit a control request message to dongle.
  68  * @rxctl: receive a control response message from dongle.
  69  * @gettxq: obtain a reference of bus transmit queue (optional).
  70  *
  71  * This structure provides an abstract interface towards the
  72  * bus specific driver. For control messages to common driver
  73  * will assure there is only one active transaction. Unless
  74  * indicated otherwise these callbacks are mandatory.
  75  */
  76 struct brcmf_bus_ops {
  77         int (*preinit)(struct device *dev);
  78         void (*stop)(struct device *dev);
  79         int (*txdata)(struct device *dev, struct sk_buff *skb);
  80         int (*txctl)(struct device *dev, unsigned char *msg, uint len);
  81         int (*rxctl)(struct device *dev, unsigned char *msg, uint len);
  82         struct pktq * (*gettxq)(struct device *dev);
  83 };
  84
  85
  86 /**
  87  * struct brcmf_bus_msgbuf - bus ringbuf if in case of msgbuf.
  88  *
  89  * @commonrings: commonrings which are always there.
  90  * @flowrings: commonrings which are dynamically created and destroyed for data.
  91  * @rx_dataoffset: if set then all rx data has this this offset.
  92  * @max_rxbufpost: maximum number of buffers to post for rx.
  93  * @nrof_flowrings: number of flowrings.
  94  */
  95 struct brcmf_bus_msgbuf {
  96         struct brcmf_commonring *commonrings[BRCMF_NROF_COMMON_MSGRINGS];
  97         struct brcmf_commonring **flowrings;
  98         u32 rx_dataoffset;
  99         u32 max_rxbufpost;
 100         u32 nrof_flowrings;
 101 };
 102
 103
 104 /**
 105  * struct brcmf_bus - interface structure between common and bus layer
 106  *
 107  * @bus_priv: pointer to private bus device.
 108  * @proto_type: protocol type, bcdc or msgbuf
 109  * @dev: device pointer of bus device.
 110  * @drvr: public driver information.
 111  * @state: operational state of the bus interface.
 112  * @maxctl: maximum size for rxctl request message.
 113  * @tx_realloc: number of tx packets realloced for headroom.
 114  * @dstats: dongle-based statistical data.
 115  * @dcmd_list: bus/device specific dongle initialization commands.
 116  * @chip: device identifier of the dongle chip.
 117  * @chiprev: revision of the dongle chip.
 118  */
 119 struct brcmf_bus {
 120         union {
 121                 struct brcmf_sdio_dev *sdio;
 122                 struct brcmf_usbdev *usb;
 123                 struct brcmf_pciedev *pcie;
 124         } bus_priv;
 125         enum brcmf_bus_protocol_type proto_type;
 126         struct device *dev;
 127         struct brcmf_pub *drvr;
 128         enum brcmf_bus_state state;
 129         uint maxctl;
 130         unsigned long tx_realloc;
 131         u32 chip;
 132         u32 chiprev;
 133         bool always_use_fws_queue;
 134
 135         struct brcmf_bus_ops *ops;
 136         struct brcmf_bus_msgbuf *msgbuf;
 137 };
 138
 139 /*
 140  * callback wrappers
 141  */
 142 static inline int brcmf_bus_preinit(struct brcmf_bus *bus)
 143 {
 144         if (!bus->ops->preinit)
 145                 return 0;
 146         return bus->ops->preinit(bus->dev);
 147 }
 148
 149 static inline void brcmf_bus_stop(struct brcmf_bus *bus)
 150 {
 151         bus->ops->stop(bus->dev);
 152 }
 153
 154 static inline int brcmf_bus_txdata(struct brcmf_bus *bus, struct sk_buff *skb)
 155 {
 156         return bus->ops->txdata(bus->dev, skb);
 157 }
 158
 159 static inline
 160 int brcmf_bus_txctl(struct brcmf_bus *bus, unsigned char *msg, uint len)
 161 {
 162         return bus->ops->txctl(bus->dev, msg, len);
 163 }
 164
 165 static inline
 166 int brcmf_bus_rxctl(struct brcmf_bus *bus, unsigned char *msg, uint len)
 167 {
 168         return bus->ops->rxctl(bus->dev, msg, len);
 169 }
 170
 171 static inline
 172 struct pktq *brcmf_bus_gettxq(struct brcmf_bus *bus)
 173 {
 174         if (!bus->ops->gettxq)
 175                 return ERR_PTR(-ENOENT);
 176
 177         return bus->ops->gettxq(bus->dev);
 178 }
 179
 180 static inline bool brcmf_bus_ready(struct brcmf_bus *bus)
 181 {
 182         return bus->state == BRCMF_BUS_LOAD || bus->state == BRCMF_BUS_DATA;
 183 }
 184
 185 static inline void brcmf_bus_change_state(struct brcmf_bus *bus,
 186                                           enum brcmf_bus_state new_state)
 187 {
 188         /* NOMEDIUM is permanent */
 189         if (bus->state == BRCMF_BUS_NOMEDIUM)
 190                 return;
 191
 192         brcmf_dbg(TRACE, "%d -> %d\n", bus->state, new_state);
 193         bus->state = new_state;
 194 }
 195
 196 /*
 197  * interface functions from common layer
 198  */
 199
 200 bool brcmf_c_prec_enq(struct device *dev, struct pktq *q, struct sk_buff *pkt,
 201                       int prec);
 202
 203 /* Receive frame for delivery to OS.  Callee disposes of rxp. */
 204 void brcmf_rx_frame(struct device *dev, struct sk_buff *rxp);
 205
 206 /* Indication from bus module regarding presence/insertion of dongle. */
 207 int brcmf_attach(struct device *dev);
 208 /* Indication from bus module regarding removal/absence of dongle */
 209 void brcmf_detach(struct device *dev);
 210 /* Indication from bus module that dongle should be reset */
 211 void brcmf_dev_reset(struct device *dev);
 212 /* Indication from bus module to change flow-control state */
 213 void brcmf_txflowblock(struct device *dev, bool state);
 214
 215 /* Notify the bus has transferred the tx packet to firmware */
 216 void brcmf_txcomplete(struct device *dev, struct sk_buff *txp, bool success);
 217
 218 int brcmf_bus_start(struct device *dev);
 219 s32 brcmf_iovar_data_set(struct device *dev, char *name, void *data,
 220                                 u32 len);
 221 void brcmf_bus_add_txhdrlen(struct device *dev, uint len);
 222
 223 #ifdef CONFIG_BRCMFMAC_SDIO
 224 void brcmf_sdio_exit(void);
 225 void brcmf_sdio_init(void);
 226 void brcmf_sdio_register(void);
 227 #endif
 228 #ifdef CONFIG_BRCMFMAC_USB
 229 void brcmf_usb_exit(void);
 230 void brcmf_usb_register(void);
 231 #endif
 232
 233 #endif                          /* _BRCMF_BUS_H_ */