| 1 | /* $NetBSD: bus_private.h,v 1.14 2011/09/01 15:10:31 christos Exp $ */ |
| 2 | /* NetBSD: bus.h,v 1.8 2005/03/09 19:04:46 matt Exp */ |
| 3 | |
| 4 | /*- |
| 5 | * Copyright (c) 1996, 1997, 1998, 2001 The NetBSD Foundation, Inc. |
| 6 | * All rights reserved. |
| 7 | * |
| 8 | * This code is derived from software contributed to The NetBSD Foundation |
| 9 | * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility, |
| 10 | * NASA Ames Research Center. |
| 11 | * |
| 12 | * Redistribution and use in source and binary forms, with or without |
| 13 | * modification, are permitted provided that the following conditions |
| 14 | * are met: |
| 15 | * 1. Redistributions of source code must retain the above copyright |
| 16 | * notice, this list of conditions and the following disclaimer. |
| 17 | * 2. Redistributions in binary form must reproduce the above copyright |
| 18 | * notice, this list of conditions and the following disclaimer in the |
| 19 | * documentation and/or other materials provided with the distribution. |
| 20 | * |
| 21 | * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS |
| 22 | * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED |
| 23 | * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
| 24 | * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS |
| 25 | * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| 26 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| 27 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| 28 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| 29 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| 30 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| 31 | * POSSIBILITY OF SUCH DAMAGE. |
| 32 | */ |
| 33 | |
| 34 | /* |
| 35 | * Copyright (c) 1996 Charles M. Hannum. All rights reserved. |
| 36 | * Copyright (c) 1996 Christopher G. Demetriou. All rights reserved. |
| 37 | * |
| 38 | * Redistribution and use in source and binary forms, with or without |
| 39 | * modification, are permitted provided that the following conditions |
| 40 | * are met: |
| 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 | * 3. All advertising materials mentioning features or use of this software |
| 47 | * must display the following acknowledgement: |
| 48 | * This product includes software developed by Christopher G. Demetriou |
| 49 | * for the NetBSD Project. |
| 50 | * 4. The name of the author may not be used to endorse or promote products |
| 51 | * derived from this software without specific prior written permission |
| 52 | * |
| 53 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
| 54 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| 55 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
| 56 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
| 57 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
| 58 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 59 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 60 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 61 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
| 62 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 63 | */ |
| 64 | |
| 65 | #if !defined(_X86_BUS_PRIVATE_H_) |
| 66 | #define _X86_BUS_PRIVATE_H_ |
| 67 | |
| 68 | /* |
| 69 | * Cookie used for bounce buffers. A pointer to one of these it stashed in |
| 70 | * the DMA map. |
| 71 | */ |
| 72 | struct x86_bus_dma_cookie { |
| 73 | int id_flags; /* flags; see below */ |
| 74 | |
| 75 | /* |
| 76 | * Information about the original buffer used during |
| 77 | * DMA map syncs. Note that origibuflen is only used |
| 78 | * for ID_BUFTYPE_LINEAR. |
| 79 | */ |
| 80 | void *id_origbuf; /* pointer to orig buffer if |
| 81 | bouncing */ |
| 82 | bus_size_t id_origbuflen; /* ...and size */ |
| 83 | int id_buftype; /* type of buffer */ |
| 84 | |
| 85 | void *id_bouncebuf; /* pointer to the bounce buffer */ |
| 86 | bus_size_t id_bouncebuflen; /* ...and size */ |
| 87 | int id_nbouncesegs; /* number of valid bounce segs */ |
| 88 | bus_dma_segment_t id_bouncesegs[0]; /* array of bounce buffer |
| 89 | physical memory segments */ |
| 90 | }; |
| 91 | |
| 92 | /* id_flags */ |
| 93 | #define X86_DMA_MIGHT_NEED_BOUNCE 0x01 /* may need bounce buffers */ |
| 94 | #define X86_DMA_HAS_BOUNCE 0x02 /* has bounce buffers */ |
| 95 | #define X86_DMA_IS_BOUNCING 0x04 /* is bouncing current xfer */ |
| 96 | |
| 97 | /* id_buftype */ |
| 98 | #define X86_DMA_BUFTYPE_INVALID 0 |
| 99 | #define X86_DMA_BUFTYPE_LINEAR 1 |
| 100 | #define X86_DMA_BUFTYPE_MBUF 2 |
| 101 | #define X86_DMA_BUFTYPE_UIO 3 |
| 102 | #define X86_DMA_BUFTYPE_RAW 4 |
| 103 | |
| 104 | /* |
| 105 | * default address translation macros, which are appropriate where |
| 106 | * paddr_t == bus_addr_t. |
| 107 | */ |
| 108 | |
| 109 | #if !defined(_BUS_PHYS_TO_BUS) |
| 110 | #define _BUS_PHYS_TO_BUS(pa) ((bus_addr_t)(pa)) |
| 111 | #endif /* !defined(_BUS_PHYS_TO_BUS) */ |
| 112 | |
| 113 | #if !defined(_BUS_BUS_TO_PHYS) |
| 114 | #define _BUS_BUS_TO_PHYS(ba) ((paddr_t)(ba)) |
| 115 | #endif /* !defined(_BUS_BUS_TO_PHYS) */ |
| 116 | |
| 117 | #if !defined(_BUS_VM_PAGE_TO_BUS) |
| 118 | #define _BUS_VM_PAGE_TO_BUS(pg) _BUS_PHYS_TO_BUS(VM_PAGE_TO_PHYS(pg)) |
| 119 | #endif /* !defined(_BUS_VM_PAGE_TO_BUS) */ |
| 120 | |
| 121 | #if !defined(_BUS_BUS_TO_VM_PAGE) |
| 122 | #define _BUS_BUS_TO_VM_PAGE(ba) PHYS_TO_VM_PAGE(ba) |
| 123 | #endif /* !defined(_BUS_BUS_TO_VM_PAGE) */ |
| 124 | |
| 125 | #if !defined(_BUS_PMAP_ENTER) |
| 126 | #define _BUS_PMAP_ENTER(pmap, va, ba, prot, flags) \ |
| 127 | pmap_enter(pmap, va, ba, prot, flags) |
| 128 | #endif /* _BUS_PMAP_ENTER */ |
| 129 | |
| 130 | #if !defined(_BUS_VIRT_TO_BUS) |
| 131 | #include <uvm/uvm.h> |
| 132 | |
| 133 | static __inline bus_addr_t _bus_virt_to_bus(struct pmap *, vaddr_t); |
| 134 | #define _BUS_VIRT_TO_BUS(pm, va) _bus_virt_to_bus((pm), (va)) |
| 135 | |
| 136 | static __inline bus_addr_t |
| 137 | _bus_virt_to_bus(struct pmap *pm, vaddr_t va) |
| 138 | { |
| 139 | paddr_t pa; |
| 140 | |
| 141 | if (!pmap_extract(pm, va, &pa)) { |
| 142 | panic("_bus_virt_to_bus" ); |
| 143 | } |
| 144 | |
| 145 | return _BUS_PHYS_TO_BUS(pa); |
| 146 | } |
| 147 | #endif /* !defined(_BUS_VIRT_TO_BUS) */ |
| 148 | |
| 149 | /* |
| 150 | * by default, the end address of RAM visible on bus is the same as the |
| 151 | * largest physical address. |
| 152 | */ |
| 153 | #ifndef _BUS_AVAIL_END |
| 154 | #define _BUS_AVAIL_END (avail_end) |
| 155 | #endif |
| 156 | |
| 157 | struct x86_bus_dma_tag { |
| 158 | bus_dma_tag_t bdt_super; |
| 159 | /* bdt_present: bitmap indicating overrides present (1) in *this* tag, |
| 160 | * bdt_exists: bitmap indicating overrides present (1) in *this* tag |
| 161 | * or in an ancestor's tag (follow bdt_super to ancestors) |
| 162 | */ |
| 163 | uint64_t bdt_present; |
| 164 | uint64_t bdt_exists; |
| 165 | const struct bus_dma_overrides *bdt_ov; |
| 166 | void *bdt_ctx; |
| 167 | /* |
| 168 | * The `bounce threshold' is checked while we are loading |
| 169 | * the DMA map. If the physical address of the segment |
| 170 | * exceeds the threshold, an error will be returned. The |
| 171 | * caller can then take whatever action is necessary to |
| 172 | * bounce the transfer. If this value is 0, it will be |
| 173 | * ignored. |
| 174 | */ |
| 175 | int _tag_needs_free; |
| 176 | bus_addr_t _bounce_thresh; |
| 177 | bus_addr_t _bounce_alloc_lo; |
| 178 | bus_addr_t _bounce_alloc_hi; |
| 179 | int (*_may_bounce)(bus_dma_tag_t, bus_dmamap_t, int, int *); |
| 180 | }; |
| 181 | |
| 182 | #endif /* !defined(_X86_BUS_PRIVATE_H_) */ |
| 183 | |