xref: /freebsd/sys/dev/ata/ata-dma.c (revision 52ec752989b2e6d4e9a59a8ff25d8ff596d85e62)
1 /*-
2  * Copyright (c) 1998 - 2004 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  * 3. The name of the author may not be used to endorse or promote products
15  *    derived from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
31 
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/ata.h>
35 #include <sys/kernel.h>
36 #include <sys/endian.h>
37 #include <sys/malloc.h>
38 #include <sys/lock.h>
39 #include <sys/sema.h>
40 #include <sys/taskqueue.h>
41 #include <vm/uma.h>
42 #include <sys/bus.h>
43 #include <machine/bus.h>
44 #include <sys/rman.h>
45 #include <dev/pci/pcivar.h>
46 #include <dev/ata/ata-all.h>
47 #include <dev/ata/ata-pci.h>
48 
49 /* prototypes */
50 static void ata_dmaalloc(struct ata_channel *);
51 static void ata_dmafree(struct ata_channel *);
52 static void ata_dmasetupd_cb(void *, bus_dma_segment_t *, int, int);
53 static int ata_dmaload(struct ata_device *, caddr_t, int32_t, int);
54 static int ata_dmaunload(struct ata_channel *);
55 
56 /* local vars */
57 static MALLOC_DEFINE(M_ATADMA, "ATA DMA", "ATA driver DMA");
58 
59 /* misc defines */
60 #define MAXSEGSZ	PAGE_SIZE
61 #define MAXTABSZ	PAGE_SIZE
62 #define MAXCTLDMASZ	(2 * (MAXTABSZ + MAXPHYS))
63 
64 struct ata_dc_cb_args {
65     bus_addr_t maddr;
66     int error;
67 };
68 
69 void
70 ata_dmainit(struct ata_channel *ch)
71 {
72     if ((ch->dma = malloc(sizeof(struct ata_dma), M_ATADMA, M_NOWAIT|M_ZERO))) {
73 	ch->dma->alloc = ata_dmaalloc;
74 	ch->dma->free = ata_dmafree;
75 	ch->dma->load = ata_dmaload;
76 	ch->dma->unload = ata_dmaunload;
77 	ch->dma->alignment = 2;
78 	ch->dma->max_iosize = 64 * 1024;
79 	ch->dma->boundary = 64 * 1024;
80     }
81 }
82 
83 
84 static void
85 ata_dmasetupc_cb(void *xsc, bus_dma_segment_t *segs, int nsegs, int error)
86 {
87     struct ata_dc_cb_args *cba = (struct ata_dc_cb_args *)xsc;
88 
89     if (!(cba->error = error))
90 	cba->maddr = segs[0].ds_addr;
91 }
92 
93 static void
94 ata_dmaalloc(struct ata_channel *ch)
95 {
96     struct ata_dc_cb_args ccba;
97 
98     if (bus_dma_tag_create(NULL, 1, 0,
99 			   BUS_SPACE_MAXADDR_32BIT, BUS_SPACE_MAXADDR,
100 			   NULL, NULL, MAXCTLDMASZ,
101 			   ATA_DMA_ENTRIES, BUS_SPACE_MAXSIZE_32BIT,
102 			   BUS_DMA_ALLOCNOW, NULL, NULL, &ch->dma->dmatag))
103 	goto error;
104 
105     if (bus_dma_tag_create(ch->dma->dmatag, PAGE_SIZE, PAGE_SIZE,
106 			   BUS_SPACE_MAXADDR_32BIT, BUS_SPACE_MAXADDR,
107 			   NULL, NULL, MAXTABSZ, 1, MAXTABSZ,
108 			   BUS_DMA_ALLOCNOW, NULL, NULL, &ch->dma->cdmatag))
109 	goto error;
110 
111     if (bus_dma_tag_create(ch->dma->dmatag,ch->dma->alignment,ch->dma->boundary,
112 			   BUS_SPACE_MAXADDR_32BIT, BUS_SPACE_MAXADDR,
113 			   NULL, NULL, ch->dma->max_iosize,
114 			   ATA_DMA_ENTRIES, ch->dma->boundary,
115 			   BUS_DMA_ALLOCNOW, NULL, NULL, &ch->dma->ddmatag))
116 	goto error;
117 
118     if (bus_dmamem_alloc(ch->dma->cdmatag, (void **)&ch->dma->dmatab, 0,
119 			 &ch->dma->cdmamap))
120 	goto error;
121 
122     if (bus_dmamap_load(ch->dma->cdmatag, ch->dma->cdmamap, ch->dma->dmatab,
123 			MAXTABSZ, ata_dmasetupc_cb, &ccba, 0) || ccba.error) {
124 	bus_dmamem_free(ch->dma->cdmatag, ch->dma->dmatab,ch->dma->cdmamap);
125 	goto error;
126     }
127     ch->dma->mdmatab = ccba.maddr;
128     if (bus_dmamap_create(ch->dma->ddmatag, 0, &ch->dma->ddmamap))
129 	goto error;
130     return;
131 
132 error:
133     ata_printf(ch, -1, "WARNING - DMA tag allocation failed, disabling DMA\n");
134     ata_dmafree(ch);
135     free(ch->dma, M_ATADMA);
136     ch->dma = NULL;
137 }
138 
139 static void
140 ata_dmafree(struct ata_channel *ch)
141 {
142     if (ch->dma->mdmatab) {
143 	bus_dmamap_unload(ch->dma->cdmatag, ch->dma->cdmamap);
144 	bus_dmamem_free(ch->dma->cdmatag, ch->dma->dmatab, ch->dma->cdmamap);
145 	ch->dma->mdmatab = 0;
146 	ch->dma->cdmamap = NULL;
147 	ch->dma->dmatab = NULL;
148     }
149     if (ch->dma->ddmamap) {
150 	bus_dmamap_destroy(ch->dma->ddmatag, ch->dma->ddmamap);
151 	ch->dma->ddmamap = NULL;
152     }
153     if (ch->dma->cdmatag) {
154 	bus_dma_tag_destroy(ch->dma->cdmatag);
155 	ch->dma->cdmatag = NULL;
156     }
157     if (ch->dma->ddmatag) {
158 	bus_dma_tag_destroy(ch->dma->ddmatag);
159 	ch->dma->ddmatag = NULL;
160     }
161     if (ch->dma->dmatag) {
162 	bus_dma_tag_destroy(ch->dma->dmatag);
163 	ch->dma->dmatag = NULL;
164     }
165 }
166 
167 struct ata_dmasetup_data_cb_args {
168     struct ata_dmaentry *dmatab;
169     int error;
170 };
171 
172 static void
173 ata_dmasetupd_cb(void *xsc, bus_dma_segment_t *segs, int nsegs, int error)
174 {
175     struct ata_dmasetup_data_cb_args *cba =
176 	(struct ata_dmasetup_data_cb_args *)xsc;
177     bus_size_t cnt;
178     u_int32_t lastcount;
179     int i, j;
180 
181     cba->error = error;
182     if (error != 0)
183 	return;
184     lastcount = j = 0;
185     for (i = 0; i < nsegs; i++) {
186 	/*
187 	 * A maximum segment size was specified for bus_dma_tag_create, but
188 	 * some busdma code does not seem to honor this, so fix up if needed.
189 	 */
190 	for (cnt = 0; cnt < segs[i].ds_len; cnt += MAXSEGSZ, j++) {
191 	    cba->dmatab[j].base = htole32(segs[i].ds_addr + cnt);
192 	    lastcount = ulmin(segs[i].ds_len - cnt, MAXSEGSZ) & 0xffff;
193 	    cba->dmatab[j].count = htole32(lastcount);
194 	}
195     }
196     cba->dmatab[j - 1].count = htole32(lastcount | ATA_DMA_EOT);
197 }
198 
199 static int
200 ata_dmaload(struct ata_device *atadev, caddr_t data, int32_t count, int dir)
201 {
202     struct ata_channel *ch = atadev->channel;
203     struct ata_dmasetup_data_cb_args cba;
204 
205     if (ch->dma->flags & ATA_DMA_ACTIVE) {
206 	ata_prtdev(atadev, "FAILURE - already active DMA on this device\n");
207 	return -1;
208     }
209     if (!count) {
210 	ata_prtdev(atadev, "FAILURE - zero length DMA transfer attempted\n");
211 	return -1;
212     }
213     if (((uintptr_t)data & (ch->dma->alignment - 1)) ||
214 	(count & (ch->dma->alignment - 1))) {
215 	ata_prtdev(atadev, "FAILURE - non aligned DMA transfer attempted\n");
216 	return -1;
217     }
218     if (count > ch->dma->max_iosize) {
219 	ata_prtdev(atadev,
220 		   "FAILURE - oversized DMA transfer attempted %d > %d\n",
221 		   count, ch->dma->max_iosize);
222 	return -1;
223     }
224 
225     cba.dmatab = ch->dma->dmatab;
226 
227     bus_dmamap_sync(ch->dma->cdmatag, ch->dma->cdmamap, BUS_DMASYNC_PREWRITE);
228 
229     if (bus_dmamap_load(ch->dma->ddmatag, ch->dma->ddmamap, data, count,
230 			ata_dmasetupd_cb, &cba, 0) || cba.error)
231 	return -1;
232 
233     bus_dmamap_sync(ch->dma->ddmatag, ch->dma->ddmamap,
234 		    dir ? BUS_DMASYNC_PREREAD : BUS_DMASYNC_PREWRITE);
235 
236     ch->dma->cur_iosize = count;
237     ch->dma->flags = dir ? (ATA_DMA_ACTIVE | ATA_DMA_READ) : ATA_DMA_ACTIVE;
238 
239     return 0;
240 }
241 
242 int
243 ata_dmaunload(struct ata_channel *ch)
244 {
245     bus_dmamap_sync(ch->dma->cdmatag, ch->dma->cdmamap, BUS_DMASYNC_POSTWRITE);
246 
247     bus_dmamap_sync(ch->dma->ddmatag, ch->dma->ddmamap,
248 		    (ch->dma->flags & ATA_DMA_READ) != 0 ?
249 		    BUS_DMASYNC_POSTREAD : BUS_DMASYNC_POSTWRITE);
250     bus_dmamap_unload(ch->dma->ddmatag, ch->dma->ddmamap);
251 
252     ch->dma->cur_iosize = 0;
253     ch->dma->flags = 0;
254 
255     return 0;
256 }
257