2 * Copyright (c) 2010 Broadcom Corporation
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.
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.
20 /* The level of bus communication with the dongle */
21 enum brcmf_bus_state {
22 BRCMF_BUS_DOWN, /* Not ready for frame transfers */
23 BRCMF_BUS_LOAD, /* Download access only (CPU reset) */
24 BRCMF_BUS_DATA /* Ready for frame transfers */
27 struct brcmf_bus_dcmd {
31 struct list_head list;
35 * struct brcmf_bus_ops - bus callback operations.
37 * @preinit: execute bus/device specific dongle init commands (optional).
38 * @init: prepare for communication with dongle.
39 * @stop: clear pending frames, disable data flow.
40 * @txdata: send a data frame to the dongle. When the data
41 * has been transferred, the common driver must be
42 * notified using brcmf_txcomplete(). The common
43 * driver calls this function with interrupts
45 * @txctl: transmit a control request message to dongle.
46 * @rxctl: receive a control response message from dongle.
47 * @gettxq: obtain a reference of bus transmit queue (optional).
49 * This structure provides an abstract interface towards the
50 * bus specific driver. For control messages to common driver
51 * will assure there is only one active transaction. Unless
52 * indicated otherwise these callbacks are mandatory.
54 struct brcmf_bus_ops {
55 int (*preinit)(struct device *dev);
56 int (*init)(struct device *dev);
57 void (*stop)(struct device *dev);
58 int (*txdata)(struct device *dev, struct sk_buff *skb);
59 int (*txctl)(struct device *dev, unsigned char *msg, uint len);
60 int (*rxctl)(struct device *dev, unsigned char *msg, uint len);
61 struct pktq * (*gettxq)(struct device *dev);
65 * struct brcmf_bus - interface structure between common and bus layer
67 * @bus_priv: pointer to private bus device.
68 * @dev: device pointer of bus device.
69 * @drvr: public driver information.
70 * @state: operational state of the bus interface.
71 * @maxctl: maximum size for rxctl request message.
72 * @tx_realloc: number of tx packets realloced for headroom.
73 * @dstats: dongle-based statistical data.
74 * @dcmd_list: bus/device specific dongle initialization commands.
75 * @chip: device identifier of the dongle chip.
76 * @chiprev: revision of the dongle chip.
80 struct brcmf_sdio_dev *sdio;
81 struct brcmf_usbdev *usb;
84 struct brcmf_pub *drvr;
85 enum brcmf_bus_state state;
87 unsigned long tx_realloc;
91 struct brcmf_bus_ops *ops;
97 static inline int brcmf_bus_preinit(struct brcmf_bus *bus)
99 if (!bus->ops->preinit)
101 return bus->ops->preinit(bus->dev);
104 static inline int brcmf_bus_init(struct brcmf_bus *bus)
106 return bus->ops->init(bus->dev);
109 static inline void brcmf_bus_stop(struct brcmf_bus *bus)
111 bus->ops->stop(bus->dev);
114 static inline int brcmf_bus_txdata(struct brcmf_bus *bus, struct sk_buff *skb)
116 return bus->ops->txdata(bus->dev, skb);
120 int brcmf_bus_txctl(struct brcmf_bus *bus, unsigned char *msg, uint len)
122 return bus->ops->txctl(bus->dev, msg, len);
126 int brcmf_bus_rxctl(struct brcmf_bus *bus, unsigned char *msg, uint len)
128 return bus->ops->rxctl(bus->dev, msg, len);
132 struct pktq *brcmf_bus_gettxq(struct brcmf_bus *bus)
134 if (!bus->ops->gettxq)
135 return ERR_PTR(-ENOENT);
137 return bus->ops->gettxq(bus->dev);
140 * interface functions from common layer
143 bool brcmf_c_prec_enq(struct device *dev, struct pktq *q, struct sk_buff *pkt,
146 /* Receive frame for delivery to OS. Callee disposes of rxp. */
147 void brcmf_rx_frame(struct device *dev, struct sk_buff *rxp);
149 /* Indication from bus module regarding presence/insertion of dongle. */
150 int brcmf_attach(struct device *dev);
151 /* Indication from bus module regarding removal/absence of dongle */
152 void brcmf_detach(struct device *dev);
153 /* Indication from bus module that dongle should be reset */
154 void brcmf_dev_reset(struct device *dev);
155 /* Indication from bus module to change flow-control state */
156 void brcmf_txflowblock(struct device *dev, bool state);
158 /* Notify the bus has transferred the tx packet to firmware */
159 void brcmf_txcomplete(struct device *dev, struct sk_buff *txp, bool success);
161 int brcmf_bus_start(struct device *dev);
162 s32 brcmf_iovar_data_set(struct device *dev, char *name, void *data,
164 void brcmf_bus_add_txhdrlen(struct device *dev, uint len);
166 #ifdef CONFIG_BRCMFMAC_SDIO
167 void brcmf_sdio_exit(void);
168 void brcmf_sdio_init(void);
169 void brcmf_sdio_register(void);
171 #ifdef CONFIG_BRCMFMAC_USB
172 void brcmf_usb_exit(void);
173 void brcmf_usb_register(void);
176 #endif /* _BRCMF_BUS_H_ */