bus_defs.h revision 1.1
1 /* $NetBSD: bus_defs.h,v 1.1 2014/02/24 07:23:43 skrll Exp $ */ 2 3 /* $OpenBSD: bus.h,v 1.13 2001/07/30 14:15:59 art Exp $ */ 4 5 /* 6 * Copyright (c) 1998-2004 Michael Shalayeff 7 * All rights reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 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. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 21 * IN NO EVENT SHALL THE AUTHOR OR HIS RELATIVES BE LIABLE FOR ANY DIRECT, 22 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 24 * SERVICES; LOSS OF MIND, USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 26 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 27 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 28 * THE POSSIBILITY OF SUCH DAMAGE. 29 */ 30 31 32 #ifndef _MACHINE_BUS_DEFS_H_ 33 #define _MACHINE_BUS_DEFS_H_ 34 35 #include <machine/cpufunc.h> 36 37 /* 38 * Bus address and size types. 39 */ 40 typedef u_long bus_addr_t; 41 typedef u_long bus_size_t; 42 typedef u_long bus_space_handle_t; 43 44 struct hppa_bus_space_tag { 45 void *hbt_cookie; 46 47 int (*hbt_map)(void *v, bus_addr_t addr, bus_size_t size, 48 int flags, bus_space_handle_t *bshp); 49 void (*hbt_unmap)(void *v, bus_space_handle_t bsh, 50 bus_size_t size); 51 int (*hbt_subregion)(void *v, bus_space_handle_t bsh, 52 bus_size_t offset, bus_size_t size, 53 bus_space_handle_t *nbshp); 54 int (*hbt_alloc)(void *v, bus_addr_t rstart, bus_addr_t rend, 55 bus_size_t size, bus_size_t align, 56 bus_size_t boundary, int flags, 57 bus_addr_t *addrp, bus_space_handle_t *bshp); 58 void (*hbt_free)(void *, bus_space_handle_t, bus_size_t); 59 void (*hbt_barrier)(void *v, bus_space_handle_t h, 60 bus_size_t o, bus_size_t l, int op); 61 void *(*hbt_vaddr)(void *, bus_space_handle_t); 62 paddr_t (*hbt_mmap)(void *, bus_addr_t, off_t, int, int); 63 64 uint8_t (*hbt_r1)(void *, bus_space_handle_t, bus_size_t); 65 uint16_t (*hbt_r2)(void *, bus_space_handle_t, bus_size_t); 66 uint32_t (*hbt_r4)(void *, bus_space_handle_t, bus_size_t); 67 uint64_t (*hbt_r8)(void *, bus_space_handle_t, bus_size_t); 68 69 void (*hbt_w1)(void *, bus_space_handle_t, bus_size_t, uint8_t); 70 void (*hbt_w2)(void *, bus_space_handle_t, bus_size_t, uint16_t); 71 void (*hbt_w4)(void *, bus_space_handle_t, bus_size_t, uint32_t); 72 void (*hbt_w8)(void *, bus_space_handle_t, bus_size_t, uint64_t); 73 74 void (*hbt_rm_1)(void *v, bus_space_handle_t h, 75 bus_size_t o, uint8_t *a, bus_size_t c); 76 void (*hbt_rm_2)(void *v, bus_space_handle_t h, 77 bus_size_t o, uint16_t *a, bus_size_t c); 78 void (*hbt_rm_4)(void *v, bus_space_handle_t h, 79 bus_size_t o, uint32_t *a, bus_size_t c); 80 void (*hbt_rm_8)(void *v, bus_space_handle_t h, 81 bus_size_t o, uint64_t *a, bus_size_t c); 82 83 void (*hbt_wm_1)(void *v, bus_space_handle_t h, bus_size_t o, 84 const uint8_t *a, bus_size_t c); 85 void (*hbt_wm_2)(void *v, bus_space_handle_t h, bus_size_t o, 86 const uint16_t *a, bus_size_t c); 87 void (*hbt_wm_4)(void *v, bus_space_handle_t h, bus_size_t o, 88 const uint32_t *a, bus_size_t c); 89 void (*hbt_wm_8)(void *v, bus_space_handle_t h, bus_size_t o, 90 const uint64_t *a, bus_size_t c); 91 92 void (*hbt_sm_1)(void *v, bus_space_handle_t h, bus_size_t o, 93 uint8_t vv, bus_size_t c); 94 void (*hbt_sm_2)(void *v, bus_space_handle_t h, bus_size_t o, 95 uint16_t vv, bus_size_t c); 96 void (*hbt_sm_4)(void *v, bus_space_handle_t h, bus_size_t o, 97 uint32_t vv, bus_size_t c); 98 void (*hbt_sm_8)(void *v, bus_space_handle_t h, bus_size_t o, 99 uint64_t vv, bus_size_t c); 100 101 void (*hbt_rrm_2)(void *v, bus_space_handle_t h, 102 bus_size_t o, uint16_t *a, bus_size_t c); 103 void (*hbt_rrm_4)(void *v, bus_space_handle_t h, 104 bus_size_t o, uint32_t *a, bus_size_t c); 105 void (*hbt_rrm_8)(void *v, bus_space_handle_t h, 106 bus_size_t o, uint64_t *a, bus_size_t c); 107 108 void (*hbt_wrm_2)(void *v, bus_space_handle_t h, 109 bus_size_t o, const uint16_t *a, bus_size_t c); 110 void (*hbt_wrm_4)(void *v, bus_space_handle_t h, 111 bus_size_t o, const uint32_t *a, bus_size_t c); 112 void (*hbt_wrm_8)(void *v, bus_space_handle_t h, 113 bus_size_t o, const uint64_t *a, bus_size_t c); 114 115 void (*hbt_rr_1)(void *v, bus_space_handle_t h, 116 bus_size_t o, uint8_t *a, bus_size_t c); 117 void (*hbt_rr_2)(void *v, bus_space_handle_t h, 118 bus_size_t o, uint16_t *a, bus_size_t c); 119 void (*hbt_rr_4)(void *v, bus_space_handle_t h, 120 bus_size_t o, uint32_t *a, bus_size_t c); 121 void (*hbt_rr_8)(void *v, bus_space_handle_t h, 122 bus_size_t o, uint64_t *a, bus_size_t c); 123 124 void (*hbt_wr_1)(void *v, bus_space_handle_t h, 125 bus_size_t o, const uint8_t *a, bus_size_t c); 126 void (*hbt_wr_2)(void *v, bus_space_handle_t h, 127 bus_size_t o, const uint16_t *a, bus_size_t c); 128 void (*hbt_wr_4)(void *v, bus_space_handle_t h, 129 bus_size_t o, const uint32_t *a, bus_size_t c); 130 void (*hbt_wr_8)(void *v, bus_space_handle_t h, 131 bus_size_t o, const uint64_t *a, bus_size_t c); 132 133 void (*hbt_rrr_2)(void *v, bus_space_handle_t h, 134 bus_size_t o, uint16_t *a, bus_size_t c); 135 void (*hbt_rrr_4)(void *v, bus_space_handle_t h, 136 bus_size_t o, uint32_t *a, bus_size_t c); 137 void (*hbt_rrr_8)(void *v, bus_space_handle_t h, 138 bus_size_t o, uint64_t *a, bus_size_t c); 139 140 void (*hbt_wrr_2)(void *v, bus_space_handle_t h, 141 bus_size_t o, const uint16_t *a, bus_size_t c); 142 void (*hbt_wrr_4)(void *v, bus_space_handle_t h, 143 bus_size_t o, const uint32_t *a, bus_size_t c); 144 void (*hbt_wrr_8)(void *v, bus_space_handle_t h, 145 bus_size_t o, const uint64_t *a, bus_size_t c); 146 147 void (*hbt_sr_1)(void *v, bus_space_handle_t h, 148 bus_size_t o, uint8_t vv, bus_size_t c); 149 void (*hbt_sr_2)(void *v, bus_space_handle_t h, 150 bus_size_t o, uint16_t vv, bus_size_t c); 151 void (*hbt_sr_4)(void *v, bus_space_handle_t h, 152 bus_size_t o, uint32_t vv, bus_size_t c); 153 void (*hbt_sr_8)(void *v, bus_space_handle_t h, 154 bus_size_t o, uint64_t vv, bus_size_t c); 155 156 void (*hbt_cp_1)(void *v, bus_space_handle_t h1, bus_size_t o1, 157 bus_space_handle_t h2, bus_size_t o2, bus_size_t c); 158 void (*hbt_cp_2)(void *v, bus_space_handle_t h1, bus_size_t o1, 159 bus_space_handle_t h2, bus_size_t o2, bus_size_t c); 160 void (*hbt_cp_4)(void *v, bus_space_handle_t h1, bus_size_t o1, 161 bus_space_handle_t h2, bus_size_t o2, bus_size_t c); 162 void (*hbt_cp_8)(void *v, bus_space_handle_t h1, bus_size_t o1, 163 bus_space_handle_t h2, bus_size_t o2, bus_size_t c); 164 }; 165 typedef const struct hppa_bus_space_tag *bus_space_tag_t; 166 167 /* flags for bus space map functions */ 168 #define BUS_SPACE_MAP_READONLY 0x0008 169 #define BUS_SPACE_MAP_NOEXTENT 0x8000 /* no extent ops */ 170 171 172 /* bus access routines */ 173 #define BUS_SPACE_ALIGNED_POINTER(p, t) ALIGNED_POINTER(p, t) 174 175 /* XXX fredette */ 176 #define __BUS_SPACE_HAS_STREAM_METHODS 177 178 #define BUS_DMA_WAITOK 0x000 /* safe to sleep (pseudo-flag) */ 179 #define BUS_DMA_NOWAIT 0x001 /* not safe to sleep */ 180 #define BUS_DMA_ALLOCNOW 0x002 /* perform resource allocation now */ 181 #define BUS_DMA_COHERENT 0x004 /* hint: map memory DMA coherent */ 182 #define BUS_DMA_STREAMING 0x008 /* hint: sequential, unidirectional */ 183 #define BUS_DMA_BUS1 0x010 /* placeholders for bus functions... */ 184 #define BUS_DMA_BUS2 0x020 185 #define BUS_DMA_BUS3 0x040 186 #define BUS_DMA_BUS4 0x080 187 #define BUS_DMA_READ 0x100 /* mapping is device -> memory only */ 188 #define BUS_DMA_WRITE 0x200 /* mapping is memory -> device only */ 189 #define BUS_DMA_NOCACHE 0x400 /* hint: map non-cached memory */ 190 191 /* For devices that have a 24-bit address space */ 192 #define BUS_DMA_24BIT BUS_DMA_BUS1 193 194 /* Forwards needed by prototypes below. */ 195 struct mbuf; 196 struct proc; 197 struct uio; 198 199 typedef const struct hppa_bus_dma_tag *bus_dma_tag_t; 200 typedef struct hppa_bus_dmamap *bus_dmamap_t; 201 202 #define BUS_DMA_TAG_VALID(t) ((t) != (bus_dma_tag_t)0) 203 204 /* 205 * bus_dma_segment_t 206 * 207 * Describes a single contiguous DMA transaction. Values 208 * are suitable for programming into DMA registers. 209 */ 210 struct hppa_bus_dma_segment { 211 bus_addr_t ds_addr; /* DMA address */ 212 bus_size_t ds_len; /* length of transfer */ 213 void *_ds_mlist; /* page list when dmamem_alloc'ed */ 214 vaddr_t _ds_va; /* VA when dmamem_map'ed */ 215 }; 216 typedef struct hppa_bus_dma_segment bus_dma_segment_t; 217 218 /* 219 * bus_dma_tag_t 220 * 221 * A machine-dependent opaque type describing the implementation of 222 * DMA for a given bus. 223 */ 224 225 struct hppa_bus_dma_tag { 226 void *_cookie; /* cookie used in the guts */ 227 228 /* 229 * DMA mapping methods. 230 */ 231 int (*_dmamap_create)(void *, bus_size_t, int, 232 bus_size_t, bus_size_t, int, bus_dmamap_t *); 233 void (*_dmamap_destroy)(void *, bus_dmamap_t); 234 int (*_dmamap_load)(void *, bus_dmamap_t, void *, 235 bus_size_t, struct proc *, int); 236 int (*_dmamap_load_mbuf)(void *, bus_dmamap_t, 237 struct mbuf *, int); 238 int (*_dmamap_load_uio)(void *, bus_dmamap_t, 239 struct uio *, int); 240 int (*_dmamap_load_raw)(void *, bus_dmamap_t, 241 bus_dma_segment_t *, int, bus_size_t, int); 242 void (*_dmamap_unload)(void *, bus_dmamap_t); 243 void (*_dmamap_sync)(void *, bus_dmamap_t, bus_addr_t, bus_size_t, int); 244 245 /* 246 * DMA memory utility functions. 247 */ 248 int (*_dmamem_alloc)(void *, bus_size_t, bus_size_t, 249 bus_size_t, bus_dma_segment_t *, int, int *, int); 250 void (*_dmamem_free)(void *, bus_dma_segment_t *, int); 251 int (*_dmamem_map)(void *, bus_dma_segment_t *, 252 int, size_t, void **, int); 253 void (*_dmamem_unmap)(void *, void *, size_t); 254 paddr_t (*_dmamem_mmap)(void *, bus_dma_segment_t *, 255 int, off_t, int, int); 256 }; 257 258 /* 259 * bus_dmamap_t 260 * 261 * Describes a DMA mapping. 262 */ 263 struct hppa_bus_dmamap { 264 /* 265 * PRIVATE MEMBERS: not for use by machine-independent code. 266 */ 267 bus_size_t _dm_size; /* largest DMA transfer mappable */ 268 int _dm_segcnt; /* number of segs this map can map */ 269 bus_size_t _dm_maxsegsz; /* fixed largest possible segment */ 270 bus_size_t _dm_boundary; /* don't cross this */ 271 int _dm_flags; /* misc. flags */ 272 273 void *_dm_cookie; /* cookie for bus-specific functions */ 274 275 /* 276 * PUBLIC MEMBERS: these are used by machine-independent code. 277 */ 278 bus_size_t dm_maxsegsz; /* largest possible segment */ 279 bus_size_t dm_mapsize; /* size of the mapping */ 280 int dm_nsegs; /* # valid segments in mapping */ 281 bus_dma_segment_t dm_segs[1]; /* segments; variable length */ 282 }; 283 284 #endif /* _MACHINE_BUS_DEFS_H_ */ 285
Indexes created Mon Sep 29 21:09:56 GMT 2025