sys/mips/include/bus.h

   1 /*      $NetBSD: bus.h,v 1.11 2003/07/28 17:35:54 thorpej Exp $ */
   2
   3 /*-
   4  * SPDX-License-Identifier: BSD-2-Clause-NetBSD AND BSD-4-Clause
   5  *
   6  * Copyright (c) 1996, 1997, 1998, 2001 The NetBSD Foundation, Inc.
   7  * All rights reserved.
   8  *
   9  * This code is derived from software contributed to The NetBSD Foundation
  10  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
  11  * NASA Ames Research Center.
  12  *
  13  * Redistribution and use in source and binary forms, with or without
  14  * modification, are permitted provided that the following conditions
  15  * are met:
  16  * 1. Redistributions of source code must retain the above copyright
  17  *    notice, this list of conditions and the following disclaimer.
  18  * 2. Redistributions in binary form must reproduce the above copyright
  19  *    notice, this list of conditions and the following disclaimer in the
  20  *    documentation and/or other materials provided with the distribution.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  23  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  24  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  25  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  26  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  27  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  30  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  32  * POSSIBILITY OF SUCH DAMAGE.
  33  */
  34
  35 /*-
  36  * Copyright (c) 1996 Charles M. Hannum.  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  * $FreeBSD$
  66  */
  67
  68 #ifndef _MACHINE_BUS_H_
  69 #define _MACHINE_BUS_H_
  70
  71 #include <machine/_bus.h>
  72
  73 struct bus_space {
  74         /* cookie */
  75         void            *bs_cookie;
  76
  77         /* mapping/unmapping */
  78         int             (*bs_map) (void *, bus_addr_t, bus_size_t,
  79                             int, bus_space_handle_t *);
  80         void            (*bs_unmap) (void *, bus_space_handle_t, bus_size_t);
  81         int             (*bs_subregion) (void *, bus_space_handle_t,
  82                             bus_size_t, bus_size_t, bus_space_handle_t *);
  83
  84         /* allocation/deallocation */
  85         int             (*bs_alloc) (void *, bus_addr_t, bus_addr_t,
  86                             bus_size_t, bus_size_t, bus_size_t, int,
  87                             bus_addr_t *, bus_space_handle_t *);
  88         void            (*bs_free) (void *, bus_space_handle_t,
  89                             bus_size_t);
  90
  91         /* get kernel virtual address */
  92         /* barrier */
  93         void            (*bs_barrier) (void *, bus_space_handle_t,
  94                             bus_size_t, bus_size_t, int);
  95
  96         /* read (single) */
  97         u_int8_t        (*bs_r_1) (void *, bus_space_handle_t, bus_size_t);
  98         u_int16_t       (*bs_r_2) (void *, bus_space_handle_t, bus_size_t);
  99         u_int32_t       (*bs_r_4) (void *, bus_space_handle_t, bus_size_t);
 100         u_int64_t       (*bs_r_8) (void *, bus_space_handle_t, bus_size_t);
 101
 102         /* read multiple */
 103         void            (*bs_rm_1) (void *, bus_space_handle_t, bus_size_t,
 104             u_int8_t *, bus_size_t);
 105         void            (*bs_rm_2) (void *, bus_space_handle_t, bus_size_t,
 106             u_int16_t *, bus_size_t);
 107         void            (*bs_rm_4) (void *, bus_space_handle_t,
 108                             bus_size_t, u_int32_t *, bus_size_t);
 109         void            (*bs_rm_8) (void *, bus_space_handle_t,
 110                             bus_size_t, u_int64_t *, bus_size_t);
 111
 112         /* read region */
 113         void            (*bs_rr_1) (void *, bus_space_handle_t,
 114                             bus_size_t, u_int8_t *, bus_size_t);
 115         void            (*bs_rr_2) (void *, bus_space_handle_t,
 116                             bus_size_t, u_int16_t *, bus_size_t);
 117         void            (*bs_rr_4) (void *, bus_space_handle_t,
 118                             bus_size_t, u_int32_t *, bus_size_t);
 119         void            (*bs_rr_8) (void *, bus_space_handle_t,
 120                             bus_size_t, u_int64_t *, bus_size_t);
 121
 122         /* write (single) */
 123         void            (*bs_w_1) (void *, bus_space_handle_t,
 124                             bus_size_t, u_int8_t);
 125         void            (*bs_w_2) (void *, bus_space_handle_t,
 126                             bus_size_t, u_int16_t);
 127         void            (*bs_w_4) (void *, bus_space_handle_t,
 128                             bus_size_t, u_int32_t);
 129         void            (*bs_w_8) (void *, bus_space_handle_t,
 130                             bus_size_t, u_int64_t);
 131
 132         /* write multiple */
 133         void            (*bs_wm_1) (void *, bus_space_handle_t,
 134                             bus_size_t, const u_int8_t *, bus_size_t);
 135         void            (*bs_wm_2) (void *, bus_space_handle_t,
 136                             bus_size_t, const u_int16_t *, bus_size_t);
 137         void            (*bs_wm_4) (void *, bus_space_handle_t,
 138                             bus_size_t, const u_int32_t *, bus_size_t);
 139         void            (*bs_wm_8) (void *, bus_space_handle_t,
 140                             bus_size_t, const u_int64_t *, bus_size_t);
 141
 142         /* write region */
 143         void            (*bs_wr_1) (void *, bus_space_handle_t,
 144                             bus_size_t, const u_int8_t *, bus_size_t);
 145         void            (*bs_wr_2) (void *, bus_space_handle_t,
 146                             bus_size_t, const u_int16_t *, bus_size_t);
 147         void            (*bs_wr_4) (void *, bus_space_handle_t,
 148                             bus_size_t, const u_int32_t *, bus_size_t);
 149         void            (*bs_wr_8) (void *, bus_space_handle_t,
 150                             bus_size_t, const u_int64_t *, bus_size_t);
 151
 152         /* set multiple */
 153         void            (*bs_sm_1) (void *, bus_space_handle_t,
 154                             bus_size_t, u_int8_t, bus_size_t);
 155         void            (*bs_sm_2) (void *, bus_space_handle_t,
 156                             bus_size_t, u_int16_t, bus_size_t);
 157         void            (*bs_sm_4) (void *, bus_space_handle_t,
 158                             bus_size_t, u_int32_t, bus_size_t);
 159         void            (*bs_sm_8) (void *, bus_space_handle_t,
 160                             bus_size_t, u_int64_t, bus_size_t);
 161
 162         /* set region */
 163         void            (*bs_sr_1) (void *, bus_space_handle_t,
 164                             bus_size_t, u_int8_t, bus_size_t);
 165         void            (*bs_sr_2) (void *, bus_space_handle_t,
 166                             bus_size_t, u_int16_t, bus_size_t);
 167         void            (*bs_sr_4) (void *, bus_space_handle_t,
 168                             bus_size_t, u_int32_t, bus_size_t);
 169         void            (*bs_sr_8) (void *, bus_space_handle_t,
 170                             bus_size_t, u_int64_t, bus_size_t);
 171
 172         /* copy */
 173         void            (*bs_c_1) (void *, bus_space_handle_t, bus_size_t,
 174                             bus_space_handle_t, bus_size_t, bus_size_t);
 175         void            (*bs_c_2) (void *, bus_space_handle_t, bus_size_t,
 176                             bus_space_handle_t, bus_size_t, bus_size_t);
 177         void            (*bs_c_4) (void *, bus_space_handle_t, bus_size_t,
 178                             bus_space_handle_t, bus_size_t, bus_size_t);
 179         void            (*bs_c_8) (void *, bus_space_handle_t, bus_size_t,
 180                             bus_space_handle_t, bus_size_t, bus_size_t);
 181
 182         /* read stream (single) */
 183         u_int8_t        (*bs_r_1_s) (void *, bus_space_handle_t, bus_size_t);
 184         u_int16_t       (*bs_r_2_s) (void *, bus_space_handle_t, bus_size_t);
 185         u_int32_t       (*bs_r_4_s) (void *, bus_space_handle_t, bus_size_t);
 186         u_int64_t       (*bs_r_8_s) (void *, bus_space_handle_t, bus_size_t);
 187
 188         /* read multiple stream */
 189         void            (*bs_rm_1_s) (void *, bus_space_handle_t, bus_size_t,
 190             u_int8_t *, bus_size_t);
 191         void            (*bs_rm_2_s) (void *, bus_space_handle_t, bus_size_t,
 192             u_int16_t *, bus_size_t);
 193         void            (*bs_rm_4_s) (void *, bus_space_handle_t,
 194                             bus_size_t, u_int32_t *, bus_size_t);
 195         void            (*bs_rm_8_s) (void *, bus_space_handle_t,
 196                             bus_size_t, u_int64_t *, bus_size_t);
 197
 198         /* read region stream */
 199         void            (*bs_rr_1_s) (void *, bus_space_handle_t,
 200                             bus_size_t, u_int8_t *, bus_size_t);
 201         void            (*bs_rr_2_s) (void *, bus_space_handle_t,
 202                             bus_size_t, u_int16_t *, bus_size_t);
 203         void            (*bs_rr_4_s) (void *, bus_space_handle_t,
 204                             bus_size_t, u_int32_t *, bus_size_t);
 205         void            (*bs_rr_8_s) (void *, bus_space_handle_t,
 206                             bus_size_t, u_int64_t *, bus_size_t);
 207
 208         /* write stream (single) */
 209         void            (*bs_w_1_s) (void *, bus_space_handle_t,
 210                             bus_size_t, u_int8_t);
 211         void            (*bs_w_2_s) (void *, bus_space_handle_t,
 212                             bus_size_t, u_int16_t);
 213         void            (*bs_w_4_s) (void *, bus_space_handle_t,
 214                             bus_size_t, u_int32_t);
 215         void            (*bs_w_8_s) (void *, bus_space_handle_t,
 216                             bus_size_t, u_int64_t);
 217
 218         /* write multiple stream */
 219         void            (*bs_wm_1_s) (void *, bus_space_handle_t,
 220                             bus_size_t, const u_int8_t *, bus_size_t);
 221         void            (*bs_wm_2_s) (void *, bus_space_handle_t,
 222                             bus_size_t, const u_int16_t *, bus_size_t);
 223         void            (*bs_wm_4_s) (void *, bus_space_handle_t,
 224                             bus_size_t, const u_int32_t *, bus_size_t);
 225         void            (*bs_wm_8_s) (void *, bus_space_handle_t,
 226                             bus_size_t, const u_int64_t *, bus_size_t);
 227
 228         /* write region stream */
 229         void            (*bs_wr_1_s) (void *, bus_space_handle_t,
 230                             bus_size_t, const u_int8_t *, bus_size_t);
 231         void            (*bs_wr_2_s) (void *, bus_space_handle_t,
 232                             bus_size_t, const u_int16_t *, bus_size_t);
 233         void            (*bs_wr_4_s) (void *, bus_space_handle_t,
 234                             bus_size_t, const u_int32_t *, bus_size_t);
 235         void            (*bs_wr_8_s) (void *, bus_space_handle_t,
 236                             bus_size_t, const u_int64_t *, bus_size_t);
 237 };
 238
 239 /*
 240  * Utility macros; INTERNAL USE ONLY.
 241  */
 242 #define __bs_c(a,b)             __CONCAT(a,b)
 243 #define __bs_opname(op,size)    __bs_c(__bs_c(__bs_c(bs_,op),_),size)
 244
 245 #define __bs_rs(sz, t, h, o)                                            \
 246         (*(t)->__bs_opname(r,sz))((t)->bs_cookie, h, o)
 247 #define __bs_ws(sz, t, h, o, v)                                         \
 248         (*(t)->__bs_opname(w,sz))((t)->bs_cookie, h, o, v)
 249 #define __bs_nonsingle(type, sz, t, h, o, a, c)                         \
 250         (*(t)->__bs_opname(type,sz))((t)->bs_cookie, h, o, a, c)
 251 #define __bs_set(type, sz, t, h, o, v, c)                               \
 252         (*(t)->__bs_opname(type,sz))((t)->bs_cookie, h, o, v, c)
 253 #define __bs_copy(sz, t, h1, o1, h2, o2, cnt)                           \
 254         (*(t)->__bs_opname(c,sz))((t)->bs_cookie, h1, o1, h2, o2, cnt)
 255
 256 #define __bs_opname_s(op,size)  __bs_c(__bs_c(__bs_c(__bs_c(bs_,op),_),size),_s)
 257 #define __bs_rs_s(sz, t, h, o)                                          \
 258         (*(t)->__bs_opname_s(r,sz))((t)->bs_cookie, h, o)
 259 #define __bs_ws_s(sz, t, h, o, v)                                       \
 260         (*(t)->__bs_opname_s(w,sz))((t)->bs_cookie, h, o, v)
 261 #define __bs_nonsingle_s(type, sz, t, h, o, a, c)                       \
 262         (*(t)->__bs_opname_s(type,sz))((t)->bs_cookie, h, o, a, c)
 263
 264 /*
 265  * Mapping and unmapping operations.
 266  */
 267 #define bus_space_map(t, a, s, c, hp)                                   \
 268         (*(t)->bs_map)((t)->bs_cookie, (a), (s), (c), (hp))
 269 #define bus_space_unmap(t, h, s)                                        \
 270         (*(t)->bs_unmap)((t)->bs_cookie, (h), (s))
 271 #define bus_space_subregion(t, h, o, s, hp)                             \
 272         (*(t)->bs_subregion)((t)->bs_cookie, (h), (o), (s), (hp))
 273
 274 /*
 275  * Allocation and deallocation operations.
 276  */
 277 #define bus_space_alloc(t, rs, re, s, a, b, c, ap, hp)                  \
 278         (*(t)->bs_alloc)((t)->bs_cookie, (rs), (re), (s), (a), (b),     \
 279             (c), (ap), (hp))
 280 #define bus_space_free(t, h, s)                                         \
 281         (*(t)->bs_free)((t)->bs_cookie, (h), (s))
 282
 283 /*
 284  * Bus barrier operations.
 285  */
 286 #define bus_space_barrier(t, h, o, l, f)                                \
 287         (*(t)->bs_barrier)((t)->bs_cookie, (h), (o), (l), (f))
 288
 289 #define BUS_SPACE_BARRIER_READ  0x01
 290 #define BUS_SPACE_BARRIER_WRITE 0x02
 291
 292 /*
 293  * Bus read (single) operations.
 294  */
 295 #define bus_space_read_1(t, h, o)       __bs_rs(1,(t),(h),(o))
 296 #define bus_space_read_2(t, h, o)       __bs_rs(2,(t),(h),(o))
 297 #define bus_space_read_4(t, h, o)       __bs_rs(4,(t),(h),(o))
 298 #define bus_space_read_8(t, h, o)       __bs_rs(8,(t),(h),(o))
 299
 300 #define bus_space_read_stream_1(t, h, o)        __bs_rs_s(1,(t), (h), (o))
 301 #define bus_space_read_stream_2(t, h, o)        __bs_rs_s(2,(t), (h), (o))
 302 #define bus_space_read_stream_4(t, h, o)        __bs_rs_s(4,(t), (h), (o))
 303 #define bus_space_read_stream_8(t, h, o)        __bs_rs_s(8,8,(t),(h),(o))
 304
 305 /*
 306  * Bus read multiple operations.
 307  */
 308 #define bus_space_read_multi_1(t, h, o, a, c)                           \
 309         __bs_nonsingle(rm,1,(t),(h),(o),(a),(c))
 310 #define bus_space_read_multi_2(t, h, o, a, c)                           \
 311         __bs_nonsingle(rm,2,(t),(h),(o),(a),(c))
 312 #define bus_space_read_multi_4(t, h, o, a, c)                           \
 313         __bs_nonsingle(rm,4,(t),(h),(o),(a),(c))
 314 #define bus_space_read_multi_8(t, h, o, a, c)                           \
 315         __bs_nonsingle(rm,8,(t),(h),(o),(a),(c))
 316
 317 #define bus_space_read_multi_stream_1(t, h, o, a, c)                    \
 318         __bs_nonsingle_s(rm,1,(t),(h),(o),(a),(c))
 319 #define bus_space_read_multi_stream_2(t, h, o, a, c)                    \
 320         __bs_nonsingle_s(rm,2,(t),(h),(o),(a),(c))
 321 #define bus_space_read_multi_stream_4(t, h, o, a, c)                    \
 322         __bs_nonsingle_s(rm,4,(t),(h),(o),(a),(c))
 323 #define bus_space_read_multi_stream_8(t, h, o, a, c)                    \
 324         __bs_nonsingle_s(rm,8,(t),(h),(o),(a),(c))
 325
 326 /*
 327  * Bus read region operations.
 328  */
 329 #define bus_space_read_region_1(t, h, o, a, c)                          \
 330         __bs_nonsingle(rr,1,(t),(h),(o),(a),(c))
 331 #define bus_space_read_region_2(t, h, o, a, c)                          \
 332         __bs_nonsingle(rr,2,(t),(h),(o),(a),(c))
 333 #define bus_space_read_region_4(t, h, o, a, c)                          \
 334         __bs_nonsingle(rr,4,(t),(h),(o),(a),(c))
 335 #define bus_space_read_region_8(t, h, o, a, c)                          \
 336         __bs_nonsingle(rr,8,(t),(h),(o),(a),(c))
 337
 338 #define bus_space_read_region_stream_1(t, h, o, a, c)                   \
 339         __bs_nonsingle_s(rr,1,(t),(h),(o),(a),(c))
 340 #define bus_space_read_region_stream_2(t, h, o, a, c)                   \
 341         __bs_nonsingle_s(rr,2,(t),(h),(o),(a),(c))
 342 #define bus_space_read_region_stream_4(t, h, o, a, c)                   \
 343         __bs_nonsingle_s(rr,4,(t),(h),(o),(a),(c))
 344 #define bus_space_read_region_stream_8(t, h, o, a, c)                   \
 345         __bs_nonsingle_s(rr,8,(t),(h),(o),(a),(c))
 346
 347 /*
 348  * Bus write (single) operations.
 349  */
 350 #define bus_space_write_1(t, h, o, v)   __bs_ws(1,(t),(h),(o),(v))
 351 #define bus_space_write_2(t, h, o, v)   __bs_ws(2,(t),(h),(o),(v))
 352 #define bus_space_write_4(t, h, o, v)   __bs_ws(4,(t),(h),(o),(v))
 353 #define bus_space_write_8(t, h, o, v)   __bs_ws(8,(t),(h),(o),(v))
 354
 355 #define bus_space_write_stream_1(t, h, o, v)    __bs_ws_s(1,(t),(h),(o),(v))
 356 #define bus_space_write_stream_2(t, h, o, v)    __bs_ws_s(2,(t),(h),(o),(v))
 357 #define bus_space_write_stream_4(t, h, o, v)    __bs_ws_s(4,(t),(h),(o),(v))
 358 #define bus_space_write_stream_8(t, h, o, v)    __bs_ws_s(8,(t),(h),(o),(v))
 359
 360 /*
 361  * Bus write multiple operations.
 362  */
 363 #define bus_space_write_multi_1(t, h, o, a, c)                          \
 364         __bs_nonsingle(wm,1,(t),(h),(o),(a),(c))
 365 #define bus_space_write_multi_2(t, h, o, a, c)                          \
 366         __bs_nonsingle(wm,2,(t),(h),(o),(a),(c))
 367 #define bus_space_write_multi_4(t, h, o, a, c)                          \
 368         __bs_nonsingle(wm,4,(t),(h),(o),(a),(c))
 369 #define bus_space_write_multi_8(t, h, o, a, c)                          \
 370         __bs_nonsingle(wm,8,(t),(h),(o),(a),(c))
 371
 372 #define bus_space_write_multi_stream_1(t, h, o, a, c)                   \
 373         __bs_nonsingle_s(wm,1,(t),(h),(o),(a),(c))
 374 #define bus_space_write_multi_stream_2(t, h, o, a, c)                   \
 375         __bs_nonsingle_s(wm,2,(t),(h),(o),(a),(c))
 376 #define bus_space_write_multi_stream_4(t, h, o, a, c)                   \
 377         __bs_nonsingle_s(wm,4,(t),(h),(o),(a),(c))
 378 #define bus_space_write_multi_stream_8(t, h, o, a, c)                   \
 379         __bs_nonsingle_s(wm,8,(t),(h),(o),(a),(c))
 380
 381 /*
 382  * Bus write region operations.
 383  */
 384 #define bus_space_write_region_1(t, h, o, a, c)                         \
 385         __bs_nonsingle(wr,1,(t),(h),(o),(a),(c))
 386 #define bus_space_write_region_2(t, h, o, a, c)                         \
 387         __bs_nonsingle(wr,2,(t),(h),(o),(a),(c))
 388 #define bus_space_write_region_4(t, h, o, a, c)                         \
 389         __bs_nonsingle(wr,4,(t),(h),(o),(a),(c))
 390 #define bus_space_write_region_8(t, h, o, a, c)                         \
 391         __bs_nonsingle(wr,8,(t),(h),(o),(a),(c))
 392
 393 #define bus_space_write_region_stream_1(t, h, o, a, c)                  \
 394         __bs_nonsingle_s(wr,1,(t),(h),(o),(a),(c))
 395 #define bus_space_write_region_stream_2(t, h, o, a, c)                  \
 396         __bs_nonsingle_s(wr,2,(t),(h),(o),(a),(c))
 397 #define bus_space_write_region_stream_4(t, h, o, a, c)                  \
 398         __bs_nonsingle_s(wr,4,(t),(h),(o),(a),(c))
 399 #define bus_space_write_region_stream_8(t, h, o, a, c)                  \
 400         __bs_nonsingle_s(wr,8,(t),(h),(o),(a),(c))
 401
 402 /*
 403  * Set multiple operations.
 404  */
 405 #define bus_space_set_multi_1(t, h, o, v, c)                            \
 406         __bs_set(sm,1,(t),(h),(o),(v),(c))
 407 #define bus_space_set_multi_2(t, h, o, v, c)                            \
 408         __bs_set(sm,2,(t),(h),(o),(v),(c))
 409 #define bus_space_set_multi_4(t, h, o, v, c)                            \
 410         __bs_set(sm,4,(t),(h),(o),(v),(c))
 411 #define bus_space_set_multi_8(t, h, o, v, c)                            \
 412         __bs_set(sm,8,(t),(h),(o),(v),(c))
 413
 414 /*
 415  * Set region operations.
 416  */
 417 #define bus_space_set_region_1(t, h, o, v, c)                           \
 418         __bs_set(sr,1,(t),(h),(o),(v),(c))
 419 #define bus_space_set_region_2(t, h, o, v, c)                           \
 420         __bs_set(sr,2,(t),(h),(o),(v),(c))
 421 #define bus_space_set_region_4(t, h, o, v, c)                           \
 422         __bs_set(sr,4,(t),(h),(o),(v),(c))
 423 #define bus_space_set_region_8(t, h, o, v, c)                           \
 424         __bs_set(sr,8,(t),(h),(o),(v),(c))
 425
 426 /*
 427  * Copy operations.
 428  */
 429 #define bus_space_copy_region_1(t, h1, o1, h2, o2, c)                           \
 430         __bs_copy(1, t, h1, o1, h2, o2, c)
 431 #define bus_space_copy_region_2(t, h1, o1, h2, o2, c)                           \
 432         __bs_copy(2, t, h1, o1, h2, o2, c)
 433 #define bus_space_copy_region_4(t, h1, o1, h2, o2, c)                           \
 434         __bs_copy(4, t, h1, o1, h2, o2, c)
 435 #define bus_space_copy_region_8(t, h1, o1, h2, o2, c)                           \
 436         __bs_copy(8, t, h1, o1, h2, o2, c)
 437
 438 /*
 439  * Macros to provide prototypes for all the functions used in the
 440  * bus_space structure
 441  */
 442
 443 #define bs_map_proto(f)                                                 \
 444 int     __bs_c(f,_bs_map) (void *t, bus_addr_t addr,            \
 445             bus_size_t size, int cacheable, bus_space_handle_t *bshp);
 446
 447 #define bs_unmap_proto(f)                                               \
 448 void    __bs_c(f,_bs_unmap) (void *t, bus_space_handle_t bsh,           \
 449             bus_size_t size);
 450
 451 #define bs_subregion_proto(f)                                           \
 452 int     __bs_c(f,_bs_subregion) (void *t, bus_space_handle_t bsh,       \
 453             bus_size_t offset, bus_size_t size,                         \
 454             bus_space_handle_t *nbshp);
 455
 456 #define bs_alloc_proto(f)                                               \
 457 int     __bs_c(f,_bs_alloc) (void *t, bus_addr_t rstart,                \
 458             bus_addr_t rend, bus_size_t size, bus_size_t align,         \
 459             bus_size_t boundary, int cacheable, bus_addr_t *addrp,      \
 460             bus_space_handle_t *bshp);
 461
 462 #define bs_free_proto(f)                                                \
 463 void    __bs_c(f,_bs_free) (void *t, bus_space_handle_t bsh,    \
 464             bus_size_t size);
 465
 466 #define bs_barrier_proto(f)                                             \
 467 void    __bs_c(f,_bs_barrier) (void *t, bus_space_handle_t bsh, \
 468             bus_size_t offset, bus_size_t len, int flags);
 469
 470 #define bs_r_1_proto(f)                                                 \
 471 u_int8_t        __bs_c(f,_bs_r_1) (void *t, bus_space_handle_t bsh,     \
 472                     bus_size_t offset);
 473
 474 #define bs_r_2_proto(f)                                                 \
 475 u_int16_t       __bs_c(f,_bs_r_2) (void *t, bus_space_handle_t bsh,     \
 476                     bus_size_t offset);
 477
 478 #define bs_r_4_proto(f)                                                 \
 479 u_int32_t       __bs_c(f,_bs_r_4) (void *t, bus_space_handle_t bsh,     \
 480                     bus_size_t offset);
 481
 482 #define bs_r_8_proto(f)                                                 \
 483 u_int64_t       __bs_c(f,_bs_r_8) (void *t, bus_space_handle_t bsh,     \
 484                     bus_size_t offset);
 485
 486 #define bs_r_1_s_proto(f)                                               \
 487 u_int8_t        __bs_c(f,_bs_r_1_s) (void *t, bus_space_handle_t bsh,   \
 488                     bus_size_t offset);
 489
 490 #define bs_r_2_s_proto(f)                                               \
 491 u_int16_t       __bs_c(f,_bs_r_2_s) (void *t, bus_space_handle_t bsh,   \
 492                     bus_size_t offset);
 493
 494 #define bs_r_4_s_proto(f)                                               \
 495 u_int32_t       __bs_c(f,_bs_r_4_s) (void *t, bus_space_handle_t bsh,   \
 496                     bus_size_t offset);
 497
 498 #define bs_w_1_proto(f)                                                 \
 499 void    __bs_c(f,_bs_w_1) (void *t, bus_space_handle_t bsh,             \
 500             bus_size_t offset, u_int8_t value);
 501
 502 #define bs_w_2_proto(f)                                                 \
 503 void    __bs_c(f,_bs_w_2) (void *t, bus_space_handle_t bsh,             \
 504             bus_size_t offset, u_int16_t value);
 505
 506 #define bs_w_4_proto(f)                                                 \
 507 void    __bs_c(f,_bs_w_4) (void *t, bus_space_handle_t bsh,             \
 508             bus_size_t offset, u_int32_t value);
 509
 510 #define bs_w_8_proto(f)                                                 \
 511 void    __bs_c(f,_bs_w_8) (void *t, bus_space_handle_t bsh,             \
 512             bus_size_t offset, u_int64_t value);
 513
 514 #define bs_w_1_s_proto(f)                                               \
 515 void    __bs_c(f,_bs_w_1_s) (void *t, bus_space_handle_t bsh,           \
 516             bus_size_t offset, u_int8_t value);
 517
 518 #define bs_w_2_s_proto(f)                                               \
 519 void    __bs_c(f,_bs_w_2_s) (void *t, bus_space_handle_t bsh,           \
 520             bus_size_t offset, u_int16_t value);
 521
 522 #define bs_w_4_s_proto(f)                                               \
 523 void    __bs_c(f,_bs_w_4_s) (void *t, bus_space_handle_t bsh,           \
 524             bus_size_t offset, u_int32_t value);
 525
 526 #define bs_rm_1_proto(f)                                                \
 527 void    __bs_c(f,_bs_rm_1) (void *t, bus_space_handle_t bsh,    \
 528             bus_size_t offset, u_int8_t *addr, bus_size_t count);
 529
 530 #define bs_rm_2_proto(f)                                                \
 531 void    __bs_c(f,_bs_rm_2) (void *t, bus_space_handle_t bsh,    \
 532             bus_size_t offset, u_int16_t *addr, bus_size_t count);
 533
 534 #define bs_rm_4_proto(f)                                                \
 535 void    __bs_c(f,_bs_rm_4) (void *t, bus_space_handle_t bsh,    \
 536             bus_size_t offset, u_int32_t *addr, bus_size_t count);
 537
 538 #define bs_rm_8_proto(f)                                                \
 539 void    __bs_c(f,_bs_rm_8) (void *t, bus_space_handle_t bsh,    \
 540             bus_size_t offset, u_int64_t *addr, bus_size_t count);
 541
 542 #define bs_wm_1_proto(f)                                                \
 543 void    __bs_c(f,_bs_wm_1) (void *t, bus_space_handle_t bsh,    \
 544             bus_size_t offset, const u_int8_t *addr, bus_size_t count);
 545
 546 #define bs_wm_2_proto(f)                                                \
 547 void    __bs_c(f,_bs_wm_2) (void *t, bus_space_handle_t bsh,    \
 548             bus_size_t offset, const u_int16_t *addr, bus_size_t count);
 549
 550 #define bs_wm_4_proto(f)                                                \
 551 void    __bs_c(f,_bs_wm_4) (void *t, bus_space_handle_t bsh,    \
 552             bus_size_t offset, const u_int32_t *addr, bus_size_t count);
 553
 554 #define bs_wm_8_proto(f)                                                \
 555 void    __bs_c(f,_bs_wm_8) (void *t, bus_space_handle_t bsh,    \
 556             bus_size_t offset, const u_int64_t *addr, bus_size_t count);
 557
 558 #define bs_rr_1_proto(f)                                                \
 559 void    __bs_c(f, _bs_rr_1) (void *t, bus_space_handle_t bsh,   \
 560             bus_size_t offset, u_int8_t *addr, bus_size_t count);
 561
 562 #define bs_rr_2_proto(f)                                                \
 563 void    __bs_c(f, _bs_rr_2) (void *t, bus_space_handle_t bsh,   \
 564             bus_size_t offset, u_int16_t *addr, bus_size_t count);
 565
 566 #define bs_rr_4_proto(f)                                                \
 567 void    __bs_c(f, _bs_rr_4) (void *t, bus_space_handle_t bsh,   \
 568             bus_size_t offset, u_int32_t *addr, bus_size_t count);
 569
 570 #define bs_rr_8_proto(f)                                                \
 571 void    __bs_c(f, _bs_rr_8) (void *t, bus_space_handle_t bsh,   \
 572             bus_size_t offset, u_int64_t *addr, bus_size_t count);
 573
 574 #define bs_wr_1_proto(f)                                                \
 575 void    __bs_c(f, _bs_wr_1) (void *t, bus_space_handle_t bsh,   \
 576             bus_size_t offset, const u_int8_t *addr, bus_size_t count);
 577
 578 #define bs_wr_2_proto(f)                                                \
 579 void    __bs_c(f, _bs_wr_2) (void *t, bus_space_handle_t bsh,   \
 580             bus_size_t offset, const u_int16_t *addr, bus_size_t count);
 581
 582 #define bs_wr_4_proto(f)                                                \
 583 void    __bs_c(f, _bs_wr_4) (void *t, bus_space_handle_t bsh,   \
 584             bus_size_t offset, const u_int32_t *addr, bus_size_t count);
 585
 586 #define bs_wr_8_proto(f)                                                \
 587 void    __bs_c(f, _bs_wr_8) (void *t, bus_space_handle_t bsh,   \
 588             bus_size_t offset, const u_int64_t *addr, bus_size_t count);
 589
 590 #define bs_sm_1_proto(f)                                                \
 591 void    __bs_c(f,_bs_sm_1) (void *t, bus_space_handle_t bsh,    \
 592             bus_size_t offset, u_int8_t value, bus_size_t count);
 593
 594 #define bs_sm_2_proto(f)                                                \
 595 void    __bs_c(f,_bs_sm_2) (void *t, bus_space_handle_t bsh,    \
 596             bus_size_t offset, u_int16_t value, bus_size_t count);
 597
 598 #define bs_sm_4_proto(f)                                                \
 599 void    __bs_c(f,_bs_sm_4) (void *t, bus_space_handle_t bsh,    \
 600             bus_size_t offset, u_int32_t value, bus_size_t count);
 601
 602 #define bs_sm_8_proto(f)                                                \
 603 void    __bs_c(f,_bs_sm_8) (void *t, bus_space_handle_t bsh,    \
 604             bus_size_t offset, u_int64_t value, bus_size_t count);
 605
 606 #define bs_sr_1_proto(f)                                                \
 607 void    __bs_c(f,_bs_sr_1) (void *t, bus_space_handle_t bsh,    \
 608             bus_size_t offset, u_int8_t value, bus_size_t count);
 609
 610 #define bs_sr_2_proto(f)                                                \
 611 void    __bs_c(f,_bs_sr_2) (void *t, bus_space_handle_t bsh,    \
 612             bus_size_t offset, u_int16_t value, bus_size_t count);
 613
 614 #define bs_sr_4_proto(f)                                                \
 615 void    __bs_c(f,_bs_sr_4) (void *t, bus_space_handle_t bsh,    \
 616             bus_size_t offset, u_int32_t value, bus_size_t count);
 617
 618 #define bs_sr_8_proto(f)                                                \
 619 void    __bs_c(f,_bs_sr_8) (void *t, bus_space_handle_t bsh,    \
 620             bus_size_t offset, u_int64_t value, bus_size_t count);
 621
 622 #define bs_c_1_proto(f)                                                 \
 623 void    __bs_c(f,_bs_c_1) (void *t, bus_space_handle_t bsh1,    \
 624             bus_size_t offset1, bus_space_handle_t bsh2,                \
 625             bus_size_t offset2, bus_size_t count);
 626
 627 #define bs_c_2_proto(f)                                                 \
 628 void    __bs_c(f,_bs_c_2) (void *t, bus_space_handle_t bsh1,    \
 629             bus_size_t offset1, bus_space_handle_t bsh2,                \
 630             bus_size_t offset2, bus_size_t count);
 631
 632 #define bs_c_4_proto(f)                                                 \
 633 void    __bs_c(f,_bs_c_4) (void *t, bus_space_handle_t bsh1,    \
 634             bus_size_t offset1, bus_space_handle_t bsh2,                \
 635             bus_size_t offset2, bus_size_t count);
 636
 637 #define bs_c_8_proto(f)                                                 \
 638 void    __bs_c(f,_bs_c_8) (void *t, bus_space_handle_t bsh1,    \
 639             bus_size_t offset1, bus_space_handle_t bsh2,                \
 640             bus_size_t offset2, bus_size_t count);
 641
 642 #define DECLARE_BUS_SPACE_PROTOTYPES(f)         \
 643         bs_map_proto(f);                        \
 644         bs_unmap_proto(f);                      \
 645         bs_subregion_proto(f);                  \
 646         bs_alloc_proto(f);                      \
 647         bs_free_proto(f);                       \
 648         bs_barrier_proto(f);                    \
 649         bs_r_1_proto(f);                        \
 650         bs_r_2_proto(f);                        \
 651         bs_r_4_proto(f);                        \
 652         bs_r_8_proto(f);                        \
 653         bs_r_1_s_proto(f);                      \
 654         bs_r_2_s_proto(f);                      \
 655         bs_r_4_s_proto(f);                      \
 656         bs_w_1_proto(f);                        \
 657         bs_w_2_proto(f);                        \
 658         bs_w_4_proto(f);                        \
 659         bs_w_8_proto(f);                        \
 660         bs_w_1_s_proto(f);                      \
 661         bs_w_2_s_proto(f);                      \
 662         bs_w_4_s_proto(f);                      \
 663         bs_rm_1_proto(f);                       \
 664         bs_rm_2_proto(f);                       \
 665         bs_rm_4_proto(f);                       \
 666         bs_rm_8_proto(f);                       \
 667         bs_wm_1_proto(f);                       \
 668         bs_wm_2_proto(f);                       \
 669         bs_wm_4_proto(f);                       \
 670         bs_wm_8_proto(f);                       \
 671         bs_rr_1_proto(f);                       \
 672         bs_rr_2_proto(f);                       \
 673         bs_rr_4_proto(f);                       \
 674         bs_rr_8_proto(f);                       \
 675         bs_wr_1_proto(f);                       \
 676         bs_wr_2_proto(f);                       \
 677         bs_wr_4_proto(f);                       \
 678         bs_wr_8_proto(f);                       \
 679         bs_sm_1_proto(f);                       \
 680         bs_sm_2_proto(f);                       \
 681         bs_sm_4_proto(f);                       \
 682         bs_sm_8_proto(f);                       \
 683         bs_sr_1_proto(f);                       \
 684         bs_sr_2_proto(f);                       \
 685         bs_sr_4_proto(f);                       \
 686         bs_sr_8_proto(f);                       \
 687         bs_c_1_proto(f);                        \
 688         bs_c_2_proto(f);                        \
 689         bs_c_4_proto(f);                        \
 690         bs_c_8_proto(f);
 691
 692 #define BUS_PEEK_FUNC(width, type)                                      \
 693         static inline int                                               \
 694         bus_space_peek_##width(bus_space_tag_t tag,                     \
 695             bus_space_handle_t hnd, bus_size_t offset, type *value)     \
 696         {                                                               \
 697                 type tmp;                                               \
 698                 tmp = bus_space_read_##width(tag, hnd, offset);         \
 699                 *value = (type)tmp;                                     \
 700                 return (0);                                             \
 701         }
 702 BUS_PEEK_FUNC(1, uint8_t)
 703 BUS_PEEK_FUNC(2, uint16_t)
 704 BUS_PEEK_FUNC(4, uint32_t)
 705 BUS_PEEK_FUNC(8, uint64_t)
 706
 707 #define BUS_POKE_FUNC(width, type)                                      \
 708         static inline int                                               \
 709         bus_space_poke_##width(bus_space_tag_t tag,                     \
 710             bus_space_handle_t hnd, bus_size_t offset, type value)      \
 711         {                                                               \
 712                 bus_space_write_##width(tag, hnd, offset, value);       \
 713                 return (0);                                             \
 714         }
 715 BUS_POKE_FUNC(1, uint8_t)
 716 BUS_POKE_FUNC(2, uint16_t)
 717 BUS_POKE_FUNC(4, uint32_t)
 718 BUS_POKE_FUNC(8, uint64_t)
 719
 720 #define BUS_SPACE_ALIGNED_POINTER(p, t) ALIGNED_POINTER(p, t)
 721
 722 #define BUS_SPACE_MAXADDR_24BIT 0xFFFFFF
 723 #define BUS_SPACE_MAXSIZE_24BIT 0xFFFFFF
 724
 725 #define BUS_SPACE_MAXADDR_32BIT 0xFFFFFFFF
 726 #define BUS_SPACE_MAXSIZE_32BIT 0xFFFFFFFF
 727
 728 #if defined(__mips_n64)
 729 #define BUS_SPACE_MAXADDR       0xFFFFFFFFFFFFFFFFUL
 730 #define BUS_SPACE_MAXSIZE       0xFFFFFFFFFFFFFFFFUL
 731 #else
 732 #define BUS_SPACE_MAXADDR       0xFFFFFFFFUL
 733 #define BUS_SPACE_MAXSIZE       0xFFFFFFFFUL
 734 #endif
 735
 736 #define BUS_SPACE_UNRESTRICTED  (~0)
 737
 738 /*
 739  * declare generic bus space, it suits all needs in
 740  */
 741 DECLARE_BUS_SPACE_PROTOTYPES(generic);
 742 extern bus_space_tag_t mips_bus_space_generic;
 743
 744 /* Special bus space for RMI processors */
 745 #if defined(CPU_RMI) || defined (CPU_NLM)
 746 extern bus_space_tag_t rmi_bus_space;
 747 extern bus_space_tag_t rmi_pci_bus_space;
 748 extern bus_space_tag_t rmi_uart_bus_space;
 749 #endif
 750
 751 #include <machine/bus_dma.h>
 752
 753 #endif /* _MACHINE_BUS_H_ */