drivers/net/wireless/brcm80211/brcmfmac/fweh.c

   1 /*
   2  * Copyright (c) 2012 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 #include <linux/netdevice.h>
  17
  18 #include "brcmu_wifi.h"
  19 #include "brcmu_utils.h"
  20
  21 #include "dhd.h"
  22 #include "dhd_dbg.h"
  23 #include "fweh.h"
  24 #include "fwil.h"
  25
  26 /**
  27  * struct brcm_ethhdr - broadcom specific ether header.
  28  *
  29  * @subtype: subtype for this packet.
  30  * @length: TODO: length of appended data.
  31  * @version: version indication.
  32  * @oui: OUI of this packet.
  33  * @usr_subtype: subtype for this OUI.
  34  */
  35 struct brcm_ethhdr {
  36         __be16 subtype;
  37         __be16 length;
  38         u8 version;
  39         u8 oui[3];
  40         __be16 usr_subtype;
  41 } __packed;
  42
  43 struct brcmf_event_msg_be {
  44         __be16 version;
  45         __be16 flags;
  46         __be32 event_type;
  47         __be32 status;
  48         __be32 reason;
  49         __be32 auth_type;
  50         __be32 datalen;
  51         u8 addr[ETH_ALEN];
  52         char ifname[IFNAMSIZ];
  53         u8 ifidx;
  54         u8 bsscfgidx;
  55 } __packed;
  56
  57 /**
  58  * struct brcmf_event - contents of broadcom event packet.
  59  *
  60  * @eth: standard ether header.
  61  * @hdr: broadcom specific ether header.
  62  * @msg: common part of the actual event message.
  63  */
  64 struct brcmf_event {
  65         struct ethhdr eth;
  66         struct brcm_ethhdr hdr;
  67         struct brcmf_event_msg_be msg;
  68 } __packed;
  69
  70 /**
  71  * struct brcmf_fweh_queue_item - event item on event queue.
  72  *
  73  * @q: list element for queuing.
  74  * @code: event code.
  75  * @ifidx: interface index related to this event.
  76  * @ifaddr: ethernet address for interface.
  77  * @emsg: common parameters of the firmware event message.
  78  * @data: event specific data part of the firmware event.
  79  */
  80 struct brcmf_fweh_queue_item {
  81         struct list_head q;
  82         enum brcmf_fweh_event_code code;
  83         u8 ifidx;
  84         u8 ifaddr[ETH_ALEN];
  85         struct brcmf_event_msg_be emsg;
  86         u8 data[0];
  87 };
  88
  89 /**
  90  * struct brcmf_fweh_event_name - code, name mapping entry.
  91  */
  92 struct brcmf_fweh_event_name {
  93         enum brcmf_fweh_event_code code;
  94         const char *name;
  95 };
  96
  97 #ifdef DEBUG
  98 #define BRCMF_ENUM_DEF(id, val) \
  99         { val, #id },
 100
 101 /* array for mapping code to event name */
 102 static struct brcmf_fweh_event_name fweh_event_names[] = {
 103         BRCMF_FWEH_EVENT_ENUM_DEFLIST
 104 };
 105 #undef BRCMF_ENUM_DEF
 106
 107 /**
 108  * brcmf_fweh_event_name() - returns name for given event code.
 109  *
 110  * @code: code to lookup.
 111  */
 112 static const char *brcmf_fweh_event_name(enum brcmf_fweh_event_code code)
 113 {
 114         int i;
 115         for (i = 0; i < ARRAY_SIZE(fweh_event_names); i++) {
 116                 if (fweh_event_names[i].code == code)
 117                         return fweh_event_names[i].name;
 118         }
 119         return "unknown";
 120 }
 121 #else
 122 static const char *brcmf_fweh_event_name(enum brcmf_fweh_event_code code)
 123 {
 124         return "nodebug";
 125 }
 126 #endif
 127
 128 /**
 129  * brcmf_fweh_queue_event() - create and queue event.
 130  *
 131  * @fweh: firmware event handling info.
 132  * @event: event queue entry.
 133  */
 134 static void brcmf_fweh_queue_event(struct brcmf_fweh_info *fweh,
 135                                    struct brcmf_fweh_queue_item *event)
 136 {
 137         ulong flags;
 138
 139         spin_lock_irqsave(&fweh->evt_q_lock, flags);
 140         list_add_tail(&event->q, &fweh->event_q);
 141         spin_unlock_irqrestore(&fweh->evt_q_lock, flags);
 142         schedule_work(&fweh->event_work);
 143 }
 144
 145 static int brcmf_fweh_call_event_handler(struct brcmf_if *ifp,
 146                                          enum brcmf_fweh_event_code code,
 147                                          struct brcmf_event_msg *emsg,
 148                                          void *data)
 149 {
 150         struct brcmf_fweh_info *fweh;
 151         int err = -EINVAL;
 152
 153         if (ifp) {
 154                 fweh = &ifp->drvr->fweh;
 155
 156                 /* handle the event if valid interface and handler */
 157                 if (ifp->ndev && fweh->evt_handler[code])
 158                         err = fweh->evt_handler[code](ifp, emsg, data);
 159                 else
 160                         brcmf_err("unhandled event %d ignored\n", code);
 161         } else {
 162                 brcmf_err("no interface object\n");
 163         }
 164         return err;
 165 }
 166
 167 /**
 168  * brcmf_fweh_handle_if_event() - handle IF event.
 169  *
 170  * @drvr: driver information object.
 171  * @item: queue entry.
 172  * @ifpp: interface object (may change upon ADD action).
 173  */
 174 static void brcmf_fweh_handle_if_event(struct brcmf_pub *drvr,
 175                                        struct brcmf_event_msg *emsg,
 176                                        void *data)
 177 {
 178         struct brcmf_if_event *ifevent = data;
 179         struct brcmf_if *ifp;
 180         int err = 0;
 181
 182         brcmf_dbg(EVENT, "action: %u idx: %u bsscfg: %u flags: %u\n",
 183                   ifevent->action, ifevent->ifidx,
 184                   ifevent->bssidx, ifevent->flags);
 185
 186         if (ifevent->ifidx >= BRCMF_MAX_IFS) {
 187                 brcmf_err("invalid interface index: %u\n",
 188                           ifevent->ifidx);
 189                 return;
 190         }
 191
 192         ifp = drvr->iflist[ifevent->ifidx];
 193
 194         if (ifevent->action == BRCMF_E_IF_ADD) {
 195                 brcmf_dbg(EVENT, "adding %s (%pM)\n", emsg->ifname,
 196                           emsg->addr);
 197                 ifp = brcmf_add_if(drvr, ifevent->ifidx, ifevent->bssidx,
 198                                    emsg->ifname, emsg->addr);
 199                 if (IS_ERR(ifp))
 200                         return;
 201
 202                 if (!drvr->fweh.evt_handler[BRCMF_E_IF])
 203                         err = brcmf_net_attach(ifp);
 204         }
 205
 206         err = brcmf_fweh_call_event_handler(ifp, emsg->event_code, emsg, data);
 207
 208         if (ifevent->action == BRCMF_E_IF_DEL)
 209                 brcmf_del_if(drvr, ifevent->ifidx);
 210 }
 211
 212 /**
 213  * brcmf_fweh_dequeue_event() - get event from the queue.
 214  *
 215  * @fweh: firmware event handling info.
 216  */
 217 static struct brcmf_fweh_queue_item *
 218 brcmf_fweh_dequeue_event(struct brcmf_fweh_info *fweh)
 219 {
 220         struct brcmf_fweh_queue_item *event = NULL;
 221         ulong flags;
 222
 223         spin_lock_irqsave(&fweh->evt_q_lock, flags);
 224         if (!list_empty(&fweh->event_q)) {
 225                 event = list_first_entry(&fweh->event_q,
 226                                          struct brcmf_fweh_queue_item, q);
 227                 list_del(&event->q);
 228         }
 229         spin_unlock_irqrestore(&fweh->evt_q_lock, flags);
 230
 231         return event;
 232 }
 233
 234 /**
 235  * brcmf_fweh_event_worker() - firmware event worker.
 236  *
 237  * @work: worker object.
 238  */
 239 static void brcmf_fweh_event_worker(struct work_struct *work)
 240 {
 241         struct brcmf_pub *drvr;
 242         struct brcmf_if *ifp;
 243         struct brcmf_fweh_info *fweh;
 244         struct brcmf_fweh_queue_item *event;
 245         int err = 0;
 246         struct brcmf_event_msg_be *emsg_be;
 247         struct brcmf_event_msg emsg;
 248
 249         fweh = container_of(work, struct brcmf_fweh_info, event_work);
 250         drvr = container_of(fweh, struct brcmf_pub, fweh);
 251
 252         while ((event = brcmf_fweh_dequeue_event(fweh))) {
 253                 ifp = drvr->iflist[event->ifidx];
 254
 255                 brcmf_dbg(EVENT, "event %s (%u) ifidx %u bsscfg %u addr %pM\n",
 256                           brcmf_fweh_event_name(event->code), event->code,
 257                           event->emsg.ifidx, event->emsg.bsscfgidx,
 258                           event->emsg.addr);
 259
 260                 /* convert event message */
 261                 emsg_be = &event->emsg;
 262                 emsg.version = be16_to_cpu(emsg_be->version);
 263                 emsg.flags = be16_to_cpu(emsg_be->flags);
 264                 emsg.event_code = event->code;
 265                 emsg.status = be32_to_cpu(emsg_be->status);
 266                 emsg.reason = be32_to_cpu(emsg_be->reason);
 267                 emsg.auth_type = be32_to_cpu(emsg_be->auth_type);
 268                 emsg.datalen = be32_to_cpu(emsg_be->datalen);
 269                 memcpy(emsg.addr, emsg_be->addr, ETH_ALEN);
 270                 memcpy(emsg.ifname, emsg_be->ifname, sizeof(emsg.ifname));
 271                 emsg.ifidx = emsg_be->ifidx;
 272                 emsg.bsscfgidx = emsg_be->bsscfgidx;
 273
 274                 brcmf_dbg(EVENT, "  version %u flags %u status %u reason %u\n",
 275                           emsg.version, emsg.flags, emsg.status, emsg.reason);
 276                 brcmf_dbg_hex_dump(BRCMF_EVENT_ON(), event->data,
 277                                    min_t(u32, emsg.datalen, 64),
 278                                    "event payload, len=%d\n", emsg.datalen);
 279
 280                 /* special handling of interface event */
 281                 if (event->code == BRCMF_E_IF) {
 282                         brcmf_fweh_handle_if_event(drvr, &emsg, event->data);
 283                         goto event_free;
 284                 }
 285
 286                 err = brcmf_fweh_call_event_handler(ifp, event->code, &emsg,
 287                                                     event->data);
 288                 if (err) {
 289                         brcmf_err("event handler failed (%d)\n",
 290                                   event->code);
 291                         err = 0;
 292                 }
 293 event_free:
 294                 kfree(event);
 295         }
 296 }
 297
 298 /**
 299  * brcmf_fweh_attach() - initialize firmware event handling.
 300  *
 301  * @drvr: driver information object.
 302  */
 303 void brcmf_fweh_attach(struct brcmf_pub *drvr)
 304 {
 305         struct brcmf_fweh_info *fweh = &drvr->fweh;
 306         INIT_WORK(&fweh->event_work, brcmf_fweh_event_worker);
 307         spin_lock_init(&fweh->evt_q_lock);
 308         INIT_LIST_HEAD(&fweh->event_q);
 309 }
 310
 311 /**
 312  * brcmf_fweh_detach() - cleanup firmware event handling.
 313  *
 314  * @drvr: driver information object.
 315  */
 316 void brcmf_fweh_detach(struct brcmf_pub *drvr)
 317 {
 318         struct brcmf_fweh_info *fweh = &drvr->fweh;
 319         struct brcmf_if *ifp = drvr->iflist[0];
 320         s8 eventmask[BRCMF_EVENTING_MASK_LEN];
 321
 322         if (ifp) {
 323                 /* clear all events */
 324                 memset(eventmask, 0, BRCMF_EVENTING_MASK_LEN);
 325                 (void)brcmf_fil_iovar_data_set(ifp, "event_msgs",
 326                                                eventmask,
 327                                                BRCMF_EVENTING_MASK_LEN);
 328         }
 329         /* cancel the worker */
 330         cancel_work_sync(&fweh->event_work);
 331         WARN_ON(!list_empty(&fweh->event_q));
 332         memset(fweh->evt_handler, 0, sizeof(fweh->evt_handler));
 333 }
 334
 335 /**
 336  * brcmf_fweh_register() - register handler for given event code.
 337  *
 338  * @drvr: driver information object.
 339  * @code: event code.
 340  * @handler: handler for the given event code.
 341  */
 342 int brcmf_fweh_register(struct brcmf_pub *drvr, enum brcmf_fweh_event_code code,
 343                         brcmf_fweh_handler_t handler)
 344 {
 345         if (drvr->fweh.evt_handler[code]) {
 346                 brcmf_err("event code %d already registered\n", code);
 347                 return -ENOSPC;
 348         }
 349         drvr->fweh.evt_handler[code] = handler;
 350         brcmf_dbg(TRACE, "event handler registered for %s\n",
 351                   brcmf_fweh_event_name(code));
 352         return 0;
 353 }
 354
 355 /**
 356  * brcmf_fweh_unregister() - remove handler for given code.
 357  *
 358  * @drvr: driver information object.
 359  * @code: event code.
 360  */
 361 void brcmf_fweh_unregister(struct brcmf_pub *drvr,
 362                            enum brcmf_fweh_event_code code)
 363 {
 364         brcmf_dbg(TRACE, "event handler cleared for %s\n",
 365                   brcmf_fweh_event_name(code));
 366         drvr->fweh.evt_handler[code] = NULL;
 367 }
 368
 369 /**
 370  * brcmf_fweh_activate_events() - enables firmware events registered.
 371  *
 372  * @ifp: primary interface object.
 373  */
 374 int brcmf_fweh_activate_events(struct brcmf_if *ifp)
 375 {
 376         int i, err;
 377         s8 eventmask[BRCMF_EVENTING_MASK_LEN];
 378
 379         for (i = 0; i < BRCMF_E_LAST; i++) {
 380                 if (ifp->drvr->fweh.evt_handler[i]) {
 381                         brcmf_dbg(EVENT, "enable event %s\n",
 382                                   brcmf_fweh_event_name(i));
 383                         setbit(eventmask, i);
 384                 }
 385         }
 386
 387         /* want to handle IF event as well */
 388         brcmf_dbg(EVENT, "enable event IF\n");
 389         setbit(eventmask, BRCMF_E_IF);
 390
 391         err = brcmf_fil_iovar_data_set(ifp, "event_msgs",
 392                                        eventmask, BRCMF_EVENTING_MASK_LEN);
 393         if (err)
 394                 brcmf_err("Set event_msgs error (%d)\n", err);
 395
 396         return err;
 397 }
 398
 399 /**
 400  * brcmf_fweh_process_event() - process skb as firmware event.
 401  *
 402  * @drvr: driver information object.
 403  * @event_packet: event packet to process.
 404  * @ifidx: index of the firmware interface (may change).
 405  *
 406  * If the packet buffer contains a firmware event message it will
 407  * dispatch the event to a registered handler (using worker).
 408  */
 409 void brcmf_fweh_process_event(struct brcmf_pub *drvr,
 410                               struct brcmf_event *event_packet, u8 *ifidx)
 411 {
 412         enum brcmf_fweh_event_code code;
 413         struct brcmf_fweh_info *fweh = &drvr->fweh;
 414         struct brcmf_fweh_queue_item *event;
 415         gfp_t alloc_flag = GFP_KERNEL;
 416         void *data;
 417         u32 datalen;
 418
 419         /* get event info */
 420         code = get_unaligned_be32(&event_packet->msg.event_type);
 421         datalen = get_unaligned_be32(&event_packet->msg.datalen);
 422         *ifidx = event_packet->msg.ifidx;
 423         data = &event_packet[1];
 424
 425         if (code >= BRCMF_E_LAST)
 426                 return;
 427
 428         if (code != BRCMF_E_IF && !fweh->evt_handler[code])
 429                 return;
 430
 431         if (in_interrupt())
 432                 alloc_flag = GFP_ATOMIC;
 433
 434         event = kzalloc(sizeof(*event) + datalen, alloc_flag);
 435         if (!event)
 436                 return;
 437
 438         event->code = code;
 439         event->ifidx = *ifidx;
 440
 441         /* use memcpy to get aligned event message */
 442         memcpy(&event->emsg, &event_packet->msg, sizeof(event->emsg));
 443         memcpy(event->data, data, datalen);
 444         memcpy(event->ifaddr, event_packet->eth.h_dest, ETH_ALEN);
 445
 446         brcmf_fweh_queue_event(fweh, event);
 447 }