| /* |
| * Copyright (c) 2012 Broadcom Corporation |
| * |
| * Permission to use, copy, modify, and/or distribute this software for any |
| * purpose with or without fee is hereby granted, provided that the above |
| * copyright notice and this permission notice appear in all copies. |
| * |
| * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
| * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
| * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY |
| * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
| * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION |
| * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN |
| * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
| */ |
| |
| #include "fweh.h" |
| |
| #include <threads.h> |
| |
| #include "brcmu_utils.h" |
| #include "brcmu_wifi.h" |
| #include "cfg80211.h" |
| #include "core.h" |
| #include "debug.h" |
| #include "device.h" |
| #include "fwil.h" |
| #include "linuxisms.h" |
| #include "proto.h" |
| #include "workqueue.h" |
| |
| /** |
| * struct brcmf_fweh_queue_item - event item on event queue. |
| * |
| * @q: list element for queuing. |
| * @code: event code. |
| * @ifidx: interface index related to this event. |
| * @ifaddr: ethernet address for interface. |
| * @emsg: common parameters of the firmware event message. |
| * @data: event specific data part of the firmware event. |
| */ |
| struct brcmf_fweh_queue_item { |
| struct list_node q; |
| enum brcmf_fweh_event_code code; |
| uint8_t ifidx; |
| uint8_t ifaddr[ETH_ALEN]; |
| struct brcmf_event_msg_be emsg; |
| uint32_t datalen; |
| uint8_t data[0]; |
| }; |
| |
| /** |
| * struct brcmf_fweh_event_name - code, name mapping entry. |
| */ |
| struct brcmf_fweh_event_name { |
| enum brcmf_fweh_event_code code; |
| const char* name; |
| }; |
| |
| #ifdef DEBUG |
| #define BRCMF_ENUM_DEF(id, val) {val, #id}, |
| |
| /* array for mapping code to event name */ |
| static struct brcmf_fweh_event_name fweh_event_names[] = {BRCMF_FWEH_EVENT_ENUM_DEFLIST}; |
| #undef BRCMF_ENUM_DEF |
| |
| /** |
| * brcmf_fweh_event_name() - returns name for given event code. |
| * |
| * @code: code to lookup. |
| */ |
| const char* brcmf_fweh_event_name(enum brcmf_fweh_event_code code) { |
| int i; |
| for (i = 0; i < (int)countof(fweh_event_names); i++) { |
| if (fweh_event_names[i].code == code) { |
| return fweh_event_names[i].name; |
| } |
| } |
| return "unknown"; |
| } |
| #else |
| const char* brcmf_fweh_event_name(enum brcmf_fweh_event_code code) { |
| return "nodebug"; |
| } |
| #endif |
| |
| /** |
| * brcmf_fweh_queue_event() - create and queue event. |
| * |
| * @fweh: firmware event handling info. |
| * @event: event queue entry. |
| */ |
| static void brcmf_fweh_queue_event(struct brcmf_fweh_info* fweh, |
| struct brcmf_fweh_queue_item* event) { |
| //spin_lock_irqsave(&fweh->evt_q_lock, flags); |
| pthread_mutex_lock(&irq_callback_lock); |
| list_add_tail(&fweh->event_q, &event->q); |
| //spin_unlock_irqrestore(&fweh->evt_q_lock, flags); |
| pthread_mutex_unlock(&irq_callback_lock); |
| workqueue_schedule_default(&fweh->event_work); |
| } |
| |
| static zx_status_t brcmf_fweh_call_event_handler(struct brcmf_if* ifp, |
| enum brcmf_fweh_event_code code, |
| struct brcmf_event_msg* emsg, void* data) { |
| struct brcmf_fweh_info* fweh; |
| zx_status_t err = ZX_ERR_IO; |
| |
| if (ifp) { |
| fweh = &ifp->drvr->fweh; |
| |
| /* handle the event if valid interface and handler */ |
| if (fweh->evt_handler[code]) { |
| err = fweh->evt_handler[code](ifp, emsg, data); |
| } else { |
| brcmf_err("unhandled event %d ignored\n", code); |
| } |
| } else { |
| brcmf_err("no interface object\n"); |
| } |
| return err; |
| } |
| |
| /** |
| * brcmf_fweh_handle_if_event() - handle IF event. |
| * |
| * @drvr: driver information object. |
| * @item: queue entry. |
| * @ifpp: interface object (may change upon ADD action). |
| */ |
| static void brcmf_fweh_handle_if_event(struct brcmf_pub* drvr, struct brcmf_event_msg* emsg, |
| void* data) { |
| struct brcmf_if_event* ifevent = data; |
| struct brcmf_if* ifp; |
| bool is_p2pdev; |
| zx_status_t err = ZX_OK; |
| |
| brcmf_dbg(EVENT, "action: %u ifidx: %u bsscfgidx: %u flags: %u role: %u\n", ifevent->action, |
| ifevent->ifidx, ifevent->bsscfgidx, ifevent->flags, ifevent->role); |
| |
| /* The P2P Device interface event must not be ignored contrary to what |
| * firmware tells us. Older firmware uses p2p noif, with sta role. |
| * This should be accepted when p2pdev_setup is ongoing. TDLS setup will |
| * use the same ifevent and should be ignored. |
| */ |
| is_p2pdev = ((ifevent->flags & BRCMF_E_IF_FLAG_NOIF) && |
| (ifevent->role == BRCMF_E_IF_ROLE_P2P_CLIENT || |
| ((ifevent->role == BRCMF_E_IF_ROLE_STA) && (drvr->fweh.p2pdev_setup_ongoing)))); |
| if (!is_p2pdev && (ifevent->flags & BRCMF_E_IF_FLAG_NOIF)) { |
| brcmf_dbg(EVENT, "event can be ignored\n"); |
| return; |
| } |
| if (ifevent->ifidx >= BRCMF_MAX_IFS) { |
| brcmf_err("invalid interface index: %u\n", ifevent->ifidx); |
| return; |
| } |
| |
| ifp = drvr->iflist[ifevent->bsscfgidx]; |
| |
| if (ifevent->action == BRCMF_E_IF_ADD) { |
| brcmf_dbg(EVENT, "adding %s (%pM)\n", emsg->ifname, emsg->addr); |
| err = brcmf_add_if(drvr, ifevent->bsscfgidx, ifevent->ifidx, is_p2pdev, emsg->ifname, |
| emsg->addr, &ifp); |
| if (err != ZX_OK) { |
| return; |
| } |
| if (!is_p2pdev) { |
| brcmf_proto_add_if(drvr, ifp); |
| } |
| if (!drvr->fweh.evt_handler[BRCMF_E_IF]) |
| if (brcmf_net_attach(ifp, false) != ZX_OK) { |
| return; |
| } |
| } |
| |
| if (ifp && ifevent->action == BRCMF_E_IF_CHANGE) { |
| brcmf_proto_reset_if(drvr, ifp); |
| } |
| |
| err = brcmf_fweh_call_event_handler(ifp, emsg->event_code, emsg, data); |
| |
| if (ifp && ifevent->action == BRCMF_E_IF_DEL) { |
| bool armed = brcmf_cfg80211_vif_event_armed(drvr->config); |
| |
| /* Default handling in case no-one waits for this event */ |
| if (!armed) { |
| brcmf_remove_interface(ifp, false); |
| } |
| } |
| } |
| |
| /** |
| * brcmf_fweh_dequeue_event() - get event from the queue. |
| * |
| * @fweh: firmware event handling info. |
| */ |
| static struct brcmf_fweh_queue_item* brcmf_fweh_dequeue_event(struct brcmf_fweh_info* fweh) { |
| struct brcmf_fweh_queue_item* event = NULL; |
| |
| //spin_lock_irqsave(&fweh->evt_q_lock, flags); |
| pthread_mutex_lock(&irq_callback_lock); |
| if (!list_is_empty(&fweh->event_q)) { |
| event = list_peek_head_type(&fweh->event_q, struct brcmf_fweh_queue_item, q); |
| list_delete(&event->q); |
| } |
| //spin_unlock_irqrestore(&fweh->evt_q_lock, flags); |
| pthread_mutex_unlock(&irq_callback_lock); |
| |
| return event; |
| } |
| |
| /** |
| * brcmf_fweh_event_worker() - firmware event worker. |
| * |
| * @work: worker object. |
| */ |
| static void brcmf_fweh_event_worker(struct work_struct* work) { |
| struct brcmf_pub* drvr; |
| struct brcmf_if* ifp; |
| struct brcmf_fweh_info* fweh; |
| struct brcmf_fweh_queue_item* event; |
| zx_status_t err = ZX_OK; |
| struct brcmf_event_msg_be* emsg_be; |
| struct brcmf_event_msg emsg; |
| |
| fweh = containerof(work, struct brcmf_fweh_info, event_work); |
| drvr = containerof(fweh, struct brcmf_pub, fweh); |
| |
| while ((event = brcmf_fweh_dequeue_event(fweh))) { |
| brcmf_dbg(EVENT, "event %s (%u) ifidx %u bsscfg %u addr %pM\n", |
| brcmf_fweh_event_name(event->code), event->code, event->emsg.ifidx, |
| event->emsg.bsscfgidx, event->emsg.addr); |
| |
| /* convert event message */ |
| emsg_be = &event->emsg; |
| emsg.version = be16toh(emsg_be->version); |
| emsg.flags = be16toh(emsg_be->flags); |
| emsg.event_code = event->code; |
| emsg.status = be32toh(emsg_be->status); |
| emsg.reason = be32toh(emsg_be->reason); |
| emsg.auth_type = be32toh(emsg_be->auth_type); |
| emsg.datalen = be32toh(emsg_be->datalen); |
| memcpy(emsg.addr, emsg_be->addr, ETH_ALEN); |
| memcpy(emsg.ifname, emsg_be->ifname, sizeof(emsg.ifname)); |
| emsg.ifidx = emsg_be->ifidx; |
| emsg.bsscfgidx = emsg_be->bsscfgidx; |
| |
| brcmf_dbg(EVENT, " version %u flags %u status %u reason %u\n", emsg.version, emsg.flags, |
| emsg.status, emsg.reason); |
| brcmf_dbg_hex_dump(BRCMF_EVENT_ON(), event->data, min_t(uint32_t, emsg.datalen, 64), |
| "event payload, len=%d\n", emsg.datalen); |
| |
| /* special handling of interface event */ |
| if (event->code == BRCMF_E_IF) { |
| brcmf_fweh_handle_if_event(drvr, &emsg, event->data); |
| goto event_free; |
| } |
| |
| if (event->code == BRCMF_E_TDLS_PEER_EVENT) { |
| ifp = drvr->iflist[0]; |
| } else { |
| ifp = drvr->iflist[emsg.bsscfgidx]; |
| } |
| err = brcmf_fweh_call_event_handler(ifp, event->code, &emsg, event->data); |
| if (err != ZX_OK) { |
| brcmf_err("event handler failed (%d)\n", event->code); |
| err = ZX_OK; |
| } |
| event_free: |
| free(event); |
| } |
| } |
| |
| /** |
| * brcmf_fweh_p2pdev_setup() - P2P device setup ongoing (or not). |
| * |
| * @ifp: ifp on which setup is taking place or finished. |
| * @ongoing: p2p device setup in progress (or not). |
| */ |
| void brcmf_fweh_p2pdev_setup(struct brcmf_if* ifp, bool ongoing) { |
| ifp->drvr->fweh.p2pdev_setup_ongoing = ongoing; |
| } |
| |
| /** |
| * brcmf_fweh_attach() - initialize firmware event handling. |
| * |
| * @drvr: driver information object. |
| */ |
| void brcmf_fweh_attach(struct brcmf_pub* drvr) { |
| struct brcmf_fweh_info* fweh = &drvr->fweh; |
| workqueue_init_work(&fweh->event_work, brcmf_fweh_event_worker); |
| //spin_lock_init(&fweh->evt_q_lock); |
| list_initialize(&fweh->event_q); |
| } |
| |
| /** |
| * brcmf_fweh_detach() - cleanup firmware event handling. |
| * |
| * @drvr: driver information object. |
| */ |
| void brcmf_fweh_detach(struct brcmf_pub* drvr) { |
| struct brcmf_fweh_info* fweh = &drvr->fweh; |
| struct brcmf_if* ifp = brcmf_get_ifp(drvr, 0); |
| int8_t eventmask[BRCMF_EVENTING_MASK_LEN]; |
| |
| if (ifp) { |
| /* clear all events */ |
| memset(eventmask, 0, BRCMF_EVENTING_MASK_LEN); |
| (void)brcmf_fil_iovar_data_set(ifp, "event_msgs", eventmask, BRCMF_EVENTING_MASK_LEN); |
| } |
| /* cancel the worker */ |
| workqueue_cancel_work(&fweh->event_work); |
| WARN_ON(!list_is_empty(&fweh->event_q)); |
| memset(fweh->evt_handler, 0, sizeof(fweh->evt_handler)); |
| } |
| |
| /** |
| * brcmf_fweh_register() - register handler for given event code. |
| * |
| * @drvr: driver information object. |
| * @code: event code. |
| * @handler: handler for the given event code. |
| */ |
| zx_status_t brcmf_fweh_register(struct brcmf_pub* drvr, enum brcmf_fweh_event_code code, |
| brcmf_fweh_handler_t handler) { |
| if (drvr->fweh.evt_handler[code]) { |
| brcmf_err("Exit: event code %d already registered\n", code); |
| return ZX_ERR_ALREADY_EXISTS; |
| } |
| drvr->fweh.evt_handler[code] = handler; |
| brcmf_dbg(TRACE, "Exit: event handler registered for %s\n", brcmf_fweh_event_name(code)); |
| return ZX_OK; |
| } |
| |
| /** |
| * brcmf_fweh_unregister() - remove handler for given code. |
| * |
| * @drvr: driver information object. |
| * @code: event code. |
| */ |
| void brcmf_fweh_unregister(struct brcmf_pub* drvr, enum brcmf_fweh_event_code code) { |
| brcmf_dbg(TRACE, "event handler cleared for %s\n", brcmf_fweh_event_name(code)); |
| drvr->fweh.evt_handler[code] = NULL; |
| } |
| |
| /** |
| * brcmf_fweh_activate_events() - enables firmware events registered. |
| * |
| * @ifp: primary interface object. |
| */ |
| zx_status_t brcmf_fweh_activate_events(struct brcmf_if* ifp) { |
| int i; |
| zx_status_t err; |
| int8_t eventmask[BRCMF_EVENTING_MASK_LEN]; |
| |
| memset(eventmask, 0, sizeof(eventmask)); |
| for (i = 0; i < BRCMF_E_LAST; i++) { |
| if (ifp->drvr->fweh.evt_handler[i]) { |
| brcmf_dbg(EVENT, "enable event %s\n", brcmf_fweh_event_name(i)); |
| setbit(eventmask, i); |
| } |
| } |
| |
| /* want to handle IF event as well */ |
| brcmf_dbg(EVENT, "enable event IF\n"); |
| setbit(eventmask, BRCMF_E_IF); |
| |
| err = brcmf_fil_iovar_data_set(ifp, "event_msgs", eventmask, BRCMF_EVENTING_MASK_LEN); |
| if (err != ZX_OK) { |
| brcmf_err("Set event_msgs error (%d)\n", err); |
| } |
| |
| return err; |
| } |
| |
| /** |
| * brcmf_fweh_process_event() - process netbuf as firmware event. |
| * |
| * @drvr: driver information object. |
| * @event_packet: event packet to process. |
| * |
| * If the packet buffer contains a firmware event message it will |
| * dispatch the event to a registered handler (using worker). |
| */ |
| void brcmf_fweh_process_event(struct brcmf_pub* drvr, struct brcmf_event* event_packet, |
| uint32_t packet_len) { |
| enum brcmf_fweh_event_code code; |
| struct brcmf_fweh_info* fweh = &drvr->fweh; |
| struct brcmf_fweh_queue_item* event; |
| void* data; |
| uint32_t datalen; |
| |
| //brcmf_dbg(TEMP, "Enter"); |
| /* get event info */ |
| code = be32toh(event_packet->msg.event_type); |
| datalen = be32toh(event_packet->msg.datalen); |
| data = &event_packet[1]; |
| |
| if (code >= BRCMF_E_LAST) { |
| return; |
| } |
| |
| if (code != BRCMF_E_IF && !fweh->evt_handler[code]) { |
| brcmf_dbg(TEMP, "Event not found"); |
| return; |
| } |
| |
| if (datalen > BRCMF_DCMD_MAXLEN || datalen + sizeof(*event_packet) > packet_len) { |
| brcmf_dbg(TEMP, "Len, datalen %d, event_packet size %ld, packet_len %d", datalen, |
| sizeof(*event_packet), packet_len); |
| return; |
| } |
| |
| event = calloc(1, sizeof(*event) + datalen); |
| if (!event) { |
| return; |
| } |
| |
| event->code = code; |
| event->ifidx = event_packet->msg.ifidx; |
| |
| /* use memcpy to get aligned event message */ |
| memcpy(&event->emsg, &event_packet->msg, sizeof(event->emsg)); |
| memcpy(event->data, data, datalen); |
| event->datalen = datalen; |
| memcpy(event->ifaddr, event_packet->eth.h_dest, ETH_ALEN); |
| |
| //brcmf_dbg(TEMP, "Queueing event!"); |
| brcmf_fweh_queue_event(fweh, event); |
| } |