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 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
  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 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 #ifdef CUSTOMER_HW2
  84 int wifi_get_mac_addr(unsigned char *buf);
  85 #endif
  86
  87 /* Packet alignment for most efficient SDIO (can change based on platform) */
  88 #ifndef DHD_SDALIGN
  89 #define DHD_SDALIGN     32
  90 #endif
  91 #if !ISPOWEROF2(DHD_SDALIGN)
  92 #error DHD_SDALIGN is not a power of 2!
  93 #endif
  94
  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.
 101                                          */
 102 #define ROUND_UP_MARGIN 2048    /* Biggest SDIO block size possible for
 103                                  * round off at the end of buffer
 104                                  */
 105
 106 typedef struct dhd_prot {
 107         u16 reqid;
 108         u8 pending;
 109         u32 lastcmd;
 110         u8 bus_header[BUS_HEADER_LEN];
 111         struct cdc_ioctl msg;
 112         unsigned char buf[WLC_IOCTL_MAXLEN + ROUND_UP_MARGIN];
 113 } dhd_prot_t;
 114
 115 static int dhdcdc_msg(dhd_pub_t *dhd)
 116 {
 117         dhd_prot_t *prot = dhd->prot;
 118         int len = le32_to_cpu(prot->msg.len) + sizeof(struct cdc_ioctl);
 119
 120         DHD_TRACE(("%s: Enter\n", __func__));
 121
 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
 125          */
 126         if (len > CDC_MAX_MSG_SIZE)
 127                 len = CDC_MAX_MSG_SIZE;
 128
 129         /* Send request */
 130         return brcmf_sdbrcm_bus_txctl(dhd->bus, (unsigned char *)&prot->msg,
 131                                       len);
 132 }
 133
 134 static int dhdcdc_cmplt(dhd_pub_t *dhd, u32 id, u32 len)
 135 {
 136         int ret;
 137         dhd_prot_t *prot = dhd->prot;
 138
 139         DHD_TRACE(("%s: Enter\n", __func__));
 140
 141         do {
 142                 ret = brcmf_sdbrcm_bus_rxctl(dhd->bus,
 143                                              (unsigned char *)&prot->msg,
 144                                              len + sizeof(struct cdc_ioctl));
 145                 if (ret < 0)
 146                         break;
 147         } while (CDC_IOC_ID(le32_to_cpu(prot->msg.flags)) != id);
 148
 149         return ret;
 150 }
 151
 152 int
 153 dhdcdc_query_ioctl(dhd_pub_t *dhd, int ifidx, uint cmd, void *buf, uint len)
 154 {
 155         dhd_prot_t *prot = dhd->prot;
 156         struct cdc_ioctl *msg = &prot->msg;
 157         void *info;
 158         int ret = 0, retries = 0;
 159         u32 id, flags = 0;
 160
 161         DHD_TRACE(("%s: Enter\n", __func__));
 162         DHD_CTL(("%s: cmd %d len %d\n", __func__, cmd, len));
 163
 164         /* Respond "bcmerror" and "bcmerrorstr" with local cache */
 165         if (cmd == WLC_GET_VAR && buf) {
 166                 if (!strcmp((char *)buf, "bcmerrorstr")) {
 167                         strncpy((char *)buf, "bcm_error",
 168                                 BCME_STRLEN);
 169                         goto done;
 170                 } else if (!strcmp((char *)buf, "bcmerror")) {
 171                         *(int *)buf = dhd->dongle_error;
 172                         goto done;
 173                 }
 174         }
 175
 176         memset(msg, 0, sizeof(struct cdc_ioctl));
 177
 178         msg->cmd = cpu_to_le32(cmd);
 179         msg->len = cpu_to_le32(len);
 180         msg->flags = (++prot->reqid << CDCF_IOC_ID_SHIFT);
 181         CDC_SET_IF_IDX(msg, ifidx);
 182         msg->flags = cpu_to_le32(msg->flags);
 183
 184         if (buf)
 185                 memcpy(prot->buf, buf, len);
 186
 187         ret = dhdcdc_msg(dhd);
 188         if (ret < 0) {
 189                 DHD_ERROR(("dhdcdc_query_ioctl: dhdcdc_msg failed w/status "
 190                         "%d\n", ret));
 191                 goto done;
 192         }
 193
 194 retry:
 195         /* wait for interrupt and get first fragment */
 196         ret = dhdcdc_cmplt(dhd, prot->reqid, len);
 197         if (ret < 0)
 198                 goto done;
 199
 200         flags = le32_to_cpu(msg->flags);
 201         id = (flags & CDCF_IOC_ID_MASK) >> CDCF_IOC_ID_SHIFT;
 202
 203         if ((id < prot->reqid) && (++retries < RETRIES))
 204                 goto retry;
 205         if (id != prot->reqid) {
 206                 DHD_ERROR(("%s: %s: unexpected request id %d (expected %d)\n",
 207                            dhd_ifname(dhd, ifidx), __func__, id, prot->reqid));
 208                 ret = -EINVAL;
 209                 goto done;
 210         }
 211
 212         /* Check info buffer */
 213         info = (void *)&msg[1];
 214
 215         /* Copy info buffer */
 216         if (buf) {
 217                 if (ret < (int)len)
 218                         len = ret;
 219                 memcpy(buf, info, len);
 220         }
 221
 222         /* Check the ERROR flag */
 223         if (flags & CDCF_IOC_ERROR) {
 224                 ret = le32_to_cpu(msg->status);
 225                 /* Cache error from dongle */
 226                 dhd->dongle_error = ret;
 227         }
 228
 229 done:
 230         return ret;
 231 }
 232
 233 int dhdcdc_set_ioctl(dhd_pub_t *dhd, int ifidx, uint cmd, void *buf, uint len)
 234 {
 235         dhd_prot_t *prot = dhd->prot;
 236         struct cdc_ioctl *msg = &prot->msg;
 237         int ret = 0;
 238         u32 flags, id;
 239
 240         DHD_TRACE(("%s: Enter\n", __func__));
 241         DHD_CTL(("%s: cmd %d len %d\n", __func__, cmd, len));
 242
 243         memset(msg, 0, sizeof(struct cdc_ioctl));
 244
 245         msg->cmd = cpu_to_le32(cmd);
 246         msg->len = cpu_to_le32(len);
 247         msg->flags = (++prot->reqid << CDCF_IOC_ID_SHIFT) | CDCF_IOC_SET;
 248         CDC_SET_IF_IDX(msg, ifidx);
 249         msg->flags = cpu_to_le32(msg->flags);
 250
 251         if (buf)
 252                 memcpy(prot->buf, buf, len);
 253
 254         ret = dhdcdc_msg(dhd);
 255         if (ret < 0)
 256                 goto done;
 257
 258         ret = dhdcdc_cmplt(dhd, prot->reqid, len);
 259         if (ret < 0)
 260                 goto done;
 261
 262         flags = le32_to_cpu(msg->flags);
 263         id = (flags & CDCF_IOC_ID_MASK) >> CDCF_IOC_ID_SHIFT;
 264
 265         if (id != prot->reqid) {
 266                 DHD_ERROR(("%s: %s: unexpected request id %d (expected %d)\n",
 267                            dhd_ifname(dhd, ifidx), __func__, id, prot->reqid));
 268                 ret = -EINVAL;
 269                 goto done;
 270         }
 271
 272         /* Check the ERROR flag */
 273         if (flags & CDCF_IOC_ERROR) {
 274                 ret = le32_to_cpu(msg->status);
 275                 /* Cache error from dongle */
 276                 dhd->dongle_error = ret;
 277         }
 278
 279 done:
 280         return ret;
 281 }
 282
 283 extern int dhd_bus_interface(struct dhd_bus *bus, uint arg, void *arg2);
 284 int
 285 dhd_prot_ioctl(dhd_pub_t *dhd, int ifidx, wl_ioctl_t *ioc, void *buf, int len)
 286 {
 287         dhd_prot_t *prot = dhd->prot;
 288         int ret = -1;
 289
 290         if (dhd->busstate == DHD_BUS_DOWN) {
 291                 DHD_ERROR(("%s : bus is down. we have nothing to do\n",
 292                            __func__));
 293                 return ret;
 294         }
 295         dhd_os_proto_block(dhd);
 296
 297         DHD_TRACE(("%s: Enter\n", __func__));
 298
 299         ASSERT(len <= WLC_IOCTL_MAXLEN);
 300
 301         if (len > WLC_IOCTL_MAXLEN)
 302                 goto done;
 303
 304         if (prot->pending == true) {
 305                 DHD_TRACE(("CDC packet is pending!!!! cmd=0x%x (%lu) "
 306                         "lastcmd=0x%x (%lu)\n",
 307                         ioc->cmd, (unsigned long)ioc->cmd, prot->lastcmd,
 308                         (unsigned long)prot->lastcmd));
 309                 if ((ioc->cmd == WLC_SET_VAR) || (ioc->cmd == WLC_GET_VAR))
 310                         DHD_TRACE(("iovar cmd=%s\n", (char *)buf));
 311
 312                 goto done;
 313         }
 314
 315         prot->pending = true;
 316         prot->lastcmd = ioc->cmd;
 317         if (ioc->set)
 318                 ret = dhdcdc_set_ioctl(dhd, ifidx, ioc->cmd, buf, len);
 319         else {
 320                 ret = dhdcdc_query_ioctl(dhd, ifidx, ioc->cmd, buf, len);
 321                 if (ret > 0)
 322                         ioc->used = ret - sizeof(struct cdc_ioctl);
 323         }
 324
 325         /* Too many programs assume ioctl() returns 0 on success */
 326         if (ret >= 0)
 327                 ret = 0;
 328         else {
 329                 struct cdc_ioctl *msg = &prot->msg;
 330                 /* len == needed when set/query fails from dongle */
 331                 ioc->needed = le32_to_cpu(msg->len);
 332         }
 333
 334         /* Intercept the wme_dp ioctl here */
 335         if ((!ret) && (ioc->cmd == WLC_SET_VAR) && (!strcmp(buf, "wme_dp"))) {
 336                 int slen, val = 0;
 337
 338                 slen = strlen("wme_dp") + 1;
 339                 if (len >= (int)(slen + sizeof(int)))
 340                         memcpy(&val, (char *)buf + slen, sizeof(int));
 341                 dhd->wme_dp = (u8) le32_to_cpu(val);
 342         }
 343
 344         prot->pending = false;
 345
 346 done:
 347         dhd_os_proto_unblock(dhd);
 348
 349         return ret;
 350 }
 351
 352 #define PKTSUMNEEDED(skb) \
 353                 (((struct sk_buff *)(skb))->ip_summed == CHECKSUM_PARTIAL)
 354 #define PKTSETSUMGOOD(skb, x) \
 355                 (((struct sk_buff *)(skb))->ip_summed = \
 356                 ((x) ? CHECKSUM_UNNECESSARY : CHECKSUM_NONE))
 357
 358 /* PKTSETSUMNEEDED and PKTSUMGOOD are not possible because
 359         skb->ip_summed is overloaded */
 360
 361 int
 362 dhd_prot_iovar_op(dhd_pub_t *dhdp, const char *name,
 363                   void *params, int plen, void *arg, int len, bool set)
 364 {
 365         return -ENOTSUPP;
 366 }
 367
 368 void dhd_prot_dump(dhd_pub_t *dhdp, struct brcmu_strbuf *strbuf)
 369 {
 370         brcmu_bprintf(strbuf, "Protocol CDC: reqid %d\n", dhdp->prot->reqid);
 371 }
 372
 373 void dhd_prot_hdrpush(dhd_pub_t *dhd, int ifidx, struct sk_buff *pktbuf)
 374 {
 375 #ifdef BDC
 376         struct bdc_header *h;
 377 #endif                          /* BDC */
 378
 379         DHD_TRACE(("%s: Enter\n", __func__));
 380
 381 #ifdef BDC
 382         /* Push BDC header used to convey priority for buses that don't */
 383
 384         skb_push(pktbuf, BDC_HEADER_LEN);
 385
 386         h = (struct bdc_header *)(pktbuf->data);
 387
 388         h->flags = (BDC_PROTO_VER << BDC_FLAG_VER_SHIFT);
 389         if (PKTSUMNEEDED(pktbuf))
 390                 h->flags |= BDC_FLAG_SUM_NEEDED;
 391
 392         h->priority = (pktbuf->priority & BDC_PRIORITY_MASK);
 393         h->flags2 = 0;
 394         h->rssi = 0;
 395 #endif                          /* BDC */
 396         BDC_SET_IF_IDX(h, ifidx);
 397 }
 398
 399 int dhd_prot_hdrpull(dhd_pub_t *dhd, int *ifidx, struct sk_buff *pktbuf)
 400 {
 401 #ifdef BDC
 402         struct bdc_header *h;
 403 #endif
 404
 405         DHD_TRACE(("%s: Enter\n", __func__));
 406
 407 #ifdef BDC
 408         /* Pop BDC header used to convey priority for buses that don't */
 409
 410         if (pktbuf->len < BDC_HEADER_LEN) {
 411                 DHD_ERROR(("%s: rx data too short (%d < %d)\n", __func__,
 412                            pktbuf->len, BDC_HEADER_LEN));
 413                 return -EBADE;
 414         }
 415
 416         h = (struct bdc_header *)(pktbuf->data);
 417
 418         *ifidx = BDC_GET_IF_IDX(h);
 419         if (*ifidx >= DHD_MAX_IFS) {
 420                 DHD_ERROR(("%s: rx data ifnum out of range (%d)\n",
 421                            __func__, *ifidx));
 422                 return -EBADE;
 423         }
 424
 425         if (((h->flags & BDC_FLAG_VER_MASK) >> BDC_FLAG_VER_SHIFT) !=
 426             BDC_PROTO_VER) {
 427                 DHD_ERROR(("%s: non-BDC packet received, flags 0x%x\n",
 428                            dhd_ifname(dhd, *ifidx), h->flags));
 429                 return -EBADE;
 430         }
 431
 432         if (h->flags & BDC_FLAG_SUM_GOOD) {
 433                 DHD_INFO(("%s: BDC packet received with good rx-csum, "
 434                         "flags 0x%x\n",
 435                         dhd_ifname(dhd, *ifidx), h->flags));
 436                 PKTSETSUMGOOD(pktbuf, true);
 437         }
 438
 439         pktbuf->priority = h->priority & BDC_PRIORITY_MASK;
 440
 441         skb_pull(pktbuf, BDC_HEADER_LEN);
 442 #endif                          /* BDC */
 443
 444         return 0;
 445 }
 446
 447 int dhd_prot_attach(dhd_pub_t *dhd)
 448 {
 449         dhd_prot_t *cdc;
 450
 451         cdc = kzalloc(sizeof(dhd_prot_t), GFP_ATOMIC);
 452         if (!cdc) {
 453                 DHD_ERROR(("%s: kmalloc failed\n", __func__));
 454                 goto fail;
 455         }
 456
 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"));
 460                 goto fail;
 461         }
 462
 463         dhd->prot = cdc;
 464 #ifdef BDC
 465         dhd->hdrlen += BDC_HEADER_LEN;
 466 #endif
 467         dhd->maxctl =
 468                 WLC_IOCTL_MAXLEN + sizeof(struct cdc_ioctl) + ROUND_UP_MARGIN;
 469         return 0;
 470
 471 fail:
 472         kfree(cdc);
 473         return -ENOMEM;
 474 }
 475
 476 /* ~NOTE~ What if another thread is waiting on the semaphore?  Holding it? */
 477 void dhd_prot_detach(dhd_pub_t *dhd)
 478 {
 479         kfree(dhd->prot);
 480         dhd->prot = NULL;
 481 }
 482
 483 void dhd_prot_dstats(dhd_pub_t *dhd)
 484 {
 485         /* No stats from dongle added yet, copy bus stats */
 486         dhd->dstats.tx_packets = dhd->tx_packets;
 487         dhd->dstats.tx_errors = dhd->tx_errors;
 488         dhd->dstats.rx_packets = dhd->rx_packets;
 489         dhd->dstats.rx_errors = dhd->rx_errors;
 490         dhd->dstats.rx_dropped = dhd->rx_dropped;
 491         dhd->dstats.multicast = dhd->rx_multicast;
 492         return;
 493 }
 494
 495 int dhd_prot_init(dhd_pub_t *dhd)
 496 {
 497         int ret = 0;
 498         char buf[128];
 499
 500         DHD_TRACE(("%s: Enter\n", __func__));
 501
 502         dhd_os_proto_block(dhd);
 503
 504         /* Get the device MAC address */
 505         strcpy(buf, "cur_etheraddr");
 506         ret = dhdcdc_query_ioctl(dhd, 0, WLC_GET_VAR, buf, sizeof(buf));
 507         if (ret < 0) {
 508                 dhd_os_proto_unblock(dhd);
 509                 return ret;
 510         }
 511         memcpy(dhd->mac, buf, ETH_ALEN);
 512
 513         dhd_os_proto_unblock(dhd);
 514
 515 #ifdef EMBEDDED_PLATFORM
 516         ret = dhd_preinit_ioctls(dhd);
 517 #endif                          /* EMBEDDED_PLATFORM */
 518
 519         /* Always assumes wl for now */
 520         dhd->iswl = true;
 521
 522         return ret;
 523 }
 524
 525 void dhd_prot_stop(dhd_pub_t *dhd)
 526 {
 527         /* Nothing to do for CDC */
 528 }