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.
17 #include <linux/types.h>
18 #include <linux/netdevice.h>
19 #include <linux/sched.h>
22 #include <brcmu_utils.h>
23 #include <brcmu_wifi.h>
25 #include "dngl_stats.h"
27 #include "dhd_proto.h"
32 u32 cmd; /* ioctl command value */
33 u32 len; /* lower 16: output buflen;
34 * upper 16: input buflen (excludes header) */
35 u32 flags; /* flag defns given below */
36 u32 status; /* status code returned from the device */
39 /* Max valid buffer size that can be sent to the dongle */
40 #define CDC_MAX_MSG_SIZE (ETH_FRAME_LEN+ETH_FCS_LEN)
42 /* CDC flag definitions */
43 #define CDCF_IOC_ERROR 0x01 /* 1=ioctl cmd failed */
44 #define CDCF_IOC_SET 0x02 /* 0=get, 1=set cmd */
45 #define CDCF_IOC_IF_MASK 0xF000 /* I/F index */
46 #define CDCF_IOC_IF_SHIFT 12
47 #define CDCF_IOC_ID_MASK 0xFFFF0000 /* id an ioctl pairing */
48 #define CDCF_IOC_ID_SHIFT 16 /* ID Mask shift bits */
49 #define CDC_IOC_ID(flags) \
50 (((flags) & CDCF_IOC_ID_MASK) >> CDCF_IOC_ID_SHIFT)
51 #define CDC_SET_IF_IDX(hdr, idx) \
52 ((hdr)->flags = (((hdr)->flags & ~CDCF_IOC_IF_MASK) | \
53 ((idx) << CDCF_IOC_IF_SHIFT)))
56 * BDC header - Broadcom specific extension of CDC.
57 * Used on data packets to convey priority across USB.
59 #define BDC_HEADER_LEN 4
60 #define BDC_PROTO_VER 1 /* Protocol version */
61 #define BDC_FLAG_VER_MASK 0xf0 /* Protocol version mask */
62 #define BDC_FLAG_VER_SHIFT 4 /* Protocol version shift */
63 #define BDC_FLAG_SUM_GOOD 0x04 /* Good RX checksums */
64 #define BDC_FLAG_SUM_NEEDED 0x08 /* Dongle needs to do TX checksums */
65 #define BDC_PRIORITY_MASK 0x7
66 #define BDC_FLAG2_IF_MASK 0x0f /* packet rx interface in APSTA */
67 #define BDC_FLAG2_IF_SHIFT 0
69 #define BDC_GET_IF_IDX(hdr) \
70 ((int)((((hdr)->flags2) & BDC_FLAG2_IF_MASK) >> BDC_FLAG2_IF_SHIFT))
71 #define BDC_SET_IF_IDX(hdr, idx) \
72 ((hdr)->flags2 = (((hdr)->flags2 & ~BDC_FLAG2_IF_MASK) | \
73 ((idx) << BDC_FLAG2_IF_SHIFT)))
77 u8 priority; /* 802.1d Priority, 4:7 flow control info for usb */
84 int wifi_get_mac_addr(unsigned char *buf);
87 /* Packet alignment for most efficient SDIO (can change based on platform) */
89 #define DHD_SDALIGN 32
91 #if !ISPOWEROF2(DHD_SDALIGN)
92 #error DHD_SDALIGN is not a power of 2!
95 #define RETRIES 2 /* # of retries to retrieve matching ioctl response */
96 #define BUS_HEADER_LEN (16+DHD_SDALIGN) /* Must be atleast SDPCM_RESERVE
97 * defined in dhd_sdio.c
98 * (amount of header tha might be added)
99 * plus any space that might be needed
100 * for alignment padding.
102 #define ROUND_UP_MARGIN 2048 /* Biggest SDIO block size possible for
103 * round off at the end of buffer
106 typedef struct dhd_prot {
110 u8 bus_header[BUS_HEADER_LEN];
111 struct cdc_ioctl msg;
112 unsigned char buf[BRCMF_C_IOCTL_MAXLEN + ROUND_UP_MARGIN];
115 static int brcmf_proto_cdc_msg(dhd_pub_t *dhd)
117 dhd_prot_t *prot = dhd->prot;
118 int len = le32_to_cpu(prot->msg.len) + sizeof(struct cdc_ioctl);
120 DHD_TRACE(("%s: Enter\n", __func__));
122 /* NOTE : cdc->msg.len holds the desired length of the buffer to be
123 * returned. Only up to CDC_MAX_MSG_SIZE of this buffer area
124 * is actually sent to the dongle
126 if (len > CDC_MAX_MSG_SIZE)
127 len = CDC_MAX_MSG_SIZE;
130 return brcmf_sdbrcm_bus_txctl(dhd->bus, (unsigned char *)&prot->msg,
134 static int brcmf_proto_cdc_cmplt(dhd_pub_t *dhd, u32 id, u32 len)
137 dhd_prot_t *prot = dhd->prot;
139 DHD_TRACE(("%s: Enter\n", __func__));
142 ret = brcmf_sdbrcm_bus_rxctl(dhd->bus,
143 (unsigned char *)&prot->msg,
144 len + sizeof(struct cdc_ioctl));
147 } while (CDC_IOC_ID(le32_to_cpu(prot->msg.flags)) != id);
153 brcmf_proto_cdc_query_ioctl(dhd_pub_t *dhd, int ifidx, uint cmd, void *buf,
156 dhd_prot_t *prot = dhd->prot;
157 struct cdc_ioctl *msg = &prot->msg;
159 int ret = 0, retries = 0;
162 DHD_TRACE(("%s: Enter\n", __func__));
163 DHD_CTL(("%s: cmd %d len %d\n", __func__, cmd, len));
165 /* Respond "bcmerror" and "bcmerrorstr" with local cache */
166 if (cmd == BRCMF_C_GET_VAR && buf) {
167 if (!strcmp((char *)buf, "bcmerrorstr")) {
168 strncpy((char *)buf, "bcm_error",
171 } else if (!strcmp((char *)buf, "bcmerror")) {
172 *(int *)buf = dhd->dongle_error;
177 memset(msg, 0, sizeof(struct cdc_ioctl));
179 msg->cmd = cpu_to_le32(cmd);
180 msg->len = cpu_to_le32(len);
181 msg->flags = (++prot->reqid << CDCF_IOC_ID_SHIFT);
182 CDC_SET_IF_IDX(msg, ifidx);
183 msg->flags = cpu_to_le32(msg->flags);
186 memcpy(prot->buf, buf, len);
188 ret = brcmf_proto_cdc_msg(dhd);
190 DHD_ERROR(("dhdcdc_query_ioctl: dhdcdc_msg failed w/status "
196 /* wait for interrupt and get first fragment */
197 ret = brcmf_proto_cdc_cmplt(dhd, prot->reqid, len);
201 flags = le32_to_cpu(msg->flags);
202 id = (flags & CDCF_IOC_ID_MASK) >> CDCF_IOC_ID_SHIFT;
204 if ((id < prot->reqid) && (++retries < RETRIES))
206 if (id != prot->reqid) {
207 DHD_ERROR(("%s: %s: unexpected request id %d (expected %d)\n",
208 brcmf_ifname(dhd, ifidx), __func__, id,
214 /* Check info buffer */
215 info = (void *)&msg[1];
217 /* Copy info buffer */
221 memcpy(buf, info, len);
224 /* Check the ERROR flag */
225 if (flags & CDCF_IOC_ERROR) {
226 ret = le32_to_cpu(msg->status);
227 /* Cache error from dongle */
228 dhd->dongle_error = ret;
235 int brcmf_proto_cdc_set_ioctl(dhd_pub_t *dhd, int ifidx, uint cmd,
238 dhd_prot_t *prot = dhd->prot;
239 struct cdc_ioctl *msg = &prot->msg;
243 DHD_TRACE(("%s: Enter\n", __func__));
244 DHD_CTL(("%s: cmd %d len %d\n", __func__, cmd, len));
246 memset(msg, 0, sizeof(struct cdc_ioctl));
248 msg->cmd = cpu_to_le32(cmd);
249 msg->len = cpu_to_le32(len);
250 msg->flags = (++prot->reqid << CDCF_IOC_ID_SHIFT) | CDCF_IOC_SET;
251 CDC_SET_IF_IDX(msg, ifidx);
252 msg->flags = cpu_to_le32(msg->flags);
255 memcpy(prot->buf, buf, len);
257 ret = brcmf_proto_cdc_msg(dhd);
261 ret = brcmf_proto_cdc_cmplt(dhd, prot->reqid, len);
265 flags = le32_to_cpu(msg->flags);
266 id = (flags & CDCF_IOC_ID_MASK) >> CDCF_IOC_ID_SHIFT;
268 if (id != prot->reqid) {
269 DHD_ERROR(("%s: %s: unexpected request id %d (expected %d)\n",
270 brcmf_ifname(dhd, ifidx), __func__, id,
276 /* Check the ERROR flag */
277 if (flags & CDCF_IOC_ERROR) {
278 ret = le32_to_cpu(msg->status);
279 /* Cache error from dongle */
280 dhd->dongle_error = ret;
287 extern int dhd_bus_interface(struct dhd_bus *bus, uint arg, void *arg2);
289 brcmf_proto_ioctl(dhd_pub_t *dhd, int ifidx, wl_ioctl_t *ioc, void *buf,
292 dhd_prot_t *prot = dhd->prot;
295 if (dhd->busstate == DHD_BUS_DOWN) {
296 DHD_ERROR(("%s : bus is down. we have nothing to do\n",
300 brcmf_os_proto_block(dhd);
302 DHD_TRACE(("%s: Enter\n", __func__));
304 ASSERT(len <= BRCMF_C_IOCTL_MAXLEN);
306 if (len > BRCMF_C_IOCTL_MAXLEN)
309 if (prot->pending == true) {
310 DHD_TRACE(("CDC packet is pending!!!! cmd=0x%x (%lu) "
311 "lastcmd=0x%x (%lu)\n",
312 ioc->cmd, (unsigned long)ioc->cmd, prot->lastcmd,
313 (unsigned long)prot->lastcmd));
314 if ((ioc->cmd == BRCMF_C_SET_VAR) ||
315 (ioc->cmd == BRCMF_C_GET_VAR))
316 DHD_TRACE(("iovar cmd=%s\n", (char *)buf));
321 prot->pending = true;
322 prot->lastcmd = ioc->cmd;
324 ret = brcmf_proto_cdc_set_ioctl(dhd, ifidx, ioc->cmd, buf, len);
326 ret = brcmf_proto_cdc_query_ioctl(dhd, ifidx, ioc->cmd,
329 ioc->used = ret - sizeof(struct cdc_ioctl);
332 /* Too many programs assume ioctl() returns 0 on success */
336 struct cdc_ioctl *msg = &prot->msg;
337 /* len == needed when set/query fails from dongle */
338 ioc->needed = le32_to_cpu(msg->len);
341 /* Intercept the wme_dp ioctl here */
342 if (!ret && ioc->cmd == BRCMF_C_SET_VAR &&
343 !strcmp(buf, "wme_dp")) {
346 slen = strlen("wme_dp") + 1;
347 if (len >= (int)(slen + sizeof(int)))
348 memcpy(&val, (char *)buf + slen, sizeof(int));
349 dhd->wme_dp = (u8) le32_to_cpu(val);
352 prot->pending = false;
355 brcmf_os_proto_unblock(dhd);
360 #define PKTSUMNEEDED(skb) \
361 (((struct sk_buff *)(skb))->ip_summed == CHECKSUM_PARTIAL)
362 #define PKTSETSUMGOOD(skb, x) \
363 (((struct sk_buff *)(skb))->ip_summed = \
364 ((x) ? CHECKSUM_UNNECESSARY : CHECKSUM_NONE))
366 /* PKTSETSUMNEEDED and PKTSUMGOOD are not possible because
367 skb->ip_summed is overloaded */
370 brcmf_proto_iovar_op(dhd_pub_t *dhdp, const char *name,
371 void *params, int plen, void *arg, int len, bool set)
376 void brcmf_proto_dump(dhd_pub_t *dhdp, struct brcmu_strbuf *strbuf)
378 brcmu_bprintf(strbuf, "Protocol CDC: reqid %d\n", dhdp->prot->reqid);
381 void brcmf_proto_hdrpush(dhd_pub_t *dhd, int ifidx, struct sk_buff *pktbuf)
383 struct bdc_header *h;
385 DHD_TRACE(("%s: Enter\n", __func__));
387 /* Push BDC header used to convey priority for buses that don't */
389 skb_push(pktbuf, BDC_HEADER_LEN);
391 h = (struct bdc_header *)(pktbuf->data);
393 h->flags = (BDC_PROTO_VER << BDC_FLAG_VER_SHIFT);
394 if (PKTSUMNEEDED(pktbuf))
395 h->flags |= BDC_FLAG_SUM_NEEDED;
397 h->priority = (pktbuf->priority & BDC_PRIORITY_MASK);
400 BDC_SET_IF_IDX(h, ifidx);
403 int brcmf_proto_hdrpull(dhd_pub_t *dhd, int *ifidx, struct sk_buff *pktbuf)
405 struct bdc_header *h;
407 DHD_TRACE(("%s: Enter\n", __func__));
409 /* Pop BDC header used to convey priority for buses that don't */
411 if (pktbuf->len < BDC_HEADER_LEN) {
412 DHD_ERROR(("%s: rx data too short (%d < %d)\n", __func__,
413 pktbuf->len, BDC_HEADER_LEN));
417 h = (struct bdc_header *)(pktbuf->data);
419 *ifidx = BDC_GET_IF_IDX(h);
420 if (*ifidx >= DHD_MAX_IFS) {
421 DHD_ERROR(("%s: rx data ifnum out of range (%d)\n",
426 if (((h->flags & BDC_FLAG_VER_MASK) >> BDC_FLAG_VER_SHIFT) !=
428 DHD_ERROR(("%s: non-BDC packet received, flags 0x%x\n",
429 brcmf_ifname(dhd, *ifidx), h->flags));
433 if (h->flags & BDC_FLAG_SUM_GOOD) {
434 DHD_INFO(("%s: BDC packet received with good rx-csum, "
436 brcmf_ifname(dhd, *ifidx), h->flags));
437 PKTSETSUMGOOD(pktbuf, true);
440 pktbuf->priority = h->priority & BDC_PRIORITY_MASK;
442 skb_pull(pktbuf, BDC_HEADER_LEN);
447 int brcmf_proto_attach(dhd_pub_t *dhd)
451 cdc = kzalloc(sizeof(dhd_prot_t), GFP_ATOMIC);
453 DHD_ERROR(("%s: kmalloc failed\n", __func__));
457 /* ensure that the msg buf directly follows the cdc msg struct */
458 if ((unsigned long)(&cdc->msg + 1) != (unsigned long)cdc->buf) {
459 DHD_ERROR(("dhd_prot_t is not correctly defined\n"));
464 dhd->hdrlen += BDC_HEADER_LEN;
465 dhd->maxctl = BRCMF_C_IOCTL_MAXLEN +
466 sizeof(struct cdc_ioctl) + ROUND_UP_MARGIN;
474 /* ~NOTE~ What if another thread is waiting on the semaphore? Holding it? */
475 void brcmf_proto_detach(dhd_pub_t *dhd)
481 void brcmf_proto_dstats(dhd_pub_t *dhd)
483 /* No stats from dongle added yet, copy bus stats */
484 dhd->dstats.tx_packets = dhd->tx_packets;
485 dhd->dstats.tx_errors = dhd->tx_errors;
486 dhd->dstats.rx_packets = dhd->rx_packets;
487 dhd->dstats.rx_errors = dhd->rx_errors;
488 dhd->dstats.rx_dropped = dhd->rx_dropped;
489 dhd->dstats.multicast = dhd->rx_multicast;
493 int brcmf_proto_init(dhd_pub_t *dhd)
498 DHD_TRACE(("%s: Enter\n", __func__));
500 brcmf_os_proto_block(dhd);
502 /* Get the device MAC address */
503 strcpy(buf, "cur_etheraddr");
504 ret = brcmf_proto_cdc_query_ioctl(dhd, 0, BRCMF_C_GET_VAR,
507 brcmf_os_proto_unblock(dhd);
510 memcpy(dhd->mac, buf, ETH_ALEN);
512 brcmf_os_proto_unblock(dhd);
514 #ifdef EMBEDDED_PLATFORM
515 ret = brcmf_c_preinit_ioctls(dhd);
516 #endif /* EMBEDDED_PLATFORM */
518 /* Always assumes wl for now */
524 void brcmf_proto_stop(dhd_pub_t *dhd)
526 /* Nothing to do for CDC */