drivers/net/wireless/broadcom/brcm80211/brcmfmac/bcdc.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 /*******************************************************************************
  18  * Communicates with the dongle by using dcmd codes.
  19  * For certain dcmd codes, the dongle interprets string data from the host.
  20  ******************************************************************************/
  21
  22 #include <linux/types.h>
  23 #include <linux/netdevice.h>
  24
  25 #include <brcmu_utils.h>
  26 #include <brcmu_wifi.h>
  27
  28 #include "core.h"
  29 #include "bus.h"
  30 #include "fwsignal.h"
  31 #include "debug.h"
  32 #include "tracepoint.h"
  33 #include "proto.h"
  34 #include "bcdc.h"
  35
  36 struct brcmf_proto_bcdc_dcmd {
  37         __le32 cmd;     /* dongle command value */
  38         __le32 len;     /* lower 16: output buflen;
  39                          * upper 16: input buflen (excludes header) */
  40         __le32 flags;   /* flag defns given below */
  41         __le32 status;  /* status code returned from the device */
  42 };
  43
  44 /* BCDC flag definitions */
  45 #define BCDC_DCMD_ERROR         0x01            /* 1=cmd failed */
  46 #define BCDC_DCMD_SET           0x02            /* 0=get, 1=set cmd */
  47 #define BCDC_DCMD_IF_MASK       0xF000          /* I/F index */
  48 #define BCDC_DCMD_IF_SHIFT      12
  49 #define BCDC_DCMD_ID_MASK       0xFFFF0000      /* id an cmd pairing */
  50 #define BCDC_DCMD_ID_SHIFT      16              /* ID Mask shift bits */
  51 #define BCDC_DCMD_ID(flags)     \
  52         (((flags) & BCDC_DCMD_ID_MASK) >> BCDC_DCMD_ID_SHIFT)
  53
  54 /*
  55  * BCDC header - Broadcom specific extension of CDC.
  56  * Used on data packets to convey priority across USB.
  57  */
  58 #define BCDC_HEADER_LEN         4
  59 #define BCDC_PROTO_VER          2       /* Protocol version */
  60 #define BCDC_FLAG_VER_MASK      0xf0    /* Protocol version mask */
  61 #define BCDC_FLAG_VER_SHIFT     4       /* Protocol version shift */
  62 #define BCDC_FLAG_SUM_GOOD      0x04    /* Good RX checksums */
  63 #define BCDC_FLAG_SUM_NEEDED    0x08    /* Dongle needs to do TX checksums */
  64 #define BCDC_PRIORITY_MASK      0x7
  65 #define BCDC_FLAG2_IF_MASK      0x0f    /* packet rx interface in APSTA */
  66 #define BCDC_FLAG2_IF_SHIFT     0
  67
  68 #define BCDC_GET_IF_IDX(hdr) \
  69         ((int)((((hdr)->flags2) & BCDC_FLAG2_IF_MASK) >> BCDC_FLAG2_IF_SHIFT))
  70 #define BCDC_SET_IF_IDX(hdr, idx) \
  71         ((hdr)->flags2 = (((hdr)->flags2 & ~BCDC_FLAG2_IF_MASK) | \
  72         ((idx) << BCDC_FLAG2_IF_SHIFT)))
  73
  74 /**
  75  * struct brcmf_proto_bcdc_header - BCDC header format
  76  *
  77  * @flags: flags contain protocol and checksum info.
  78  * @priority: 802.1d priority and USB flow control info (bit 4:7).
  79  * @flags2: additional flags containing dongle interface index.
  80  * @data_offset: start of packet data. header is following by firmware signals.
  81  */
  82 struct brcmf_proto_bcdc_header {
  83         u8 flags;
  84         u8 priority;
  85         u8 flags2;
  86         u8 data_offset;
  87 };
  88
  89 /*
  90  * maximum length of firmware signal data between
  91  * the BCDC header and packet data in the tx path.
  92  */
  93 #define BRCMF_PROT_FW_SIGNAL_MAX_TXBYTES        12
  94
  95 #define RETRIES 2 /* # of retries to retrieve matching dcmd response */
  96 #define BUS_HEADER_LEN  (16+64)         /* Must be atleast SDPCM_RESERVE
  97                                          * (amount of header tha might be added)
  98                                          * plus any space that might be needed
  99                                          * for bus alignment padding.
 100                                          */
 101 struct brcmf_bcdc {
 102         u16 reqid;
 103         u8 bus_header[BUS_HEADER_LEN];
 104         struct brcmf_proto_bcdc_dcmd msg;
 105         unsigned char buf[BRCMF_DCMD_MAXLEN];
 106         struct brcmf_fws_info *fws;
 107 };
 108
 109
 110 struct brcmf_fws_info *drvr_to_fws(struct brcmf_pub *drvr)
 111 {
 112         struct brcmf_bcdc *bcdc = drvr->proto->pd;
 113
 114         return bcdc->fws;
 115 }
 116
 117 static int
 118 brcmf_proto_bcdc_msg(struct brcmf_pub *drvr, int ifidx, uint cmd, void *buf,
 119                      uint len, bool set)
 120 {
 121         struct brcmf_bcdc *bcdc = (struct brcmf_bcdc *)drvr->proto->pd;
 122         struct brcmf_proto_bcdc_dcmd *msg = &bcdc->msg;
 123         u32 flags;
 124
 125         brcmf_dbg(BCDC, "Enter\n");
 126
 127         memset(msg, 0, sizeof(struct brcmf_proto_bcdc_dcmd));
 128
 129         msg->cmd = cpu_to_le32(cmd);
 130         msg->len = cpu_to_le32(len);
 131         flags = (++bcdc->reqid << BCDC_DCMD_ID_SHIFT);
 132         if (set)
 133                 flags |= BCDC_DCMD_SET;
 134         flags = (flags & ~BCDC_DCMD_IF_MASK) |
 135                 (ifidx << BCDC_DCMD_IF_SHIFT);
 136         msg->flags = cpu_to_le32(flags);
 137
 138         if (buf)
 139                 memcpy(bcdc->buf, buf, len);
 140
 141         len += sizeof(*msg);
 142         if (len > BRCMF_TX_IOCTL_MAX_MSG_SIZE)
 143                 len = BRCMF_TX_IOCTL_MAX_MSG_SIZE;
 144
 145         /* Send request */
 146         return brcmf_bus_txctl(drvr->bus_if, (unsigned char *)&bcdc->msg, len);
 147 }
 148
 149 static int brcmf_proto_bcdc_cmplt(struct brcmf_pub *drvr, u32 id, u32 len)
 150 {
 151         int ret;
 152         struct brcmf_bcdc *bcdc = (struct brcmf_bcdc *)drvr->proto->pd;
 153
 154         brcmf_dbg(BCDC, "Enter\n");
 155         len += sizeof(struct brcmf_proto_bcdc_dcmd);
 156         do {
 157                 ret = brcmf_bus_rxctl(drvr->bus_if, (unsigned char *)&bcdc->msg,
 158                                       len);
 159                 if (ret < 0)
 160                         break;
 161         } while (BCDC_DCMD_ID(le32_to_cpu(bcdc->msg.flags)) != id);
 162
 163         return ret;
 164 }
 165
 166 static int
 167 brcmf_proto_bcdc_query_dcmd(struct brcmf_pub *drvr, int ifidx, uint cmd,
 168                             void *buf, uint len)
 169 {
 170         struct brcmf_bcdc *bcdc = (struct brcmf_bcdc *)drvr->proto->pd;
 171         struct brcmf_proto_bcdc_dcmd *msg = &bcdc->msg;
 172         void *info;
 173         int ret = 0, retries = 0;
 174         u32 id, flags;
 175
 176         brcmf_dbg(BCDC, "Enter, cmd %d len %d\n", cmd, len);
 177
 178         ret = brcmf_proto_bcdc_msg(drvr, ifidx, cmd, buf, len, false);
 179         if (ret < 0) {
 180                 brcmf_err("brcmf_proto_bcdc_msg failed w/status %d\n",
 181                           ret);
 182                 goto done;
 183         }
 184
 185 retry:
 186         /* wait for interrupt and get first fragment */
 187         ret = brcmf_proto_bcdc_cmplt(drvr, bcdc->reqid, len);
 188         if (ret < 0)
 189                 goto done;
 190
 191         flags = le32_to_cpu(msg->flags);
 192         id = (flags & BCDC_DCMD_ID_MASK) >> BCDC_DCMD_ID_SHIFT;
 193
 194         if ((id < bcdc->reqid) && (++retries < RETRIES))
 195                 goto retry;
 196         if (id != bcdc->reqid) {
 197                 brcmf_err("%s: unexpected request id %d (expected %d)\n",
 198                           brcmf_ifname(brcmf_get_ifp(drvr, ifidx)), id,
 199                           bcdc->reqid);
 200                 ret = -EINVAL;
 201                 goto done;
 202         }
 203
 204         /* Check info buffer */
 205         info = (void *)&bcdc->buf[0];
 206
 207         /* Copy info buffer */
 208         if (buf) {
 209                 if (ret < (int)len)
 210                         len = ret;
 211                 memcpy(buf, info, len);
 212         }
 213
 214         /* Check the ERROR flag */
 215         if (flags & BCDC_DCMD_ERROR)
 216                 ret = le32_to_cpu(msg->status);
 217
 218 done:
 219         return ret;
 220 }
 221
 222 static int
 223 brcmf_proto_bcdc_set_dcmd(struct brcmf_pub *drvr, int ifidx, uint cmd,
 224                           void *buf, uint len)
 225 {
 226         struct brcmf_bcdc *bcdc = (struct brcmf_bcdc *)drvr->proto->pd;
 227         struct brcmf_proto_bcdc_dcmd *msg = &bcdc->msg;
 228         int ret = 0;
 229         u32 flags, id;
 230
 231         brcmf_dbg(BCDC, "Enter, cmd %d len %d\n", cmd, len);
 232
 233         ret = brcmf_proto_bcdc_msg(drvr, ifidx, cmd, buf, len, true);
 234         if (ret < 0)
 235                 goto done;
 236
 237         ret = brcmf_proto_bcdc_cmplt(drvr, bcdc->reqid, len);
 238         if (ret < 0)
 239                 goto done;
 240
 241         flags = le32_to_cpu(msg->flags);
 242         id = (flags & BCDC_DCMD_ID_MASK) >> BCDC_DCMD_ID_SHIFT;
 243
 244         if (id != bcdc->reqid) {
 245                 brcmf_err("%s: unexpected request id %d (expected %d)\n",
 246                           brcmf_ifname(brcmf_get_ifp(drvr, ifidx)), id,
 247                           bcdc->reqid);
 248                 ret = -EINVAL;
 249                 goto done;
 250         }
 251
 252         /* Check the ERROR flag */
 253         if (flags & BCDC_DCMD_ERROR)
 254                 ret = le32_to_cpu(msg->status);
 255
 256 done:
 257         return ret;
 258 }
 259
 260 static void
 261 brcmf_proto_bcdc_hdrpush(struct brcmf_pub *drvr, int ifidx, u8 offset,
 262                          struct sk_buff *pktbuf)
 263 {
 264         struct brcmf_proto_bcdc_header *h;
 265
 266         brcmf_dbg(BCDC, "Enter\n");
 267
 268         /* Push BDC header used to convey priority for buses that don't */
 269         skb_push(pktbuf, BCDC_HEADER_LEN);
 270
 271         h = (struct brcmf_proto_bcdc_header *)(pktbuf->data);
 272
 273         h->flags = (BCDC_PROTO_VER << BCDC_FLAG_VER_SHIFT);
 274         if (pktbuf->ip_summed == CHECKSUM_PARTIAL)
 275                 h->flags |= BCDC_FLAG_SUM_NEEDED;
 276
 277         h->priority = (pktbuf->priority & BCDC_PRIORITY_MASK);
 278         h->flags2 = 0;
 279         h->data_offset = offset;
 280         BCDC_SET_IF_IDX(h, ifidx);
 281         trace_brcmf_bcdchdr(pktbuf->data);
 282 }
 283
 284 static int
 285 brcmf_proto_bcdc_hdrpull(struct brcmf_pub *drvr, bool do_fws,
 286                          struct sk_buff *pktbuf, struct brcmf_if **ifp)
 287 {
 288         struct brcmf_proto_bcdc_header *h;
 289         struct brcmf_if *tmp_if;
 290
 291         brcmf_dbg(BCDC, "Enter\n");
 292
 293         /* Pop BCDC header used to convey priority for buses that don't */
 294         if (pktbuf->len <= BCDC_HEADER_LEN) {
 295                 brcmf_dbg(INFO, "rx data too short (%d <= %d)\n",
 296                           pktbuf->len, BCDC_HEADER_LEN);
 297                 return -EBADE;
 298         }
 299
 300         trace_brcmf_bcdchdr(pktbuf->data);
 301         h = (struct brcmf_proto_bcdc_header *)(pktbuf->data);
 302
 303         tmp_if = brcmf_get_ifp(drvr, BCDC_GET_IF_IDX(h));
 304         if (!tmp_if) {
 305                 brcmf_dbg(INFO, "no matching ifp found\n");
 306                 return -EBADE;
 307         }
 308         if (((h->flags & BCDC_FLAG_VER_MASK) >> BCDC_FLAG_VER_SHIFT) !=
 309             BCDC_PROTO_VER) {
 310                 brcmf_err("%s: non-BCDC packet received, flags 0x%x\n",
 311                           brcmf_ifname(tmp_if), h->flags);
 312                 return -EBADE;
 313         }
 314
 315         if (h->flags & BCDC_FLAG_SUM_GOOD) {
 316                 brcmf_dbg(BCDC, "%s: BDC rcv, good checksum, flags 0x%x\n",
 317                           brcmf_ifname(tmp_if), h->flags);
 318                 pktbuf->ip_summed = CHECKSUM_UNNECESSARY;
 319         }
 320
 321         pktbuf->priority = h->priority & BCDC_PRIORITY_MASK;
 322
 323         skb_pull(pktbuf, BCDC_HEADER_LEN);
 324         if (do_fws)
 325                 brcmf_fws_hdrpull(tmp_if, h->data_offset << 2, pktbuf);
 326         else
 327                 skb_pull(pktbuf, h->data_offset << 2);
 328
 329         if (pktbuf->len == 0)
 330                 return -ENODATA;
 331
 332         if (ifp != NULL)
 333                 *ifp = tmp_if;
 334         return 0;
 335 }
 336
 337 static int brcmf_proto_bcdc_tx_queue_data(struct brcmf_pub *drvr, int ifidx,
 338                                           struct sk_buff *skb)
 339 {
 340         struct brcmf_if *ifp = brcmf_get_ifp(drvr, ifidx);
 341         struct brcmf_bcdc *bcdc = drvr->proto->pd;
 342
 343         if (!brcmf_fws_queue_skbs(bcdc->fws))
 344                 return brcmf_proto_txdata(drvr, ifidx, 0, skb);
 345
 346         return brcmf_fws_process_skb(ifp, skb);
 347 }
 348
 349 static int
 350 brcmf_proto_bcdc_txdata(struct brcmf_pub *drvr, int ifidx, u8 offset,
 351                         struct sk_buff *pktbuf)
 352 {
 353         brcmf_proto_bcdc_hdrpush(drvr, ifidx, offset, pktbuf);
 354         return brcmf_bus_txdata(drvr->bus_if, pktbuf);
 355 }
 356
 357 void brcmf_proto_bcdc_txflowblock(struct device *dev, bool state)
 358 {
 359         struct brcmf_bus *bus_if = dev_get_drvdata(dev);
 360         struct brcmf_pub *drvr = bus_if->drvr;
 361
 362         brcmf_dbg(TRACE, "Enter\n");
 363
 364         brcmf_fws_bus_blocked(drvr, state);
 365 }
 366
 367 void
 368 brcmf_proto_bcdc_txcomplete(struct device *dev, struct sk_buff *txp,
 369                             bool success)
 370 {
 371         struct brcmf_bus *bus_if = dev_get_drvdata(dev);
 372         struct brcmf_bcdc *bcdc = bus_if->drvr->proto->pd;
 373         struct brcmf_if *ifp;
 374
 375         /* await txstatus signal for firmware if active */
 376         if (brcmf_fws_fc_active(bcdc->fws)) {
 377                 if (!success)
 378                         brcmf_fws_bustxfail(bcdc->fws, txp);
 379         } else {
 380                 if (brcmf_proto_bcdc_hdrpull(bus_if->drvr, false, txp, &ifp))
 381                         brcmu_pkt_buf_free_skb(txp);
 382                 else
 383                         brcmf_txfinalize(ifp, txp, success);
 384         }
 385 }
 386
 387 static void
 388 brcmf_proto_bcdc_configure_addr_mode(struct brcmf_pub *drvr, int ifidx,
 389                                      enum proto_addr_mode addr_mode)
 390 {
 391 }
 392
 393 static void
 394 brcmf_proto_bcdc_delete_peer(struct brcmf_pub *drvr, int ifidx,
 395                              u8 peer[ETH_ALEN])
 396 {
 397 }
 398
 399 static void
 400 brcmf_proto_bcdc_add_tdls_peer(struct brcmf_pub *drvr, int ifidx,
 401                                u8 peer[ETH_ALEN])
 402 {
 403 }
 404
 405 static void brcmf_proto_bcdc_rxreorder(struct brcmf_if *ifp,
 406                                        struct sk_buff *skb)
 407 {
 408         brcmf_fws_rxreorder(ifp, skb);
 409 }
 410
 411 static void
 412 brcmf_proto_bcdc_add_if(struct brcmf_if *ifp)
 413 {
 414         brcmf_fws_add_interface(ifp);
 415 }
 416
 417 static void
 418 brcmf_proto_bcdc_del_if(struct brcmf_if *ifp)
 419 {
 420         brcmf_fws_del_interface(ifp);
 421 }
 422
 423 static void
 424 brcmf_proto_bcdc_reset_if(struct brcmf_if *ifp)
 425 {
 426         brcmf_fws_reset_interface(ifp);
 427 }
 428
 429 static int
 430 brcmf_proto_bcdc_init_done(struct brcmf_pub *drvr)
 431 {
 432         struct brcmf_bcdc *bcdc = drvr->proto->pd;
 433         struct brcmf_fws_info *fws;
 434
 435         fws = brcmf_fws_attach(drvr);
 436         if (IS_ERR(fws))
 437                 return PTR_ERR(fws);
 438
 439         bcdc->fws = fws;
 440         return 0;
 441 }
 442
 443 int brcmf_proto_bcdc_attach(struct brcmf_pub *drvr)
 444 {
 445         struct brcmf_bcdc *bcdc;
 446
 447         bcdc = kzalloc(sizeof(*bcdc), GFP_ATOMIC);
 448         if (!bcdc)
 449                 goto fail;
 450
 451         /* ensure that the msg buf directly follows the cdc msg struct */
 452         if ((unsigned long)(&bcdc->msg + 1) != (unsigned long)bcdc->buf) {
 453                 brcmf_err("struct brcmf_proto_bcdc is not correctly defined\n");
 454                 goto fail;
 455         }
 456
 457         drvr->proto->hdrpull = brcmf_proto_bcdc_hdrpull;
 458         drvr->proto->query_dcmd = brcmf_proto_bcdc_query_dcmd;
 459         drvr->proto->set_dcmd = brcmf_proto_bcdc_set_dcmd;
 460         drvr->proto->tx_queue_data = brcmf_proto_bcdc_tx_queue_data;
 461         drvr->proto->txdata = brcmf_proto_bcdc_txdata;
 462         drvr->proto->configure_addr_mode = brcmf_proto_bcdc_configure_addr_mode;
 463         drvr->proto->delete_peer = brcmf_proto_bcdc_delete_peer;
 464         drvr->proto->add_tdls_peer = brcmf_proto_bcdc_add_tdls_peer;
 465         drvr->proto->rxreorder = brcmf_proto_bcdc_rxreorder;
 466         drvr->proto->add_if = brcmf_proto_bcdc_add_if;
 467         drvr->proto->del_if = brcmf_proto_bcdc_del_if;
 468         drvr->proto->reset_if = brcmf_proto_bcdc_reset_if;
 469         drvr->proto->init_done = brcmf_proto_bcdc_init_done;
 470         drvr->proto->pd = bcdc;
 471
 472         drvr->hdrlen += BCDC_HEADER_LEN + BRCMF_PROT_FW_SIGNAL_MAX_TXBYTES;
 473         drvr->bus_if->maxctl = BRCMF_DCMD_MAXLEN +
 474                         sizeof(struct brcmf_proto_bcdc_dcmd);
 475         return 0;
 476
 477 fail:
 478         kfree(bcdc);
 479         return -ENOMEM;
 480 }
 481
 482 void brcmf_proto_bcdc_detach(struct brcmf_pub *drvr)
 483 {
 484         struct brcmf_bcdc *bcdc = drvr->proto->pd;
 485
 486         drvr->proto->pd = NULL;
 487         brcmf_fws_detach(bcdc->fws);
 488         kfree(bcdc);
 489 }