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