sys/dev/ata/ata-dma.c

   1 /*-
   2  * Copyright (c) 1998 - 2008 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/ata/ata-all.h>
  44
  45 /* prototypes */
  46 static void ata_dmasetupc_cb(void *xsc, bus_dma_segment_t *segs, int nsegs, int error);
  47 static void ata_dmaalloc(device_t dev);
  48 static void ata_dmafree(device_t dev);
  49 static void ata_dmasetprd(void *xsc, bus_dma_segment_t *segs, int nsegs, int error);
  50 static int ata_dmaload(struct ata_request *request, void *addr, int *nsegs);
  51 static int ata_dmaunload(struct ata_request *request);
  52
  53 /* local vars */
  54 static MALLOC_DEFINE(M_ATADMA, "ata_dma", "ATA driver DMA");
  55
  56 /* misc defines */
  57 #define MAXTABSZ        PAGE_SIZE
  58 #define MAXWSPCSZ       PAGE_SIZE*2
  59
  60 struct ata_dc_cb_args {
  61     bus_addr_t maddr;
  62     int error;
  63 };
  64
  65 void
  66 ata_dmainit(device_t dev)
  67 {
  68     struct ata_channel *ch = device_get_softc(dev);
  69     struct ata_dc_cb_args dcba;
  70
  71     ch->dma.alloc = ata_dmaalloc;
  72     ch->dma.free = ata_dmafree;
  73     ch->dma.setprd = ata_dmasetprd;
  74     ch->dma.load = ata_dmaload;
  75     ch->dma.unload = ata_dmaunload;
  76     ch->dma.alignment = 2;
  77     ch->dma.boundary = 65536;
  78     ch->dma.segsize = 65536;
  79     ch->dma.max_iosize = MIN((ATA_DMA_ENTRIES - 1) * PAGE_SIZE, MAXPHYS);
  80     ch->dma.max_address = BUS_SPACE_MAXADDR_32BIT;
  81     ch->dma.dma_slots = 1;
  82
  83     if (bus_dma_tag_create(bus_get_dma_tag(dev), ch->dma.alignment, 0,
  84                            ch->dma.max_address, BUS_SPACE_MAXADDR,
  85                            NULL, NULL, ch->dma.max_iosize,
  86                            ATA_DMA_ENTRIES, ch->dma.segsize,
  87                            0, NULL, NULL, &ch->dma.dmatag))
  88         goto error;
  89
  90     if (bus_dma_tag_create(ch->dma.dmatag, PAGE_SIZE, 64 * 1024,
  91                            ch->dma.max_address, BUS_SPACE_MAXADDR,
  92                            NULL, NULL, MAXWSPCSZ, 1, MAXWSPCSZ,
  93                            0, NULL, NULL, &ch->dma.work_tag))
  94         goto error;
  95
  96     if (bus_dmamem_alloc(ch->dma.work_tag, (void **)&ch->dma.work, 0,
  97                          &ch->dma.work_map))
  98         goto error;
  99
 100     if (bus_dmamap_load(ch->dma.work_tag, ch->dma.work_map, ch->dma.work,
 101                         MAXWSPCSZ, ata_dmasetupc_cb, &dcba, 0) ||
 102                         dcba.error) {
 103         bus_dmamem_free(ch->dma.work_tag, ch->dma.work, ch->dma.work_map);
 104         goto error;
 105     }
 106     ch->dma.work_bus = dcba.maddr;
 107     return;
 108
 109 error:
 110     device_printf(dev, "WARNING - DMA initialization failed, disabling DMA\n");
 111     ata_dmafini(dev);
 112 }
 113
 114 void
 115 ata_dmafini(device_t dev)
 116 {
 117     struct ata_channel *ch = device_get_softc(dev);
 118
 119     if (ch->dma.work_bus) {
 120         bus_dmamap_unload(ch->dma.work_tag, ch->dma.work_map);
 121         bus_dmamem_free(ch->dma.work_tag, ch->dma.work, ch->dma.work_map);
 122         ch->dma.work_bus = 0;
 123         ch->dma.work_map = NULL;
 124         ch->dma.work = NULL;
 125     }
 126     if (ch->dma.work_tag) {
 127         bus_dma_tag_destroy(ch->dma.work_tag);
 128         ch->dma.work_tag = NULL;
 129     }
 130     if (ch->dma.dmatag) {
 131         bus_dma_tag_destroy(ch->dma.dmatag);
 132         ch->dma.dmatag = NULL;
 133     }
 134 }
 135
 136 static void
 137 ata_dmasetupc_cb(void *xsc, bus_dma_segment_t *segs, int nsegs, int error)
 138 {
 139     struct ata_dc_cb_args *dcba = (struct ata_dc_cb_args *)xsc;
 140
 141     if (!(dcba->error = error))
 142         dcba->maddr = segs[0].ds_addr;
 143 }
 144
 145 static void
 146 ata_dmaalloc(device_t dev)
 147 {
 148     struct ata_channel *ch = device_get_softc(dev);
 149     struct ata_dc_cb_args dcba;
 150     int i;
 151
 152     /* alloc and setup needed dma slots */
 153     bzero(ch->dma.slot, sizeof(struct ata_dmaslot) * ATA_DMA_SLOTS);
 154     for (i = 0; i < ch->dma.dma_slots; i++) {
 155         struct ata_dmaslot *slot = &ch->dma.slot[i];
 156
 157         if (bus_dma_tag_create(ch->dma.dmatag, PAGE_SIZE, PAGE_SIZE,
 158                                ch->dma.max_address, BUS_SPACE_MAXADDR,
 159                                NULL, NULL, PAGE_SIZE, 1, PAGE_SIZE,
 160                                0, NULL, NULL, &slot->sg_tag)) {
 161             device_printf(ch->dev, "FAILURE - create sg_tag\n");
 162             goto error;
 163         }
 164
 165         if (bus_dmamem_alloc(slot->sg_tag, (void **)&slot->sg,
 166                              0, &slot->sg_map)) {
 167             device_printf(ch->dev, "FAILURE - alloc sg_map\n");
 168             goto error;
 169         }
 170
 171         if (bus_dmamap_load(slot->sg_tag, slot->sg_map, slot->sg, MAXTABSZ,
 172                             ata_dmasetupc_cb, &dcba, 0) || dcba.error) {
 173             device_printf(ch->dev, "FAILURE - load sg\n");
 174             goto error;
 175         }
 176         slot->sg_bus = dcba.maddr;
 177
 178         if (bus_dma_tag_create(ch->dma.dmatag,
 179                                ch->dma.alignment, ch->dma.boundary,
 180                                ch->dma.max_address, BUS_SPACE_MAXADDR,
 181                                NULL, NULL, ch->dma.max_iosize,
 182                                ATA_DMA_ENTRIES, ch->dma.segsize,
 183                                BUS_DMA_ALLOCNOW, NULL, NULL, &slot->data_tag)) {
 184             device_printf(ch->dev, "FAILURE - create data_tag\n");
 185             goto error;
 186         }
 187
 188         if (bus_dmamap_create(slot->data_tag, 0, &slot->data_map)) {
 189             device_printf(ch->dev, "FAILURE - create data_map\n");
 190             goto error;
 191         }
 192     }
 193
 194     return;
 195
 196 error:
 197     device_printf(dev, "WARNING - DMA allocation failed, disabling DMA\n");
 198     ata_dmafree(dev);
 199 }
 200
 201 static void
 202 ata_dmafree(device_t dev)
 203 {
 204     struct ata_channel *ch = device_get_softc(dev);
 205     int i;
 206
 207     /* free all dma slots */
 208     for (i = 0; i < ATA_DMA_SLOTS; i++) {
 209         struct ata_dmaslot *slot = &ch->dma.slot[i];
 210
 211         if (slot->sg_bus) {
 212             bus_dmamap_unload(slot->sg_tag, slot->sg_map);
 213             slot->sg_bus = 0;
 214         }
 215         if (slot->sg_map) {
 216             bus_dmamem_free(slot->sg_tag, slot->sg, slot->sg_map);
 217             bus_dmamap_destroy(slot->sg_tag, slot->sg_map);
 218             slot->sg = NULL;
 219             slot->sg_map = NULL;
 220         }
 221         if (slot->data_map) {
 222             bus_dmamap_destroy(slot->data_tag, slot->data_map);
 223             slot->data_map = NULL;
 224         }
 225         if (slot->sg_tag) {
 226             bus_dma_tag_destroy(slot->sg_tag);
 227             slot->sg_tag = NULL;
 228         }
 229         if (slot->data_tag) {
 230             bus_dma_tag_destroy(slot->data_tag);
 231             slot->data_tag = NULL;
 232         }
 233     }
 234 }
 235
 236 static void
 237 ata_dmasetprd(void *xsc, bus_dma_segment_t *segs, int nsegs, int error)
 238 {
 239     struct ata_dmasetprd_args *args = xsc;
 240     struct ata_dma_prdentry *prd = args->dmatab;
 241     int i;
 242
 243     if ((args->error = error))
 244         return;
 245
 246     for (i = 0; i < nsegs; i++) {
 247         prd[i].addr = htole32(segs[i].ds_addr);
 248         prd[i].count = htole32(segs[i].ds_len);
 249     }
 250     prd[i - 1].count |= htole32(ATA_DMA_EOT);
 251     KASSERT(nsegs <= ATA_DMA_ENTRIES, ("too many DMA segment entries\n"));
 252     args->nsegs = nsegs;
 253 }
 254
 255 static int
 256 ata_dmaload(struct ata_request *request, void *addr, int *entries)
 257 {
 258     struct ata_channel *ch = device_get_softc(request->parent);
 259     struct ata_dmasetprd_args dspa;
 260     int error;
 261
 262     ATA_DEBUG_RQ(request, "dmaload");
 263
 264     if (request->dma) {
 265         device_printf(request->parent,
 266                       "FAILURE - already active DMA on this device\n");
 267         return EIO;
 268     }
 269     if (!request->bytecount) {
 270         device_printf(request->parent,
 271                       "FAILURE - zero length DMA transfer attempted\n");
 272         return EIO;
 273     }
 274     if (request->bytecount & (ch->dma.alignment - 1)) {
 275         device_printf(request->parent,
 276                       "FAILURE - odd-sized DMA transfer attempt %d %% %d\n",
 277                       request->bytecount, ch->dma.alignment);
 278         return EIO;
 279     }
 280     if (request->bytecount > ch->dma.max_iosize) {
 281         device_printf(request->parent,
 282                       "FAILURE - oversized DMA transfer attempt %d > %d\n",
 283                       request->bytecount, ch->dma.max_iosize);
 284         return EIO;
 285     }
 286
 287     /* set our slot. XXX SOS NCQ will change that */
 288     request->dma = &ch->dma.slot[0];
 289
 290     if (addr)
 291         dspa.dmatab = addr;
 292     else
 293         dspa.dmatab = request->dma->sg;
 294
 295     if ((error = bus_dmamap_load(request->dma->data_tag, request->dma->data_map,
 296                                  request->data, request->bytecount,
 297                                  ch->dma.setprd, &dspa, BUS_DMA_NOWAIT)) ||
 298                                  (error = dspa.error)) {
 299         device_printf(request->parent, "FAILURE - load data\n");
 300         goto error;
 301     }
 302
 303     if (entries)
 304         *entries = dspa.nsegs;
 305
 306     bus_dmamap_sync(request->dma->sg_tag, request->dma->sg_map,
 307                     BUS_DMASYNC_PREWRITE);
 308     bus_dmamap_sync(request->dma->data_tag, request->dma->data_map,
 309                     (request->flags & ATA_R_READ) ?
 310                     BUS_DMASYNC_PREREAD : BUS_DMASYNC_PREWRITE);
 311     return 0;
 312
 313 error:
 314     ata_dmaunload(request);
 315     return EIO;
 316 }
 317
 318 int
 319 ata_dmaunload(struct ata_request *request)
 320 {
 321     ATA_DEBUG_RQ(request, "dmaunload");
 322
 323     if (request->dma) {
 324         bus_dmamap_sync(request->dma->sg_tag, request->dma->sg_map,
 325                         BUS_DMASYNC_POSTWRITE);
 326         bus_dmamap_sync(request->dma->data_tag, request->dma->data_map,
 327                         (request->flags & ATA_R_READ) ?
 328                         BUS_DMASYNC_POSTREAD : BUS_DMASYNC_POSTWRITE);
 329
 330         bus_dmamap_unload(request->dma->data_tag, request->dma->data_map);
 331         request->dma = NULL;
 332     }
 333     return 0;
 334 }