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