[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_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"

/* 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);
	struct device* (*dev)(struct wl1271 *wl);
	void (*enable_irq)(struct wl1271 *wl);
	void (*disable_irq)(struct wl1271 *wl);
};

struct wl1271 {
	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;
	u16 tx_security_seq_16;
	u32 tx_security_seq_32;

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

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