1*b0d28118Sjsg /* $OpenBSD: bus.h,v 1.11 2024/11/18 05:32:39 jsg Exp $ */ 2f24071e5Spatrick /* 3f24071e5Spatrick * Copyright (c) 2003-2004 Opsycon AB Sweden. All rights reserved. 4f24071e5Spatrick * 5f24071e5Spatrick * Redistribution and use in source and binary forms, with or without 6f24071e5Spatrick * modification, are permitted provided that the following conditions 7f24071e5Spatrick * are met: 8f24071e5Spatrick * 1. Redistributions of source code must retain the above copyright 9f24071e5Spatrick * notice, this list of conditions and the following disclaimer. 10f24071e5Spatrick * 2. Redistributions in binary form must reproduce the above copyright 11f24071e5Spatrick * notice, this list of conditions and the following disclaimer in the 12f24071e5Spatrick * documentation and/or other materials provided with the distribution. 13f24071e5Spatrick * 14f24071e5Spatrick * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 15f24071e5Spatrick * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 16f24071e5Spatrick * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 17f24071e5Spatrick * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 18f24071e5Spatrick * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 19f24071e5Spatrick * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 20f24071e5Spatrick * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 21f24071e5Spatrick * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 22f24071e5Spatrick * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 23f24071e5Spatrick * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 24f24071e5Spatrick */ 25f24071e5Spatrick 26f24071e5Spatrick #ifndef _MACHINE_BUS_H_ 27f24071e5Spatrick #define _MACHINE_BUS_H_ 28f24071e5Spatrick 29f24071e5Spatrick #ifdef __STDC__ 30f24071e5Spatrick #define CAT(a,b) a##b 31f24071e5Spatrick #define CAT3(a,b,c) a##b##c 32f24071e5Spatrick #else 33f24071e5Spatrick #define CAT(a,b) a/**/b 34f24071e5Spatrick #define CAT3(a,b,c) a/**/b/**/c 35f24071e5Spatrick #endif 36f24071e5Spatrick 37f24071e5Spatrick /* 38f24071e5Spatrick * Bus access types. 39f24071e5Spatrick */ 40f24071e5Spatrick struct bus_space; 41f24071e5Spatrick typedef u_long bus_addr_t; 42f24071e5Spatrick typedef u_long bus_size_t; 43f24071e5Spatrick typedef u_long bus_space_handle_t; 44f24071e5Spatrick typedef struct bus_space *bus_space_tag_t; 45f24071e5Spatrick typedef struct bus_space bus_space_t; 46f24071e5Spatrick 47f24071e5Spatrick struct bus_space { 48f24071e5Spatrick bus_addr_t bus_base; 49f24071e5Spatrick void *bus_private; 50f24071e5Spatrick u_int8_t (*_space_read_1)(bus_space_tag_t , bus_space_handle_t, 51f24071e5Spatrick bus_size_t); 52f24071e5Spatrick void (*_space_write_1)(bus_space_tag_t , bus_space_handle_t, 53f24071e5Spatrick bus_size_t, u_int8_t); 54f24071e5Spatrick u_int16_t (*_space_read_2)(bus_space_tag_t , bus_space_handle_t, 55f24071e5Spatrick bus_size_t); 56f24071e5Spatrick void (*_space_write_2)(bus_space_tag_t , bus_space_handle_t, 57f24071e5Spatrick bus_size_t, u_int16_t); 58f24071e5Spatrick u_int32_t (*_space_read_4)(bus_space_tag_t , bus_space_handle_t, 59f24071e5Spatrick bus_size_t); 60f24071e5Spatrick void (*_space_write_4)(bus_space_tag_t , bus_space_handle_t, 61f24071e5Spatrick bus_size_t, u_int32_t); 62f24071e5Spatrick u_int64_t (*_space_read_8)(bus_space_tag_t , bus_space_handle_t, 63f24071e5Spatrick bus_size_t); 64f24071e5Spatrick void (*_space_write_8)(bus_space_tag_t , bus_space_handle_t, 65f24071e5Spatrick bus_size_t, u_int64_t); 66f24071e5Spatrick void (*_space_read_raw_2)(bus_space_tag_t, bus_space_handle_t, 67f24071e5Spatrick bus_addr_t, u_int8_t *, bus_size_t); 68f24071e5Spatrick void (*_space_write_raw_2)(bus_space_tag_t, bus_space_handle_t, 69f24071e5Spatrick bus_addr_t, const u_int8_t *, bus_size_t); 70f24071e5Spatrick void (*_space_read_raw_4)(bus_space_tag_t, bus_space_handle_t, 71f24071e5Spatrick bus_addr_t, u_int8_t *, bus_size_t); 72f24071e5Spatrick void (*_space_write_raw_4)(bus_space_tag_t, bus_space_handle_t, 73f24071e5Spatrick bus_addr_t, const u_int8_t *, bus_size_t); 74f24071e5Spatrick void (*_space_read_raw_8)(bus_space_tag_t, bus_space_handle_t, 75f24071e5Spatrick bus_addr_t, u_int8_t *, bus_size_t); 76f24071e5Spatrick void (*_space_write_raw_8)(bus_space_tag_t, bus_space_handle_t, 77f24071e5Spatrick bus_addr_t, const u_int8_t *, bus_size_t); 78f24071e5Spatrick int (*_space_map)(bus_space_tag_t , bus_addr_t, 79f24071e5Spatrick bus_size_t, int, bus_space_handle_t *); 80f24071e5Spatrick void (*_space_unmap)(bus_space_tag_t, bus_space_handle_t, 81f24071e5Spatrick bus_size_t); 82f24071e5Spatrick int (*_space_subregion)(bus_space_tag_t, bus_space_handle_t, 83f24071e5Spatrick bus_size_t, bus_size_t, bus_space_handle_t *); 84f24071e5Spatrick void * (*_space_vaddr)(bus_space_tag_t, bus_space_handle_t); 854e0475b7Skettenis paddr_t (*_space_mmap)(bus_space_tag_t, bus_addr_t, off_t, 864e0475b7Skettenis int, int); 87f24071e5Spatrick }; 88f24071e5Spatrick 89f24071e5Spatrick #define bus_space_read_1(t, h, o) (*(t)->_space_read_1)((t), (h), (o)) 90f24071e5Spatrick #define bus_space_read_2(t, h, o) (*(t)->_space_read_2)((t), (h), (o)) 91f24071e5Spatrick #define bus_space_read_4(t, h, o) (*(t)->_space_read_4)((t), (h), (o)) 92f24071e5Spatrick #define bus_space_read_8(t, h, o) (*(t)->_space_read_8)((t), (h), (o)) 93f24071e5Spatrick 94f24071e5Spatrick #define bus_space_write_1(t, h, o, v) (*(t)->_space_write_1)((t), (h), (o), (v)) 95f24071e5Spatrick #define bus_space_write_2(t, h, o, v) (*(t)->_space_write_2)((t), (h), (o), (v)) 96f24071e5Spatrick #define bus_space_write_4(t, h, o, v) (*(t)->_space_write_4)((t), (h), (o), (v)) 97f24071e5Spatrick #define bus_space_write_8(t, h, o, v) (*(t)->_space_write_8)((t), (h), (o), (v)) 98f24071e5Spatrick 99643fbde1Spatrick #define bus_space_read_raw_2(t, h, o) \ 100643fbde1Spatrick (*(t)->_space_read_2)((t), (h), (o)) 101643fbde1Spatrick #define bus_space_read_raw_4(t, h, o) \ 102643fbde1Spatrick (*(t)->_space_read_4)((t), (h), (o)) 103643fbde1Spatrick #define bus_space_read_raw_8(t, h, o) \ 104643fbde1Spatrick (*(t)->_space_read_8)((t), (h), (o)) 105643fbde1Spatrick 106643fbde1Spatrick #define bus_space_write_raw_2(t, h, o, v) \ 107643fbde1Spatrick (*(t)->_space_write_2)((t), (h), (o), (v)) 108643fbde1Spatrick #define bus_space_write_raw_4(t, h, o, v) \ 109643fbde1Spatrick (*(t)->_space_write_4)((t), (h), (o), (v)) 110643fbde1Spatrick #define bus_space_write_raw_8(t, h, o, v) \ 111643fbde1Spatrick (*(t)->_space_write_8)((t), (h), (o), (v)) 112643fbde1Spatrick 113f24071e5Spatrick #define bus_space_read_raw_multi_2(t, h, a, b, l) \ 114f24071e5Spatrick (*(t)->_space_read_raw_2)((t), (h), (a), (b), (l)) 115f24071e5Spatrick #define bus_space_read_raw_multi_4(t, h, a, b, l) \ 116f24071e5Spatrick (*(t)->_space_read_raw_4)((t), (h), (a), (b), (l)) 117f24071e5Spatrick #define bus_space_read_raw_multi_8(t, h, a, b, l) \ 118f24071e5Spatrick (*(t)->_space_read_raw_8)((t), (h), (a), (b), (l)) 119f24071e5Spatrick 120f24071e5Spatrick #define bus_space_write_raw_multi_2(t, h, a, b, l) \ 121f24071e5Spatrick (*(t)->_space_write_raw_2)((t), (h), (a), (b), (l)) 122f24071e5Spatrick #define bus_space_write_raw_multi_4(t, h, a, b, l) \ 123f24071e5Spatrick (*(t)->_space_write_raw_4)((t), (h), (a), (b), (l)) 124f24071e5Spatrick #define bus_space_write_raw_multi_8(t, h, a, b, l) \ 125f24071e5Spatrick (*(t)->_space_write_raw_8)((t), (h), (a), (b), (l)) 126f24071e5Spatrick 127f24071e5Spatrick #define bus_space_map(t, o, s, c, p) (*(t)->_space_map)((t), (o), (s), (c), (p)) 128f24071e5Spatrick #define bus_space_unmap(t, h, s) (*(t)->_space_unmap)((t), (h), (s)) 129f24071e5Spatrick #define bus_space_subregion(t, h, o, s, p) \ 130f24071e5Spatrick (*(t)->_space_subregion)((t), (h), (o), (s), (p)) 131f24071e5Spatrick 132f24071e5Spatrick #define BUS_SPACE_MAP_CACHEABLE 0x01 133d3dca73fSkettenis #define BUS_SPACE_MAP_POSTED 0x02 134f24071e5Spatrick #define BUS_SPACE_MAP_LINEAR 0x04 135f24071e5Spatrick #define BUS_SPACE_MAP_PREFETCHABLE 0x08 136f24071e5Spatrick 137*b0d28118Sjsg extern bus_space_t arm64_bs_tag; 138*b0d28118Sjsg 139f24071e5Spatrick #define bus_space_vaddr(t, h) (*(t)->_space_vaddr)((t), (h)) 1404e0475b7Skettenis #define bus_space_mmap(t, a, o, p, f) \ 1414e0475b7Skettenis (*(t)->_space_mmap)((t), (a), (o), (p), (f)) 142f24071e5Spatrick 143f24071e5Spatrick /*----------------------------------------------------------------------------*/ 144f24071e5Spatrick #define bus_space_read_multi(n,m) \ 145f24071e5Spatrick static __inline void \ 146f24071e5Spatrick CAT(bus_space_read_multi_,n)(bus_space_tag_t bst, bus_space_handle_t bsh, \ 147f24071e5Spatrick bus_size_t o, CAT3(u_int,m,_t) *x, size_t cnt) \ 148f24071e5Spatrick { \ 149f24071e5Spatrick while (cnt--) \ 150f24071e5Spatrick *x++ = CAT(bus_space_read_,n)(bst, bsh, o); \ 151f24071e5Spatrick } 152f24071e5Spatrick 153f24071e5Spatrick bus_space_read_multi(1,8) 154f24071e5Spatrick bus_space_read_multi(2,16) 155f24071e5Spatrick bus_space_read_multi(4,32) 156f24071e5Spatrick bus_space_read_multi(8,64) 157f24071e5Spatrick 158f24071e5Spatrick /*----------------------------------------------------------------------------*/ 159f24071e5Spatrick #define bus_space_read_region(n,m) \ 160f24071e5Spatrick static __inline void \ 161f24071e5Spatrick CAT(bus_space_read_region_,n)(bus_space_tag_t bst, bus_space_handle_t bsh, \ 162f24071e5Spatrick bus_addr_t ba, CAT3(u_int,m,_t) *x, size_t cnt) \ 163f24071e5Spatrick { \ 16420d3e1cbSkettenis while (cnt--) { \ 16520d3e1cbSkettenis *x++ = CAT(bus_space_read_,n)(bst, bsh, ba); \ 16620d3e1cbSkettenis ba += (n); \ 16720d3e1cbSkettenis } \ 168f24071e5Spatrick } 169f24071e5Spatrick 170f24071e5Spatrick bus_space_read_region(1,8) 171f24071e5Spatrick bus_space_read_region(2,16) 172f24071e5Spatrick bus_space_read_region(4,32) 173f24071e5Spatrick bus_space_read_region(8,64) 174f24071e5Spatrick 175f24071e5Spatrick /*----------------------------------------------------------------------------*/ 176f24071e5Spatrick #define bus_space_read_raw_region(n,m) \ 177f24071e5Spatrick static __inline void \ 178f24071e5Spatrick CAT(bus_space_read_raw_region_,n)(bus_space_tag_t bst, \ 179f24071e5Spatrick bus_space_handle_t bsh, \ 180f24071e5Spatrick bus_addr_t ba, u_int8_t *x, size_t cnt) \ 181f24071e5Spatrick { \ 182f24071e5Spatrick cnt >>= ((n) >> 1); \ 183f24071e5Spatrick while (cnt--) { \ 184f24071e5Spatrick CAT(bus_space_read_raw_multi_,n)(bst, bsh, ba, x, (n)); \ 185f24071e5Spatrick ba += (n); \ 186f24071e5Spatrick x += (n); \ 187f24071e5Spatrick } \ 188f24071e5Spatrick } 189f24071e5Spatrick 190f24071e5Spatrick bus_space_read_raw_region(2,16) 191f24071e5Spatrick bus_space_read_raw_region(4,32) 192f24071e5Spatrick bus_space_read_raw_region(8,64) 193f24071e5Spatrick 194f24071e5Spatrick /*----------------------------------------------------------------------------*/ 195f24071e5Spatrick #define bus_space_write_multi(n,m) \ 196f24071e5Spatrick static __inline void \ 197f24071e5Spatrick CAT(bus_space_write_multi_,n)(bus_space_tag_t bst, bus_space_handle_t bsh, \ 198f24071e5Spatrick bus_size_t o, const CAT3(u_int,m,_t) *x, size_t cnt) \ 199f24071e5Spatrick { \ 20020d3e1cbSkettenis while (cnt--) \ 201f24071e5Spatrick CAT(bus_space_write_,n)(bst, bsh, o, *x++); \ 202f24071e5Spatrick } 203f24071e5Spatrick 204f24071e5Spatrick bus_space_write_multi(1,8) 205f24071e5Spatrick bus_space_write_multi(2,16) 206f24071e5Spatrick bus_space_write_multi(4,32) 207f24071e5Spatrick bus_space_write_multi(8,64) 208f24071e5Spatrick 209f24071e5Spatrick /*----------------------------------------------------------------------------*/ 210f24071e5Spatrick #define bus_space_write_region(n,m) \ 211f24071e5Spatrick static __inline void \ 212f24071e5Spatrick CAT(bus_space_write_region_,n)(bus_space_tag_t bst, bus_space_handle_t bsh, \ 213f24071e5Spatrick bus_addr_t ba, const CAT3(u_int,m,_t) *x, size_t cnt) \ 214f24071e5Spatrick { \ 215f24071e5Spatrick while (cnt--) { \ 216f24071e5Spatrick CAT(bus_space_write_,n)(bst, bsh, ba, *x++); \ 21720d3e1cbSkettenis ba += (n); \ 218f24071e5Spatrick } \ 219f24071e5Spatrick } 220f24071e5Spatrick 221f24071e5Spatrick bus_space_write_region(1,8) 222f24071e5Spatrick bus_space_write_region(2,16) 223f24071e5Spatrick bus_space_write_region(4,32) 224f24071e5Spatrick bus_space_write_region(8,64) 225f24071e5Spatrick 226f24071e5Spatrick /*----------------------------------------------------------------------------*/ 227f24071e5Spatrick #define bus_space_write_raw_region(n,m) \ 228f24071e5Spatrick static __inline void \ 229f24071e5Spatrick CAT(bus_space_write_raw_region_,n)(bus_space_tag_t bst, \ 230f24071e5Spatrick bus_space_handle_t bsh, \ 231f24071e5Spatrick bus_addr_t ba, const u_int8_t *x, size_t cnt) \ 232f24071e5Spatrick { \ 233f24071e5Spatrick cnt >>= ((n) >> 1); \ 234f24071e5Spatrick while (cnt--) { \ 235f24071e5Spatrick CAT(bus_space_write_raw_multi_,n)(bst, bsh, ba, x, (n)); \ 236f24071e5Spatrick ba += (n); \ 237f24071e5Spatrick x += (n); \ 238f24071e5Spatrick } \ 239f24071e5Spatrick } 240f24071e5Spatrick 241f24071e5Spatrick bus_space_write_raw_region(2,16) 242f24071e5Spatrick bus_space_write_raw_region(4,32) 243f24071e5Spatrick bus_space_write_raw_region(8,64) 244f24071e5Spatrick 245f24071e5Spatrick /*----------------------------------------------------------------------------*/ 246f24071e5Spatrick #define bus_space_set_region(n,m) \ 247f24071e5Spatrick static __inline void \ 248f24071e5Spatrick CAT(bus_space_set_region_,n)(bus_space_tag_t bst, bus_space_handle_t bsh, \ 249f24071e5Spatrick bus_addr_t ba, CAT3(u_int,m,_t) x, size_t cnt) \ 250f24071e5Spatrick { \ 251f24071e5Spatrick while (cnt--) { \ 252f24071e5Spatrick CAT(bus_space_write_,n)(bst, bsh, ba, x); \ 25320d3e1cbSkettenis ba += (n); \ 254f24071e5Spatrick } \ 255f24071e5Spatrick } 256f24071e5Spatrick 257f24071e5Spatrick bus_space_set_region(1,8) 258f24071e5Spatrick bus_space_set_region(2,16) 259f24071e5Spatrick bus_space_set_region(4,32) 260f24071e5Spatrick bus_space_set_region(8,64) 261f24071e5Spatrick 262f24071e5Spatrick /*----------------------------------------------------------------------------*/ 263f24071e5Spatrick static __inline void 264f24071e5Spatrick bus_space_copy_1(void *v, bus_space_handle_t h1, bus_size_t o1, 265f24071e5Spatrick bus_space_handle_t h2, bus_size_t o2, bus_size_t c) 266f24071e5Spatrick { 267f24071e5Spatrick char *s = (char *)(h1 + o1); 268f24071e5Spatrick char *d = (char *)(h2 + o2); 269f24071e5Spatrick 270f24071e5Spatrick while (c--) 271f24071e5Spatrick *d++ = *s++; 272f24071e5Spatrick } 273f24071e5Spatrick 274f24071e5Spatrick 275f24071e5Spatrick static __inline void 276f24071e5Spatrick bus_space_copy_2(void *v, bus_space_handle_t h1, bus_size_t o1, 277f24071e5Spatrick bus_space_handle_t h2, bus_size_t o2, bus_size_t c) 278f24071e5Spatrick { 279f24071e5Spatrick short *s = (short *)(h1 + o1); 280f24071e5Spatrick short *d = (short *)(h2 + o2); 281f24071e5Spatrick 282f24071e5Spatrick while (c--) 283f24071e5Spatrick *d++ = *s++; 284f24071e5Spatrick } 285f24071e5Spatrick 286f24071e5Spatrick static __inline void 287f24071e5Spatrick bus_space_copy_4(void *v, bus_space_handle_t h1, bus_size_t o1, 288f24071e5Spatrick bus_space_handle_t h2, bus_size_t o2, bus_size_t c) 289f24071e5Spatrick { 290f24071e5Spatrick int *s = (int *)(h1 + o1); 291f24071e5Spatrick int *d = (int *)(h2 + o2); 292f24071e5Spatrick 293f24071e5Spatrick while (c--) 294f24071e5Spatrick *d++ = *s++; 295f24071e5Spatrick } 296f24071e5Spatrick 297f24071e5Spatrick static __inline void 298f24071e5Spatrick bus_space_copy_8(void *v, bus_space_handle_t h1, bus_size_t o1, 299f24071e5Spatrick bus_space_handle_t h2, bus_size_t o2, bus_size_t c) 300f24071e5Spatrick { 301f24071e5Spatrick int64_t *s = (int64_t *)(h1 + o1); 302f24071e5Spatrick int64_t *d = (int64_t *)(h2 + o2); 303f24071e5Spatrick 304f24071e5Spatrick while (c--) 305f24071e5Spatrick *d++ = *s++; 306f24071e5Spatrick } 307f24071e5Spatrick 308f24071e5Spatrick /*----------------------------------------------------------------------------*/ 309f24071e5Spatrick /* 310f24071e5Spatrick * Bus read/write barrier methods. 311f24071e5Spatrick * 312f24071e5Spatrick * void bus_space_barrier(bus_space_tag_t tag, 313f24071e5Spatrick * bus_space_handle_t bsh, bus_size_t offset, 314f24071e5Spatrick * bus_size_t len, int flags); 315f24071e5Spatrick * 316f24071e5Spatrick */ 317f24071e5Spatrick static inline void 318f24071e5Spatrick bus_space_barrier(bus_space_tag_t t, bus_space_handle_t h, bus_size_t offset, 319f24071e5Spatrick bus_size_t length, int flags) 320f24071e5Spatrick { 321f24071e5Spatrick __asm__ volatile ("dsb sy" ::: "memory"); 322f24071e5Spatrick } 323f24071e5Spatrick #define BUS_SPACE_BARRIER_READ 0x01 /* force read barrier */ 324f24071e5Spatrick #define BUS_SPACE_BARRIER_WRITE 0x02 /* force write barrier */ 325f24071e5Spatrick 326f24071e5Spatrick #define BUS_DMA_WAITOK 0x0000 327f24071e5Spatrick #define BUS_DMA_NOWAIT 0x0001 328f24071e5Spatrick #define BUS_DMA_ALLOCNOW 0x0002 329f24071e5Spatrick #define BUS_DMA_COHERENT 0x0008 330f24071e5Spatrick #define BUS_DMA_BUS1 0x0010 /* placeholders for bus functions... */ 331f24071e5Spatrick #define BUS_DMA_BUS2 0x0020 332f24071e5Spatrick #define BUS_DMA_BUS3 0x0040 333f24071e5Spatrick #define BUS_DMA_BUS4 0x0080 334f24071e5Spatrick #define BUS_DMA_READ 0x0100 /* mapping is device -> memory only */ 335f24071e5Spatrick #define BUS_DMA_WRITE 0x0200 /* mapping is memory -> device only */ 336f24071e5Spatrick #define BUS_DMA_STREAMING 0x0400 /* hint: sequential, unidirectional */ 337f24071e5Spatrick #define BUS_DMA_ZERO 0x0800 /* zero memory in dmamem_alloc */ 338f24071e5Spatrick #define BUS_DMA_NOCACHE 0x1000 339b0002153Sdlg #define BUS_DMA_64BIT 0x2000 /* device handles 64bit dva */ 340b4036ef4Skettenis #define BUS_DMA_FIXED 0x4000 /* place mapping at specified dva */ 341f24071e5Spatrick 342f24071e5Spatrick /* Forwards needed by prototypes below. */ 343f24071e5Spatrick struct mbuf; 344f24071e5Spatrick struct proc; 345f24071e5Spatrick struct uio; 346f24071e5Spatrick 347f24071e5Spatrick #define BUS_DMASYNC_POSTREAD 0x0001 348f24071e5Spatrick #define BUS_DMASYNC_POSTWRITE 0x0002 349f24071e5Spatrick #define BUS_DMASYNC_PREREAD 0x0004 350f24071e5Spatrick #define BUS_DMASYNC_PREWRITE 0x0008 351f24071e5Spatrick 352f24071e5Spatrick typedef struct machine_bus_dma_tag *bus_dma_tag_t; 353f24071e5Spatrick typedef struct machine_bus_dmamap *bus_dmamap_t; 354f24071e5Spatrick 355f24071e5Spatrick /* 356f24071e5Spatrick * bus_dma_segment_t 357f24071e5Spatrick * 358f24071e5Spatrick * Describes a single contiguous DMA transaction. Values 359f24071e5Spatrick * are suitable for programming into DMA registers. 360f24071e5Spatrick */ 361f24071e5Spatrick struct machine_bus_dma_segment { 362f24071e5Spatrick bus_addr_t ds_addr; /* DMA address */ 363f24071e5Spatrick bus_size_t ds_len; /* length of transfer */ 364f24071e5Spatrick 365f24071e5Spatrick paddr_t _ds_paddr; /* CPU address */ 366f24071e5Spatrick vaddr_t _ds_vaddr; /* CPU address */ 367f24071e5Spatrick }; 368f24071e5Spatrick typedef struct machine_bus_dma_segment bus_dma_segment_t; 369f24071e5Spatrick 370f24071e5Spatrick /* 371f24071e5Spatrick * bus_dma_tag_t 372f24071e5Spatrick * 373f24071e5Spatrick * A machine-dependent opaque type describing the implementation of 374f24071e5Spatrick * DMA for a given bus. 375f24071e5Spatrick */ 376f24071e5Spatrick 377f24071e5Spatrick struct machine_bus_dma_tag { 378f24071e5Spatrick void *_cookie; /* cookie used in the guts */ 3792d784deaSpatrick int _flags; /* misc. flags */ 380f24071e5Spatrick 381f24071e5Spatrick /* 382f24071e5Spatrick * DMA mapping methods. 383f24071e5Spatrick */ 384f24071e5Spatrick int (*_dmamap_create)(bus_dma_tag_t , bus_size_t, int, 385f24071e5Spatrick bus_size_t, bus_size_t, int, bus_dmamap_t *); 386f24071e5Spatrick void (*_dmamap_destroy)(bus_dma_tag_t , bus_dmamap_t); 387f24071e5Spatrick int (*_dmamap_load)(bus_dma_tag_t , bus_dmamap_t, void *, 388f24071e5Spatrick bus_size_t, struct proc *, int); 389f24071e5Spatrick int (*_dmamap_load_mbuf)(bus_dma_tag_t , bus_dmamap_t, 390f24071e5Spatrick struct mbuf *, int); 391f24071e5Spatrick int (*_dmamap_load_uio)(bus_dma_tag_t , bus_dmamap_t, 392f24071e5Spatrick struct uio *, int); 393f24071e5Spatrick int (*_dmamap_load_raw)(bus_dma_tag_t , bus_dmamap_t, 394f24071e5Spatrick bus_dma_segment_t *, int, bus_size_t, int); 395f24071e5Spatrick int (*_dmamap_load_buffer)(bus_dma_tag_t, bus_dmamap_t, void *, 396f24071e5Spatrick bus_size_t, struct proc *, int, paddr_t *, int *, int); 397f24071e5Spatrick void (*_dmamap_unload)(bus_dma_tag_t , bus_dmamap_t); 398f24071e5Spatrick void (*_dmamap_sync)(bus_dma_tag_t , bus_dmamap_t, 399f24071e5Spatrick bus_addr_t, bus_size_t, int); 400f24071e5Spatrick 401f24071e5Spatrick /* 402f24071e5Spatrick * DMA memory utility functions. 403f24071e5Spatrick */ 404f24071e5Spatrick int (*_dmamem_alloc)(bus_dma_tag_t, bus_size_t, bus_size_t, 405f24071e5Spatrick bus_size_t, bus_dma_segment_t *, int, int *, int); 406f86ce5abSkettenis int (*_dmamem_alloc_range)(bus_dma_tag_t, bus_size_t, bus_size_t, 407f86ce5abSkettenis bus_size_t, bus_dma_segment_t *, int, int *, int, 408f86ce5abSkettenis bus_addr_t, bus_addr_t); 409f24071e5Spatrick void (*_dmamem_free)(bus_dma_tag_t, bus_dma_segment_t *, int); 410f24071e5Spatrick int (*_dmamem_map)(bus_dma_tag_t, bus_dma_segment_t *, 411f24071e5Spatrick int, size_t, caddr_t *, int); 412f24071e5Spatrick void (*_dmamem_unmap)(bus_dma_tag_t, caddr_t, size_t); 413f24071e5Spatrick paddr_t (*_dmamem_mmap)(bus_dma_tag_t, bus_dma_segment_t *, 414f24071e5Spatrick int, off_t, int, int); 415f24071e5Spatrick 416f24071e5Spatrick /* 417f24071e5Spatrick * internal memory address translation information. 418f24071e5Spatrick */ 419f24071e5Spatrick bus_addr_t _dma_mask; 420f24071e5Spatrick }; 421f24071e5Spatrick 422f24071e5Spatrick #define bus_dmamap_create(t, s, n, m, b, f, p) \ 423f24071e5Spatrick (*(t)->_dmamap_create)((t), (s), (n), (m), (b), (f), (p)) 424f24071e5Spatrick #define bus_dmamap_destroy(t, p) \ 425f24071e5Spatrick (*(t)->_dmamap_destroy)((t), (p)) 426f24071e5Spatrick #define bus_dmamap_load(t, m, b, s, p, f) \ 427f24071e5Spatrick (*(t)->_dmamap_load)((t), (m), (b), (s), (p), (f)) 428f24071e5Spatrick #define bus_dmamap_load_mbuf(t, m, b, f) \ 429f24071e5Spatrick (*(t)->_dmamap_load_mbuf)((t), (m), (b), (f)) 430f24071e5Spatrick #define bus_dmamap_load_uio(t, m, u, f) \ 431f24071e5Spatrick (*(t)->_dmamap_load_uio)((t), (m), (u), (f)) 432f24071e5Spatrick #define bus_dmamap_load_raw(t, m, sg, n, s, f) \ 433f24071e5Spatrick (*(t)->_dmamap_load_raw)((t), (m), (sg), (n), (s), (f)) 434f24071e5Spatrick #define bus_dmamap_unload(t, p) \ 435f24071e5Spatrick (*(t)->_dmamap_unload)((t), (p)) 436f24071e5Spatrick #define bus_dmamap_sync(t, p, a, l, o) \ 437f24071e5Spatrick (void)((t)->_dmamap_sync ? \ 438f24071e5Spatrick (*(t)->_dmamap_sync)((t), (p), (a), (l), (o)) : (void)0) 439f24071e5Spatrick 440f24071e5Spatrick #define bus_dmamem_alloc(t, s, a, b, sg, n, r, f) \ 441f24071e5Spatrick (*(t)->_dmamem_alloc)((t), (s), (a), (b), (sg), (n), (r), (f)) 442f86ce5abSkettenis #define bus_dmamem_alloc_range(t, s, a, b, sg, n, r, f, l, h) \ 443f86ce5abSkettenis (*(t)->_dmamem_alloc_range)((t), (s), (a), (b), (sg), \ 444f86ce5abSkettenis (n), (r), (f), (l), (h)) 445f24071e5Spatrick #define bus_dmamem_free(t, sg, n) \ 446f24071e5Spatrick (*(t)->_dmamem_free)((t), (sg), (n)) 447f24071e5Spatrick #define bus_dmamem_map(t, sg, n, s, k, f) \ 448f24071e5Spatrick (*(t)->_dmamem_map)((t), (sg), (n), (s), (k), (f)) 449f24071e5Spatrick #define bus_dmamem_unmap(t, k, s) \ 450f24071e5Spatrick (*(t)->_dmamem_unmap)((t), (k), (s)) 451f24071e5Spatrick #define bus_dmamem_mmap(t, sg, n, o, p, f) \ 452f24071e5Spatrick (*(t)->_dmamem_mmap)((t), (sg), (n), (o), (p), (f)) 453f24071e5Spatrick 454f24071e5Spatrick int _dmamap_create(bus_dma_tag_t, bus_size_t, int, 455f24071e5Spatrick bus_size_t, bus_size_t, int, bus_dmamap_t *); 456f24071e5Spatrick void _dmamap_destroy(bus_dma_tag_t, bus_dmamap_t); 457f24071e5Spatrick int _dmamap_load(bus_dma_tag_t, bus_dmamap_t, void *, 458f24071e5Spatrick bus_size_t, struct proc *, int); 459f24071e5Spatrick int _dmamap_load_mbuf(bus_dma_tag_t, bus_dmamap_t, struct mbuf *, int); 460f24071e5Spatrick int _dmamap_load_uio(bus_dma_tag_t, bus_dmamap_t, struct uio *, int); 461f24071e5Spatrick int _dmamap_load_raw(bus_dma_tag_t, bus_dmamap_t, 462f24071e5Spatrick bus_dma_segment_t *, int, bus_size_t, int); 463f24071e5Spatrick int _dmamap_load_buffer(bus_dma_tag_t, bus_dmamap_t, void *, 464f24071e5Spatrick bus_size_t, struct proc *, int, paddr_t *, int *, int); 465f24071e5Spatrick void _dmamap_unload(bus_dma_tag_t, bus_dmamap_t); 466f24071e5Spatrick void _dmamap_sync(bus_dma_tag_t, bus_dmamap_t, bus_addr_t, 467f24071e5Spatrick bus_size_t, int); 468f24071e5Spatrick 469f24071e5Spatrick int _dmamem_alloc(bus_dma_tag_t, bus_size_t, bus_size_t, 470f24071e5Spatrick bus_size_t, bus_dma_segment_t *, int, int *, int); 471f24071e5Spatrick void _dmamem_free(bus_dma_tag_t, bus_dma_segment_t *, int); 472f24071e5Spatrick int _dmamem_map(bus_dma_tag_t, bus_dma_segment_t *, 473f24071e5Spatrick int, size_t, caddr_t *, int); 474f24071e5Spatrick void _dmamem_unmap(bus_dma_tag_t, caddr_t, size_t); 475f24071e5Spatrick paddr_t _dmamem_mmap(bus_dma_tag_t, bus_dma_segment_t *, int, off_t, int, int); 476f24071e5Spatrick int _dmamem_alloc_range(bus_dma_tag_t, bus_size_t, bus_size_t, bus_size_t, 477f24071e5Spatrick bus_dma_segment_t *, int, int *, int, paddr_t, paddr_t); 478f24071e5Spatrick 479f24071e5Spatrick /* 480f24071e5Spatrick * bus_dmamap_t 481f24071e5Spatrick * 482f24071e5Spatrick * Describes a DMA mapping. 483f24071e5Spatrick */ 484f24071e5Spatrick struct machine_bus_dmamap { 485f24071e5Spatrick /* 486f24071e5Spatrick * PRIVATE MEMBERS: not for use by machine-independent code. 487f24071e5Spatrick */ 488f24071e5Spatrick bus_size_t _dm_size; /* largest DMA transfer mappable */ 489f24071e5Spatrick int _dm_segcnt; /* number of segs this map can map */ 490f24071e5Spatrick bus_size_t _dm_maxsegsz; /* largest possible segment */ 491f24071e5Spatrick bus_size_t _dm_boundary; /* don't cross this */ 492f24071e5Spatrick int _dm_flags; /* misc. flags */ 493f24071e5Spatrick 494f24071e5Spatrick void *_dm_cookie; /* cookie for bus-specific functions */ 495f24071e5Spatrick 496f24071e5Spatrick /* 497f24071e5Spatrick * PUBLIC MEMBERS: these are used by machine-independent code. 498f24071e5Spatrick */ 499f24071e5Spatrick bus_size_t dm_mapsize; /* size of the mapping */ 500f24071e5Spatrick int dm_nsegs; /* # valid segments in mapping */ 501f24071e5Spatrick bus_dma_segment_t dm_segs[1]; /* segments; variable length */ 502f24071e5Spatrick }; 503f24071e5Spatrick 504f24071e5Spatrick int generic_space_map(bus_space_tag_t, bus_addr_t, bus_size_t, int, 505f24071e5Spatrick bus_space_handle_t *); 506f24071e5Spatrick void generic_space_unmap(bus_space_tag_t, bus_space_handle_t, bus_size_t); 507f24071e5Spatrick int generic_space_region(bus_space_tag_t, bus_space_handle_t, bus_size_t, 508f24071e5Spatrick bus_size_t, bus_space_handle_t *); 509f24071e5Spatrick void *generic_space_vaddr(bus_space_tag_t, bus_space_handle_t); 5104e0475b7Skettenis paddr_t generic_space_mmap(bus_space_tag_t, bus_addr_t, off_t, int, int); 511f24071e5Spatrick uint8_t generic_space_read_1(bus_space_tag_t, bus_space_handle_t, bus_size_t); 512f24071e5Spatrick uint16_t generic_space_read_2(bus_space_tag_t, bus_space_handle_t, bus_size_t); 513f24071e5Spatrick uint32_t generic_space_read_4(bus_space_tag_t, bus_space_handle_t, bus_size_t); 514f24071e5Spatrick uint64_t generic_space_read_8(bus_space_tag_t, bus_space_handle_t, bus_size_t); 515f24071e5Spatrick void generic_space_read_raw_2(bus_space_tag_t, bus_space_handle_t, 516f24071e5Spatrick bus_addr_t, uint8_t *, bus_size_t); 517f24071e5Spatrick void generic_space_write_1(bus_space_tag_t, bus_space_handle_t, bus_size_t, 518f24071e5Spatrick uint8_t); 519f24071e5Spatrick void generic_space_write_2(bus_space_tag_t, bus_space_handle_t, bus_size_t, 520f24071e5Spatrick uint16_t); 521f24071e5Spatrick void generic_space_write_4(bus_space_tag_t, bus_space_handle_t, bus_size_t, 522f24071e5Spatrick uint32_t); 523f24071e5Spatrick void generic_space_write_8(bus_space_tag_t, bus_space_handle_t, bus_size_t, 524f24071e5Spatrick uint64_t); 525f24071e5Spatrick void generic_space_write_raw_2(bus_space_tag_t, bus_space_handle_t, 526f24071e5Spatrick bus_addr_t, const uint8_t *, bus_size_t); 527f24071e5Spatrick void generic_space_read_raw_4(bus_space_tag_t, bus_space_handle_t, 528f24071e5Spatrick bus_addr_t, uint8_t *, bus_size_t); 529f24071e5Spatrick void generic_space_write_raw_4(bus_space_tag_t, bus_space_handle_t, 530f24071e5Spatrick bus_addr_t, const uint8_t *, bus_size_t); 531f24071e5Spatrick void generic_space_read_raw_8(bus_space_tag_t, bus_space_handle_t, 532f24071e5Spatrick bus_addr_t, uint8_t *, bus_size_t); 533f24071e5Spatrick void generic_space_write_raw_8(bus_space_tag_t, bus_space_handle_t, 534f24071e5Spatrick bus_addr_t, const uint8_t *, bus_size_t); 535f24071e5Spatrick 536f24071e5Spatrick #endif /* _MACHINE_BUS_H_ */ 537