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

/*
 * Copyright (c) 2010 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.
 */

/****************
 * Common types *
 */

#ifndef BRCMFMAC_CORE_H
#define BRCMFMAC_CORE_H

#include "fweh.h"

#define TOE_TX_CSUM_OL		0x00000001
#define TOE_RX_CSUM_OL		0x00000002

/* For supporting multiple interfaces */
#define BRCMF_MAX_IFS	16

/* Small, medium and maximum buffer size for dcmd
 */
#define BRCMF_DCMD_SMLEN	256
#define BRCMF_DCMD_MEDLEN	1536
#define BRCMF_DCMD_MAXLEN	8192

/* IOCTL from host to device are limited in lenght. A device can only handle
 * ethernet frame size. This limitation is to be applied by protocol layer.
 */
#define BRCMF_TX_IOCTL_MAX_MSG_SIZE	(ETH_FRAME_LEN+ETH_FCS_LEN)

#define BRCMF_AMPDU_RX_REORDER_MAXFLOWS		256

/* Length of firmware version string stored for
 * ethtool driver info which uses 32 bytes as well.
 */
#define BRCMF_DRIVER_FIRMWARE_VERSION_LEN	32

/**
 * struct brcmf_ampdu_rx_reorder - AMPDU receive reorder info
 *
 * @pktslots: dynamic allocated array for ordering AMPDU packets.
 * @flow_id: AMPDU flow identifier.
 * @cur_idx: last AMPDU index from firmware.
 * @exp_idx: expected next AMPDU index.
 * @max_idx: maximum amount of packets per AMPDU.
 * @pend_pkts: number of packets currently in @pktslots.
 */
struct brcmf_ampdu_rx_reorder {
	struct sk_buff **pktslots;
	u8 flow_id;
	u8 cur_idx;
	u8 exp_idx;
	u8 max_idx;
	u8 pend_pkts;
};

/* Forward decls for struct brcmf_pub (see below) */
struct brcmf_proto;	/* device communication protocol info */
struct brcmf_cfg80211_dev; /* cfg80211 device info */
struct brcmf_fws_info; /* firmware signalling info */

/* see struct brcmf_rev_info_le in fwil_types.h */
struct brcmf_rev_info {
	u32 vendorid;
	u32 deviceid;
	u32 radiorev;
	u32 chiprev;
	u32 corerev;
	u32 boardid;
	u32 boardvendor;
	u32 boardrev;
	u32 driverrev;
	u32 ucoderev;
	u32 bus;
	u32 chipnum;
	u32 phytype;
	u32 phyrev;
	u32 anarev;
	u32 chippkg;
	u32 nvramrev;
};

/* Common structure for module and instance linkage */
struct brcmf_pub {
	/* Linkage ponters */
	struct brcmf_bus *bus_if;
	struct brcmf_proto *proto;
	struct brcmf_cfg80211_info *config;

	/* Internal brcmf items */
	uint hdrlen;		/* Total BRCMF header length (proto + bus) */
	uint rxsz;		/* Rx buffer size bus module should use */

	/* Dongle media info */
	char fwver[BRCMF_DRIVER_FIRMWARE_VERSION_LEN];
	u8 mac[ETH_ALEN];		/* MAC address obtained from dongle */

	/* Multicast data packets sent to dongle */
	unsigned long tx_multicast;

	struct brcmf_if *iflist[BRCMF_MAX_IFS];

	struct mutex proto_block;
	unsigned char proto_buf[BRCMF_DCMD_MAXLEN];

	struct brcmf_fweh_info fweh;

	struct brcmf_fws_info *fws;

	struct brcmf_ampdu_rx_reorder
		*reorder_flows[BRCMF_AMPDU_RX_REORDER_MAXFLOWS];

	u32 feat_flags;
	u32 chip_quirks;

	struct brcmf_rev_info revinfo;
#ifdef DEBUG
	struct dentry *dbgfs_dir;
#endif
};

/* forward declarations */
struct brcmf_cfg80211_vif;
struct brcmf_fws_mac_descriptor;

/**
 * enum brcmf_netif_stop_reason - reason for stopping netif queue.
 *
 * @BRCMF_NETIF_STOP_REASON_FWS_FC:
 *	netif stopped due to firmware signalling flow control.
 * @BRCMF_NETIF_STOP_REASON_FLOW:
 *	netif stopped due to flowring full.
 */
enum brcmf_netif_stop_reason {
	BRCMF_NETIF_STOP_REASON_FWS_FC = 1,
	BRCMF_NETIF_STOP_REASON_FLOW = 2
};

/**
 * struct brcmf_if - interface control information.
 *
 * @drvr: points to device related information.
 * @vif: points to cfg80211 specific interface information.
 * @ndev: associated network device.
 * @stats: interface specific network statistics.
 * @setmacaddr_work: worker object for setting mac address.
 * @multicast_work: worker object for multicast provisioning.
 * @fws_desc: interface specific firmware-signalling descriptor.
 * @ifidx: interface index in device firmware.
 * @bssidx: index of bss associated with this interface.
 * @mac_addr: assigned mac address.
 * @netif_stop: bitmap indicates reason why netif queues are stopped.
 * @netif_stop_lock: spinlock for update netif_stop from multiple sources.
 * @pend_8021x_cnt: tracks outstanding number of 802.1x frames.
 * @pend_8021x_wait: used for signalling change in count.
 */
struct brcmf_if {
	struct brcmf_pub *drvr;
	struct brcmf_cfg80211_vif *vif;
	struct net_device *ndev;
	struct net_device_stats stats;
	struct work_struct setmacaddr_work;
	struct work_struct multicast_work;
	struct brcmf_fws_mac_descriptor *fws_desc;
	int ifidx;
	s32 bssidx;
	u8 mac_addr[ETH_ALEN];
	u8 netif_stop;
	spinlock_t netif_stop_lock;
	atomic_t pend_8021x_cnt;
	wait_queue_head_t pend_8021x_wait;
};

struct brcmf_skb_reorder_data {
	u8 *reorder;
};

int brcmf_netdev_wait_pend8021x(struct brcmf_if *ifp);

/* Return pointer to interface name */
char *brcmf_ifname(struct brcmf_pub *drvr, int idx);

int brcmf_net_attach(struct brcmf_if *ifp, bool rtnl_locked);
struct brcmf_if *brcmf_add_if(struct brcmf_pub *drvr, s32 bssidx, s32 ifidx,
			      char *name, u8 *mac_addr);
void brcmf_remove_interface(struct brcmf_pub *drvr, u32 bssidx);
int brcmf_get_next_free_bsscfgidx(struct brcmf_pub *drvr);
void brcmf_txflowblock_if(struct brcmf_if *ifp,
			  enum brcmf_netif_stop_reason reason, bool state);
void brcmf_txfinalize(struct brcmf_pub *drvr, struct sk_buff *txp, u8 ifidx,
		      bool success);
void brcmf_netif_rx(struct brcmf_if *ifp, struct sk_buff *skb);

/* Sets dongle media info (drv_version, mac address). */
int brcmf_c_preinit_dcmds(struct brcmf_if *ifp);

#endif /* BRCMFMAC_CORE_H */
Commit	Line	Data
5b435de0 AS	1	/*
	2	* Copyright (c) 2010 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	* Common types *
	19	*/
	20
122d3d04 HM	21	#ifndef BRCMFMAC_CORE_H
122d3d04 HM	22	#define BRCMFMAC_CORE_H
5b435de0	23
5c36b99a AS	24	#include "fweh.h"
5c36b99a AS	25
5b435de0 AS	26	#define TOE_TX_CSUM_OL 0x00000001
	27	#define TOE_RX_CSUM_OL 0x00000002
	28
5b435de0 AS	29	/* For supporting multiple interfaces */
5b435de0 AS	30	#define BRCMF_MAX_IFS 16
5b435de0	31
81f5dcb8 HM	32	/* Small, medium and maximum buffer size for dcmd
	33	*/
	34	#define BRCMF_DCMD_SMLEN 256
	35	#define BRCMF_DCMD_MEDLEN 1536
	36	#define BRCMF_DCMD_MAXLEN 8192
	37
d4533992 HM	38	/* IOCTL from host to device are limited in lenght. A device can only handle
	39	* ethernet frame size. This limitation is to be applied by protocol layer.
	40	*/
	41	#define BRCMF_TX_IOCTL_MAX_MSG_SIZE (ETH_FRAME_LEN+ETH_FCS_LEN)
	42
87edd891 AS	43	#define BRCMF_AMPDU_RX_REORDER_MAXFLOWS 256
87edd891 AS	44
55685b8f AS	45	/* Length of firmware version string stored for
	46	* ethtool driver info which uses 32 bytes as well.
	47	*/
	48	#define BRCMF_DRIVER_FIRMWARE_VERSION_LEN 32
	49
87edd891 AS	50	/**
	51	* struct brcmf_ampdu_rx_reorder - AMPDU receive reorder info
	52	*
	53	* @pktslots: dynamic allocated array for ordering AMPDU packets.
	54	* @flow_id: AMPDU flow identifier.
	55	* @cur_idx: last AMPDU index from firmware.
	56	* @exp_idx: expected next AMPDU index.
	57	* @max_idx: maximum amount of packets per AMPDU.
	58	* @pend_pkts: number of packets currently in @pktslots.
	59	*/
	60	struct brcmf_ampdu_rx_reorder {
	61	struct sk_buff **pktslots;
	62	u8 flow_id;
	63	u8 cur_idx;
	64	u8 exp_idx;
	65	u8 max_idx;
	66	u8 pend_pkts;
	67	};
	68
5b435de0	69	/* Forward decls for struct brcmf_pub (see below) */
5b435de0	70	struct brcmf_proto; /* device communication protocol info */
5b435de0	71	struct brcmf_cfg80211_dev; /* cfg80211 device info */
349e7104	72	struct brcmf_fws_info; /* firmware signalling info */
5b435de0	73
48622903 AS	74	/* see struct brcmf_rev_info_le in fwil_types.h */
	75	struct brcmf_rev_info {
	76	u32 vendorid;
	77	u32 deviceid;
	78	u32 radiorev;
	79	u32 chiprev;
	80	u32 corerev;
	81	u32 boardid;
	82	u32 boardvendor;
	83	u32 boardrev;
	84	u32 driverrev;
	85	u32 ucoderev;
	86	u32 bus;
	87	u32 chipnum;
	88	u32 phytype;
	89	u32 phyrev;
	90	u32 anarev;
	91	u32 chippkg;
	92	u32 nvramrev;
	93	};
	94
5b435de0 AS	95	/* Common structure for module and instance linkage */
	96	struct brcmf_pub {
	97	/* Linkage ponters */
8d169aa0	98	struct brcmf_bus *bus_if;
85b84133	99	struct brcmf_proto *proto;
27a68fe3	100	struct brcmf_cfg80211_info *config;
5b435de0 AS	101
5b435de0 AS	102	/* Internal brcmf items */
5b435de0	103	uint hdrlen; /* Total BRCMF header length (proto + bus) */
5b435de0	104	uint rxsz; /* Rx buffer size bus module should use */
5b435de0 AS	105
5b435de0 AS	106	/* Dongle media info */
55685b8f	107	char fwver[BRCMF_DRIVER_FIRMWARE_VERSION_LEN];
5b435de0	108	u8 mac[ETH_ALEN]; /* MAC address obtained from dongle */
5b435de0	109
5b435de0 AS	110	/* Multicast data packets sent to dongle */
5b435de0 AS	111	unsigned long tx_multicast;
5b435de0	112
d08b6a37 FL	113	struct brcmf_if *iflist[BRCMF_MAX_IFS];
	114
	115	struct mutex proto_block;
81f5dcb8	116	unsigned char proto_buf[BRCMF_DCMD_MAXLEN];
d08b6a37	117
5c36b99a	118	struct brcmf_fweh_info fweh;
349e7104	119
349e7104	120	struct brcmf_fws_info *fws;
87edd891 AS	121
	122	struct brcmf_ampdu_rx_reorder
	123	*reorder_flows[BRCMF_AMPDU_RX_REORDER_MAXFLOWS];
c08437b4 AS	124
	125	u32 feat_flags;
	126	u32 chip_quirks;
	127
48622903	128	struct brcmf_rev_info revinfo;
d319a7cf AS	129	#ifdef DEBUG
	130	struct dentry *dbgfs_dir;
	131	#endif
5b435de0 AS	132	};
5b435de0 AS	133
bb8c8063	134	/* forward declarations */
3eacf866	135	struct brcmf_cfg80211_vif;
bb8c8063	136	struct brcmf_fws_mac_descriptor;
3eacf866	137
29e04ae3 AS	138	/**
	139	* enum brcmf_netif_stop_reason - reason for stopping netif queue.
	140	*
	141	* @BRCMF_NETIF_STOP_REASON_FWS_FC:
	142	* netif stopped due to firmware signalling flow control.
17ca5c71 HM	143	* @BRCMF_NETIF_STOP_REASON_FLOW:
17ca5c71 HM	144	* netif stopped due to flowring full.
29e04ae3 AS	145	*/
	146	enum brcmf_netif_stop_reason {
	147	BRCMF_NETIF_STOP_REASON_FWS_FC = 1,
17ca5c71	148	BRCMF_NETIF_STOP_REASON_FLOW = 2
29e04ae3 AS	149	};
29e04ae3 AS	150
1d4fd8d7 AS	151	/**
	152	* struct brcmf_if - interface control information.
	153	*
	154	* @drvr: points to device related information.
3eacf866	155	* @vif: points to cfg80211 specific interface information.
1d4fd8d7 AS	156	* @ndev: associated network device.
1d4fd8d7 AS	157	* @stats: interface specific network statistics.
bb8c8063 AS	158	* @setmacaddr_work: worker object for setting mac address.
	159	* @multicast_work: worker object for multicast provisioning.
	160	* @fws_desc: interface specific firmware-signalling descriptor.
2880b868	161	* @ifidx: interface index in device firmware.
1d4fd8d7 AS	162	* @bssidx: index of bss associated with this interface.
1d4fd8d7 AS	163	* @mac_addr: assigned mac address.
29e04ae3	164	* @netif_stop: bitmap indicates reason why netif queues are stopped.
df50f756	165	* @netif_stop_lock: spinlock for update netif_stop from multiple sources.
10ef7321 HM	166	* @pend_8021x_cnt: tracks outstanding number of 802.1x frames.
10ef7321 HM	167	* @pend_8021x_wait: used for signalling change in count.
1d4fd8d7 AS	168	*/
	169	struct brcmf_if {
	170	struct brcmf_pub *drvr;
3eacf866	171	struct brcmf_cfg80211_vif *vif;
1d4fd8d7 AS	172	struct net_device *ndev;
1d4fd8d7 AS	173	struct net_device_stats stats;
bdf5ff51 AS	174	struct work_struct setmacaddr_work;
bdf5ff51 AS	175	struct work_struct multicast_work;
bb8c8063	176	struct brcmf_fws_mac_descriptor *fws_desc;
2880b868	177	int ifidx;
1d4fd8d7 AS	178	s32 bssidx;
1d4fd8d7 AS	179	u8 mac_addr[ETH_ALEN];
29e04ae3	180	u8 netif_stop;
df50f756	181	spinlock_t netif_stop_lock;
10ef7321 HM	182	atomic_t pend_8021x_cnt;
10ef7321 HM	183	wait_queue_head_t pend_8021x_wait;
5b435de0 AS	184	};
5b435de0 AS	185
87edd891 AS	186	struct brcmf_skb_reorder_data {
	187	u8 *reorder;
	188	};
1d4fd8d7	189
118eb304	190	int brcmf_netdev_wait_pend8021x(struct brcmf_if *ifp);
5b435de0	191
5b435de0	192	/* Return pointer to interface name */
9bd91f3c	193	char brcmf_ifname(struct brcmf_pub drvr, int idx);
5b435de0	194
9bd91f3c JP	195	int brcmf_net_attach(struct brcmf_if *ifp, bool rtnl_locked);
	196	struct brcmf_if brcmf_add_if(struct brcmf_pub drvr, s32 bssidx, s32 ifidx,
	197	char name, u8 mac_addr);
a44aa400 HM	198	void brcmf_remove_interface(struct brcmf_pub *drvr, u32 bssidx);
a44aa400 HM	199	int brcmf_get_next_free_bsscfgidx(struct brcmf_pub *drvr);
29e04ae3 AS	200	void brcmf_txflowblock_if(struct brcmf_if *ifp,
29e04ae3 AS	201	enum brcmf_netif_stop_reason reason, bool state);
53e30ea4	202	void brcmf_txfinalize(struct brcmf_pub drvr, struct sk_buff txp, u8 ifidx,
9bd91f3c	203	bool success);
9374a2b5	204	void brcmf_netif_rx(struct brcmf_if ifp, struct sk_buff skb);
5b435de0	205
f931868d HM	206	/* Sets dongle media info (drv_version, mac address). */
	207	int brcmf_c_preinit_dcmds(struct brcmf_if *ifp);
	208
122d3d04	209	#endif /* BRCMFMAC_CORE_H */