2 * carl9170 firmware - used by the ar9170 wireless device
6 * Copyright (c) 2000-2005 ZyDAS Technology Corporation
7 * Copyright (c) 2007-2009 Atheros Communications, Inc.
8 * Copyright 2009 Johannes Berg <johannes@sipsolutions.net>
9 * Copyright 2009-2011 Christian Lamparter <chunkeey@googlemail.com>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License along
22 * with this program; if not, write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 #ifndef __CARL9170FW_WLAN_H
27 #define __CARL9170FW_WLAN_H
35 static inline __inline void set_wlan_txq_dma_addr(const unsigned int q, const uint32_t v)
37 set(AR9170_MAC_REG_DMA_TXQ_ADDR + (q << 3), v);
40 static inline __inline void set_wlan_txq_dma_curr_addr(const unsigned int q, const uint32_t v)
42 set(AR9170_MAC_REG_DMA_TXQ_CURR_ADDR + (q << 3), v);
45 static inline __inline struct dma_desc *get_wlan_txq_dma_addr(const unsigned int q)
47 return getp(AR9170_MAC_REG_DMA_TXQ_ADDR + (q << 3));
50 static inline __inline struct dma_desc *get_wlan_txq_addr(const unsigned int q)
52 return getp(AR9170_MAC_REG_DMA_TXQ_CURR_ADDR + (q << 3));
55 static inline __inline void wlan_trigger(const uint32_t queue_bit)
57 set(AR9170_MAC_REG_DMA_TRIGGER, queue_bit);
60 static inline __inline uint8_t ar9170_get_rx_macstatus_status(struct dma_desc *desc)
62 return *((uint8_t *) DESC_PAYLOAD_OFF(desc->lastAddr,
63 (unsigned int) desc->lastAddr->dataSize - 1));
66 static inline __inline uint8_t ar9170_get_rx_macstatus_error(struct dma_desc *desc)
70 if (desc->lastAddr->dataSize == 1) {
71 while (desc->lastAddr != desc->nextAddr)
72 desc = desc->nextAddr;
74 offset = (unsigned int) (desc->dataSize - 1);
76 desc = desc->lastAddr;
77 offset = desc->dataSize -
78 (sizeof(struct ar9170_rx_macstatus) -
79 offsetof(struct ar9170_rx_macstatus, error));
82 return *((uint8_t *) DESC_PAYLOAD_OFF(desc, offset));
85 static inline __inline struct ieee80211_hdr *ar9170_get_rx_i3e(struct dma_desc *desc)
87 if (!((ar9170_get_rx_macstatus_status(desc) &
88 AR9170_RX_STATUS_MPDU) & AR9170_RX_STATUS_MPDU_LAST)) {
89 return (void *)(DESC_PAYLOAD_OFF(desc,
90 offsetof(struct ar9170_rx_frame_head, i3e)));
92 return (void *)(DESC_PAYLOAD_OFF(desc,
93 offsetof(struct ar9170_rx_frame_tail, i3e)));
97 static inline __inline struct ar9170_rx_head *ar9170_get_rx_head(struct dma_desc *desc)
99 if (!((ar9170_get_rx_macstatus_status(desc) &
100 AR9170_RX_STATUS_MPDU) & AR9170_RX_STATUS_MPDU_LAST)) {
101 return (void *)((uint8_t *)DESC_PAYLOAD(desc) +
102 offsetof(struct ar9170_rx_frame_head, phy_head));
104 return (void *) NULL;
108 static inline __inline uint32_t ar9170_rx_to_phy(struct dma_desc *rx)
110 struct ar9170_tx_hw_phy_control phy;
111 struct ar9170_rx_head *head;
116 head = ar9170_get_rx_head(rx);
118 return le32_to_cpu(phy.set);
120 mac_status = ar9170_get_rx_macstatus_status(rx);
122 phy.modulation = mac_status & AR9170_RX_STATUS_MODULATION;
123 phy.chains = AR9170_TX_PHY_TXCHAIN_1;
125 switch (phy.modulation) {
126 case AR9170_RX_STATUS_MODULATION_CCK:
127 if (mac_status & AR9170_RX_STATUS_SHORT_PREAMBLE)
130 switch (head->plcp[0]) {
131 case AR9170_RX_PHY_RATE_CCK_2M:
132 phy.mcs = AR9170_TX_PHY_RATE_CCK_2M;
135 case AR9170_RX_PHY_RATE_CCK_5M:
136 phy.mcs = AR9170_TX_PHY_RATE_CCK_5M;
139 case AR9170_RX_PHY_RATE_CCK_11M:
140 phy.mcs = AR9170_TX_PHY_RATE_CCK_11M;
143 case AR9170_RX_PHY_RATE_CCK_1M:
145 phy.mcs = AR9170_TX_PHY_RATE_CCK_1M;
151 case AR9170_RX_STATUS_MODULATION_DUPOFDM:
152 case AR9170_RX_STATUS_MODULATION_OFDM:
153 phy.mcs = head->plcp[0] & 0xf;
156 case AR9170_RX_STATUS_MODULATION_HT:
157 if (head->plcp[3] & 0x80)
160 if (head->plcp[6] & 0x80)
163 /* TODO: Enable both chains for MCS > 7 */
164 phy.mcs = head->plcp[6] & 0x7;
168 return le32_to_cpu(phy.set);
171 static inline __inline unsigned int ar9170_get_rx_mpdu_len(struct dma_desc *desc)
174 * WARNING: you have to check the error bits in macstatus first!
177 unsigned int mpdu_len = desc->totalLen;
179 mpdu_len -= sizeof(struct ar9170_rx_macstatus);
181 switch (ar9170_get_rx_macstatus_status(desc) & AR9170_RX_STATUS_MPDU) {
182 case AR9170_RX_STATUS_MPDU_LAST:
183 mpdu_len -= sizeof(struct ar9170_rx_phystatus);
186 case AR9170_RX_STATUS_MPDU_SINGLE:
187 mpdu_len -= sizeof(struct ar9170_rx_phystatus);
189 case AR9170_RX_STATUS_MPDU_FIRST:
190 mpdu_len -= sizeof(struct ar9170_rx_head);
193 case AR9170_RX_STATUS_MPDU_MIDDLE:
201 static inline __inline bool ar9170_tx_length_check(const uint16_t len)
203 return len > (sizeof(struct carl9170_tx_superframe) + 24 +
207 static inline __inline struct carl9170_tx_superframe *get_super(struct dma_desc *desc)
209 return container_of(DESC_PAYLOAD(desc), struct carl9170_tx_superframe,
213 static inline __inline void hide_super(struct dma_desc *desc)
215 desc->dataAddr = (uint8_t *)
216 (((unsigned long)(DESC_PAYLOAD(desc)) +
217 offsetof(struct carl9170_tx_superframe, f)));
219 desc->dataSize -= sizeof(struct carl9170_tx_superdesc);
220 desc->totalLen -= sizeof(struct carl9170_tx_superdesc);
223 static inline __inline void unhide_super(struct dma_desc *desc)
225 desc->dataAddr = (uint8_t *) get_super(desc);
226 desc->dataSize += sizeof(struct carl9170_tx_superdesc);
227 desc->totalLen += sizeof(struct carl9170_tx_superdesc);
230 static inline __inline __hot void read_tsf(uint32_t *tsf)
233 * "According to the [hardware] documentation:
234 * > when TSF_LOW is read, TSF_HI is automatically concurrently
235 * > copied into a temporary register so that an immediate read
236 * > of TSF_HI will get the value that was present when TSF_LOW
239 * (David H. Lynch Jr. - mail from 2010-05-22)
240 * http://permalink.gmane.org/gmane.linux.kernel.wireless.general/51249
243 tsf[0] = get(AR9170_MAC_REG_TSF_L);
244 tsf[1] = get(AR9170_MAC_REG_TSF_H);
247 void wlan_tx(struct dma_desc *desc);
248 void wlan_timer(void);
249 void handle_wlan(void);
251 void wlan_cab_flush_queue(const unsigned int vif);
252 void wlan_modify_beacon(const unsigned int vif,
253 const unsigned int bcn_addr,
254 const unsigned int bcn_len);
256 static inline void wlan_prepare_wol(void)
258 /* set filter policy to: discard everything */
259 fw.wlan.rx_filter = CARL9170_RX_FILTER_EVERYTHING;
261 /* reenable rx dma */
262 wlan_trigger(AR9170_DMA_TRIGGER_RXQ);
265 static inline void __check_wlantx(void)
267 BUILD_BUG_ON(CARL9170_TX_SUPERDESC_LEN & 3);
268 BUILD_BUG_ON(sizeof(struct carl9170_tx_superdesc) != CARL9170_TX_SUPERDESC_LEN);
269 BUILD_BUG_ON(sizeof(struct _carl9170_tx_superdesc) != CARL9170_TX_SUPERDESC_LEN);
270 BUILD_BUG_ON(sizeof(struct _carl9170_tx_superframe) != CARL9170_TX_SUPERFRAME_LEN);
271 BUILD_BUG_ON((offsetof(struct carl9170_tx_superframe, f) & 3) != 0);
272 BUILD_BUG_ON(offsetof(struct _carl9170_tx_superframe, f) !=
273 (offsetof(struct _carl9170_tx_superframe, f)));
274 BUILD_BUG_ON(sizeof(struct ar9170_tx_hwdesc) != AR9170_TX_HWDESC_LEN);
275 BUILD_BUG_ON(sizeof(struct _ar9170_tx_hwdesc) != AR9170_TX_HWDESC_LEN);
276 BUILD_BUG_ON(sizeof(struct ar9170_rx_head) != AR9170_RX_HEAD_LEN);
277 BUILD_BUG_ON(sizeof(struct ar9170_rx_phystatus) != AR9170_RX_PHYSTATUS_LEN);
278 BUILD_BUG_ON(sizeof(struct ar9170_rx_macstatus) != AR9170_RX_MACSTATUS_LEN);
281 #endif /* __CARL9170FW_WLAN_H */