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  *
75  * This structure provides an abstract interface towards the
76  * bus specific driver. For control messages to common driver
77  * will assure there is only one active transaction. Unless
78  * indicated otherwise these callbacks are mandatory.
79  */
80 struct brcmf_bus_ops {
81 	int (*preinit)(struct device *dev);
82 	void (*stop)(struct device *dev);
83 	int (*txdata)(struct device *dev, struct sk_buff *skb);
84 	int (*txctl)(struct device *dev, unsigned char *msg, uint len);
85 	int (*rxctl)(struct device *dev, unsigned char *msg, uint len);
86 	struct pktq * (*gettxq)(struct device *dev);
87 	void (*wowl_config)(struct device *dev, bool enabled);
88 	size_t (*get_ramsize)(struct device *dev);
89 	int (*get_memdump)(struct device *dev, void *data, size_t len);
90 };
91 
92 
93 /**
94  * struct brcmf_bus_msgbuf - bus ringbuf if in case of msgbuf.
95  *
96  * @commonrings: commonrings which are always there.
97  * @flowrings: commonrings which are dynamically created and destroyed for data.
98  * @rx_dataoffset: if set then all rx data has this this offset.
99  * @max_rxbufpost: maximum number of buffers to post for rx.
100  * @max_flowrings: maximum number of tx flow rings supported.
101  * @max_submissionrings: maximum number of submission rings(h2d) supported.
102  * @max_completionrings: maximum number of completion rings(d2h) supported.
103  */
104 struct brcmf_bus_msgbuf {
105 	struct brcmf_commonring *commonrings[BRCMF_NROF_COMMON_MSGRINGS];
106 	struct brcmf_commonring **flowrings;
107 	u32 rx_dataoffset;
108 	u32 max_rxbufpost;
109 	u16 max_flowrings;
110 	u16 max_submissionrings;
111 	u16 max_completionrings;
112 };
113 
114 
115 /**
116  * struct brcmf_bus_stats - bus statistic counters.
117  *
118  * @pktcowed: packets cowed for extra headroom/unorphan.
119  * @pktcow_failed: packets dropped due to failed cow-ing.
120  */
121 struct brcmf_bus_stats {
122 	atomic_t pktcowed;
123 	atomic_t pktcow_failed;
124 };
125 
126 /**
127  * struct brcmf_bus - interface structure between common and bus layer
128  *
129  * @bus_priv: pointer to private bus device.
130  * @proto_type: protocol type, bcdc or msgbuf
131  * @dev: device pointer of bus device.
132  * @drvr: public driver information.
133  * @state: operational state of the bus interface.
134  * @stats: statistics shared between common and bus layer.
135  * @maxctl: maximum size for rxctl request message.
136  * @chip: device identifier of the dongle chip.
137  * @always_use_fws_queue: bus wants use queue also when fwsignal is inactive.
138  * @wowl_supported: is wowl supported by bus driver.
139  * @chiprev: revision of the dongle chip.
140  */
141 struct brcmf_bus {
142 	union {
143 		struct brcmf_sdio_dev *sdio;
144 		struct brcmf_usbdev *usb;
145 		struct brcmf_pciedev *pcie;
146 	} bus_priv;
147 	enum brcmf_bus_protocol_type proto_type;
148 	struct device *dev;
149 	struct brcmf_pub *drvr;
150 	enum brcmf_bus_state state;
151 	struct brcmf_bus_stats stats;
152 	uint maxctl;
153 	u32 chip;
154 	u32 chiprev;
155 	bool always_use_fws_queue;
156 	bool wowl_supported;
157 
158 	const struct brcmf_bus_ops *ops;
159 	struct brcmf_bus_msgbuf *msgbuf;
160 };
161 
162 /*
163  * callback wrappers
164  */
165 static inline int brcmf_bus_preinit(struct brcmf_bus *bus)
166 {
167 	if (!bus->ops->preinit)
168 		return 0;
169 	return bus->ops->preinit(bus->dev);
170 }
171 
172 static inline void brcmf_bus_stop(struct brcmf_bus *bus)
173 {
174 	bus->ops->stop(bus->dev);
175 }
176 
177 static inline int brcmf_bus_txdata(struct brcmf_bus *bus, struct sk_buff *skb)
178 {
179 	return bus->ops->txdata(bus->dev, skb);
180 }
181 
182 static inline
183 int brcmf_bus_txctl(struct brcmf_bus *bus, unsigned char *msg, uint len)
184 {
185 	return bus->ops->txctl(bus->dev, msg, len);
186 }
187 
188 static inline
189 int brcmf_bus_rxctl(struct brcmf_bus *bus, unsigned char *msg, uint len)
190 {
191 	return bus->ops->rxctl(bus->dev, msg, len);
192 }
193 
194 static inline
195 struct pktq *brcmf_bus_gettxq(struct brcmf_bus *bus)
196 {
197 	if (!bus->ops->gettxq)
198 		return ERR_PTR(-ENOENT);
199 
200 	return bus->ops->gettxq(bus->dev);
201 }
202 
203 static inline
204 void brcmf_bus_wowl_config(struct brcmf_bus *bus, bool enabled)
205 {
206 	if (bus->ops->wowl_config)
207 		bus->ops->wowl_config(bus->dev, enabled);
208 }
209 
210 static inline size_t brcmf_bus_get_ramsize(struct brcmf_bus *bus)
211 {
212 	if (!bus->ops->get_ramsize)
213 		return 0;
214 
215 	return bus->ops->get_ramsize(bus->dev);
216 }
217 
218 static inline
219 int brcmf_bus_get_memdump(struct brcmf_bus *bus, void *data, size_t len)
220 {
221 	if (!bus->ops->get_memdump)
222 		return -EOPNOTSUPP;
223 
224 	return bus->ops->get_memdump(bus->dev, data, len);
225 }
226 
227 /*
228  * interface functions from common layer
229  */
230 
231 /* Receive frame for delivery to OS.  Callee disposes of rxp. */
232 void brcmf_rx_frame(struct device *dev, struct sk_buff *rxp, bool handle_event);
233 /* Receive async event packet from firmware. Callee disposes of rxp. */
234 void brcmf_rx_event(struct device *dev, struct sk_buff *rxp);
235 
236 /* Indication from bus module regarding presence/insertion of dongle. */
237 int brcmf_attach(struct device *dev, struct brcmf_mp_device *settings);
238 /* Indication from bus module regarding removal/absence of dongle */
239 void brcmf_detach(struct device *dev);
240 /* Indication from bus module that dongle should be reset */
241 void brcmf_dev_reset(struct device *dev);
242 
243 /* Configure the "global" bus state used by upper layers */
244 void brcmf_bus_change_state(struct brcmf_bus *bus, enum brcmf_bus_state state);
245 
246 int brcmf_bus_started(struct device *dev);
247 s32 brcmf_iovar_data_set(struct device *dev, char *name, void *data, u32 len);
248 void brcmf_bus_add_txhdrlen(struct device *dev, uint len);
249 
250 #ifdef CONFIG_BRCMFMAC_SDIO
251 void brcmf_sdio_exit(void);
252 void brcmf_sdio_register(void);
253 #endif
254 #ifdef CONFIG_BRCMFMAC_USB
255 void brcmf_usb_exit(void);
256 void brcmf_usb_register(void);
257 #endif
258 
259 #endif /* BRCMFMAC_BUS_H */
260