carlfw/src/dma.c

   1 /*
   2  * carl9170 firmware - used by the ar9170 wireless device
   3  *
   4  * DMA descriptor handling functions
   5  *
   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>
  10  *
  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.
  15  *
  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.
  20  *
  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.
  24  */
  25
  26 #include "carl9170.h"
  27 #include "wl.h"
  28 #include "printf.h"
  29
  30 struct ar9170_dma_memory dma_mem __section(sram);
  31
  32 static void copy_dma_desc(struct dma_desc *dst,
  33                           struct dma_desc *src)
  34 {
  35         memcpy(dst, src, sizeof(struct dma_desc));
  36 }
  37
  38 static void clear_descriptor(struct dma_desc *d)
  39 {
  40         d->status = AR9170_OWN_BITS_SW;
  41         d->ctrl = 0;
  42         d->dataSize = 0;
  43         d->totalLen = 0;
  44         d->lastAddr = d;
  45         d->dataAddr = NULL;
  46         d->nextAddr = d;
  47 }
  48
  49 static void fill_descriptor(struct dma_desc *d, uint16_t size, uint8_t *data)
  50 {
  51         d->status = AR9170_OWN_BITS_SW;
  52         d->ctrl = 0;
  53         d->dataSize = size;
  54         d->totalLen = 0;
  55         d->lastAddr = d;
  56         d->dataAddr = data;
  57         d->nextAddr = NULL;
  58 }
  59
  60 /*
  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().
  64  *
  65  * NOTE: LastAddr tempary point (same) to nextAddr after initialize.
  66  *       Because LastAddr is don't care in function dma_reclaim().
  67  */
  68 void dma_init_descriptors(void)
  69 {
  70         unsigned int i, j;
  71
  72         for (i = 0; i < ARRAY_SIZE(dma_mem.terminator); i++)
  73                 clear_descriptor(&dma_mem.terminator[i]);
  74
  75         /* Assign terminators to DMA queues */
  76         i = 0;
  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++];
  84         fw.wlan.fw_desc = &dma_mem.terminator[i++];
  85
  86 #ifdef CONFIG_CARL9170FW_CAB_QUEUE
  87         /* GCC bug ? */
  88 # if (CARL9170_INTF_NUM != 2)
  89         for (j = 0; j < CARL9170_INTF_NUM; j++)
  90                 fw.wlan.cab_queue[j].head = fw.wlan.cab_queue[j].terminator = &dma_mem.terminator[i++];
  91 #else
  92         fw.wlan.cab_queue[0].head = fw.wlan.cab_queue[0].terminator = &dma_mem.terminator[i++];
  93         fw.wlan.cab_queue[1].head = fw.wlan.cab_queue[1].terminator = &dma_mem.terminator[i++];
  94 #endif
  95 #endif /* CONFIG_CARL9170FW_CAB_QUEUE */
  96
  97         BUILD_BUG_ON(AR9170_TERMINATOR_NUMBER != j);
  98
  99         DBG("Blocks:%d [tx:%d, rx:%d] Terminators:%d/%d\n",
 100             AR9170_BLOCK_NUMBER, AR9170_TX_BLOCK_NUMBER,
 101             AR9170_RX_BLOCK_NUMBER, AR9170_TERMINATOR_NUMBER, i);
 102
 103         /* Init descriptors and memory blocks */
 104         for (i = 0; i < AR9170_BLOCK_NUMBER; i++) {
 105                 fill_descriptor(&dma_mem.block[i], AR9170_BLOCK_SIZE, dma_mem.data[i].data);
 106
 107                 if (i < AR9170_TX_BLOCK_NUMBER)
 108                         dma_reclaim(&fw.pta.down_queue, &dma_mem.block[i]);
 109                 else
 110                         dma_reclaim(&fw.wlan.rx_queue, &dma_mem.block[i]);
 111         }
 112
 113         /* Set DMA address registers */
 114         set(AR9170_PTA_REG_DN_DMA_ADDRH, (uint32_t) fw.pta.down_queue.head >> 16);
 115         set(AR9170_PTA_REG_DN_DMA_ADDRL, (uint32_t) fw.pta.down_queue.head & 0xffff);
 116         set(AR9170_PTA_REG_UP_DMA_ADDRH, (uint32_t) fw.pta.up_queue.head >> 16);
 117         set(AR9170_PTA_REG_UP_DMA_ADDRL, (uint32_t) fw.pta.up_queue.head & 0xffff);
 118
 119         for (i = 0; i < __AR9170_NUM_TX_QUEUES; i++)
 120                 set_wlan_txq_dma_addr(i, (uint32_t) fw.wlan.tx_queue[i].head);
 121
 122         set(AR9170_MAC_REG_DMA_RXQ_ADDR, (uint32_t) fw.wlan.rx_queue.head);
 123
 124         fw.usb.int_desc->dataSize = AR9170_BLOCK_SIZE;
 125         fw.usb.int_desc->dataAddr = (void *) &dma_mem.reserved.rsp;
 126
 127         memset(DESC_PAYLOAD(fw.usb.int_desc), 0xff,
 128                AR9170_INT_MAGIC_HEADER_SIZE);
 129         memset(DESC_PAYLOAD_OFF(fw.usb.int_desc, AR9170_INT_MAGIC_HEADER_SIZE),
 130                0, AR9170_BLOCK_SIZE - AR9170_INT_MAGIC_HEADER_SIZE);
 131
 132         /* rsp is now available for use */
 133         fw.usb.int_desc_available = 1;
 134
 135         memset(DESC_PAYLOAD(fw.wlan.fw_desc), 0, 128);
 136         fw.wlan.fw_desc_available = 1;
 137 }
 138
 139 /*
 140  * Free descriptor.
 141  *
 142  * Exchange the terminator and the first descriptor of the packet
 143  * for hardware ascy...
 144  */
 145 void dma_reclaim(struct dma_queue *q, struct dma_desc *desc)
 146 {
 147         struct dma_desc *tmpDesc, *last;
 148         struct dma_desc tdesc;
 149
 150         /* 1. Set OWN bit to HW for all TDs to be added, clear ctrl and size */
 151         tmpDesc = desc;
 152         last = desc->lastAddr;
 153
 154         while (1) {
 155                 tmpDesc->status = AR9170_OWN_BITS_HW;
 156                 tmpDesc->ctrl = 0;
 157                 tmpDesc->totalLen = 0;
 158                 tmpDesc->dataSize = AR9170_BLOCK_SIZE;
 159
 160                 /* TODO : Exception handle */
 161
 162                 tmpDesc->lastAddr = tmpDesc;
 163
 164                 if (tmpDesc == last)
 165                         break;
 166
 167                 tmpDesc = tmpDesc->nextAddr;
 168         }
 169
 170         /* 2. Next address of Last TD to be added = first TD */
 171         tmpDesc->nextAddr = desc;
 172
 173         /* Link first TD to self */
 174         desc->lastAddr = q->terminator;
 175
 176         /* 3. Copy first TD to be added to TTD */
 177         copy_dma_desc(&tdesc, desc);
 178
 179         /* 4. Initialize new terminator */
 180         clear_descriptor(desc);
 181
 182         /* 5. Copy TTD to last TD */
 183         tdesc.status = 0;
 184         copy_dma_desc((void *)q->terminator, (void *)&tdesc);
 185         q->terminator->status |= AR9170_OWN_BITS_HW;
 186
 187         /* Update terminator pointer */
 188         q->terminator = desc;
 189 }
 190
 191 /*
 192  * Put a complete packet into the tail of the Queue q.
 193  * Exchange the terminator and the first descriptor of the packet
 194  * for hardware ascy...
 195  */
 196 void dma_put(struct dma_queue *q, struct dma_desc *desc)
 197 {
 198         struct dma_desc *tmpDesc;
 199         struct dma_desc tdesc;
 200
 201         tmpDesc = desc;
 202
 203         while (1) {
 204                 /* update totalLen */
 205                 tmpDesc->totalLen = desc->totalLen;
 206
 207                 /* 1. Set OWN bit to HW for all TDs to be added */
 208                 tmpDesc->status = AR9170_OWN_BITS_HW;
 209                 /* TODO : Exception handle */
 210
 211                 tmpDesc->lastAddr = desc->lastAddr;
 212
 213                 if (desc->lastAddr == tmpDesc)
 214                         break;
 215
 216                 tmpDesc = tmpDesc->nextAddr;
 217         }
 218
 219         /* 2. Next address of Last TD to be added = first TD */
 220         desc->lastAddr->nextAddr = desc;
 221
 222         /* If there is only one descriptor, update pointer of last descriptor */
 223         if (desc->lastAddr == desc)
 224                 desc->lastAddr = q->terminator;
 225
 226         /* 3. Copy first TD to be added to TTD */
 227         copy_dma_desc(&tdesc, desc);
 228
 229         /* 4. Initialize new terminator */
 230         clear_descriptor(desc);
 231
 232         /* 5. Copy TTD to last TD */
 233         tdesc.status &= (~AR9170_OWN_BITS);
 234         copy_dma_desc((void *)q->terminator, (void *)&tdesc);
 235         q->terminator->status |= AR9170_OWN_BITS_HW;
 236
 237         /* Update terminator pointer */
 238         q->terminator = desc;
 239 }
 240
 241 struct dma_desc *dma_unlink_head(struct dma_queue *queue)
 242 {
 243         struct dma_desc *desc;
 244
 245         if (queue_empty(queue))
 246                 return NULL;
 247
 248         desc = queue->head;
 249
 250         queue->head = desc->lastAddr->nextAddr;
 251
 252         /* poison nextAddr address */
 253         desc->lastAddr->nextAddr = desc->lastAddr;
 254         desc->lastAddr->lastAddr = desc->lastAddr;
 255
 256         return desc;
 257 }