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 
25 #ifndef __TX_H__
26 #define __TX_H__
27 
28 #define TX_HW_BLOCK_SPARE                2
29 #define TX_HW_BLOCK_SIZE                 252
30 
31 #define TX_HW_MGMT_PKT_LIFETIME_TU       2000
32 #define TX_HW_AP_MODE_PKT_LIFETIME_TU    8000
33 /* The chipset reference driver states, that the "aid" value 1
34  * is for infra-BSS, but is still always used */
35 #define TX_HW_DEFAULT_AID                1
36 
37 #define TX_HW_ATTR_SAVE_RETRIES          BIT(0)
38 #define TX_HW_ATTR_HEADER_PAD            BIT(1)
39 #define TX_HW_ATTR_SESSION_COUNTER       (BIT(2) | BIT(3) | BIT(4))
40 #define TX_HW_ATTR_RATE_POLICY           (BIT(5) | BIT(6) | BIT(7) | \
41 					  BIT(8) | BIT(9))
42 #define TX_HW_ATTR_LAST_WORD_PAD         (BIT(10) | BIT(11))
43 #define TX_HW_ATTR_TX_CMPLT_REQ          BIT(12)
44 
45 #define TX_HW_ATTR_OFST_SAVE_RETRIES     0
46 #define TX_HW_ATTR_OFST_HEADER_PAD       1
47 #define TX_HW_ATTR_OFST_SESSION_COUNTER  2
48 #define TX_HW_ATTR_OFST_RATE_POLICY      5
49 #define TX_HW_ATTR_OFST_LAST_WORD_PAD    10
50 #define TX_HW_ATTR_OFST_TX_CMPLT_REQ     12
51 
52 #define TX_HW_RESULT_QUEUE_LEN           16
53 #define TX_HW_RESULT_QUEUE_LEN_MASK      0xf
54 
55 #define WL1271_TX_ALIGN_TO 4
56 #define WL1271_TKIP_IV_SPACE 4
57 
58 struct wl1271_tx_hw_descr {
59 	/* Length of packet in words, including descriptor+header+data */
60 	__le16 length;
61 	/* Number of extra memory blocks to allocate for this packet in
62 	   addition to the number of blocks derived from the packet length */
63 	u8 extra_mem_blocks;
64 	/* Total number of memory blocks allocated by the host for this packet.
65 	   Must be equal or greater than the actual blocks number allocated by
66 	   HW!! */
67 	u8 total_mem_blocks;
68 	/* Device time (in us) when the packet arrived to the driver */
69 	__le32 start_time;
70 	/* Max delay in TUs until transmission. The last device time the
71 	   packet can be transmitted is: startTime+(1024*LifeTime) */
72 	__le16 life_time;
73 	/* Bitwise fields - see TX_ATTR... definitions above. */
74 	__le16 tx_attr;
75 	/* Packet identifier used also in the Tx-Result. */
76 	u8 id;
77 	/* The packet TID value (as User-Priority) */
78 	u8 tid;
79 	union {
80 		/* STA - Identifier of the remote STA in IBSS, 1 in infra-BSS */
81 		u8 aid;
82 		/* AP - host link ID (HLID) */
83 		u8 hlid;
84 	} __packed;
85 	u8 reserved;
86 } __packed;
87 
88 enum wl1271_tx_hw_res_status {
89 	TX_SUCCESS          = 0,
90 	TX_HW_ERROR         = 1,
91 	TX_DISABLED         = 2,
92 	TX_RETRY_EXCEEDED   = 3,
93 	TX_TIMEOUT          = 4,
94 	TX_KEY_NOT_FOUND    = 5,
95 	TX_PEER_NOT_FOUND   = 6,
96 	TX_SESSION_MISMATCH = 7
97 };
98 
99 struct wl1271_tx_hw_res_descr {
100 	/* Packet Identifier - same value used in the Tx descriptor.*/
101 	u8 id;
102 	/* The status of the transmission, indicating success or one of
103 	   several possible reasons for failure. */
104 	u8 status;
105 	/* Total air access duration including all retrys and overheads.*/
106 	__le16 medium_usage;
107 	/* The time passed from host xfer to Tx-complete.*/
108 	__le32 fw_handling_time;
109 	/* Total media delay
110 	   (from 1st EDCA AIFS counter until TX Complete). */
111 	__le32 medium_delay;
112 	/* LS-byte of last TKIP seq-num (saved per AC for recovery). */
113 	u8 lsb_security_sequence_number;
114 	/* Retry count - number of transmissions without successful ACK.*/
115 	u8 ack_failures;
116 	/* The rate that succeeded getting ACK
117 	   (Valid only if status=SUCCESS). */
118 	u8 rate_class_index;
119 	/* for 4-byte alignment. */
120 	u8 spare;
121 } __packed;
122 
123 struct wl1271_tx_hw_res_if {
124 	__le32 tx_result_fw_counter;
125 	__le32 tx_result_host_counter;
126 	struct wl1271_tx_hw_res_descr tx_results_queue[TX_HW_RESULT_QUEUE_LEN];
127 } __packed;
128 
wl1271_tx_get_queue(int queue)129 static inline int wl1271_tx_get_queue(int queue)
130 {
131 	switch (queue) {
132 	case 0:
133 		return CONF_TX_AC_VO;
134 	case 1:
135 		return CONF_TX_AC_VI;
136 	case 2:
137 		return CONF_TX_AC_BE;
138 	case 3:
139 		return CONF_TX_AC_BK;
140 	default:
141 		return CONF_TX_AC_BE;
142 	}
143 }
144 
145 void wl1271_tx_work(struct work_struct *work);
146 void wl1271_tx_work_locked(struct wl1271 *wl);
147 void wl1271_tx_complete(struct wl1271 *wl);
148 void wl1271_tx_reset(struct wl1271 *wl);
149 void wl1271_tx_flush(struct wl1271 *wl);
150 u8 wl1271_rate_to_idx(int rate, enum ieee80211_band band);
151 u32 wl1271_tx_enabled_rates_get(struct wl1271 *wl, u32 rate_set);
152 u32 wl1271_tx_min_rate_get(struct wl1271 *wl);
153 u8 wl1271_tx_get_hlid(struct sk_buff *skb);
154 void wl1271_tx_reset_link_queues(struct wl1271 *wl, u8 hlid);
155 void wl1271_handle_tx_low_watermark(struct wl1271 *wl);
156 
157 #endif
158