2 * Copyright (c) 2012 Broadcom Corporation
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.
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.
16 #include <linux/netdevice.h>
18 #include "brcmu_wifi.h"
19 #include "brcmu_utils.h"
24 #include "tracepoint.h"
30 * struct brcmf_fweh_queue_item - event item on event queue.
32 * @q: list element for queuing.
34 * @ifidx: interface index related to this event.
35 * @ifaddr: ethernet address for interface.
36 * @emsg: common parameters of the firmware event message.
37 * @data: event specific data part of the firmware event.
39 struct brcmf_fweh_queue_item {
41 enum brcmf_fweh_event_code code;
44 struct brcmf_event_msg_be emsg;
50 * struct brcmf_fweh_event_name - code, name mapping entry.
52 struct brcmf_fweh_event_name {
53 enum brcmf_fweh_event_code code;
58 #define BRCMF_ENUM_DEF(id, val) \
61 /* array for mapping code to event name */
62 static struct brcmf_fweh_event_name fweh_event_names[] = {
63 BRCMF_FWEH_EVENT_ENUM_DEFLIST
68 * brcmf_fweh_event_name() - returns name for given event code.
70 * @code: code to lookup.
72 const char *brcmf_fweh_event_name(enum brcmf_fweh_event_code code)
75 for (i = 0; i < ARRAY_SIZE(fweh_event_names); i++) {
76 if (fweh_event_names[i].code == code)
77 return fweh_event_names[i].name;
82 const char *brcmf_fweh_event_name(enum brcmf_fweh_event_code code)
89 * brcmf_fweh_queue_event() - create and queue event.
91 * @fweh: firmware event handling info.
92 * @event: event queue entry.
94 static void brcmf_fweh_queue_event(struct brcmf_fweh_info *fweh,
95 struct brcmf_fweh_queue_item *event)
99 spin_lock_irqsave(&fweh->evt_q_lock, flags);
100 list_add_tail(&event->q, &fweh->event_q);
101 spin_unlock_irqrestore(&fweh->evt_q_lock, flags);
102 schedule_work(&fweh->event_work);
105 static int brcmf_fweh_call_event_handler(struct brcmf_if *ifp,
106 enum brcmf_fweh_event_code code,
107 struct brcmf_event_msg *emsg,
110 struct brcmf_fweh_info *fweh;
114 fweh = &ifp->drvr->fweh;
116 /* handle the event if valid interface and handler */
117 if (fweh->evt_handler[code])
118 err = fweh->evt_handler[code](ifp, emsg, data);
120 brcmf_err("unhandled event %d ignored\n", code);
122 brcmf_err("no interface object\n");
128 * brcmf_fweh_handle_if_event() - handle IF event.
130 * @drvr: driver information object.
131 * @item: queue entry.
132 * @ifpp: interface object (may change upon ADD action).
134 static void brcmf_fweh_handle_if_event(struct brcmf_pub *drvr,
135 struct brcmf_event_msg *emsg,
138 struct brcmf_if_event *ifevent = data;
139 struct brcmf_if *ifp;
143 brcmf_dbg(EVENT, "action: %u ifidx: %u bsscfgidx: %u flags: %u role: %u\n",
144 ifevent->action, ifevent->ifidx, ifevent->bsscfgidx,
145 ifevent->flags, ifevent->role);
147 /* The P2P Device interface event must not be ignored contrary to what
148 * firmware tells us. Older firmware uses p2p noif, with sta role.
149 * This should be accepted when p2pdev_setup is ongoing. TDLS setup will
150 * use the same ifevent and should be ignored.
152 is_p2pdev = ((ifevent->flags & BRCMF_E_IF_FLAG_NOIF) &&
153 (ifevent->role == BRCMF_E_IF_ROLE_P2P_CLIENT ||
154 ((ifevent->role == BRCMF_E_IF_ROLE_STA) &&
155 (drvr->fweh.p2pdev_setup_ongoing))));
156 if (!is_p2pdev && (ifevent->flags & BRCMF_E_IF_FLAG_NOIF)) {
157 brcmf_dbg(EVENT, "event can be ignored\n");
160 if (ifevent->ifidx >= BRCMF_MAX_IFS) {
161 brcmf_err("invalid interface index: %u\n", ifevent->ifidx);
165 ifp = drvr->iflist[ifevent->bsscfgidx];
167 if (ifevent->action == BRCMF_E_IF_ADD) {
168 brcmf_dbg(EVENT, "adding %s (%pM)\n", emsg->ifname,
170 ifp = brcmf_add_if(drvr, ifevent->bsscfgidx, ifevent->ifidx,
171 is_p2pdev, emsg->ifname, emsg->addr);
175 brcmf_proto_add_if(drvr, ifp);
176 if (!drvr->fweh.evt_handler[BRCMF_E_IF])
177 if (brcmf_net_attach(ifp, false) < 0)
181 if (ifp && ifevent->action == BRCMF_E_IF_CHANGE)
182 brcmf_proto_reset_if(drvr, ifp);
184 err = brcmf_fweh_call_event_handler(ifp, emsg->event_code, emsg, data);
186 if (ifp && ifevent->action == BRCMF_E_IF_DEL) {
187 bool armed = brcmf_cfg80211_vif_event_armed(drvr->config);
189 /* Default handling in case no-one waits for this event */
191 brcmf_remove_interface(ifp, false);
196 * brcmf_fweh_dequeue_event() - get event from the queue.
198 * @fweh: firmware event handling info.
200 static struct brcmf_fweh_queue_item *
201 brcmf_fweh_dequeue_event(struct brcmf_fweh_info *fweh)
203 struct brcmf_fweh_queue_item *event = NULL;
206 spin_lock_irqsave(&fweh->evt_q_lock, flags);
207 if (!list_empty(&fweh->event_q)) {
208 event = list_first_entry(&fweh->event_q,
209 struct brcmf_fweh_queue_item, q);
212 spin_unlock_irqrestore(&fweh->evt_q_lock, flags);
218 * brcmf_fweh_event_worker() - firmware event worker.
220 * @work: worker object.
222 static void brcmf_fweh_event_worker(struct work_struct *work)
224 struct brcmf_pub *drvr;
225 struct brcmf_if *ifp;
226 struct brcmf_fweh_info *fweh;
227 struct brcmf_fweh_queue_item *event;
229 struct brcmf_event_msg_be *emsg_be;
230 struct brcmf_event_msg emsg;
232 fweh = container_of(work, struct brcmf_fweh_info, event_work);
233 drvr = container_of(fweh, struct brcmf_pub, fweh);
235 while ((event = brcmf_fweh_dequeue_event(fweh))) {
236 brcmf_dbg(EVENT, "event %s (%u) ifidx %u bsscfg %u addr %pM\n",
237 brcmf_fweh_event_name(event->code), event->code,
238 event->emsg.ifidx, event->emsg.bsscfgidx,
240 if (event->emsg.bsscfgidx >= BRCMF_MAX_IFS) {
241 brcmf_err("invalid bsscfg index: %u\n", event->emsg.bsscfgidx);
245 /* convert event message */
246 emsg_be = &event->emsg;
247 emsg.version = be16_to_cpu(emsg_be->version);
248 emsg.flags = be16_to_cpu(emsg_be->flags);
249 emsg.event_code = event->code;
250 emsg.status = be32_to_cpu(emsg_be->status);
251 emsg.reason = be32_to_cpu(emsg_be->reason);
252 emsg.auth_type = be32_to_cpu(emsg_be->auth_type);
253 emsg.datalen = be32_to_cpu(emsg_be->datalen);
254 memcpy(emsg.addr, emsg_be->addr, ETH_ALEN);
255 memcpy(emsg.ifname, emsg_be->ifname, sizeof(emsg.ifname));
256 emsg.ifidx = emsg_be->ifidx;
257 emsg.bsscfgidx = emsg_be->bsscfgidx;
259 brcmf_dbg(EVENT, " version %u flags %u status %u reason %u\n",
260 emsg.version, emsg.flags, emsg.status, emsg.reason);
261 brcmf_dbg_hex_dump(BRCMF_EVENT_ON(), event->data,
262 min_t(u32, emsg.datalen, 64),
263 "event payload, len=%d\n", emsg.datalen);
264 if (emsg.datalen > event->datalen) {
265 brcmf_err("event invalid length header=%d, msg=%d\n",
266 event->datalen, emsg.datalen);
270 /* special handling of interface event */
271 if (event->code == BRCMF_E_IF) {
272 brcmf_fweh_handle_if_event(drvr, &emsg, event->data);
276 if (event->code == BRCMF_E_TDLS_PEER_EVENT)
277 ifp = drvr->iflist[0];
279 ifp = drvr->iflist[emsg.bsscfgidx];
280 err = brcmf_fweh_call_event_handler(ifp, event->code, &emsg,
283 brcmf_err("event handler failed (%d)\n",
293 * brcmf_fweh_p2pdev_setup() - P2P device setup ongoing (or not).
295 * @ifp: ifp on which setup is taking place or finished.
296 * @ongoing: p2p device setup in progress (or not).
298 void brcmf_fweh_p2pdev_setup(struct brcmf_if *ifp, bool ongoing)
300 ifp->drvr->fweh.p2pdev_setup_ongoing = ongoing;
304 * brcmf_fweh_attach() - initialize firmware event handling.
306 * @drvr: driver information object.
308 void brcmf_fweh_attach(struct brcmf_pub *drvr)
310 struct brcmf_fweh_info *fweh = &drvr->fweh;
311 INIT_WORK(&fweh->event_work, brcmf_fweh_event_worker);
312 spin_lock_init(&fweh->evt_q_lock);
313 INIT_LIST_HEAD(&fweh->event_q);
317 * brcmf_fweh_detach() - cleanup firmware event handling.
319 * @drvr: driver information object.
321 void brcmf_fweh_detach(struct brcmf_pub *drvr)
323 struct brcmf_fweh_info *fweh = &drvr->fweh;
324 struct brcmf_if *ifp = brcmf_get_ifp(drvr, 0);
325 s8 eventmask[BRCMF_EVENTING_MASK_LEN];
328 /* clear all events */
329 memset(eventmask, 0, BRCMF_EVENTING_MASK_LEN);
330 (void)brcmf_fil_iovar_data_set(ifp, "event_msgs",
332 BRCMF_EVENTING_MASK_LEN);
334 /* cancel the worker */
335 cancel_work_sync(&fweh->event_work);
336 WARN_ON(!list_empty(&fweh->event_q));
337 memset(fweh->evt_handler, 0, sizeof(fweh->evt_handler));
341 * brcmf_fweh_register() - register handler for given event code.
343 * @drvr: driver information object.
345 * @handler: handler for the given event code.
347 int brcmf_fweh_register(struct brcmf_pub *drvr, enum brcmf_fweh_event_code code,
348 brcmf_fweh_handler_t handler)
350 if (drvr->fweh.evt_handler[code]) {
351 brcmf_err("event code %d already registered\n", code);
354 drvr->fweh.evt_handler[code] = handler;
355 brcmf_dbg(TRACE, "event handler registered for %s\n",
356 brcmf_fweh_event_name(code));
361 * brcmf_fweh_unregister() - remove handler for given code.
363 * @drvr: driver information object.
366 void brcmf_fweh_unregister(struct brcmf_pub *drvr,
367 enum brcmf_fweh_event_code code)
369 brcmf_dbg(TRACE, "event handler cleared for %s\n",
370 brcmf_fweh_event_name(code));
371 drvr->fweh.evt_handler[code] = NULL;
375 * brcmf_fweh_activate_events() - enables firmware events registered.
377 * @ifp: primary interface object.
379 int brcmf_fweh_activate_events(struct brcmf_if *ifp)
382 s8 eventmask[BRCMF_EVENTING_MASK_LEN];
384 memset(eventmask, 0, sizeof(eventmask));
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);
393 /* want to handle IF event as well */
394 brcmf_dbg(EVENT, "enable event IF\n");
395 setbit(eventmask, BRCMF_E_IF);
397 err = brcmf_fil_iovar_data_set(ifp, "event_msgs",
398 eventmask, BRCMF_EVENTING_MASK_LEN);
400 brcmf_err("Set event_msgs error (%d)\n", err);
406 * brcmf_fweh_process_event() - process skb as firmware event.
408 * @drvr: driver information object.
409 * @event_packet: event packet to process.
411 * If the packet buffer contains a firmware event message it will
412 * dispatch the event to a registered handler (using worker).
414 void brcmf_fweh_process_event(struct brcmf_pub *drvr,
415 struct brcmf_event *event_packet,
418 enum brcmf_fweh_event_code code;
419 struct brcmf_fweh_info *fweh = &drvr->fweh;
420 struct brcmf_fweh_queue_item *event;
421 gfp_t alloc_flag = GFP_KERNEL;
426 code = get_unaligned_be32(&event_packet->msg.event_type);
427 datalen = get_unaligned_be32(&event_packet->msg.datalen);
428 data = &event_packet[1];
430 if (code >= BRCMF_E_LAST)
433 if (code != BRCMF_E_IF && !fweh->evt_handler[code])
436 if (datalen > BRCMF_DCMD_MAXLEN ||
437 datalen + sizeof(*event_packet) > packet_len)
441 alloc_flag = GFP_ATOMIC;
443 event = kzalloc(sizeof(*event) + datalen, alloc_flag);
448 event->ifidx = event_packet->msg.ifidx;
450 /* use memcpy to get aligned event message */
451 memcpy(&event->emsg, &event_packet->msg, sizeof(event->emsg));
452 memcpy(event->data, data, datalen);
453 event->datalen = datalen;
454 memcpy(event->ifaddr, event_packet->eth.h_dest, ETH_ALEN);
456 brcmf_fweh_queue_event(fweh, event);