bus_defs.h revision 1.1
1 /* $NetBSD: bus_defs.h,v 1.1 2011/07/19 15:52:30 dyoung Exp $ */ 2 3 /*- 4 * Copyright (c) 1997, 1998, 2000, 2001 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility, 9 * NASA Ames Research Center. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 30 * POSSIBILITY OF SUCH DAMAGE. 31 */ 32 33 /* 34 * Copyright (c) 1996 Carnegie-Mellon University. 35 * All rights reserved. 36 * 37 * Author: Chris G. Demetriou 38 * 39 * Permission to use, copy, modify and distribute this software and 40 * its documentation is hereby granted, provided that both the copyright 41 * notice and this permission notice appear in all copies of the 42 * software, derivative works or modified versions, and any portions 43 * thereof, and that both notices appear in supporting documentation. 44 * 45 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS" 46 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND 47 * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE. 48 * 49 * Carnegie Mellon requests users of this software to return to 50 * 51 * Software Distribution Coordinator or Software.Distribution (at) CS.CMU.EDU 52 * School of Computer Science 53 * Carnegie Mellon University 54 * Pittsburgh PA 15213-3890 55 * 56 * any improvements or extensions that they make and grant Carnegie the 57 * rights to redistribute these changes. 58 */ 59 60 #ifndef _DREAMCAST_BUS_DEFS_H_ 61 #define _DREAMCAST_BUS_DEFS_H_ 62 63 #ifdef _KERNEL 64 /* 65 * Turn on BUS_SPACE_DEBUG if the global DEBUG option is enabled. 66 */ 67 #if defined(DEBUG) && !defined(BUS_SPACE_DEBUG) 68 #define BUS_SPACE_DEBUG 69 #endif 70 71 #ifdef BUS_SPACE_DEBUG 72 #include <sys/systm.h> /* for printf() prototype */ 73 /* 74 * Macros for checking the aligned-ness of pointers passed to bus 75 * space ops. Strict alignment is required by the Alpha architecture, 76 * and a trap will occur if unaligned access is performed. These 77 * may aid in the debugging of a broken device driver by displaying 78 * useful information about the problem. 79 */ 80 #define __BUS_SPACE_ALIGNED_ADDRESS(p, t) \ 81 ((((u_long)(p)) & (sizeof(t)-1)) == 0) 82 83 #define __BUS_SPACE_ADDRESS_SANITY(p, t, d) \ 84 ({ \ 85 if (__BUS_SPACE_ALIGNED_ADDRESS((p), t) == 0) { \ 86 printf("%s 0x%lx not aligned to %lu bytes %s:%d\n", \ 87 d, (u_long)(p), (u_long)sizeof(t), __FILE__, __LINE__); \ 88 } \ 89 (void) 0; \ 90 }) 91 92 #define BUS_SPACE_ALIGNED_POINTER(p, t) __BUS_SPACE_ALIGNED_ADDRESS(p, t) 93 #else 94 #define __BUS_SPACE_ADDRESS_SANITY(p, t, d) (void) 0 95 #define BUS_SPACE_ALIGNED_POINTER(p, t) ALIGNED_POINTER(p, t) 96 #endif /* BUS_SPACE_DEBUG */ 97 #endif /* _KERNEL */ 98 99 /* 100 * Addresses (in bus space). 101 */ 102 typedef u_long bus_addr_t; 103 typedef u_long bus_size_t; 104 105 /* 106 * Access methods for bus space. 107 */ 108 typedef struct dreamcast_bus_space *bus_space_tag_t; 109 typedef u_long bus_space_handle_t; 110 111 struct dreamcast_bus_space { 112 /* cookie */ 113 void *dbs_cookie; 114 115 /* mapping/unmapping */ 116 int (*dbs_map)(void *, bus_addr_t, bus_size_t, 117 int, bus_space_handle_t *); 118 void (*dbs_unmap)(void *, bus_space_handle_t, 119 bus_size_t); 120 int (*dbs_subregion)(void *, bus_space_handle_t, 121 bus_size_t, bus_size_t, bus_space_handle_t *); 122 paddr_t (*dbs_mmap)(void *, bus_addr_t, off_t, int, int); 123 124 /* allocation/deallocation */ 125 int (*dbs_alloc)(void *, bus_addr_t, bus_addr_t, 126 bus_size_t, bus_size_t, bus_size_t, int, 127 bus_addr_t *, bus_space_handle_t *); 128 void (*dbs_free)(void *, bus_space_handle_t, 129 bus_size_t); 130 131 /* get kernel virtual address */ 132 void * (*dbs_vaddr)(void *, bus_space_handle_t); 133 134 /* read (single) */ 135 uint8_t (*dbs_r_1)(void *, bus_space_handle_t, 136 bus_size_t); 137 uint16_t (*dbs_r_2)(void *, bus_space_handle_t, 138 bus_size_t); 139 uint32_t (*dbs_r_4)(void *, bus_space_handle_t, 140 bus_size_t); 141 uint64_t (*dbs_r_8)(void *, bus_space_handle_t, 142 bus_size_t); 143 144 /* read multiple */ 145 void (*dbs_rm_1)(void *, bus_space_handle_t, 146 bus_size_t, uint8_t *, bus_size_t); 147 void (*dbs_rm_2)(void *, bus_space_handle_t, 148 bus_size_t, uint16_t *, bus_size_t); 149 void (*dbs_rm_4)(void *, bus_space_handle_t, 150 bus_size_t, uint32_t *, bus_size_t); 151 void (*dbs_rm_8)(void *, bus_space_handle_t, 152 bus_size_t, uint64_t *, bus_size_t); 153 154 /* read region */ 155 void (*dbs_rr_1)(void *, bus_space_handle_t, 156 bus_size_t, uint8_t *, bus_size_t); 157 void (*dbs_rr_2)(void *, bus_space_handle_t, 158 bus_size_t, uint16_t *, bus_size_t); 159 void (*dbs_rr_4)(void *, bus_space_handle_t, 160 bus_size_t, uint32_t *, bus_size_t); 161 void (*dbs_rr_8)(void *, bus_space_handle_t, 162 bus_size_t, uint64_t *, bus_size_t); 163 164 /* write (single) */ 165 void (*dbs_w_1)(void *, bus_space_handle_t, 166 bus_size_t, uint8_t); 167 void (*dbs_w_2)(void *, bus_space_handle_t, 168 bus_size_t, uint16_t); 169 void (*dbs_w_4)(void *, bus_space_handle_t, 170 bus_size_t, uint32_t); 171 void (*dbs_w_8)(void *, bus_space_handle_t, 172 bus_size_t, uint64_t); 173 174 /* write multiple */ 175 void (*dbs_wm_1)(void *, bus_space_handle_t, 176 bus_size_t, const uint8_t *, bus_size_t); 177 void (*dbs_wm_2)(void *, bus_space_handle_t, 178 bus_size_t, const uint16_t *, bus_size_t); 179 void (*dbs_wm_4)(void *, bus_space_handle_t, 180 bus_size_t, const uint32_t *, bus_size_t); 181 void (*dbs_wm_8)(void *, bus_space_handle_t, 182 bus_size_t, const uint64_t *, bus_size_t); 183 184 /* write region */ 185 void (*dbs_wr_1)(void *, bus_space_handle_t, 186 bus_size_t, const uint8_t *, bus_size_t); 187 void (*dbs_wr_2)(void *, bus_space_handle_t, 188 bus_size_t, const uint16_t *, bus_size_t); 189 void (*dbs_wr_4)(void *, bus_space_handle_t, 190 bus_size_t, const uint32_t *, bus_size_t); 191 void (*dbs_wr_8)(void *, bus_space_handle_t, 192 bus_size_t, const uint64_t *, bus_size_t); 193 194 /* set multiple */ 195 void (*dbs_sm_1)(void *, bus_space_handle_t, 196 bus_size_t, uint8_t, bus_size_t); 197 void (*dbs_sm_2)(void *, bus_space_handle_t, 198 bus_size_t, uint16_t, bus_size_t); 199 void (*dbs_sm_4)(void *, bus_space_handle_t, 200 bus_size_t, uint32_t, bus_size_t); 201 void (*dbs_sm_8)(void *, bus_space_handle_t, 202 bus_size_t, uint64_t, bus_size_t); 203 204 /* set region */ 205 void (*dbs_sr_1)(void *, bus_space_handle_t, 206 bus_size_t, uint8_t, bus_size_t); 207 void (*dbs_sr_2)(void *, bus_space_handle_t, 208 bus_size_t, uint16_t, bus_size_t); 209 void (*dbs_sr_4)(void *, bus_space_handle_t, 210 bus_size_t, uint32_t, bus_size_t); 211 void (*dbs_sr_8)(void *, bus_space_handle_t, 212 bus_size_t, uint64_t, bus_size_t); 213 214 /* copy */ 215 void (*dbs_c_1)(void *, bus_space_handle_t, bus_size_t, 216 bus_space_handle_t, bus_size_t, bus_size_t); 217 void (*dbs_c_2)(void *, bus_space_handle_t, bus_size_t, 218 bus_space_handle_t, bus_size_t, bus_size_t); 219 void (*dbs_c_4)(void *, bus_space_handle_t, bus_size_t, 220 bus_space_handle_t, bus_size_t, bus_size_t); 221 void (*dbs_c_8)(void *, bus_space_handle_t, bus_size_t, 222 bus_space_handle_t, bus_size_t, bus_size_t); 223 }; 224 225 #define BUS_SPACE_MAP_CACHEABLE 0x01 226 #define BUS_SPACE_MAP_LINEAR 0x02 227 #define BUS_SPACE_MAP_PREFETCHABLE 0x04 228 229 #ifdef _KERNEL 230 231 #define BUS_SPACE_BARRIER_READ 0x01 232 #define BUS_SPACE_BARRIER_WRITE 0x02 233 234 #endif /* _KERNEL */ 235 236 /* 237 * Flags used in various bus DMA methods. 238 */ 239 #define BUS_DMA_WAITOK 0x000 /* safe to sleep (pseudo-flag) */ 240 #define BUS_DMA_NOWAIT 0x001 /* not safe to sleep */ 241 #define BUS_DMA_ALLOCNOW 0x002 /* perform resource allocation now */ 242 #define BUS_DMA_COHERENT 0x004 /* map memory to not require sync */ 243 #define BUS_DMA_STREAMING 0x008 /* hint: sequential, unidirectional */ 244 #define BUS_DMA_BUS1 0x010 /* placeholders for bus functions... */ 245 #define BUS_DMA_BUS2 0x020 246 #define BUS_DMA_BUS3 0x040 247 #define BUS_DMA_BUS4 0x080 248 #define BUS_DMA_READ 0x100 /* mapping is device -> memory only */ 249 #define BUS_DMA_WRITE 0x200 /* mapping is memory -> device only */ 250 #define BUS_DMA_NOCACHE 0x400 /* hint: map non-cached memory */ 251 252 /* Forwards needed by prototypes below. */ 253 struct mbuf; 254 struct uio; 255 256 /* 257 * Operations performed by bus_dmamap_sync(). 258 */ 259 #define BUS_DMASYNC_PREREAD 0x01 260 #define BUS_DMASYNC_POSTREAD 0x02 261 #define BUS_DMASYNC_PREWRITE 0x04 262 #define BUS_DMASYNC_POSTWRITE 0x08 263 264 typedef struct dreamcast_bus_dma_tag *bus_dma_tag_t; 265 typedef struct dreamcast_bus_dmamap *bus_dmamap_t; 266 267 #define BUS_DMA_TAG_VALID(t) ((t) != (bus_dma_tag_t)0) 268 269 /* 270 * bus_dma_segment_t 271 * 272 * Describes a single contiguous DMA transaction. Values 273 * are suitable for programming into DMA registers. 274 */ 275 struct dreamcast_bus_dma_segment { 276 bus_addr_t ds_addr; /* DMA address */ 277 bus_size_t ds_len; /* length of transfer */ 278 }; 279 typedef struct dreamcast_bus_dma_segment bus_dma_segment_t; 280 281 /* 282 * bus_dma_tag_t 283 * 284 * A machine-dependent opaque type describing the implementation of 285 * DMA for a given bus. 286 */ 287 288 struct dreamcast_bus_dma_tag { 289 void *_cookie; /* cookie used in the guts */ 290 291 /* 292 * DMA mapping methods. 293 */ 294 int (*_dmamap_create)(bus_dma_tag_t, bus_size_t, int, 295 bus_size_t, bus_size_t, int, bus_dmamap_t *); 296 void (*_dmamap_destroy)(bus_dma_tag_t, bus_dmamap_t); 297 int (*_dmamap_load)(bus_dma_tag_t, bus_dmamap_t, void *, 298 bus_size_t, struct proc *, int); 299 int (*_dmamap_load_mbuf)(bus_dma_tag_t, bus_dmamap_t, 300 struct mbuf *, int); 301 int (*_dmamap_load_uio)(bus_dma_tag_t, bus_dmamap_t, 302 struct uio *, int); 303 int (*_dmamap_load_raw)(bus_dma_tag_t, bus_dmamap_t, 304 bus_dma_segment_t *, int, bus_size_t, int); 305 void (*_dmamap_unload)(bus_dma_tag_t, bus_dmamap_t); 306 void (*_dmamap_sync)(bus_dma_tag_t, bus_dmamap_t, 307 bus_addr_t, bus_size_t, int); 308 309 /* 310 * DMA memory utility functions. 311 */ 312 int (*_dmamem_alloc)(bus_dma_tag_t, bus_size_t, bus_size_t, 313 bus_size_t, bus_dma_segment_t *, int, int *, int); 314 void (*_dmamem_free)(bus_dma_tag_t, 315 bus_dma_segment_t *, int); 316 int (*_dmamem_map)(bus_dma_tag_t, bus_dma_segment_t *, 317 int, size_t, void **, int); 318 void (*_dmamem_unmap)(bus_dma_tag_t, void *, size_t); 319 paddr_t (*_dmamem_mmap)(bus_dma_tag_t, bus_dma_segment_t *, 320 int, off_t, int, int); 321 }; 322 323 /* 324 * bus_dmamap_t 325 * 326 * Describes a DMA mapping. 327 */ 328 struct dreamcast_bus_dmamap { 329 /* 330 * PRIVATE MEMBERS: not for use my machine-independent code. 331 */ 332 bus_size_t _dm_size; /* largest DMA transfer mappable */ 333 int _dm_segcnt; /* number of segs this map can map */ 334 bus_size_t _dm_maxmaxsegsz; /* fixed largest possible segment */ 335 bus_size_t _dm_boundary; /* don't cross this */ 336 int _dm_flags; /* misc. flags */ 337 338 void *_dm_cookie; /* cookie for bus-specific functions */ 339 340 /* 341 * PUBLIC MEMBERS: these are used by machine-independent code. 342 */ 343 int dm_nsegs; /* # valid segments in mapping */ 344 bus_dma_segment_t dm_segs[1]; /* segments; variable length */ 345 bus_size_t dm_mapsize; /* size of the mapping */ 346 bus_size_t dm_maxsegsz; /* largest possible segment */ 347 }; 348 349 #endif /* _DREAMCAST_BUS_DEFS_H_ */ 350
Indexes created Tue Sep 30 17:09:57 GMT 2025