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"
27 * struct brcm_ethhdr - broadcom specific ether header.
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.
43 struct brcmf_event_msg_be {
52 char ifname[IFNAMSIZ];
58 * struct brcmf_event - contents of broadcom event packet.
60 * @eth: standard ether header.
61 * @hdr: broadcom specific ether header.
62 * @msg: common part of the actual event message.
66 struct brcm_ethhdr hdr;
67 struct brcmf_event_msg_be msg;
71 * struct brcmf_fweh_queue_item - event item on event queue.
73 * @q: list element for queuing.
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.
80 struct brcmf_fweh_queue_item {
82 enum brcmf_fweh_event_code code;
85 struct brcmf_event_msg_be emsg;
90 * struct brcmf_fweh_event_name - code, name mapping entry.
92 struct brcmf_fweh_event_name {
93 enum brcmf_fweh_event_code code;
98 #define BRCMF_ENUM_DEF(id, val) \
101 /* array for mapping code to event name */
102 static struct brcmf_fweh_event_name fweh_event_names[] = {
103 BRCMF_FWEH_EVENT_ENUM_DEFLIST
105 #undef BRCMF_ENUM_DEF
108 * brcmf_fweh_event_name() - returns name for given event code.
110 * @code: code to lookup.
112 static const char *brcmf_fweh_event_name(enum brcmf_fweh_event_code code)
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;
122 static const char *brcmf_fweh_event_name(enum brcmf_fweh_event_code code)
129 * brcmf_fweh_queue_event() - create and queue event.
131 * @fweh: firmware event handling info.
132 * @event: event queue entry.
134 static void brcmf_fweh_queue_event(struct brcmf_fweh_info *fweh,
135 struct brcmf_fweh_queue_item *event)
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);
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,
150 struct brcmf_fweh_info *fweh;
154 fweh = &ifp->drvr->fweh;
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);
160 brcmf_err("unhandled event %d ignored\n", code);
162 brcmf_err("no interface object\n");
168 * brcmf_fweh_handle_if_event() - handle IF event.
170 * @drvr: driver information object.
171 * @item: queue entry.
172 * @ifpp: interface object (may change upon ADD action).
174 static void brcmf_fweh_handle_if_event(struct brcmf_pub *drvr,
175 struct brcmf_event_msg *emsg,
178 struct brcmf_if_event *ifevent = data;
179 struct brcmf_if *ifp;
182 brcmf_dbg(EVENT, "action: %u idx: %u bsscfg: %u flags: %u\n",
183 ifevent->action, ifevent->ifidx,
184 ifevent->bssidx, ifevent->flags);
186 if (ifevent->ifidx >= BRCMF_MAX_IFS) {
187 brcmf_err("invalid interface index: %u\n",
192 ifp = drvr->iflist[ifevent->bssidx];
194 if (ifevent->action == BRCMF_E_IF_ADD) {
195 brcmf_dbg(EVENT, "adding %s (%pM)\n", emsg->ifname,
197 ifp = brcmf_add_if(drvr, ifevent->bssidx, ifevent->ifidx,
198 emsg->ifname, emsg->addr);
202 if (!drvr->fweh.evt_handler[BRCMF_E_IF])
203 err = brcmf_net_attach(ifp, false);
206 err = brcmf_fweh_call_event_handler(ifp, emsg->event_code, emsg, data);
208 if (ifevent->action == BRCMF_E_IF_DEL)
209 brcmf_del_if(drvr, ifevent->bssidx);
213 * brcmf_fweh_dequeue_event() - get event from the queue.
215 * @fweh: firmware event handling info.
217 static struct brcmf_fweh_queue_item *
218 brcmf_fweh_dequeue_event(struct brcmf_fweh_info *fweh)
220 struct brcmf_fweh_queue_item *event = NULL;
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);
229 spin_unlock_irqrestore(&fweh->evt_q_lock, flags);
235 * brcmf_fweh_event_worker() - firmware event worker.
237 * @work: worker object.
239 static void brcmf_fweh_event_worker(struct work_struct *work)
241 struct brcmf_pub *drvr;
242 struct brcmf_if *ifp;
243 struct brcmf_fweh_info *fweh;
244 struct brcmf_fweh_queue_item *event;
246 struct brcmf_event_msg_be *emsg_be;
247 struct brcmf_event_msg emsg;
249 fweh = container_of(work, struct brcmf_fweh_info, event_work);
250 drvr = container_of(fweh, struct brcmf_pub, fweh);
252 while ((event = brcmf_fweh_dequeue_event(fweh))) {
253 brcmf_dbg(EVENT, "event %s (%u) ifidx %u bsscfg %u addr %pM\n",
254 brcmf_fweh_event_name(event->code), event->code,
255 event->emsg.ifidx, event->emsg.bsscfgidx,
258 /* convert event message */
259 emsg_be = &event->emsg;
260 emsg.version = be16_to_cpu(emsg_be->version);
261 emsg.flags = be16_to_cpu(emsg_be->flags);
262 emsg.event_code = event->code;
263 emsg.status = be32_to_cpu(emsg_be->status);
264 emsg.reason = be32_to_cpu(emsg_be->reason);
265 emsg.auth_type = be32_to_cpu(emsg_be->auth_type);
266 emsg.datalen = be32_to_cpu(emsg_be->datalen);
267 memcpy(emsg.addr, emsg_be->addr, ETH_ALEN);
268 memcpy(emsg.ifname, emsg_be->ifname, sizeof(emsg.ifname));
269 emsg.ifidx = emsg_be->ifidx;
270 emsg.bsscfgidx = emsg_be->bsscfgidx;
272 brcmf_dbg(EVENT, " version %u flags %u status %u reason %u\n",
273 emsg.version, emsg.flags, emsg.status, emsg.reason);
274 brcmf_dbg_hex_dump(BRCMF_EVENT_ON(), event->data,
275 min_t(u32, emsg.datalen, 64),
276 "event payload, len=%d\n", emsg.datalen);
278 /* special handling of interface event */
279 if (event->code == BRCMF_E_IF) {
280 brcmf_fweh_handle_if_event(drvr, &emsg, event->data);
284 ifp = drvr->iflist[emsg.bsscfgidx];
285 err = brcmf_fweh_call_event_handler(ifp, event->code, &emsg,
288 brcmf_err("event handler failed (%d)\n",
298 * brcmf_fweh_attach() - initialize firmware event handling.
300 * @drvr: driver information object.
302 void brcmf_fweh_attach(struct brcmf_pub *drvr)
304 struct brcmf_fweh_info *fweh = &drvr->fweh;
305 INIT_WORK(&fweh->event_work, brcmf_fweh_event_worker);
306 spin_lock_init(&fweh->evt_q_lock);
307 INIT_LIST_HEAD(&fweh->event_q);
311 * brcmf_fweh_detach() - cleanup firmware event handling.
313 * @drvr: driver information object.
315 void brcmf_fweh_detach(struct brcmf_pub *drvr)
317 struct brcmf_fweh_info *fweh = &drvr->fweh;
318 struct brcmf_if *ifp = drvr->iflist[0];
319 s8 eventmask[BRCMF_EVENTING_MASK_LEN];
322 /* clear all events */
323 memset(eventmask, 0, BRCMF_EVENTING_MASK_LEN);
324 (void)brcmf_fil_iovar_data_set(ifp, "event_msgs",
326 BRCMF_EVENTING_MASK_LEN);
328 /* cancel the worker */
329 cancel_work_sync(&fweh->event_work);
330 WARN_ON(!list_empty(&fweh->event_q));
331 memset(fweh->evt_handler, 0, sizeof(fweh->evt_handler));
335 * brcmf_fweh_register() - register handler for given event code.
337 * @drvr: driver information object.
339 * @handler: handler for the given event code.
341 int brcmf_fweh_register(struct brcmf_pub *drvr, enum brcmf_fweh_event_code code,
342 brcmf_fweh_handler_t handler)
344 if (drvr->fweh.evt_handler[code]) {
345 brcmf_err("event code %d already registered\n", code);
348 drvr->fweh.evt_handler[code] = handler;
349 brcmf_dbg(TRACE, "event handler registered for %s\n",
350 brcmf_fweh_event_name(code));
355 * brcmf_fweh_unregister() - remove handler for given code.
357 * @drvr: driver information object.
360 void brcmf_fweh_unregister(struct brcmf_pub *drvr,
361 enum brcmf_fweh_event_code code)
363 brcmf_dbg(TRACE, "event handler cleared for %s\n",
364 brcmf_fweh_event_name(code));
365 drvr->fweh.evt_handler[code] = NULL;
369 * brcmf_fweh_activate_events() - enables firmware events registered.
371 * @ifp: primary interface object.
373 int brcmf_fweh_activate_events(struct brcmf_if *ifp)
376 s8 eventmask[BRCMF_EVENTING_MASK_LEN];
378 for (i = 0; i < BRCMF_E_LAST; i++) {
379 if (ifp->drvr->fweh.evt_handler[i]) {
380 brcmf_dbg(EVENT, "enable event %s\n",
381 brcmf_fweh_event_name(i));
382 setbit(eventmask, i);
386 /* want to handle IF event as well */
387 brcmf_dbg(EVENT, "enable event IF\n");
388 setbit(eventmask, BRCMF_E_IF);
390 err = brcmf_fil_iovar_data_set(ifp, "event_msgs",
391 eventmask, BRCMF_EVENTING_MASK_LEN);
393 brcmf_err("Set event_msgs error (%d)\n", err);
399 * brcmf_fweh_process_event() - process skb as firmware event.
401 * @drvr: driver information object.
402 * @event_packet: event packet to process.
403 * @ifidx: index of the firmware interface (may change).
405 * If the packet buffer contains a firmware event message it will
406 * dispatch the event to a registered handler (using worker).
408 void brcmf_fweh_process_event(struct brcmf_pub *drvr,
409 struct brcmf_event *event_packet, u8 *ifidx)
411 enum brcmf_fweh_event_code code;
412 struct brcmf_fweh_info *fweh = &drvr->fweh;
413 struct brcmf_fweh_queue_item *event;
414 gfp_t alloc_flag = GFP_KERNEL;
419 code = get_unaligned_be32(&event_packet->msg.event_type);
420 datalen = get_unaligned_be32(&event_packet->msg.datalen);
421 *ifidx = event_packet->msg.ifidx;
422 data = &event_packet[1];
424 if (code >= BRCMF_E_LAST)
427 if (code != BRCMF_E_IF && !fweh->evt_handler[code])
431 alloc_flag = GFP_ATOMIC;
433 event = kzalloc(sizeof(*event) + datalen, alloc_flag);
438 event->ifidx = *ifidx;
440 /* use memcpy to get aligned event message */
441 memcpy(&event->emsg, &event_packet->msg, sizeof(event->emsg));
442 memcpy(event->data, data, datalen);
443 memcpy(event->ifaddr, event_packet->eth.h_dest, ETH_ALEN);
445 brcmf_fweh_queue_event(fweh, event);