Sync usage with man page.

[netbsd-mini2440.git] / sys / arch / sh3 / include / bus.h

/*      $NetBSD: bus.h,v 1.16 2006/03/04 01:55:03 uwe Exp $     */

/*-
 * Copyright (c) 1996, 1997 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
 * NASA Ames Research Center.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

/*
 * Copyright (c) 1996 Charles M. Hannum.  All rights reserved.
 * Copyright (c) 1996 Christopher G. Demetriou.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *      This product includes software developed by Christopher G. Demetriou
 *      for the NetBSD Project.
 * 4. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _SH3_BUS_H_
#define _SH3_BUS_H_

#include <sys/bswap.h>

#define __BUS_SPACE_HAS_STREAM_METHODS

#define BUS_SPACE_ALIGNED_POINTER(p, t) ALIGNED_POINTER(p, t)

/*
 * Values for the sh3 bus space tag, not to be used directly by MI code.
 */
#define SH3_BUS_SPACE_IO        0       /* space is i/o space */
#define SH3_BUS_SPACE_MEM       1       /* space is mem space */
#define SH3_BUS_SPACE_PCMCIA_IO 2       /* PCMCIA IO space */
#define SH3_BUS_SPACE_PCMCIA_MEM 3      /* PCMCIA Mem space */
#define SH3_BUS_SPACE_PCMCIA_ATT 4      /* PCMCIA Attr space */
#define SH3_BUS_SPACE_PCMCIA_8BIT 0x8000 /* PCMCIA BUS 8 BIT WIDTH */
#define SH3_BUS_SPACE_PCMCIA_IO8 \
            (SH3_BUS_SPACE_PCMCIA_IO|SH3_BUS_SPACE_PCMCIA_8BIT)
#define SH3_BUS_SPACE_PCMCIA_MEM8 \
            (SH3_BUS_SPACE_PCMCIA_MEM|SH3_BUS_SPACE_PCMCIA_8BIT)
#define SH3_BUS_SPACE_PCMCIA_ATT8 \
            (SH3_BUS_SPACE_PCMCIA_ATT|SH3_BUS_SPACE_PCMCIA_8BIT)

/*
 * Bus address and size types
 */
typedef u_long bus_addr_t;
typedef u_long bus_size_t;

/*
 * Access methods for bus resources and address space.
 */
typedef int bus_space_tag_t;
typedef u_long bus_space_handle_t;

/*
 *      int bus_space_map (bus_space_tag_t t, bus_addr_t addr,
 *          bus_size_t size, int flags, bus_space_handle_t *bshp);
 *
 * Map a region of bus space.
 */
#define BUS_SPACE_MAP_CACHEABLE         0x01
#define BUS_SPACE_MAP_LINEAR            0x02

int bus_space_map(bus_space_tag_t, bus_addr_t, bus_size_t size,
    int, bus_space_handle_t *);

#ifdef SH4_PCMCIA
int shpcmcia_memio_map(bus_space_tag_t, bus_addr_t, bus_size_t size,
    int, bus_space_handle_t *);

int shpcmcia_mem_add_mapping(bus_addr_t, bus_size_t, int,
    bus_space_handle_t *);
void shpcmcia_memio_unmap(bus_space_tag_t, bus_space_handle_t,
    bus_size_t);
void shpcmcia_memio_free(bus_space_tag_t, bus_space_handle_t,
    bus_size_t);
int shpcmcia_memio_subregion(bus_space_tag_t, bus_space_handle_t,
    bus_size_t, bus_size_t, bus_space_handle_t *);
#endif

/*
 *      u_intN_t bus_space_read_N(bus_space_tag_t tag,
 *          bus_space_handle_t bsh, bus_size_t offset);
 *
 * Read a 1, 2, 4, or 8 byte quantity from bus space
 * described by tag/handle/offset.
 */
static __inline uint8_t bus_space_read_1
        (bus_space_tag_t, bus_space_handle_t, bus_size_t);
static __inline uint16_t bus_space_read_2
        (bus_space_tag_t, bus_space_handle_t, bus_size_t);
static __inline uint32_t bus_space_read_4
        (bus_space_tag_t, bus_space_handle_t, bus_size_t);

uint8_t
bus_space_read_1(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset)
{

        return *(volatile uint8_t *)(bsh + offset);
}

uint16_t
bus_space_read_2(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset)
{

        return bswap16(*(volatile uint16_t *)(bsh + offset));
}

uint32_t
bus_space_read_4(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset)
{

        return bswap32(*(volatile uint32_t *)(bsh + offset));
}

static __inline uint16_t bus_space_read_stream_2
        (bus_space_tag_t, bus_space_handle_t, bus_size_t);

static __inline uint32_t bus_space_read_stream_4
        (bus_space_tag_t, bus_space_handle_t, bus_size_t);

uint16_t
bus_space_read_stream_2(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset)
{

        return *(volatile uint16_t *)(bsh + offset);
}

uint32_t
bus_space_read_stream_4(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset)
{

        return *(volatile uint32_t *)(bsh + offset);
}

/*
 *      void bus_space_read_multi_N(bus_space_tag_t tag,
 *          bus_space_handle_t bsh, bus_size_t offset,
 *          u_intN_t *addr, size_t count);
 *
 * Read `count' 1, 2, 4, or 8 byte quantities from bus space
 * described by tag/handle/offset and copy into buffer provided.
 */
static __inline void bus_space_read_multi_1(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, uint8_t *, bus_size_t);
static __inline void bus_space_read_multi_2(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, uint16_t *, bus_size_t);
static __inline void bus_space_read_multi_4(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, uint32_t *, bus_size_t);

void
bus_space_read_multi_1(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, uint8_t *addr, bus_size_t count)
{

        while (count--)
                *addr++ = bus_space_read_1(tag, bsh, offset);
}

void
bus_space_read_multi_2(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, uint16_t *addr, bus_size_t count)
{

        while (count--)
                *addr++ = bus_space_read_2(tag, bsh, offset);
}

void
bus_space_read_multi_4(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, uint32_t *addr, bus_size_t count)
{

        while (count--)
                *addr++ = bus_space_read_4(tag, bsh, offset);
}

static __inline void bus_space_read_multi_stream_2(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, uint16_t *, bus_size_t);
static __inline void bus_space_read_multi_stream_4(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, uint32_t *, bus_size_t);

void
bus_space_read_multi_stream_2(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, uint16_t *addr, bus_size_t count)
{

        while (count--)
                *addr++ = *(volatile uint16_t *)(bsh + offset);
}

void
bus_space_read_multi_stream_4(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, uint32_t *addr, bus_size_t count)
{

        while (count--)
                *addr++ = *(volatile uint32_t *)(bsh + offset);
}

/*
 *      int bus_space_alloc(bus_space_tag_t t, bus_addr_t rstart,
 *          bus_addr_t rend, bus_size_t size, bus_size_t align,
 *          bus_size_t boundary, int flags, bus_addr_t *addrp,
 *          bus_space_handle_t *bshp);
 *
 * Allocate a region of bus space.
 */
int sh_memio_alloc(bus_space_tag_t, bus_addr_t, bus_addr_t, bus_size_t,
    bus_size_t, bus_size_t, int, bus_addr_t *, bus_space_handle_t *);

#define bus_space_alloc(t, rs, re, s, a, b, f, ap, hp)                  \
        sh_memio_alloc((t), (rs), (re), (s), (a), (b), (f), (ap), (hp))

/*
 *      int bus_space_free(bus_space_tag_t t,
 *          bus_space_handle_t bsh, bus_size_t size);
 *
 * Free a region of bus space.
 */
void sh_memio_free(bus_space_tag_t, bus_space_handle_t, bus_size_t);

#define bus_space_free(t, h, s)                                         \
        sh_memio_free((t), (h), (s))

/*
 *      int bus_space_unmap(bus_space_tag_t t,
 *          bus_space_handle_t bsh, bus_size_t size);
 *
 * Unmap a region of bus space.
 */
void sh_memio_unmap(bus_space_tag_t, bus_space_handle_t, bus_size_t);

#define bus_space_unmap(t, h, s)                                        \
        sh_memio_unmap((t), (h), (s))

/*
 *      int bus_space_subregion(bus_space_tag_t t,
 *          bus_space_handle_t bsh, bus_size_t offset, bus_size_t size,
 *          bus_space_handle_t *nbshp);
 *
 * Get a new handle for a subregion of an already-mapped area of bus space.
 */
int sh_memio_subregion(bus_space_tag_t, bus_space_handle_t,
    bus_size_t, bus_size_t, bus_space_handle_t *);

#define bus_space_subregion(t, h, o, s, nhp)                            \
        sh_memio_subregion((t), (h), (o), (s), (nhp))

/*
 *      void bus_space_read_region_N(bus_space_tag_t tag,
 *          bus_space_handle_t bsh, bus_size_t offset,
 *          u_intN_t *addr, size_t count);
 *
 * Read `count' 1, 2, 4, or 8 byte quantities from bus space
 * described by tag/handle and starting at `offset' and copy into
 * buffer provided.
 */
static __inline void bus_space_read_region_1(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, uint8_t *, bus_size_t);
static __inline void bus_space_read_region_2(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, uint16_t *, bus_size_t);
static __inline void bus_space_read_region_4(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, uint32_t *, bus_size_t);

void
bus_space_read_region_1(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, uint8_t *addr, bus_size_t count)
{
        uint8_t *p = (uint8_t *)(bsh + offset);

        while (count--)
                *addr++ = *p++;
}

void
bus_space_read_region_2(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, uint16_t *addr, bus_size_t count)
{
        uint16_t *p = (uint16_t *)(bsh + offset);

        while (count--)
                *addr++ = bswap16(*p++);
}

void
bus_space_read_region_4(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, uint32_t *addr, bus_size_t count)
{
        uint32_t *p = (uint32_t *)(bsh + offset);

        while (count--)
                *addr++ = bswap32(*p++);
}

/*
 *      void bus_space_read_region_stream_N(bus_space_tag_t tag,
 *          bus_space_handle_t bsh, bus_size_t offset,
 *          u_intN_t *addr, size_t count);
 *
 * Read `count' 1, 2, 4, or 8 byte quantities from bus space
 * described by tag/handle and starting at `offset' and copy into
 * buffer provided.
 */
static __inline void bus_space_read_region_stream_1(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, uint8_t *, bus_size_t);
static __inline void bus_space_read_region_stream_2(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, uint16_t *, bus_size_t);
static __inline void bus_space_read_region_stream_4(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, uint32_t *, bus_size_t);

void
bus_space_read_region_stream_1(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, uint8_t *addr, bus_size_t count)
{
        uint8_t *p = (uint8_t *)(bsh + offset);

        while (count--)
                *addr++ = *p++;
}

void
bus_space_read_region_stream_2(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, uint16_t *addr, bus_size_t count)
{
        uint16_t *p = (uint16_t *)(bsh + offset);

        while (count--)
                *addr++ = *p++;
}

void
bus_space_read_region_stream_4(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, uint32_t *addr, bus_size_t count)
{
        uint32_t *p = (uint32_t *)(bsh + offset);

        while (count--)
                *addr++ = *p++;
}

/*
 *      void bus_space_write_region_N(bus_space_tag_t tag,
 *          bus_space_handle_t bsh, bus_size_t offset,
 *          const u_intN_t *addr, size_t count);
 *
 * Write `count' 1, 2, 4, or 8 byte quantities from the buffer provided
 * to bus space described by tag/handle starting at `offset'.
 */
static __inline void bus_space_write_region_1(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, const uint8_t *, bus_size_t);
static __inline void bus_space_write_region_2(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, const uint16_t *, bus_size_t);
static __inline void bus_space_write_region_4(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, const uint32_t *, bus_size_t);

void
bus_space_write_region_1(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, const uint8_t *addr, bus_size_t count)
{
        uint8_t *p = (uint8_t *)(bsh + offset);

        while (count--)
                *p++ = *addr++;
}

void
bus_space_write_region_2(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, const uint16_t *addr, bus_size_t count)
{
        uint16_t *p = (uint16_t *)(bsh + offset);

        while (count--)
                *p++ = bswap16(*addr++);
}

void
bus_space_write_region_4(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, const uint32_t *addr, bus_size_t count)
{
        uint32_t *p = (uint32_t *)(bsh + offset);

        while (count--)
                *p++ = bswap32(*addr++);
}

/*
 *      void bus_space_write_region_stream_N(bus_space_tag_t tag,
 *          bus_space_handle_t bsh, bus_size_t offset,
 *          const u_intN_t *addr, size_t count);
 *
 * Write `count' 1, 2, 4, or 8 byte quantities from the buffer provided
 * to bus space described by tag/handle starting at `offset'.
 */
static __inline void bus_space_write_region_stream_1(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, const uint8_t *, bus_size_t);
static __inline void bus_space_write_region_stream_2(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, const uint16_t *, bus_size_t);
static __inline void bus_space_write_region_stream_4(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, const uint32_t *, bus_size_t);

void
bus_space_write_region_stream_1(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, const uint8_t *addr, bus_size_t count)
{
        uint8_t *p = (uint8_t *)(bsh + offset);

        while (count--)
                *p++ = *addr++;
}

void
bus_space_write_region_stream_2(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, const uint16_t *addr, bus_size_t count)
{
        uint16_t *p = (uint16_t *)(bsh + offset);

        while (count--)
                *p++ = *addr++;
}

void
bus_space_write_region_stream_4(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, const uint32_t *addr, bus_size_t count)
{
        uint32_t *p = (uint32_t *)(bsh + offset);

        while (count--)
                *p++ = *addr++;
}

/*
 *      void bus_space_write_N(bus_space_tag_t tag,
 *          bus_space_handle_t bsh, bus_size_t offset,
 *          u_intN_t value);
 *
 * Write the 1, 2, 4, or 8 byte value `value' to bus space
 * described by tag/handle/offset.
 */
static __inline void bus_space_write_1(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, uint8_t);
static __inline void bus_space_write_2(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, uint16_t);
static __inline void bus_space_write_4(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, uint32_t);

void
bus_space_write_1(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, uint8_t value)
{

        *(volatile uint8_t *)(bsh + offset) = value;
}

void
bus_space_write_2(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, uint16_t value)
{

        *(volatile uint16_t *)(bsh + offset) = bswap16(value);
}

void
bus_space_write_4(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, uint32_t value)
{

        *(volatile uint32_t *)(bsh + offset) = bswap32(value);
}

static __inline void bus_space_write_stream_2(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, uint16_t);
static __inline void bus_space_write_stream_4(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, uint32_t);

void
bus_space_write_stream_2(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, uint16_t value)
{

        *(volatile uint16_t *)(bsh + offset) = value;
}

void
bus_space_write_stream_4(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, uint32_t value)
{

        *(volatile uint32_t *)(bsh + offset) = value;
}

/*
 *      void bus_space_write_multi_N(bus_space_tag_t tag,
 *          bus_space_handle_t bsh, bus_size_t offset,
 *          const u_intN_t *addr, size_t count);
 *
 * Write `count' 1, 2, 4, or 8 byte quantities from the buffer
 * provided to bus space described by tag/handle/offset.
 */
static __inline void bus_space_write_multi_1(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, uint8_t *, bus_size_t);
static __inline void bus_space_write_multi_2(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, uint16_t *, bus_size_t);
static __inline void bus_space_write_multi_4(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, uint32_t *, bus_size_t);

void
bus_space_write_multi_1(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, uint8_t *addr, bus_size_t count)
{

        while (count--)
                bus_space_write_1(tag, bsh, offset, *addr++);
}

void
bus_space_write_multi_2(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, uint16_t *addr, bus_size_t count)
{

        while (count--)
                bus_space_write_2(tag, bsh, offset, *addr++);
}

void
bus_space_write_multi_4(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, uint32_t *addr, bus_size_t count)
{

        while (count--)
                bus_space_write_4(tag, bsh, offset, *addr++);
}

static __inline void bus_space_write_multi_stream_2(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, uint16_t *, bus_size_t);
static __inline void bus_space_write_multi_stream_4(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, uint32_t *, bus_size_t);

void
bus_space_write_multi_stream_2(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, uint16_t *addr, bus_size_t count)
{

        while (count--)
                bus_space_write_stream_2(tag, bsh, offset, *addr++);
}

void
bus_space_write_multi_stream_4(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, uint32_t *addr, bus_size_t count)
{

        while (count--)
                bus_space_write_stream_4(tag, bsh, offset, *addr++);
}

/*
 *      void bus_space_set_multi_N(bus_space_tag_t tag,
 *          bus_space_handle_t bsh, bus_size_t offset, u_intN_t val,
 *          size_t count);
 *
 * Write the 1, 2, 4, or 8 byte value `val' to bus space described
 * by tag/handle/offset `count' times.
 */
static __inline void bus_space_set_multi_1(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, uint8_t, bus_size_t);
static __inline void bus_space_set_multi_2(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, uint16_t, bus_size_t);
static __inline void bus_space_set_multi_4(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, uint32_t, bus_size_t);

void
bus_space_set_multi_1(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, uint8_t val, bus_size_t count)
{

        while (count--)
                bus_space_write_1(tag, bsh, offset, val);
}

void
bus_space_set_multi_2(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, uint16_t val, bus_size_t count)
{

        while (count--)
                bus_space_write_2(tag, bsh, offset, val);
}

void
bus_space_set_multi_4(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, uint32_t val, bus_size_t count)
{

        while (count--)
                bus_space_write_4(tag, bsh, offset, val);
}

/*
 *      void bus_space_set_region_N(bus_space_tag_t tag,
 *          bus_space_handle_t bsh, bus_size_t offset, u_intN_t val,
 *          size_t count);
 *
 * Write `count' 1, 2, 4, or 8 byte value `val' to bus space described
 * by tag/handle starting at `offset'.
 */
static __inline void bus_space_set_region_1(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, uint8_t, bus_size_t);
static __inline void bus_space_set_region_2(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, uint16_t, bus_size_t);
static __inline void bus_space_set_region_4(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, uint32_t, bus_size_t);

void
bus_space_set_region_1(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, uint8_t val, bus_size_t count)
{
        volatile uint8_t *addr = (void *)(bsh + offset);

        while (count--)
                *addr++ = val;
}

void
bus_space_set_region_2(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, uint16_t val, bus_size_t count)
{
        volatile uint16_t *addr = (void *)(bsh + offset);

        val = bswap16(val);
        while (count--)
                *addr++ = val;
}

void
bus_space_set_region_4(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, uint32_t val, bus_size_t count)
{
        volatile uint32_t *addr = (void *)(bsh + offset);

        val = bswap32(val);
        while (count--)
                *addr++ = val;
}

/*
 *      void bus_space_set_region_stream_N(bus_space_tag_t tag,
 *          bus_space_handle_t bsh, bus_size_t offset, u_intN_t val,
 *          size_t count);
 *
 * Write `count' 1, 2, 4, or 8 byte value `val' to bus space described
 * by tag/handle starting at `offset'.
 */
static __inline void bus_space_set_region_stream_1(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, uint8_t, bus_size_t);
static __inline void bus_space_set_region_stream_2(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, uint16_t, bus_size_t);
static __inline void bus_space_set_region_stream_4(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, uint32_t, bus_size_t);

void
bus_space_set_region_stream_1(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, uint8_t val, bus_size_t count)
{
        volatile uint8_t *addr = (void *)(bsh + offset);

        while (count--)
                *addr++ = val;
}

void
bus_space_set_region_stream_2(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, uint16_t val, bus_size_t count)
{
        volatile uint16_t *addr = (void *)(bsh + offset);

        while (count--)
                *addr++ = val;
}

void
bus_space_set_region_stream_4(bus_space_tag_t tag, bus_space_handle_t bsh,
    bus_size_t offset, uint32_t val, bus_size_t count)
{
        volatile uint32_t *addr = (void *)(bsh + offset);

        while (count--)
                *addr++ = val;
}

/*
 *      void bus_space_copy_region_N(bus_space_tag_t tag,
 *          bus_space_handle_t bsh1, bus_size_t off1,
 *          bus_space_handle_t bsh2, bus_size_t off2,
 *          size_t count);
 *
 * Copy `count' 1, 2, 4, or 8 byte values from bus space starting
 * at tag/bsh1/off1 to bus space starting at tag/bsh2/off2.
 */
static __inline void bus_space_copy_region_1(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, bus_space_handle_t, bus_size_t,
    bus_size_t);
static __inline void bus_space_copy_region_2(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, bus_space_handle_t, bus_size_t,
    bus_size_t);
static __inline void bus_space_copy_region_4(bus_space_tag_t,
    bus_space_handle_t, bus_size_t, bus_space_handle_t, bus_size_t,
    bus_size_t);

void
bus_space_copy_region_1(bus_space_tag_t t, bus_space_handle_t h1,
    bus_size_t o1, bus_space_handle_t h2, bus_size_t o2, bus_size_t c)
{
        volatile uint8_t *addr1 = (void *)(h1 + o1);
        volatile uint8_t *addr2 = (void *)(h2 + o2);

        if (addr1 >= addr2) {   /* src after dest: copy forward */
                while (c--)
                        *addr2++ = *addr1++;
        } else {                /* dest after src: copy backwards */
                addr1 += c - 1;
                addr2 += c - 1;
                while (c--)
                        *addr2-- = *addr1--;
        }
}

void
bus_space_copy_region_2(bus_space_tag_t t, bus_space_handle_t h1,
    bus_size_t o1, bus_space_handle_t h2, bus_size_t o2, bus_size_t c)
{
        volatile uint16_t *addr1 = (void *)(h1 + o1);
        volatile uint16_t *addr2 = (void *)(h2 + o2);

        if (addr1 >= addr2) {   /* src after dest: copy forward */
                while (c--)
                        *addr2++ = *addr1++;
        } else {                /* dest after src: copy backwards */
                addr1 += c - 1;
                addr2 += c - 1;
                while (c--)
                        *addr2-- = *addr1--;
        }
}

void
bus_space_copy_region_4(bus_space_tag_t t, bus_space_handle_t h1,
    bus_size_t o1, bus_space_handle_t h2, bus_size_t o2, bus_size_t c)
{
        volatile uint32_t *addr1 = (void *)(h1 + o1);
        volatile uint32_t *addr2 = (void *)(h2 + o2);

        if (addr1 >= addr2) {   /* src after dest: copy forward */
                while (c--)
                        *addr2++ = *addr1++;
        } else {                /* dest after src: copy backwards */
                addr1 += c - 1;
                addr2 += c - 1;
                while (c--)
                        *addr2-- = *addr1--;
        }
}

/*
 * Bus read/write barrier methods.
 *
 *      void bus_space_barrier(bus_space_tag_t tag,
 *          bus_space_handle_t bsh, bus_size_t offset,
 *          bus_size_t len, int flags);
 *
 * Note: the sh3 does not currently require barriers, but we must
 * provide the flags to MI code.
 */
#define bus_space_barrier(t, h, o, l, f)        \
        ((void)((void)(t), (void)(h), (void)(o), (void)(l), (void)(f)))
#define BUS_SPACE_BARRIER_READ  0x01            /* force read barrier */
#define BUS_SPACE_BARRIER_WRITE 0x02            /* force write barrier */

#endif /* _SH3_BUS_H_ */