drivers/net/wireless/broadcom/brcm80211/brcmfmac/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 BRCMFMAC_BUS_H
  18 #define BRCMFMAC_BUS_H
  19
  20 #include "debug.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_H2D_MSGRING_FLOWRING_IDSTART      2
  26 #define BRCMF_D2H_MSGRING_CONTROL_COMPLETE      2
  27 #define BRCMF_D2H_MSGRING_TX_COMPLETE           3
  28 #define BRCMF_D2H_MSGRING_RX_COMPLETE           4
  29
  30
  31 #define BRCMF_NROF_H2D_COMMON_MSGRINGS          2
  32 #define BRCMF_NROF_D2H_COMMON_MSGRINGS          3
  33 #define BRCMF_NROF_COMMON_MSGRINGS      (BRCMF_NROF_H2D_COMMON_MSGRINGS + \
  34                                          BRCMF_NROF_D2H_COMMON_MSGRINGS)
  35
  36 /* The level of bus communication with the dongle */
  37 enum brcmf_bus_state {
  38         BRCMF_BUS_DOWN,         /* Not ready for frame transfers */
  39         BRCMF_BUS_UP            /* Ready for frame transfers */
  40 };
  41
  42 /* The level of bus communication with the dongle */
  43 enum brcmf_bus_protocol_type {
  44         BRCMF_PROTO_BCDC,
  45         BRCMF_PROTO_MSGBUF
  46 };
  47
  48 struct brcmf_mp_device;
  49
  50 struct brcmf_bus_dcmd {
  51         char *name;
  52         char *param;
  53         int param_len;
  54         struct list_head list;
  55 };
  56
  57 /**
  58  * struct brcmf_bus_ops - bus callback operations.
  59  *
  60  * @preinit: execute bus/device specific dongle init commands (optional).
  61  * @init: prepare for communication with dongle.
  62  * @stop: clear pending frames, disable data flow.
  63  * @txdata: send a data frame to the dongle. When the data
  64  *      has been transferred, the common driver must be
  65  *      notified using brcmf_txcomplete(). The common
  66  *      driver calls this function with interrupts
  67  *      disabled.
  68  * @txctl: transmit a control request message to dongle.
  69  * @rxctl: receive a control response message from dongle.
  70  * @gettxq: obtain a reference of bus transmit queue (optional).
  71  * @wowl_config: specify if dongle is configured for wowl when going to suspend
  72  * @get_ramsize: obtain size of device memory.
  73  * @get_memdump: obtain device memory dump in provided buffer.
  74  * @get_fwname: obtain firmware name.
  75  *
  76  * This structure provides an abstract interface towards the
  77  * bus specific driver. For control messages to common driver
  78  * will assure there is only one active transaction. Unless
  79  * indicated otherwise these callbacks are mandatory.
  80  */
  81 struct brcmf_bus_ops {
  82         int (*preinit)(struct device *dev);
  83         void (*stop)(struct device *dev);
  84         int (*txdata)(struct device *dev, struct sk_buff *skb);
  85         int (*txctl)(struct device *dev, unsigned char *msg, uint len);
  86         int (*rxctl)(struct device *dev, unsigned char *msg, uint len);
  87         struct pktq * (*gettxq)(struct device *dev);
  88         void (*wowl_config)(struct device *dev, bool enabled);
  89         size_t (*get_ramsize)(struct device *dev);
  90         int (*get_memdump)(struct device *dev, void *data, size_t len);
  91         int (*get_fwname)(struct device *dev, uint chip, uint chiprev,
  92                           unsigned char *fw_name);
  93 };
  94
  95
  96 /**
  97  * struct brcmf_bus_msgbuf - bus ringbuf if in case of msgbuf.
  98  *
  99  * @commonrings: commonrings which are always there.
 100  * @flowrings: commonrings which are dynamically created and destroyed for data.
 101  * @rx_dataoffset: if set then all rx data has this this offset.
 102  * @max_rxbufpost: maximum number of buffers to post for rx.
 103  * @max_flowrings: maximum number of tx flow rings supported.
 104  * @max_submissionrings: maximum number of submission rings(h2d) supported.
 105  * @max_completionrings: maximum number of completion rings(d2h) supported.
 106  */
 107 struct brcmf_bus_msgbuf {
 108         struct brcmf_commonring *commonrings[BRCMF_NROF_COMMON_MSGRINGS];
 109         struct brcmf_commonring **flowrings;
 110         u32 rx_dataoffset;
 111         u32 max_rxbufpost;
 112         u16 max_flowrings;
 113         u16 max_submissionrings;
 114         u16 max_completionrings;
 115 };
 116
 117
 118 /**
 119  * struct brcmf_bus_stats - bus statistic counters.
 120  *
 121  * @pktcowed: packets cowed for extra headroom/unorphan.
 122  * @pktcow_failed: packets dropped due to failed cow-ing.
 123  */
 124 struct brcmf_bus_stats {
 125         atomic_t pktcowed;
 126         atomic_t pktcow_failed;
 127 };
 128
 129 /**
 130  * struct brcmf_bus - interface structure between common and bus layer
 131  *
 132  * @bus_priv: pointer to private bus device.
 133  * @proto_type: protocol type, bcdc or msgbuf
 134  * @dev: device pointer of bus device.
 135  * @drvr: public driver information.
 136  * @state: operational state of the bus interface.
 137  * @stats: statistics shared between common and bus layer.
 138  * @maxctl: maximum size for rxctl request message.
 139  * @chip: device identifier of the dongle chip.
 140  * @always_use_fws_queue: bus wants use queue also when fwsignal is inactive.
 141  * @wowl_supported: is wowl supported by bus driver.
 142  * @chiprev: revision of the dongle chip.
 143  */
 144 struct brcmf_bus {
 145         union {
 146                 struct brcmf_sdio_dev *sdio;
 147                 struct brcmf_usbdev *usb;
 148                 struct brcmf_pciedev *pcie;
 149         } bus_priv;
 150         enum brcmf_bus_protocol_type proto_type;
 151         struct device *dev;
 152         struct brcmf_pub *drvr;
 153         enum brcmf_bus_state state;
 154         struct brcmf_bus_stats stats;
 155         uint maxctl;
 156         u32 chip;
 157         u32 chiprev;
 158         bool always_use_fws_queue;
 159         bool wowl_supported;
 160
 161         const struct brcmf_bus_ops *ops;
 162         struct brcmf_bus_msgbuf *msgbuf;
 163 };
 164
 165 /*
 166  * callback wrappers
 167  */
 168 static inline int brcmf_bus_preinit(struct brcmf_bus *bus)
 169 {
 170         if (!bus->ops->preinit)
 171                 return 0;
 172         return bus->ops->preinit(bus->dev);
 173 }
 174
 175 static inline void brcmf_bus_stop(struct brcmf_bus *bus)
 176 {
 177         bus->ops->stop(bus->dev);
 178 }
 179
 180 static inline int brcmf_bus_txdata(struct brcmf_bus *bus, struct sk_buff *skb)
 181 {
 182         return bus->ops->txdata(bus->dev, skb);
 183 }
 184
 185 static inline
 186 int brcmf_bus_txctl(struct brcmf_bus *bus, unsigned char *msg, uint len)
 187 {
 188         return bus->ops->txctl(bus->dev, msg, len);
 189 }
 190
 191 static inline
 192 int brcmf_bus_rxctl(struct brcmf_bus *bus, unsigned char *msg, uint len)
 193 {
 194         return bus->ops->rxctl(bus->dev, msg, len);
 195 }
 196
 197 static inline
 198 struct pktq *brcmf_bus_gettxq(struct brcmf_bus *bus)
 199 {
 200         if (!bus->ops->gettxq)
 201                 return ERR_PTR(-ENOENT);
 202
 203         return bus->ops->gettxq(bus->dev);
 204 }
 205
 206 static inline
 207 void brcmf_bus_wowl_config(struct brcmf_bus *bus, bool enabled)
 208 {
 209         if (bus->ops->wowl_config)
 210                 bus->ops->wowl_config(bus->dev, enabled);
 211 }
 212
 213 static inline size_t brcmf_bus_get_ramsize(struct brcmf_bus *bus)
 214 {
 215         if (!bus->ops->get_ramsize)
 216                 return 0;
 217
 218         return bus->ops->get_ramsize(bus->dev);
 219 }
 220
 221 static inline
 222 int brcmf_bus_get_memdump(struct brcmf_bus *bus, void *data, size_t len)
 223 {
 224         if (!bus->ops->get_memdump)
 225                 return -EOPNOTSUPP;
 226
 227         return bus->ops->get_memdump(bus->dev, data, len);
 228 }
 229
 230 static inline
 231 int brcmf_bus_get_fwname(struct brcmf_bus *bus, uint chip, uint chiprev,
 232                          unsigned char *fw_name)
 233 {
 234         return bus->ops->get_fwname(bus->dev, chip, chiprev, fw_name);
 235 }
 236
 237 /*
 238  * interface functions from common layer
 239  */
 240
 241 /* Receive frame for delivery to OS.  Callee disposes of rxp. */
 242 void brcmf_rx_frame(struct device *dev, struct sk_buff *rxp, bool handle_event);
 243 /* Receive async event packet from firmware. Callee disposes of rxp. */
 244 void brcmf_rx_event(struct device *dev, struct sk_buff *rxp);
 245
 246 /* Indication from bus module regarding presence/insertion of dongle. */
 247 int brcmf_attach(struct device *dev, struct brcmf_mp_device *settings);
 248 /* Indication from bus module regarding removal/absence of dongle */
 249 void brcmf_detach(struct device *dev);
 250 /* Indication from bus module that dongle should be reset */
 251 void brcmf_dev_reset(struct device *dev);
 252
 253 /* Configure the "global" bus state used by upper layers */
 254 void brcmf_bus_change_state(struct brcmf_bus *bus, enum brcmf_bus_state state);
 255
 256 int brcmf_bus_started(struct device *dev);
 257 s32 brcmf_iovar_data_set(struct device *dev, char *name, void *data, u32 len);
 258 void brcmf_bus_add_txhdrlen(struct device *dev, uint len);
 259
 260 #ifdef CONFIG_BRCMFMAC_SDIO
 261 void brcmf_sdio_exit(void);
 262 void brcmf_sdio_register(void);
 263 #endif
 264 #ifdef CONFIG_BRCMFMAC_USB
 265 void brcmf_usb_exit(void);
 266 void brcmf_usb_register(void);
 267 #endif
 268
 269 #endif /* BRCMFMAC_BUS_H */