drivers/staging/brcm80211/brcmfmac/dhd_cdc.c

   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 #include <linux/types.h>
  18 #include <linux/netdevice.h>
  19 #include <linux/sched.h>
  20 #include <defs.h>
  21
  22 #include <brcmu_utils.h>
  23 #include <brcmu_wifi.h>
  24
  25 #include "dngl_stats.h"
  26 #include "dhd.h"
  27 #include "dhd_proto.h"
  28 #include "dhd_bus.h"
  29 #include "dhd_dbg.h"
  30
  31 struct brcmf_proto_cdc_ioctl {
  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 */
  37 };
  38
  39 /* Max valid buffer size that can be sent to the dongle */
  40 #define CDC_MAX_MSG_SIZE        (ETH_FRAME_LEN+ETH_FCS_LEN)
  41
  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)))
  54
  55 /*
  56  * BDC header - Broadcom specific extension of CDC.
  57  * Used on data packets to convey priority across USB.
  58  */
  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
  68
  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)))
  74
  75 struct brcmf_proto_bdc_header {
  76         u8 flags;
  77         u8 priority;    /* 802.1d Priority, 4:7 flow control info for usb */
  78         u8 flags2;
  79         u8 rssi;
  80 };
  81
  82
  83 #define RETRIES 2       /* # of retries to retrieve matching ioctl response */
  84 #define BUS_HEADER_LEN  (16+BRCMF_SDALIGN) /* Must be atleast SDPCM_RESERVE
  85                                          * (amount of header tha might be added)
  86                                          * plus any space that might be needed
  87                                          * for alignment padding.
  88                                          */
  89 #define ROUND_UP_MARGIN 2048    /* Biggest SDIO block size possible for
  90                                  * round off at the end of buffer
  91                                  */
  92
  93 struct brcmf_proto {
  94         u16 reqid;
  95         u8 pending;
  96         u32 lastcmd;
  97         u8 bus_header[BUS_HEADER_LEN];
  98         struct brcmf_proto_cdc_ioctl msg;
  99         unsigned char buf[BRCMF_C_IOCTL_MAXLEN + ROUND_UP_MARGIN];
 100 };
 101
 102 static int brcmf_proto_cdc_msg(struct brcmf_pub *drvr)
 103 {
 104         struct brcmf_proto *prot = drvr->prot;
 105         int len = le32_to_cpu(prot->msg.len) +
 106                         sizeof(struct brcmf_proto_cdc_ioctl);
 107
 108         BRCMF_TRACE(("%s: Enter\n", __func__));
 109
 110         /* NOTE : cdc->msg.len holds the desired length of the buffer to be
 111          *        returned. Only up to CDC_MAX_MSG_SIZE of this buffer area
 112          *        is actually sent to the dongle
 113          */
 114         if (len > CDC_MAX_MSG_SIZE)
 115                 len = CDC_MAX_MSG_SIZE;
 116
 117         /* Send request */
 118         return brcmf_sdbrcm_bus_txctl(drvr->bus, (unsigned char *)&prot->msg,
 119                                       len);
 120 }
 121
 122 static int brcmf_proto_cdc_cmplt(struct brcmf_pub *drvr, u32 id, u32 len)
 123 {
 124         int ret;
 125         struct brcmf_proto *prot = drvr->prot;
 126
 127         BRCMF_TRACE(("%s: Enter\n", __func__));
 128
 129         do {
 130                 ret = brcmf_sdbrcm_bus_rxctl(drvr->bus,
 131                                 (unsigned char *)&prot->msg,
 132                                 len + sizeof(struct brcmf_proto_cdc_ioctl));
 133                 if (ret < 0)
 134                         break;
 135         } while (CDC_IOC_ID(le32_to_cpu(prot->msg.flags)) != id);
 136
 137         return ret;
 138 }
 139
 140 int
 141 brcmf_proto_cdc_query_ioctl(struct brcmf_pub *drvr, int ifidx, uint cmd,
 142                             void *buf, uint len)
 143 {
 144         struct brcmf_proto *prot = drvr->prot;
 145         struct brcmf_proto_cdc_ioctl *msg = &prot->msg;
 146         void *info;
 147         int ret = 0, retries = 0;
 148         u32 id, flags = 0;
 149
 150         BRCMF_TRACE(("%s: Enter\n", __func__));
 151         BRCMF_CTL(("%s: cmd %d len %d\n", __func__, cmd, len));
 152
 153         /* Respond "bcmerror" and "bcmerrorstr" with local cache */
 154         if (cmd == BRCMF_C_GET_VAR && buf) {
 155                 if (!strcmp((char *)buf, "bcmerrorstr")) {
 156                         strncpy((char *)buf, "bcm_error",
 157                                 BCME_STRLEN);
 158                         goto done;
 159                 } else if (!strcmp((char *)buf, "bcmerror")) {
 160                         *(int *)buf = drvr->dongle_error;
 161                         goto done;
 162                 }
 163         }
 164
 165         memset(msg, 0, sizeof(struct brcmf_proto_cdc_ioctl));
 166
 167         msg->cmd = cpu_to_le32(cmd);
 168         msg->len = cpu_to_le32(len);
 169         msg->flags = (++prot->reqid << CDCF_IOC_ID_SHIFT);
 170         CDC_SET_IF_IDX(msg, ifidx);
 171         msg->flags = cpu_to_le32(msg->flags);
 172
 173         if (buf)
 174                 memcpy(prot->buf, buf, len);
 175
 176         ret = brcmf_proto_cdc_msg(drvr);
 177         if (ret < 0) {
 178                 BRCMF_ERROR(("brcmf_proto_cdc_query_ioctl: brcmf_proto_cdc_msg "
 179                              "failed w/status %d\n", ret));
 180                 goto done;
 181         }
 182
 183 retry:
 184         /* wait for interrupt and get first fragment */
 185         ret = brcmf_proto_cdc_cmplt(drvr, prot->reqid, len);
 186         if (ret < 0)
 187                 goto done;
 188
 189         flags = le32_to_cpu(msg->flags);
 190         id = (flags & CDCF_IOC_ID_MASK) >> CDCF_IOC_ID_SHIFT;
 191
 192         if ((id < prot->reqid) && (++retries < RETRIES))
 193                 goto retry;
 194         if (id != prot->reqid) {
 195                 BRCMF_ERROR(("%s: %s: unexpected request id %d (expected %d)\n",
 196                              brcmf_ifname(drvr, ifidx), __func__, id,
 197                              prot->reqid));
 198                 ret = -EINVAL;
 199                 goto done;
 200         }
 201
 202         /* Check info buffer */
 203         info = (void *)&msg[1];
 204
 205         /* Copy info buffer */
 206         if (buf) {
 207                 if (ret < (int)len)
 208                         len = ret;
 209                 memcpy(buf, info, len);
 210         }
 211
 212         /* Check the ERROR flag */
 213         if (flags & CDCF_IOC_ERROR) {
 214                 ret = le32_to_cpu(msg->status);
 215                 /* Cache error from dongle */
 216                 drvr->dongle_error = ret;
 217         }
 218
 219 done:
 220         return ret;
 221 }
 222
 223 int brcmf_proto_cdc_set_ioctl(struct brcmf_pub *drvr, int ifidx, uint cmd,
 224                               void *buf, uint len)
 225 {
 226         struct brcmf_proto *prot = drvr->prot;
 227         struct brcmf_proto_cdc_ioctl *msg = &prot->msg;
 228         int ret = 0;
 229         u32 flags, id;
 230
 231         BRCMF_TRACE(("%s: Enter\n", __func__));
 232         BRCMF_CTL(("%s: cmd %d len %d\n", __func__, cmd, len));
 233
 234         memset(msg, 0, sizeof(struct brcmf_proto_cdc_ioctl));
 235
 236         msg->cmd = cpu_to_le32(cmd);
 237         msg->len = cpu_to_le32(len);
 238         msg->flags = (++prot->reqid << CDCF_IOC_ID_SHIFT) | CDCF_IOC_SET;
 239         CDC_SET_IF_IDX(msg, ifidx);
 240         msg->flags = cpu_to_le32(msg->flags);
 241
 242         if (buf)
 243                 memcpy(prot->buf, buf, len);
 244
 245         ret = brcmf_proto_cdc_msg(drvr);
 246         if (ret < 0)
 247                 goto done;
 248
 249         ret = brcmf_proto_cdc_cmplt(drvr, prot->reqid, len);
 250         if (ret < 0)
 251                 goto done;
 252
 253         flags = le32_to_cpu(msg->flags);
 254         id = (flags & CDCF_IOC_ID_MASK) >> CDCF_IOC_ID_SHIFT;
 255
 256         if (id != prot->reqid) {
 257                 BRCMF_ERROR(("%s: %s: unexpected request id %d (expected %d)\n",
 258                              brcmf_ifname(drvr, ifidx), __func__, id,
 259                              prot->reqid));
 260                 ret = -EINVAL;
 261                 goto done;
 262         }
 263
 264         /* Check the ERROR flag */
 265         if (flags & CDCF_IOC_ERROR) {
 266                 ret = le32_to_cpu(msg->status);
 267                 /* Cache error from dongle */
 268                 drvr->dongle_error = ret;
 269         }
 270
 271 done:
 272         return ret;
 273 }
 274
 275 int
 276 brcmf_proto_ioctl(struct brcmf_pub *drvr, int ifidx, struct brcmf_ioctl *ioc,
 277                   void *buf, int len)
 278 {
 279         struct brcmf_proto *prot = drvr->prot;
 280         int ret = -1;
 281
 282         if (drvr->busstate == BRCMF_BUS_DOWN) {
 283                 BRCMF_ERROR(("%s : bus is down. we have nothing to do\n",
 284                              __func__));
 285                 return ret;
 286         }
 287         brcmf_os_proto_block(drvr);
 288
 289         BRCMF_TRACE(("%s: Enter\n", __func__));
 290
 291         if (len > BRCMF_C_IOCTL_MAXLEN)
 292                 goto done;
 293
 294         if (prot->pending == true) {
 295                 BRCMF_TRACE(("CDC packet is pending!!!! cmd=0x%x (%lu) "
 296                              "lastcmd=0x%x (%lu)\n",
 297                              ioc->cmd, (unsigned long)ioc->cmd, prot->lastcmd,
 298                              (unsigned long)prot->lastcmd));
 299                 if ((ioc->cmd == BRCMF_C_SET_VAR) ||
 300                     (ioc->cmd == BRCMF_C_GET_VAR))
 301                         BRCMF_TRACE(("iovar cmd=%s\n", (char *)buf));
 302
 303                 goto done;
 304         }
 305
 306         prot->pending = true;
 307         prot->lastcmd = ioc->cmd;
 308         if (ioc->set)
 309                 ret = brcmf_proto_cdc_set_ioctl(drvr, ifidx, ioc->cmd,
 310                                                 buf, len);
 311         else {
 312                 ret = brcmf_proto_cdc_query_ioctl(drvr, ifidx, ioc->cmd,
 313                                                   buf, len);
 314                 if (ret > 0)
 315                         ioc->used = ret - sizeof(struct brcmf_proto_cdc_ioctl);
 316         }
 317
 318         /* Too many programs assume ioctl() returns 0 on success */
 319         if (ret >= 0)
 320                 ret = 0;
 321         else {
 322                 struct brcmf_proto_cdc_ioctl *msg = &prot->msg;
 323                 /* len == needed when set/query fails from dongle */
 324                 ioc->needed = le32_to_cpu(msg->len);
 325         }
 326
 327         /* Intercept the wme_dp ioctl here */
 328         if (!ret && ioc->cmd == BRCMF_C_SET_VAR &&
 329             !strcmp(buf, "wme_dp")) {
 330                 int slen, val = 0;
 331
 332                 slen = strlen("wme_dp") + 1;
 333                 if (len >= (int)(slen + sizeof(int)))
 334                         memcpy(&val, (char *)buf + slen, sizeof(int));
 335                 drvr->wme_dp = (u8) le32_to_cpu(val);
 336         }
 337
 338         prot->pending = false;
 339
 340 done:
 341         brcmf_os_proto_unblock(drvr);
 342
 343         return ret;
 344 }
 345
 346 #define PKTSUMNEEDED(skb) \
 347                 (((struct sk_buff *)(skb))->ip_summed == CHECKSUM_PARTIAL)
 348 #define PKTSETSUMGOOD(skb, x) \
 349                 (((struct sk_buff *)(skb))->ip_summed = \
 350                 ((x) ? CHECKSUM_UNNECESSARY : CHECKSUM_NONE))
 351
 352 void brcmf_proto_dump(struct brcmf_pub *drvr, struct brcmu_strbuf *strbuf)
 353 {
 354         brcmu_bprintf(strbuf, "Protocol CDC: reqid %d\n", drvr->prot->reqid);
 355 }
 356
 357 void brcmf_proto_hdrpush(struct brcmf_pub *drvr, int ifidx,
 358                          struct sk_buff *pktbuf)
 359 {
 360         struct brcmf_proto_bdc_header *h;
 361
 362         BRCMF_TRACE(("%s: Enter\n", __func__));
 363
 364         /* Push BDC header used to convey priority for buses that don't */
 365
 366         skb_push(pktbuf, BDC_HEADER_LEN);
 367
 368         h = (struct brcmf_proto_bdc_header *)(pktbuf->data);
 369
 370         h->flags = (BDC_PROTO_VER << BDC_FLAG_VER_SHIFT);
 371         if (PKTSUMNEEDED(pktbuf))
 372                 h->flags |= BDC_FLAG_SUM_NEEDED;
 373
 374         h->priority = (pktbuf->priority & BDC_PRIORITY_MASK);
 375         h->flags2 = 0;
 376         h->rssi = 0;
 377         BDC_SET_IF_IDX(h, ifidx);
 378 }
 379
 380 int brcmf_proto_hdrpull(struct brcmf_pub *drvr, int *ifidx,
 381                         struct sk_buff *pktbuf)
 382 {
 383         struct brcmf_proto_bdc_header *h;
 384
 385         BRCMF_TRACE(("%s: Enter\n", __func__));
 386
 387         /* Pop BDC header used to convey priority for buses that don't */
 388
 389         if (pktbuf->len < BDC_HEADER_LEN) {
 390                 BRCMF_ERROR(("%s: rx data too short (%d < %d)\n", __func__,
 391                              pktbuf->len, BDC_HEADER_LEN));
 392                 return -EBADE;
 393         }
 394
 395         h = (struct brcmf_proto_bdc_header *)(pktbuf->data);
 396
 397         *ifidx = BDC_GET_IF_IDX(h);
 398         if (*ifidx >= BRCMF_MAX_IFS) {
 399                 BRCMF_ERROR(("%s: rx data ifnum out of range (%d)\n",
 400                              __func__, *ifidx));
 401                 return -EBADE;
 402         }
 403
 404         if (((h->flags & BDC_FLAG_VER_MASK) >> BDC_FLAG_VER_SHIFT) !=
 405             BDC_PROTO_VER) {
 406                 BRCMF_ERROR(("%s: non-BDC packet received, flags 0x%x\n",
 407                              brcmf_ifname(drvr, *ifidx), h->flags));
 408                 return -EBADE;
 409         }
 410
 411         if (h->flags & BDC_FLAG_SUM_GOOD) {
 412                 BRCMF_INFO(("%s: BDC packet received with good rx-csum, "
 413                             "flags 0x%x\n",
 414                             brcmf_ifname(drvr, *ifidx), h->flags));
 415                 PKTSETSUMGOOD(pktbuf, true);
 416         }
 417
 418         pktbuf->priority = h->priority & BDC_PRIORITY_MASK;
 419
 420         skb_pull(pktbuf, BDC_HEADER_LEN);
 421
 422         return 0;
 423 }
 424
 425 int brcmf_proto_attach(struct brcmf_pub *drvr)
 426 {
 427         struct brcmf_proto *cdc;
 428
 429         cdc = kzalloc(sizeof(struct brcmf_proto), GFP_ATOMIC);
 430         if (!cdc) {
 431                 BRCMF_ERROR(("%s: kmalloc failed\n", __func__));
 432                 goto fail;
 433         }
 434
 435         /* ensure that the msg buf directly follows the cdc msg struct */
 436         if ((unsigned long)(&cdc->msg + 1) != (unsigned long)cdc->buf) {
 437                 BRCMF_ERROR(("struct brcmf_proto is not correctly defined\n"));
 438                 goto fail;
 439         }
 440
 441         drvr->prot = cdc;
 442         drvr->hdrlen += BDC_HEADER_LEN;
 443         drvr->maxctl = BRCMF_C_IOCTL_MAXLEN +
 444                         sizeof(struct brcmf_proto_cdc_ioctl) + ROUND_UP_MARGIN;
 445         return 0;
 446
 447 fail:
 448         kfree(cdc);
 449         return -ENOMEM;
 450 }
 451
 452 /* ~NOTE~ What if another thread is waiting on the semaphore?  Holding it? */
 453 void brcmf_proto_detach(struct brcmf_pub *drvr)
 454 {
 455         kfree(drvr->prot);
 456         drvr->prot = NULL;
 457 }
 458
 459 void brcmf_proto_dstats(struct brcmf_pub *drvr)
 460 {
 461         /* No stats from dongle added yet, copy bus stats */
 462         drvr->dstats.tx_packets = drvr->tx_packets;
 463         drvr->dstats.tx_errors = drvr->tx_errors;
 464         drvr->dstats.rx_packets = drvr->rx_packets;
 465         drvr->dstats.rx_errors = drvr->rx_errors;
 466         drvr->dstats.rx_dropped = drvr->rx_dropped;
 467         drvr->dstats.multicast = drvr->rx_multicast;
 468         return;
 469 }
 470
 471 int brcmf_proto_init(struct brcmf_pub *drvr)
 472 {
 473         int ret = 0;
 474         char buf[128];
 475
 476         BRCMF_TRACE(("%s: Enter\n", __func__));
 477
 478         brcmf_os_proto_block(drvr);
 479
 480         /* Get the device MAC address */
 481         strcpy(buf, "cur_etheraddr");
 482         ret = brcmf_proto_cdc_query_ioctl(drvr, 0, BRCMF_C_GET_VAR,
 483                                           buf, sizeof(buf));
 484         if (ret < 0) {
 485                 brcmf_os_proto_unblock(drvr);
 486                 return ret;
 487         }
 488         memcpy(drvr->mac, buf, ETH_ALEN);
 489
 490         brcmf_os_proto_unblock(drvr);
 491
 492         ret = brcmf_c_preinit_ioctls(drvr);
 493
 494         /* Always assumes wl for now */
 495         drvr->iswl = true;
 496
 497         return ret;
 498 }
 499
 500 void brcmf_proto_stop(struct brcmf_pub *drvr)
 501 {
 502         /* Nothing to do for CDC */
 503 }