Commit | Line | Data |
---|---|---|
5c36b99a AS |
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 | ||
5c36b99a AS |
18 | #include "brcmu_wifi.h" |
19 | #include "brcmu_utils.h" | |
20 | ||
21 | #include "dhd.h" | |
22 | #include "dhd_dbg.h" | |
40c1c249 | 23 | #include "tracepoint.h" |
bb8c8063 | 24 | #include "fwsignal.h" |
5c36b99a AS |
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 | |
dc5cbdfd AS |
100 | #define BRCMF_ENUM_DEF(id, val) \ |
101 | { val, #id }, | |
102 | ||
5c36b99a AS |
103 | /* array for mapping code to event name */ |
104 | static struct brcmf_fweh_event_name fweh_event_names[] = { | |
dc5cbdfd | 105 | BRCMF_FWEH_EVENT_ENUM_DEFLIST |
5c36b99a | 106 | }; |
dc5cbdfd | 107 | #undef BRCMF_ENUM_DEF |
5c36b99a AS |
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 | * | |
607d5c0e AS |
133 | * @fweh: firmware event handling info. |
134 | * @event: event queue entry. | |
5c36b99a | 135 | */ |
607d5c0e AS |
136 | static void brcmf_fweh_queue_event(struct brcmf_fweh_info *fweh, |
137 | struct brcmf_fweh_queue_item *event) | |
5c36b99a | 138 | { |
5c36b99a | 139 | ulong flags; |
5c36b99a AS |
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 | ||
3e0a97e1 AS |
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 */ | |
5857f9c6 | 159 | if (fweh->evt_handler[code]) |
3e0a97e1 AS |
160 | err = fweh->evt_handler[code](ifp, emsg, data); |
161 | else | |
5e8149f5 | 162 | brcmf_err("unhandled event %d ignored\n", code); |
3e0a97e1 | 163 | } else { |
5e8149f5 | 164 | brcmf_err("no interface object\n"); |
3e0a97e1 AS |
165 | } |
166 | return err; | |
167 | } | |
168 | ||
5c36b99a | 169 | /** |
3e0a97e1 | 170 | * brcmf_fweh_handle_if_event() - handle IF event. |
5c36b99a AS |
171 | * |
172 | * @drvr: driver information object. | |
173 | * @item: queue entry. | |
174 | * @ifpp: interface object (may change upon ADD action). | |
175 | */ | |
3e0a97e1 AS |
176 | static void brcmf_fweh_handle_if_event(struct brcmf_pub *drvr, |
177 | struct brcmf_event_msg *emsg, | |
178 | void *data) | |
5c36b99a | 179 | { |
3e0a97e1 | 180 | struct brcmf_if_event *ifevent = data; |
5c36b99a AS |
181 | struct brcmf_if *ifp; |
182 | int err = 0; | |
183 | ||
8fdd1578 AS |
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); | |
5c36b99a | 187 | |
2ee8382f AS |
188 | if (ifevent->flags & BRCMF_E_IF_FLAG_NOIF) { |
189 | brcmf_dbg(EVENT, "event can be ignored\n"); | |
190 | return; | |
191 | } | |
5c36b99a | 192 | if (ifevent->ifidx >= BRCMF_MAX_IFS) { |
5e8149f5 | 193 | brcmf_err("invalid interface index: %u\n", |
5c36b99a | 194 | ifevent->ifidx); |
3e0a97e1 | 195 | return; |
5c36b99a AS |
196 | } |
197 | ||
2880b868 | 198 | ifp = drvr->iflist[ifevent->bssidx]; |
3e0a97e1 AS |
199 | |
200 | if (ifevent->action == BRCMF_E_IF_ADD) { | |
201 | brcmf_dbg(EVENT, "adding %s (%pM)\n", emsg->ifname, | |
202 | emsg->addr); | |
2880b868 | 203 | ifp = brcmf_add_if(drvr, ifevent->bssidx, ifevent->ifidx, |
3e0a97e1 AS |
204 | emsg->ifname, emsg->addr); |
205 | if (IS_ERR(ifp)) | |
206 | return; | |
bb8c8063 | 207 | brcmf_fws_add_interface(ifp); |
3e0a97e1 | 208 | if (!drvr->fweh.evt_handler[BRCMF_E_IF]) |
9390ace9 AS |
209 | if (brcmf_net_attach(ifp, false) < 0) |
210 | return; | |
5c36b99a | 211 | } |
3e0a97e1 | 212 | |
bb8c8063 AS |
213 | if (ifevent->action == BRCMF_E_IF_CHANGE) |
214 | brcmf_fws_reset_interface(ifp); | |
215 | ||
3e0a97e1 AS |
216 | err = brcmf_fweh_call_event_handler(ifp, emsg->event_code, emsg, data); |
217 | ||
bb8c8063 AS |
218 | if (ifevent->action == BRCMF_E_IF_DEL) { |
219 | brcmf_fws_del_interface(ifp); | |
2880b868 | 220 | brcmf_del_if(drvr, ifevent->bssidx); |
bb8c8063 | 221 | } |
5c36b99a AS |
222 | } |
223 | ||
224 | /** | |
225 | * brcmf_fweh_dequeue_event() - get event from the queue. | |
226 | * | |
227 | * @fweh: firmware event handling info. | |
228 | */ | |
229 | static struct brcmf_fweh_queue_item * | |
230 | brcmf_fweh_dequeue_event(struct brcmf_fweh_info *fweh) | |
231 | { | |
232 | struct brcmf_fweh_queue_item *event = NULL; | |
233 | ulong flags; | |
234 | ||
235 | spin_lock_irqsave(&fweh->evt_q_lock, flags); | |
236 | if (!list_empty(&fweh->event_q)) { | |
237 | event = list_first_entry(&fweh->event_q, | |
238 | struct brcmf_fweh_queue_item, q); | |
239 | list_del(&event->q); | |
240 | } | |
241 | spin_unlock_irqrestore(&fweh->evt_q_lock, flags); | |
242 | ||
243 | return event; | |
244 | } | |
245 | ||
246 | /** | |
247 | * brcmf_fweh_event_worker() - firmware event worker. | |
248 | * | |
249 | * @work: worker object. | |
250 | */ | |
251 | static void brcmf_fweh_event_worker(struct work_struct *work) | |
252 | { | |
253 | struct brcmf_pub *drvr; | |
254 | struct brcmf_if *ifp; | |
255 | struct brcmf_fweh_info *fweh; | |
256 | struct brcmf_fweh_queue_item *event; | |
257 | int err = 0; | |
258 | struct brcmf_event_msg_be *emsg_be; | |
259 | struct brcmf_event_msg emsg; | |
260 | ||
261 | fweh = container_of(work, struct brcmf_fweh_info, event_work); | |
262 | drvr = container_of(fweh, struct brcmf_pub, fweh); | |
263 | ||
264 | while ((event = brcmf_fweh_dequeue_event(fweh))) { | |
1b4e027e | 265 | brcmf_dbg(EVENT, "event %s (%u) ifidx %u bsscfg %u addr %pM\n", |
5c36b99a AS |
266 | brcmf_fweh_event_name(event->code), event->code, |
267 | event->emsg.ifidx, event->emsg.bsscfgidx, | |
268 | event->emsg.addr); | |
269 | ||
5c36b99a AS |
270 | /* convert event message */ |
271 | emsg_be = &event->emsg; | |
272 | emsg.version = be16_to_cpu(emsg_be->version); | |
273 | emsg.flags = be16_to_cpu(emsg_be->flags); | |
274 | emsg.event_code = event->code; | |
275 | emsg.status = be32_to_cpu(emsg_be->status); | |
276 | emsg.reason = be32_to_cpu(emsg_be->reason); | |
277 | emsg.auth_type = be32_to_cpu(emsg_be->auth_type); | |
278 | emsg.datalen = be32_to_cpu(emsg_be->datalen); | |
279 | memcpy(emsg.addr, emsg_be->addr, ETH_ALEN); | |
280 | memcpy(emsg.ifname, emsg_be->ifname, sizeof(emsg.ifname)); | |
281 | emsg.ifidx = emsg_be->ifidx; | |
282 | emsg.bsscfgidx = emsg_be->bsscfgidx; | |
283 | ||
284 | brcmf_dbg(EVENT, " version %u flags %u status %u reason %u\n", | |
285 | emsg.version, emsg.flags, emsg.status, emsg.reason); | |
286 | brcmf_dbg_hex_dump(BRCMF_EVENT_ON(), event->data, | |
287 | min_t(u32, emsg.datalen, 64), | |
1b4e027e | 288 | "event payload, len=%d\n", emsg.datalen); |
5c36b99a | 289 | |
3e0a97e1 AS |
290 | /* special handling of interface event */ |
291 | if (event->code == BRCMF_E_IF) { | |
292 | brcmf_fweh_handle_if_event(drvr, &emsg, event->data); | |
293 | goto event_free; | |
294 | } | |
295 | ||
2880b868 | 296 | ifp = drvr->iflist[emsg.bsscfgidx]; |
3e0a97e1 AS |
297 | err = brcmf_fweh_call_event_handler(ifp, event->code, &emsg, |
298 | event->data); | |
5c36b99a | 299 | if (err) { |
5e8149f5 | 300 | brcmf_err("event handler failed (%d)\n", |
5c36b99a AS |
301 | event->code); |
302 | err = 0; | |
303 | } | |
304 | event_free: | |
305 | kfree(event); | |
306 | } | |
307 | } | |
308 | ||
309 | /** | |
310 | * brcmf_fweh_attach() - initialize firmware event handling. | |
311 | * | |
312 | * @drvr: driver information object. | |
313 | */ | |
314 | void brcmf_fweh_attach(struct brcmf_pub *drvr) | |
315 | { | |
316 | struct brcmf_fweh_info *fweh = &drvr->fweh; | |
317 | INIT_WORK(&fweh->event_work, brcmf_fweh_event_worker); | |
318 | spin_lock_init(&fweh->evt_q_lock); | |
319 | INIT_LIST_HEAD(&fweh->event_q); | |
320 | } | |
321 | ||
322 | /** | |
323 | * brcmf_fweh_detach() - cleanup firmware event handling. | |
324 | * | |
325 | * @drvr: driver information object. | |
326 | */ | |
327 | void brcmf_fweh_detach(struct brcmf_pub *drvr) | |
328 | { | |
329 | struct brcmf_fweh_info *fweh = &drvr->fweh; | |
330 | struct brcmf_if *ifp = drvr->iflist[0]; | |
331 | s8 eventmask[BRCMF_EVENTING_MASK_LEN]; | |
332 | ||
df19e777 HM |
333 | if (ifp) { |
334 | /* clear all events */ | |
335 | memset(eventmask, 0, BRCMF_EVENTING_MASK_LEN); | |
336 | (void)brcmf_fil_iovar_data_set(ifp, "event_msgs", | |
337 | eventmask, | |
338 | BRCMF_EVENTING_MASK_LEN); | |
339 | } | |
5c36b99a AS |
340 | /* cancel the worker */ |
341 | cancel_work_sync(&fweh->event_work); | |
342 | WARN_ON(!list_empty(&fweh->event_q)); | |
343 | memset(fweh->evt_handler, 0, sizeof(fweh->evt_handler)); | |
344 | } | |
345 | ||
346 | /** | |
347 | * brcmf_fweh_register() - register handler for given event code. | |
348 | * | |
349 | * @drvr: driver information object. | |
350 | * @code: event code. | |
351 | * @handler: handler for the given event code. | |
352 | */ | |
353 | int brcmf_fweh_register(struct brcmf_pub *drvr, enum brcmf_fweh_event_code code, | |
354 | brcmf_fweh_handler_t handler) | |
355 | { | |
356 | if (drvr->fweh.evt_handler[code]) { | |
5e8149f5 | 357 | brcmf_err("event code %d already registered\n", code); |
5c36b99a AS |
358 | return -ENOSPC; |
359 | } | |
360 | drvr->fweh.evt_handler[code] = handler; | |
b522dd80 AS |
361 | brcmf_dbg(TRACE, "event handler registered for %s\n", |
362 | brcmf_fweh_event_name(code)); | |
5c36b99a AS |
363 | return 0; |
364 | } | |
365 | ||
366 | /** | |
367 | * brcmf_fweh_unregister() - remove handler for given code. | |
368 | * | |
369 | * @drvr: driver information object. | |
370 | * @code: event code. | |
371 | */ | |
372 | void brcmf_fweh_unregister(struct brcmf_pub *drvr, | |
373 | enum brcmf_fweh_event_code code) | |
374 | { | |
b522dd80 AS |
375 | brcmf_dbg(TRACE, "event handler cleared for %s\n", |
376 | brcmf_fweh_event_name(code)); | |
5c36b99a AS |
377 | drvr->fweh.evt_handler[code] = NULL; |
378 | } | |
379 | ||
380 | /** | |
381 | * brcmf_fweh_activate_events() - enables firmware events registered. | |
382 | * | |
383 | * @ifp: primary interface object. | |
384 | */ | |
385 | int brcmf_fweh_activate_events(struct brcmf_if *ifp) | |
386 | { | |
387 | int i, err; | |
388 | s8 eventmask[BRCMF_EVENTING_MASK_LEN]; | |
389 | ||
390 | for (i = 0; i < BRCMF_E_LAST; i++) { | |
391 | if (ifp->drvr->fweh.evt_handler[i]) { | |
392 | brcmf_dbg(EVENT, "enable event %s\n", | |
393 | brcmf_fweh_event_name(i)); | |
394 | setbit(eventmask, i); | |
395 | } | |
396 | } | |
397 | ||
398 | /* want to handle IF event as well */ | |
b522dd80 | 399 | brcmf_dbg(EVENT, "enable event IF\n"); |
5c36b99a AS |
400 | setbit(eventmask, BRCMF_E_IF); |
401 | ||
402 | err = brcmf_fil_iovar_data_set(ifp, "event_msgs", | |
403 | eventmask, BRCMF_EVENTING_MASK_LEN); | |
404 | if (err) | |
5e8149f5 | 405 | brcmf_err("Set event_msgs error (%d)\n", err); |
5c36b99a AS |
406 | |
407 | return err; | |
408 | } | |
409 | ||
410 | /** | |
411 | * brcmf_fweh_process_event() - process skb as firmware event. | |
412 | * | |
413 | * @drvr: driver information object. | |
414 | * @event_packet: event packet to process. | |
5c36b99a AS |
415 | * |
416 | * If the packet buffer contains a firmware event message it will | |
417 | * dispatch the event to a registered handler (using worker). | |
418 | */ | |
419 | void brcmf_fweh_process_event(struct brcmf_pub *drvr, | |
deb09280 | 420 | struct brcmf_event *event_packet) |
5c36b99a AS |
421 | { |
422 | enum brcmf_fweh_event_code code; | |
607d5c0e AS |
423 | struct brcmf_fweh_info *fweh = &drvr->fweh; |
424 | struct brcmf_fweh_queue_item *event; | |
425 | gfp_t alloc_flag = GFP_KERNEL; | |
426 | void *data; | |
427 | u32 datalen; | |
5c36b99a | 428 | |
607d5c0e | 429 | /* get event info */ |
5c36b99a | 430 | code = get_unaligned_be32(&event_packet->msg.event_type); |
607d5c0e | 431 | datalen = get_unaligned_be32(&event_packet->msg.datalen); |
607d5c0e AS |
432 | data = &event_packet[1]; |
433 | ||
3e0a97e1 AS |
434 | if (code >= BRCMF_E_LAST) |
435 | return; | |
436 | ||
437 | if (code != BRCMF_E_IF && !fweh->evt_handler[code]) | |
607d5c0e | 438 | return; |
607d5c0e AS |
439 | |
440 | if (in_interrupt()) | |
441 | alloc_flag = GFP_ATOMIC; | |
442 | ||
443 | event = kzalloc(sizeof(*event) + datalen, alloc_flag); | |
5b15d0f4 JL |
444 | if (!event) |
445 | return; | |
446 | ||
607d5c0e | 447 | event->code = code; |
deb09280 | 448 | event->ifidx = event_packet->msg.ifidx; |
607d5c0e AS |
449 | |
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 | memcpy(event->ifaddr, event_packet->eth.h_dest, ETH_ALEN); | |
5c36b99a | 454 | |
607d5c0e | 455 | brcmf_fweh_queue_event(fweh, event); |
5c36b99a | 456 | } |