bus_defs.h revision 1.1
1 /* $NetBSD: bus_defs.h,v 1.1 2014/09/03 19:34:26 matt Exp $ */ 2 /* $OpenBSD: bus.h,v 1.1 1997/10/13 10:53:42 pefo Exp $ */ 3 4 /*- 5 * Copyright (c) 1996, 1997, 1998 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 Jason R. Thorpe. All rights reserved. 37 * Copyright (c) 1996 Christopher G. Demetriou. All rights reserved. 38 * 39 * Redistribution and use in source and binary forms, with or without 40 * modification, are permitted provided that the following conditions 41 * are met: 42 * 1. Redistributions of source code must retain the above copyright 43 * notice, this list of conditions and the following disclaimer. 44 * 2. Redistributions in binary form must reproduce the above copyright 45 * notice, this list of conditions and the following disclaimer in the 46 * documentation and/or other materials provided with the distribution. 47 * 3. All advertising materials mentioning features or use of this software 48 * must display the following acknowledgement: 49 * This product includes software developed by Christopher G. Demetriou 50 * for the NetBSD Project. 51 * 4. The name of the author may not be used to endorse or promote products 52 * derived from this software without specific prior written permission 53 * 54 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 55 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 56 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 57 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 58 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 59 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 60 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 61 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 62 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 63 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 64 */ 65 66 /* 67 * Copyright (c) 1997 Per Fogelstrom. All rights reserved. 68 * Copyright (c) 1996 Niklas Hallqvist. All rights reserved. 69 * 70 * Redistribution and use in source and binary forms, with or without 71 * modification, are permitted provided that the following conditions 72 * are met: 73 * 1. Redistributions of source code must retain the above copyright 74 * notice, this list of conditions and the following disclaimer. 75 * 2. Redistributions in binary form must reproduce the above copyright 76 * notice, this list of conditions and the following disclaimer in the 77 * documentation and/or other materials provided with the distribution. 78 * 3. All advertising materials mentioning features or use of this software 79 * must display the following acknowledgement: 80 * This product includes software developed by Christopher G. Demetriou 81 * for the NetBSD Project. 82 * 4. The name of the author may not be used to endorse or promote products 83 * derived from this software without specific prior written permission 84 * 85 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 86 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 87 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 88 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 89 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 90 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 91 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 92 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 93 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 94 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 95 */ 96 97 #ifndef _OR1K_BUS_DEFS_H_ 98 #define _OR1K_BUS_DEFS_H_ 99 100 /* 101 * Bus access types. 102 */ 103 typedef uintptr_t bus_addr_t; 104 typedef uintptr_t bus_size_t; 105 106 typedef uintptr_t bus_space_handle_t; 107 typedef const struct or1k_bus_space *bus_space_tag_t; 108 109 struct extent; 110 111 struct or1k_bus_space_scalar { 112 uint8_t (*pbss_read_1)(bus_space_tag_t, bus_space_handle_t, 113 bus_size_t); 114 uint16_t (*pbss_read_2)(bus_space_tag_t, bus_space_handle_t, 115 bus_size_t); 116 uint32_t (*pbss_read_4)(bus_space_tag_t, bus_space_handle_t, 117 bus_size_t); 118 uint64_t (*pbss_read_8)(bus_space_tag_t, bus_space_handle_t, 119 bus_size_t); 120 121 void (*pbss_write_1)(bus_space_tag_t, bus_space_handle_t, bus_size_t, 122 uint8_t); 123 void (*pbss_write_2)(bus_space_tag_t, bus_space_handle_t, bus_size_t, 124 uint16_t); 125 void (*pbss_write_4)(bus_space_tag_t, bus_space_handle_t, bus_size_t, 126 uint32_t); 127 void (*pbss_write_8)(bus_space_tag_t, bus_space_handle_t, bus_size_t, 128 uint64_t); 129 }; 130 131 struct or1k_bus_space_group { 132 void (*pbsg_read_1)(bus_space_tag_t, bus_space_handle_t, 133 bus_size_t, uint8_t *, size_t); 134 void (*pbsg_read_2)(bus_space_tag_t, bus_space_handle_t, 135 bus_size_t, uint16_t *, size_t); 136 void (*pbsg_read_4)(bus_space_tag_t, bus_space_handle_t, 137 bus_size_t, uint32_t *, size_t); 138 void (*pbsg_read_8)(bus_space_tag_t, bus_space_handle_t, 139 bus_size_t, uint64_t *, size_t); 140 141 void (*pbsg_write_1)(bus_space_tag_t, bus_space_handle_t, 142 bus_size_t, const uint8_t *, size_t); 143 void (*pbsg_write_2)(bus_space_tag_t, bus_space_handle_t, 144 bus_size_t, const uint16_t *, size_t); 145 void (*pbsg_write_4)(bus_space_tag_t, bus_space_handle_t, 146 bus_size_t, const uint32_t *, size_t); 147 void (*pbsg_write_8)(bus_space_tag_t, bus_space_handle_t, 148 bus_size_t, const uint64_t *, size_t); 149 }; 150 151 struct or1k_bus_space_set { 152 void (*pbss_set_1)(bus_space_tag_t, bus_space_handle_t, 153 bus_size_t, uint8_t, size_t); 154 void (*pbss_set_2)(bus_space_tag_t, bus_space_handle_t, 155 bus_size_t, uint16_t, size_t); 156 void (*pbss_set_4)(bus_space_tag_t, bus_space_handle_t, 157 bus_size_t, uint32_t, size_t); 158 void (*pbss_set_8)(bus_space_tag_t, bus_space_handle_t, 159 bus_size_t, uint64_t, size_t); 160 }; 161 162 struct or1k_bus_space_copy { 163 void (*pbsc_copy_1)(bus_space_tag_t, bus_space_handle_t, 164 bus_size_t, bus_space_handle_t, bus_size_t, size_t); 165 void (*pbsc_copy_2)(bus_space_tag_t, bus_space_handle_t, 166 bus_size_t, bus_space_handle_t, bus_size_t, size_t); 167 void (*pbsc_copy_4)(bus_space_tag_t, bus_space_handle_t, 168 bus_size_t, bus_space_handle_t, bus_size_t, size_t); 169 void (*pbsc_copy_8)(bus_space_tag_t, bus_space_handle_t, 170 bus_size_t, bus_space_handle_t, bus_size_t, size_t); 171 }; 172 173 struct or1k_bus_space { 174 int pbs_flags; 175 #define _BUS_SPACE_BIG_ENDIAN 0x00000100 176 #define _BUS_SPACE_LITTLE_ENDIAN 0x00000000 177 #define _BUS_SPACE_IO_TYPE 0x00000200 178 #define _BUS_SPACE_MEM_TYPE 0x00000000 179 #define _BUS_SPACE_STRIDE_MASK 0x0000001f 180 bus_addr_t pbs_offset; /* offset to real start */ 181 bus_addr_t pbs_base; /* extent base */ 182 bus_addr_t pbs_limit; /* extent limit */ 183 struct extent *pbs_extent; 184 185 paddr_t (*pbs_mmap)(bus_space_tag_t, bus_addr_t, off_t, int, int); 186 int (*pbs_map)(bus_space_tag_t, bus_addr_t, bus_size_t, int, 187 bus_space_handle_t *); 188 void (*pbs_unmap)(bus_space_tag_t, bus_space_handle_t, bus_size_t); 189 int (*pbs_alloc)(bus_space_tag_t, bus_addr_t, bus_addr_t, bus_size_t, 190 bus_size_t align, bus_size_t, int, bus_addr_t *, 191 bus_space_handle_t *); 192 void (*pbs_free)(bus_space_tag_t, bus_space_handle_t, bus_size_t); 193 int (*pbs_subregion)(bus_space_tag_t, bus_space_handle_t, bus_size_t, 194 bus_size_t, bus_space_handle_t *); 195 196 struct or1k_bus_space_scalar pbs_scalar; 197 struct or1k_bus_space_scalar pbs_scalar_stream; 198 const struct or1k_bus_space_group *pbs_multi; 199 const struct or1k_bus_space_group *pbs_multi_stream; 200 const struct or1k_bus_space_group *pbs_region; 201 const struct or1k_bus_space_group *pbs_region_stream; 202 const struct or1k_bus_space_set *pbs_set; 203 const struct or1k_bus_space_set *pbs_set_stream; 204 const struct or1k_bus_space_copy *pbs_copy; 205 }; 206 207 #define _BUS_SPACE_STRIDE(t, o) \ 208 ((o) << ((t)->pbs_flags & _BUS_SPACE_STRIDE_MASK)) 209 #define _BUS_SPACE_UNSTRIDE(t, o) \ 210 ((o) >> ((t)->pbs_flags & _BUS_SPACE_STRIDE_MASK)) 211 212 #define BUS_SPACE_MAP_CACHEABLE 0x01 213 #define BUS_SPACE_MAP_LINEAR 0x02 214 #define BUS_SPACE_MAP_PREFETCHABLE 0x04 215 216 int bus_space_init(struct or1k_bus_space *, const char *, void *, size_t); 217 void bus_space_mallocok(void); 218 219 /* 220 * Access methods for bus resources 221 */ 222 223 #define __BUS_SPACE_HAS_STREAM_METHODS 224 225 #define BUS_SPACE_BARRIER_READ 0x01 /* force read barrier */ 226 #define BUS_SPACE_BARRIER_WRITE 0x02 /* force write barrier */ 227 228 #define BUS_SPACE_ALIGNED_POINTER(p, t) ALIGNED_POINTER(p, t) 229 230 /* 231 * Bus DMA methods. 232 */ 233 234 /* 235 * Flags used in various bus DMA methods. 236 */ 237 #define BUS_DMA_WAITOK 0x000 /* safe to sleep (pseudo-flag) */ 238 #define BUS_DMA_NOWAIT 0x001 /* not safe to sleep */ 239 #define BUS_DMA_ALLOCNOW 0x002 /* perform resource allocation now */ 240 #define BUS_DMA_COHERENT 0x004 /* hint: map memory DMA coherent */ 241 #define BUS_DMA_STREAMING 0x008 /* hint: sequential, unidirectional */ 242 #define BUS_DMA_BUS1 0x010 /* placeholders for bus functions... */ 243 #define BUS_DMA_BUS2 0x020 244 #define BUS_DMA_BUS3 0x040 245 #define BUS_DMA_BUS4 0x080 246 #define BUS_DMA_READ 0x100 /* mapping is device -> memory only */ 247 #define BUS_DMA_WRITE 0x200 /* mapping is memory -> device only */ 248 #define BUS_DMA_NOCACHE 0x400 /* hint: map non-cached memory */ 249 250 #ifndef BUS_DMA_DONTCACHE 251 #define BUS_DMA_DONTCACHE BUS_DMA_NOCACHE 252 #endif 253 254 /* Forwards needed by prototypes below. */ 255 struct proc; 256 struct mbuf; 257 struct uio; 258 259 /* 260 * Operations performed by bus_dmamap_sync(). 261 */ 262 #define BUS_DMASYNC_PREREAD 0x01 /* pre-read synchronization */ 263 #define BUS_DMASYNC_POSTREAD 0x02 /* post-read synchronization */ 264 #define BUS_DMASYNC_PREWRITE 0x04 /* pre-write synchronization */ 265 #define BUS_DMASYNC_POSTWRITE 0x08 /* post-write synchronization */ 266 267 typedef struct or1k_bus_dma_tag *bus_dma_tag_t; 268 typedef struct or1k_bus_dmamap *bus_dmamap_t; 269 270 #define BUS_DMA_TAG_VALID(t) ((t) != (bus_dma_tag_t)0) 271 272 /* 273 * bus_dma_segment_t 274 * 275 * Describes a single contiguous DMA transaction. Values 276 * are suitable for programming into DMA registers. 277 */ 278 struct or1k_bus_dma_segment { 279 bus_addr_t ds_addr; /* DMA address */ 280 bus_size_t ds_len; /* length of transfer */ 281 }; 282 typedef struct or1k_bus_dma_segment bus_dma_segment_t; 283 284 /* 285 * bus_dma_tag_t 286 * 287 * A machine-dependent opaque type describing the implementation of 288 * DMA for a given bus. 289 */ 290 291 struct or1k_bus_dma_tag { 292 /* 293 * The `bounce threshold' is checked while we are loading 294 * the DMA map. If the physical address of the segment 295 * exceeds the threshold, an error will be returned. The 296 * caller can then take whatever action is necessary to 297 * bounce the transfer. If this value is 0, it will be 298 * ignored. 299 */ 300 bus_addr_t _bounce_thresh; 301 302 /* 303 * DMA mapping methods. 304 */ 305 int (*_dmamap_create) (bus_dma_tag_t, bus_size_t, int, 306 bus_size_t, bus_size_t, int, bus_dmamap_t *); 307 void (*_dmamap_destroy) (bus_dma_tag_t, bus_dmamap_t); 308 int (*_dmamap_load) (bus_dma_tag_t, bus_dmamap_t, void *, 309 bus_size_t, struct proc *, int); 310 int (*_dmamap_load_mbuf) (bus_dma_tag_t, bus_dmamap_t, 311 struct mbuf *, int); 312 int (*_dmamap_load_uio) (bus_dma_tag_t, bus_dmamap_t, 313 struct uio *, int); 314 int (*_dmamap_load_raw) (bus_dma_tag_t, bus_dmamap_t, 315 bus_dma_segment_t *, int, bus_size_t, int); 316 void (*_dmamap_unload) (bus_dma_tag_t, bus_dmamap_t); 317 void (*_dmamap_sync) (bus_dma_tag_t, bus_dmamap_t, 318 bus_addr_t, bus_size_t, int); 319 320 /* 321 * DMA memory utility functions. 322 */ 323 int (*_dmamem_alloc) (bus_dma_tag_t, bus_size_t, bus_size_t, 324 bus_size_t, bus_dma_segment_t *, int, int *, int); 325 void (*_dmamem_free) (bus_dma_tag_t, 326 bus_dma_segment_t *, int); 327 int (*_dmamem_map) (bus_dma_tag_t, bus_dma_segment_t *, 328 int, size_t, void **, int); 329 void (*_dmamem_unmap) (bus_dma_tag_t, void *, size_t); 330 paddr_t (*_dmamem_mmap) (bus_dma_tag_t, bus_dma_segment_t *, 331 int, off_t, int, int); 332 333 #ifndef PHYS_TO_BUS_MEM 334 bus_addr_t (*_dma_phys_to_bus_mem)(bus_dma_tag_t, bus_addr_t); 335 #define PHYS_TO_BUS_MEM(t, addr) (*(t)->_dma_phys_to_bus_mem)((t), (addr)) 336 #endif 337 #ifndef BUS_MEM_TO_PHYS 338 bus_addr_t (*_dma_bus_mem_to_phys)(bus_dma_tag_t, bus_addr_t); 339 #define BUS_MEM_TO_PHYS(t, addr) (*(t)->_dma_bus_mem_to_phys)((t), (addr)) 340 #endif 341 }; 342 343 /* 344 * bus_dmamap_t 345 * 346 * Describes a DMA mapping. 347 */ 348 struct or1k_bus_dmamap { 349 /* 350 * PRIVATE MEMBERS: not for use my machine-independent code. 351 */ 352 bus_size_t _dm_size; /* largest DMA transfer mappable */ 353 int _dm_segcnt; /* number of segs this map can map */ 354 bus_size_t _dm_maxmaxsegsz; /* fixed largest possible segment */ 355 bus_size_t _dm_boundary; /* don't cross this */ 356 bus_addr_t _dm_bounce_thresh; /* bounce threshold; see tag */ 357 int _dm_flags; /* misc. flags */ 358 359 void *_dm_cookie; /* cookie for bus-specific functions */ 360 361 /* 362 * PUBLIC MEMBERS: these are used by machine-independent code. 363 */ 364 bus_size_t dm_maxsegsz; /* largest possible segment */ 365 bus_size_t dm_mapsize; /* size of the mapping */ 366 int dm_nsegs; /* # valid segments in mapping */ 367 bus_dma_segment_t dm_segs[1]; /* segments; variable length */ 368 }; 369 370 #endif /* _OR1K_BUS_DEFS_H_ */ 371
Indexes created Mon Sep 29 21:09:56 GMT 2025