sys/dev/ata/ata-dma.c

   1 /*-
   2  * Copyright (c) 1998 - 2007 Søren Schmidt <sos@FreeBSD.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer,
  10  *    without modification, immediately at the beginning of the file.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26
  27 #include <sys/cdefs.h>
  28 __FBSDID("$FreeBSD$");
  29
  30 #include <sys/param.h>
  31 #include <sys/systm.h>
  32 #include <sys/ata.h>
  33 #include <sys/kernel.h>
  34 #include <sys/endian.h>
  35 #include <sys/malloc.h>
  36 #include <sys/lock.h>
  37 #include <sys/sema.h>
  38 #include <sys/taskqueue.h>
  39 #include <vm/uma.h>
  40 #include <sys/bus.h>
  41 #include <machine/bus.h>
  42 #include <sys/rman.h>
  43 #include <dev/pci/pcivar.h>
  44 #include <dev/ata/ata-all.h>
  45 #include <dev/ata/ata-pci.h>
  46
  47 /* prototypes */
  48 static void ata_dmaalloc(device_t);
  49 static void ata_dmafree(device_t);
  50 static void ata_dmasetprd(void *, bus_dma_segment_t *, int, int);
  51 static int ata_dmaload(device_t, caddr_t, int32_t, int, void *, int *);
  52 static int ata_dmaunload(device_t);
  53
  54 /* local vars */
  55 static MALLOC_DEFINE(M_ATADMA, "ata_dma", "ATA driver DMA");
  56
  57 /* misc defines */
  58 #define MAXTABSZ        PAGE_SIZE
  59 #define MAXWSPCSZ       PAGE_SIZE*2
  60
  61 struct ata_dc_cb_args {
  62     bus_addr_t maddr;
  63     int error;
  64 };
  65
  66 void
  67 ata_dmainit(device_t dev)
  68 {
  69     struct ata_channel *ch = device_get_softc(dev);
  70
  71     if ((ch->dma = malloc(sizeof(struct ata_dma), M_ATADMA, M_NOWAIT|M_ZERO))) {
  72         ch->dma->alloc = ata_dmaalloc;
  73         ch->dma->free = ata_dmafree;
  74         ch->dma->setprd = ata_dmasetprd;
  75         ch->dma->load = ata_dmaload;
  76         ch->dma->unload = ata_dmaunload;
  77         ch->dma->alignment = 2;
  78         ch->dma->boundary = 65536;
  79         ch->dma->segsize = 128 * DEV_BSIZE;
  80         ch->dma->max_iosize = 128 * DEV_BSIZE;
  81         ch->dma->max_address = BUS_SPACE_MAXADDR_32BIT;
  82     }
  83 }
  84
  85 static void
  86 ata_dmasetupc_cb(void *xsc, bus_dma_segment_t *segs, int nsegs, int error)
  87 {
  88     struct ata_dc_cb_args *cba = (struct ata_dc_cb_args *)xsc;
  89
  90     if (!(cba->error = error))
  91         cba->maddr = segs[0].ds_addr;
  92 }
  93
  94 static void
  95 ata_dmaalloc(device_t dev)
  96 {
  97     struct ata_channel *ch = device_get_softc(dev);
  98     struct ata_dc_cb_args ccba;
  99
 100     if (bus_dma_tag_create(bus_get_dma_tag(dev), ch->dma->alignment, 0,
 101                            ch->dma->max_address, BUS_SPACE_MAXADDR,
 102                            NULL, NULL, ch->dma->max_iosize,
 103                            ATA_DMA_ENTRIES, ch->dma->segsize,
 104                            0, NULL, NULL, &ch->dma->dmatag))
 105         goto error;
 106
 107     if (bus_dma_tag_create(ch->dma->dmatag, PAGE_SIZE, PAGE_SIZE,
 108                            ch->dma->max_address, BUS_SPACE_MAXADDR,
 109                            NULL, NULL, MAXTABSZ, 1, MAXTABSZ,
 110                            0, NULL, NULL, &ch->dma->sg_tag))
 111         goto error;
 112
 113     if (bus_dma_tag_create(ch->dma->dmatag,ch->dma->alignment,ch->dma->boundary,
 114                            ch->dma->max_address, BUS_SPACE_MAXADDR,
 115                            NULL, NULL, ch->dma->max_iosize,
 116                            ATA_DMA_ENTRIES, ch->dma->segsize,
 117                            0, NULL, NULL, &ch->dma->data_tag))
 118         goto error;
 119
 120     if (bus_dmamem_alloc(ch->dma->sg_tag, (void **)&ch->dma->sg, 0,
 121                          &ch->dma->sg_map))
 122         goto error;
 123
 124     if (bus_dmamap_load(ch->dma->sg_tag, ch->dma->sg_map, ch->dma->sg,
 125                         MAXTABSZ, ata_dmasetupc_cb, &ccba, 0) || ccba.error) {
 126         bus_dmamem_free(ch->dma->sg_tag, ch->dma->sg, ch->dma->sg_map);
 127         goto error;
 128     }
 129     ch->dma->sg_bus = ccba.maddr;
 130
 131     if (bus_dmamap_create(ch->dma->data_tag, 0, &ch->dma->data_map))
 132         goto error;
 133
 134     if (bus_dma_tag_create(ch->dma->dmatag, PAGE_SIZE, 64 * 1024,
 135                            ch->dma->max_address, BUS_SPACE_MAXADDR,
 136                            NULL, NULL, MAXWSPCSZ, 1, MAXWSPCSZ,
 137                            0, NULL, NULL, &ch->dma->work_tag))
 138         goto error;
 139
 140     if (bus_dmamem_alloc(ch->dma->work_tag, (void **)&ch->dma->work, 0,
 141                          &ch->dma->work_map))
 142         goto error;
 143
 144     if (bus_dmamap_load(ch->dma->work_tag, ch->dma->work_map,ch->dma->work,
 145                         MAXWSPCSZ, ata_dmasetupc_cb, &ccba, 0) || ccba.error) {
 146         bus_dmamem_free(ch->dma->work_tag,ch->dma->work, ch->dma->work_map);
 147         goto error;
 148     }
 149     ch->dma->work_bus = ccba.maddr;
 150
 151     return;
 152
 153 error:
 154     device_printf(dev, "WARNING - DMA allocation failed, disabling DMA\n");
 155     ata_dmafree(dev);
 156     free(ch->dma, M_ATADMA);
 157     ch->dma = NULL;
 158 }
 159
 160 static void
 161 ata_dmafree(device_t dev)
 162 {
 163     struct ata_channel *ch = device_get_softc(dev);
 164
 165     if (ch->dma->work_bus) {
 166         bus_dmamap_unload(ch->dma->work_tag, ch->dma->work_map);
 167         bus_dmamem_free(ch->dma->work_tag, ch->dma->work, ch->dma->work_map);
 168         ch->dma->work_bus = 0;
 169         ch->dma->work_map = NULL;
 170         ch->dma->work = NULL;
 171     }
 172     if (ch->dma->work_tag) {
 173         bus_dma_tag_destroy(ch->dma->work_tag);
 174         ch->dma->work_tag = NULL;
 175     }
 176     if (ch->dma->sg_bus) {
 177         bus_dmamap_unload(ch->dma->sg_tag, ch->dma->sg_map);
 178         bus_dmamem_free(ch->dma->sg_tag, ch->dma->sg, ch->dma->sg_map);
 179         ch->dma->sg_bus = 0;
 180         ch->dma->sg_map = NULL;
 181         ch->dma->sg = NULL;
 182     }
 183     if (ch->dma->data_map) {
 184         bus_dmamap_destroy(ch->dma->data_tag, ch->dma->data_map);
 185         ch->dma->data_map = NULL;
 186     }
 187     if (ch->dma->sg_tag) {
 188         bus_dma_tag_destroy(ch->dma->sg_tag);
 189         ch->dma->sg_tag = NULL;
 190     }
 191     if (ch->dma->data_tag) {
 192         bus_dma_tag_destroy(ch->dma->data_tag);
 193         ch->dma->data_tag = NULL;
 194     }
 195     if (ch->dma->dmatag) {
 196         bus_dma_tag_destroy(ch->dma->dmatag);
 197         ch->dma->dmatag = NULL;
 198     }
 199 }
 200
 201 static void
 202 ata_dmasetprd(void *xsc, bus_dma_segment_t *segs, int nsegs, int error)
 203 {
 204     struct ata_dmasetprd_args *args = xsc;
 205     struct ata_dma_prdentry *prd = args->dmatab;
 206     int i;
 207
 208     if ((args->error = error))
 209         return;
 210
 211     for (i = 0; i < nsegs; i++) {
 212         prd[i].addr = htole32(segs[i].ds_addr);
 213         prd[i].count = htole32(segs[i].ds_len);
 214     }
 215     prd[i - 1].count |= htole32(ATA_DMA_EOT);
 216     KASSERT(nsegs <= ATA_DMA_ENTRIES, ("too many DMA segment entries\n"));
 217     args->nsegs = nsegs;
 218 }
 219
 220 static int
 221 ata_dmaload(device_t dev, caddr_t data, int32_t count, int dir,
 222             void *addr, int *entries)
 223 {
 224     struct ata_channel *ch = device_get_softc(dev);
 225     struct ata_dmasetprd_args cba;
 226     int error;
 227
 228     if (ch->dma->flags & ATA_DMA_LOADED) {
 229         device_printf(dev, "FAILURE - already active DMA on this device\n");
 230         return EIO;
 231     }
 232     if (!count) {
 233         device_printf(dev, "FAILURE - zero length DMA transfer attempted\n");
 234         return EIO;
 235     }
 236     if (((uintptr_t)data & (ch->dma->alignment - 1)) ||
 237         (count & (ch->dma->alignment - 1))) {
 238         device_printf(dev, "FAILURE - non aligned DMA transfer attempted\n");
 239         return EIO;
 240     }
 241     if (count > ch->dma->max_iosize) {
 242         device_printf(dev, "FAILURE - oversized DMA transfer attempt %d > %d\n",
 243                       count, ch->dma->max_iosize);
 244         return EIO;
 245     }
 246
 247     cba.dmatab = addr;
 248
 249     if ((error = bus_dmamap_load(ch->dma->data_tag, ch->dma->data_map,
 250                                  data, count, ch->dma->setprd, &cba,
 251                                  BUS_DMA_NOWAIT)) || (error = cba.error))
 252         return error;
 253
 254     *entries = cba.nsegs;
 255
 256     bus_dmamap_sync(ch->dma->sg_tag, ch->dma->sg_map, BUS_DMASYNC_PREWRITE);
 257
 258     bus_dmamap_sync(ch->dma->data_tag, ch->dma->data_map,
 259                     dir ? BUS_DMASYNC_PREREAD : BUS_DMASYNC_PREWRITE);
 260
 261     ch->dma->cur_iosize = count;
 262     ch->dma->flags = dir ? (ATA_DMA_LOADED | ATA_DMA_READ) : ATA_DMA_LOADED;
 263     return 0;
 264 }
 265
 266 int
 267 ata_dmaunload(device_t dev)
 268 {
 269     struct ata_channel *ch = device_get_softc(dev);
 270
 271     if (ch->dma->flags & ATA_DMA_LOADED) {
 272         bus_dmamap_sync(ch->dma->sg_tag, ch->dma->sg_map,
 273                         BUS_DMASYNC_POSTWRITE);
 274
 275         bus_dmamap_sync(ch->dma->data_tag, ch->dma->data_map,
 276                         (ch->dma->flags & ATA_DMA_READ) ?
 277                         BUS_DMASYNC_POSTREAD : BUS_DMASYNC_POSTWRITE);
 278         bus_dmamap_unload(ch->dma->data_tag, ch->dma->data_map);
 279
 280         ch->dma->cur_iosize = 0;
 281         ch->dma->flags &= ~ATA_DMA_LOADED;
 282     }
 283     return 0;
 284 }