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"
23 #include "tracepoint.h"
29 * struct brcm_ethhdr - broadcom specific ether header.
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.
45 struct brcmf_event_msg_be
{
54 char ifname
[IFNAMSIZ
];
60 * struct brcmf_event - contents of broadcom event packet.
62 * @eth: standard ether header.
63 * @hdr: broadcom specific ether header.
64 * @msg: common part of the actual event message.
68 struct brcm_ethhdr hdr
;
69 struct brcmf_event_msg_be msg
;
73 * struct brcmf_fweh_queue_item - event item on event queue.
75 * @q: list element for queuing.
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.
82 struct brcmf_fweh_queue_item
{
84 enum brcmf_fweh_event_code code
;
87 struct brcmf_event_msg_be emsg
;
92 * struct brcmf_fweh_event_name - code, name mapping entry.
94 struct brcmf_fweh_event_name
{
95 enum brcmf_fweh_event_code code
;
100 #define BRCMF_ENUM_DEF(id, val) \
103 /* array for mapping code to event name */
104 static struct brcmf_fweh_event_name fweh_event_names
[] = {
105 BRCMF_FWEH_EVENT_ENUM_DEFLIST
107 #undef BRCMF_ENUM_DEF
110 * brcmf_fweh_event_name() - returns name for given event code.
112 * @code: code to lookup.
114 static const char *brcmf_fweh_event_name(enum brcmf_fweh_event_code code
)
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
;
124 static const char *brcmf_fweh_event_name(enum brcmf_fweh_event_code code
)
131 * brcmf_fweh_queue_event() - create and queue event.
133 * @fweh: firmware event handling info.
134 * @event: event queue entry.
136 static void brcmf_fweh_queue_event(struct brcmf_fweh_info
*fweh
,
137 struct brcmf_fweh_queue_item
*event
)
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
);
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
,
152 struct brcmf_fweh_info
*fweh
;
156 fweh
= &ifp
->drvr
->fweh
;
158 /* handle the event if valid interface and handler */
159 if (fweh
->evt_handler
[code
])
160 err
= fweh
->evt_handler
[code
](ifp
, emsg
, data
);
162 brcmf_err("unhandled event %d ignored\n", code
);
164 brcmf_err("no interface object\n");
170 * brcmf_fweh_handle_if_event() - handle IF event.
172 * @drvr: driver information object.
173 * @item: queue entry.
174 * @ifpp: interface object (may change upon ADD action).
176 static void brcmf_fweh_handle_if_event(struct brcmf_pub
*drvr
,
177 struct brcmf_event_msg
*emsg
,
180 struct brcmf_if_event
*ifevent
= data
;
181 struct brcmf_if
*ifp
;
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
);
188 if (ifevent
->ifidx
>= BRCMF_MAX_IFS
) {
189 brcmf_err("invalid interface index: %u\n",
194 ifp
= drvr
->iflist
[ifevent
->bssidx
];
196 if (ifevent
->action
== BRCMF_E_IF_ADD
) {
197 brcmf_dbg(EVENT
, "adding %s (%pM)\n", emsg
->ifname
,
199 ifp
= brcmf_add_if(drvr
, ifevent
->bssidx
, ifevent
->ifidx
,
200 emsg
->ifname
, emsg
->addr
);
203 brcmf_fws_add_interface(ifp
);
204 if (!drvr
->fweh
.evt_handler
[BRCMF_E_IF
])
205 if (brcmf_net_attach(ifp
, false) < 0)
209 if (ifevent
->action
== BRCMF_E_IF_CHANGE
)
210 brcmf_fws_reset_interface(ifp
);
212 err
= brcmf_fweh_call_event_handler(ifp
, emsg
->event_code
, emsg
, data
);
214 if (ifevent
->action
== BRCMF_E_IF_DEL
) {
215 brcmf_fws_del_interface(ifp
);
216 brcmf_del_if(drvr
, ifevent
->bssidx
);
221 * brcmf_fweh_dequeue_event() - get event from the queue.
223 * @fweh: firmware event handling info.
225 static struct brcmf_fweh_queue_item
*
226 brcmf_fweh_dequeue_event(struct brcmf_fweh_info
*fweh
)
228 struct brcmf_fweh_queue_item
*event
= NULL
;
231 spin_lock_irqsave(&fweh
->evt_q_lock
, flags
);
232 if (!list_empty(&fweh
->event_q
)) {
233 event
= list_first_entry(&fweh
->event_q
,
234 struct brcmf_fweh_queue_item
, q
);
237 spin_unlock_irqrestore(&fweh
->evt_q_lock
, flags
);
243 * brcmf_fweh_event_worker() - firmware event worker.
245 * @work: worker object.
247 static void brcmf_fweh_event_worker(struct work_struct
*work
)
249 struct brcmf_pub
*drvr
;
250 struct brcmf_if
*ifp
;
251 struct brcmf_fweh_info
*fweh
;
252 struct brcmf_fweh_queue_item
*event
;
254 struct brcmf_event_msg_be
*emsg_be
;
255 struct brcmf_event_msg emsg
;
257 fweh
= container_of(work
, struct brcmf_fweh_info
, event_work
);
258 drvr
= container_of(fweh
, struct brcmf_pub
, fweh
);
260 while ((event
= brcmf_fweh_dequeue_event(fweh
))) {
261 brcmf_dbg(EVENT
, "event %s (%u) ifidx %u bsscfg %u addr %pM\n",
262 brcmf_fweh_event_name(event
->code
), event
->code
,
263 event
->emsg
.ifidx
, event
->emsg
.bsscfgidx
,
266 /* convert event message */
267 emsg_be
= &event
->emsg
;
268 emsg
.version
= be16_to_cpu(emsg_be
->version
);
269 emsg
.flags
= be16_to_cpu(emsg_be
->flags
);
270 emsg
.event_code
= event
->code
;
271 emsg
.status
= be32_to_cpu(emsg_be
->status
);
272 emsg
.reason
= be32_to_cpu(emsg_be
->reason
);
273 emsg
.auth_type
= be32_to_cpu(emsg_be
->auth_type
);
274 emsg
.datalen
= be32_to_cpu(emsg_be
->datalen
);
275 memcpy(emsg
.addr
, emsg_be
->addr
, ETH_ALEN
);
276 memcpy(emsg
.ifname
, emsg_be
->ifname
, sizeof(emsg
.ifname
));
277 emsg
.ifidx
= emsg_be
->ifidx
;
278 emsg
.bsscfgidx
= emsg_be
->bsscfgidx
;
280 brcmf_dbg(EVENT
, " version %u flags %u status %u reason %u\n",
281 emsg
.version
, emsg
.flags
, emsg
.status
, emsg
.reason
);
282 brcmf_dbg_hex_dump(BRCMF_EVENT_ON(), event
->data
,
283 min_t(u32
, emsg
.datalen
, 64),
284 "event payload, len=%d\n", emsg
.datalen
);
286 /* special handling of interface event */
287 if (event
->code
== BRCMF_E_IF
) {
288 brcmf_fweh_handle_if_event(drvr
, &emsg
, event
->data
);
292 ifp
= drvr
->iflist
[emsg
.bsscfgidx
];
293 err
= brcmf_fweh_call_event_handler(ifp
, event
->code
, &emsg
,
296 brcmf_err("event handler failed (%d)\n",
306 * brcmf_fweh_attach() - initialize firmware event handling.
308 * @drvr: driver information object.
310 void brcmf_fweh_attach(struct brcmf_pub
*drvr
)
312 struct brcmf_fweh_info
*fweh
= &drvr
->fweh
;
313 INIT_WORK(&fweh
->event_work
, brcmf_fweh_event_worker
);
314 spin_lock_init(&fweh
->evt_q_lock
);
315 INIT_LIST_HEAD(&fweh
->event_q
);
319 * brcmf_fweh_detach() - cleanup firmware event handling.
321 * @drvr: driver information object.
323 void brcmf_fweh_detach(struct brcmf_pub
*drvr
)
325 struct brcmf_fweh_info
*fweh
= &drvr
->fweh
;
326 struct brcmf_if
*ifp
= drvr
->iflist
[0];
327 s8 eventmask
[BRCMF_EVENTING_MASK_LEN
];
330 /* clear all events */
331 memset(eventmask
, 0, BRCMF_EVENTING_MASK_LEN
);
332 (void)brcmf_fil_iovar_data_set(ifp
, "event_msgs",
334 BRCMF_EVENTING_MASK_LEN
);
336 /* cancel the worker */
337 cancel_work_sync(&fweh
->event_work
);
338 WARN_ON(!list_empty(&fweh
->event_q
));
339 memset(fweh
->evt_handler
, 0, sizeof(fweh
->evt_handler
));
343 * brcmf_fweh_register() - register handler for given event code.
345 * @drvr: driver information object.
347 * @handler: handler for the given event code.
349 int brcmf_fweh_register(struct brcmf_pub
*drvr
, enum brcmf_fweh_event_code code
,
350 brcmf_fweh_handler_t handler
)
352 if (drvr
->fweh
.evt_handler
[code
]) {
353 brcmf_err("event code %d already registered\n", code
);
356 drvr
->fweh
.evt_handler
[code
] = handler
;
357 brcmf_dbg(TRACE
, "event handler registered for %s\n",
358 brcmf_fweh_event_name(code
));
363 * brcmf_fweh_unregister() - remove handler for given code.
365 * @drvr: driver information object.
368 void brcmf_fweh_unregister(struct brcmf_pub
*drvr
,
369 enum brcmf_fweh_event_code code
)
371 brcmf_dbg(TRACE
, "event handler cleared for %s\n",
372 brcmf_fweh_event_name(code
));
373 drvr
->fweh
.evt_handler
[code
] = NULL
;
377 * brcmf_fweh_activate_events() - enables firmware events registered.
379 * @ifp: primary interface object.
381 int brcmf_fweh_activate_events(struct brcmf_if
*ifp
)
384 s8 eventmask
[BRCMF_EVENTING_MASK_LEN
];
386 for (i
= 0; i
< BRCMF_E_LAST
; i
++) {
387 if (ifp
->drvr
->fweh
.evt_handler
[i
]) {
388 brcmf_dbg(EVENT
, "enable event %s\n",
389 brcmf_fweh_event_name(i
));
390 setbit(eventmask
, i
);
394 /* want to handle IF event as well */
395 brcmf_dbg(EVENT
, "enable event IF\n");
396 setbit(eventmask
, BRCMF_E_IF
);
398 err
= brcmf_fil_iovar_data_set(ifp
, "event_msgs",
399 eventmask
, BRCMF_EVENTING_MASK_LEN
);
401 brcmf_err("Set event_msgs error (%d)\n", err
);
407 * brcmf_fweh_process_event() - process skb as firmware event.
409 * @drvr: driver information object.
410 * @event_packet: event packet to process.
412 * If the packet buffer contains a firmware event message it will
413 * dispatch the event to a registered handler (using worker).
415 void brcmf_fweh_process_event(struct brcmf_pub
*drvr
,
416 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
])
437 alloc_flag
= GFP_ATOMIC
;
439 event
= kzalloc(sizeof(*event
) + datalen
, alloc_flag
);
444 event
->ifidx
= event_packet
->msg
.ifidx
;
446 /* use memcpy to get aligned event message */
447 memcpy(&event
->emsg
, &event_packet
->msg
, sizeof(event
->emsg
));
448 memcpy(event
->data
, data
, datalen
);
449 memcpy(event
->ifaddr
, event_packet
->eth
.h_dest
, ETH_ALEN
);
451 brcmf_fweh_queue_event(fweh
, event
);