2 * Copyright (c) 1996, 1997, 1998 The NetBSD Foundation, Inc.
5 * This code is derived from software contributed to The NetBSD Foundation
6 * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
7 * NASA Ames Research Center.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGE.
31 * Copyright (c) 1992, 1993
32 * The Regents of the University of California. All rights reserved.
34 * This software was developed by the Computer Systems Engineering group
35 * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
36 * contributed to Berkeley.
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions
41 * 1. Redistributions of source code must retain the above copyright
42 * notice, this list of conditions and the following disclaimer.
43 * 2. Redistributions in binary form must reproduce the above copyright
44 * notice, this list of conditions and the following disclaimer in the
45 * documentation and/or other materials provided with the distribution.
46 * 4. Neither the name of the University nor the names of its contributors
47 * may be used to endorse or promote products derived from this software
48 * without specific prior written permission.
50 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
51 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
52 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
53 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
54 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
55 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
56 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
57 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
58 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
59 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
63 * Copyright (c) 1997, 1998 Justin T. Gibbs.
64 * All rights reserved.
65 * Copyright 2001 by Thomas Moestl <tmm@FreeBSD.org>. All rights reserved.
67 * Redistribution and use in source and binary forms, with or without
68 * modification, are permitted provided that the following conditions
70 * 1. Redistributions of source code must retain the above copyright
71 * notice, this list of conditions, and the following disclaimer,
72 * without modification, immediately at the beginning of the file.
73 * 2. The name of the author may not be used to endorse or promote products
74 * derived from this software without specific prior written permission.
76 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
77 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
78 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
79 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
80 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
81 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
82 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
83 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
84 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
85 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
88 * from: @(#)machdep.c 8.6 (Berkeley) 1/14/94
89 * from: NetBSD: machdep.c,v 1.221 2008/04/28 20:23:37 martin Exp
91 * from: FreeBSD: src/sys/i386/i386/busdma_machdep.c,v 1.24 2001/08/15
94 #include <sys/cdefs.h>
95 __FBSDID("$FreeBSD$");
97 #include <sys/param.h>
100 #include <sys/malloc.h>
101 #include <sys/mutex.h>
102 #include <sys/proc.h>
103 #include <sys/rman.h>
105 #include <sys/systm.h>
108 #include <vm/vm_extern.h>
109 #include <vm/vm_kern.h>
110 #include <vm/vm_page.h>
111 #include <vm/vm_param.h>
112 #include <vm/vm_map.h>
114 #include <machine/asi.h>
115 #include <machine/atomic.h>
116 #include <machine/bus.h>
117 #include <machine/bus_private.h>
118 #include <machine/cache.h>
119 #include <machine/smp.h>
120 #include <machine/tlb.h>
122 /* ASIs for bus access */
123 const int bus_type_asi[] = {
124 ASI_PHYS_BYPASS_EC_WITH_EBIT, /* nexus */
125 ASI_PHYS_BYPASS_EC_WITH_EBIT, /* SBus */
126 ASI_PHYS_BYPASS_EC_WITH_EBIT_L, /* PCI configuration space */
127 ASI_PHYS_BYPASS_EC_WITH_EBIT_L, /* PCI memory space */
128 ASI_PHYS_BYPASS_EC_WITH_EBIT_L, /* PCI I/O space */
132 const int bus_stream_asi[] = {
133 ASI_PHYS_BYPASS_EC_WITH_EBIT, /* nexus */
134 ASI_PHYS_BYPASS_EC_WITH_EBIT, /* SBus */
135 ASI_PHYS_BYPASS_EC_WITH_EBIT, /* PCI configuration space */
136 ASI_PHYS_BYPASS_EC_WITH_EBIT, /* PCI memory space */
137 ASI_PHYS_BYPASS_EC_WITH_EBIT, /* PCI I/O space */
142 * Convenience function for manipulating driver locks from busdma (during
143 * busdma_swi, for example). Drivers that don't provide their own locks
144 * should specify &Giant to dmat->lockfuncarg. Drivers that use their own
145 * non-mutex locking scheme don't have to use this at all.
148 busdma_lock_mutex(void *arg, bus_dma_lock_op_t op)
152 dmtx = (struct mtx *)arg;
161 panic("Unknown operation 0x%x for busdma_lock_mutex!", op);
166 * dflt_lock should never get called. It gets put into the dma tag when
167 * lockfunc == NULL, which is only valid if the maps that are associated
168 * with the tag are meant to never be defered.
169 * XXX Should have a way to identify which driver is responsible here.
172 dflt_lock(void *arg, bus_dma_lock_op_t op)
175 panic("driver error: busdma dflt_lock called");
179 * Allocate a device specific dma_tag.
182 bus_dma_tag_create(bus_dma_tag_t parent, bus_size_t alignment,
183 bus_addr_t boundary, bus_addr_t lowaddr, bus_addr_t highaddr,
184 bus_dma_filter_t *filter, void *filterarg, bus_size_t maxsize,
185 int nsegments, bus_size_t maxsegsz, int flags, bus_dma_lock_t *lockfunc,
186 void *lockfuncarg, bus_dma_tag_t *dmat)
188 bus_dma_tag_t newtag;
190 /* Return a NULL tag on failure */
193 /* Enforce the usage of BUS_GET_DMA_TAG(). */
195 panic("%s: parent DMA tag NULL", __func__);
197 newtag = (bus_dma_tag_t)malloc(sizeof(*newtag), M_DEVBUF, M_NOWAIT);
202 * The method table pointer and the cookie need to be taken over from
205 newtag->dt_cookie = parent->dt_cookie;
206 newtag->dt_mt = parent->dt_mt;
208 newtag->dt_parent = parent;
209 newtag->dt_alignment = alignment;
210 newtag->dt_boundary = boundary;
211 newtag->dt_lowaddr = trunc_page((vm_offset_t)lowaddr) + (PAGE_SIZE - 1);
212 newtag->dt_highaddr = trunc_page((vm_offset_t)highaddr) +
214 newtag->dt_filter = filter;
215 newtag->dt_filterarg = filterarg;
216 newtag->dt_maxsize = maxsize;
217 newtag->dt_nsegments = nsegments;
218 newtag->dt_maxsegsz = maxsegsz;
219 newtag->dt_flags = flags;
220 newtag->dt_ref_count = 1; /* Count ourselves */
221 newtag->dt_map_count = 0;
223 if (lockfunc != NULL) {
224 newtag->dt_lockfunc = lockfunc;
225 newtag->dt_lockfuncarg = lockfuncarg;
227 newtag->dt_lockfunc = dflt_lock;
228 newtag->dt_lockfuncarg = NULL;
231 newtag->dt_segments = NULL;
233 /* Take into account any restrictions imposed by our parent tag. */
234 newtag->dt_lowaddr = ulmin(parent->dt_lowaddr, newtag->dt_lowaddr);
235 newtag->dt_highaddr = ulmax(parent->dt_highaddr, newtag->dt_highaddr);
236 if (newtag->dt_boundary == 0)
237 newtag->dt_boundary = parent->dt_boundary;
238 else if (parent->dt_boundary != 0)
239 newtag->dt_boundary = ulmin(parent->dt_boundary,
240 newtag->dt_boundary);
241 atomic_add_int(&parent->dt_ref_count, 1);
243 if (newtag->dt_boundary > 0)
244 newtag->dt_maxsegsz = ulmin(newtag->dt_maxsegsz,
245 newtag->dt_boundary);
252 bus_dma_tag_destroy(bus_dma_tag_t dmat)
254 bus_dma_tag_t parent;
257 if (dmat->dt_map_count != 0)
259 while (dmat != NULL) {
260 parent = dmat->dt_parent;
261 atomic_subtract_int(&dmat->dt_ref_count, 1);
262 if (dmat->dt_ref_count == 0) {
263 if (dmat->dt_segments != NULL)
264 free(dmat->dt_segments, M_DEVBUF);
265 free(dmat, M_DEVBUF);
267 * Last reference count, so
268 * release our reference
269 * count on our parent.
279 /* Allocate/free a tag, and do the necessary management work. */
281 sparc64_dma_alloc_map(bus_dma_tag_t dmat, bus_dmamap_t *mapp)
284 if (dmat->dt_segments == NULL) {
285 dmat->dt_segments = (bus_dma_segment_t *)malloc(
286 sizeof(bus_dma_segment_t) * dmat->dt_nsegments, M_DEVBUF,
288 if (dmat->dt_segments == NULL)
291 *mapp = malloc(sizeof(**mapp), M_DEVBUF, M_NOWAIT | M_ZERO);
295 SLIST_INIT(&(*mapp)->dm_reslist);
296 dmat->dt_map_count++;
301 sparc64_dma_free_map(bus_dma_tag_t dmat, bus_dmamap_t map)
305 dmat->dt_map_count--;
309 nexus_dmamap_create(bus_dma_tag_t dmat, int flags, bus_dmamap_t *mapp)
312 return (sparc64_dma_alloc_map(dmat, mapp));
316 nexus_dmamap_destroy(bus_dma_tag_t dmat, bus_dmamap_t map)
319 sparc64_dma_free_map(dmat, map);
324 * Add a single contiguous physical range to the segment list.
327 nexus_dmamap_addseg(bus_dma_tag_t dmat, bus_dmamap_t map, bus_addr_t curaddr,
328 bus_size_t sgsize, bus_dma_segment_t *segs, int *segp)
330 bus_addr_t baddr, bmask;
334 * Make sure we don't cross any boundaries.
336 bmask = ~(dmat->dt_boundary - 1);
337 if (dmat->dt_boundary > 0) {
338 baddr = (curaddr + dmat->dt_boundary) & bmask;
339 if (sgsize > (baddr - curaddr))
340 sgsize = (baddr - curaddr);
344 * Insert chunk into a segment, coalescing with
345 * previous segment if possible.
350 segs[seg].ds_addr = curaddr;
351 segs[seg].ds_len = sgsize;
353 if (curaddr == segs[seg].ds_addr + segs[seg].ds_len &&
354 (segs[seg].ds_len + sgsize) <= dmat->dt_maxsegsz &&
355 (dmat->dt_boundary == 0 ||
356 (segs[seg].ds_addr & bmask) == (curaddr & bmask)))
357 segs[seg].ds_len += sgsize;
359 if (++seg >= dmat->dt_nsegments)
361 segs[seg].ds_addr = curaddr;
362 segs[seg].ds_len = sgsize;
370 * Utility function to load a physical buffer. segp contains
371 * the starting segment on entrace, and the ending segment on exit.
374 nexus_dmamap_load_phys(bus_dma_tag_t dmat, bus_dmamap_t map, vm_paddr_t buf,
375 bus_size_t buflen, int flags, bus_dma_segment_t *segs, int *segp)
381 segs = dmat->dt_segments;
385 sgsize = MIN(buflen, dmat->dt_maxsegsz);
386 sgsize = nexus_dmamap_addseg(dmat, map, curaddr, sgsize, segs,
397 return (buflen != 0 ? EFBIG : 0); /* XXX better return value here? */
401 * Utility function to load a linear buffer. segp contains
402 * the starting segment on entrace, and the ending segment on exit.
405 nexus_dmamap_load_buffer(bus_dma_tag_t dmat, bus_dmamap_t map, void *buf,
406 bus_size_t buflen, pmap_t pmap, int flags, bus_dma_segment_t *segs,
411 vm_offset_t vaddr = (vm_offset_t)buf;
414 segs = dmat->dt_segments;
418 * Get the physical address for this segment.
420 if (pmap == kernel_pmap)
421 curaddr = pmap_kextract(vaddr);
423 curaddr = pmap_extract(pmap, vaddr);
426 * Compute the segment size, and adjust counts.
428 sgsize = PAGE_SIZE - ((u_long)curaddr & PAGE_MASK);
429 if (sgsize > dmat->dt_maxsegsz)
430 sgsize = dmat->dt_maxsegsz;
434 sgsize = nexus_dmamap_addseg(dmat, map, curaddr, sgsize, segs,
446 return (buflen != 0 ? EFBIG : 0); /* XXX better return value here? */
450 nexus_dmamap_waitok(bus_dma_tag_t dmat, bus_dmamap_t map,
451 struct memdesc *mem, bus_dmamap_callback_t *callback, void *callback_arg)
456 static bus_dma_segment_t *
457 nexus_dmamap_complete(bus_dma_tag_t dmat, bus_dmamap_t map,
458 bus_dma_segment_t *segs, int nsegs, int error)
462 segs = dmat->dt_segments;
467 * Common function for unloading a DMA map. May be called by
468 * bus-specific DMA map unload functions.
471 nexus_dmamap_unload(bus_dma_tag_t dmat, bus_dmamap_t map)
474 map->dm_flags &= ~DMF_LOADED;
478 * Common function for DMA map synchronization. May be called
479 * by bus-specific DMA map synchronization functions.
482 nexus_dmamap_sync(bus_dma_tag_t dmat, bus_dmamap_t map, bus_dmasync_op_t op)
486 * We sync out our caches, but the bus must do the same.
488 * Actually a #Sync is expensive. We should optimize.
490 if ((op & BUS_DMASYNC_PREREAD) || (op & BUS_DMASYNC_PREWRITE)) {
492 * Don't really need to do anything, but flush any pending
497 if (op & BUS_DMASYNC_POSTWRITE) {
498 /* Nothing to do. Handled by the bus controller. */
503 * Common function for DMA-safe memory allocation. May be called
504 * by bus-specific DMA memory allocation functions.
507 nexus_dmamem_alloc(bus_dma_tag_t dmat, void **vaddr, int flags,
512 if (flags & BUS_DMA_NOWAIT)
516 if (flags & BUS_DMA_ZERO)
521 * (dmat->dt_alignment < dmat->dt_maxsize) is just a quick hack; the
522 * exact alignment guarantees of malloc need to be nailed down, and
523 * the code below should be rewritten to take that into account.
525 * In the meantime, we'll warn the user if malloc gets it wrong.
527 if (dmat->dt_maxsize <= PAGE_SIZE &&
528 dmat->dt_alignment < dmat->dt_maxsize)
529 *vaddr = malloc(dmat->dt_maxsize, M_DEVBUF, mflags);
532 * XXX use contigmalloc until it is merged into this
533 * facility and handles multi-seg allocations. Nobody
534 * is doing multi-seg allocations yet though.
536 *vaddr = contigmalloc(dmat->dt_maxsize, M_DEVBUF, mflags,
537 0ul, dmat->dt_lowaddr,
538 dmat->dt_alignment ? dmat->dt_alignment : 1UL,
543 if (vtophys(*vaddr) % dmat->dt_alignment)
544 printf("%s: failed to align memory properly.\n", __func__);
549 * Common function for freeing DMA-safe memory. May be called by
550 * bus-specific DMA memory free functions.
553 nexus_dmamem_free(bus_dma_tag_t dmat, void *vaddr, bus_dmamap_t map)
556 if (dmat->dt_maxsize <= PAGE_SIZE &&
557 dmat->dt_alignment < dmat->dt_maxsize)
558 free(vaddr, M_DEVBUF);
560 contigfree(vaddr, dmat->dt_maxsize, M_DEVBUF);
563 static struct bus_dma_methods nexus_dma_methods = {
565 nexus_dmamap_destroy,
566 nexus_dmamap_load_phys,
567 nexus_dmamap_load_buffer,
569 nexus_dmamap_complete,
576 struct bus_dma_tag nexus_dmatag = {
598 * Helpers to map/unmap bus memory
601 bus_space_map(bus_space_tag_t tag, bus_addr_t address, bus_size_t size,
602 int flags, bus_space_handle_t *handlep)
605 return (sparc64_bus_mem_map(tag, address, size, flags, 0, handlep));
609 sparc64_bus_mem_map(bus_space_tag_t tag, bus_addr_t addr, bus_size_t size,
610 int flags, vm_offset_t vaddr, bus_space_handle_t *hp)
619 * Given that we use physical access for bus_space(9) there's no need
620 * need to map anything in unless BUS_SPACE_MAP_LINEAR is requested.
622 if ((flags & BUS_SPACE_MAP_LINEAR) == 0) {
627 if (tag->bst_cookie == NULL) {
628 printf("%s: resource cookie not set\n", __func__);
632 size = round_page(size);
634 printf("%s: zero size\n", __func__);
638 switch (tag->bst_type) {
639 case PCI_CONFIG_BUS_SPACE:
640 case PCI_IO_BUS_SPACE:
641 case PCI_MEMORY_BUS_SPACE:
649 if ((flags & BUS_SPACE_MAP_CACHEABLE) == 0)
653 sva = trunc_page(vaddr);
655 if ((sva = kva_alloc(size)) == 0)
656 panic("%s: cannot allocate virtual memory", __func__);
659 pa = trunc_page(addr);
660 if ((flags & BUS_SPACE_MAP_READONLY) == 0)
666 pmap_kenter_flags(va, pa, pm_flags);
669 } while ((vsz -= PAGE_SIZE) > 0);
670 tlb_range_demap(kernel_pmap, sva, sva + size - 1);
672 /* Note: we preserve the page offset. */
673 rman_set_virtual(tag->bst_cookie, (void *)(sva | (addr & PAGE_MASK)));
678 bus_space_unmap(bus_space_tag_t tag, bus_space_handle_t handle,
682 sparc64_bus_mem_unmap(tag, handle, size);
686 sparc64_bus_mem_unmap(bus_space_tag_t tag, bus_space_handle_t handle,
693 if (tag->bst_cookie == NULL ||
694 (sva = (vm_offset_t)rman_get_virtual(tag->bst_cookie)) == 0)
696 sva = trunc_page(sva);
697 endva = sva + round_page(size);
698 for (va = sva; va < endva; va += PAGE_SIZE)
699 pmap_kremove_flags(va);
700 tlb_range_demap(kernel_pmap, sva, sva + size - 1);
706 * Fake up a bus tag, for use by console drivers in early boot when the
707 * regular means to allocate resources are not yet available.
708 * Addr is the physical address of the desired start of the handle.
711 sparc64_fake_bustag(int space, bus_addr_t addr, struct bus_space_tag *ptag)
714 ptag->bst_cookie = NULL;
715 ptag->bst_type = space;
723 sparc64_alloc_bus_tag(void *cookie, int type)
727 bt = malloc(sizeof(struct bus_space_tag), M_DEVBUF, M_NOWAIT);
730 bt->bst_cookie = cookie;
735 struct bus_space_tag nexus_bustag = {
737 NEXUS_BUS_SPACE /* type */