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