xref: /freebsd/sys/dev/ata/ata-dma.c (revision 0fa02ea5f786ef02befd46f8f083f48c8cd9630b)
1 /*-
2  * Copyright (c) 1998 - 2003 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/mutex.h>
40 #include <sys/taskqueue.h>
41 #include <sys/bus.h>
42 #include <machine/bus.h>
43 #include <sys/rman.h>
44 #include <dev/pci/pcivar.h>
45 #include <dev/ata/ata-all.h>
46 #include <dev/ata/ata-pci.h>
47 
48 /* prototypes */
49 static void ata_dmaalloc(struct ata_channel *);
50 static void ata_dmafree(struct ata_channel *);
51 static void ata_dmasetupd_cb(void *, bus_dma_segment_t *, int, int);
52 static int ata_dmaload(struct ata_device *, caddr_t, int32_t, int);
53 static int ata_dmaunload(struct ata_channel *);
54 
55 /* local vars */
56 static MALLOC_DEFINE(M_ATADMA, "ATA DMA", "ATA driver DMA");
57 
58 /* misc defines */
59 #define MAXSEGSZ	PAGE_SIZE
60 #define MAXTABSZ	PAGE_SIZE
61 #define MAXCTLDMASZ	(2 * (MAXTABSZ + MAXPHYS))
62 
63 struct ata_dc_cb_args {
64     bus_addr_t maddr;
65     int error;
66 };
67 
68 void
69 ata_dmainit(struct ata_channel *ch)
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->load = ata_dmaload;
75 	ch->dma->unload = ata_dmaunload;
76 	ch->dma->alignment = 2;
77 	ch->dma->max_iosize = 64 * 1024;
78 	ch->dma->boundary = 64 * 1024;
79     }
80 }
81 
82 
83 static void
84 ata_dmasetupc_cb(void *xsc, bus_dma_segment_t *segs, int nsegs, int error)
85 {
86     struct ata_dc_cb_args *cba = (struct ata_dc_cb_args *)xsc;
87 
88     if (!(cba->error = error))
89 	cba->maddr = segs[0].ds_addr;
90 }
91 
92 static void
93 ata_dmaalloc(struct ata_channel *ch)
94 {
95     struct ata_dc_cb_args ccba;
96 
97     if (bus_dma_tag_create(NULL, 1, 0,
98 			   BUS_SPACE_MAXADDR_32BIT, BUS_SPACE_MAXADDR,
99 			   NULL, NULL, MAXCTLDMASZ,
100 			   ATA_DMA_ENTRIES, BUS_SPACE_MAXSIZE_32BIT,
101 			   BUS_DMA_ALLOCNOW, NULL, NULL, &ch->dma->dmatag))
102 	goto error;
103 
104     if (bus_dma_tag_create(ch->dma->dmatag, PAGE_SIZE, PAGE_SIZE,
105 			   BUS_SPACE_MAXADDR_32BIT, BUS_SPACE_MAXADDR,
106 			   NULL, NULL, MAXTABSZ, 1, MAXTABSZ,
107 			   BUS_DMA_ALLOCNOW, NULL, NULL, &ch->dma->cdmatag))
108 	goto error;
109 
110     if (bus_dma_tag_create(ch->dma->dmatag,ch->dma->alignment,ch->dma->boundary,
111 			   BUS_SPACE_MAXADDR_32BIT, BUS_SPACE_MAXADDR,
112 			   NULL, NULL, ch->dma->max_iosize,
113 			   ATA_DMA_ENTRIES, ch->dma->boundary,
114 			   BUS_DMA_ALLOCNOW, NULL, NULL, &ch->dma->ddmatag))
115 	goto error;
116 
117     if (bus_dmamem_alloc(ch->dma->cdmatag, (void **)&ch->dma->dmatab, 0,
118 			 &ch->dma->cdmamap))
119 	goto error;
120 
121     if (bus_dmamap_load(ch->dma->cdmatag, ch->dma->cdmamap, ch->dma->dmatab,
122 			MAXTABSZ, ata_dmasetupc_cb, &ccba, 0) || ccba.error) {
123 	bus_dmamem_free(ch->dma->cdmatag, ch->dma->dmatab,ch->dma->cdmamap);
124 	goto error;
125     }
126     ch->dma->mdmatab = ccba.maddr;
127     if (bus_dmamap_create(ch->dma->ddmatag, 0, &ch->dma->ddmamap))
128 	goto error;
129     return;
130 
131 error:
132     ata_printf(ch, -1, "WARNING - DMA tag allocation failed, disabling DMA\n");
133     ata_dmafree(ch);
134     free(ch->dma, M_ATADMA);
135     ch->dma = NULL;
136 }
137 
138 static void
139 ata_dmafree(struct ata_channel *ch)
140 {
141     if (ch->dma->mdmatab) {
142 	bus_dmamap_unload(ch->dma->cdmatag, ch->dma->cdmamap);
143 	bus_dmamem_free(ch->dma->cdmatag, ch->dma->dmatab, ch->dma->cdmamap);
144 	ch->dma->mdmatab = 0;
145 	ch->dma->cdmamap = NULL;
146 	ch->dma->dmatab = NULL;
147     }
148     if (ch->dma->ddmamap) {
149 	bus_dmamap_destroy(ch->dma->ddmatag, ch->dma->ddmamap);
150 	ch->dma->ddmamap = NULL;
151     }
152     if (ch->dma->cdmatag) {
153 	bus_dma_tag_destroy(ch->dma->cdmatag);
154 	ch->dma->cdmatag = NULL;
155     }
156     if (ch->dma->ddmatag) {
157 	bus_dma_tag_destroy(ch->dma->ddmatag);
158 	ch->dma->ddmatag = NULL;
159     }
160     if (ch->dma->dmatag) {
161 	bus_dma_tag_destroy(ch->dma->dmatag);
162 	ch->dma->dmatag = NULL;
163     }
164 }
165 
166 struct ata_dmasetup_data_cb_args {
167     struct ata_dmaentry *dmatab;
168     int error;
169 };
170 
171 static void
172 ata_dmasetupd_cb(void *xsc, bus_dma_segment_t *segs, int nsegs, int error)
173 {
174     struct ata_dmasetup_data_cb_args *cba =
175 	(struct ata_dmasetup_data_cb_args *)xsc;
176     bus_size_t cnt;
177     u_int32_t lastcount;
178     int i, j;
179 
180     cba->error = error;
181     if (error != 0)
182 	return;
183     lastcount = j = 0;
184     for (i = 0; i < nsegs; i++) {
185 	/*
186 	 * A maximum segment size was specified for bus_dma_tag_create, but
187 	 * some busdma code does not seem to honor this, so fix up if needed.
188 	 */
189 	for (cnt = 0; cnt < segs[i].ds_len; cnt += MAXSEGSZ, j++) {
190 	    cba->dmatab[j].base = htole32(segs[i].ds_addr + cnt);
191 	    lastcount = ulmin(segs[i].ds_len - cnt, MAXSEGSZ) & 0xffff;
192 	    cba->dmatab[j].count = htole32(lastcount);
193 	}
194     }
195     cba->dmatab[j - 1].count = htole32(lastcount | ATA_DMA_EOT);
196 }
197 
198 static int
199 ata_dmaload(struct ata_device *atadev, caddr_t data, int32_t count, int dir)
200 {
201     struct ata_channel *ch = atadev->channel;
202     struct ata_dmasetup_data_cb_args cba;
203 
204     if (ch->dma->flags & ATA_DMA_ACTIVE) {
205 	ata_prtdev(atadev, "FAILURE - already active DMA on this device\n");
206 	return -1;
207     }
208     if (!count) {
209 	ata_prtdev(atadev, "FAILURE - zero length DMA transfer attempted\n");
210 	return -1;
211     }
212     if (((uintptr_t)data & (ch->dma->alignment - 1)) ||
213 	(count & (ch->dma->alignment - 1))) {
214 	ata_prtdev(atadev, "FAILURE - non aligned DMA transfer attempted\n");
215 	return -1;
216     }
217     if (count > ch->dma->max_iosize) {
218 	ata_prtdev(atadev,
219 		   "FAILURE - oversized DMA transfer attempted %d > %d\n",
220 		   count, ch->dma->max_iosize);
221 	return -1;
222     }
223 
224     cba.dmatab = ch->dma->dmatab;
225 
226     bus_dmamap_sync(ch->dma->cdmatag, ch->dma->cdmamap, BUS_DMASYNC_PREWRITE);
227 
228     if (bus_dmamap_load(ch->dma->ddmatag, ch->dma->ddmamap, data, count,
229 			ata_dmasetupd_cb, &cba, 0) || cba.error)
230 	return -1;
231 
232     bus_dmamap_sync(ch->dma->ddmatag, ch->dma->ddmamap,
233 		    dir ? BUS_DMASYNC_PREREAD : BUS_DMASYNC_PREWRITE);
234 
235     ch->dma->cur_iosize = count;
236     ch->dma->flags = dir ? (ATA_DMA_ACTIVE | ATA_DMA_READ) : ATA_DMA_ACTIVE;
237 
238     return 0;
239 }
240 
241 int
242 ata_dmaunload(struct ata_channel *ch)
243 {
244     bus_dmamap_sync(ch->dma->cdmatag, ch->dma->cdmamap, BUS_DMASYNC_POSTWRITE);
245 
246     bus_dmamap_sync(ch->dma->ddmatag, ch->dma->ddmamap,
247 		    (ch->dma->flags & ATA_DMA_READ) != 0 ?
248 		    BUS_DMASYNC_POSTREAD : BUS_DMASYNC_POSTWRITE);
249     bus_dmamap_unload(ch->dma->ddmatag, ch->dma->ddmamap);
250 
251     ch->dma->cur_iosize = 0;
252     ch->dma->flags = 0;
253 
254     return 0;
255 }
256