sys/dev/disk/nata/ata-dma.c

   1 /*-
   2  * Copyright (c) 1998 - 2006 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  * $FreeBSD: src/sys/dev/ata/ata-dma.c,v 1.147 2007/04/08 21:53:52 sos Exp $
  27  * $DragonFly: src/sys/dev/disk/nata/ata-dma.c,v 1.5 2007/07/23 19:26:09 dillon Exp $
  28  */
  29
  30 #include "opt_ata.h"
  31
  32 #include <sys/param.h>
  33 #include <sys/bus.h>
  34 #include <sys/bus_dma.h>
  35 #include <sys/endian.h>
  36 #include <sys/malloc.h>
  37 #include <sys/nata.h>
  38
  39 #include <machine/bus_dma.h>
  40
  41 #include "ata-all.h"
  42 #include "ata-pci.h"
  43 #include "ata_if.h"
  44
  45 /* prototypes */
  46 static void ata_dmaalloc(device_t);
  47 static void ata_dmafree(device_t);
  48 static void ata_dmasetprd(void *, bus_dma_segment_t *, int, int);
  49 static int ata_dmaload(device_t, caddr_t, int32_t, int, void *, int *);
  50 static int ata_dmaunload(device_t);
  51
  52 /* local vars */
  53 static MALLOC_DEFINE(M_ATADMA, "ata_dma", "ATA driver DMA");
  54
  55 /* misc defines */
  56 #define MAXTABSZ        PAGE_SIZE
  57 #define MAXWSPCSZ       PAGE_SIZE*2
  58
  59 struct ata_dc_cb_args {
  60     bus_addr_t maddr;
  61     int error;
  62 };
  63
  64 void
  65 ata_dmainit(device_t dev)
  66 {
  67     struct ata_channel *ch = device_get_softc(dev);
  68
  69     ch->dma = kmalloc(sizeof(struct ata_dma), M_ATADMA, M_INTWAIT|M_ZERO);
  70     ch->dma->alloc = ata_dmaalloc;
  71     ch->dma->free = ata_dmafree;
  72     ch->dma->setprd = ata_dmasetprd;
  73     ch->dma->load = ata_dmaload;
  74     ch->dma->unload = ata_dmaunload;
  75     ch->dma->alignment = 2;
  76     ch->dma->boundary = 128 * DEV_BSIZE;
  77     ch->dma->segsize = 128 * DEV_BSIZE;
  78     ch->dma->max_iosize = 128 * DEV_BSIZE;
  79     ch->dma->max_address = BUS_SPACE_MAXADDR_32BIT;
  80 }
  81
  82 static void
  83 ata_dmasetupc_cb(void *xsc, bus_dma_segment_t *segs, int nsegs, int error)
  84 {
  85     struct ata_dc_cb_args *cba = (struct ata_dc_cb_args *)xsc;
  86
  87     if (!(cba->error = error))
  88         cba->maddr = segs[0].ds_addr;
  89 }
  90
  91 static void
  92 ata_dmaalloc(device_t dev)
  93 {
  94     struct ata_channel *ch = device_get_softc(dev);
  95     struct ata_dc_cb_args ccba;
  96
  97     if (bus_dma_tag_create(NULL, ch->dma->alignment, 0,
  98                            ch->dma->max_address, BUS_SPACE_MAXADDR,
  99                            NULL, NULL, ch->dma->max_iosize,
 100                            ATA_DMA_ENTRIES, ch->dma->segsize,
 101                            0, &ch->dma->dmatag))
 102         goto error;
 103
 104     if (bus_dma_tag_create(ch->dma->dmatag, PAGE_SIZE, PAGE_SIZE,
 105                            ch->dma->max_address, BUS_SPACE_MAXADDR,
 106                            NULL, NULL, MAXTABSZ, 1, MAXTABSZ,
 107                            0, &ch->dma->sg_tag))
 108         goto error;
 109
 110     if (bus_dma_tag_create(ch->dma->dmatag,ch->dma->alignment,ch->dma->boundary,
 111                            ch->dma->max_address, BUS_SPACE_MAXADDR,
 112                            NULL, NULL, ch->dma->max_iosize,
 113                            ATA_DMA_ENTRIES, ch->dma->segsize,
 114                            0, &ch->dma->data_tag))
 115         goto error;
 116
 117     if (bus_dmamem_alloc(ch->dma->sg_tag, (void **)&ch->dma->sg, 0,
 118                          &ch->dma->sg_map))
 119         goto error;
 120
 121     if (bus_dmamap_load(ch->dma->sg_tag, ch->dma->sg_map, ch->dma->sg,
 122                         MAXTABSZ, ata_dmasetupc_cb, &ccba, 0) || ccba.error) {
 123         bus_dmamem_free(ch->dma->sg_tag, ch->dma->sg, ch->dma->sg_map);
 124         goto error;
 125     }
 126     ch->dma->sg_bus = ccba.maddr;
 127
 128     if (bus_dmamap_create(ch->dma->data_tag, 0, &ch->dma->data_map))
 129         goto error;
 130
 131     if (bus_dma_tag_create(ch->dma->dmatag, PAGE_SIZE, 64 * 1024,
 132                            ch->dma->max_address, BUS_SPACE_MAXADDR,
 133                            NULL, NULL, MAXWSPCSZ, 1, MAXWSPCSZ,
 134                            0, &ch->dma->work_tag))
 135         goto error;
 136
 137     if (bus_dmamem_alloc(ch->dma->work_tag, (void *)&ch->dma->work, 0,
 138                          (void *)&ch->dma->work_map))
 139         goto error;
 140
 141     if (bus_dmamap_load(ch->dma->work_tag, ch->dma->work_map,ch->dma->work,
 142                         MAXWSPCSZ, ata_dmasetupc_cb, &ccba, 0) || ccba.error) {
 143         bus_dmamem_free(ch->dma->work_tag,ch->dma->work, ch->dma->work_map);
 144         goto error;
 145     }
 146     ch->dma->work_bus = ccba.maddr;
 147
 148     return;
 149
 150 error:
 151     device_printf(dev, "WARNING - DMA allocation failed, disabling DMA\n");
 152     ata_dmafree(dev);
 153     kfree(ch->dma, M_ATADMA);
 154     ch->dma = NULL;
 155 }
 156
 157 static void
 158 ata_dmafree(device_t dev)
 159 {
 160     struct ata_channel *ch = device_get_softc(dev);
 161
 162     if (ch->dma->work_bus) {
 163         bus_dmamap_unload(ch->dma->work_tag, ch->dma->work_map);
 164         bus_dmamem_free(ch->dma->work_tag, ch->dma->work, ch->dma->work_map);
 165         ch->dma->work_bus = 0;
 166         ch->dma->work_map = NULL;
 167         ch->dma->work = NULL;
 168     }
 169     if (ch->dma->work_tag) {
 170         bus_dma_tag_destroy(ch->dma->work_tag);
 171         ch->dma->work_tag = NULL;
 172     }
 173     if (ch->dma->sg_bus) {
 174         bus_dmamap_unload(ch->dma->sg_tag, ch->dma->sg_map);
 175         bus_dmamem_free(ch->dma->sg_tag, ch->dma->sg, ch->dma->sg_map);
 176         ch->dma->sg_bus = 0;
 177         ch->dma->sg_map = NULL;
 178         ch->dma->sg = NULL;
 179     }
 180     if (ch->dma->data_map) {
 181         bus_dmamap_destroy(ch->dma->data_tag, ch->dma->data_map);
 182         ch->dma->data_map = NULL;
 183     }
 184     if (ch->dma->sg_tag) {
 185         bus_dma_tag_destroy(ch->dma->sg_tag);
 186         ch->dma->sg_tag = NULL;
 187     }
 188     if (ch->dma->data_tag) {
 189         bus_dma_tag_destroy(ch->dma->data_tag);
 190         ch->dma->data_tag = NULL;
 191     }
 192     if (ch->dma->dmatag) {
 193         bus_dma_tag_destroy(ch->dma->dmatag);
 194         ch->dma->dmatag = NULL;
 195     }
 196 }
 197
 198 static void
 199 ata_dmasetprd(void *xsc, bus_dma_segment_t *segs, int nsegs, int error)
 200 {
 201     struct ata_dmasetprd_args *args = xsc;
 202     struct ata_dma_prdentry *prd = args->dmatab;
 203     int i;
 204
 205     if ((args->error = error))
 206         return;
 207
 208     for (i = 0; i < nsegs; i++) {
 209         prd[i].addr = htole32(segs[i].ds_addr);
 210         prd[i].count = htole32(segs[i].ds_len);
 211     }
 212     prd[i - 1].count |= htole32(ATA_DMA_EOT);
 213     args->nsegs = nsegs;
 214 }
 215
 216 static int
 217 ata_dmaload(device_t dev, caddr_t data, int32_t count, int dir,
 218             void *addr, int *entries)
 219 {
 220     struct ata_channel *ch = device_get_softc(dev);
 221     struct ata_dmasetprd_args cba;
 222     int error;
 223
 224     if (ch->dma->flags & ATA_DMA_LOADED) {
 225         device_printf(dev, "FAILURE - already active DMA on this device\n");
 226         return EIO;
 227     }
 228     if (!count) {
 229         device_printf(dev, "FAILURE - zero length DMA transfer attempted\n");
 230         panic("zero length DMA transfer");
 231         return EIO;
 232     }
 233     if (((uintptr_t)data & (ch->dma->alignment - 1)) ||
 234         (count & (ch->dma->alignment - 1))) {
 235         device_printf(dev, "FAILURE - non aligned DMA transfer attempted\n");
 236         return EIO;
 237     }
 238     if (count > ch->dma->max_iosize) {
 239         device_printf(dev, "FAILURE - oversized DMA transfer attempt %d > %d\n",
 240                       count, ch->dma->max_iosize);
 241         return EIO;
 242     }
 243
 244     cba.dmatab = addr;
 245
 246     if ((error = bus_dmamap_load(ch->dma->data_tag, ch->dma->data_map,
 247                                  data, count, ch->dma->setprd, &cba,
 248                                  BUS_DMA_NOWAIT)) || (error = cba.error))
 249         return error;
 250
 251     *entries = cba.nsegs;
 252
 253     bus_dmamap_sync(ch->dma->sg_tag, ch->dma->sg_map, BUS_DMASYNC_PREWRITE);
 254
 255     bus_dmamap_sync(ch->dma->data_tag, ch->dma->data_map,
 256                     dir ? BUS_DMASYNC_PREREAD : BUS_DMASYNC_PREWRITE);
 257
 258     ch->dma->cur_iosize = count;
 259     ch->dma->flags = dir ? (ATA_DMA_LOADED | ATA_DMA_READ) : ATA_DMA_LOADED;
 260     return 0;
 261 }
 262
 263 int
 264 ata_dmaunload(device_t dev)
 265 {
 266     struct ata_channel *ch = device_get_softc(dev);
 267
 268     if (ch->dma->flags & ATA_DMA_LOADED) {
 269         bus_dmamap_sync(ch->dma->sg_tag, ch->dma->sg_map,
 270                         BUS_DMASYNC_POSTWRITE);
 271
 272         bus_dmamap_sync(ch->dma->data_tag, ch->dma->data_map,
 273                         (ch->dma->flags & ATA_DMA_READ) ?
 274                         BUS_DMASYNC_POSTREAD : BUS_DMASYNC_POSTWRITE);
 275         bus_dmamap_unload(ch->dma->data_tag, ch->dma->data_map);
 276
 277         ch->dma->cur_iosize = 0;
 278         ch->dma->flags &= ~ATA_DMA_LOADED;
 279     }
 280     return 0;
 281 }