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 /* The level of bus communication with the dongle */
28 enum brcmf_bus_protocol_type {
33 struct brcmf_bus_dcmd {
37 struct list_head list;
41 * struct brcmf_bus_ops - bus callback operations.
43 * @preinit: execute bus/device specific dongle init commands (optional).
44 * @init: prepare for communication with dongle.
45 * @stop: clear pending frames, disable data flow.
46 * @txdata: send a data frame to the dongle. When the data
47 * has been transferred, the common driver must be
48 * notified using brcmf_txcomplete(). The common
49 * driver calls this function with interrupts
51 * @txctl: transmit a control request message to dongle.
52 * @rxctl: receive a control response message from dongle.
53 * @gettxq: obtain a reference of bus transmit queue (optional).
55 * This structure provides an abstract interface towards the
56 * bus specific driver. For control messages to common driver
57 * will assure there is only one active transaction. Unless
58 * indicated otherwise these callbacks are mandatory.
60 struct brcmf_bus_ops {
61 int (*preinit)(struct device *dev);
62 int (*init)(struct device *dev);
63 void (*stop)(struct device *dev);
64 int (*txdata)(struct device *dev, struct sk_buff *skb);
65 int (*txctl)(struct device *dev, unsigned char *msg, uint len);
66 int (*rxctl)(struct device *dev, unsigned char *msg, uint len);
67 struct pktq * (*gettxq)(struct device *dev);
71 * struct brcmf_bus - interface structure between common and bus layer
73 * @bus_priv: pointer to private bus device.
74 * @proto_type: protocol type, bcdc or msgbuf
75 * @dev: device pointer of bus device.
76 * @drvr: public driver information.
77 * @state: operational state of the bus interface.
78 * @maxctl: maximum size for rxctl request message.
79 * @tx_realloc: number of tx packets realloced for headroom.
80 * @dstats: dongle-based statistical data.
81 * @dcmd_list: bus/device specific dongle initialization commands.
82 * @chip: device identifier of the dongle chip.
83 * @chiprev: revision of the dongle chip.
87 struct brcmf_sdio_dev *sdio;
88 struct brcmf_usbdev *usb;
90 enum brcmf_bus_protocol_type proto_type;
92 struct brcmf_pub *drvr;
93 enum brcmf_bus_state state;
95 unsigned long tx_realloc;
99 struct brcmf_bus_ops *ops;
105 static inline int brcmf_bus_preinit(struct brcmf_bus *bus)
107 if (!bus->ops->preinit)
109 return bus->ops->preinit(bus->dev);
112 static inline int brcmf_bus_init(struct brcmf_bus *bus)
114 return bus->ops->init(bus->dev);
117 static inline void brcmf_bus_stop(struct brcmf_bus *bus)
119 bus->ops->stop(bus->dev);
122 static inline int brcmf_bus_txdata(struct brcmf_bus *bus, struct sk_buff *skb)
124 return bus->ops->txdata(bus->dev, skb);
128 int brcmf_bus_txctl(struct brcmf_bus *bus, unsigned char *msg, uint len)
130 return bus->ops->txctl(bus->dev, msg, len);
134 int brcmf_bus_rxctl(struct brcmf_bus *bus, unsigned char *msg, uint len)
136 return bus->ops->rxctl(bus->dev, msg, len);
140 struct pktq *brcmf_bus_gettxq(struct brcmf_bus *bus)
142 if (!bus->ops->gettxq)
143 return ERR_PTR(-ENOENT);
145 return bus->ops->gettxq(bus->dev);
148 * interface functions from common layer
151 bool brcmf_c_prec_enq(struct device *dev, struct pktq *q, struct sk_buff *pkt,
154 /* Receive frame for delivery to OS. Callee disposes of rxp. */
155 void brcmf_rx_frame(struct device *dev, struct sk_buff *rxp);
157 /* Indication from bus module regarding presence/insertion of dongle. */
158 int brcmf_attach(struct device *dev);
159 /* Indication from bus module regarding removal/absence of dongle */
160 void brcmf_detach(struct device *dev);
161 /* Indication from bus module that dongle should be reset */
162 void brcmf_dev_reset(struct device *dev);
163 /* Indication from bus module to change flow-control state */
164 void brcmf_txflowblock(struct device *dev, bool state);
166 /* Notify the bus has transferred the tx packet to firmware */
167 void brcmf_txcomplete(struct device *dev, struct sk_buff *txp, bool success);
169 int brcmf_bus_start(struct device *dev);
170 s32 brcmf_iovar_data_set(struct device *dev, char *name, void *data,
172 void brcmf_bus_add_txhdrlen(struct device *dev, uint len);
174 #ifdef CONFIG_BRCMFMAC_SDIO
175 void brcmf_sdio_exit(void);
176 void brcmf_sdio_init(void);
177 void brcmf_sdio_register(void);
179 #ifdef CONFIG_BRCMFMAC_USB
180 void brcmf_usb_exit(void);
181 void brcmf_usb_register(void);
184 #endif /* _BRCMF_BUS_H_ */