1 /* $NetBSD: bus_defs.h,v 1.1 2014/08/10 05:47:38 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 _AARCH64_BUS_DEFS_H_ 98 #define _AARCH64_BUS_DEFS_H_ 99 100 #ifdef __aarch64__ 101 102 /* 103 * Bus access types. 104 */ 105 typedef uintptr_t bus_addr_t; 106 typedef uintptr_t bus_size_t; 107 108 typedef uintptr_t bus_space_handle_t; 109 typedef const struct aarch64_bus_space *bus_space_tag_t; 110 111 struct extent; 112 113 struct aarch64_bus_space_scalar { 114 uint8_t (*pbss_read_1)(bus_space_tag_t, bus_space_handle_t, 115 bus_size_t); 116 uint16_t (*pbss_read_2)(bus_space_tag_t, bus_space_handle_t, 117 bus_size_t); 118 uint32_t (*pbss_read_4)(bus_space_tag_t, bus_space_handle_t, 119 bus_size_t); 120 uint64_t (*pbss_read_8)(bus_space_tag_t, bus_space_handle_t, 121 bus_size_t); 122 123 void (*pbss_write_1)(bus_space_tag_t, bus_space_handle_t, bus_size_t, 124 uint8_t); 125 void (*pbss_write_2)(bus_space_tag_t, bus_space_handle_t, bus_size_t, 126 uint16_t); 127 void (*pbss_write_4)(bus_space_tag_t, bus_space_handle_t, bus_size_t, 128 uint32_t); 129 void (*pbss_write_8)(bus_space_tag_t, bus_space_handle_t, bus_size_t, 130 uint64_t); 131 }; 132 133 struct aarch64_bus_space_group { 134 void (*pbsg_read_1)(bus_space_tag_t, bus_space_handle_t, 135 bus_size_t, uint8_t *, size_t); 136 void (*pbsg_read_2)(bus_space_tag_t, bus_space_handle_t, 137 bus_size_t, uint16_t *, size_t); 138 void (*pbsg_read_4)(bus_space_tag_t, bus_space_handle_t, 139 bus_size_t, uint32_t *, size_t); 140 void (*pbsg_read_8)(bus_space_tag_t, bus_space_handle_t, 141 bus_size_t, uint64_t *, size_t); 142 143 void (*pbsg_write_1)(bus_space_tag_t, bus_space_handle_t, 144 bus_size_t, const uint8_t *, size_t); 145 void (*pbsg_write_2)(bus_space_tag_t, bus_space_handle_t, 146 bus_size_t, const uint16_t *, size_t); 147 void (*pbsg_write_4)(bus_space_tag_t, bus_space_handle_t, 148 bus_size_t, const uint32_t *, size_t); 149 void (*pbsg_write_8)(bus_space_tag_t, bus_space_handle_t, 150 bus_size_t, const uint64_t *, size_t); 151 }; 152 153 struct aarch64_bus_space_set { 154 void (*pbss_set_1)(bus_space_tag_t, bus_space_handle_t, 155 bus_size_t, uint8_t, size_t); 156 void (*pbss_set_2)(bus_space_tag_t, bus_space_handle_t, 157 bus_size_t, uint16_t, size_t); 158 void (*pbss_set_4)(bus_space_tag_t, bus_space_handle_t, 159 bus_size_t, uint32_t, size_t); 160 void (*pbss_set_8)(bus_space_tag_t, bus_space_handle_t, 161 bus_size_t, uint64_t, size_t); 162 }; 163 164 struct aarch64_bus_space_copy { 165 void (*pbsc_copy_1)(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_2)(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_4)(bus_space_tag_t, bus_space_handle_t, 170 bus_size_t, bus_space_handle_t, bus_size_t, size_t); 171 void (*pbsc_copy_8)(bus_space_tag_t, bus_space_handle_t, 172 bus_size_t, bus_space_handle_t, bus_size_t, size_t); 173 }; 174 175 struct aarch64_bus_space { 176 int pbs_flags; 177 #define _BUS_SPACE_BIG_ENDIAN 0x00000100 178 #define _BUS_SPACE_LITTLE_ENDIAN 0x00000000 179 #define _BUS_SPACE_IO_TYPE 0x00000200 180 #define _BUS_SPACE_MEM_TYPE 0x00000000 181 #define _BUS_SPACE_STRIDE_MASK 0x0000001f 182 bus_addr_t pbs_offset; /* offset to real start */ 183 bus_addr_t pbs_base; /* extent base */ 184 bus_addr_t pbs_limit; /* extent limit */ 185 struct extent *pbs_extent; 186 187 paddr_t (*pbs_mmap)(bus_space_tag_t, bus_addr_t, off_t, int, int); 188 int (*pbs_map)(bus_space_tag_t, bus_addr_t, bus_size_t, int, 189 bus_space_handle_t *); 190 void (*pbs_unmap)(bus_space_tag_t, bus_space_handle_t, bus_size_t); 191 int (*pbs_alloc)(bus_space_tag_t, bus_addr_t, bus_addr_t, bus_size_t, 192 bus_size_t align, bus_size_t, int, bus_addr_t *, 193 bus_space_handle_t *); 194 void (*pbs_free)(bus_space_tag_t, bus_space_handle_t, bus_size_t); 195 int (*pbs_subregion)(bus_space_tag_t, bus_space_handle_t, bus_size_t, 196 bus_size_t, bus_space_handle_t *); 197 198 struct aarch64_bus_space_scalar pbs_scalar; 199 struct aarch64_bus_space_scalar pbs_scalar_stream; 200 const struct aarch64_bus_space_group *pbs_multi; 201 const struct aarch64_bus_space_group *pbs_multi_stream; 202 const struct aarch64_bus_space_group *pbs_region; 203 const struct aarch64_bus_space_group *pbs_region_stream; 204 const struct aarch64_bus_space_set *pbs_set; 205 const struct aarch64_bus_space_set *pbs_set_stream; 206 const struct aarch64_bus_space_copy *pbs_copy; 207 }; 208 209 #define _BUS_SPACE_STRIDE(t, o) \ 210 ((o) << ((t)->pbs_flags & _BUS_SPACE_STRIDE_MASK)) 211 #define _BUS_SPACE_UNSTRIDE(t, o) \ 212 ((o) >> ((t)->pbs_flags & _BUS_SPACE_STRIDE_MASK)) 213 214 #define BUS_SPACE_MAP_CACHEABLE 0x01 215 #define BUS_SPACE_MAP_LINEAR 0x02 216 #define BUS_SPACE_MAP_PREFETCHABLE 0x04 217 218 int bus_space_init(struct aarch64_bus_space *, const char *, void *, size_t); 219 void bus_space_mallocok(void); 220 221 /* 222 * Access methods for bus resources 223 */ 224 225 #define __BUS_SPACE_HAS_STREAM_METHODS 226 227 #define BUS_SPACE_BARRIER_READ 0x01 /* force read barrier */ 228 #define BUS_SPACE_BARRIER_WRITE 0x02 /* force write barrier */ 229 230 #define BUS_SPACE_ALIGNED_POINTER(p, t) ALIGNED_POINTER(p, t) 231 232 /* 233 * Bus DMA methods. 234 */ 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 /* hint: map memory DMA coherent */ 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 #ifndef BUS_DMA_DONTCACHE 253 #define BUS_DMA_DONTCACHE BUS_DMA_NOCACHE 254 #endif 255 256 /* Forwards needed by prototypes below. */ 257 struct proc; 258 struct mbuf; 259 struct uio; 260 261 /* 262 * Operations performed by bus_dmamap_sync(). 263 */ 264 #define BUS_DMASYNC_PREREAD 0x01 /* pre-read synchronization */ 265 #define BUS_DMASYNC_POSTREAD 0x02 /* post-read synchronization */ 266 #define BUS_DMASYNC_PREWRITE 0x04 /* pre-write synchronization */ 267 #define BUS_DMASYNC_POSTWRITE 0x08 /* post-write synchronization */ 268 269 typedef struct aarch64_bus_dma_tag *bus_dma_tag_t; 270 typedef struct aarch64_bus_dmamap *bus_dmamap_t; 271 272 #define BUS_DMA_TAG_VALID(t) ((t) != (bus_dma_tag_t)0) 273 274 /* 275 * bus_dma_segment_t 276 * 277 * Describes a single contiguous DMA transaction. Values 278 * are suitable for programming into DMA registers. 279 */ 280 struct aarch64_bus_dma_segment { 281 bus_addr_t ds_addr; /* DMA address */ 282 bus_size_t ds_len; /* length of transfer */ 283 }; 284 typedef struct aarch64_bus_dma_segment bus_dma_segment_t; 285 286 /* 287 * bus_dma_tag_t 288 * 289 * A machine-dependent opaque type describing the implementation of 290 * DMA for a given bus. 291 */ 292 293 struct aarch64_bus_dma_tag { 294 /* 295 * The `bounce threshold' is checked while we are loading 296 * the DMA map. If the physical address of the segment 297 * exceeds the threshold, an error will be returned. The 298 * caller can then take whatever action is necessary to 299 * bounce the transfer. If this value is 0, it will be 300 * ignored. 301 */ 302 bus_addr_t _bounce_thresh; 303 304 /* 305 * DMA mapping methods. 306 */ 307 int (*_dmamap_create) (bus_dma_tag_t, bus_size_t, int, 308 bus_size_t, bus_size_t, int, bus_dmamap_t *); 309 void (*_dmamap_destroy) (bus_dma_tag_t, bus_dmamap_t); 310 int (*_dmamap_load) (bus_dma_tag_t, bus_dmamap_t, void *, 311 bus_size_t, struct proc *, int); 312 int (*_dmamap_load_mbuf) (bus_dma_tag_t, bus_dmamap_t, 313 struct mbuf *, int); 314 int (*_dmamap_load_uio) (bus_dma_tag_t, bus_dmamap_t, 315 struct uio *, int); 316 int (*_dmamap_load_raw) (bus_dma_tag_t, bus_dmamap_t, 317 bus_dma_segment_t *, int, bus_size_t, int); 318 void (*_dmamap_unload) (bus_dma_tag_t, bus_dmamap_t); 319 void (*_dmamap_sync) (bus_dma_tag_t, bus_dmamap_t, 320 bus_addr_t, bus_size_t, int); 321 322 /* 323 * DMA memory utility functions. 324 */ 325 int (*_dmamem_alloc) (bus_dma_tag_t, bus_size_t, bus_size_t, 326 bus_size_t, bus_dma_segment_t *, int, int *, int); 327 void (*_dmamem_free) (bus_dma_tag_t, 328 bus_dma_segment_t *, int); 329 int (*_dmamem_map) (bus_dma_tag_t, bus_dma_segment_t *, 330 int, size_t, void **, int); 331 void (*_dmamem_unmap) (bus_dma_tag_t, void *, size_t); 332 paddr_t (*_dmamem_mmap) (bus_dma_tag_t, bus_dma_segment_t *, 333 int, off_t, int, int); 334 335 #ifndef PHYS_TO_BUS_MEM 336 bus_addr_t (*_dma_phys_to_bus_mem)(bus_dma_tag_t, bus_addr_t); 337 #define PHYS_TO_BUS_MEM(t, addr) (*(t)->_dma_phys_to_bus_mem)((t), (addr)) 338 #endif 339 #ifndef BUS_MEM_TO_PHYS 340 bus_addr_t (*_dma_bus_mem_to_phys)(bus_dma_tag_t, bus_addr_t); 341 #define BUS_MEM_TO_PHYS(t, addr) (*(t)->_dma_bus_mem_to_phys)((t), (addr)) 342 #endif 343 }; 344 345 /* 346 * bus_dmamap_t 347 * 348 * Describes a DMA mapping. 349 */ 350 struct aarch64_bus_dmamap { 351 /* 352 * PRIVATE MEMBERS: not for use my machine-independent code. 353 */ 354 bus_size_t _dm_size; /* largest DMA transfer mappable */ 355 int _dm_segcnt; /* number of segs this map can map */ 356 bus_size_t _dm_maxmaxsegsz; /* fixed largest possible segment */ 357 bus_size_t _dm_boundary; /* don't cross this */ 358 bus_addr_t _dm_bounce_thresh; /* bounce threshold; see tag */ 359 int _dm_flags; /* misc. flags */ 360 361 void *_dm_cookie; /* cookie for bus-specific functions */ 362 363 /* 364 * PUBLIC MEMBERS: these are used by machine-independent code. 365 */ 366 bus_size_t dm_maxsegsz; /* largest possible segment */ 367 bus_size_t dm_mapsize; /* size of the mapping */ 368 int dm_nsegs; /* # valid segments in mapping */ 369 bus_dma_segment_t dm_segs[1]; /* segments; variable length */ 370 }; 371 372 #elif defined(__arm__) 373 374 #include <arm/bus_defs.h> 375 376 #endif /* __aarch64__/__arm__ */ 377 378 #endif /* _AARCH64_BUS_DEFS_H_ */ 379