1/* $NetBSD: bus_defs.h,v 1.3 2024/01/28 09:03:22 macallan 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 */ 40typedef u_long bus_addr_t; 41typedef u_long bus_size_t; 42 43#define PRIxBUSADDR "lx" 44#define PRIxBUSSIZE "lx" 45#define PRIuBUSSIZE "lu" 46 47typedef u_long bus_space_handle_t; 48 49#define PRIxBSH "lx" 50 51struct hppa_bus_space_tag { 52 void *hbt_cookie; 53 54 int (*hbt_map)(void *v, bus_addr_t addr, bus_size_t size, 55 int flags, bus_space_handle_t *bshp); 56 void (*hbt_unmap)(void *v, bus_space_handle_t bsh, 57 bus_size_t size); 58 int (*hbt_subregion)(void *v, bus_space_handle_t bsh, 59 bus_size_t offset, bus_size_t size, 60 bus_space_handle_t *nbshp); 61 int (*hbt_alloc)(void *v, bus_addr_t rstart, bus_addr_t rend, 62 bus_size_t size, bus_size_t align, 63 bus_size_t boundary, int flags, 64 bus_addr_t *addrp, bus_space_handle_t *bshp); 65 void (*hbt_free)(void *, bus_space_handle_t, bus_size_t); 66 void (*hbt_barrier)(void *v, bus_space_handle_t h, 67 bus_size_t o, bus_size_t l, int op); 68 void *(*hbt_vaddr)(void *, bus_space_handle_t); 69 paddr_t (*hbt_mmap)(void *, bus_addr_t, off_t, int, int); 70 71 uint8_t (*hbt_r1)(void *, bus_space_handle_t, bus_size_t); 72 uint16_t (*hbt_r2)(void *, bus_space_handle_t, bus_size_t); 73 uint32_t (*hbt_r4)(void *, bus_space_handle_t, bus_size_t); 74 uint64_t (*hbt_r8)(void *, bus_space_handle_t, bus_size_t); 75 76 uint16_t (*hbt_rs2)(void *, bus_space_handle_t, bus_size_t); 77 uint32_t (*hbt_rs4)(void *, bus_space_handle_t, bus_size_t); 78 uint64_t (*hbt_rs8)(void *, bus_space_handle_t, bus_size_t); 79 80 void (*hbt_w1)(void *, bus_space_handle_t, bus_size_t, uint8_t); 81 void (*hbt_w2)(void *, bus_space_handle_t, bus_size_t, uint16_t); 82 void (*hbt_w4)(void *, bus_space_handle_t, bus_size_t, uint32_t); 83 void (*hbt_w8)(void *, bus_space_handle_t, bus_size_t, uint64_t); 84 85 void (*hbt_ws2)(void *, bus_space_handle_t, bus_size_t, uint16_t); 86 void (*hbt_ws4)(void *, bus_space_handle_t, bus_size_t, uint32_t); 87 void (*hbt_ws8)(void *, bus_space_handle_t, bus_size_t, uint64_t); 88 89 void (*hbt_rm_1)(void *v, bus_space_handle_t h, 90 bus_size_t o, uint8_t *a, bus_size_t c); 91 void (*hbt_rm_2)(void *v, bus_space_handle_t h, 92 bus_size_t o, uint16_t *a, bus_size_t c); 93 void (*hbt_rm_4)(void *v, bus_space_handle_t h, 94 bus_size_t o, uint32_t *a, bus_size_t c); 95 void (*hbt_rm_8)(void *v, bus_space_handle_t h, 96 bus_size_t o, uint64_t *a, bus_size_t c); 97 98 void (*hbt_wm_1)(void *v, bus_space_handle_t h, bus_size_t o, 99 const uint8_t *a, bus_size_t c); 100 void (*hbt_wm_2)(void *v, bus_space_handle_t h, bus_size_t o, 101 const uint16_t *a, bus_size_t c); 102 void (*hbt_wm_4)(void *v, bus_space_handle_t h, bus_size_t o, 103 const uint32_t *a, bus_size_t c); 104 void (*hbt_wm_8)(void *v, bus_space_handle_t h, bus_size_t o, 105 const uint64_t *a, bus_size_t c); 106 107 void (*hbt_sm_1)(void *v, bus_space_handle_t h, bus_size_t o, 108 uint8_t vv, bus_size_t c); 109 void (*hbt_sm_2)(void *v, bus_space_handle_t h, bus_size_t o, 110 uint16_t vv, bus_size_t c); 111 void (*hbt_sm_4)(void *v, bus_space_handle_t h, bus_size_t o, 112 uint32_t vv, bus_size_t c); 113 void (*hbt_sm_8)(void *v, bus_space_handle_t h, bus_size_t o, 114 uint64_t vv, bus_size_t c); 115 116 void (*hbt_rrm_2)(void *v, bus_space_handle_t h, 117 bus_size_t o, uint16_t *a, bus_size_t c); 118 void (*hbt_rrm_4)(void *v, bus_space_handle_t h, 119 bus_size_t o, uint32_t *a, bus_size_t c); 120 void (*hbt_rrm_8)(void *v, bus_space_handle_t h, 121 bus_size_t o, uint64_t *a, bus_size_t c); 122 123 void (*hbt_wrm_2)(void *v, bus_space_handle_t h, 124 bus_size_t o, const uint16_t *a, bus_size_t c); 125 void (*hbt_wrm_4)(void *v, bus_space_handle_t h, 126 bus_size_t o, const uint32_t *a, bus_size_t c); 127 void (*hbt_wrm_8)(void *v, bus_space_handle_t h, 128 bus_size_t o, const uint64_t *a, bus_size_t c); 129 130 void (*hbt_rr_1)(void *v, bus_space_handle_t h, 131 bus_size_t o, uint8_t *a, bus_size_t c); 132 void (*hbt_rr_2)(void *v, bus_space_handle_t h, 133 bus_size_t o, uint16_t *a, bus_size_t c); 134 void (*hbt_rr_4)(void *v, bus_space_handle_t h, 135 bus_size_t o, uint32_t *a, bus_size_t c); 136 void (*hbt_rr_8)(void *v, bus_space_handle_t h, 137 bus_size_t o, uint64_t *a, bus_size_t c); 138 139 void (*hbt_wr_1)(void *v, bus_space_handle_t h, 140 bus_size_t o, const uint8_t *a, bus_size_t c); 141 void (*hbt_wr_2)(void *v, bus_space_handle_t h, 142 bus_size_t o, const uint16_t *a, bus_size_t c); 143 void (*hbt_wr_4)(void *v, bus_space_handle_t h, 144 bus_size_t o, const uint32_t *a, bus_size_t c); 145 void (*hbt_wr_8)(void *v, bus_space_handle_t h, 146 bus_size_t o, const uint64_t *a, bus_size_t c); 147 148 void (*hbt_rrr_2)(void *v, bus_space_handle_t h, 149 bus_size_t o, uint16_t *a, bus_size_t c); 150 void (*hbt_rrr_4)(void *v, bus_space_handle_t h, 151 bus_size_t o, uint32_t *a, bus_size_t c); 152 void (*hbt_rrr_8)(void *v, bus_space_handle_t h, 153 bus_size_t o, uint64_t *a, bus_size_t c); 154 155 void (*hbt_wrr_2)(void *v, bus_space_handle_t h, 156 bus_size_t o, const uint16_t *a, bus_size_t c); 157 void (*hbt_wrr_4)(void *v, bus_space_handle_t h, 158 bus_size_t o, const uint32_t *a, bus_size_t c); 159 void (*hbt_wrr_8)(void *v, bus_space_handle_t h, 160 bus_size_t o, const uint64_t *a, bus_size_t c); 161 162 void (*hbt_sr_1)(void *v, bus_space_handle_t h, 163 bus_size_t o, uint8_t vv, bus_size_t c); 164 void (*hbt_sr_2)(void *v, bus_space_handle_t h, 165 bus_size_t o, uint16_t vv, bus_size_t c); 166 void (*hbt_sr_4)(void *v, bus_space_handle_t h, 167 bus_size_t o, uint32_t vv, bus_size_t c); 168 void (*hbt_sr_8)(void *v, bus_space_handle_t h, 169 bus_size_t o, uint64_t vv, bus_size_t c); 170 171 void (*hbt_cp_1)(void *v, bus_space_handle_t h1, bus_size_t o1, 172 bus_space_handle_t h2, bus_size_t o2, bus_size_t c); 173 void (*hbt_cp_2)(void *v, bus_space_handle_t h1, bus_size_t o1, 174 bus_space_handle_t h2, bus_size_t o2, bus_size_t c); 175 void (*hbt_cp_4)(void *v, bus_space_handle_t h1, bus_size_t o1, 176 bus_space_handle_t h2, bus_size_t o2, bus_size_t c); 177 void (*hbt_cp_8)(void *v, bus_space_handle_t h1, bus_size_t o1, 178 bus_space_handle_t h2, bus_size_t o2, bus_size_t c); 179}; 180typedef const struct hppa_bus_space_tag *bus_space_tag_t; 181 182/* flags for bus space map functions */ 183#define BUS_SPACE_MAP_READONLY 0x0008 184#define BUS_SPACE_MAP_NOEXTENT 0x8000 /* no extent ops */ 185 186 187/* bus access routines */ 188#define BUS_SPACE_ALIGNED_POINTER(p, t) ALIGNED_POINTER(p, t) 189 190/* XXX fredette */ 191#define __BUS_SPACE_HAS_STREAM_METHODS 192 193#define BUS_DMA_WAITOK 0x000 /* safe to sleep (pseudo-flag) */ 194#define BUS_DMA_NOWAIT 0x001 /* not safe to sleep */ 195#define BUS_DMA_ALLOCNOW 0x002 /* perform resource allocation now */ 196#define BUS_DMA_COHERENT 0x004 /* hint: map memory DMA coherent */ 197#define BUS_DMA_STREAMING 0x008 /* hint: sequential, unidirectional */ 198#define BUS_DMA_BUS1 0x010 /* placeholders for bus functions... */ 199#define BUS_DMA_BUS2 0x020 200#define BUS_DMA_BUS3 0x040 201#define BUS_DMA_BUS4 0x080 202#define BUS_DMA_READ 0x100 /* mapping is device -> memory only */ 203#define BUS_DMA_WRITE 0x200 /* mapping is memory -> device only */ 204#define BUS_DMA_NOCACHE 0x400 /* hint: map non-cached memory */ 205 206/* For devices that have a 24-bit address space */ 207#define BUS_DMA_24BIT BUS_DMA_BUS1 208 209/* Forwards needed by prototypes below. */ 210struct mbuf; 211struct proc; 212struct uio; 213 214typedef const struct hppa_bus_dma_tag *bus_dma_tag_t; 215typedef struct hppa_bus_dmamap *bus_dmamap_t; 216 217#define BUS_DMA_TAG_VALID(t) ((t) != (bus_dma_tag_t)0) 218 219/* 220 * bus_dma_segment_t 221 * 222 * Describes a single contiguous DMA transaction. Values 223 * are suitable for programming into DMA registers. 224 */ 225struct hppa_bus_dma_segment { 226 bus_addr_t ds_addr; /* DMA address */ 227 bus_size_t ds_len; /* length of transfer */ 228 void *_ds_mlist; /* page list when dmamem_alloc'ed */ 229 vaddr_t _ds_va; /* VA when dmamem_map'ed */ 230}; 231typedef struct hppa_bus_dma_segment bus_dma_segment_t; 232 233/* 234 * bus_dma_tag_t 235 * 236 * A machine-dependent opaque type describing the implementation of 237 * DMA for a given bus. 238 */ 239 240struct hppa_bus_dma_tag { 241 void *_cookie; /* cookie used in the guts */ 242 243 /* 244 * DMA mapping methods. 245 */ 246 int (*_dmamap_create)(void *, bus_size_t, int, 247 bus_size_t, bus_size_t, int, bus_dmamap_t *); 248 void (*_dmamap_destroy)(void *, bus_dmamap_t); 249 int (*_dmamap_load)(void *, bus_dmamap_t, void *, 250 bus_size_t, struct proc *, int); 251 int (*_dmamap_load_mbuf)(void *, bus_dmamap_t, 252 struct mbuf *, int); 253 int (*_dmamap_load_uio)(void *, bus_dmamap_t, 254 struct uio *, int); 255 int (*_dmamap_load_raw)(void *, bus_dmamap_t, 256 bus_dma_segment_t *, int, bus_size_t, int); 257 void (*_dmamap_unload)(void *, bus_dmamap_t); 258 void (*_dmamap_sync)(void *, bus_dmamap_t, bus_addr_t, bus_size_t, int); 259 260 /* 261 * DMA memory utility functions. 262 */ 263 int (*_dmamem_alloc)(void *, bus_size_t, bus_size_t, 264 bus_size_t, bus_dma_segment_t *, int, int *, int); 265 void (*_dmamem_free)(void *, bus_dma_segment_t *, int); 266 int (*_dmamem_map)(void *, bus_dma_segment_t *, 267 int, size_t, void **, int); 268 void (*_dmamem_unmap)(void *, void *, size_t); 269 paddr_t (*_dmamem_mmap)(void *, bus_dma_segment_t *, 270 int, off_t, int, int); 271}; 272 273/* 274 * bus_dmamap_t 275 * 276 * Describes a DMA mapping. 277 */ 278struct hppa_bus_dmamap { 279 /* 280 * PRIVATE MEMBERS: not for use by machine-independent code. 281 */ 282 bus_size_t _dm_size; /* largest DMA transfer mappable */ 283 int _dm_segcnt; /* number of segs this map can map */ 284 bus_size_t _dm_maxsegsz; /* fixed largest possible segment */ 285 bus_size_t _dm_boundary; /* don't cross this */ 286 int _dm_flags; /* misc. flags */ 287 288 void *_dm_cookie; /* cookie for bus-specific functions */ 289 290 /* 291 * PUBLIC MEMBERS: these are used by machine-independent code. 292 */ 293 bus_size_t dm_maxsegsz; /* largest possible segment */ 294 bus_size_t dm_mapsize; /* size of the mapping */ 295 int dm_nsegs; /* # valid segments in mapping */ 296 bus_dma_segment_t dm_segs[1]; /* segments; variable length */ 297}; 298 299#endif /* _MACHINE_BUS_DEFS_H_ */ 300