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 AS |
187 | |
188 | if (ifevent->ifidx >= BRCMF_MAX_IFS) { | |
5e8149f5 | 189 | brcmf_err("invalid interface index: %u\n", |
5c36b99a | 190 | ifevent->ifidx); |
3e0a97e1 | 191 | return; |
5c36b99a AS |
192 | } |
193 | ||
2880b868 | 194 | ifp = drvr->iflist[ifevent->bssidx]; |
3e0a97e1 AS |
195 | |
196 | if (ifevent->action == BRCMF_E_IF_ADD) { | |
197 | brcmf_dbg(EVENT, "adding %s (%pM)\n", emsg->ifname, | |
198 | emsg->addr); | |
2880b868 | 199 | ifp = brcmf_add_if(drvr, ifevent->bssidx, ifevent->ifidx, |
3e0a97e1 AS |
200 | emsg->ifname, emsg->addr); |
201 | if (IS_ERR(ifp)) | |
202 | return; | |
bb8c8063 | 203 | brcmf_fws_add_interface(ifp); |
3e0a97e1 | 204 | if (!drvr->fweh.evt_handler[BRCMF_E_IF]) |
9390ace9 AS |
205 | if (brcmf_net_attach(ifp, false) < 0) |
206 | return; | |
5c36b99a | 207 | } |
3e0a97e1 | 208 | |
bb8c8063 AS |
209 | if (ifevent->action == BRCMF_E_IF_CHANGE) |
210 | brcmf_fws_reset_interface(ifp); | |
211 | ||
3e0a97e1 AS |
212 | err = brcmf_fweh_call_event_handler(ifp, emsg->event_code, emsg, data); |
213 | ||
bb8c8063 AS |
214 | if (ifevent->action == BRCMF_E_IF_DEL) { |
215 | brcmf_fws_del_interface(ifp); | |
2880b868 | 216 | brcmf_del_if(drvr, ifevent->bssidx); |
bb8c8063 | 217 | } |
5c36b99a AS |
218 | } |
219 | ||
220 | /** | |
221 | * brcmf_fweh_dequeue_event() - get event from the queue. | |
222 | * | |
223 | * @fweh: firmware event handling info. | |
224 | */ | |
225 | static struct brcmf_fweh_queue_item * | |
226 | brcmf_fweh_dequeue_event(struct brcmf_fweh_info *fweh) | |
227 | { | |
228 | struct brcmf_fweh_queue_item *event = NULL; | |
229 | ulong flags; | |
230 | ||
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); | |
235 | list_del(&event->q); | |
236 | } | |
237 | spin_unlock_irqrestore(&fweh->evt_q_lock, flags); | |
238 | ||
239 | return event; | |
240 | } | |
241 | ||
242 | /** | |
243 | * brcmf_fweh_event_worker() - firmware event worker. | |
244 | * | |
245 | * @work: worker object. | |
246 | */ | |
247 | static void brcmf_fweh_event_worker(struct work_struct *work) | |
248 | { | |
249 | struct brcmf_pub *drvr; | |
250 | struct brcmf_if *ifp; | |
251 | struct brcmf_fweh_info *fweh; | |
252 | struct brcmf_fweh_queue_item *event; | |
253 | int err = 0; | |
254 | struct brcmf_event_msg_be *emsg_be; | |
255 | struct brcmf_event_msg emsg; | |
256 | ||
257 | fweh = container_of(work, struct brcmf_fweh_info, event_work); | |
258 | drvr = container_of(fweh, struct brcmf_pub, fweh); | |
259 | ||
260 | while ((event = brcmf_fweh_dequeue_event(fweh))) { | |
1b4e027e | 261 | brcmf_dbg(EVENT, "event %s (%u) ifidx %u bsscfg %u addr %pM\n", |
5c36b99a AS |
262 | brcmf_fweh_event_name(event->code), event->code, |
263 | event->emsg.ifidx, event->emsg.bsscfgidx, | |
264 | event->emsg.addr); | |
265 | ||
5c36b99a AS |
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; | |
279 | ||
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), | |
1b4e027e | 284 | "event payload, len=%d\n", emsg.datalen); |
5c36b99a | 285 | |
3e0a97e1 AS |
286 | /* special handling of interface event */ |
287 | if (event->code == BRCMF_E_IF) { | |
288 | brcmf_fweh_handle_if_event(drvr, &emsg, event->data); | |
289 | goto event_free; | |
290 | } | |
291 | ||
2880b868 | 292 | ifp = drvr->iflist[emsg.bsscfgidx]; |
3e0a97e1 AS |
293 | err = brcmf_fweh_call_event_handler(ifp, event->code, &emsg, |
294 | event->data); | |
5c36b99a | 295 | if (err) { |
5e8149f5 | 296 | brcmf_err("event handler failed (%d)\n", |
5c36b99a AS |
297 | event->code); |
298 | err = 0; | |
299 | } | |
300 | event_free: | |
301 | kfree(event); | |
302 | } | |
303 | } | |
304 | ||
305 | /** | |
306 | * brcmf_fweh_attach() - initialize firmware event handling. | |
307 | * | |
308 | * @drvr: driver information object. | |
309 | */ | |
310 | void brcmf_fweh_attach(struct brcmf_pub *drvr) | |
311 | { | |
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); | |
316 | } | |
317 | ||
318 | /** | |
319 | * brcmf_fweh_detach() - cleanup firmware event handling. | |
320 | * | |
321 | * @drvr: driver information object. | |
322 | */ | |
323 | void brcmf_fweh_detach(struct brcmf_pub *drvr) | |
324 | { | |
325 | struct brcmf_fweh_info *fweh = &drvr->fweh; | |
326 | struct brcmf_if *ifp = drvr->iflist[0]; | |
327 | s8 eventmask[BRCMF_EVENTING_MASK_LEN]; | |
328 | ||
df19e777 HM |
329 | if (ifp) { |
330 | /* clear all events */ | |
331 | memset(eventmask, 0, BRCMF_EVENTING_MASK_LEN); | |
332 | (void)brcmf_fil_iovar_data_set(ifp, "event_msgs", | |
333 | eventmask, | |
334 | BRCMF_EVENTING_MASK_LEN); | |
335 | } | |
5c36b99a AS |
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)); | |
340 | } | |
341 | ||
342 | /** | |
343 | * brcmf_fweh_register() - register handler for given event code. | |
344 | * | |
345 | * @drvr: driver information object. | |
346 | * @code: event code. | |
347 | * @handler: handler for the given event code. | |
348 | */ | |
349 | int brcmf_fweh_register(struct brcmf_pub *drvr, enum brcmf_fweh_event_code code, | |
350 | brcmf_fweh_handler_t handler) | |
351 | { | |
352 | if (drvr->fweh.evt_handler[code]) { | |
5e8149f5 | 353 | brcmf_err("event code %d already registered\n", code); |
5c36b99a AS |
354 | return -ENOSPC; |
355 | } | |
356 | drvr->fweh.evt_handler[code] = handler; | |
b522dd80 AS |
357 | brcmf_dbg(TRACE, "event handler registered for %s\n", |
358 | brcmf_fweh_event_name(code)); | |
5c36b99a AS |
359 | return 0; |
360 | } | |
361 | ||
362 | /** | |
363 | * brcmf_fweh_unregister() - remove handler for given code. | |
364 | * | |
365 | * @drvr: driver information object. | |
366 | * @code: event code. | |
367 | */ | |
368 | void brcmf_fweh_unregister(struct brcmf_pub *drvr, | |
369 | enum brcmf_fweh_event_code code) | |
370 | { | |
b522dd80 AS |
371 | brcmf_dbg(TRACE, "event handler cleared for %s\n", |
372 | brcmf_fweh_event_name(code)); | |
5c36b99a AS |
373 | drvr->fweh.evt_handler[code] = NULL; |
374 | } | |
375 | ||
376 | /** | |
377 | * brcmf_fweh_activate_events() - enables firmware events registered. | |
378 | * | |
379 | * @ifp: primary interface object. | |
380 | */ | |
381 | int brcmf_fweh_activate_events(struct brcmf_if *ifp) | |
382 | { | |
383 | int i, err; | |
384 | s8 eventmask[BRCMF_EVENTING_MASK_LEN]; | |
385 | ||
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); | |
391 | } | |
392 | } | |
393 | ||
394 | /* want to handle IF event as well */ | |
b522dd80 | 395 | brcmf_dbg(EVENT, "enable event IF\n"); |
5c36b99a AS |
396 | setbit(eventmask, BRCMF_E_IF); |
397 | ||
398 | err = brcmf_fil_iovar_data_set(ifp, "event_msgs", | |
399 | eventmask, BRCMF_EVENTING_MASK_LEN); | |
400 | if (err) | |
5e8149f5 | 401 | brcmf_err("Set event_msgs error (%d)\n", err); |
5c36b99a AS |
402 | |
403 | return err; | |
404 | } | |
405 | ||
406 | /** | |
407 | * brcmf_fweh_process_event() - process skb as firmware event. | |
408 | * | |
409 | * @drvr: driver information object. | |
410 | * @event_packet: event packet to process. | |
5c36b99a AS |
411 | * |
412 | * If the packet buffer contains a firmware event message it will | |
413 | * dispatch the event to a registered handler (using worker). | |
414 | */ | |
415 | void brcmf_fweh_process_event(struct brcmf_pub *drvr, | |
deb09280 | 416 | struct brcmf_event *event_packet) |
5c36b99a AS |
417 | { |
418 | enum brcmf_fweh_event_code code; | |
607d5c0e AS |
419 | struct brcmf_fweh_info *fweh = &drvr->fweh; |
420 | struct brcmf_fweh_queue_item *event; | |
421 | gfp_t alloc_flag = GFP_KERNEL; | |
422 | void *data; | |
423 | u32 datalen; | |
5c36b99a | 424 | |
607d5c0e | 425 | /* get event info */ |
5c36b99a | 426 | code = get_unaligned_be32(&event_packet->msg.event_type); |
607d5c0e | 427 | datalen = get_unaligned_be32(&event_packet->msg.datalen); |
607d5c0e AS |
428 | data = &event_packet[1]; |
429 | ||
3e0a97e1 AS |
430 | if (code >= BRCMF_E_LAST) |
431 | return; | |
432 | ||
433 | if (code != BRCMF_E_IF && !fweh->evt_handler[code]) | |
607d5c0e | 434 | return; |
607d5c0e AS |
435 | |
436 | if (in_interrupt()) | |
437 | alloc_flag = GFP_ATOMIC; | |
438 | ||
439 | event = kzalloc(sizeof(*event) + datalen, alloc_flag); | |
5b15d0f4 JL |
440 | if (!event) |
441 | return; | |
442 | ||
607d5c0e | 443 | event->code = code; |
deb09280 | 444 | event->ifidx = event_packet->msg.ifidx; |
607d5c0e AS |
445 | |
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); | |
5c36b99a | 450 | |
607d5c0e | 451 | brcmf_fweh_queue_event(fweh, event); |
5c36b99a | 452 | } |