[deliverable/linux.git] / drivers / net / wireless / brcm80211 / brcmfmac / fweh.c

/*
 * Copyright (c) 2012 Broadcom Corporation
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
 * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
 * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */
#include <linux/netdevice.h>

#include "brcmu_wifi.h"
#include "brcmu_utils.h"

#include "dhd.h"
#include "dhd_dbg.h"
#include "tracepoint.h"
#include "fwsignal.h"
#include "fweh.h"
#include "fwil.h"

/**
 * struct brcm_ethhdr - broadcom specific ether header.
 *
 * @subtype: subtype for this packet.
 * @length: TODO: length of appended data.
 * @version: version indication.
 * @oui: OUI of this packet.
 * @usr_subtype: subtype for this OUI.
 */
struct brcm_ethhdr {
	__be16 subtype;
	__be16 length;
	u8 version;
	u8 oui[3];
	__be16 usr_subtype;
} __packed;

struct brcmf_event_msg_be {
	__be16 version;
	__be16 flags;
	__be32 event_type;
	__be32 status;
	__be32 reason;
	__be32 auth_type;
	__be32 datalen;
	u8 addr[ETH_ALEN];
	char ifname[IFNAMSIZ];
	u8 ifidx;
	u8 bsscfgidx;
} __packed;

/**
 * struct brcmf_event - contents of broadcom event packet.
 *
 * @eth: standard ether header.
 * @hdr: broadcom specific ether header.
 * @msg: common part of the actual event message.
 */
struct brcmf_event {
	struct ethhdr eth;
	struct brcm_ethhdr hdr;
	struct brcmf_event_msg_be msg;
} __packed;

/**
 * struct brcmf_fweh_queue_item - event item on event queue.
 *
 * @q: list element for queuing.
 * @code: event code.
 * @ifidx: interface index related to this event.
 * @ifaddr: ethernet address for interface.
 * @emsg: common parameters of the firmware event message.
 * @data: event specific data part of the firmware event.
 */
struct brcmf_fweh_queue_item {
	struct list_head q;
	enum brcmf_fweh_event_code code;
	u8 ifidx;
	u8 ifaddr[ETH_ALEN];
	struct brcmf_event_msg_be emsg;
	u8 data[0];
};

/**
 * struct brcmf_fweh_event_name - code, name mapping entry.
 */
struct brcmf_fweh_event_name {
	enum brcmf_fweh_event_code code;
	const char *name;
};

#ifdef DEBUG
#define BRCMF_ENUM_DEF(id, val) \
	{ val, #id },

/* array for mapping code to event name */
static struct brcmf_fweh_event_name fweh_event_names[] = {
	BRCMF_FWEH_EVENT_ENUM_DEFLIST
};
#undef BRCMF_ENUM_DEF

/**
 * brcmf_fweh_event_name() - returns name for given event code.
 *
 * @code: code to lookup.
 */
static const char *brcmf_fweh_event_name(enum brcmf_fweh_event_code code)
{
	int i;
	for (i = 0; i < ARRAY_SIZE(fweh_event_names); i++) {
		if (fweh_event_names[i].code == code)
			return fweh_event_names[i].name;
	}
	return "unknown";
}
#else
static const char *brcmf_fweh_event_name(enum brcmf_fweh_event_code code)
{
	return "nodebug";
}
#endif

/**
 * brcmf_fweh_queue_event() - create and queue event.
 *
 * @fweh: firmware event handling info.
 * @event: event queue entry.
 */
static void brcmf_fweh_queue_event(struct brcmf_fweh_info *fweh,
				   struct brcmf_fweh_queue_item *event)
{
	ulong flags;

	spin_lock_irqsave(&fweh->evt_q_lock, flags);
	list_add_tail(&event->q, &fweh->event_q);
	spin_unlock_irqrestore(&fweh->evt_q_lock, flags);
	schedule_work(&fweh->event_work);
}

static int brcmf_fweh_call_event_handler(struct brcmf_if *ifp,
					 enum brcmf_fweh_event_code code,
					 struct brcmf_event_msg *emsg,
					 void *data)
{
	struct brcmf_fweh_info *fweh;
	int err = -EINVAL;

	if (ifp) {
		fweh = &ifp->drvr->fweh;

		/* handle the event if valid interface and handler */
		if (fweh->evt_handler[code])
			err = fweh->evt_handler[code](ifp, emsg, data);
		else
			brcmf_err("unhandled event %d ignored\n", code);
	} else {
		brcmf_err("no interface object\n");
	}
	return err;
}

/**
 * brcmf_fweh_handle_if_event() - handle IF event.
 *
 * @drvr: driver information object.
 * @item: queue entry.
 * @ifpp: interface object (may change upon ADD action).
 */
static void brcmf_fweh_handle_if_event(struct brcmf_pub *drvr,
				       struct brcmf_event_msg *emsg,
				       void *data)
{
	struct brcmf_if_event *ifevent = data;
	struct brcmf_if *ifp;
	int err = 0;

	brcmf_dbg(EVENT, "action: %u idx: %u bsscfg: %u flags: %u role: %u\n",
		  ifevent->action, ifevent->ifidx, ifevent->bssidx,
		  ifevent->flags, ifevent->role);

	if (ifevent->ifidx >= BRCMF_MAX_IFS) {
		brcmf_err("invalid interface index: %u\n",
			  ifevent->ifidx);
		return;
	}

	ifp = drvr->iflist[ifevent->bssidx];

	if (ifevent->action == BRCMF_E_IF_ADD) {
		brcmf_dbg(EVENT, "adding %s (%pM)\n", emsg->ifname,
			  emsg->addr);
		ifp = brcmf_add_if(drvr, ifevent->bssidx, ifevent->ifidx,
				   emsg->ifname, emsg->addr);
		if (IS_ERR(ifp))
			return;
		brcmf_fws_add_interface(ifp);
		if (!drvr->fweh.evt_handler[BRCMF_E_IF])
			err = brcmf_net_attach(ifp, false);
	}

	if (ifevent->action == BRCMF_E_IF_CHANGE)
		brcmf_fws_reset_interface(ifp);

	err = brcmf_fweh_call_event_handler(ifp, emsg->event_code, emsg, data);

	if (ifevent->action == BRCMF_E_IF_DEL) {
		brcmf_fws_del_interface(ifp);
		brcmf_del_if(drvr, ifevent->bssidx);
	}
}

/**
 * brcmf_fweh_dequeue_event() - get event from the queue.
 *
 * @fweh: firmware event handling info.
 */
static struct brcmf_fweh_queue_item *
brcmf_fweh_dequeue_event(struct brcmf_fweh_info *fweh)
{
	struct brcmf_fweh_queue_item *event = NULL;
	ulong flags;

	spin_lock_irqsave(&fweh->evt_q_lock, flags);
	if (!list_empty(&fweh->event_q)) {
		event = list_first_entry(&fweh->event_q,
					 struct brcmf_fweh_queue_item, q);
		list_del(&event->q);
	}
	spin_unlock_irqrestore(&fweh->evt_q_lock, flags);

	return event;
}

/**
 * brcmf_fweh_event_worker() - firmware event worker.
 *
 * @work: worker object.
 */
static void brcmf_fweh_event_worker(struct work_struct *work)
{
	struct brcmf_pub *drvr;
	struct brcmf_if *ifp;
	struct brcmf_fweh_info *fweh;
	struct brcmf_fweh_queue_item *event;
	int err = 0;
	struct brcmf_event_msg_be *emsg_be;
	struct brcmf_event_msg emsg;

	fweh = container_of(work, struct brcmf_fweh_info, event_work);
	drvr = container_of(fweh, struct brcmf_pub, fweh);

	while ((event = brcmf_fweh_dequeue_event(fweh))) {
		brcmf_dbg(EVENT, "event %s (%u) ifidx %u bsscfg %u addr %pM\n",
			  brcmf_fweh_event_name(event->code), event->code,
			  event->emsg.ifidx, event->emsg.bsscfgidx,
			  event->emsg.addr);

		/* convert event message */
		emsg_be = &event->emsg;
		emsg.version = be16_to_cpu(emsg_be->version);
		emsg.flags = be16_to_cpu(emsg_be->flags);
		emsg.event_code = event->code;
		emsg.status = be32_to_cpu(emsg_be->status);
		emsg.reason = be32_to_cpu(emsg_be->reason);
		emsg.auth_type = be32_to_cpu(emsg_be->auth_type);
		emsg.datalen = be32_to_cpu(emsg_be->datalen);
		memcpy(emsg.addr, emsg_be->addr, ETH_ALEN);
		memcpy(emsg.ifname, emsg_be->ifname, sizeof(emsg.ifname));
		emsg.ifidx = emsg_be->ifidx;
		emsg.bsscfgidx = emsg_be->bsscfgidx;

		brcmf_dbg(EVENT, "  version %u flags %u status %u reason %u\n",
			  emsg.version, emsg.flags, emsg.status, emsg.reason);
		brcmf_dbg_hex_dump(BRCMF_EVENT_ON(), event->data,
				   min_t(u32, emsg.datalen, 64),
				   "event payload, len=%d\n", emsg.datalen);

		/* special handling of interface event */
		if (event->code == BRCMF_E_IF) {
			brcmf_fweh_handle_if_event(drvr, &emsg, event->data);
			goto event_free;
		}

		ifp = drvr->iflist[emsg.bsscfgidx];
		err = brcmf_fweh_call_event_handler(ifp, event->code, &emsg,
						    event->data);
		if (err) {
			brcmf_err("event handler failed (%d)\n",
				  event->code);
			err = 0;
		}
event_free:
		kfree(event);
	}
}

/**
 * brcmf_fweh_attach() - initialize firmware event handling.
 *
 * @drvr: driver information object.
 */
void brcmf_fweh_attach(struct brcmf_pub *drvr)
{
	struct brcmf_fweh_info *fweh = &drvr->fweh;
	INIT_WORK(&fweh->event_work, brcmf_fweh_event_worker);
	spin_lock_init(&fweh->evt_q_lock);
	INIT_LIST_HEAD(&fweh->event_q);
}

/**
 * brcmf_fweh_detach() - cleanup firmware event handling.
 *
 * @drvr: driver information object.
 */
void brcmf_fweh_detach(struct brcmf_pub *drvr)
{
	struct brcmf_fweh_info *fweh = &drvr->fweh;
	struct brcmf_if *ifp = drvr->iflist[0];
	s8 eventmask[BRCMF_EVENTING_MASK_LEN];

	if (ifp) {
		/* clear all events */
		memset(eventmask, 0, BRCMF_EVENTING_MASK_LEN);
		(void)brcmf_fil_iovar_data_set(ifp, "event_msgs",
					       eventmask,
					       BRCMF_EVENTING_MASK_LEN);
	}
	/* cancel the worker */
	cancel_work_sync(&fweh->event_work);
	WARN_ON(!list_empty(&fweh->event_q));
	memset(fweh->evt_handler, 0, sizeof(fweh->evt_handler));
}

/**
 * brcmf_fweh_register() - register handler for given event code.
 *
 * @drvr: driver information object.
 * @code: event code.
 * @handler: handler for the given event code.
 */
int brcmf_fweh_register(struct brcmf_pub *drvr, enum brcmf_fweh_event_code code,
			brcmf_fweh_handler_t handler)
{
	if (drvr->fweh.evt_handler[code]) {
		brcmf_err("event code %d already registered\n", code);
		return -ENOSPC;
	}
	drvr->fweh.evt_handler[code] = handler;
	brcmf_dbg(TRACE, "event handler registered for %s\n",
		  brcmf_fweh_event_name(code));
	return 0;
}

/**
 * brcmf_fweh_unregister() - remove handler for given code.
 *
 * @drvr: driver information object.
 * @code: event code.
 */
void brcmf_fweh_unregister(struct brcmf_pub *drvr,
			   enum brcmf_fweh_event_code code)
{
	brcmf_dbg(TRACE, "event handler cleared for %s\n",
		  brcmf_fweh_event_name(code));
	drvr->fweh.evt_handler[code] = NULL;
}

/**
 * brcmf_fweh_activate_events() - enables firmware events registered.
 *
 * @ifp: primary interface object.
 */
int brcmf_fweh_activate_events(struct brcmf_if *ifp)
{
	int i, err;
	s8 eventmask[BRCMF_EVENTING_MASK_LEN];

	for (i = 0; i < BRCMF_E_LAST; i++) {
		if (ifp->drvr->fweh.evt_handler[i]) {
			brcmf_dbg(EVENT, "enable event %s\n",
				  brcmf_fweh_event_name(i));
			setbit(eventmask, i);
		}
	}

	/* want to handle IF event as well */
	brcmf_dbg(EVENT, "enable event IF\n");
	setbit(eventmask, BRCMF_E_IF);

	err = brcmf_fil_iovar_data_set(ifp, "event_msgs",
				       eventmask, BRCMF_EVENTING_MASK_LEN);
	if (err)
		brcmf_err("Set event_msgs error (%d)\n", err);

	return err;
}

/**
 * brcmf_fweh_process_event() - process skb as firmware event.
 *
 * @drvr: driver information object.
 * @event_packet: event packet to process.
 *
 * If the packet buffer contains a firmware event message it will
 * dispatch the event to a registered handler (using worker).
 */
void brcmf_fweh_process_event(struct brcmf_pub *drvr,
			      struct brcmf_event *event_packet)
{
	enum brcmf_fweh_event_code code;
	struct brcmf_fweh_info *fweh = &drvr->fweh;
	struct brcmf_fweh_queue_item *event;
	gfp_t alloc_flag = GFP_KERNEL;
	void *data;
	u32 datalen;

	/* get event info */
	code = get_unaligned_be32(&event_packet->msg.event_type);
	datalen = get_unaligned_be32(&event_packet->msg.datalen);
	data = &event_packet[1];

	if (code >= BRCMF_E_LAST)
		return;

	if (code != BRCMF_E_IF && !fweh->evt_handler[code])
		return;

	if (in_interrupt())
		alloc_flag = GFP_ATOMIC;

	event = kzalloc(sizeof(*event) + datalen, alloc_flag);
	if (!event)
		return;

	event->code = code;
	event->ifidx = event_packet->msg.ifidx;

	/* use memcpy to get aligned event message */
	memcpy(&event->emsg, &event_packet->msg, sizeof(event->emsg));
	memcpy(event->data, data, datalen);
	memcpy(event->ifaddr, event_packet->eth.h_dest, ETH_ALEN);

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