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

/*
 * 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.
 */


#ifndef FWEH_H_
#define FWEH_H_

#include <asm/unaligned.h>
#include <linux/skbuff.h>
#include <linux/if_ether.h>
#include <linux/if.h>

/* formward declarations */
struct brcmf_pub;
struct brcmf_if;
struct brcmf_cfg80211_info;
struct brcmf_event;

/* list of firmware events */
#define BRCMF_FWEH_EVENT_ENUM_DEFLIST \
	BRCMF_ENUM_DEF(SET_SSID, 0) \
	BRCMF_ENUM_DEF(JOIN, 1) \
	BRCMF_ENUM_DEF(START, 2) \
	BRCMF_ENUM_DEF(AUTH, 3) \
	BRCMF_ENUM_DEF(AUTH_IND, 4) \
	BRCMF_ENUM_DEF(DEAUTH, 5) \
	BRCMF_ENUM_DEF(DEAUTH_IND, 6) \
	BRCMF_ENUM_DEF(ASSOC, 7) \
	BRCMF_ENUM_DEF(ASSOC_IND, 8) \
	BRCMF_ENUM_DEF(REASSOC, 9) \
	BRCMF_ENUM_DEF(REASSOC_IND, 10) \
	BRCMF_ENUM_DEF(DISASSOC, 11) \
	BRCMF_ENUM_DEF(DISASSOC_IND, 12) \
	BRCMF_ENUM_DEF(QUIET_START, 13) \
	BRCMF_ENUM_DEF(QUIET_END, 14) \
	BRCMF_ENUM_DEF(BEACON_RX, 15) \
	BRCMF_ENUM_DEF(LINK, 16) \
	BRCMF_ENUM_DEF(MIC_ERROR, 17) \
	BRCMF_ENUM_DEF(NDIS_LINK, 18) \
	BRCMF_ENUM_DEF(ROAM, 19) \
	BRCMF_ENUM_DEF(TXFAIL, 20) \
	BRCMF_ENUM_DEF(PMKID_CACHE, 21) \
	BRCMF_ENUM_DEF(RETROGRADE_TSF, 22) \
	BRCMF_ENUM_DEF(PRUNE, 23) \
	BRCMF_ENUM_DEF(AUTOAUTH, 24) \
	BRCMF_ENUM_DEF(EAPOL_MSG, 25) \
	BRCMF_ENUM_DEF(SCAN_COMPLETE, 26) \
	BRCMF_ENUM_DEF(ADDTS_IND, 27) \
	BRCMF_ENUM_DEF(DELTS_IND, 28) \
	BRCMF_ENUM_DEF(BCNSENT_IND, 29) \
	BRCMF_ENUM_DEF(BCNRX_MSG, 30) \
	BRCMF_ENUM_DEF(BCNLOST_MSG, 31) \
	BRCMF_ENUM_DEF(ROAM_PREP, 32) \
	BRCMF_ENUM_DEF(PFN_NET_FOUND, 33) \
	BRCMF_ENUM_DEF(PFN_NET_LOST, 34) \
	BRCMF_ENUM_DEF(RESET_COMPLETE, 35) \
	BRCMF_ENUM_DEF(JOIN_START, 36) \
	BRCMF_ENUM_DEF(ROAM_START, 37) \
	BRCMF_ENUM_DEF(ASSOC_START, 38) \
	BRCMF_ENUM_DEF(IBSS_ASSOC, 39) \
	BRCMF_ENUM_DEF(RADIO, 40) \
	BRCMF_ENUM_DEF(PSM_WATCHDOG, 41) \
	BRCMF_ENUM_DEF(PROBREQ_MSG, 44) \
	BRCMF_ENUM_DEF(SCAN_CONFIRM_IND, 45) \
	BRCMF_ENUM_DEF(PSK_SUP, 46) \
	BRCMF_ENUM_DEF(COUNTRY_CODE_CHANGED, 47) \
	BRCMF_ENUM_DEF(EXCEEDED_MEDIUM_TIME, 48) \
	BRCMF_ENUM_DEF(ICV_ERROR, 49) \
	BRCMF_ENUM_DEF(UNICAST_DECODE_ERROR, 50) \
	BRCMF_ENUM_DEF(MULTICAST_DECODE_ERROR, 51) \
	BRCMF_ENUM_DEF(TRACE, 52) \
	BRCMF_ENUM_DEF(IF, 54) \
	BRCMF_ENUM_DEF(P2P_DISC_LISTEN_COMPLETE, 55) \
	BRCMF_ENUM_DEF(RSSI, 56) \
	BRCMF_ENUM_DEF(PFN_SCAN_COMPLETE, 57) \
	BRCMF_ENUM_DEF(EXTLOG_MSG, 58) \
	BRCMF_ENUM_DEF(ACTION_FRAME, 59) \
	BRCMF_ENUM_DEF(ACTION_FRAME_COMPLETE, 60) \
	BRCMF_ENUM_DEF(PRE_ASSOC_IND, 61) \
	BRCMF_ENUM_DEF(PRE_REASSOC_IND, 62) \
	BRCMF_ENUM_DEF(CHANNEL_ADOPTED, 63) \
	BRCMF_ENUM_DEF(AP_STARTED, 64) \
	BRCMF_ENUM_DEF(DFS_AP_STOP, 65) \
	BRCMF_ENUM_DEF(DFS_AP_RESUME, 66) \
	BRCMF_ENUM_DEF(ESCAN_RESULT, 69) \
	BRCMF_ENUM_DEF(ACTION_FRAME_OFF_CHAN_COMPLETE, 70) \
	BRCMF_ENUM_DEF(PROBERESP_MSG, 71) \
	BRCMF_ENUM_DEF(P2P_PROBEREQ_MSG, 72) \
	BRCMF_ENUM_DEF(DCS_REQUEST, 73) \
	BRCMF_ENUM_DEF(FIFO_CREDIT_MAP, 74) \
	BRCMF_ENUM_DEF(ACTION_FRAME_RX, 75) \
	BRCMF_ENUM_DEF(BCMC_CREDIT_SUPPORT, 127)

#define BRCMF_ENUM_DEF(id, val) \
	BRCMF_E_##id = (val),

/* firmware event codes sent by the dongle */
enum brcmf_fweh_event_code {
	BRCMF_FWEH_EVENT_ENUM_DEFLIST
	BRCMF_E_LAST
};
#undef BRCMF_ENUM_DEF

/* flags field values in struct brcmf_event_msg */
#define BRCMF_EVENT_MSG_LINK		0x01
#define BRCMF_EVENT_MSG_FLUSHTXQ	0x02
#define BRCMF_EVENT_MSG_GROUP		0x04

/**
 * definitions for event packet validation.
 */
#define BRCMF_EVENT_OUI_OFFSET		19
#define BRCM_OUI			"\x00\x10\x18"
#define DOT11_OUI_LEN			3
#define BCMILCP_BCM_SUBTYPE_EVENT	1


/**
 * struct brcmf_event_msg - firmware event message.
 *
 * @version: version information.
 * @flags: event flags.
 * @event_code: firmware event code.
 * @status: status information.
 * @reason: reason code.
 * @auth_type: authentication type.
 * @datalen: lenght of event data buffer.
 * @addr: ether address.
 * @ifname: interface name.
 * @ifidx: interface index.
 * @bsscfgidx: bsscfg index.
 */
struct brcmf_event_msg {
	u16 version;
	u16 flags;
	u32 event_code;
	u32 status;
	u32 reason;
	s32 auth_type;
	u32 datalen;
	u8 addr[ETH_ALEN];
	char ifname[IFNAMSIZ];
	u8 ifidx;
	u8 bsscfgidx;
};

typedef int (*brcmf_fweh_handler_t)(struct brcmf_if *ifp,
				    const struct brcmf_event_msg *evtmsg,
				    void *data);

/**
 * struct brcmf_fweh_info - firmware event handling information.
 *
 * @event_work: event worker.
 * @evt_q_lock: lock for event queue protection.
 * @event_q: event queue.
 * @evt_handler: registered event handlers.
 */
struct brcmf_fweh_info {
	struct work_struct event_work;
	spinlock_t evt_q_lock;
	struct list_head event_q;
	int (*evt_handler[BRCMF_E_LAST])(struct brcmf_if *ifp,
					 const struct brcmf_event_msg *evtmsg,
					 void *data);
};

void brcmf_fweh_attach(struct brcmf_pub *drvr);
void brcmf_fweh_detach(struct brcmf_pub *drvr);
int brcmf_fweh_register(struct brcmf_pub *drvr, enum brcmf_fweh_event_code code,
			int (*handler)(struct brcmf_if *ifp,
				       const struct brcmf_event_msg *evtmsg,
				       void *data));
void brcmf_fweh_unregister(struct brcmf_pub *drvr,
			   enum brcmf_fweh_event_code code);
int brcmf_fweh_activate_events(struct brcmf_if *ifp);
void brcmf_fweh_process_event(struct brcmf_pub *drvr,
			      struct brcmf_event *event_packet);

static inline void brcmf_fweh_process_skb(struct brcmf_pub *drvr,
					  struct sk_buff *skb)
{
	struct brcmf_event *event_packet;
	u8 *data;
	u16 usr_stype;

	/* only process events when protocol matches */
	if (skb->protocol != cpu_to_be16(ETH_P_LINK_CTL))
		return;

	/* check for BRCM oui match */
	event_packet = (struct brcmf_event *)skb_mac_header(skb);
	data = (u8 *)event_packet;
	data += BRCMF_EVENT_OUI_OFFSET;
	if (memcmp(BRCM_OUI, data, DOT11_OUI_LEN))
		return;

	/* final match on usr_subtype */
	data += DOT11_OUI_LEN;
	usr_stype = get_unaligned_be16(data);
	if (usr_stype != BCMILCP_BCM_SUBTYPE_EVENT)
		return;

	brcmf_fweh_process_event(drvr, event_packet);
}

#endif /* FWEH_H_ */
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
	17
	18	#ifndef FWEH_H_
	19	#define FWEH_H_
	20
b6f06f6e	21	#include <asm/unaligned.h>
5c36b99a AS	22	#include <linux/skbuff.h>
	23	#include <linux/if_ether.h>
	24	#include <linux/if.h>
	25
	26	/* formward declarations */
	27	struct brcmf_pub;
	28	struct brcmf_if;
	29	struct brcmf_cfg80211_info;
	30	struct brcmf_event;
	31
dc5cbdfd AS	32	/* list of firmware events */
	33	#define BRCMF_FWEH_EVENT_ENUM_DEFLIST \
	34	BRCMF_ENUM_DEF(SET_SSID, 0) \
	35	BRCMF_ENUM_DEF(JOIN, 1) \
	36	BRCMF_ENUM_DEF(START, 2) \
	37	BRCMF_ENUM_DEF(AUTH, 3) \
	38	BRCMF_ENUM_DEF(AUTH_IND, 4) \
	39	BRCMF_ENUM_DEF(DEAUTH, 5) \
	40	BRCMF_ENUM_DEF(DEAUTH_IND, 6) \
	41	BRCMF_ENUM_DEF(ASSOC, 7) \
	42	BRCMF_ENUM_DEF(ASSOC_IND, 8) \
	43	BRCMF_ENUM_DEF(REASSOC, 9) \
	44	BRCMF_ENUM_DEF(REASSOC_IND, 10) \
	45	BRCMF_ENUM_DEF(DISASSOC, 11) \
	46	BRCMF_ENUM_DEF(DISASSOC_IND, 12) \
	47	BRCMF_ENUM_DEF(QUIET_START, 13) \
	48	BRCMF_ENUM_DEF(QUIET_END, 14) \
	49	BRCMF_ENUM_DEF(BEACON_RX, 15) \
	50	BRCMF_ENUM_DEF(LINK, 16) \
	51	BRCMF_ENUM_DEF(MIC_ERROR, 17) \
	52	BRCMF_ENUM_DEF(NDIS_LINK, 18) \
	53	BRCMF_ENUM_DEF(ROAM, 19) \
	54	BRCMF_ENUM_DEF(TXFAIL, 20) \
	55	BRCMF_ENUM_DEF(PMKID_CACHE, 21) \
	56	BRCMF_ENUM_DEF(RETROGRADE_TSF, 22) \
	57	BRCMF_ENUM_DEF(PRUNE, 23) \
	58	BRCMF_ENUM_DEF(AUTOAUTH, 24) \
	59	BRCMF_ENUM_DEF(EAPOL_MSG, 25) \
	60	BRCMF_ENUM_DEF(SCAN_COMPLETE, 26) \
	61	BRCMF_ENUM_DEF(ADDTS_IND, 27) \
	62	BRCMF_ENUM_DEF(DELTS_IND, 28) \
	63	BRCMF_ENUM_DEF(BCNSENT_IND, 29) \
	64	BRCMF_ENUM_DEF(BCNRX_MSG, 30) \
	65	BRCMF_ENUM_DEF(BCNLOST_MSG, 31) \
	66	BRCMF_ENUM_DEF(ROAM_PREP, 32) \
	67	BRCMF_ENUM_DEF(PFN_NET_FOUND, 33) \
	68	BRCMF_ENUM_DEF(PFN_NET_LOST, 34) \
	69	BRCMF_ENUM_DEF(RESET_COMPLETE, 35) \
	70	BRCMF_ENUM_DEF(JOIN_START, 36) \
	71	BRCMF_ENUM_DEF(ROAM_START, 37) \
	72	BRCMF_ENUM_DEF(ASSOC_START, 38) \
	73	BRCMF_ENUM_DEF(IBSS_ASSOC, 39) \
	74	BRCMF_ENUM_DEF(RADIO, 40) \
	75	BRCMF_ENUM_DEF(PSM_WATCHDOG, 41) \
	76	BRCMF_ENUM_DEF(PROBREQ_MSG, 44) \
	77	BRCMF_ENUM_DEF(SCAN_CONFIRM_IND, 45) \
	78	BRCMF_ENUM_DEF(PSK_SUP, 46) \
	79	BRCMF_ENUM_DEF(COUNTRY_CODE_CHANGED, 47) \
	80	BRCMF_ENUM_DEF(EXCEEDED_MEDIUM_TIME, 48) \
	81	BRCMF_ENUM_DEF(ICV_ERROR, 49) \
	82	BRCMF_ENUM_DEF(UNICAST_DECODE_ERROR, 50) \
	83	BRCMF_ENUM_DEF(MULTICAST_DECODE_ERROR, 51) \
	84	BRCMF_ENUM_DEF(TRACE, 52) \
	85	BRCMF_ENUM_DEF(IF, 54) \
0de8aace	86	BRCMF_ENUM_DEF(P2P_DISC_LISTEN_COMPLETE, 55) \
dc5cbdfd AS	87	BRCMF_ENUM_DEF(RSSI, 56) \
	88	BRCMF_ENUM_DEF(PFN_SCAN_COMPLETE, 57) \
	89	BRCMF_ENUM_DEF(EXTLOG_MSG, 58) \
	90	BRCMF_ENUM_DEF(ACTION_FRAME, 59) \
	91	BRCMF_ENUM_DEF(ACTION_FRAME_COMPLETE, 60) \
	92	BRCMF_ENUM_DEF(PRE_ASSOC_IND, 61) \
	93	BRCMF_ENUM_DEF(PRE_REASSOC_IND, 62) \
	94	BRCMF_ENUM_DEF(CHANNEL_ADOPTED, 63) \
	95	BRCMF_ENUM_DEF(AP_STARTED, 64) \
	96	BRCMF_ENUM_DEF(DFS_AP_STOP, 65) \
	97	BRCMF_ENUM_DEF(DFS_AP_RESUME, 66) \
	98	BRCMF_ENUM_DEF(ESCAN_RESULT, 69) \
	99	BRCMF_ENUM_DEF(ACTION_FRAME_OFF_CHAN_COMPLETE, 70) \
0de8aace HM	100	BRCMF_ENUM_DEF(PROBERESP_MSG, 71) \
0de8aace HM	101	BRCMF_ENUM_DEF(P2P_PROBEREQ_MSG, 72) \
dc5cbdfd	102	BRCMF_ENUM_DEF(DCS_REQUEST, 73) \
0de8aace	103	BRCMF_ENUM_DEF(FIFO_CREDIT_MAP, 74) \
7d747037 HM	104	BRCMF_ENUM_DEF(ACTION_FRAME_RX, 75) \
7d747037 HM	105	BRCMF_ENUM_DEF(BCMC_CREDIT_SUPPORT, 127)
dc5cbdfd AS	106
	107	#define BRCMF_ENUM_DEF(id, val) \
	108	BRCMF_E_##id = (val),
	109
5c36b99a AS	110	/* firmware event codes sent by the dongle */
5c36b99a AS	111	enum brcmf_fweh_event_code {
dc5cbdfd	112	BRCMF_FWEH_EVENT_ENUM_DEFLIST
5c36b99a AS	113	BRCMF_E_LAST
5c36b99a AS	114	};
dc5cbdfd	115	#undef BRCMF_ENUM_DEF
5c36b99a AS	116
	117	/* flags field values in struct brcmf_event_msg */
	118	#define BRCMF_EVENT_MSG_LINK 0x01
	119	#define BRCMF_EVENT_MSG_FLUSHTXQ 0x02
	120	#define BRCMF_EVENT_MSG_GROUP 0x04
	121
	122	/**
	123	* definitions for event packet validation.
	124	*/
	125	#define BRCMF_EVENT_OUI_OFFSET 19
	126	#define BRCM_OUI "\x00\x10\x18"
	127	#define DOT11_OUI_LEN 3
	128	#define BCMILCP_BCM_SUBTYPE_EVENT 1
	129
	130
	131	/**
	132	* struct brcmf_event_msg - firmware event message.
	133	*
	134	* @version: version information.
	135	* @flags: event flags.
	136	* @event_code: firmware event code.
	137	* @status: status information.
	138	* @reason: reason code.
	139	* @auth_type: authentication type.
	140	* @datalen: lenght of event data buffer.
	141	* @addr: ether address.
	142	* @ifname: interface name.
	143	* @ifidx: interface index.
	144	* @bsscfgidx: bsscfg index.
	145	*/
	146	struct brcmf_event_msg {
	147	u16 version;
	148	u16 flags;
	149	u32 event_code;
	150	u32 status;
	151	u32 reason;
	152	s32 auth_type;
	153	u32 datalen;
	154	u8 addr[ETH_ALEN];
	155	char ifname[IFNAMSIZ];
	156	u8 ifidx;
	157	u8 bsscfgidx;
	158	};
	159
	160	typedef int (brcmf_fweh_handler_t)(struct brcmf_if ifp,
	161	const struct brcmf_event_msg *evtmsg,
	162	void *data);
	163
	164	/**
	165	* struct brcmf_fweh_info - firmware event handling information.
	166	*
	167	* @event_work: event worker.
	168	* @evt_q_lock: lock for event queue protection.
	169	* @event_q: event queue.
	170	* @evt_handler: registered event handlers.
	171	*/
	172	struct brcmf_fweh_info {
	173	struct work_struct event_work;
f241b244	174	spinlock_t evt_q_lock;
5c36b99a AS	175	struct list_head event_q;
	176	int (evt_handler[BRCMF_E_LAST])(struct brcmf_if ifp,
	177	const struct brcmf_event_msg *evtmsg,
	178	void *data);
	179	};
	180
	181	void brcmf_fweh_attach(struct brcmf_pub *drvr);
	182	void brcmf_fweh_detach(struct brcmf_pub *drvr);
	183	int brcmf_fweh_register(struct brcmf_pub *drvr, enum brcmf_fweh_event_code code,
	184	int (handler)(struct brcmf_if ifp,
	185	const struct brcmf_event_msg *evtmsg,
	186	void *data));
	187	void brcmf_fweh_unregister(struct brcmf_pub *drvr,
	188	enum brcmf_fweh_event_code code);
	189	int brcmf_fweh_activate_events(struct brcmf_if *ifp);
	190	void brcmf_fweh_process_event(struct brcmf_pub *drvr,
deb09280	191	struct brcmf_event *event_packet);
5c36b99a AS	192
5c36b99a AS	193	static inline void brcmf_fweh_process_skb(struct brcmf_pub *drvr,
deb09280	194	struct sk_buff *skb)
5c36b99a AS	195	{
	196	struct brcmf_event *event_packet;
	197	u8 *data;
	198	u16 usr_stype;
	199
	200	/* only process events when protocol matches */
	201	if (skb->protocol != cpu_to_be16(ETH_P_LINK_CTL))
	202	return;
	203
	204	/* check for BRCM oui match */
	205	event_packet = (struct brcmf_event *)skb_mac_header(skb);
	206	data = (u8 *)event_packet;
	207	data += BRCMF_EVENT_OUI_OFFSET;
	208	if (memcmp(BRCM_OUI, data, DOT11_OUI_LEN))
	209	return;
	210
	211	/* final match on usr_subtype */
	212	data += DOT11_OUI_LEN;
	213	usr_stype = get_unaligned_be16(data);
	214	if (usr_stype != BCMILCP_BCM_SUBTYPE_EVENT)
	215	return;
	216
deb09280	217	brcmf_fweh_process_event(drvr, event_packet);
5c36b99a AS	218	}
	219
	220	#endif /* FWEH_H_ */