[deliverable/linux.git] / drivers / net / wireless / brcm80211 / brcmfmac / wl_cfg80211.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.
 */

#ifndef _wl_cfg80211_h_
#define _wl_cfg80211_h_

#define WL_DBG_NONE		0
#define WL_DBG_CONN		(1 << 5)
#define WL_DBG_SCAN		(1 << 4)
#define WL_DBG_TRACE		(1 << 3)
#define WL_DBG_INFO		(1 << 1)
#define WL_DBG_ERR		(1 << 0)
#define WL_DBG_MASK		((WL_DBG_INFO | WL_DBG_ERR | WL_DBG_TRACE) | \
				(WL_DBG_SCAN) | (WL_DBG_CONN))

#define	WL_ERR(fmt, ...)					\
do {								\
	if (brcmf_dbg_level & WL_DBG_ERR) {			\
		if (net_ratelimit()) {				\
			pr_err("ERROR @%s : " fmt,		\
			       __func__, ##__VA_ARGS__);	\
		}						\
	}							\
} while (0)

#if (defined DEBUG)
#define	WL_INFO(fmt, ...)					\
do {								\
	if (brcmf_dbg_level & WL_DBG_INFO) {			\
		if (net_ratelimit()) {				\
			pr_err("INFO @%s : " fmt,		\
			       __func__, ##__VA_ARGS__);	\
		}						\
	}							\
} while (0)

#define	WL_TRACE(fmt, ...)					\
do {								\
	if (brcmf_dbg_level & WL_DBG_TRACE) {			\
		if (net_ratelimit()) {				\
			pr_err("TRACE @%s : " fmt,		\
			       __func__, ##__VA_ARGS__);	\
		}						\
	}							\
} while (0)

#define	WL_SCAN(fmt, ...)					\
do {								\
	if (brcmf_dbg_level & WL_DBG_SCAN) {			\
		if (net_ratelimit()) {				\
			pr_err("SCAN @%s : " fmt,		\
			       __func__, ##__VA_ARGS__);	\
		}						\
	}							\
} while (0)

#define	WL_CONN(fmt, ...)					\
do {								\
	if (brcmf_dbg_level & WL_DBG_CONN) {			\
		if (net_ratelimit()) {				\
			pr_err("CONN @%s : " fmt,		\
			       __func__, ##__VA_ARGS__);	\
		}						\
	}							\
} while (0)

#else /* (defined DEBUG) */
#define	WL_INFO(fmt, args...)
#define	WL_TRACE(fmt, args...)
#define	WL_SCAN(fmt, args...)
#define	WL_CONN(fmt, args...)
#endif /* (defined DEBUG) */

#define WL_NUM_SCAN_MAX		1
#define WL_NUM_PMKIDS_MAX	MAXPMKID	/* will be used
						 * for 2.6.33 kernel
						 * or later
						 */
#define WL_SCAN_BUF_MAX			(1024 * 8)
#define WL_TLV_INFO_MAX			1024
#define WL_BSS_INFO_MAX			2048
#define WL_ASSOC_INFO_MAX	512	/*
				 * needs to grab assoc info from dongle to
				 * report it to cfg80211 through "connect"
				 * event
				 */
#define WL_DCMD_LEN_MAX	1024
#define WL_EXTRA_BUF_MAX	2048
#define WL_ISCAN_BUF_MAX	2048	/*
				 * the buf length can be BRCMF_DCMD_MAXLEN
				 * to reduce iteration
				 */
#define WL_ISCAN_TIMER_INTERVAL_MS	3000
#define WL_SCAN_ERSULTS_LAST	(BRCMF_SCAN_RESULTS_NO_MEM+1)
#define WL_AP_MAX	256	/* virtually unlimitted as long
				 * as kernel memory allows
				 */

#define WL_ROAM_TRIGGER_LEVEL		-75
#define WL_ROAM_DELTA			20
#define WL_BEACON_TIMEOUT		3

#define WL_SCAN_CHANNEL_TIME		40
#define WL_SCAN_UNASSOC_TIME		40
#define WL_SCAN_PASSIVE_TIME		120

#define WL_ESCAN_BUF_SIZE		(1024 * 64)
#define WL_ESCAN_TIMER_INTERVAL_MS	8000 /* E-Scan timeout */

#define WL_ESCAN_ACTION_START		1
#define WL_ESCAN_ACTION_CONTINUE	2
#define WL_ESCAN_ACTION_ABORT		3

#define WL_AUTH_SHARED_KEY		1	/* d11 shared authentication */
#define IE_MAX_LEN			512

/**
 * enum brcmf_scan_status - dongle scan status
 *
 * @BRCMF_SCAN_STATUS_BUSY: scanning in progress on dongle.
 * @BRCMF_SCAN_STATUS_ABORT: scan being aborted on dongle.
 */
enum brcmf_scan_status {
	BRCMF_SCAN_STATUS_BUSY,
	BRCMF_SCAN_STATUS_ABORT,
};

/* wi-fi mode */
enum wl_mode {
	WL_MODE_BSS,
	WL_MODE_IBSS,
	WL_MODE_AP
};

/* dongle profile list */
enum wl_prof_list {
	WL_PROF_MODE,
	WL_PROF_SSID,
	WL_PROF_SEC,
	WL_PROF_IBSS,
	WL_PROF_BAND,
	WL_PROF_BSSID,
	WL_PROF_ACT,
	WL_PROF_BEACONINT,
	WL_PROF_DTIMPERIOD
};

/* dongle iscan state */
enum wl_iscan_state {
	WL_ISCAN_STATE_IDLE,
	WL_ISCAN_STATE_SCANING
};

/* dongle configuration */
struct brcmf_cfg80211_conf {
	u32 mode;		/* adhoc , infrastructure or ap */
	u32 frag_threshold;
	u32 rts_threshold;
	u32 retry_short;
	u32 retry_long;
	s32 tx_power;
	struct ieee80211_channel channel;
};

/* forward declaration */
struct brcmf_cfg80211_info;

/* cfg80211 main event loop */
struct brcmf_cfg80211_event_loop {
	s32(*handler[BRCMF_E_LAST]) (struct brcmf_cfg80211_info *cfg,
				     struct net_device *ndev,
				     const struct brcmf_event_msg *e,
				     void *data);
};

/* basic structure of scan request */
struct brcmf_cfg80211_scan_req {
	struct brcmf_ssid_le ssid_le;
};

/* basic structure of information element */
struct brcmf_cfg80211_ie {
	u16 offset;
	u8 buf[WL_TLV_INFO_MAX];
};

/* event queue for cfg80211 main event */
struct brcmf_cfg80211_event_q {
	struct list_head evt_q_list;
	u32 etype;
	struct brcmf_event_msg emsg;
	s8 edata[1];
};

/* security information with currently associated ap */
struct brcmf_cfg80211_security {
	u32 wpa_versions;
	u32 auth_type;
	u32 cipher_pairwise;
	u32 cipher_group;
	u32 wpa_auth;
};

/* ibss information for currently joined ibss network */
struct brcmf_cfg80211_ibss {
	u8 beacon_interval;	/* in millisecond */
	u8 atim;		/* in millisecond */
	s8 join_only;
	u8 band;
	u8 channel;
};

/* dongle profile */
struct brcmf_cfg80211_profile {
	u32 mode;
	struct brcmf_ssid ssid;
	u8 bssid[ETH_ALEN];
	u16 beacon_interval;
	u8 dtim_period;
	struct brcmf_cfg80211_security sec;
	struct brcmf_cfg80211_ibss ibss;
	s32 band;
};

/**
 * enum brcmf_vif_status - bit indices for vif status.
 *
 * @BRCMF_VIF_STATUS_READY: ready for operation.
 * @BRCMF_VIF_STATUS_CONNECTING: connect/join in progress.
 * @BRCMF_VIF_STATUS_CONNECTED: connected/joined succesfully.
 * @BRCMF_VIF_STATUS_AP_CREATING: interface configured for AP operation.
 * @BRCMF_VIF_STATUS_AP_CREATED: AP operation started.
 */
enum brcmf_vif_status {
	BRCMF_VIF_STATUS_READY,
	BRCMF_VIF_STATUS_CONNECTING,
	BRCMF_VIF_STATUS_CONNECTED,
	BRCMF_VIF_STATUS_AP_CREATING,
	BRCMF_VIF_STATUS_AP_CREATED
};

/**
 * struct brcmf_cfg80211_vif - virtual interface specific information.
 *
 * @ifp: lower layer interface pointer
 * @wdev: wireless device.
 * @profile: profile information.
 * @mode: operating mode.
 * @roam_off: roaming state.
 * @sme_state: SME state using enum brcmf_vif_status bits.
 * @pm_block: power-management blocked.
 * @list: linked list.
 */
struct brcmf_cfg80211_vif {
	struct brcmf_if *ifp;
	struct wireless_dev wdev;
	struct brcmf_cfg80211_profile profile;
	s32 mode;
	s32 roam_off;
	unsigned long sme_state;
	bool pm_block;
	struct list_head list;
};

/* dongle iscan event loop */
struct brcmf_cfg80211_iscan_eloop {
	s32 (*handler[WL_SCAN_ERSULTS_LAST])
		(struct brcmf_cfg80211_info *cfg);
};

/* dongle iscan controller */
struct brcmf_cfg80211_iscan_ctrl {
	struct net_device *ndev;
	struct timer_list timer;
	u32 timer_ms;
	u32 timer_on;
	s32 state;
	struct work_struct work;
	struct brcmf_cfg80211_iscan_eloop el;
	void *data;
	s8 dcmd_buf[BRCMF_DCMD_SMLEN];
	s8 scan_buf[WL_ISCAN_BUF_MAX];
};

/* association inform */
struct brcmf_cfg80211_connect_info {
	u8 *req_ie;
	s32 req_ie_len;
	u8 *resp_ie;
	s32 resp_ie_len;
};

/* assoc ie length */
struct brcmf_cfg80211_assoc_ielen_le {
	__le32 req_len;
	__le32 resp_len;
};

/* wpa2 pmk list */
struct brcmf_cfg80211_pmk_list {
	struct pmkid_list pmkids;
	struct pmkid foo[MAXPMKID - 1];
};

/* dongle escan state */
enum wl_escan_state {
	WL_ESCAN_STATE_IDLE,
	WL_ESCAN_STATE_SCANNING
};

struct escan_info {
	u32 escan_state;
	u8 escan_buf[WL_ESCAN_BUF_SIZE];
	struct wiphy *wiphy;
	struct net_device *ndev;
};

/* Structure to hold WPS, WPA IEs for a AP */
struct ap_info {
	u8 probe_res_ie[IE_MAX_LEN];
	u8 beacon_ie[IE_MAX_LEN];
	u32 probe_res_ie_len;
	u32 beacon_ie_len;
	u8 *wpa_ie;
	u8 *rsn_ie;
	bool security_mode;
};

/**
 * struct brcmf_pno_param_le - PNO scan configuration parameters
 *
 * @version: PNO parameters version.
 * @scan_freq: scan frequency.
 * @lost_network_timeout: #sec. to declare discovered network as lost.
 * @flags: Bit field to control features of PFN such as sort criteria auto
 *	enable switch and background scan.
 * @rssi_margin: Margin to avoid jitter for choosing a PFN based on RSSI sort
 *	criteria.
 * @bestn: number of best networks in each scan.
 * @mscan: number of scans recorded.
 * @repeat: minimum number of scan intervals before scan frequency changes
 *	in adaptive scan.
 * @exp: exponent of 2 for maximum scan interval.
 * @slow_freq: slow scan period.
 */
struct brcmf_pno_param_le {
	__le32 version;
	__le32 scan_freq;
	__le32 lost_network_timeout;
	__le16 flags;
	__le16 rssi_margin;
	u8 bestn;
	u8 mscan;
	u8 repeat;
	u8 exp;
	__le32 slow_freq;
};

/**
 * struct brcmf_pno_net_param_le - scan parameters per preferred network.
 *
 * @ssid: ssid name and its length.
 * @flags: bit2: hidden.
 * @infra: BSS vs IBSS.
 * @auth: Open vs Closed.
 * @wpa_auth: WPA type.
 * @wsec: wsec value.
 */
struct brcmf_pno_net_param_le {
	struct brcmf_ssid_le ssid;
	__le32 flags;
	__le32 infra;
	__le32 auth;
	__le32 wpa_auth;
	__le32 wsec;
};

/**
 * struct brcmf_pno_net_info_le - information per found network.
 *
 * @bssid: BSS network identifier.
 * @channel: channel number only.
 * @SSID_len: length of ssid.
 * @SSID: ssid characters.
 * @RSSI: receive signal strength (in dBm).
 * @timestamp: age in seconds.
 */
struct brcmf_pno_net_info_le {
	u8 bssid[ETH_ALEN];
	u8 channel;
	u8 SSID_len;
	u8 SSID[32];
	__le16	RSSI;
	__le16	timestamp;
};

/**
 * struct brcmf_pno_scanresults_le - result returned in PNO NET FOUND event.
 *
 * @version: PNO version identifier.
 * @status: indicates completion status of PNO scan.
 * @count: amount of brcmf_pno_net_info_le entries appended.
 */
struct brcmf_pno_scanresults_le {
	__le32 version;
	__le32 status;
	__le32 count;
};

/**
 * struct brcmf_cfg80211_info - dongle private data of cfg80211 interface
 *
 * @wiphy: wiphy object for cfg80211 interface.
 * @conf: dongle configuration.
 * @scan_request: cfg80211 scan request object.
 * @el: main event loop.
 * @evt_q_list: used for event queue.
 * @evt_q_lock: for event queue synchronization.
 * @usr_sync: mainly for dongle up/down synchronization.
 * @bss_list: bss_list holding scanned ap information.
 * @scan_results: results of the last scan.
 * @scan_req_int: internal scan request object.
 * @bss_info: bss information for cfg80211 layer.
 * @ie: information element object for internal purpose.
 * @iscan: iscan controller information.
 * @conn_info: association info.
 * @pmk_list: wpa2 pmk list.
 * @event_work: event handler work struct.
 * @scan_status: scan activity on the dongle.
 * @pub: common driver information.
 * @channel: current channel.
 * @iscan_on: iscan on/off switch.
 * @iscan_kickstart: indicate iscan already started.
 * @active_scan: current scan mode.
 * @sched_escan: e-scan for scheduled scan support running.
 * @ibss_starter: indicates this sta is ibss starter.
 * @link_up: link/connection up flag.
 * @pwr_save: indicate whether dongle to support power save mode.
 * @dongle_up: indicate whether dongle up or not.
 * @roam_on: on/off switch for dongle self-roaming.
 * @scan_tried: indicates if first scan attempted.
 * @dcmd_buf: dcmd buffer.
 * @extra_buf: mainly to grab assoc information.
 * @debugfsdir: debugfs folder for this device.
 * @escan_on: escan on/off switch.
 * @escan_info: escan information.
 * @escan_timeout: Timer for catch scan timeout.
 * @escan_timeout_work: scan timeout worker.
 * @escan_ioctl_buf: dongle command buffer for escan commands.
 * @ap_info: host ap information.
 * @vif_list: linked list of vif instances.
 * @vif_cnt: number of vif instances.
 */
struct brcmf_cfg80211_info {
	struct wiphy *wiphy;
	struct brcmf_cfg80211_conf *conf;
	struct cfg80211_scan_request *scan_request;
	struct brcmf_cfg80211_event_loop el;
	struct list_head evt_q_list;
	spinlock_t	 evt_q_lock;
	struct mutex usr_sync;
	struct brcmf_scan_results *bss_list;
	struct brcmf_scan_results *scan_results;
	struct brcmf_cfg80211_scan_req *scan_req_int;
	struct wl_cfg80211_bss_info *bss_info;
	struct brcmf_cfg80211_ie ie;
	struct brcmf_cfg80211_iscan_ctrl *iscan;
	struct brcmf_cfg80211_connect_info conn_info;
	struct brcmf_cfg80211_pmk_list *pmk_list;
	struct work_struct event_work;
	unsigned long scan_status;
	struct brcmf_pub *pub;
	u32 channel;
	bool iscan_on;
	bool iscan_kickstart;
	bool active_scan;
	bool sched_escan;
	bool ibss_starter;
	bool link_up;
	bool pwr_save;
	bool dongle_up;
	bool roam_on;
	bool scan_tried;
	u8 *dcmd_buf;
	u8 *extra_buf;
	struct dentry *debugfsdir;
	bool escan_on;
	struct escan_info escan_info;
	struct timer_list escan_timeout;
	struct work_struct escan_timeout_work;
	u8 *escan_ioctl_buf;
	struct ap_info *ap_info;
	struct list_head vif_list;
	u8 vif_cnt;
};

static inline struct wiphy *cfg_to_wiphy(struct brcmf_cfg80211_info *cfg)
{
	return cfg->wiphy;
}

static inline struct brcmf_cfg80211_info *wiphy_to_cfg(struct wiphy *w)
{
	return (struct brcmf_cfg80211_info *)(wiphy_priv(w));
}

static inline struct brcmf_cfg80211_info *wdev_to_cfg(struct wireless_dev *wd)
{
	return (struct brcmf_cfg80211_info *)(wdev_priv(wd));
}

static inline
struct net_device *cfg_to_ndev(struct brcmf_cfg80211_info *cfg)
{
	struct brcmf_cfg80211_vif *vif;
	vif = list_first_entry(&cfg->vif_list, struct brcmf_cfg80211_vif, list);
	return vif->wdev.netdev;
}

static inline struct brcmf_cfg80211_info *ndev_to_cfg(struct net_device *ndev)
{
	return wdev_to_cfg(ndev->ieee80211_ptr);
}

static inline struct brcmf_cfg80211_profile *ndev_to_prof(struct net_device *nd)
{
	struct brcmf_if *ifp = netdev_priv(nd);
	return &ifp->vif->profile;
}

#define iscan_to_cfg(i) ((struct brcmf_cfg80211_info *)(i->data))
#define cfg_to_iscan(w) (w->iscan)

static inline struct
brcmf_cfg80211_connect_info *cfg_to_conn(struct brcmf_cfg80211_info *cfg)
{
	return &cfg->conn_info;
}

struct brcmf_cfg80211_info *brcmf_cfg80211_attach(struct brcmf_pub *drvr);
void brcmf_cfg80211_detach(struct brcmf_cfg80211_info *cfg);

/* event handler from dongle */
void brcmf_cfg80211_event(struct net_device *ndev,
			  const struct brcmf_event_msg *e, void *data);
s32 brcmf_cfg80211_up(struct brcmf_cfg80211_info *cfg);
s32 brcmf_cfg80211_down(struct brcmf_cfg80211_info *cfg);

#endif				/* _wl_cfg80211_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	#ifndef _wl_cfg80211_h_
	18	#define _wl_cfg80211_h_
	19
5b435de0 AS	20	#define WL_DBG_NONE 0
	21	#define WL_DBG_CONN (1 << 5)
	22	#define WL_DBG_SCAN (1 << 4)
	23	#define WL_DBG_TRACE (1 << 3)
	24	#define WL_DBG_INFO (1 << 1)
	25	#define WL_DBG_ERR (1 << 0)
	26	#define WL_DBG_MASK ((WL_DBG_INFO \| WL_DBG_ERR \| WL_DBG_TRACE) \| \
	27	(WL_DBG_SCAN) \| (WL_DBG_CONN))
	28
02f77195	29	#define WL_ERR(fmt, ...) \
5b435de0 AS	30	do { \
	31	if (brcmf_dbg_level & WL_DBG_ERR) { \
	32	if (net_ratelimit()) { \
02f77195 JP	33	pr_err("ERROR @%s : " fmt, \
02f77195 JP	34	__func__, ##__VA_ARGS__); \
5b435de0 AS	35	} \
	36	} \
	37	} while (0)
	38
8ae74654	39	#if (defined DEBUG)
02f77195	40	#define WL_INFO(fmt, ...) \
5b435de0 AS	41	do { \
	42	if (brcmf_dbg_level & WL_DBG_INFO) { \
	43	if (net_ratelimit()) { \
02f77195 JP	44	pr_err("INFO @%s : " fmt, \
02f77195 JP	45	__func__, ##__VA_ARGS__); \
5b435de0 AS	46	} \
	47	} \
	48	} while (0)
	49
02f77195	50	#define WL_TRACE(fmt, ...) \
5b435de0 AS	51	do { \
	52	if (brcmf_dbg_level & WL_DBG_TRACE) { \
	53	if (net_ratelimit()) { \
02f77195 JP	54	pr_err("TRACE @%s : " fmt, \
02f77195 JP	55	__func__, ##__VA_ARGS__); \
5b435de0 AS	56	} \
	57	} \
	58	} while (0)
	59
02f77195	60	#define WL_SCAN(fmt, ...) \
5b435de0 AS	61	do { \
	62	if (brcmf_dbg_level & WL_DBG_SCAN) { \
	63	if (net_ratelimit()) { \
02f77195 JP	64	pr_err("SCAN @%s : " fmt, \
02f77195 JP	65	__func__, ##__VA_ARGS__); \
5b435de0 AS	66	} \
	67	} \
	68	} while (0)
	69
02f77195	70	#define WL_CONN(fmt, ...) \
5b435de0 AS	71	do { \
	72	if (brcmf_dbg_level & WL_DBG_CONN) { \
	73	if (net_ratelimit()) { \
02f77195 JP	74	pr_err("CONN @%s : " fmt, \
02f77195 JP	75	__func__, ##__VA_ARGS__); \
5b435de0 AS	76	} \
	77	} \
	78	} while (0)
	79
8ae74654	80	#else /* (defined DEBUG) */
5b435de0 AS	81	#define WL_INFO(fmt, args...)
	82	#define WL_TRACE(fmt, args...)
	83	#define WL_SCAN(fmt, args...)
	84	#define WL_CONN(fmt, args...)
8ae74654	85	#endif /* (defined DEBUG) */
5b435de0 AS	86
	87	#define WL_NUM_SCAN_MAX 1
	88	#define WL_NUM_PMKIDS_MAX MAXPMKID /* will be used
	89	* for 2.6.33 kernel
	90	* or later
	91	*/
	92	#define WL_SCAN_BUF_MAX (1024 * 8)
	93	#define WL_TLV_INFO_MAX 1024
	94	#define WL_BSS_INFO_MAX 2048
	95	#define WL_ASSOC_INFO_MAX 512 /*
	96	* needs to grab assoc info from dongle to
	97	* report it to cfg80211 through "connect"
	98	* event
	99	*/
	100	#define WL_DCMD_LEN_MAX 1024
	101	#define WL_EXTRA_BUF_MAX 2048
	102	#define WL_ISCAN_BUF_MAX 2048 /*
	103	* the buf length can be BRCMF_DCMD_MAXLEN
	104	* to reduce iteration
	105	*/
	106	#define WL_ISCAN_TIMER_INTERVAL_MS 3000
	107	#define WL_SCAN_ERSULTS_LAST (BRCMF_SCAN_RESULTS_NO_MEM+1)
	108	#define WL_AP_MAX 256 /* virtually unlimitted as long
	109	* as kernel memory allows
	110	*/
	111
	112	#define WL_ROAM_TRIGGER_LEVEL -75
	113	#define WL_ROAM_DELTA 20
	114	#define WL_BEACON_TIMEOUT 3
	115
	116	#define WL_SCAN_CHANNEL_TIME 40
	117	#define WL_SCAN_UNASSOC_TIME 40
	118	#define WL_SCAN_PASSIVE_TIME 120
	119
e756af5b HM	120	#define WL_ESCAN_BUF_SIZE (1024 * 64)
	121	#define WL_ESCAN_TIMER_INTERVAL_MS 8000 /* E-Scan timeout */
	122
	123	#define WL_ESCAN_ACTION_START 1
	124	#define WL_ESCAN_ACTION_CONTINUE 2
	125	#define WL_ESCAN_ACTION_ABORT 3
	126
f09d0c02	127	#define WL_AUTH_SHARED_KEY 1 /* d11 shared authentication */
1a873342	128	#define IE_MAX_LEN 512
f09d0c02	129
c1179033 AS	130	/**
	131	* enum brcmf_scan_status - dongle scan status
	132	*
	133	* @BRCMF_SCAN_STATUS_BUSY: scanning in progress on dongle.
	134	* @BRCMF_SCAN_STATUS_ABORT: scan being aborted on dongle.
	135	*/
	136	enum brcmf_scan_status {
	137	BRCMF_SCAN_STATUS_BUSY,
	138	BRCMF_SCAN_STATUS_ABORT,
5b435de0 AS	139	};
	140
	141	/* wi-fi mode */
	142	enum wl_mode {
	143	WL_MODE_BSS,
	144	WL_MODE_IBSS,
	145	WL_MODE_AP
	146	};
	147
	148	/* dongle profile list */
	149	enum wl_prof_list {
	150	WL_PROF_MODE,
	151	WL_PROF_SSID,
	152	WL_PROF_SEC,
	153	WL_PROF_IBSS,
	154	WL_PROF_BAND,
	155	WL_PROF_BSSID,
	156	WL_PROF_ACT,
	157	WL_PROF_BEACONINT,
	158	WL_PROF_DTIMPERIOD
	159	};
	160
	161	/* dongle iscan state */
	162	enum wl_iscan_state {
	163	WL_ISCAN_STATE_IDLE,
	164	WL_ISCAN_STATE_SCANING
	165	};
	166
	167	/* dongle configuration */
	168	struct brcmf_cfg80211_conf {
	169	u32 mode; /* adhoc , infrastructure or ap */
	170	u32 frag_threshold;
	171	u32 rts_threshold;
	172	u32 retry_short;
	173	u32 retry_long;
	174	s32 tx_power;
	175	struct ieee80211_channel channel;
	176	};
	177
5db6e956	178	/* forward declaration */
27a68fe3	179	struct brcmf_cfg80211_info;
5db6e956	180
5b435de0 AS	181	/* cfg80211 main event loop */
5b435de0 AS	182	struct brcmf_cfg80211_event_loop {
27a68fe3	183	s32(handler[BRCMF_E_LAST]) (struct brcmf_cfg80211_info cfg,
5b435de0 AS	184	struct net_device *ndev,
	185	const struct brcmf_event_msg *e,
	186	void *data);
	187	};
	188
5b435de0 AS	189	/* basic structure of scan request */
	190	struct brcmf_cfg80211_scan_req {
	191	struct brcmf_ssid_le ssid_le;
	192	};
	193
	194	/* basic structure of information element */
	195	struct brcmf_cfg80211_ie {
	196	u16 offset;
	197	u8 buf[WL_TLV_INFO_MAX];
	198	};
	199
	200	/* event queue for cfg80211 main event */
	201	struct brcmf_cfg80211_event_q {
	202	struct list_head evt_q_list;
	203	u32 etype;
	204	struct brcmf_event_msg emsg;
	205	s8 edata[1];
	206	};
	207
	208	/* security information with currently associated ap */
	209	struct brcmf_cfg80211_security {
	210	u32 wpa_versions;
	211	u32 auth_type;
	212	u32 cipher_pairwise;
	213	u32 cipher_group;
	214	u32 wpa_auth;
	215	};
	216
	217	/* ibss information for currently joined ibss network */
	218	struct brcmf_cfg80211_ibss {
	219	u8 beacon_interval; /* in millisecond */
	220	u8 atim; /* in millisecond */
	221	s8 join_only;
	222	u8 band;
	223	u8 channel;
	224	};
	225
	226	/* dongle profile */
	227	struct brcmf_cfg80211_profile {
	228	u32 mode;
	229	struct brcmf_ssid ssid;
	230	u8 bssid[ETH_ALEN];
	231	u16 beacon_interval;
	232	u8 dtim_period;
	233	struct brcmf_cfg80211_security sec;
	234	struct brcmf_cfg80211_ibss ibss;
	235	s32 band;
	236	};
	237
c1179033 AS	238	/**
	239	* enum brcmf_vif_status - bit indices for vif status.
	240	*
	241	* @BRCMF_VIF_STATUS_READY: ready for operation.
	242	* @BRCMF_VIF_STATUS_CONNECTING: connect/join in progress.
	243	* @BRCMF_VIF_STATUS_CONNECTED: connected/joined succesfully.
	244	* @BRCMF_VIF_STATUS_AP_CREATING: interface configured for AP operation.
	245	* @BRCMF_VIF_STATUS_AP_CREATED: AP operation started.
	246	*/
	247	enum brcmf_vif_status {
	248	BRCMF_VIF_STATUS_READY,
	249	BRCMF_VIF_STATUS_CONNECTING,
	250	BRCMF_VIF_STATUS_CONNECTED,
	251	BRCMF_VIF_STATUS_AP_CREATING,
	252	BRCMF_VIF_STATUS_AP_CREATED
	253	};
	254
3eacf866 AS	255	/**
	256	* struct brcmf_cfg80211_vif - virtual interface specific information.
	257	*
	258	* @ifp: lower layer interface pointer
	259	* @wdev: wireless device.
6ac4f4ed	260	* @profile: profile information.
3eacf866 AS	261	* @mode: operating mode.
3eacf866 AS	262	* @roam_off: roaming state.
c1179033	263	* @sme_state: SME state using enum brcmf_vif_status bits.
3eacf866 AS	264	* @pm_block: power-management blocked.
	265	* @list: linked list.
	266	*/
	267	struct brcmf_cfg80211_vif {
	268	struct brcmf_if *ifp;
	269	struct wireless_dev wdev;
6ac4f4ed	270	struct brcmf_cfg80211_profile profile;
3eacf866 AS	271	s32 mode;
3eacf866 AS	272	s32 roam_off;
c1179033	273	unsigned long sme_state;
3eacf866 AS	274	bool pm_block;
	275	struct list_head list;
	276	};
	277
5b435de0 AS	278	/* dongle iscan event loop */
	279	struct brcmf_cfg80211_iscan_eloop {
	280	s32 (*handler[WL_SCAN_ERSULTS_LAST])
27a68fe3	281	(struct brcmf_cfg80211_info *cfg);
5b435de0 AS	282	};
	283
	284	/* dongle iscan controller */
	285	struct brcmf_cfg80211_iscan_ctrl {
	286	struct net_device *ndev;
	287	struct timer_list timer;
	288	u32 timer_ms;
	289	u32 timer_on;
	290	s32 state;
	291	struct work_struct work;
	292	struct brcmf_cfg80211_iscan_eloop el;
	293	void *data;
	294	s8 dcmd_buf[BRCMF_DCMD_SMLEN];
	295	s8 scan_buf[WL_ISCAN_BUF_MAX];
	296	};
	297
	298	/* association inform */
	299	struct brcmf_cfg80211_connect_info {
	300	u8 *req_ie;
	301	s32 req_ie_len;
	302	u8 *resp_ie;
	303	s32 resp_ie_len;
	304	};
	305
	306	/* assoc ie length */
c4e382d2 AS	307	struct brcmf_cfg80211_assoc_ielen_le {
	308	__le32 req_len;
	309	__le32 resp_len;
5b435de0 AS	310	};
	311
	312	/* wpa2 pmk list */
	313	struct brcmf_cfg80211_pmk_list {
	314	struct pmkid_list pmkids;
	315	struct pmkid foo[MAXPMKID - 1];
	316	};
	317
e756af5b HM	318	/* dongle escan state */
	319	enum wl_escan_state {
	320	WL_ESCAN_STATE_IDLE,
	321	WL_ESCAN_STATE_SCANNING
	322	};
	323
	324	struct escan_info {
	325	u32 escan_state;
	326	u8 escan_buf[WL_ESCAN_BUF_SIZE];
	327	struct wiphy *wiphy;
	328	struct net_device *ndev;
	329	};
	330
1a873342 HM	331	/* Structure to hold WPS, WPA IEs for a AP */
	332	struct ap_info {
	333	u8 probe_res_ie[IE_MAX_LEN];
	334	u8 beacon_ie[IE_MAX_LEN];
	335	u32 probe_res_ie_len;
	336	u32 beacon_ie_len;
	337	u8 *wpa_ie;
	338	u8 *rsn_ie;
	339	bool security_mode;
	340	};
	341
e5806072 AS	342	/**
	343	* struct brcmf_pno_param_le - PNO scan configuration parameters
	344	*
	345	* @version: PNO parameters version.
	346	* @scan_freq: scan frequency.
	347	* @lost_network_timeout: #sec. to declare discovered network as lost.
	348	* @flags: Bit field to control features of PFN such as sort criteria auto
	349	* enable switch and background scan.
	350	* @rssi_margin: Margin to avoid jitter for choosing a PFN based on RSSI sort
	351	* criteria.
	352	* @bestn: number of best networks in each scan.
	353	* @mscan: number of scans recorded.
	354	* @repeat: minimum number of scan intervals before scan frequency changes
	355	* in adaptive scan.
	356	* @exp: exponent of 2 for maximum scan interval.
	357	* @slow_freq: slow scan period.
	358	*/
	359	struct brcmf_pno_param_le {
	360	__le32 version;
	361	__le32 scan_freq;
	362	__le32 lost_network_timeout;
	363	__le16 flags;
	364	__le16 rssi_margin;
	365	u8 bestn;
	366	u8 mscan;
	367	u8 repeat;
	368	u8 exp;
	369	__le32 slow_freq;
	370	};
	371
	372	/**
	373	* struct brcmf_pno_net_param_le - scan parameters per preferred network.
	374	*
	375	* @ssid: ssid name and its length.
	376	* @flags: bit2: hidden.
	377	* @infra: BSS vs IBSS.
	378	* @auth: Open vs Closed.
	379	* @wpa_auth: WPA type.
	380	* @wsec: wsec value.
	381	*/
	382	struct brcmf_pno_net_param_le {
	383	struct brcmf_ssid_le ssid;
	384	__le32 flags;
	385	__le32 infra;
	386	__le32 auth;
	387	__le32 wpa_auth;
	388	__le32 wsec;
	389	};
	390
	391	/**
	392	* struct brcmf_pno_net_info_le - information per found network.
	393	*
	394	* @bssid: BSS network identifier.
	395	* @channel: channel number only.
	396	* @SSID_len: length of ssid.
	397	* @SSID: ssid characters.
	398	* @RSSI: receive signal strength (in dBm).
	399	* @timestamp: age in seconds.
	400	*/
	401	struct brcmf_pno_net_info_le {
	402	u8 bssid[ETH_ALEN];
	403	u8 channel;
	404	u8 SSID_len;
	405	u8 SSID[32];
406	__le16 RSSI;
407	__le16 timestamp;
408	};
409
410	/**
411	* struct brcmf_pno_scanresults_le - result returned in PNO NET FOUND event.
412	*
413	* @version: PNO version identifier.
414	* @status: indicates completion status of PNO scan.
415	* @count: amount of brcmf_pno_net_info_le entries appended.
416	*/
417	struct brcmf_pno_scanresults_le {
418	__le32 version;
419	__le32 status;
420	__le32 count;
421	};
422
02030eb6	423	/**
27a68fe3	424	* struct brcmf_cfg80211_info - dongle private data of cfg80211 interface
02030eb6	425	*
3eacf866	426	* @wiphy: wiphy object for cfg80211 interface.
02030eb6 AS	427	* @conf: dongle configuration.
	428	* @scan_request: cfg80211 scan request object.
	429	* @el: main event loop.
	430	* @evt_q_list: used for event queue.
	431	* @evt_q_lock: for event queue synchronization.
	432	* @usr_sync: mainly for dongle up/down synchronization.
	433	* @bss_list: bss_list holding scanned ap information.
	434	* @scan_results: results of the last scan.
	435	* @scan_req_int: internal scan request object.
	436	* @bss_info: bss information for cfg80211 layer.
	437	* @ie: information element object for internal purpose.
02030eb6 AS	438	* @iscan: iscan controller information.
	439	* @conn_info: association info.
	440	* @pmk_list: wpa2 pmk list.
	441	* @event_work: event handler work struct.
c1179033	442	* @scan_status: scan activity on the dongle.
02030eb6 AS	443	* @pub: common driver information.
	444	* @channel: current channel.
	445	* @iscan_on: iscan on/off switch.
	446	* @iscan_kickstart: indicate iscan already started.
	447	* @active_scan: current scan mode.
	448	* @sched_escan: e-scan for scheduled scan support running.
	449	* @ibss_starter: indicates this sta is ibss starter.
	450	* @link_up: link/connection up flag.
	451	* @pwr_save: indicate whether dongle to support power save mode.
	452	* @dongle_up: indicate whether dongle up or not.
	453	* @roam_on: on/off switch for dongle self-roaming.
	454	* @scan_tried: indicates if first scan attempted.
	455	* @dcmd_buf: dcmd buffer.
	456	* @extra_buf: mainly to grab assoc information.
	457	* @debugfsdir: debugfs folder for this device.
	458	* @escan_on: escan on/off switch.
	459	* @escan_info: escan information.
	460	* @escan_timeout: Timer for catch scan timeout.
	461	* @escan_timeout_work: scan timeout worker.
	462	* @escan_ioctl_buf: dongle command buffer for escan commands.
1a873342	463	* @ap_info: host ap information.
3eacf866 AS	464	* @vif_list: linked list of vif instances.
3eacf866 AS	465	* @vif_cnt: number of vif instances.
02030eb6	466	*/
27a68fe3	467	struct brcmf_cfg80211_info {
3eacf866	468	struct wiphy *wiphy;
02030eb6 AS	469	struct brcmf_cfg80211_conf *conf;
	470	struct cfg80211_scan_request *scan_request;
	471	struct brcmf_cfg80211_event_loop el;
	472	struct list_head evt_q_list;
	473	spinlock_t evt_q_lock;
	474	struct mutex usr_sync;
	475	struct brcmf_scan_results *bss_list;
5b435de0	476	struct brcmf_scan_results *scan_results;
02030eb6 AS	477	struct brcmf_cfg80211_scan_req *scan_req_int;
	478	struct wl_cfg80211_bss_info *bss_info;
	479	struct brcmf_cfg80211_ie ie;
02030eb6 AS	480	struct brcmf_cfg80211_iscan_ctrl *iscan;
	481	struct brcmf_cfg80211_connect_info conn_info;
	482	struct brcmf_cfg80211_pmk_list *pmk_list;
	483	struct work_struct event_work;
c1179033	484	unsigned long scan_status;
ee928381	485	struct brcmf_pub *pub;
02030eb6 AS	486	u32 channel;
	487	bool iscan_on;
	488	bool iscan_kickstart;
	489	bool active_scan;
	490	bool sched_escan;
	491	bool ibss_starter;
	492	bool link_up;
	493	bool pwr_save;
	494	bool dongle_up;
	495	bool roam_on;
	496	bool scan_tried;
	497	u8 *dcmd_buf;
	498	u8 *extra_buf;
5b435de0	499	struct dentry *debugfsdir;
02030eb6 AS	500	bool escan_on;
	501	struct escan_info escan_info;
	502	struct timer_list escan_timeout;
	503	struct work_struct escan_timeout_work;
e756af5b	504	u8 *escan_ioctl_buf;
1a873342	505	struct ap_info *ap_info;
3eacf866 AS	506	struct list_head vif_list;
3eacf866 AS	507	u8 vif_cnt;
5b435de0 AS	508	};
5b435de0 AS	509
3eacf866	510	static inline struct wiphy cfg_to_wiphy(struct brcmf_cfg80211_info cfg)
5b435de0	511	{
3eacf866	512	return cfg->wiphy;
5b435de0 AS	513	}
5b435de0 AS	514
27a68fe3	515	static inline struct brcmf_cfg80211_info wiphy_to_cfg(struct wiphy w)
5b435de0	516	{
27a68fe3	517	return (struct brcmf_cfg80211_info *)(wiphy_priv(w));
5b435de0 AS	518	}
5b435de0 AS	519
27a68fe3	520	static inline struct brcmf_cfg80211_info wdev_to_cfg(struct wireless_dev wd)
5b435de0	521	{
27a68fe3	522	return (struct brcmf_cfg80211_info *)(wdev_priv(wd));
5b435de0 AS	523	}
5b435de0 AS	524
3eacf866 AS	525	static inline
3eacf866 AS	526	struct net_device cfg_to_ndev(struct brcmf_cfg80211_info cfg)
5b435de0	527	{
3eacf866 AS	528	struct brcmf_cfg80211_vif *vif;
	529	vif = list_first_entry(&cfg->vif_list, struct brcmf_cfg80211_vif, list);
	530	return vif->wdev.netdev;
5b435de0 AS	531	}
5b435de0 AS	532
27a68fe3	533	static inline struct brcmf_cfg80211_info ndev_to_cfg(struct net_device ndev)
5b435de0 AS	534	{
	535	return wdev_to_cfg(ndev->ieee80211_ptr);
	536	}
	537
6ac4f4ed AS	538	static inline struct brcmf_cfg80211_profile ndev_to_prof(struct net_device nd)
	539	{
	540	struct brcmf_if *ifp = netdev_priv(nd);
	541	return &ifp->vif->profile;
	542	}
	543
27a68fe3	544	#define iscan_to_cfg(i) ((struct brcmf_cfg80211_info *)(i->data))
5b435de0 AS	545	#define cfg_to_iscan(w) (w->iscan)
	546
	547	static inline struct
27a68fe3	548	brcmf_cfg80211_connect_info cfg_to_conn(struct brcmf_cfg80211_info cfg)
5b435de0 AS	549	{
	550	return &cfg->conn_info;
	551	}
	552
1ed9baf0	553	struct brcmf_cfg80211_info brcmf_cfg80211_attach(struct brcmf_pub drvr);
27a68fe3	554	void brcmf_cfg80211_detach(struct brcmf_cfg80211_info *cfg);
5b435de0 AS	555
5b435de0 AS	556	/* event handler from dongle */
c3567a04 AS	557	void brcmf_cfg80211_event(struct net_device *ndev,
c3567a04 AS	558	const struct brcmf_event_msg e, void data);
27a68fe3 AS	559	s32 brcmf_cfg80211_up(struct brcmf_cfg80211_info *cfg);
27a68fe3 AS	560	s32 brcmf_cfg80211_down(struct brcmf_cfg80211_info *cfg);
5b435de0 AS	561
5b435de0 AS	562	#endif /* _wl_cfg80211_h_ */