bus.h revision 1.7
1 /* $NetBSD: bus.h,v 1.7 2015/06/23 21:00:23 matt Exp $ */ 2 3 /*- 4 * Copyright (c) 1997, 1998, 2000, 2001, 2005 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 _EWS4800MIPS_BUS_H_ 61 #define _EWS4800MIPS_BUS_H_ 62 63 #include <sys/types.h> 64 #ifdef _KERNEL 65 /* 66 * Turn on BUS_SPACE_DEBUG if the global DEBUG option is enabled. 67 */ 68 #if defined(DEBUG) && !defined(BUS_SPACE_DEBUG) 69 #define BUS_SPACE_DEBUG 70 #endif 71 72 #ifdef BUS_SPACE_DEBUG 73 #include <sys/systm.h> /* for printf() prototype */ 74 /* 75 * Macros for checking the aligned-ness of pointers passed to bus 76 * space ops. Strict alignment is required by the MIPS architecture, 77 * and a trap will occur if unaligned access is performed. These 78 * may aid in the debugging of a broken device driver by displaying 79 * useful information about the problem. 80 */ 81 #define __BUS_SPACE_ALIGNED_ADDRESS(p, t) \ 82 ((((uint32_t)(p)) & (sizeof(t)-1)) == 0) 83 84 #define __BUS_SPACE_ADDRESS_SANITY(p, t, d) \ 85 ({ \ 86 if (__BUS_SPACE_ALIGNED_ADDRESS((p), t) == 0) { \ 87 printf("%s 0x%x not aligned to %u bytes %s:%d\n", \ 88 d, (uint32_t)(p), (uint32_t)sizeof(t), __FILE__, \ 89 __LINE__); \ 90 } \ 91 (void) 0; \ 92 }) 93 94 #define BUS_SPACE_ALIGNED_POINTER(p, t) __BUS_SPACE_ALIGNED_ADDRESS(p, t) 95 #else 96 #define __BUS_SPACE_ADDRESS_SANITY(p, t, d) (void) 0 97 #define BUS_SPACE_ALIGNED_POINTER(p, t) ALIGNED_POINTER(p, t) 98 #endif /* BUS_SPACE_DEBUG */ 99 #endif /* _KERNEL */ 100 101 /* 102 * Addresses (in bus space). 103 */ 104 typedef long bus_addr_t; 105 typedef long bus_size_t; 106 107 /* 108 * Access methods for bus space. 109 */ 110 typedef struct ews4800mips_bus_space *bus_space_tag_t; 111 typedef bus_addr_t bus_space_handle_t; 112 113 struct extent; /* forward declaration */ 114 115 struct ews4800mips_bus_space { 116 struct extent *ebs_extent; 117 bus_addr_t ebs_base_addr; 118 bus_size_t ebs_size; 119 120 /* cookie */ 121 void *ebs_cookie; 122 123 /* mapping/unmapping */ 124 int (*ebs_map)(void *, bus_addr_t, bus_size_t, 125 int, bus_space_handle_t *); 126 void (*ebs_unmap)(void *, bus_space_handle_t, 127 bus_size_t); 128 int (*ebs_subregion)(void *, bus_space_handle_t, 129 bus_size_t, bus_size_t, bus_space_handle_t *); 130 131 /* allocation/deallocation */ 132 int (*ebs_alloc)(void *, bus_addr_t, bus_addr_t, 133 bus_size_t, bus_size_t, bus_size_t, int, 134 bus_addr_t *, bus_space_handle_t *); 135 void (*ebs_free)(void *, bus_space_handle_t, 136 bus_size_t); 137 138 /* get kernel virtual address */ 139 void * (*ebs_vaddr)(void *, bus_space_handle_t); 140 141 /* read (single) */ 142 uint8_t (*ebs_r_1)(void *, bus_space_handle_t, 143 bus_size_t); 144 uint16_t (*ebs_r_2)(void *, bus_space_handle_t, 145 bus_size_t); 146 uint32_t (*ebs_r_4)(void *, bus_space_handle_t, 147 bus_size_t); 148 uint64_t (*ebs_r_8)(void *, bus_space_handle_t, 149 bus_size_t); 150 151 /* read multiple */ 152 void (*ebs_rm_1)(void *, bus_space_handle_t, 153 bus_size_t, uint8_t *, bus_size_t); 154 void (*ebs_rm_2)(void *, bus_space_handle_t, 155 bus_size_t, uint16_t *, bus_size_t); 156 void (*ebs_rm_4)(void *, bus_space_handle_t, 157 bus_size_t, uint32_t *, bus_size_t); 158 void (*ebs_rm_8)(void *, bus_space_handle_t, 159 bus_size_t, uint64_t *, bus_size_t); 160 161 /* read region */ 162 void (*ebs_rr_1)(void *, bus_space_handle_t, 163 bus_size_t, uint8_t *, bus_size_t); 164 void (*ebs_rr_2)(void *, bus_space_handle_t, 165 bus_size_t, uint16_t *, bus_size_t); 166 void (*ebs_rr_4)(void *, bus_space_handle_t, 167 bus_size_t, uint32_t *, bus_size_t); 168 void (*ebs_rr_8)(void *, bus_space_handle_t, 169 bus_size_t, uint64_t *, bus_size_t); 170 171 /* write (single) */ 172 void (*ebs_w_1)(void *, bus_space_handle_t, 173 bus_size_t, uint8_t); 174 void (*ebs_w_2)(void *, bus_space_handle_t, 175 bus_size_t, uint16_t); 176 void (*ebs_w_4)(void *, bus_space_handle_t, 177 bus_size_t, uint32_t); 178 void (*ebs_w_8)(void *, bus_space_handle_t, 179 bus_size_t, uint64_t); 180 181 /* write multiple */ 182 void (*ebs_wm_1)(void *, bus_space_handle_t, 183 bus_size_t, const uint8_t *, bus_size_t); 184 void (*ebs_wm_2)(void *, bus_space_handle_t, 185 bus_size_t, const uint16_t *, bus_size_t); 186 void (*ebs_wm_4)(void *, bus_space_handle_t, 187 bus_size_t, const uint32_t *, bus_size_t); 188 void (*ebs_wm_8)(void *, bus_space_handle_t, 189 bus_size_t, const uint64_t *, bus_size_t); 190 191 /* write region */ 192 void (*ebs_wr_1)(void *, bus_space_handle_t, 193 bus_size_t, const uint8_t *, bus_size_t); 194 void (*ebs_wr_2)(void *, bus_space_handle_t, 195 bus_size_t, const uint16_t *, bus_size_t); 196 void (*ebs_wr_4)(void *, bus_space_handle_t, 197 bus_size_t, const uint32_t *, bus_size_t); 198 void (*ebs_wr_8)(void *, bus_space_handle_t, 199 bus_size_t, const uint64_t *, bus_size_t); 200 201 /* set multiple */ 202 void (*ebs_sm_1)(void *, bus_space_handle_t, 203 bus_size_t, uint8_t, bus_size_t); 204 void (*ebs_sm_2)(void *, bus_space_handle_t, 205 bus_size_t, uint16_t, bus_size_t); 206 void (*ebs_sm_4)(void *, bus_space_handle_t, 207 bus_size_t, uint32_t, bus_size_t); 208 void (*ebs_sm_8)(void *, bus_space_handle_t, 209 bus_size_t, uint64_t, bus_size_t); 210 211 /* set region */ 212 void (*ebs_sr_1)(void *, bus_space_handle_t, 213 bus_size_t, uint8_t, bus_size_t); 214 void (*ebs_sr_2)(void *, bus_space_handle_t, 215 bus_size_t, uint16_t, bus_size_t); 216 void (*ebs_sr_4)(void *, bus_space_handle_t, 217 bus_size_t, uint32_t, bus_size_t); 218 void (*ebs_sr_8)(void *, bus_space_handle_t, 219 bus_size_t, uint64_t, bus_size_t); 220 221 /* copy */ 222 void (*ebs_c_1)(void *, bus_space_handle_t, bus_size_t, 223 bus_space_handle_t, bus_size_t, bus_size_t); 224 void (*ebs_c_2)(void *, bus_space_handle_t, bus_size_t, 225 bus_space_handle_t, bus_size_t, bus_size_t); 226 void (*ebs_c_4)(void *, bus_space_handle_t, bus_size_t, 227 bus_space_handle_t, bus_size_t, bus_size_t); 228 void (*ebs_c_8)(void *, bus_space_handle_t, bus_size_t, 229 bus_space_handle_t, bus_size_t, bus_size_t); 230 }; 231 232 #ifdef _KERNEL 233 #ifdef _EWS4800MIPS_BUS_SPACE_PRIVATE 234 235 #ifndef __read_1 236 #define __read_1(a) (*(volatile uint8_t *)(a)) 237 #endif 238 #ifndef __read_2 239 #define __read_2(a) (*(volatile uint16_t *)(a)) 240 #endif 241 #ifndef __read_4 242 #define __read_4(a) (*(volatile uint32_t *)(a)) 243 #endif 244 #ifndef __read_8 245 #define __read_8(a) (*(volatile uint64_t *)(a)) 246 #endif 247 #define __read_16(a) "error. not yet" 248 249 #ifndef __write_1 250 #define __write_1(a, v) { \ 251 *(volatile uint8_t *)(a) = (v); \ 252 wbflush(); \ 253 } 254 #endif 255 #ifndef __write_2 256 #define __write_2(a, v) { \ 257 *(volatile uint16_t *)(a) = (v); \ 258 wbflush(); \ 259 } 260 #endif 261 #ifndef __write_4 262 #define __write_4(a, v) { \ 263 *(volatile uint32_t *)(a) = (v); \ 264 wbflush(); \ 265 } 266 #endif 267 #ifndef __write_8 268 #define __write_8(a, v) { \ 269 *(volatile uint64_t *)(a) = (v); \ 270 wbflush(); \ 271 } 272 #endif 273 274 #define __TYPENAME(BITS) uint##BITS##_t 275 276 #define _BUS_SPACE_READ(PREFIX, BYTES, BITS) \ 277 static __TYPENAME(BITS) \ 278 PREFIX##_read_##BYTES(void *, bus_space_handle_t, bus_size_t); \ 279 static __TYPENAME(BITS) \ 280 PREFIX##_read_##BYTES(void *tag, bus_space_handle_t bsh, \ 281 bus_size_t offset) \ 282 { \ 283 return __read_##BYTES(VADDR(bsh, offset)); \ 284 } 285 286 #define _BUS_SPACE_READ_MULTI(PREFIX, BYTES, BITS) \ 287 static void \ 288 PREFIX##_read_multi_##BYTES(void *, bus_space_handle_t, bus_size_t, \ 289 __TYPENAME(BITS) *, bus_size_t); \ 290 static void \ 291 PREFIX##_read_multi_##BYTES(void *tag, bus_space_handle_t bsh, \ 292 bus_size_t offset, __TYPENAME(BITS) *addr, bus_size_t count) \ 293 { \ 294 bus_addr_t a = VADDR(bsh, offset); \ 295 while (count--) \ 296 *addr++ = __read_##BYTES(a); \ 297 } 298 299 #define _BUS_SPACE_READ_REGION(PREFIX, BYTES, BITS) \ 300 static void \ 301 PREFIX##_read_region_##BYTES(void *, bus_space_handle_t, bus_size_t, \ 302 __TYPENAME(BITS) *, bus_size_t); \ 303 static void \ 304 PREFIX##_read_region_##BYTES(void *tag, bus_space_handle_t bsh, \ 305 bus_size_t offset, __TYPENAME(BITS) *addr, bus_size_t count) \ 306 { \ 307 while (count--) { \ 308 *addr++ = __read_##BYTES(VADDR(bsh, offset)); \ 309 offset += BYTES; \ 310 } \ 311 } 312 313 #define _BUS_SPACE_WRITE(PREFIX, BYTES, BITS) \ 314 static void \ 315 PREFIX##_write_##BYTES(void *, bus_space_handle_t, bus_size_t, \ 316 __TYPENAME(BITS)); \ 317 static void \ 318 PREFIX##_write_##BYTES(void *tag, bus_space_handle_t bsh, \ 319 bus_size_t offset, __TYPENAME(BITS) value) \ 320 { \ 321 __write_##BYTES(VADDR(bsh, offset), value); \ 322 } 323 324 #define _BUS_SPACE_WRITE_MULTI(PREFIX, BYTES, BITS) \ 325 static void \ 326 PREFIX##_write_multi_##BYTES(void *, bus_space_handle_t, bus_size_t, \ 327 const __TYPENAME(BITS) *, bus_size_t); \ 328 static void \ 329 PREFIX##_write_multi_##BYTES(void *tag, bus_space_handle_t bsh, \ 330 bus_size_t offset, const __TYPENAME(BITS) *addr, bus_size_t count) \ 331 { \ 332 bus_addr_t a = VADDR(bsh, offset); \ 333 while (count--) { \ 334 __write_##BYTES(a, *addr++); \ 335 } \ 336 } 337 338 #define _BUS_SPACE_WRITE_REGION(PREFIX, BYTES, BITS) \ 339 static void \ 340 PREFIX##_write_region_##BYTES(void *, bus_space_handle_t, bus_size_t, \ 341 const __TYPENAME(BITS) *, bus_size_t); \ 342 static void \ 343 PREFIX##_write_region_##BYTES(void *tag, bus_space_handle_t bsh, \ 344 bus_size_t offset, const __TYPENAME(BITS) *addr, bus_size_t count) \ 345 { \ 346 while (count--) { \ 347 __write_##BYTES(VADDR(bsh, offset), *addr++); \ 348 offset += BYTES; \ 349 } \ 350 } 351 352 #define _BUS_SPACE_SET_MULTI(PREFIX, BYTES, BITS) \ 353 static void \ 354 PREFIX##_set_multi_##BYTES(void *, bus_space_handle_t, bus_size_t, \ 355 __TYPENAME(BITS), bus_size_t); \ 356 static void \ 357 PREFIX##_set_multi_##BYTES(void *tag, bus_space_handle_t bsh, \ 358 bus_size_t offset, __TYPENAME(BITS) value, bus_size_t count) \ 359 { \ 360 bus_addr_t a = VADDR(bsh, offset); \ 361 while (count--) { \ 362 __write_##BYTES(a, value); \ 363 } \ 364 } 365 366 #define _BUS_SPACE_SET_REGION(PREFIX, BYTES, BITS) \ 367 static void \ 368 PREFIX##_set_region_##BYTES(void *, bus_space_handle_t, bus_size_t, \ 369 __TYPENAME(BITS), bus_size_t); \ 370 static void \ 371 PREFIX##_set_region_##BYTES(void *tag, bus_space_handle_t bsh, \ 372 bus_size_t offset, __TYPENAME(BITS) value, bus_size_t count) \ 373 { \ 374 while (count--) { \ 375 __write_##BYTES(VADDR(bsh, offset), value); \ 376 offset += BYTES; \ 377 } \ 378 } 379 380 #define _BUS_SPACE_COPY_REGION(PREFIX, BYTES, BITS) \ 381 static void \ 382 PREFIX##_copy_region_##BYTES(void *, bus_space_handle_t, bus_size_t, \ 383 bus_space_handle_t, bus_size_t, bus_size_t); \ 384 static void \ 385 PREFIX##_copy_region_##BYTES(void *t, bus_space_handle_t h1, \ 386 bus_size_t o1, bus_space_handle_t h2, bus_size_t o2, bus_size_t c) \ 387 { \ 388 bus_size_t o; \ 389 if ((h1 + o1) >= (h2 + o2)) { \ 390 /* src after dest: copy forward */ \ 391 for (o = 0; c != 0; c--, o += BYTES) \ 392 __write_##BYTES(VADDR(h2, o2 + o), \ 393 __read_##BYTES(VADDR(h1, o1 + o))); \ 394 } else { \ 395 /* dest after src: copy backwards */ \ 396 for (o = (c - 1) * BYTES; c != 0; c--, o -= BYTES) \ 397 __write_##BYTES(VADDR(h2, o2 + o), \ 398 __read_##BYTES(VADDR(h1, o1 + o))); \ 399 } \ 400 } 401 402 #define _BUS_SPACE_NO_MAP \ 403 (int (*)(void *, bus_addr_t, bus_size_t, int, \ 404 bus_space_handle_t *))_bus_space_invalid_access 405 #define _BUS_SPACE_NO_UNMAP \ 406 (void (*)(void *, bus_space_handle_t, bus_size_t)) \ 407 _bus_space_invalid_access 408 #define _BUS_SPACE_NO_SUBREGION \ 409 (int (*)(void *, bus_space_handle_t, bus_size_t, bus_size_t, \ 410 bus_space_handle_t *))_bus_space_invalid_access 411 #define _BUS_SPACE_NO_ALLOC \ 412 (int (*)(void *, bus_addr_t, bus_addr_t, bus_size_t, bus_size_t,\ 413 bus_size_t, int, bus_addr_t *, bus_space_handle_t *)) \ 414 _bus_space_invalid_access 415 #define _BUS_SPACE_NO_FREE \ 416 (void (*)(void *, bus_space_handle_t, bus_size_t)) \ 417 _bus_space_invalid_access 418 #define _BUS_SPACE_NO_VADDR \ 419 (void *(*)(void *, bus_space_handle_t))_bus_space_invalid_access 420 #define _BUS_SPACE_NO_READ(BYTES, BITS) \ 421 (uint##BITS##_t (*)(void *, bus_space_handle_t, bus_size_t)) \ 422 _bus_space_invalid_access 423 #define _BUS_SPACE_NO_READ_MULTI(BYTES, BITS) \ 424 (void (*)(void *, bus_space_handle_t, bus_size_t, \ 425 uint##BITS##_t *, bus_size_t))_bus_space_invalid_access 426 #define _BUS_SPACE_NO_READ_REGION(BYTES, BITS) \ 427 (void (*)(void *, bus_space_handle_t, bus_size_t, \ 428 uint##BITS##_t *, bus_size_t))_bus_space_invalid_access 429 #define _BUS_SPACE_NO_WRITE(BYTES, BITS) \ 430 (void (*)(void *, bus_space_handle_t, bus_size_t, \ 431 uint##BITS##_t))_bus_space_invalid_access 432 #define _BUS_SPACE_NO_WRITE_MULTI(BYTES, BITS) \ 433 (void (*)(void *, bus_space_handle_t, bus_size_t, \ 434 const uint##BITS##_t *, bus_size_t))_bus_space_invalid_access 435 #define _BUS_SPACE_NO_WRITE_REGION(BYTES, BITS) \ 436 (void (*)(void *, bus_space_handle_t, bus_size_t, \ 437 const uint##BITS##_t *, bus_size_t))_bus_space_invalid_access 438 #define _BUS_SPACE_NO_SET_MULTI(BYTES, BITS) \ 439 (void (*)(void *, bus_space_handle_t, bus_size_t, \ 440 uint##BITS##_t, bus_size_t))_bus_space_invalid_access 441 #define _BUS_SPACE_NO_SET_REGION(BYTES, BITS) \ 442 (void (*)(void *, bus_space_handle_t, bus_size_t, \ 443 uint##BITS##_t, bus_size_t))_bus_space_invalid_access 444 #define _BUS_SPACE_NO_COPY_REGION(BYTES, BITS) \ 445 (void (*)(void *, bus_space_handle_t, bus_size_t, \ 446 bus_space_handle_t, bus_size_t, bus_size_t))_bus_space_invalid_access 447 448 void _bus_space_invalid_access(void); 449 #endif /* _EWS4800MIPS_BUS_SPACE_PRIVATE */ 450 451 #define __ebs_c(a,b) __CONCAT(a,b) 452 #define __ebs_opname(op,size) __ebs_c(__ebs_c(__ebs_c(ebs_,op),_),size) 453 454 #define __ebs_rs(sz, tn, t, h, o) \ 455 (__BUS_SPACE_ADDRESS_SANITY((h) + (o), tn, "bus addr"), \ 456 (*(t)->__ebs_opname(r,sz))((t)->ebs_cookie, h, o)) 457 458 #define __ebs_ws(sz, tn, t, h, o, v) \ 459 ({ \ 460 __BUS_SPACE_ADDRESS_SANITY((h) + (o), tn, "bus addr"); \ 461 (*(t)->__ebs_opname(w,sz))((t)->ebs_cookie, h, o, v); \ 462 }) 463 464 #define __ebs_nonsingle(type, sz, tn, t, h, o, a, c) \ 465 ({ \ 466 __BUS_SPACE_ADDRESS_SANITY((a), tn, "buffer"); \ 467 __BUS_SPACE_ADDRESS_SANITY((h) + (o), tn, "bus addr"); \ 468 (*(t)->__ebs_opname(type,sz))((t)->ebs_cookie, h, o, a, c); \ 469 }) 470 471 #define __ebs_set(type, sz, tn, t, h, o, v, c) \ 472 ({ \ 473 __BUS_SPACE_ADDRESS_SANITY((h) + (o), tn, "bus addr"); \ 474 (*(t)->__ebs_opname(type,sz))((t)->ebs_cookie, h, o, v, c); \ 475 }) 476 477 #define __ebs_copy(sz, tn, t, h1, o1, h2, o2, cnt) \ 478 ({ \ 479 __BUS_SPACE_ADDRESS_SANITY((h1) + (o1), tn, "bus addr 1"); \ 480 __BUS_SPACE_ADDRESS_SANITY((h2) + (o2), tn, "bus addr 2"); \ 481 (*(t)->__ebs_opname(c,sz))((t)->ebs_cookie, h1, o1, h2, o2, cnt); \ 482 }) 483 484 /* 485 * Create/destroy default bus_space tag. 486 */ 487 int bus_space_create(bus_space_tag_t, const char *, bus_addr_t, bus_size_t); 488 void bus_space_destroy(bus_space_tag_t); 489 490 /* 491 * Mapping and unmapping operations. 492 */ 493 #define bus_space_map(t, a, s, f, hp) \ 494 (*(t)->ebs_map)((t)->ebs_cookie, (a), (s), (f), (hp)) 495 #define bus_space_unmap(t, h, s) \ 496 (*(t)->ebs_unmap)((t)->ebs_cookie, (h), (s)) 497 #define bus_space_subregion(t, h, o, s, hp) \ 498 (*(t)->ebs_subregion)((t)->ebs_cookie, (h), (o), (s), (hp)) 499 500 #endif /* _KERNEL */ 501 502 #define BUS_SPACE_MAP_CACHEABLE 0x01 503 #define BUS_SPACE_MAP_LINEAR 0x02 504 #define BUS_SPACE_MAP_PREFETCHABLE 0x04 505 506 #ifdef _KERNEL 507 /* 508 * Allocation and deallocation operations. 509 */ 510 #define bus_space_alloc(t, rs, re, s, a, b, f, ap, hp) \ 511 (*(t)->ebs_alloc)((t)->ebs_cookie, (rs), (re), (s), (a), (b), \ 512 (f), (ap), (hp)) 513 #define bus_space_free(t, h, s) \ 514 (*(t)->ebs_free)((t)->ebs_cookie, (h), (s)) 515 516 /* 517 * Get kernel virtual address for ranges mapped BUS_SPACE_MAP_LINEAR. 518 */ 519 #define bus_space_vaddr(t, h) \ 520 (*(t)->ebs_vaddr)((t)->ebs_cookie, (h)) 521 522 /* 523 * Bus read/write barrier methods. 524 * 525 * void bus_space_barrier(bus_space_tag_t tag, 526 * bus_space_handle_t bsh, bus_size_t offset, 527 * bus_size_t len, int flags); 528 * 529 * On the MIPS, we just flush the write buffer. 530 */ 531 #define bus_space_barrier(t, h, o, l, f) \ 532 ((void)((void)(t), (void)(h), (void)(o), (void)(l), (void)(f), \ 533 wbflush())) 534 #define BUS_SPACE_BARRIER_READ 0x01 535 #define BUS_SPACE_BARRIER_WRITE 0x02 536 537 538 /* 539 * Bus read (single) operations. 540 */ 541 #define bus_space_read_1(t, h, o) __ebs_rs(1,uint8_t,(t),(h),(o)) 542 #define bus_space_read_2(t, h, o) __ebs_rs(2,uint16_t,(t),(h),(o)) 543 #define bus_space_read_4(t, h, o) __ebs_rs(4,uint32_t,(t),(h),(o)) 544 #define bus_space_read_8(t, h, o) __ebs_rs(8,uint64_t,(t),(h),(o)) 545 546 547 /* 548 * Bus read multiple operations. 549 */ 550 #define bus_space_read_multi_1(t, h, o, a, c) \ 551 __ebs_nonsingle(rm,1,uint8_t,(t),(h),(o),(a),(c)) 552 #define bus_space_read_multi_2(t, h, o, a, c) \ 553 __ebs_nonsingle(rm,2,uint16_t,(t),(h),(o),(a),(c)) 554 #define bus_space_read_multi_4(t, h, o, a, c) \ 555 __ebs_nonsingle(rm,4,uint32_t,(t),(h),(o),(a),(c)) 556 #define bus_space_read_multi_8(t, h, o, a, c) \ 557 __ebs_nonsingle(rm,8,uint64_t,(t),(h),(o),(a),(c)) 558 559 560 /* 561 * Bus read region operations. 562 */ 563 #define bus_space_read_region_1(t, h, o, a, c) \ 564 __ebs_nonsingle(rr,1,uint8_t,(t),(h),(o),(a),(c)) 565 #define bus_space_read_region_2(t, h, o, a, c) \ 566 __ebs_nonsingle(rr,2,uint16_t,(t),(h),(o),(a),(c)) 567 #define bus_space_read_region_4(t, h, o, a, c) \ 568 __ebs_nonsingle(rr,4,uint32_t,(t),(h),(o),(a),(c)) 569 #define bus_space_read_region_8(t, h, o, a, c) \ 570 __ebs_nonsingle(rr,8,uint64_t,(t),(h),(o),(a),(c)) 571 572 573 /* 574 * Bus write (single) operations. 575 */ 576 #define bus_space_write_1(t, h, o, v) __ebs_ws(1,uint8_t,(t),(h),(o),(v)) 577 #define bus_space_write_2(t, h, o, v) __ebs_ws(2,uint16_t,(t),(h),(o),(v)) 578 #define bus_space_write_4(t, h, o, v) __ebs_ws(4,uint32_t,(t),(h),(o),(v)) 579 #define bus_space_write_8(t, h, o, v) __ebs_ws(8,uint64_t,(t),(h),(o),(v)) 580 581 582 /* 583 * Bus write multiple operations. 584 */ 585 #define bus_space_write_multi_1(t, h, o, a, c) \ 586 __ebs_nonsingle(wm,1,uint8_t,(t),(h),(o),(a),(c)) 587 #define bus_space_write_multi_2(t, h, o, a, c) \ 588 __ebs_nonsingle(wm,2,uint16_t,(t),(h),(o),(a),(c)) 589 #define bus_space_write_multi_4(t, h, o, a, c) \ 590 __ebs_nonsingle(wm,4,uint32_t,(t),(h),(o),(a),(c)) 591 #define bus_space_write_multi_8(t, h, o, a, c) \ 592 __ebs_nonsingle(wm,8,uint64_t,(t),(h),(o),(a),(c)) 593 594 595 /* 596 * Bus write region operations. 597 */ 598 #define bus_space_write_region_1(t, h, o, a, c) \ 599 __ebs_nonsingle(wr,1,uint8_t,(t),(h),(o),(a),(c)) 600 #define bus_space_write_region_2(t, h, o, a, c) \ 601 __ebs_nonsingle(wr,2,uint16_t,(t),(h),(o),(a),(c)) 602 #define bus_space_write_region_4(t, h, o, a, c) \ 603 __ebs_nonsingle(wr,4,uint32_t,(t),(h),(o),(a),(c)) 604 #define bus_space_write_region_8(t, h, o, a, c) \ 605 __ebs_nonsingle(wr,8,uint64_t,(t),(h),(o),(a),(c)) 606 607 608 /* 609 * Set multiple operations. 610 */ 611 #define bus_space_set_multi_1(t, h, o, v, c) \ 612 __ebs_set(sm,1,uint8_t,(t),(h),(o),(v),(c)) 613 #define bus_space_set_multi_2(t, h, o, v, c) \ 614 __ebs_set(sm,2,uint16_t,(t),(h),(o),(v),(c)) 615 #define bus_space_set_multi_4(t, h, o, v, c) \ 616 __ebs_set(sm,4,uint32_t,(t),(h),(o),(v),(c)) 617 #define bus_space_set_multi_8(t, h, o, v, c) \ 618 __ebs_set(sm,8,uint64_t,(t),(h),(o),(v),(c)) 619 620 621 /* 622 * Set region operations. 623 */ 624 #define bus_space_set_region_1(t, h, o, v, c) \ 625 __ebs_set(sr,1,uint8_t,(t),(h),(o),(v),(c)) 626 #define bus_space_set_region_2(t, h, o, v, c) \ 627 __ebs_set(sr,2,uint16_t,(t),(h),(o),(v),(c)) 628 #define bus_space_set_region_4(t, h, o, v, c) \ 629 __ebs_set(sr,4,uint32_t,(t),(h),(o),(v),(c)) 630 #define bus_space_set_region_8(t, h, o, v, c) \ 631 __ebs_set(sr,8,uint64_t,(t),(h),(o),(v),(c)) 632 633 634 /* 635 * Copy region operations. 636 */ 637 #define bus_space_copy_region_1(t, h1, o1, h2, o2, c) \ 638 __ebs_copy(1, uint8_t, (t), (h1), (o1), (h2), (o2), (c)) 639 #define bus_space_copy_region_2(t, h1, o1, h2, o2, c) \ 640 __ebs_copy(2, uint16_t, (t), (h1), (o1), (h2), (o2), (c)) 641 #define bus_space_copy_region_4(t, h1, o1, h2, o2, c) \ 642 __ebs_copy(4, uint32_t, (t), (h1), (o1), (h2), (o2), (c)) 643 #define bus_space_copy_region_8(t, h1, o1, h2, o2, c) \ 644 __ebs_copy(8, uint64_t, (t), (h1), (o1), (h2), (o2), (c)) 645 646 /* 647 * Bus stream operations--defined in terms of non-stream counterparts 648 */ 649 #define __BUS_SPACE_HAS_STREAM_METHODS 1 650 #define bus_space_read_stream_1 bus_space_read_1 651 #define bus_space_read_stream_2 bus_space_read_2 652 #define bus_space_read_stream_4 bus_space_read_4 653 #define bus_space_read_stream_8 bus_space_read_8 654 #define bus_space_read_multi_stream_1 bus_space_read_multi_1 655 #define bus_space_read_multi_stream_2 bus_space_read_multi_2 656 #define bus_space_read_multi_stream_4 bus_space_read_multi_4 657 #define bus_space_read_multi_stream_8 bus_space_read_multi_8 658 #define bus_space_read_region_stream_1 bus_space_read_region_1 659 #define bus_space_read_region_stream_2 bus_space_read_region_2 660 #define bus_space_read_region_stream_4 bus_space_read_region_4 661 #define bus_space_read_region_stream_8 bus_space_read_region_8 662 #define bus_space_write_stream_1 bus_space_write_1 663 #define bus_space_write_stream_2 bus_space_write_2 664 #define bus_space_write_stream_4 bus_space_write_4 665 #define bus_space_write_stream_8 bus_space_write_8 666 #define bus_space_write_multi_stream_1 bus_space_write_multi_1 667 #define bus_space_write_multi_stream_2 bus_space_write_multi_2 668 #define bus_space_write_multi_stream_4 bus_space_write_multi_4 669 #define bus_space_write_multi_stream_8 bus_space_write_multi_8 670 #define bus_space_write_region_stream_1 bus_space_write_region_1 671 #define bus_space_write_region_stream_2 bus_space_write_region_2 672 #define bus_space_write_region_stream_4 bus_space_write_region_4 673 #define bus_space_write_region_stream_8 bus_space_write_region_8 674 675 #endif /* _KERNEL */ 676 677 /* 678 * Flags used in various bus DMA methods. 679 */ 680 #define BUS_DMA_WAITOK 0x000 /* safe to sleep (pseudo-flag) */ 681 #define BUS_DMA_NOWAIT 0x001 /* not safe to sleep */ 682 #define BUS_DMA_ALLOCNOW 0x002 /* perform resource allocation now */ 683 #define BUS_DMA_COHERENT 0x004 /* hint: map memory DMA coherent */ 684 #define BUS_DMA_STREAMING 0x008 /* hint: sequential, unidirectional */ 685 #define BUS_DMA_BUS1 0x010 /* placeholders for bus functions... */ 686 #define BUS_DMA_BUS2 0x020 687 #define BUS_DMA_BUS3 0x040 688 #define BUS_DMA_BUS4 0x080 689 #define BUS_DMA_READ 0x100 /* mapping is device -> memory only */ 690 #define BUS_DMA_WRITE 0x200 /* mapping is memory -> device only */ 691 #define BUS_DMA_NOCACHE 0x400 /* hint: map non-cached memory */ 692 693 #define EWS4800MIPS_DMAMAP_COHERENT 0x10000 /* no cache flush necessary on sync */ 694 695 /* Forwards needed by prototypes below. */ 696 struct mbuf; 697 struct uio; 698 699 /* 700 * Operations performed by bus_dmamap_sync(). 701 */ 702 #define BUS_DMASYNC_PREREAD 0x01 /* pre-read synchronization */ 703 #define BUS_DMASYNC_POSTREAD 0x02 /* post-read synchronization */ 704 #define BUS_DMASYNC_PREWRITE 0x04 /* pre-write synchronization */ 705 #define BUS_DMASYNC_POSTWRITE 0x08 /* post-write synchronization */ 706 707 typedef struct ews4800mips_bus_dma_tag *bus_dma_tag_t; 708 typedef struct ews4800mips_bus_dmamap *bus_dmamap_t; 709 710 #define BUS_DMA_TAG_VALID(t) ((t) != (bus_dma_tag_t)0) 711 712 /* 713 * bus_dma_segment_t 714 * 715 * Describes a single contiguous DMA transaction. Values 716 * are suitable for programming into DMA registers. 717 */ 718 struct ews4800mips_bus_dma_segment { 719 bus_addr_t ds_addr; /* DMA address */ 720 bus_size_t ds_len; /* length of transfer */ 721 vaddr_t _ds_vaddr; /* virtual address, 0 if invalid */ 722 }; 723 typedef struct ews4800mips_bus_dma_segment bus_dma_segment_t; 724 725 /* 726 * bus_dma_tag_t 727 * 728 * A machine-dependent opaque type describing the implementation of 729 * DMA for a given bus. 730 */ 731 732 struct ews4800mips_bus_dma_tag { 733 /* 734 * DMA mapping methods. 735 */ 736 int (*_dmamap_create)(bus_dma_tag_t, bus_size_t, int, 737 bus_size_t, bus_size_t, int, bus_dmamap_t *); 738 void (*_dmamap_destroy)(bus_dma_tag_t, bus_dmamap_t); 739 int (*_dmamap_load)(bus_dma_tag_t, bus_dmamap_t, void *, 740 bus_size_t, struct proc *, int); 741 int (*_dmamap_load_mbuf)(bus_dma_tag_t, bus_dmamap_t, 742 struct mbuf *, int); 743 int (*_dmamap_load_uio)(bus_dma_tag_t, bus_dmamap_t, 744 struct uio *, int); 745 int (*_dmamap_load_raw)(bus_dma_tag_t, bus_dmamap_t, 746 bus_dma_segment_t *, int, bus_size_t, int); 747 void (*_dmamap_unload)(bus_dma_tag_t, bus_dmamap_t); 748 void (*_dmamap_sync)(bus_dma_tag_t, bus_dmamap_t, 749 bus_addr_t, bus_size_t, int); 750 751 /* 752 * DMA memory utility functions. 753 */ 754 int (*_dmamem_alloc)(bus_dma_tag_t, bus_size_t, bus_size_t, 755 bus_size_t, bus_dma_segment_t *, int, int *, int); 756 void (*_dmamem_free)(bus_dma_tag_t, 757 bus_dma_segment_t *, int); 758 int (*_dmamem_map)(bus_dma_tag_t, bus_dma_segment_t *, 759 int, size_t, void **, int); 760 void (*_dmamem_unmap)(bus_dma_tag_t, void *, size_t); 761 paddr_t (*_dmamem_mmap)(bus_dma_tag_t, bus_dma_segment_t *, 762 int, off_t, int, int); 763 764 /* 765 * DMA controller private. 766 */ 767 void *_dmachip_cookie; 768 }; 769 770 #define bus_dmamap_create(t, s, n, m, b, f, p) \ 771 (*(t)->_dmamap_create)((t), (s), (n), (m), (b), (f), (p)) 772 #define bus_dmamap_destroy(t, p) \ 773 (*(t)->_dmamap_destroy)((t), (p)) 774 #define bus_dmamap_load(t, m, b, s, p, f) \ 775 (*(t)->_dmamap_load)((t), (m), (b), (s), (p), (f)) 776 #define bus_dmamap_load_mbuf(t, m, b, f) \ 777 (*(t)->_dmamap_load_mbuf)((t), (m), (b), (f)) 778 #define bus_dmamap_load_uio(t, m, u, f) \ 779 (*(t)->_dmamap_load_uio)((t), (m), (u), (f)) 780 #define bus_dmamap_load_raw(t, m, sg, n, s, f) \ 781 (*(t)->_dmamap_load_raw)((t), (m), (sg), (n), (s), (f)) 782 #define bus_dmamap_unload(t, p) \ 783 (*(t)->_dmamap_unload)((t), (p)) 784 #define bus_dmamap_sync(t, p, o, l, ops) \ 785 (*(t)->_dmamap_sync)((t), (p), (o), (l), (ops)) 786 787 #define bus_dmamem_alloc(t, s, a, b, sg, n, r, f) \ 788 (*(t)->_dmamem_alloc)((t), (s), (a), (b), (sg), (n), (r), (f)) 789 #define bus_dmamem_free(t, sg, n) \ 790 (*(t)->_dmamem_free)((t), (sg), (n)) 791 #define bus_dmamem_map(t, sg, n, s, k, f) \ 792 (*(t)->_dmamem_map)((t), (sg), (n), (s), (k), (f)) 793 #define bus_dmamem_unmap(t, k, s) \ 794 (*(t)->_dmamem_unmap)((t), (k), (s)) 795 #define bus_dmamem_mmap(t, sg, n, o, p, f) \ 796 (*(t)->_dmamem_mmap)((t), (sg), (n), (o), (p), (f)) 797 798 #define bus_dmatag_subregion(t, mna, mxa, nt, f) EOPNOTSUPP 799 #define bus_dmatag_destroy(t) 800 801 /* 802 * bus_dmamap_t 803 * 804 * Describes a DMA mapping. 805 */ 806 struct ews4800mips_bus_dmamap { 807 /* 808 * PRIVATE MEMBERS: not for use my machine-independent code. 809 */ 810 bus_size_t _dm_size; /* largest DMA transfer mappable */ 811 int _dm_segcnt; /* number of segs this map can map */ 812 bus_size_t _dm_maxmaxsegsz; /* fixed largest possible segment */ 813 bus_size_t _dm_boundary; /* don't cross this */ 814 int _dm_flags; /* misc. flags */ 815 struct vmspace *_dm_vmspace; /* vmspace that owns the mapping */ 816 817 /* 818 * PUBLIC MEMBERS: these are used by machine-independent code. 819 */ 820 bus_size_t dm_maxsegsz; /* largest possible segment */ 821 bus_size_t dm_mapsize; /* size of the mapping */ 822 int dm_nsegs; /* # valid segments in mapping */ 823 bus_dma_segment_t dm_segs[1]; /* segments; variable length */ 824 }; 825 826 #ifdef _EWS4800MIPS_BUS_DMA_PRIVATE 827 int _bus_dmamap_create(bus_dma_tag_t, bus_size_t, int, bus_size_t, 828 bus_size_t, int, bus_dmamap_t *); 829 void _bus_dmamap_destroy(bus_dma_tag_t, bus_dmamap_t); 830 int _bus_dmamap_load(bus_dma_tag_t, bus_dmamap_t, void *, 831 bus_size_t, struct proc *, int); 832 int _bus_dmamap_load_mbuf(bus_dma_tag_t, bus_dmamap_t, 833 struct mbuf *, int); 834 int _bus_dmamap_load_uio(bus_dma_tag_t, bus_dmamap_t, 835 struct uio *, int); 836 int _bus_dmamap_load_raw(bus_dma_tag_t, bus_dmamap_t, 837 bus_dma_segment_t *, int, bus_size_t, int); 838 void _bus_dmamap_unload(bus_dma_tag_t, bus_dmamap_t); 839 void _bus_dmamap_sync(bus_dma_tag_t, bus_dmamap_t, bus_addr_t, 840 bus_size_t, int); 841 842 int _bus_dmamem_alloc(bus_dma_tag_t tag, bus_size_t size, 843 bus_size_t alignment, bus_size_t boundary, 844 bus_dma_segment_t *segs, int nsegs, int *rsegs, int flags); 845 void _bus_dmamem_free(bus_dma_tag_t tag, bus_dma_segment_t *segs, 846 int nsegs); 847 int _bus_dmamem_map(bus_dma_tag_t tag, bus_dma_segment_t *segs, 848 int nsegs, size_t size, void **kvap, int flags); 849 void _bus_dmamem_unmap(bus_dma_tag_t tag, void *kva, 850 size_t size); 851 paddr_t _bus_dmamem_mmap(bus_dma_tag_t tag, bus_dma_segment_t *segs, 852 int nsegs, off_t off, int prot, int flags); 853 854 int _bus_dmamem_alloc_range(bus_dma_tag_t tag, bus_size_t size, 855 bus_size_t alignment, bus_size_t boundary, 856 bus_dma_segment_t *segs, int nsegs, int *rsegs, int flags, 857 vaddr_t low, vaddr_t high); 858 859 extern struct ews4800mips_bus_dma_tag ews4800mips_default_bus_dma_tag; 860 #endif /* _EWS4800MIPS_BUS_DMA_PRIVATE */ 861 862 #endif /* _EWS4800MIPS_BUS_H_ */ 863
Indexes created Wed Oct 22 13:09:56 GMT 2025