1 // SPDX-License-Identifier: ISC
3 * Copyright (c) 2012 Broadcom Corporation
5 #include <linux/netdevice.h>
7 #include "brcmu_wifi.h"
8 #include "brcmu_utils.h"
13 #include "tracepoint.h"
19 * struct brcmf_fweh_queue_item - event item on event queue.
21 * @q: list element for queuing.
23 * @ifidx: interface index related to this event.
24 * @ifaddr: ethernet address for interface.
25 * @emsg: common parameters of the firmware event message.
26 * @data: event specific data part of the firmware event.
28 struct brcmf_fweh_queue_item {
30 enum brcmf_fweh_event_code code;
33 struct brcmf_event_msg_be emsg;
39 * struct brcmf_fweh_event_name - code, name mapping entry.
41 struct brcmf_fweh_event_name {
42 enum brcmf_fweh_event_code code;
47 #define BRCMF_ENUM_DEF(id, val) \
50 /* array for mapping code to event name */
51 static struct brcmf_fweh_event_name fweh_event_names[] = {
52 BRCMF_FWEH_EVENT_ENUM_DEFLIST
57 * brcmf_fweh_event_name() - returns name for given event code.
59 * @code: code to lookup.
61 const char *brcmf_fweh_event_name(enum brcmf_fweh_event_code code)
64 for (i = 0; i < ARRAY_SIZE(fweh_event_names); i++) {
65 if (fweh_event_names[i].code == code)
66 return fweh_event_names[i].name;
71 const char *brcmf_fweh_event_name(enum brcmf_fweh_event_code code)
78 * brcmf_fweh_queue_event() - create and queue event.
80 * @fweh: firmware event handling info.
81 * @event: event queue entry.
83 static void brcmf_fweh_queue_event(struct brcmf_fweh_info *fweh,
84 struct brcmf_fweh_queue_item *event)
88 spin_lock_irqsave(&fweh->evt_q_lock, flags);
89 list_add_tail(&event->q, &fweh->event_q);
90 spin_unlock_irqrestore(&fweh->evt_q_lock, flags);
91 schedule_work(&fweh->event_work);
94 static int brcmf_fweh_call_event_handler(struct brcmf_pub *drvr,
96 enum brcmf_fweh_event_code code,
97 struct brcmf_event_msg *emsg,
100 struct brcmf_fweh_info *fweh;
104 fweh = &ifp->drvr->fweh;
106 /* handle the event if valid interface and handler */
107 if (fweh->evt_handler[code])
108 err = fweh->evt_handler[code](ifp, emsg, data);
110 bphy_err(drvr, "unhandled event %d ignored\n", code);
112 bphy_err(drvr, "no interface object\n");
118 * brcmf_fweh_handle_if_event() - handle IF event.
120 * @drvr: driver information object.
121 * @item: queue entry.
122 * @ifpp: interface object (may change upon ADD action).
124 static void brcmf_fweh_handle_if_event(struct brcmf_pub *drvr,
125 struct brcmf_event_msg *emsg,
128 struct brcmf_if_event *ifevent = data;
129 struct brcmf_if *ifp;
133 brcmf_dbg(EVENT, "action: %u ifidx: %u bsscfgidx: %u flags: %u role: %u\n",
134 ifevent->action, ifevent->ifidx, ifevent->bsscfgidx,
135 ifevent->flags, ifevent->role);
137 /* The P2P Device interface event must not be ignored contrary to what
138 * firmware tells us. Older firmware uses p2p noif, with sta role.
139 * This should be accepted when p2pdev_setup is ongoing. TDLS setup will
140 * use the same ifevent and should be ignored.
142 is_p2pdev = ((ifevent->flags & BRCMF_E_IF_FLAG_NOIF) &&
143 (ifevent->role == BRCMF_E_IF_ROLE_P2P_CLIENT ||
144 ((ifevent->role == BRCMF_E_IF_ROLE_STA) &&
145 (drvr->fweh.p2pdev_setup_ongoing))));
146 if (!is_p2pdev && (ifevent->flags & BRCMF_E_IF_FLAG_NOIF)) {
147 brcmf_dbg(EVENT, "event can be ignored\n");
150 if (ifevent->ifidx >= BRCMF_MAX_IFS) {
151 bphy_err(drvr, "invalid interface index: %u\n", ifevent->ifidx);
155 ifp = drvr->iflist[ifevent->bsscfgidx];
157 if (ifevent->action == BRCMF_E_IF_ADD) {
158 brcmf_dbg(EVENT, "adding %s (%pM)\n", emsg->ifname,
160 ifp = brcmf_add_if(drvr, ifevent->bsscfgidx, ifevent->ifidx,
161 is_p2pdev, emsg->ifname, emsg->addr);
165 brcmf_proto_add_if(drvr, ifp);
166 if (!drvr->fweh.evt_handler[BRCMF_E_IF])
167 if (brcmf_net_attach(ifp, false) < 0)
171 if (ifp && ifevent->action == BRCMF_E_IF_CHANGE)
172 brcmf_proto_reset_if(drvr, ifp);
174 err = brcmf_fweh_call_event_handler(drvr, ifp, emsg->event_code, emsg,
177 if (ifp && ifevent->action == BRCMF_E_IF_DEL) {
178 bool armed = brcmf_cfg80211_vif_event_armed(drvr->config);
180 /* Default handling in case no-one waits for this event */
182 brcmf_remove_interface(ifp, false);
187 * brcmf_fweh_dequeue_event() - get event from the queue.
189 * @fweh: firmware event handling info.
191 static struct brcmf_fweh_queue_item *
192 brcmf_fweh_dequeue_event(struct brcmf_fweh_info *fweh)
194 struct brcmf_fweh_queue_item *event = NULL;
197 spin_lock_irqsave(&fweh->evt_q_lock, flags);
198 if (!list_empty(&fweh->event_q)) {
199 event = list_first_entry(&fweh->event_q,
200 struct brcmf_fweh_queue_item, q);
203 spin_unlock_irqrestore(&fweh->evt_q_lock, flags);
209 * brcmf_fweh_event_worker() - firmware event worker.
211 * @work: worker object.
213 static void brcmf_fweh_event_worker(struct work_struct *work)
215 struct brcmf_pub *drvr;
216 struct brcmf_if *ifp;
217 struct brcmf_fweh_info *fweh;
218 struct brcmf_fweh_queue_item *event;
220 struct brcmf_event_msg_be *emsg_be;
221 struct brcmf_event_msg emsg;
223 fweh = container_of(work, struct brcmf_fweh_info, event_work);
224 drvr = container_of(fweh, struct brcmf_pub, fweh);
226 while ((event = brcmf_fweh_dequeue_event(fweh))) {
227 brcmf_dbg(EVENT, "event %s (%u) ifidx %u bsscfg %u addr %pM\n",
228 brcmf_fweh_event_name(event->code), event->code,
229 event->emsg.ifidx, event->emsg.bsscfgidx,
232 /* convert event message */
233 emsg_be = &event->emsg;
234 emsg.version = be16_to_cpu(emsg_be->version);
235 emsg.flags = be16_to_cpu(emsg_be->flags);
236 emsg.event_code = event->code;
237 emsg.status = be32_to_cpu(emsg_be->status);
238 emsg.reason = be32_to_cpu(emsg_be->reason);
239 emsg.auth_type = be32_to_cpu(emsg_be->auth_type);
240 emsg.datalen = be32_to_cpu(emsg_be->datalen);
241 memcpy(emsg.addr, emsg_be->addr, ETH_ALEN);
242 memcpy(emsg.ifname, emsg_be->ifname, sizeof(emsg.ifname));
243 emsg.ifidx = emsg_be->ifidx;
244 emsg.bsscfgidx = emsg_be->bsscfgidx;
246 brcmf_dbg(EVENT, " version %u flags %u status %u reason %u\n",
247 emsg.version, emsg.flags, emsg.status, emsg.reason);
248 brcmf_dbg_hex_dump(BRCMF_EVENT_ON(), event->data,
249 min_t(u32, emsg.datalen, 64),
250 "event payload, len=%d\n", emsg.datalen);
252 /* special handling of interface event */
253 if (event->code == BRCMF_E_IF) {
254 brcmf_fweh_handle_if_event(drvr, &emsg, event->data);
258 if (event->code == BRCMF_E_TDLS_PEER_EVENT)
259 ifp = drvr->iflist[0];
261 ifp = drvr->iflist[emsg.bsscfgidx];
262 err = brcmf_fweh_call_event_handler(drvr, ifp, event->code,
265 bphy_err(drvr, "event handler failed (%d)\n",
275 * brcmf_fweh_p2pdev_setup() - P2P device setup ongoing (or not).
277 * @ifp: ifp on which setup is taking place or finished.
278 * @ongoing: p2p device setup in progress (or not).
280 void brcmf_fweh_p2pdev_setup(struct brcmf_if *ifp, bool ongoing)
282 ifp->drvr->fweh.p2pdev_setup_ongoing = ongoing;
286 * brcmf_fweh_attach() - initialize firmware event handling.
288 * @drvr: driver information object.
290 void brcmf_fweh_attach(struct brcmf_pub *drvr)
292 struct brcmf_fweh_info *fweh = &drvr->fweh;
293 INIT_WORK(&fweh->event_work, brcmf_fweh_event_worker);
294 spin_lock_init(&fweh->evt_q_lock);
295 INIT_LIST_HEAD(&fweh->event_q);
299 * brcmf_fweh_detach() - cleanup firmware event handling.
301 * @drvr: driver information object.
303 void brcmf_fweh_detach(struct brcmf_pub *drvr)
305 struct brcmf_fweh_info *fweh = &drvr->fweh;
307 /* cancel the worker */
308 cancel_work_sync(&fweh->event_work);
309 WARN_ON(!list_empty(&fweh->event_q));
310 memset(fweh->evt_handler, 0, sizeof(fweh->evt_handler));
314 * brcmf_fweh_register() - register handler for given event code.
316 * @drvr: driver information object.
318 * @handler: handler for the given event code.
320 int brcmf_fweh_register(struct brcmf_pub *drvr, enum brcmf_fweh_event_code code,
321 brcmf_fweh_handler_t handler)
323 if (drvr->fweh.evt_handler[code]) {
324 bphy_err(drvr, "event code %d already registered\n", code);
327 drvr->fweh.evt_handler[code] = handler;
328 brcmf_dbg(TRACE, "event handler registered for %s\n",
329 brcmf_fweh_event_name(code));
334 * brcmf_fweh_unregister() - remove handler for given code.
336 * @drvr: driver information object.
339 void brcmf_fweh_unregister(struct brcmf_pub *drvr,
340 enum brcmf_fweh_event_code code)
342 brcmf_dbg(TRACE, "event handler cleared for %s\n",
343 brcmf_fweh_event_name(code));
344 drvr->fweh.evt_handler[code] = NULL;
348 * brcmf_fweh_activate_events() - enables firmware events registered.
350 * @ifp: primary interface object.
352 int brcmf_fweh_activate_events(struct brcmf_if *ifp)
354 struct brcmf_pub *drvr = ifp->drvr;
356 s8 eventmask[BRCMF_EVENTING_MASK_LEN];
358 memset(eventmask, 0, sizeof(eventmask));
359 for (i = 0; i < BRCMF_E_LAST; i++) {
360 if (ifp->drvr->fweh.evt_handler[i]) {
361 brcmf_dbg(EVENT, "enable event %s\n",
362 brcmf_fweh_event_name(i));
363 setbit(eventmask, i);
367 /* want to handle IF event as well */
368 brcmf_dbg(EVENT, "enable event IF\n");
369 setbit(eventmask, BRCMF_E_IF);
371 err = brcmf_fil_iovar_data_set(ifp, "event_msgs",
372 eventmask, BRCMF_EVENTING_MASK_LEN);
374 bphy_err(drvr, "Set event_msgs error (%d)\n", err);
380 * brcmf_fweh_process_event() - process skb as firmware event.
382 * @drvr: driver information object.
383 * @event_packet: event packet to process.
385 * If the packet buffer contains a firmware event message it will
386 * dispatch the event to a registered handler (using worker).
388 void brcmf_fweh_process_event(struct brcmf_pub *drvr,
389 struct brcmf_event *event_packet,
392 enum brcmf_fweh_event_code code;
393 struct brcmf_fweh_info *fweh = &drvr->fweh;
394 struct brcmf_fweh_queue_item *event;
395 gfp_t alloc_flag = GFP_KERNEL;
400 code = get_unaligned_be32(&event_packet->msg.event_type);
401 datalen = get_unaligned_be32(&event_packet->msg.datalen);
402 data = &event_packet[1];
404 if (code >= BRCMF_E_LAST)
407 if (code != BRCMF_E_IF && !fweh->evt_handler[code])
410 if (datalen > BRCMF_DCMD_MAXLEN ||
411 datalen + sizeof(*event_packet) > packet_len)
415 alloc_flag = GFP_ATOMIC;
417 event = kzalloc(sizeof(*event) + datalen, alloc_flag);
422 event->ifidx = event_packet->msg.ifidx;
424 /* use memcpy to get aligned event message */
425 memcpy(&event->emsg, &event_packet->msg, sizeof(event->emsg));
426 memcpy(event->data, data, datalen);
427 event->datalen = datalen;
428 memcpy(event->ifaddr, event_packet->eth.h_dest, ETH_ALEN);
430 brcmf_fweh_queue_event(fweh, event);