2 * carl9170 firmware - used by the ar9170 wireless device
4 * DMA descriptor handling functions
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.
30 struct ar9170_dma_memory dma_mem __section(sram);
32 static void copy_dma_desc(struct dma_desc *dst,
35 memcpy(dst, src, sizeof(struct dma_desc));
38 static void clear_descriptor(struct dma_desc *d)
40 d->status = AR9170_OWN_BITS_SW;
49 static void fill_descriptor(struct dma_desc *d, uint16_t size, uint8_t *data)
51 d->status = AR9170_OWN_BITS_SW;
61 * - Init up_queue, down_queue, tx_queue[5], rx_queue.
62 * - Setup descriptors and data buffer address.
63 * - Ring descriptors rx_queue and down_queue by dma_reclaim().
65 * NOTE: LastAddr tempary point (same) to nextAddr after initialize.
66 * Because LastAddr is don't care in function dma_reclaim().
68 void dma_init_descriptors(void)
72 for (i = 0; i < ARRAY_SIZE(dma_mem.terminator); i++)
73 clear_descriptor(&dma_mem.terminator[i]);
75 /* Assign terminators to DMA queues */
77 fw.pta.up_queue.head = fw.pta.up_queue.terminator = &dma_mem.terminator[i++];
78 fw.pta.down_queue.head = fw.pta.down_queue.terminator = &dma_mem.terminator[i++];
79 for (j = 0; j < __AR9170_NUM_TX_QUEUES; j++)
80 fw.wlan.tx_queue[j].head = fw.wlan.tx_queue[j].terminator = &dma_mem.terminator[i++];
81 fw.wlan.tx_retry.head = fw.wlan.tx_retry.terminator = &dma_mem.terminator[i++];
82 fw.wlan.rx_queue.head = fw.wlan.rx_queue.terminator = &dma_mem.terminator[i++];
83 fw.usb.int_desc = &dma_mem.terminator[i++];
85 #ifdef CONFIG_CARL9170FW_CAB_QUEUE
87 # if (CARL9170_INTF_NUM != 2)
88 for (j = 0; j < CARL9170_INTF_NUM; j++)
89 fw.wlan.cab_queue[j].head = fw.wlan.cab_queue[j].terminator = &dma_mem.terminator[i++];
91 fw.wlan.cab_queue[0].head = fw.wlan.cab_queue[0].terminator = &dma_mem.terminator[i++];
92 fw.wlan.cab_queue[1].head = fw.wlan.cab_queue[1].terminator = &dma_mem.terminator[i++];
94 #endif /* CONFIG_CARL9170FW_CAB_QUEUE */
96 #ifdef CONFIG_CARL9170FW_HANDLE_BACK_REQ
97 fw.wlan.ba_desc = &dma_mem.terminator[i++];
98 #endif /* CONFIG_CARL9170FW_HANDLE_BACK_REQ */
100 BUILD_BUG_ON(AR9170_TERMINATOR_NUMBER != j);
102 DBG("Blocks:%d [tx:%d, rx:%d] Terminators:%d/%d\n",
103 AR9170_BLOCK_NUMBER, AR9170_TX_BLOCK_NUMBER,
104 AR9170_RX_BLOCK_NUMBER, AR9170_TERMINATOR_NUMBER, i);
106 /* Init descriptors and memory blocks */
107 for (i = 0; i < AR9170_BLOCK_NUMBER; i++) {
108 fill_descriptor(&dma_mem.block[i], AR9170_BLOCK_SIZE, dma_mem.data[i].data);
110 if (i < AR9170_TX_BLOCK_NUMBER)
111 dma_reclaim(&fw.pta.down_queue, &dma_mem.block[i]);
113 dma_reclaim(&fw.wlan.rx_queue, &dma_mem.block[i]);
116 /* Set DMA address registers */
117 set(AR9170_PTA_REG_DN_DMA_ADDRH, (uint32_t) fw.pta.down_queue.head >> 16);
118 set(AR9170_PTA_REG_DN_DMA_ADDRL, (uint32_t) fw.pta.down_queue.head & 0xffff);
119 set(AR9170_PTA_REG_UP_DMA_ADDRH, (uint32_t) fw.pta.up_queue.head >> 16);
120 set(AR9170_PTA_REG_UP_DMA_ADDRL, (uint32_t) fw.pta.up_queue.head & 0xffff);
122 for (i = 0; i < __AR9170_NUM_TX_QUEUES; i++)
123 set_wlan_txq_dma_addr(i, (uint32_t) fw.wlan.tx_queue[i].head);
125 set(AR9170_MAC_REG_DMA_RXQ_ADDR, (uint32_t) fw.wlan.rx_queue.head);
127 fw.usb.int_desc->status = AR9170_OWN_BITS_SW;
128 fw.usb.int_desc->ctrl = (AR9170_CTRL_LS_BIT | AR9170_CTRL_FS_BIT);
129 fw.usb.int_desc->dataSize = AR9170_BLOCK_SIZE;
130 fw.usb.int_desc->totalLen = 0;
131 fw.usb.int_desc->lastAddr = fw.usb.int_desc;
132 fw.usb.int_desc->dataAddr = (void *) &dma_mem.reserved.rsp;
133 fw.usb.int_desc->nextAddr = (void *) 0;
135 memset(DESC_PAYLOAD(fw.usb.int_desc), 0xff,
136 AR9170_INT_MAGIC_HEADER_SIZE);
137 memset(DESC_PAYLOAD_OFF(fw.usb.int_desc, AR9170_INT_MAGIC_HEADER_SIZE),
138 0, AR9170_BLOCK_SIZE - AR9170_INT_MAGIC_HEADER_SIZE);
140 /* rsp is now available for use */
141 fw.usb.int_desc_available = 1;
143 #ifdef CONFIG_CARL9170FW_HANDLE_BACK_REQ
144 fw.wlan.ba_desc->status = AR9170_OWN_BITS_SW;
145 fw.wlan.ba_desc->ctrl = (AR9170_CTRL_LS_BIT | AR9170_CTRL_FS_BIT);
146 fw.wlan.ba_desc->dataSize = fw.wlan.ba_desc->totalLen =
147 sizeof(struct carl9170_tx_superdesc) +
148 sizeof(struct ar9170_tx_hwdesc) +
149 sizeof(struct ieee80211_ba) + FCS_LEN;
150 fw.wlan.ba_desc->lastAddr = fw.wlan.ba_desc;
151 fw.wlan.ba_desc->nextAddr = fw.wlan.ba_desc;
152 fw.wlan.ba_desc->dataAddr = (void *) &dma_mem.reserved.ba;
154 memset(DESC_PAYLOAD(fw.wlan.ba_desc), 0, 128);
156 fw.wlan.ba_desc_available = 1;
157 #endif /* CONFIG_CARL9170FW_HANDLE_BACK_REQ */
163 * Exchange the terminator and the first descriptor of the packet
164 * for hardware ascy...
166 void dma_reclaim(struct dma_queue *q, struct dma_desc *desc)
168 struct dma_desc *tmpDesc, *last;
169 struct dma_desc tdesc;
171 /* 1. Set OWN bit to HW for all TDs to be added, clear ctrl and size */
173 last = desc->lastAddr;
176 tmpDesc->status = AR9170_OWN_BITS_HW;
178 tmpDesc->totalLen = 0;
179 tmpDesc->dataSize = AR9170_BLOCK_SIZE;
181 /* TODO : Exception handle */
183 tmpDesc->lastAddr = tmpDesc;
188 tmpDesc = tmpDesc->nextAddr;
191 /* 2. Next address of Last TD to be added = first TD */
192 tmpDesc->nextAddr = desc;
194 /* Link first TD to self */
195 desc->lastAddr = q->terminator;
197 /* 3. Copy first TD to be added to TTD */
198 copy_dma_desc(&tdesc, desc);
200 /* 4. Initialize new terminator */
201 clear_descriptor(desc);
203 /* 5. Copy TTD to last TD */
205 copy_dma_desc((void *)q->terminator, (void *)&tdesc);
206 q->terminator->status |= AR9170_OWN_BITS_HW;
208 /* Update terminator pointer */
209 q->terminator = desc;
213 * Put a complete packet into the tail of the Queue q.
214 * Exchange the terminator and the first descriptor of the packet
215 * for hardware ascy...
217 void dma_put(struct dma_queue *q, struct dma_desc *desc)
219 struct dma_desc *tmpDesc;
220 struct dma_desc tdesc;
225 /* update totalLen */
226 tmpDesc->totalLen = desc->totalLen;
228 /* 1. Set OWN bit to HW for all TDs to be added */
229 tmpDesc->status = AR9170_OWN_BITS_HW;
230 /* TODO : Exception handle */
232 tmpDesc->lastAddr = desc->lastAddr;
234 if (desc->lastAddr == tmpDesc)
237 tmpDesc = tmpDesc->nextAddr;
240 /* 2. Next address of Last TD to be added = first TD */
241 desc->lastAddr->nextAddr = desc;
243 /* If there is only one descriptor, update pointer of last descriptor */
244 if (desc->lastAddr == desc)
245 desc->lastAddr = q->terminator;
247 /* 3. Copy first TD to be added to TTD */
248 copy_dma_desc(&tdesc, desc);
250 /* 4. Initialize new terminator */
251 clear_descriptor(desc);
253 /* 5. Copy TTD to last TD */
254 tdesc.status &= (~AR9170_OWN_BITS);
255 copy_dma_desc((void *)q->terminator, (void *)&tdesc);
256 q->terminator->status |= AR9170_OWN_BITS_HW;
258 /* Update terminator pointer */
259 q->terminator = desc;
262 struct dma_desc *dma_unlink_head(struct dma_queue *queue)
264 struct dma_desc *desc;
266 if (queue_empty(queue))
271 queue->head = desc->lastAddr->nextAddr;
273 /* poison nextAddr address */
274 desc->lastAddr->nextAddr = desc->lastAddr;
275 desc->lastAddr->lastAddr = desc->lastAddr;