/*      $NetBSD: bus.h,v 1.18 2023/01/27 19:49:21 tsutsui Exp $ */

/*-
 * Copyright (c) 1996, 1997, 1998 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) 1997 Scott Reynolds.  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. 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 _MACHINE_BUS_H_
#define _MACHINE_BUS_H_

/*
 * Value for the luna68k bus space tag, not to be used directly by MI code.
 */
#define MACHINE_BUS_SPACE_MEM   0       /* space is mem space */

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

#define PRIxBUSADDR     "lx"
#define PRIxBUSSIZE     "lx"
#define PRIuBUSSIZE     "lu"

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

#define PRIxBSH         "lx"

/*
 *      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
#define BUS_SPACE_MAP_PREFETCHABLE      0x04

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

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

void    bus_space_unmap(bus_space_tag_t, bus_space_handle_t, bus_size_t);

/*
 *      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     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);

/*
 *      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     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 cacheable, bus_addr_t *addrp,
            bus_space_handle_t *bshp);

/*
 *      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    bus_space_free(bus_space_tag_t t, bus_space_handle_t bsh,
            bus_size_t size);

/*
 *      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.
 */

#define bus_space_read_1(t, h, o)                                       \
    ((void) t, (*(volatile u_int8_t *)((h) + (o)*4)))

#define bus_space_read_2(t, h, o)                                       \
    ((void) t, (*(volatile u_int16_t *)((h) + (o)*2)))

#define bus_space_read_4(t, h, o)                                       \
    ((void) t, (*(volatile u_int32_t *)((h) + (o))))

/*
 *      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.
 */

#define bus_space_read_multi_1(t, h, o, a, c) do {                      \
        (void) t;                                                       \
        __asm volatile ("                                               \
                movl    %0,%%a0                                 ;       \
                movl    %1,%%a1                                 ;       \
                movl    %2,%%d0                                 ;       \
        1:      movb    %%a0@,%%a1@+                            ;       \
                subql   #1,%%d0                                 ;       \
                jne     1b"                                     :       \
                                                                :       \
                    "r" ((h) + (o)*4), "g" (a), "g" ((size_t)(c)) :     \
                    "a0","a1","d0","memory");                           \
} while (0)

#define bus_space_read_multi_2(t, h, o, a, c) do {                      \
        (void) t;                                                       \
        __asm volatile ("                                               \
                movl    %0,%%a0                                 ;       \
                movl    %1,%%a1                                 ;       \
                movl    %2,%%d0                                 ;       \
        1:      movw    %%a0@,%%a1@+                            ;       \
                subql   #1,%%d0                                 ;       \
                jne     1b"                                     :       \
                                                                :       \
                    "r" ((h) + (o)*2), "g" (a), "g" ((size_t)(c)) :     \
                    "a0","a1","d0","memory");                           \
} while (0)

#define bus_space_read_multi_4(t, h, o, a, c) do {                      \
        (void) t;                                                       \
        __asm volatile ("                                               \
                movl    %0,%%a0                                 ;       \
                movl    %1,%%a1                                 ;       \
                movl    %2,%%d0                                 ;       \
        1:      movl    %%a0@,%%a1@+                            ;       \
                subql   #1,%%d0                                 ;       \
                jne     1b"                                     :       \
                                                                :       \
                    "r" ((h) + (o)), "g" (a), "g" ((size_t)(c)) :       \
                    "a0","a1","d0","memory");                           \
} while (0)

/*
 *      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.
 */

#define bus_space_read_region_1(t, h, o, a, c) do {                     \
        (void) t;                                                       \
        __asm volatile ("                                               \
                movl    %0,%%a0                                 ;       \
                movl    %1,%%a1                                 ;       \
                movl    %2,%%d0                                 ;       \
        1:      movb    %%a0@,%%a1@+                            ;       \
                addql   #4,%%a0                                 ;       \
                subql   #1,%%d0                                 ;       \
                jne     1b"                                     :       \
                                                                :       \
                    "r" ((h) + (o)*4), "g" (a), "g" ((size_t)(c)) :     \
                    "a0","a1","d0","memory");                           \
} while (0)

#define bus_space_read_region_2(t, h, o, a, c) do {                     \
        (void) t;                                                       \
        __asm volatile ("                                               \
                movl    %0,%%a0                                 ;       \
                movl    %1,%%a1                                 ;       \
                movl    %2,%%d0                                 ;       \
        1:      movw    %%a0@,%%a1@+                            ;       \
                addql   #4,%%a0                                 ;       \
                subql   #1,%%d0                                 ;       \
                jne     1b"                                     :       \
                                                                :       \
                    "r" ((h) + (o)*2), "g" (a), "g" ((size_t)(c)) :     \
                    "a0","a1","d0","memory");                           \
} while (0)

#define bus_space_read_region_4(t, h, o, a, c) do {                     \
        (void) t;                                                       \
        __asm volatile ("                                               \
                movl    %0,%%a0                                 ;       \
                movl    %1,%%a1                                 ;       \
                movl    %2,%%d0                                 ;       \
        1:      movl    %%a0@+,%%a1@+                           ;       \
                subql   #1,%%d0                                 ;       \
                jne     1b"                                     :       \
                                                                :       \
                    "r" ((h) + (o)), "g" (a), "g" ((size_t)(c)) :       \
                    "a0","a1","d0","memory");                           \
} while (0)

/*
 *      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.
 */

#define bus_space_write_1(t, h, o, v)                                   \
    ((void) t, ((void)(*(volatile u_int8_t *)((h) + (o)*4) = (v))))

#define bus_space_write_2(t, h, o, v)                                   \
    ((void) t, ((void)(*(volatile u_int16_t *)((h) + (o)*2) = (v))))

#define bus_space_write_4(t, h, o, v)                                   \
    ((void) t, ((void)(*(volatile u_int32_t *)((h) + (o)) = (v))))

/*
 *      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.
 */

#define bus_space_write_multi_1(t, h, o, a, c) do {                     \
        (void) t;                                                       \
        __asm volatile ("                                               \
                movl    %0,%%a0                                 ;       \
                movl    %1,%%a1                                 ;       \
                movl    %2,%%d0                                 ;       \
        1:      movb    %%a1@+,%%a0@                            ;       \
                subql   #1,%%d0                                 ;       \
                jne     1b"                                     :       \
                                                                :       \
                    "r" ((h) + (o)*4), "g" (a), "g" ((size_t)(c)) :     \
                    "a0","a1","d0");                                    \
} while (0)

#define bus_space_write_multi_2(t, h, o, a, c) do {                     \
        (void) t;                                                       \
        __asm volatile ("                                               \
                movl    %0,%%a0                                 ;       \
                movl    %1,%%a1                                 ;       \
                movl    %2,%%d0                                 ;       \
        1:      movw    %%a1@+,%%a0@                            ;       \
                subql   #1,%%d0                                 ;       \
                jne     1b"                                     :       \
                                                                :       \
                    "r" ((h) + (o)*2), "g" (a), "g" ((size_t)(c)) :     \
                    "a0","a1","d0");                                    \
} while (0)

#define bus_space_write_multi_4(t, h, o, a, c) do {                     \
        (void) t;                                                       \
        __asm volatile ("                                               \
                movl    %0,%%a0                                 ;       \
                movl    %1,%%a1                                 ;       \
                movl    %2,%%d0                                 ;       \
        1:      movl    %%a1@+,%%a0@                            ;       \
                subql   #1,%%d0                                 ;       \
                jne     1b"                                     :       \
                                                                :       \
                    "r" ((h) + (o)), "g" (a), "g" ((size_t)(c)) :       \
                    "a0","a1","d0");                                    \
} while (0)

/*
 *      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'.
 */

#define bus_space_write_region_1(t, h, o, a, c) do {                    \
        (void) t;                                                       \
        __asm volatile ("                                               \
                movl    %0,%%a0                                 ;       \
                movl    %1,%%a1                                 ;       \
                movl    %2,%%d0                                 ;       \
        1:      movb    %%a1@+,%%a0@                            ;       \
                addql   #4,%%a0                                 ;       \
                subql   #1,%%d0                                 ;       \
                jne     1b"                                     :       \
                                                                :       \
                    "r" ((h) + (o)*4), "g" (a), "g" ((size_t)(c)) :     \
                    "a0","a1","d0");                                    \
} while (0)

#define bus_space_write_region_2(t, h, o, a, c) do {                    \
        (void) t;                                                       \
        __asm volatile ("                                               \
                movl    %0,%%a0                                 ;       \
                movl    %1,%%a1                                 ;       \
                movl    %2,%%d0                                 ;       \
        1:      movw    %%a1@+,%%a0@                            ;       \
                addql   #4,%%a0                                 ;       \
                subql   #1,%%d0                                 ;       \
                jne     1b"                                     :       \
                                                                :       \
                    "r" ((h) + (o)*2), "g" (a), "g" ((size_t)(c)) :     \
                    "a0","a1","d0");                                    \
} while (0)

#define bus_space_write_region_4(t, h, o, a, c) do {                    \
        (void) t;                                                       \
        __asm volatile ("                                               \
                movl    %0,%%a0                                 ;       \
                movl    %1,%%a1                                 ;       \
                movl    %2,%%d0                                 ;       \
        1:      movl    %%a1@+,%%a0@+                           ;       \
                subql   #1,%%d0                                 ;       \
                jne     1b"                                     :       \
                                                                :       \
                    "r" ((h) + (o)), "g" (a), "g" ((size_t)(c)) :       \
                    "a0","a1","d0");                                    \
} while (0)

/*
 *      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.
 */

#define bus_space_set_multi_1(t, h, o, val, c) do {                     \
        (void) t;                                                       \
        __asm volatile ("                                               \
                movl    %0,%%a0                                 ;       \
                movl    %1,%%d1                                 ;       \
                movl    %2,%%d0                                 ;       \
        1:      movb    %%d1,%%a0@                              ;       \
                subql   #1,%%d0                                 ;       \
                jne     1b"                                     :       \
                                                                :       \
                    "r" ((h)+(o)*4), "g" ((u_long)val),                 \
                                         "g" ((size_t)(c))      :       \
                    "a0","d0","d1");                                    \
} while (0)

#define bus_space_set_multi_2(t, h, o, val, c) do {                     \
        (void) t;                                                       \
        __asm volatile ("                                               \
                movl    %0,%%a0                                 ;       \
                movl    %1,%%d1                                 ;       \
                movl    %2,%%d0                                 ;       \
        1:      movw    %%d1,%%a0@                              ;       \
                subql   #1,%%d0                                 ;       \
                jne     1b"                                     :       \
                                                                :       \
                    "r" ((h)+(o)*2), "g" ((u_long)val),                 \
                                         "g" ((size_t)(c))      :       \
                    "a0","d0","d1");                                    \
} while (0)

#define bus_space_set_multi_4(t, h, o, val, c) do {                     \
        (void) t;                                                       \
        __asm volatile ("                                               \
                movl    %0,%%a0                                 ;       \
                movl    %1,%%d1                                 ;       \
                movl    %2,%%d0                                 ;       \
        1:      movl    %%d1,%%a0@                              ;       \
                subql   #1,%%d0                                 ;       \
                jne     1b"                                     :       \
                                                                :       \
                    "r" ((h)+(o)), "g" ((u_long)val),                   \
                                         "g" ((size_t)(c))      :       \
                    "a0","d0","d1");                                    \
} while (0)

/*
 *      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'.
 */

#define bus_space_set_region_1(t, h, o, val, c) do {                    \
        (void) t;                                                       \
        __asm volatile ("                                               \
                movl    %0,%%a0                                 ;       \
                movl    %1,%%d1                                 ;       \
                movl    %2,%%d0                                 ;       \
        1:      movb    %%d1,%%a0@                              ;       \
                addql   #4,%%a0                                 ;       \
                subql   #1,%%d0                                 ;       \
                jne     1b"                                     :       \
                                                                :       \
                    "r" ((h)+(o)*4), "g" ((u_long)val),                 \
                                        "g" ((size_t)(c))       :       \
                    "a0","d0","d1");                                    \
} while (0)

#define bus_space_set_region_2(t, h, o, val, c) do {                    \
        (void) t;                                                       \
        __asm volatile ("                                               \
                movl    %0,%%a0                                 ;       \
                movl    %1,%%d1                                 ;       \
                movl    %2,%%d0                                 ;       \
        1:      movw    %%d1,%%a0@                              ;       \
                addql   #4,%%a0                                 ;       \
                subql   #1,%%d0                                 ;       \
                jne     1b"                                     :       \
                                                                :       \
                    "r" ((h)+(o)*2), "g" ((u_long)val),                 \
                                        "g" ((size_t)(c))       :       \
                    "a0","d0","d1");                                    \
} while (0)

#define bus_space_set_region_4(t, h, o, val, c) do {                    \
        (void) t;                                                       \
        __asm volatile ("                                               \
                movl    %0,%%a0                                 ;       \
                movl    %1,%%d1                                 ;       \
                movl    %2,%%d0                                 ;       \
        1:      movl    %%d1,%%a0@+                             ;       \
                subql   #1,%%d0                                 ;       \
                jne     1b"                                     :       \
                                                                :       \
                    "r" ((h)+(o)), "g" ((u_long)val),                   \
                                        "g" ((size_t)(c))       :       \
                    "a0","d0","d1");                                    \
} while (0)

/*
 *      void bus_space_copy_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.
 */

#define __MACHINE_copy_region_N(BYTES)                                  \
static __inline void __CONCAT(bus_space_copy_region_,BYTES)             \
(bus_space_tag_t,                                               \
            bus_space_handle_t bsh1, bus_size_t off1,                   \
            bus_space_handle_t bsh2, bus_size_t off2,                   \
            bus_size_t count);                                          \
                                                                        \
static __inline void                                                    \
__CONCAT(bus_space_copy_region_,BYTES)(                                 \
        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)                                                   \
{                                                                       \
        bus_size_t o;                                                   \
                                                                        \
        if ((h1 + o1) >= (h2 + o2)) {                                   \
                /* src after dest: copy forward */                      \
                for (o = 0; c != 0; c--, o += BYTES)                    \
                        __CONCAT(bus_space_write_,BYTES)(t, h2, o2 + o, \
                            __CONCAT(bus_space_read_,BYTES)(t, h1, o1 + o)); \
        } else {                                                        \
                /* dest after src: copy backwards */                    \
                for (o = (c - 1) * BYTES; c != 0; c--, o -= BYTES)      \
                        __CONCAT(bus_space_write_,BYTES)(t, h2, o2 + o, \
                            __CONCAT(bus_space_read_,BYTES)(t, h1, o1 + o)); \
        }                                                               \
}
__MACHINE_copy_region_N(1)
__MACHINE_copy_region_N(2)
__MACHINE_copy_region_N(4)

#undef __MACHINE_copy_region_N

/*
 * 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 680x0 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 */

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

/*
 * There is no bus_dma(9)'fied bus drivers on this port.
 */
#define __HAVE_NO_BUS_DMA

#endif /* _MACHINE_BUS_H_ */