[deliverable/linux.git] / drivers / net / wireless / wl12xx / wl1271.h

/*
 * This file is part of wl1271
 *
 * Copyright (C) 1998-2009 Texas Instruments. All rights reserved.
 * Copyright (C) 2008-2009 Nokia Corporation
 *
 * Contact: Luciano Coelho <luciano.coelho@nokia.com>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * version 2 as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 */

#ifndef __WL1271_H__
#define __WL1271_H__

#include <linux/mutex.h>
#include <linux/completion.h>
#include <linux/spinlock.h>
#include <linux/list.h>
#include <linux/bitops.h>
#include <net/mac80211.h>

#include "wl1271_conf.h"

#define DRIVER_NAME "wl1271"
#define DRIVER_PREFIX DRIVER_NAME ": "

enum {
	DEBUG_NONE	= 0,
	DEBUG_IRQ	= BIT(0),
	DEBUG_SPI	= BIT(1),
	DEBUG_BOOT	= BIT(2),
	DEBUG_MAILBOX	= BIT(3),
	DEBUG_TESTMODE	= BIT(4),
	DEBUG_EVENT	= BIT(5),
	DEBUG_TX	= BIT(6),
	DEBUG_RX	= BIT(7),
	DEBUG_SCAN	= BIT(8),
	DEBUG_CRYPT	= BIT(9),
	DEBUG_PSM	= BIT(10),
	DEBUG_MAC80211	= BIT(11),
	DEBUG_CMD	= BIT(12),
	DEBUG_ACX	= BIT(13),
	DEBUG_SDIO	= BIT(14),
	DEBUG_FILTERS   = BIT(15),
	DEBUG_ALL	= ~0,
};

#define DEBUG_LEVEL (DEBUG_NONE)

#define DEBUG_DUMP_LIMIT 1024

#define wl1271_error(fmt, arg...) \
	printk(KERN_ERR DRIVER_PREFIX "ERROR " fmt "\n", ##arg)

#define wl1271_warning(fmt, arg...) \
	printk(KERN_WARNING DRIVER_PREFIX "WARNING " fmt "\n", ##arg)

#define wl1271_notice(fmt, arg...) \
	printk(KERN_INFO DRIVER_PREFIX fmt "\n", ##arg)

#define wl1271_info(fmt, arg...) \
	printk(KERN_DEBUG DRIVER_PREFIX fmt "\n", ##arg)

#define wl1271_debug(level, fmt, arg...) \
	do { \
		if (level & DEBUG_LEVEL) \
			printk(KERN_DEBUG DRIVER_PREFIX fmt "\n", ##arg); \
	} while (0)

#define wl1271_dump(level, prefix, buf, len)	\
	do { \
		if (level & DEBUG_LEVEL) \
			print_hex_dump(KERN_DEBUG, DRIVER_PREFIX prefix, \
				       DUMP_PREFIX_OFFSET, 16, 1,	\
				       buf,				\
				       min_t(size_t, len, DEBUG_DUMP_LIMIT), \
				       0);				\
	} while (0)

#define wl1271_dump_ascii(level, prefix, buf, len)	\
	do { \
		if (level & DEBUG_LEVEL) \
			print_hex_dump(KERN_DEBUG, DRIVER_PREFIX prefix, \
				       DUMP_PREFIX_OFFSET, 16, 1,	\
				       buf,				\
				       min_t(size_t, len, DEBUG_DUMP_LIMIT), \
				       true);				\
	} while (0)

#define WL1271_DEFAULT_RX_CONFIG (CFG_UNI_FILTER_EN |	\
				  CFG_BSSID_FILTER_EN | \
				  CFG_MC_FILTER_EN)

#define WL1271_DEFAULT_RX_FILTER (CFG_RX_RCTS_ACK | CFG_RX_PRSP_EN |  \
				  CFG_RX_MGMT_EN | CFG_RX_DATA_EN |   \
				  CFG_RX_CTL_EN | CFG_RX_BCN_EN |     \
				  CFG_RX_AUTH_EN | CFG_RX_ASSOC_EN)

#define WL1271_FW_NAME "wl1271-fw.bin"
#define WL1271_NVS_NAME "wl1271-nvs.bin"

#define WL1271_TX_SECURITY_LO16(s) ((u16)((s) & 0xffff))
#define WL1271_TX_SECURITY_HI32(s) ((u32)(((s) >> 16) & 0xffffffff))

/* NVS data structure */
#define WL1271_NVS_SECTION_SIZE                  468

#define WL1271_NVS_GENERAL_PARAMS_SIZE            57
#define WL1271_NVS_GENERAL_PARAMS_SIZE_PADDED \
	(WL1271_NVS_GENERAL_PARAMS_SIZE + 1)
#define WL1271_NVS_STAT_RADIO_PARAMS_SIZE         17
#define WL1271_NVS_STAT_RADIO_PARAMS_SIZE_PADDED \
	(WL1271_NVS_STAT_RADIO_PARAMS_SIZE + 1)
#define WL1271_NVS_DYN_RADIO_PARAMS_SIZE          65
#define WL1271_NVS_DYN_RADIO_PARAMS_SIZE_PADDED \
	(WL1271_NVS_DYN_RADIO_PARAMS_SIZE + 1)
#define WL1271_NVS_FEM_COUNT                       2
#define WL1271_NVS_INI_SPARE_SIZE                124

struct wl1271_nvs_file {
	/* NVS section */
	u8 nvs[WL1271_NVS_SECTION_SIZE];

	/* INI section */
	u8 general_params[WL1271_NVS_GENERAL_PARAMS_SIZE_PADDED];
	u8 stat_radio_params[WL1271_NVS_STAT_RADIO_PARAMS_SIZE_PADDED];
	u8 dyn_radio_params[WL1271_NVS_FEM_COUNT]
			   [WL1271_NVS_DYN_RADIO_PARAMS_SIZE_PADDED];
	u8 ini_spare[WL1271_NVS_INI_SPARE_SIZE];
} __attribute__ ((packed));

/*
 * Enable/disable 802.11a support for WL1273
 */
#undef WL1271_80211A_ENABLED

/*
 * FIXME: for the wl1271, a busy word count of 1 here will result in a more
 * optimal SPI interface. There is some SPI bug however, causing RXS time outs
 * with this mode occasionally on boot, so lets have three for now. A value of
 * three should make sure, that the chipset will always be ready, though this
 * will impact throughput and latencies slightly.
 */
#define WL1271_BUSY_WORD_CNT 3
#define WL1271_BUSY_WORD_LEN (WL1271_BUSY_WORD_CNT * sizeof(u32))

#define WL1271_ELP_HW_STATE_ASLEEP 0
#define WL1271_ELP_HW_STATE_IRQ    1

#define WL1271_DEFAULT_BEACON_INT  100
#define WL1271_DEFAULT_DTIM_PERIOD 1

#define ACX_TX_DESCRIPTORS         32

enum wl1271_state {
	WL1271_STATE_OFF,
	WL1271_STATE_ON,
	WL1271_STATE_PLT,
};

enum wl1271_partition_type {
	PART_DOWN,
	PART_WORK,
	PART_DRPW,

	PART_TABLE_LEN
};

struct wl1271_partition {
	u32 size;
	u32 start;
};

struct wl1271_partition_set {
	struct wl1271_partition mem;
	struct wl1271_partition reg;
	struct wl1271_partition mem2;
	struct wl1271_partition mem3;
};

struct wl1271;

/* FIXME: I'm not sure about this structure name */
struct wl1271_chip {
	u32 id;
	char fw_ver[21];
};

struct wl1271_stats {
	struct acx_statistics *fw_stats;
	unsigned long fw_stats_update;

	unsigned int retry_count;
	unsigned int excessive_retries;
};

struct wl1271_debugfs {
	struct dentry *rootdir;
	struct dentry *fw_statistics;

	struct dentry *tx_internal_desc_overflow;

	struct dentry *rx_out_of_mem;
	struct dentry *rx_hdr_overflow;
	struct dentry *rx_hw_stuck;
	struct dentry *rx_dropped;
	struct dentry *rx_fcs_err;
	struct dentry *rx_xfr_hint_trig;
	struct dentry *rx_path_reset;
	struct dentry *rx_reset_counter;

	struct dentry *dma_rx_requested;
	struct dentry *dma_rx_errors;
	struct dentry *dma_tx_requested;
	struct dentry *dma_tx_errors;

	struct dentry *isr_cmd_cmplt;
	struct dentry *isr_fiqs;
	struct dentry *isr_rx_headers;
	struct dentry *isr_rx_mem_overflow;
	struct dentry *isr_rx_rdys;
	struct dentry *isr_irqs;
	struct dentry *isr_tx_procs;
	struct dentry *isr_decrypt_done;
	struct dentry *isr_dma0_done;
	struct dentry *isr_dma1_done;
	struct dentry *isr_tx_exch_complete;
	struct dentry *isr_commands;
	struct dentry *isr_rx_procs;
	struct dentry *isr_hw_pm_mode_changes;
	struct dentry *isr_host_acknowledges;
	struct dentry *isr_pci_pm;
	struct dentry *isr_wakeups;
	struct dentry *isr_low_rssi;

	struct dentry *wep_addr_key_count;
	struct dentry *wep_default_key_count;
	/* skipping wep.reserved */
	struct dentry *wep_key_not_found;
	struct dentry *wep_decrypt_fail;
	struct dentry *wep_packets;
	struct dentry *wep_interrupt;

	struct dentry *pwr_ps_enter;
	struct dentry *pwr_elp_enter;
	struct dentry *pwr_missing_bcns;
	struct dentry *pwr_wake_on_host;
	struct dentry *pwr_wake_on_timer_exp;
	struct dentry *pwr_tx_with_ps;
	struct dentry *pwr_tx_without_ps;
	struct dentry *pwr_rcvd_beacons;
	struct dentry *pwr_power_save_off;
	struct dentry *pwr_enable_ps;
	struct dentry *pwr_disable_ps;
	struct dentry *pwr_fix_tsf_ps;
	/* skipping cont_miss_bcns_spread for now */
	struct dentry *pwr_rcvd_awake_beacons;

	struct dentry *mic_rx_pkts;
	struct dentry *mic_calc_failure;

	struct dentry *aes_encrypt_fail;
	struct dentry *aes_decrypt_fail;
	struct dentry *aes_encrypt_packets;
	struct dentry *aes_decrypt_packets;
	struct dentry *aes_encrypt_interrupt;
	struct dentry *aes_decrypt_interrupt;

	struct dentry *event_heart_beat;
	struct dentry *event_calibration;
	struct dentry *event_rx_mismatch;
	struct dentry *event_rx_mem_empty;
	struct dentry *event_rx_pool;
	struct dentry *event_oom_late;
	struct dentry *event_phy_transmit_error;
	struct dentry *event_tx_stuck;

	struct dentry *ps_pspoll_timeouts;
	struct dentry *ps_upsd_timeouts;
	struct dentry *ps_upsd_max_sptime;
	struct dentry *ps_upsd_max_apturn;
	struct dentry *ps_pspoll_max_apturn;
	struct dentry *ps_pspoll_utilization;
	struct dentry *ps_upsd_utilization;

	struct dentry *rxpipe_rx_prep_beacon_drop;
	struct dentry *rxpipe_descr_host_int_trig_rx_data;
	struct dentry *rxpipe_beacon_buffer_thres_host_int_trig_rx_data;
	struct dentry *rxpipe_missed_beacon_host_int_trig_rx_data;
	struct dentry *rxpipe_tx_xfr_host_int_trig_rx_data;

	struct dentry *tx_queue_len;

	struct dentry *retry_count;
	struct dentry *excessive_retries;
	struct dentry *gpio_power;
};

#define NUM_TX_QUEUES              4
#define NUM_RX_PKT_DESC            8

/* FW status registers */
struct wl1271_fw_status {
	__le32 intr;
	u8  fw_rx_counter;
	u8  drv_rx_counter;
	u8  reserved;
	u8  tx_results_counter;
	__le32 rx_pkt_descs[NUM_RX_PKT_DESC];
	__le32 tx_released_blks[NUM_TX_QUEUES];
	__le32 fw_localtime;
	__le32 padding[2];
} __attribute__ ((packed));

struct wl1271_rx_mem_pool_addr {
	u32 addr;
	u32 addr_extra;
};

struct wl1271_scan {
	u8 state;
	u8 ssid[IW_ESSID_MAX_SIZE+1];
	size_t ssid_len;
	u8 active;
	u8 high_prio;
	u8 probe_requests;
};

struct wl1271_if_operations {
	void (*read)(struct wl1271 *wl, int addr, void *buf, size_t len,
		     bool fixed);
	void (*write)(struct wl1271 *wl, int addr, void *buf, size_t len,
		     bool fixed);
	void (*reset)(struct wl1271 *wl);
	void (*init)(struct wl1271 *wl);
	void (*power)(struct wl1271 *wl, bool enable);
	struct device* (*dev)(struct wl1271 *wl);
	void (*enable_irq)(struct wl1271 *wl);
	void (*disable_irq)(struct wl1271 *wl);
};

struct wl1271 {
	struct platform_device *plat_dev;
	struct ieee80211_hw *hw;
	bool mac80211_registered;

	void *if_priv;

	struct wl1271_if_operations *if_ops;

	void (*set_power)(bool enable);
	int irq;

	spinlock_t wl_lock;

	enum wl1271_state state;
	struct mutex mutex;

#define WL1271_FLAG_STA_RATES_CHANGED  (0)
#define WL1271_FLAG_STA_ASSOCIATED     (1)
#define WL1271_FLAG_JOINED             (2)
#define WL1271_FLAG_GPIO_POWER         (3)
#define WL1271_FLAG_TX_QUEUE_STOPPED   (4)
#define WL1271_FLAG_SCANNING           (5)
#define WL1271_FLAG_IN_ELP             (6)
#define WL1271_FLAG_PSM                (7)
#define WL1271_FLAG_PSM_REQUESTED      (8)
#define WL1271_FLAG_IRQ_PENDING        (9)
#define WL1271_FLAG_IRQ_RUNNING       (10)
	unsigned long flags;

	struct wl1271_partition_set part;

	struct wl1271_chip chip;

	int cmd_box_addr;
	int event_box_addr;

	u8 *fw;
	size_t fw_len;
	struct wl1271_nvs_file *nvs;

	u8 bssid[ETH_ALEN];
	u8 mac_addr[ETH_ALEN];
	u8 bss_type;
	u8 ssid[IW_ESSID_MAX_SIZE + 1];
	u8 ssid_len;
	int channel;

	struct wl1271_acx_mem_map *target_mem_map;

	/* Accounting for allocated / available TX blocks on HW */
	u32 tx_blocks_freed[NUM_TX_QUEUES];
	u32 tx_blocks_available;
	u32 tx_results_count;

	/* Transmitted TX packets counter for chipset interface */
	u32 tx_packets_count;

	/* Time-offset between host and chipset clocks */
	s64 time_offset;

	/* Session counter for the chipset */
	int session_counter;

	/* Frames scheduled for transmission, not handled yet */
	struct sk_buff_head tx_queue;

	struct work_struct tx_work;

	/* Pending TX frames */
	struct sk_buff *tx_frames[ACX_TX_DESCRIPTORS];

	/* Security sequence number counters */
	u8 tx_security_last_seq;
	s64 tx_security_seq;

	/* FW Rx counter */
	u32 rx_counter;

	/* Rx memory pool address */
	struct wl1271_rx_mem_pool_addr rx_mem_pool_addr;

	/* The target interrupt mask */
	struct work_struct irq_work;

	/* The mbox event mask */
	u32 event_mask;

	/* Mailbox pointers */
	u32 mbox_ptr[2];

	/* Are we currently scanning */
	struct wl1271_scan scan;

	/* Our association ID */
	u16 aid;

	/* currently configured rate set */
	u32 sta_rate_set;
	u32 basic_rate_set;
	u32 rate_set;

	/* The current band */
	enum ieee80211_band band;

	/* Default key (for WEP) */
	u32 default_key;

	unsigned int filters;
	unsigned int rx_config;
	unsigned int rx_filter;

	struct completion *elp_compl;
	struct delayed_work elp_work;

	/* retry counter for PSM entries */
	u8 psm_entry_retry;

	/* in dBm */
	int power_level;

	struct wl1271_stats stats;
	struct wl1271_debugfs debugfs;

	u32 buffer_32;
	u32 buffer_cmd;
	u32 buffer_busyword[WL1271_BUSY_WORD_CNT];

	struct wl1271_fw_status *fw_status;
	struct wl1271_tx_hw_res_if *tx_res_if;

	struct ieee80211_vif *vif;

	/* Current chipset configuration */
	struct conf_drv_settings conf;

	bool sg_enabled;

	struct list_head list;
};

int wl1271_plt_start(struct wl1271 *wl);
int wl1271_plt_stop(struct wl1271 *wl);

#define JOIN_TIMEOUT 5000 /* 5000 milliseconds to join */

#define SESSION_COUNTER_MAX 7 /* maximum value for the session counter */

#define WL1271_DEFAULT_POWER_LEVEL 0

#define WL1271_TX_QUEUE_LOW_WATERMARK  10
#define WL1271_TX_QUEUE_HIGH_WATERMARK 25

/* WL1271 needs a 200ms sleep after power on, and a 20ms sleep before power
   on in case is has been shut down shortly before */
#define WL1271_PRE_POWER_ON_SLEEP 20 /* in miliseconds */
#define WL1271_POWER_ON_SLEEP 200 /* in miliseconds */

static inline bool wl1271_11a_enabled(void)
{
	/* FIXME: this could be determined based on the NVS-INI file */
#ifdef WL1271_80211A_ENABLED
	return true;
#else
	return false;
#endif
}

#endif
Commit	Line	Data
f5fc0f86 LC	1	/*
	2	* This file is part of wl1271
	3	*
	4	* Copyright (C) 1998-2009 Texas Instruments. All rights reserved.
	5	* Copyright (C) 2008-2009 Nokia Corporation
	6	*
	7	* Contact: Luciano Coelho <luciano.coelho@nokia.com>
	8	*
	9	* This program is free software; you can redistribute it and/or
	10	* modify it under the terms of the GNU General Public License
	11	* version 2 as published by the Free Software Foundation.
	12	*
	13	* This program is distributed in the hope that it will be useful, but
	14	* WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	16	* General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License
	19	* along with this program; if not, write to the Free Software
	20	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
	21	* 02110-1301 USA
	22	*
	23	*/
	24
	25	#ifndef __WL1271_H__
	26	#define __WL1271_H__
	27
	28	#include <linux/mutex.h>
	29	#include <linux/completion.h>
	30	#include <linux/spinlock.h>
	31	#include <linux/list.h>
	32	#include <linux/bitops.h>
	33	#include <net/mac80211.h>
	34
2b60100b JO	35	#include "wl1271_conf.h"
2b60100b JO	36
f5fc0f86 LC	37	#define DRIVER_NAME "wl1271"
	38	#define DRIVER_PREFIX DRIVER_NAME ": "
	39
	40	enum {
	41	DEBUG_NONE = 0,
	42	DEBUG_IRQ = BIT(0),
	43	DEBUG_SPI = BIT(1),
	44	DEBUG_BOOT = BIT(2),
	45	DEBUG_MAILBOX = BIT(3),
c8c90873	46	DEBUG_TESTMODE = BIT(4),
f5fc0f86 LC	47	DEBUG_EVENT = BIT(5),
	48	DEBUG_TX = BIT(6),
	49	DEBUG_RX = BIT(7),
	50	DEBUG_SCAN = BIT(8),
	51	DEBUG_CRYPT = BIT(9),
	52	DEBUG_PSM = BIT(10),
	53	DEBUG_MAC80211 = BIT(11),
	54	DEBUG_CMD = BIT(12),
	55	DEBUG_ACX = BIT(13),
a3b8ea75	56	DEBUG_SDIO = BIT(14),
14b228a0	57	DEBUG_FILTERS = BIT(15),
f5fc0f86 LC	58	DEBUG_ALL = ~0,
	59	};
	60
	61	#define DEBUG_LEVEL (DEBUG_NONE)
	62
	63	#define DEBUG_DUMP_LIMIT 1024
	64
	65	#define wl1271_error(fmt, arg...) \
	66	printk(KERN_ERR DRIVER_PREFIX "ERROR " fmt "\n", ##arg)
	67
	68	#define wl1271_warning(fmt, arg...) \
	69	printk(KERN_WARNING DRIVER_PREFIX "WARNING " fmt "\n", ##arg)
	70
	71	#define wl1271_notice(fmt, arg...) \
	72	printk(KERN_INFO DRIVER_PREFIX fmt "\n", ##arg)
	73
	74	#define wl1271_info(fmt, arg...) \
	75	printk(KERN_DEBUG DRIVER_PREFIX fmt "\n", ##arg)
	76
	77	#define wl1271_debug(level, fmt, arg...) \
	78	do { \
	79	if (level & DEBUG_LEVEL) \
	80	printk(KERN_DEBUG DRIVER_PREFIX fmt "\n", ##arg); \
	81	} while (0)
	82
	83	#define wl1271_dump(level, prefix, buf, len) \
	84	do { \
	85	if (level & DEBUG_LEVEL) \
	86	print_hex_dump(KERN_DEBUG, DRIVER_PREFIX prefix, \
	87	DUMP_PREFIX_OFFSET, 16, 1, \
	88	buf, \
	89	min_t(size_t, len, DEBUG_DUMP_LIMIT), \
	90	0); \
	91	} while (0)
	92
	93	#define wl1271_dump_ascii(level, prefix, buf, len) \
	94	do { \
	95	if (level & DEBUG_LEVEL) \
	96	print_hex_dump(KERN_DEBUG, DRIVER_PREFIX prefix, \
	97	DUMP_PREFIX_OFFSET, 16, 1, \
	98	buf, \
	99	min_t(size_t, len, DEBUG_DUMP_LIMIT), \
	100	true); \
	101	} while (0)
	102
	103	#define WL1271_DEFAULT_RX_CONFIG (CFG_UNI_FILTER_EN \| \
c87dec9f JO	104	CFG_BSSID_FILTER_EN \| \
c87dec9f JO	105	CFG_MC_FILTER_EN)
f5fc0f86 LC	106
	107	#define WL1271_DEFAULT_RX_FILTER (CFG_RX_RCTS_ACK \| CFG_RX_PRSP_EN \| \
	108	CFG_RX_MGMT_EN \| CFG_RX_DATA_EN \| \
	109	CFG_RX_CTL_EN \| CFG_RX_BCN_EN \| \
	110	CFG_RX_AUTH_EN \| CFG_RX_ASSOC_EN)
	111
	112	#define WL1271_FW_NAME "wl1271-fw.bin"
	113	#define WL1271_NVS_NAME "wl1271-nvs.bin"
152ee6e0	114
04e36fc5 JO	115	#define WL1271_TX_SECURITY_LO16(s) ((u16)((s) & 0xffff))
	116	#define WL1271_TX_SECURITY_HI32(s) ((u32)(((s) >> 16) & 0xffffffff))
	117
152ee6e0 JO	118	/* NVS data structure */
	119	#define WL1271_NVS_SECTION_SIZE 468
	120
	121	#define WL1271_NVS_GENERAL_PARAMS_SIZE 57
	122	#define WL1271_NVS_GENERAL_PARAMS_SIZE_PADDED \
	123	(WL1271_NVS_GENERAL_PARAMS_SIZE + 1)
	124	#define WL1271_NVS_STAT_RADIO_PARAMS_SIZE 17
	125	#define WL1271_NVS_STAT_RADIO_PARAMS_SIZE_PADDED \
	126	(WL1271_NVS_STAT_RADIO_PARAMS_SIZE + 1)
	127	#define WL1271_NVS_DYN_RADIO_PARAMS_SIZE 65
	128	#define WL1271_NVS_DYN_RADIO_PARAMS_SIZE_PADDED \
	129	(WL1271_NVS_DYN_RADIO_PARAMS_SIZE + 1)
	130	#define WL1271_NVS_FEM_COUNT 2
	131	#define WL1271_NVS_INI_SPARE_SIZE 124
	132
	133	struct wl1271_nvs_file {
	134	/* NVS section */
	135	u8 nvs[WL1271_NVS_SECTION_SIZE];
	136
	137	/* INI section */
	138	u8 general_params[WL1271_NVS_GENERAL_PARAMS_SIZE_PADDED];
	139	u8 stat_radio_params[WL1271_NVS_STAT_RADIO_PARAMS_SIZE_PADDED];
	140	u8 dyn_radio_params[WL1271_NVS_FEM_COUNT]
	141	[WL1271_NVS_DYN_RADIO_PARAMS_SIZE_PADDED];
	142	u8 ini_spare[WL1271_NVS_INI_SPARE_SIZE];
	143	} __attribute__ ((packed));
f5fc0f86	144
1ebec3d7 TP	145	/*
	146	* Enable/disable 802.11a support for WL1273
	147	*/
	148	#undef WL1271_80211A_ENABLED
	149
545f1da8 JO	150	/*
	151	* FIXME: for the wl1271, a busy word count of 1 here will result in a more
	152	* optimal SPI interface. There is some SPI bug however, causing RXS time outs
c6d5d06e JO	153	* with this mode occasionally on boot, so lets have three for now. A value of
	154	* three should make sure, that the chipset will always be ready, though this
	155	* will impact throughput and latencies slightly.
545f1da8	156	*/
c6d5d06e	157	#define WL1271_BUSY_WORD_CNT 3
545f1da8	158	#define WL1271_BUSY_WORD_LEN (WL1271_BUSY_WORD_CNT * sizeof(u32))
f5fc0f86 LC	159
	160	#define WL1271_ELP_HW_STATE_ASLEEP 0
	161	#define WL1271_ELP_HW_STATE_IRQ 1
	162
d94cd297 JO	163	#define WL1271_DEFAULT_BEACON_INT 100
	164	#define WL1271_DEFAULT_DTIM_PERIOD 1
	165
c87dec9f	166	#define ACX_TX_DESCRIPTORS 32
be7078c2	167
f5fc0f86 LC	168	enum wl1271_state {
	169	WL1271_STATE_OFF,
	170	WL1271_STATE_ON,
	171	WL1271_STATE_PLT,
	172	};
	173
	174	enum wl1271_partition_type {
	175	PART_DOWN,
	176	PART_WORK,
	177	PART_DRPW,
	178
	179	PART_TABLE_LEN
	180	};
	181
	182	struct wl1271_partition {
	183	u32 size;
	184	u32 start;
	185	};
	186
	187	struct wl1271_partition_set {
	188	struct wl1271_partition mem;
	189	struct wl1271_partition reg;
451de97a JO	190	struct wl1271_partition mem2;
451de97a JO	191	struct wl1271_partition mem3;
f5fc0f86 LC	192	};
	193
	194	struct wl1271;
	195
	196	/* FIXME: I'm not sure about this structure name */
	197	struct wl1271_chip {
	198	u32 id;
	199	char fw_ver[21];
	200	};
	201
	202	struct wl1271_stats {
	203	struct acx_statistics *fw_stats;
	204	unsigned long fw_stats_update;
	205
	206	unsigned int retry_count;
	207	unsigned int excessive_retries;
	208	};
	209
	210	struct wl1271_debugfs {
	211	struct dentry *rootdir;
	212	struct dentry *fw_statistics;
	213
	214	struct dentry *tx_internal_desc_overflow;
	215
	216	struct dentry *rx_out_of_mem;
	217	struct dentry *rx_hdr_overflow;
	218	struct dentry *rx_hw_stuck;
	219	struct dentry *rx_dropped;
	220	struct dentry *rx_fcs_err;
	221	struct dentry *rx_xfr_hint_trig;
	222	struct dentry *rx_path_reset;
	223	struct dentry *rx_reset_counter;
	224
	225	struct dentry *dma_rx_requested;
	226	struct dentry *dma_rx_errors;
	227	struct dentry *dma_tx_requested;
	228	struct dentry *dma_tx_errors;
	229
	230	struct dentry *isr_cmd_cmplt;
	231	struct dentry *isr_fiqs;
	232	struct dentry *isr_rx_headers;
	233	struct dentry *isr_rx_mem_overflow;
	234	struct dentry *isr_rx_rdys;
	235	struct dentry *isr_irqs;
	236	struct dentry *isr_tx_procs;
	237	struct dentry *isr_decrypt_done;
	238	struct dentry *isr_dma0_done;
	239	struct dentry *isr_dma1_done;
	240	struct dentry *isr_tx_exch_complete;
	241	struct dentry *isr_commands;
	242	struct dentry *isr_rx_procs;
	243	struct dentry *isr_hw_pm_mode_changes;
	244	struct dentry *isr_host_acknowledges;
	245	struct dentry *isr_pci_pm;
	246	struct dentry *isr_wakeups;
	247	struct dentry *isr_low_rssi;
	248
	249	struct dentry *wep_addr_key_count;
	250	struct dentry *wep_default_key_count;
	251	/* skipping wep.reserved */
	252	struct dentry *wep_key_not_found;
	253	struct dentry *wep_decrypt_fail;
	254	struct dentry *wep_packets;
	255	struct dentry *wep_interrupt;
256
257	struct dentry *pwr_ps_enter;
258	struct dentry *pwr_elp_enter;
259	struct dentry *pwr_missing_bcns;
260	struct dentry *pwr_wake_on_host;
261	struct dentry *pwr_wake_on_timer_exp;
262	struct dentry *pwr_tx_with_ps;
263	struct dentry *pwr_tx_without_ps;
264	struct dentry *pwr_rcvd_beacons;
265	struct dentry *pwr_power_save_off;
266	struct dentry *pwr_enable_ps;
267	struct dentry *pwr_disable_ps;
268	struct dentry *pwr_fix_tsf_ps;
269	/* skipping cont_miss_bcns_spread for now */
270	struct dentry *pwr_rcvd_awake_beacons;
271
272	struct dentry *mic_rx_pkts;
273	struct dentry *mic_calc_failure;
274
275	struct dentry *aes_encrypt_fail;
276	struct dentry *aes_decrypt_fail;
277	struct dentry *aes_encrypt_packets;
278	struct dentry *aes_decrypt_packets;
279	struct dentry *aes_encrypt_interrupt;
280	struct dentry *aes_decrypt_interrupt;
281
282	struct dentry *event_heart_beat;
283	struct dentry *event_calibration;
284	struct dentry *event_rx_mismatch;
285	struct dentry *event_rx_mem_empty;
286	struct dentry *event_rx_pool;
287	struct dentry *event_oom_late;
288	struct dentry *event_phy_transmit_error;
289	struct dentry *event_tx_stuck;
290
291	struct dentry *ps_pspoll_timeouts;
292	struct dentry *ps_upsd_timeouts;
293	struct dentry *ps_upsd_max_sptime;
294	struct dentry *ps_upsd_max_apturn;
295	struct dentry *ps_pspoll_max_apturn;
296	struct dentry *ps_pspoll_utilization;
297	struct dentry *ps_upsd_utilization;
298
299	struct dentry *rxpipe_rx_prep_beacon_drop;
300	struct dentry *rxpipe_descr_host_int_trig_rx_data;
301	struct dentry *rxpipe_beacon_buffer_thres_host_int_trig_rx_data;
302	struct dentry *rxpipe_missed_beacon_host_int_trig_rx_data;
303	struct dentry *rxpipe_tx_xfr_host_int_trig_rx_data;
304
305	struct dentry *tx_queue_len;
306
307	struct dentry *retry_count;
308	struct dentry *excessive_retries;
98b2a684	309	struct dentry *gpio_power;
f5fc0f86 LC	310	};
	311
	312	#define NUM_TX_QUEUES 4
	313	#define NUM_RX_PKT_DESC 8
	314
	315	/* FW status registers */
	316	struct wl1271_fw_status {
d0f63b20	317	__le32 intr;
f5fc0f86 LC	318	u8 fw_rx_counter;
	319	u8 drv_rx_counter;
	320	u8 reserved;
	321	u8 tx_results_counter;
d0f63b20 LC	322	__le32 rx_pkt_descs[NUM_RX_PKT_DESC];
	323	__le32 tx_released_blks[NUM_TX_QUEUES];
	324	__le32 fw_localtime;
	325	__le32 padding[2];
f5fc0f86 LC	326	} __attribute__ ((packed));
	327
	328	struct wl1271_rx_mem_pool_addr {
	329	u32 addr;
	330	u32 addr_extra;
	331	};
	332
abb0b3bf TP	333	struct wl1271_scan {
	334	u8 state;
	335	u8 ssid[IW_ESSID_MAX_SIZE+1];
	336	size_t ssid_len;
	337	u8 active;
	338	u8 high_prio;
	339	u8 probe_requests;
	340	};
	341
8197b711 TP	342	struct wl1271_if_operations {
	343	void (read)(struct wl1271 wl, int addr, void *buf, size_t len,
	344	bool fixed);
	345	void (write)(struct wl1271 wl, int addr, void *buf, size_t len,
	346	bool fixed);
	347	void (reset)(struct wl1271 wl);
	348	void (init)(struct wl1271 wl);
becd551c	349	void (power)(struct wl1271 wl, bool enable);
8197b711 TP	350	struct device* (dev)(struct wl1271 wl);
	351	void (enable_irq)(struct wl1271 wl);
	352	void (disable_irq)(struct wl1271 wl);
	353	};
	354
f5fc0f86	355	struct wl1271 {
3b56dd6a	356	struct platform_device *plat_dev;
f5fc0f86 LC	357	struct ieee80211_hw *hw;
	358	bool mac80211_registered;
	359
8197b711 TP	360	void *if_priv;
	361
	362	struct wl1271_if_operations *if_ops;
f5fc0f86 LC	363
	364	void (*set_power)(bool enable);
	365	int irq;
	366
	367	spinlock_t wl_lock;
	368
	369	enum wl1271_state state;
	370	struct mutex mutex;
	371
830fb67b JO	372	#define WL1271_FLAG_STA_RATES_CHANGED (0)
830fb67b JO	373	#define WL1271_FLAG_STA_ASSOCIATED (1)
71449f8d JO	374	#define WL1271_FLAG_JOINED (2)
	375	#define WL1271_FLAG_GPIO_POWER (3)
	376	#define WL1271_FLAG_TX_QUEUE_STOPPED (4)
	377	#define WL1271_FLAG_SCANNING (5)
	378	#define WL1271_FLAG_IN_ELP (6)
	379	#define WL1271_FLAG_PSM (7)
	380	#define WL1271_FLAG_PSM_REQUESTED (8)
1e73eb62 JO	381	#define WL1271_FLAG_IRQ_PENDING (9)
1e73eb62 JO	382	#define WL1271_FLAG_IRQ_RUNNING (10)
830fb67b JO	383	unsigned long flags;
830fb67b JO	384
451de97a	385	struct wl1271_partition_set part;
f5fc0f86 LC	386
	387	struct wl1271_chip chip;
	388
	389	int cmd_box_addr;
	390	int event_box_addr;
	391
	392	u8 *fw;
	393	size_t fw_len;
152ee6e0	394	struct wl1271_nvs_file *nvs;
f5fc0f86 LC	395
	396	u8 bssid[ETH_ALEN];
	397	u8 mac_addr[ETH_ALEN];
	398	u8 bss_type;
	399	u8 ssid[IW_ESSID_MAX_SIZE + 1];
	400	u8 ssid_len;
f5fc0f86 LC	401	int channel;
	402
	403	struct wl1271_acx_mem_map *target_mem_map;
	404
	405	/* Accounting for allocated / available TX blocks on HW */
	406	u32 tx_blocks_freed[NUM_TX_QUEUES];
	407	u32 tx_blocks_available;
ffb591cd	408	u32 tx_results_count;
f5fc0f86 LC	409
f5fc0f86 LC	410	/* Transmitted TX packets counter for chipset interface */
ffb591cd	411	u32 tx_packets_count;
f5fc0f86 LC	412
f5fc0f86 LC	413	/* Time-offset between host and chipset clocks */
ac5e1e39	414	s64 time_offset;
f5fc0f86 LC	415
	416	/* Session counter for the chipset */
	417	int session_counter;
	418
	419	/* Frames scheduled for transmission, not handled yet */
	420	struct sk_buff_head tx_queue;
f5fc0f86 LC	421
f5fc0f86 LC	422	struct work_struct tx_work;
c87dec9f	423
f5fc0f86	424	/* Pending TX frames */
be7078c2	425	struct sk_buff *tx_frames[ACX_TX_DESCRIPTORS];
f5fc0f86	426
ac4e4ce5 JO	427	/* Security sequence number counters */
ac4e4ce5 JO	428	u8 tx_security_last_seq;
04e36fc5	429	s64 tx_security_seq;
ac4e4ce5	430
f5fc0f86 LC	431	/* FW Rx counter */
	432	u32 rx_counter;
	433
	434	/* Rx memory pool address */
	435	struct wl1271_rx_mem_pool_addr rx_mem_pool_addr;
	436
	437	/* The target interrupt mask */
	438	struct work_struct irq_work;
	439
	440	/* The mbox event mask */
	441	u32 event_mask;
	442
	443	/* Mailbox pointers */
	444	u32 mbox_ptr[2];
	445
	446	/* Are we currently scanning */
abb0b3bf	447	struct wl1271_scan scan;
f5fc0f86 LC	448
	449	/* Our association ID */
	450	u16 aid;
	451
d94cd297	452	/* currently configured rate set */
830fb67b	453	u32 sta_rate_set;
d94cd297	454	u32 basic_rate_set;
830fb67b	455	u32 rate_set;
d94cd297	456
8a5a37a6 JO	457	/* The current band */
	458	enum ieee80211_band band;
	459
f5fc0f86 LC	460	/* Default key (for WEP) */
	461	u32 default_key;
	462
14b228a0	463	unsigned int filters;
f5fc0f86 LC	464	unsigned int rx_config;
	465	unsigned int rx_filter;
	466
f5fc0f86	467	struct completion *elp_compl;
37b70a81	468	struct delayed_work elp_work;
f5fc0f86	469
19ad0715 JO	470	/* retry counter for PSM entries */
	471	u8 psm_entry_retry;
	472
f5fc0f86 LC	473	/* in dBm */
	474	int power_level;
	475
	476	struct wl1271_stats stats;
	477	struct wl1271_debugfs debugfs;
	478
	479	u32 buffer_32;
	480	u32 buffer_cmd;
545f1da8	481	u32 buffer_busyword[WL1271_BUSY_WORD_CNT];
f5fc0f86 LC	482
	483	struct wl1271_fw_status *fw_status;
	484	struct wl1271_tx_hw_res_if *tx_res_if;
b771eee5 JO	485
b771eee5 JO	486	struct ieee80211_vif *vif;
d6e19d13	487
2b60100b JO	488	/* Current chipset configuration */
2b60100b JO	489	struct conf_drv_settings conf;
01c09162	490
7fc3a864 JO	491	bool sg_enabled;
7fc3a864 JO	492
01c09162	493	struct list_head list;
f5fc0f86 LC	494	};
	495
	496	int wl1271_plt_start(struct wl1271 *wl);
	497	int wl1271_plt_stop(struct wl1271 *wl);
	498
	499	#define JOIN_TIMEOUT 5000 /* 5000 milliseconds to join */
	500
	501	#define SESSION_COUNTER_MAX 7 /* maximum value for the session counter */
	502
	503	#define WL1271_DEFAULT_POWER_LEVEL 0
	504
06f7bc7d JO	505	#define WL1271_TX_QUEUE_LOW_WATERMARK 10
06f7bc7d JO	506	#define WL1271_TX_QUEUE_HIGH_WATERMARK 25
f5fc0f86	507
01ac17ec JO	508	/* WL1271 needs a 200ms sleep after power on, and a 20ms sleep before power
	509	on in case is has been shut down shortly before */
	510	#define WL1271_PRE_POWER_ON_SLEEP 20 /* in miliseconds */
f5fc0f86 LC	511	#define WL1271_POWER_ON_SLEEP 200 /* in miliseconds */
f5fc0f86 LC	512
1ebec3d7 TP	513	static inline bool wl1271_11a_enabled(void)
1ebec3d7 TP	514	{
152ee6e0	515	/* FIXME: this could be determined based on the NVS-INI file */
1ebec3d7 TP	516	#ifdef WL1271_80211A_ENABLED
	517	return true;
	518	#else
	519	return false;
	520	#endif
	521	}
	522
f5fc0f86	523	#endif