Sync usage with man page.
[netbsd-mini2440.git] / sys / arch / alpha / pci / tsp_dma.c
blobaa3455b8c2c6b3563e54e243fd5f468a22e59e47
1 /* $NetBSD: tsp_dma.c,v 1.8 2009/03/14 14:45:53 dsl Exp $ */
3 /*-
4 * Copyright (c) 1999 by Ross Harvey. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
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. All advertising materials mentioning features or use of this software
15 * must display the following acknowledgement:
16 * This product includes software developed by Ross Harvey.
17 * 4. The name of Ross Harvey may not be used to endorse or promote products
18 * derived from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY ROSS HARVEY ``AS IS'' AND ANY EXPRESS
21 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
22 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURP0SE
23 * ARE DISCLAIMED. IN NO EVENT SHALL ROSS HARVEY BE LIABLE FOR ANY
24 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * SUCH DAMAGE.
34 /*-
35 * Copyright (c) 1997, 1998 The NetBSD Foundation, Inc.
36 * All rights reserved.
38 * This code is derived from software contributed to The NetBSD Foundation
39 * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
40 * NASA Ames Research Center.
42 * Redistribution and use in source and binary forms, with or without
43 * modification, are permitted provided that the following conditions
44 * are met:
45 * 1. Redistributions of source code must retain the above copyright
46 * notice, this list of conditions and the following disclaimer.
47 * 2. Redistributions in binary form must reproduce the above copyright
48 * notice, this list of conditions and the following disclaimer in the
49 * documentation and/or other materials provided with the distribution.
51 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
52 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
53 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
54 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
55 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
56 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
57 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
58 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
59 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
60 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
61 * POSSIBILITY OF SUCH DAMAGE.
64 #include <sys/cdefs.h>
65 __KERNEL_RCSID(0, "$NetBSD: tsp_dma.c,v 1.8 2009/03/14 14:45:53 dsl Exp $");
67 #include <sys/param.h>
68 #include <sys/systm.h>
69 #include <sys/kernel.h>
70 #include <sys/device.h>
71 #include <sys/malloc.h>
73 #include <uvm/uvm_extern.h>
75 #include <machine/autoconf.h>
76 #define _ALPHA_BUS_DMA_PRIVATE
77 #include <machine/bus.h>
78 #include <machine/rpb.h>
80 #include <dev/pci/pcireg.h>
81 #include <dev/pci/pcivar.h>
82 #include <alpha/pci/tsreg.h>
83 #include <alpha/pci/tsvar.h>
85 #define tsp_dma() { Generate ctags(1) key. }
87 #define EDIFF(a, b) (((a) | WSBA_ENA | WSBA_SG) != ((b) | WSBA_ENA | WSBA_SG))
89 bus_dma_tag_t tsp_dma_get_tag(bus_dma_tag_t, alpha_bus_t);
91 int tsp_bus_dmamap_load_sgmap(bus_dma_tag_t, bus_dmamap_t, void *,
92 bus_size_t, struct proc *, int);
94 int tsp_bus_dmamap_load_mbuf_sgmap(bus_dma_tag_t, bus_dmamap_t,
95 struct mbuf *, int);
97 int tsp_bus_dmamap_load_uio_sgmap(bus_dma_tag_t, bus_dmamap_t,
98 struct uio *, int);
100 int tsp_bus_dmamap_load_raw_sgmap(bus_dma_tag_t, bus_dmamap_t,
101 bus_dma_segment_t *, int, bus_size_t, int);
103 void tsp_bus_dmamap_unload_sgmap(bus_dma_tag_t, bus_dmamap_t);
105 void tsp_tlb_invalidate(struct tsp_config *);
108 * XXX Need to figure out what this is, if any. Initialize it to
109 * XXX something that should be safe.
111 #define TSP_SGMAP_PFTHRESH 256
113 void
114 tsp_dma_init(struct tsp_config *pcp)
116 int i;
117 bus_dma_tag_t t;
118 struct ts_pchip *pccsr = pcp->pc_csr;
119 bus_addr_t dwbase, dwlen, sgwbase, sgwlen, tbase;
120 static struct map_expected {
121 u_int32_t base, mask, enables;
122 } premap[4] = {
123 { 0x800000, 0x700000, WSBA_ENA | WSBA_SG },
124 { 0x80000000 | WSBA_ENA, 0x3ff00000, WSBA_ENA },
125 { 0, 0 },
126 { 0, 0 }
129 alpha_mb();
130 for(i = 0; i < 4; ++i) {
131 if (EDIFF(pccsr->tsp_wsba[i].tsg_r, premap[i].base) ||
132 EDIFF(pccsr->tsp_wsm[i].tsg_r, premap[i].mask))
133 printf("tsp%d: window %d: %lx/base %lx/mask %lx"
134 " reinitialized\n",
135 pcp->pc_pslot, i,
136 pccsr->tsp_wsba[i].tsg_r,
137 pccsr->tsp_wsm[i].tsg_r,
138 pccsr->tsp_tba[i].tsg_r);
139 pccsr->tsp_wsba[i].tsg_r = premap[i].base | premap[i].enables;
140 pccsr->tsp_wsm[i].tsg_r = premap[i].mask;
142 alpha_mb();
145 * Initialize the DMA tag used for direct-mapped DMA.
147 t = &pcp->pc_dmat_direct;
148 t->_cookie = pcp;
149 t->_wbase = dwbase = WSBA_ADDR(pccsr->tsp_wsba[1].tsg_r);
150 t->_wsize = dwlen = WSM_LEN(pccsr->tsp_wsm[1].tsg_r);
151 t->_next_window = &pcp->pc_dmat_sgmap;
152 t->_boundary = 0;
153 t->_sgmap = NULL;
154 t->_get_tag = tsp_dma_get_tag;
155 t->_dmamap_create = _bus_dmamap_create;
156 t->_dmamap_destroy = _bus_dmamap_destroy;
157 t->_dmamap_load = _bus_dmamap_load_direct;
158 t->_dmamap_load_mbuf = _bus_dmamap_load_mbuf_direct;
159 t->_dmamap_load_uio = _bus_dmamap_load_uio_direct;
160 t->_dmamap_load_raw = _bus_dmamap_load_raw_direct;
161 t->_dmamap_unload = _bus_dmamap_unload;
162 t->_dmamap_sync = _bus_dmamap_sync;
164 t->_dmamem_alloc = _bus_dmamem_alloc;
165 t->_dmamem_free = _bus_dmamem_free;
166 t->_dmamem_map = _bus_dmamem_map;
167 t->_dmamem_unmap = _bus_dmamem_unmap;
168 t->_dmamem_mmap = _bus_dmamem_mmap;
171 * Initialize the DMA tag used for sgmap-mapped DMA.
173 t = &pcp->pc_dmat_sgmap;
174 t->_cookie = pcp;
175 t->_wbase = sgwbase = WSBA_ADDR(pccsr->tsp_wsba[0].tsg_r);
176 t->_wsize = sgwlen = WSM_LEN(pccsr->tsp_wsm[0].tsg_r);
177 t->_next_window = NULL;
178 t->_boundary = 0;
179 t->_sgmap = &pcp->pc_sgmap;
180 t->_pfthresh = TSP_SGMAP_PFTHRESH;
181 t->_get_tag = tsp_dma_get_tag;
182 t->_dmamap_create = alpha_sgmap_dmamap_create;
183 t->_dmamap_destroy = alpha_sgmap_dmamap_destroy;
184 t->_dmamap_load = tsp_bus_dmamap_load_sgmap;
185 t->_dmamap_load_mbuf = tsp_bus_dmamap_load_mbuf_sgmap;
186 t->_dmamap_load_uio = tsp_bus_dmamap_load_uio_sgmap;
187 t->_dmamap_load_raw = tsp_bus_dmamap_load_raw_sgmap;
188 t->_dmamap_unload = tsp_bus_dmamap_unload_sgmap;
189 t->_dmamap_sync = _bus_dmamap_sync;
191 t->_dmamem_alloc = _bus_dmamem_alloc;
192 t->_dmamem_free = _bus_dmamem_free;
193 t->_dmamem_map = _bus_dmamem_map;
194 t->_dmamem_unmap = _bus_dmamem_unmap;
195 t->_dmamem_mmap = _bus_dmamem_mmap;
198 * Initialize the SGMAP. Align page table to 32k in case
199 * window is somewhat larger than expected.
201 alpha_sgmap_init(t, &pcp->pc_sgmap, "tsp_sgmap",
202 sgwbase, 0, sgwlen, sizeof(u_int64_t), NULL, (32*1024));
205 * Enable window 0 and enable SG PTE mapping.
207 alpha_mb();
208 pccsr->tsp_wsba[0].tsg_r |= WSBA_SG | WSBA_ENA;
209 alpha_mb();
212 * Check windows for sanity, especially if we later decide to
213 * use the firmware's initialization in some cases.
215 if ((sgwbase <= dwbase && dwbase < sgwbase + sgwlen) ||
216 (dwbase <= sgwbase && sgwbase < dwbase + dwlen))
217 panic("tsp_dma_init: overlap");
219 tbase = pcp->pc_sgmap.aps_ptpa;
220 if (tbase & ~0x7fffffc00UL)
221 panic("tsp_dma_init: bad page table address");
222 alpha_mb();
223 pccsr->tsp_tba[0].tsg_r = tbase;
224 alpha_mb();
226 tsp_tlb_invalidate(pcp);
227 alpha_mb();
229 /* XXX XXX BEGIN XXX XXX */
230 { /* XXX */
231 extern paddr_t alpha_XXX_dmamap_or; /* XXX */
232 alpha_XXX_dmamap_or = dwbase; /* XXX */
233 } /* XXX */
234 /* XXX XXX END XXX XXX */
238 * Return the bus dma tag to be used for the specified bus type.
239 * INTERNAL USE ONLY!
241 bus_dma_tag_t
242 tsp_dma_get_tag(bus_dma_tag_t t, alpha_bus_t bustype)
244 struct tsp_config *pcp = t->_cookie;
246 switch (bustype) {
247 case ALPHA_BUS_PCI:
248 case ALPHA_BUS_EISA:
250 * The direct mapped window will work for most systems,
251 * most of the time. When it doesn't, we chain to the sgmap
252 * window automatically.
254 return (&pcp->pc_dmat_direct);
256 case ALPHA_BUS_ISA:
258 * ISA doesn't have enough address bits to use
259 * the direct-mapped DMA window, so we must use
260 * SGMAPs.
262 return (&pcp->pc_dmat_sgmap);
264 default:
265 panic("tsp_dma_get_tag: shouldn't be here, really...");
270 * Load a TSP SGMAP-mapped DMA map with a linear buffer.
273 tsp_bus_dmamap_load_sgmap(bus_dma_tag_t t, bus_dmamap_t map, void *buf, bus_size_t buflen, struct proc *p, int flags)
275 int error;
277 error = pci_sgmap_pte64_load(t, map, buf, buflen, p, flags,
278 t->_sgmap);
279 if (error == 0)
280 tsp_tlb_invalidate(t->_cookie);
282 return (error);
286 * Load a TSP SGMAP-mapped DMA map with an mbuf chain.
289 tsp_bus_dmamap_load_mbuf_sgmap(bus_dma_tag_t t, bus_dmamap_t map, struct mbuf *m, int flags)
291 int error;
293 error = pci_sgmap_pte64_load_mbuf(t, map, m, flags, t->_sgmap);
294 if (error == 0)
295 tsp_tlb_invalidate(t->_cookie);
297 return (error);
301 * Load a TSP SGMAP-mapped DMA map with a uio.
304 tsp_bus_dmamap_load_uio_sgmap(bus_dma_tag_t t, bus_dmamap_t map, struct uio *uio, int flags)
306 int error;
308 error = pci_sgmap_pte64_load_uio(t, map, uio, flags, t->_sgmap);
309 if (error == 0)
310 tsp_tlb_invalidate(t->_cookie);
312 return (error);
316 * Load a TSP SGMAP-mapped DMA map with raw memory.
319 tsp_bus_dmamap_load_raw_sgmap(bus_dma_tag_t t, bus_dmamap_t map, bus_dma_segment_t *segs, int nsegs, bus_size_t size, int flags)
321 int error;
323 error = pci_sgmap_pte64_load_raw(t, map, segs, nsegs, size, flags,
324 t->_sgmap);
325 if (error == 0)
326 tsp_tlb_invalidate(t->_cookie);
328 return (error);
332 * Unload a TSP DMA map.
334 void
335 tsp_bus_dmamap_unload_sgmap(bus_dma_tag_t t, bus_dmamap_t map)
339 * Invalidate any SGMAP page table entries used by this
340 * mapping.
342 pci_sgmap_pte64_unload(t, map, t->_sgmap);
343 tsp_tlb_invalidate(t->_cookie);
346 * Do the generic bits of the unload.
348 _bus_dmamap_unload(t, map);
352 * Flush the TSP scatter/gather TLB.
354 void
355 tsp_tlb_invalidate(struct tsp_config *pcp)
358 alpha_mb();
359 pcp->pc_csr->tsp_tlbia.tsg_r = 0;
360 alpha_mb();