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 static void nexus_bus_barrier(bus_space_tag_t, bus_space_handle_t,
123 bus_size_t, bus_size_t, int);
125 /* ASIs for bus access */
126 const int bus_type_asi[] = {
127 ASI_PHYS_BYPASS_EC_WITH_EBIT, /* nexus */
128 ASI_PHYS_BYPASS_EC_WITH_EBIT, /* SBus */
129 ASI_PHYS_BYPASS_EC_WITH_EBIT_L, /* PCI configuration space */
130 ASI_PHYS_BYPASS_EC_WITH_EBIT_L, /* PCI memory space */
131 ASI_PHYS_BYPASS_EC_WITH_EBIT_L, /* PCI I/O space */
135 const int bus_stream_asi[] = {
136 ASI_PHYS_BYPASS_EC_WITH_EBIT, /* nexus */
137 ASI_PHYS_BYPASS_EC_WITH_EBIT, /* SBus */
138 ASI_PHYS_BYPASS_EC_WITH_EBIT, /* PCI configuration space */
139 ASI_PHYS_BYPASS_EC_WITH_EBIT, /* PCI memory space */
140 ASI_PHYS_BYPASS_EC_WITH_EBIT, /* PCI I/O space */
145 * Convenience function for manipulating driver locks from busdma (during
146 * busdma_swi, for example). Drivers that don't provide their own locks
147 * should specify &Giant to dmat->lockfuncarg. Drivers that use their own
148 * non-mutex locking scheme don't have to use this at all.
151 busdma_lock_mutex(void *arg, bus_dma_lock_op_t op)
155 dmtx = (struct mtx *)arg;
164 panic("Unknown operation 0x%x for busdma_lock_mutex!", op);
169 * dflt_lock should never get called. It gets put into the dma tag when
170 * lockfunc == NULL, which is only valid if the maps that are associated
171 * with the tag are meant to never be defered.
172 * XXX Should have a way to identify which driver is responsible here.
175 dflt_lock(void *arg, bus_dma_lock_op_t op)
178 panic("driver error: busdma dflt_lock called");
182 * Allocate a device specific dma_tag.
185 bus_dma_tag_create(bus_dma_tag_t parent, bus_size_t alignment,
186 bus_addr_t boundary, bus_addr_t lowaddr, bus_addr_t highaddr,
187 bus_dma_filter_t *filter, void *filterarg, bus_size_t maxsize,
188 int nsegments, bus_size_t maxsegsz, int flags, bus_dma_lock_t *lockfunc,
189 void *lockfuncarg, bus_dma_tag_t *dmat)
191 bus_dma_tag_t newtag;
193 /* Return a NULL tag on failure */
196 /* Enforce the usage of BUS_GET_DMA_TAG(). */
198 panic("%s: parent DMA tag NULL", __func__);
200 newtag = (bus_dma_tag_t)malloc(sizeof(*newtag), M_DEVBUF, M_NOWAIT);
205 * The method table pointer and the cookie need to be taken over from
208 newtag->dt_cookie = parent->dt_cookie;
209 newtag->dt_mt = parent->dt_mt;
211 newtag->dt_parent = parent;
212 newtag->dt_alignment = alignment;
213 newtag->dt_boundary = boundary;
214 newtag->dt_lowaddr = trunc_page((vm_offset_t)lowaddr) + (PAGE_SIZE - 1);
215 newtag->dt_highaddr = trunc_page((vm_offset_t)highaddr) +
217 newtag->dt_filter = filter;
218 newtag->dt_filterarg = filterarg;
219 newtag->dt_maxsize = maxsize;
220 newtag->dt_nsegments = nsegments;
221 newtag->dt_maxsegsz = maxsegsz;
222 newtag->dt_flags = flags;
223 newtag->dt_ref_count = 1; /* Count ourselves */
224 newtag->dt_map_count = 0;
226 if (lockfunc != NULL) {
227 newtag->dt_lockfunc = lockfunc;
228 newtag->dt_lockfuncarg = lockfuncarg;
230 newtag->dt_lockfunc = dflt_lock;
231 newtag->dt_lockfuncarg = NULL;
234 newtag->dt_segments = NULL;
236 /* Take into account any restrictions imposed by our parent tag. */
237 newtag->dt_lowaddr = ulmin(parent->dt_lowaddr, newtag->dt_lowaddr);
238 newtag->dt_highaddr = ulmax(parent->dt_highaddr, newtag->dt_highaddr);
239 if (newtag->dt_boundary == 0)
240 newtag->dt_boundary = parent->dt_boundary;
241 else if (parent->dt_boundary != 0)
242 newtag->dt_boundary = ulmin(parent->dt_boundary,
243 newtag->dt_boundary);
244 atomic_add_int(&parent->dt_ref_count, 1);
246 if (newtag->dt_boundary > 0)
247 newtag->dt_maxsegsz = ulmin(newtag->dt_maxsegsz,
248 newtag->dt_boundary);
255 bus_dma_tag_destroy(bus_dma_tag_t dmat)
257 bus_dma_tag_t parent;
260 if (dmat->dt_map_count != 0)
262 while (dmat != NULL) {
263 parent = dmat->dt_parent;
264 atomic_subtract_int(&dmat->dt_ref_count, 1);
265 if (dmat->dt_ref_count == 0) {
266 if (dmat->dt_segments != NULL)
267 free(dmat->dt_segments, M_DEVBUF);
268 free(dmat, M_DEVBUF);
270 * Last reference count, so
271 * release our reference
272 * count on our parent.
282 /* Allocate/free a tag, and do the necessary management work. */
284 sparc64_dma_alloc_map(bus_dma_tag_t dmat, bus_dmamap_t *mapp)
287 if (dmat->dt_segments == NULL) {
288 dmat->dt_segments = (bus_dma_segment_t *)malloc(
289 sizeof(bus_dma_segment_t) * dmat->dt_nsegments, M_DEVBUF,
291 if (dmat->dt_segments == NULL)
294 *mapp = malloc(sizeof(**mapp), M_DEVBUF, M_NOWAIT | M_ZERO);
298 SLIST_INIT(&(*mapp)->dm_reslist);
299 dmat->dt_map_count++;
304 sparc64_dma_free_map(bus_dma_tag_t dmat, bus_dmamap_t map)
308 dmat->dt_map_count--;
312 nexus_dmamap_create(bus_dma_tag_t dmat, int flags, bus_dmamap_t *mapp)
315 return (sparc64_dma_alloc_map(dmat, mapp));
319 nexus_dmamap_destroy(bus_dma_tag_t dmat, bus_dmamap_t map)
322 sparc64_dma_free_map(dmat, map);
327 * Add a single contiguous physical range to the segment list.
330 nexus_dmamap_addseg(bus_dma_tag_t dmat, bus_dmamap_t map, bus_addr_t curaddr,
331 bus_size_t sgsize, bus_dma_segment_t *segs, int *segp)
333 bus_addr_t baddr, bmask;
337 * Make sure we don't cross any boundaries.
339 bmask = ~(dmat->dt_boundary - 1);
340 if (dmat->dt_boundary > 0) {
341 baddr = (curaddr + dmat->dt_boundary) & bmask;
342 if (sgsize > (baddr - curaddr))
343 sgsize = (baddr - curaddr);
347 * Insert chunk into a segment, coalescing with
348 * previous segment if possible.
353 segs[seg].ds_addr = curaddr;
354 segs[seg].ds_len = sgsize;
356 if (curaddr == segs[seg].ds_addr + segs[seg].ds_len &&
357 (segs[seg].ds_len + sgsize) <= dmat->dt_maxsegsz &&
358 (dmat->dt_boundary == 0 ||
359 (segs[seg].ds_addr & bmask) == (curaddr & bmask)))
360 segs[seg].ds_len += sgsize;
362 if (++seg >= dmat->dt_nsegments)
364 segs[seg].ds_addr = curaddr;
365 segs[seg].ds_len = sgsize;
373 * Utility function to load a physical buffer. segp contains
374 * the starting segment on entrace, and the ending segment on exit.
377 nexus_dmamap_load_phys(bus_dma_tag_t dmat, bus_dmamap_t map, vm_paddr_t buf,
378 bus_size_t buflen, int flags, bus_dma_segment_t *segs, int *segp)
384 segs = dmat->dt_segments;
388 sgsize = MIN(buflen, dmat->dt_maxsegsz);
389 sgsize = nexus_dmamap_addseg(dmat, map, curaddr, sgsize, segs,
400 return (buflen != 0 ? EFBIG : 0); /* XXX better return value here? */
404 * Utility function to load a linear buffer. segp contains
405 * the starting segment on entrace, and the ending segment on exit.
408 nexus_dmamap_load_buffer(bus_dma_tag_t dmat, bus_dmamap_t map, void *buf,
409 bus_size_t buflen, pmap_t pmap, int flags, bus_dma_segment_t *segs,
414 vm_offset_t vaddr = (vm_offset_t)buf;
417 segs = dmat->dt_segments;
421 * Get the physical address for this segment.
423 if (pmap == kernel_pmap)
424 curaddr = pmap_kextract(vaddr);
426 curaddr = pmap_extract(pmap, vaddr);
429 * Compute the segment size, and adjust counts.
431 sgsize = PAGE_SIZE - ((u_long)curaddr & PAGE_MASK);
432 if (sgsize > dmat->dt_maxsegsz)
433 sgsize = dmat->dt_maxsegsz;
437 sgsize = nexus_dmamap_addseg(dmat, map, curaddr, sgsize, segs,
449 return (buflen != 0 ? EFBIG : 0); /* XXX better return value here? */
453 nexus_dmamap_waitok(bus_dma_tag_t dmat, bus_dmamap_t map,
454 struct memdesc *mem, bus_dmamap_callback_t *callback, void *callback_arg)
459 static bus_dma_segment_t *
460 nexus_dmamap_complete(bus_dma_tag_t dmat, bus_dmamap_t map,
461 bus_dma_segment_t *segs, int nsegs, int error)
465 segs = dmat->dt_segments;
470 * Common function for unloading a DMA map. May be called by
471 * bus-specific DMA map unload functions.
474 nexus_dmamap_unload(bus_dma_tag_t dmat, bus_dmamap_t map)
477 map->dm_flags &= ~DMF_LOADED;
481 * Common function for DMA map synchronization. May be called
482 * by bus-specific DMA map synchronization functions.
485 nexus_dmamap_sync(bus_dma_tag_t dmat, bus_dmamap_t map, bus_dmasync_op_t op)
489 * We sync out our caches, but the bus must do the same.
491 * Actually a #Sync is expensive. We should optimize.
493 if ((op & BUS_DMASYNC_PREREAD) || (op & BUS_DMASYNC_PREWRITE)) {
495 * Don't really need to do anything, but flush any pending
500 if (op & BUS_DMASYNC_POSTWRITE) {
501 /* Nothing to do. Handled by the bus controller. */
506 * Common function for DMA-safe memory allocation. May be called
507 * by bus-specific DMA memory allocation functions.
510 nexus_dmamem_alloc(bus_dma_tag_t dmat, void **vaddr, int flags,
515 if (flags & BUS_DMA_NOWAIT)
519 if (flags & BUS_DMA_ZERO)
524 * (dmat->dt_alignment < dmat->dt_maxsize) is just a quick hack; the
525 * exact alignment guarantees of malloc need to be nailed down, and
526 * the code below should be rewritten to take that into account.
528 * In the meantime, we'll warn the user if malloc gets it wrong.
530 if (dmat->dt_maxsize <= PAGE_SIZE &&
531 dmat->dt_alignment < dmat->dt_maxsize)
532 *vaddr = malloc(dmat->dt_maxsize, M_DEVBUF, mflags);
535 * XXX use contigmalloc until it is merged into this
536 * facility and handles multi-seg allocations. Nobody
537 * is doing multi-seg allocations yet though.
539 *vaddr = contigmalloc(dmat->dt_maxsize, M_DEVBUF, mflags,
540 0ul, dmat->dt_lowaddr,
541 dmat->dt_alignment ? dmat->dt_alignment : 1UL,
546 if (vtophys(*vaddr) % dmat->dt_alignment)
547 printf("%s: failed to align memory properly.\n", __func__);
552 * Common function for freeing DMA-safe memory. May be called by
553 * bus-specific DMA memory free functions.
556 nexus_dmamem_free(bus_dma_tag_t dmat, void *vaddr, bus_dmamap_t map)
559 if (dmat->dt_maxsize <= PAGE_SIZE &&
560 dmat->dt_alignment < dmat->dt_maxsize)
561 free(vaddr, M_DEVBUF);
563 contigfree(vaddr, dmat->dt_maxsize, M_DEVBUF);
566 static struct bus_dma_methods nexus_dma_methods = {
568 nexus_dmamap_destroy,
569 nexus_dmamap_load_phys,
570 nexus_dmamap_load_buffer,
572 nexus_dmamap_complete,
579 struct bus_dma_tag nexus_dmatag = {
601 * Helpers to map/unmap bus memory
604 bus_space_map(bus_space_tag_t tag, bus_addr_t address, bus_size_t size,
605 int flags, bus_space_handle_t *handlep)
608 return (sparc64_bus_mem_map(tag, address, size, flags, 0, handlep));
612 sparc64_bus_mem_map(bus_space_tag_t tag, bus_addr_t addr, bus_size_t size,
613 int flags, vm_offset_t vaddr, bus_space_handle_t *hp)
622 * Given that we use physical access for bus_space(9) there's no need
623 * need to map anything in unless BUS_SPACE_MAP_LINEAR is requested.
625 if ((flags & BUS_SPACE_MAP_LINEAR) == 0) {
630 if (tag->bst_cookie == NULL) {
631 printf("%s: resource cookie not set\n", __func__);
635 size = round_page(size);
637 printf("%s: zero size\n", __func__);
641 switch (tag->bst_type) {
642 case PCI_CONFIG_BUS_SPACE:
643 case PCI_IO_BUS_SPACE:
644 case PCI_MEMORY_BUS_SPACE:
652 if ((flags & BUS_SPACE_MAP_CACHEABLE) == 0)
656 sva = trunc_page(vaddr);
658 if ((sva = kva_alloc(size)) == 0)
659 panic("%s: cannot allocate virtual memory", __func__);
662 pa = trunc_page(addr);
663 if ((flags & BUS_SPACE_MAP_READONLY) == 0)
669 pmap_kenter_flags(va, pa, pm_flags);
672 } while ((vsz -= PAGE_SIZE) > 0);
673 tlb_range_demap(kernel_pmap, sva, sva + size - 1);
675 /* Note: we preserve the page offset. */
676 rman_set_virtual(tag->bst_cookie, (void *)(sva | (addr & PAGE_MASK)));
681 bus_space_unmap(bus_space_tag_t tag, bus_space_handle_t handle,
685 sparc64_bus_mem_unmap(tag, handle, size);
689 sparc64_bus_mem_unmap(bus_space_tag_t tag, bus_space_handle_t handle,
696 if (tag->bst_cookie == NULL ||
697 (sva = (vm_offset_t)rman_get_virtual(tag->bst_cookie)) == 0)
699 sva = trunc_page(sva);
700 endva = sva + round_page(size);
701 for (va = sva; va < endva; va += PAGE_SIZE)
702 pmap_kremove_flags(va);
703 tlb_range_demap(kernel_pmap, sva, sva + size - 1);
709 * Fake up a bus tag, for use by console drivers in early boot when the
710 * regular means to allocate resources are not yet available.
711 * Addr is the physical address of the desired start of the handle.
714 sparc64_fake_bustag(int space, bus_addr_t addr, struct bus_space_tag *ptag)
717 ptag->bst_cookie = NULL;
718 ptag->bst_parent = NULL;
719 ptag->bst_type = space;
720 ptag->bst_bus_barrier = nexus_bus_barrier;
725 * Allocate a bus tag.
728 sparc64_alloc_bus_tag(void *cookie, struct bus_space_tag *ptag, int type,
733 bt = malloc(sizeof(struct bus_space_tag), M_DEVBUF, M_NOWAIT);
736 bt->bst_cookie = cookie;
737 bt->bst_parent = ptag;
739 bt->bst_bus_barrier = barrier;
744 * Base bus space handlers.
748 nexus_bus_barrier(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset,
749 bus_size_t size, int flags)
753 * We have lots of alternatives depending on whether we're
754 * synchronizing loads with loads, loads with stores, stores
755 * with loads, or stores with stores. The only ones that seem
756 * generic are #Sync and #MemIssue. I'll use #Sync for safety.
759 case BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE:
760 case BUS_SPACE_BARRIER_READ:
761 case BUS_SPACE_BARRIER_WRITE:
765 panic("%s: unknown flags", __func__);
770 struct bus_space_tag nexus_bustag = {
772 NULL, /* parent bus tag */
773 NEXUS_BUS_SPACE, /* type */
774 nexus_bus_barrier, /* bus_space_barrier */