[linux-2.6-block.git] / drivers / net / wireless / wl12xx / tx.h

/*
 * This file is part of wl1271
 *
 * Copyright (C) 1998-2009 Texas Instruments. All rights reserved.
 * Copyright (C) 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 __TX_H__
#define __TX_H__

#define TX_HW_BLOCK_SPARE_DEFAULT        1
#define TX_HW_BLOCK_SIZE                 252

#define TX_HW_MGMT_PKT_LIFETIME_TU       2000
#define TX_HW_AP_MODE_PKT_LIFETIME_TU    8000

#define TX_HW_ATTR_SAVE_RETRIES          BIT(0)
#define TX_HW_ATTR_HEADER_PAD            BIT(1)
#define TX_HW_ATTR_SESSION_COUNTER       (BIT(2) | BIT(3) | BIT(4))
#define TX_HW_ATTR_RATE_POLICY           (BIT(5) | BIT(6) | BIT(7) | \
					  BIT(8) | BIT(9))
#define TX_HW_ATTR_LAST_WORD_PAD         (BIT(10) | BIT(11))
#define TX_HW_ATTR_TX_CMPLT_REQ          BIT(12)
#define TX_HW_ATTR_TX_DUMMY_REQ          BIT(13)
#define TX_HW_ATTR_HOST_ENCRYPT          BIT(14)

#define TX_HW_ATTR_OFST_SAVE_RETRIES     0
#define TX_HW_ATTR_OFST_HEADER_PAD       1
#define TX_HW_ATTR_OFST_SESSION_COUNTER  2
#define TX_HW_ATTR_OFST_RATE_POLICY      5
#define TX_HW_ATTR_OFST_LAST_WORD_PAD    10
#define TX_HW_ATTR_OFST_TX_CMPLT_REQ     12

#define TX_HW_RESULT_QUEUE_LEN           16
#define TX_HW_RESULT_QUEUE_LEN_MASK      0xf

#define WL1271_TX_ALIGN_TO 4
#define WL1271_EXTRA_SPACE_TKIP 4
#define WL1271_EXTRA_SPACE_AES  8
#define WL1271_EXTRA_SPACE_MAX  8

/* Used for management frames and dummy packets */
#define WL1271_TID_MGMT 7

struct wl127x_tx_mem {
	/*
	 * Number of extra memory blocks to allocate for this packet
	 * in addition to the number of blocks derived from the packet
	 * length.
	 */
	u8 extra_blocks;
	/*
	 * Total number of memory blocks allocated by the host for
	 * this packet. Must be equal or greater than the actual
	 * blocks number allocated by HW.
	 */
	u8 total_mem_blocks;
} __packed;

struct wl128x_tx_mem {
	/*
	 * Total number of memory blocks allocated by the host for
	 * this packet.
	 */
	u8 total_mem_blocks;
	/*
	 * Number of extra bytes, at the end of the frame. the host
	 * uses this padding to complete each frame to integer number
	 * of SDIO blocks.
	 */
	u8 extra_bytes;
} __packed;

/*
 * On wl128x based devices, when TX packets are aggregated, each packet
 * size must be aligned to the SDIO block size. The maximum block size
 * is bounded by the type of the padded bytes field that is sent to the
 * FW. Currently the type is u8, so the maximum block size is 256 bytes.
 */
#define WL12XX_BUS_BLOCK_SIZE min(512u,	\
	    (1u << (8 * sizeof(((struct wl128x_tx_mem *) 0)->extra_bytes))))

struct wl1271_tx_hw_descr {
	/* Length of packet in words, including descriptor+header+data */
	__le16 length;
	union {
		struct wl127x_tx_mem wl127x_mem;
		struct wl128x_tx_mem wl128x_mem;
	} __packed;
	/* Device time (in us) when the packet arrived to the driver */
	__le32 start_time;
	/*
	 * Max delay in TUs until transmission. The last device time the
	 * packet can be transmitted is: start_time + (1024 * life_time)
	 */
	__le16 life_time;
	/* Bitwise fields - see TX_ATTR... definitions above. */
	__le16 tx_attr;
	/* Packet identifier used also in the Tx-Result. */
	u8 id;
	/* The packet TID value (as User-Priority) */
	u8 tid;
	/* host link ID (HLID) */
	u8 hlid;
	u8 reserved;
} __packed;

enum wl1271_tx_hw_res_status {
	TX_SUCCESS          = 0,
	TX_HW_ERROR         = 1,
	TX_DISABLED         = 2,
	TX_RETRY_EXCEEDED   = 3,
	TX_TIMEOUT          = 4,
	TX_KEY_NOT_FOUND    = 5,
	TX_PEER_NOT_FOUND   = 6,
	TX_SESSION_MISMATCH = 7,
	TX_LINK_NOT_VALID   = 8,
};

struct wl1271_tx_hw_res_descr {
	/* Packet Identifier - same value used in the Tx descriptor.*/
	u8 id;
	/* The status of the transmission, indicating success or one of
	   several possible reasons for failure. */
	u8 status;
	/* Total air access duration including all retrys and overheads.*/
	__le16 medium_usage;
	/* The time passed from host xfer to Tx-complete.*/
	__le32 fw_handling_time;
	/* Total media delay
	   (from 1st EDCA AIFS counter until TX Complete). */
	__le32 medium_delay;
	/* LS-byte of last TKIP seq-num (saved per AC for recovery). */
	u8 tx_security_sequence_number_lsb;
	/* Retry count - number of transmissions without successful ACK.*/
	u8 ack_failures;
	/* The rate that succeeded getting ACK
	   (Valid only if status=SUCCESS). */
	u8 rate_class_index;
	/* for 4-byte alignment. */
	u8 spare;
} __packed;

struct wl1271_tx_hw_res_if {
	__le32 tx_result_fw_counter;
	__le32 tx_result_host_counter;
	struct wl1271_tx_hw_res_descr tx_results_queue[TX_HW_RESULT_QUEUE_LEN];
} __packed;

static inline int wl1271_tx_get_queue(int queue)
{
	switch (queue) {
	case 0:
		return CONF_TX_AC_VO;
	case 1:
		return CONF_TX_AC_VI;
	case 2:
		return CONF_TX_AC_BE;
	case 3:
		return CONF_TX_AC_BK;
	default:
		return CONF_TX_AC_BE;
	}
}

static inline int wl1271_tx_get_mac80211_queue(int queue)
{
	switch (queue) {
	case CONF_TX_AC_VO:
		return 0;
	case CONF_TX_AC_VI:
		return 1;
	case CONF_TX_AC_BE:
		return 2;
	case CONF_TX_AC_BK:
		return 3;
	default:
		return 2;
	}
}

static inline int wl1271_tx_total_queue_count(struct wl1271 *wl)
{
	int i, count = 0;

	for (i = 0; i < NUM_TX_QUEUES; i++)
		count += wl->tx_queue_count[i];

	return count;
}

void wl1271_tx_work(struct work_struct *work);
void wl1271_tx_work_locked(struct wl1271 *wl);
void wl1271_tx_complete(struct wl1271 *wl);
void wl12xx_tx_reset_wlvif(struct wl1271 *wl, struct wl12xx_vif *wlvif);
void wl12xx_tx_reset(struct wl1271 *wl, bool reset_tx_queues);
void wl1271_tx_flush(struct wl1271 *wl);
u8 wl1271_rate_to_idx(int rate, enum ieee80211_band band);
u32 wl1271_tx_enabled_rates_get(struct wl1271 *wl, u32 rate_set,
				enum ieee80211_band rate_band);
u32 wl1271_tx_min_rate_get(struct wl1271 *wl, u32 rate_set);
u8 wl12xx_tx_get_hlid_ap(struct wl1271 *wl, struct wl12xx_vif *wlvif,
			 struct sk_buff *skb);
u8 wl12xx_tx_get_hlid(struct wl1271 *wl, struct wl12xx_vif *wlvif,
		      struct sk_buff *skb);
void wl1271_tx_reset_link_queues(struct wl1271 *wl, u8 hlid);
void wl1271_handle_tx_low_watermark(struct wl1271 *wl);
bool wl12xx_is_dummy_packet(struct wl1271 *wl, struct sk_buff *skb);
void wl12xx_rearm_rx_streaming(struct wl1271 *wl, unsigned long *active_hlids);

/* from main.c */
void wl1271_free_sta(struct wl1271 *wl, struct wl12xx_vif *wlvif, u8 hlid);
void wl12xx_rearm_tx_watchdog_locked(struct wl1271 *wl);

#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) 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
00d20100 SL	25	#ifndef __TX_H__
00d20100 SL	26	#define __TX_H__
f5fc0f86	27
e9eb8cbe	28	#define TX_HW_BLOCK_SPARE_DEFAULT 1
5c9417f1	29	#define TX_HW_BLOCK_SIZE 252
f5fc0f86 LC	30
f5fc0f86 LC	31	#define TX_HW_MGMT_PKT_LIFETIME_TU 2000
beb6c880	32	#define TX_HW_AP_MODE_PKT_LIFETIME_TU 8000
f5fc0f86 LC	33
	34	#define TX_HW_ATTR_SAVE_RETRIES BIT(0)
	35	#define TX_HW_ATTR_HEADER_PAD BIT(1)
	36	#define TX_HW_ATTR_SESSION_COUNTER (BIT(2) \| BIT(3) \| BIT(4))
	37	#define TX_HW_ATTR_RATE_POLICY (BIT(5) \| BIT(6) \| BIT(7) \| \
	38	BIT(8) \| BIT(9))
	39	#define TX_HW_ATTR_LAST_WORD_PAD (BIT(10) \| BIT(11))
	40	#define TX_HW_ATTR_TX_CMPLT_REQ BIT(12)
ae47c45f	41	#define TX_HW_ATTR_TX_DUMMY_REQ BIT(13)
f4f57943	42	#define TX_HW_ATTR_HOST_ENCRYPT BIT(14)
ae47c45f	43
f5fc0f86 LC	44	#define TX_HW_ATTR_OFST_SAVE_RETRIES 0
	45	#define TX_HW_ATTR_OFST_HEADER_PAD 1
	46	#define TX_HW_ATTR_OFST_SESSION_COUNTER 2
	47	#define TX_HW_ATTR_OFST_RATE_POLICY 5
	48	#define TX_HW_ATTR_OFST_LAST_WORD_PAD 10
	49	#define TX_HW_ATTR_OFST_TX_CMPLT_REQ 12
	50
	51	#define TX_HW_RESULT_QUEUE_LEN 16
	52	#define TX_HW_RESULT_QUEUE_LEN_MASK 0xf
	53
	54	#define WL1271_TX_ALIGN_TO 4
5ec8a448 EP	55	#define WL1271_EXTRA_SPACE_TKIP 4
	56	#define WL1271_EXTRA_SPACE_AES 8
	57	#define WL1271_EXTRA_SPACE_MAX 8
f5fc0f86	58
ae47c45f SL	59	/* Used for management frames and dummy packets */
	60	#define WL1271_TID_MGMT 7
	61
48a61477 SL	62	struct wl127x_tx_mem {
	63	/*
	64	* Number of extra memory blocks to allocate for this packet
	65	* in addition to the number of blocks derived from the packet
	66	* length.
	67	*/
	68	u8 extra_blocks;
	69	/*
	70	* Total number of memory blocks allocated by the host for
	71	* this packet. Must be equal or greater than the actual
	72	* blocks number allocated by HW.
	73	*/
	74	u8 total_mem_blocks;
	75	} __packed;
	76
	77	struct wl128x_tx_mem {
	78	/*
	79	* Total number of memory blocks allocated by the host for
	80	* this packet.
	81	*/
	82	u8 total_mem_blocks;
	83	/*
	84	* Number of extra bytes, at the end of the frame. the host
	85	* uses this padding to complete each frame to integer number
	86	* of SDIO blocks.
	87	*/
	88	u8 extra_bytes;
	89	} __packed;
	90
0da13da7 IY	91	/*
	92	* On wl128x based devices, when TX packets are aggregated, each packet
	93	* size must be aligned to the SDIO block size. The maximum block size
	94	* is bounded by the type of the padded bytes field that is sent to the
	95	* FW. Currently the type is u8, so the maximum block size is 256 bytes.
	96	*/
	97	#define WL12XX_BUS_BLOCK_SIZE min(512u, \
	98	(1u << (8 * sizeof(((struct wl128x_tx_mem *) 0)->extra_bytes))))
	99
f5fc0f86 LC	100	struct wl1271_tx_hw_descr {
f5fc0f86 LC	101	/* Length of packet in words, including descriptor+header+data */
d0f63b20	102	__le16 length;
48a61477 SL	103	union {
	104	struct wl127x_tx_mem wl127x_mem;
	105	struct wl128x_tx_mem wl128x_mem;
	106	} __packed;
f5fc0f86	107	/* Device time (in us) when the packet arrived to the driver */
d0f63b20	108	__le32 start_time;
48a61477 SL	109	/*
	110	* Max delay in TUs until transmission. The last device time the
	111	* packet can be transmitted is: start_time + (1024 * life_time)
	112	*/
d0f63b20	113	__le16 life_time;
f5fc0f86	114	/* Bitwise fields - see TX_ATTR... definitions above. */
d0f63b20	115	__le16 tx_attr;
f5fc0f86 LC	116	/* Packet identifier used also in the Tx-Result. */
	117	u8 id;
	118	/* The packet TID value (as User-Priority) */
	119	u8 tid;
79b122dc EP	120	/* host link ID (HLID) */
79b122dc EP	121	u8 hlid;
f5fc0f86	122	u8 reserved;
ba2d3587	123	} __packed;
f5fc0f86 LC	124
	125	enum wl1271_tx_hw_res_status {
	126	TX_SUCCESS = 0,
	127	TX_HW_ERROR = 1,
	128	TX_DISABLED = 2,
	129	TX_RETRY_EXCEEDED = 3,
	130	TX_TIMEOUT = 4,
	131	TX_KEY_NOT_FOUND = 5,
	132	TX_PEER_NOT_FOUND = 6,
79b122dc EP	133	TX_SESSION_MISMATCH = 7,
79b122dc EP	134	TX_LINK_NOT_VALID = 8,
f5fc0f86 LC	135	};
	136
	137	struct wl1271_tx_hw_res_descr {
	138	/* Packet Identifier - same value used in the Tx descriptor.*/
	139	u8 id;
	140	/* The status of the transmission, indicating success or one of
	141	several possible reasons for failure. */
	142	u8 status;
	143	/* Total air access duration including all retrys and overheads.*/
d0f63b20	144	__le16 medium_usage;
f5fc0f86	145	/* The time passed from host xfer to Tx-complete.*/
d0f63b20	146	__le32 fw_handling_time;
f5fc0f86 LC	147	/* Total media delay
f5fc0f86 LC	148	(from 1st EDCA AIFS counter until TX Complete). */
d0f63b20	149	__le32 medium_delay;
f5fc0f86	150	/* LS-byte of last TKIP seq-num (saved per AC for recovery). */
b992c682	151	u8 tx_security_sequence_number_lsb;
f5fc0f86 LC	152	/* Retry count - number of transmissions without successful ACK.*/
	153	u8 ack_failures;
	154	/* The rate that succeeded getting ACK
	155	(Valid only if status=SUCCESS). */
	156	u8 rate_class_index;
	157	/* for 4-byte alignment. */
	158	u8 spare;
ba2d3587	159	} __packed;
f5fc0f86 LC	160
f5fc0f86 LC	161	struct wl1271_tx_hw_res_if {
d0f63b20 LC	162	__le32 tx_result_fw_counter;
d0f63b20 LC	163	__le32 tx_result_host_counter;
f5fc0f86	164	struct wl1271_tx_hw_res_descr tx_results_queue[TX_HW_RESULT_QUEUE_LEN];
ba2d3587	165	} __packed;
f5fc0f86	166
c6999d83 KV	167	static inline int wl1271_tx_get_queue(int queue)
c6999d83 KV	168	{
c6999d83 KV	169	switch (queue) {
	170	case 0:
	171	return CONF_TX_AC_VO;
	172	case 1:
	173	return CONF_TX_AC_VI;
	174	case 2:
	175	return CONF_TX_AC_BE;
	176	case 3:
	177	return CONF_TX_AC_BK;
	178	default:
	179	return CONF_TX_AC_BE;
	180	}
	181	}
	182
708bb3cf AN	183	static inline int wl1271_tx_get_mac80211_queue(int queue)
	184	{
	185	switch (queue) {
	186	case CONF_TX_AC_VO:
	187	return 0;
	188	case CONF_TX_AC_VI:
	189	return 1;
	190	case CONF_TX_AC_BE:
	191	return 2;
	192	case CONF_TX_AC_BK:
	193	return 3;
	194	default:
	195	return 2;
	196	}
	197	}
	198
f1a46384 AN	199	static inline int wl1271_tx_total_queue_count(struct wl1271 *wl)
	200	{
	201	int i, count = 0;
	202
	203	for (i = 0; i < NUM_TX_QUEUES; i++)
	204	count += wl->tx_queue_count[i];
	205
	206	return count;
	207	}
	208
f5fc0f86	209	void wl1271_tx_work(struct work_struct *work);
a32d0cdf	210	void wl1271_tx_work_locked(struct wl1271 *wl);
ffb591cd	211	void wl1271_tx_complete(struct wl1271 *wl);
d6a3cc2e EP	212	void wl12xx_tx_reset_wlvif(struct wl1271 wl, struct wl12xx_vif wlvif);
d6a3cc2e EP	213	void wl12xx_tx_reset(struct wl1271 *wl, bool reset_tx_queues);
f5fc0f86	214	void wl1271_tx_flush(struct wl1271 *wl);
6a2de93b	215	u8 wl1271_rate_to_idx(int rate, enum ieee80211_band band);
af7fbb28 EP	216	u32 wl1271_tx_enabled_rates_get(struct wl1271 *wl, u32 rate_set,
	217	enum ieee80211_band rate_band);
	218	u32 wl1271_tx_min_rate_get(struct wl1271 *wl, u32 rate_set);
a8ab39a4 EP	219	u8 wl12xx_tx_get_hlid_ap(struct wl1271 wl, struct wl12xx_vif wlvif,
a8ab39a4 EP	220	struct sk_buff *skb);
d6a3cc2e EP	221	u8 wl12xx_tx_get_hlid(struct wl1271 wl, struct wl12xx_vif wlvif,
d6a3cc2e EP	222	struct sk_buff *skb);
a8c0ddb5 AN	223	void wl1271_tx_reset_link_queues(struct wl1271 *wl, u8 hlid);
a8c0ddb5 AN	224	void wl1271_handle_tx_low_watermark(struct wl1271 *wl);
f8e0af6b	225	bool wl12xx_is_dummy_packet(struct wl1271 wl, struct sk_buff skb);
9eb599e9	226	void wl12xx_rearm_rx_streaming(struct wl1271 wl, unsigned long active_hlids);
f5fc0f86	227
f1acea9a	228	/* from main.c */
c7ffb902	229	void wl1271_free_sta(struct wl1271 wl, struct wl12xx_vif wlvif, u8 hlid);
55df5afb	230	void wl12xx_rearm_tx_watchdog_locked(struct wl1271 *wl);
f1acea9a	231
f5fc0f86	232	#endif