/*      $NetBSD: bus_defs.h,v 1.3 2023/01/27 20:05:03 tsutsui Exp $     */

/*-
* Copyright (c) 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) 1996 Carnegie-Mellon University.
* All rights reserved.
*
* Author: Chris G. Demetriou
*
* Permission to use, copy, modify and distribute this software and
* its documentation is hereby granted, provided that both the copyright
* notice and this permission notice appear in all copies of the
* software, derivative works or modified versions, and any portions
* thereof, and that both notices appear in supporting documentation.
*
* CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
* CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
* FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
*
* Carnegie Mellon requests users of this software to return to
*
*  Software Distribution Coordinator  or  [email protected]
*  School of Computer Science
*  Carnegie Mellon University
*  Pittsburgh PA 15213-3890
*
* any improvements or extensions that they make and grant Carnegie the
* rights to redistribute these changes.
*/

#ifndef _ATARI_BUS_DEFS_H_
#define _ATARI_BUS_DEFS_H_

/*
* Memory addresses (in bus space)
*/
typedef u_long  bus_addr_t;
typedef u_long  bus_size_t;

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

/*
* I/O addresses (in bus space)
*/
typedef u_long bus_io_addr_t;
typedef u_long bus_io_size_t;

#define __BUS_SPACE_HAS_STREAM_METHODS

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

#define PRIxBSH         "lx"

#define BUS_SPACE_MAP_CACHEABLE         0x01
#define BUS_SPACE_MAP_LINEAR            0x02
#define BUS_SPACE_MAP_PREFETCHABLE      0x04

/*
* Structure containing functions and other feature-data that might differ
* between the various bus spaces on the atari. Currently 'known' bus
* spaces are: ISA, PCI, VME and 'mainbus'.
*/
struct atari_bus_space {
       u_long  base;

       /* XXX Next 2 lines can be turned into an opaque cookie */
       int     stride;
       int     wo_1, wo_2, wo_4, wo_8;

       /* Autoconf detection stuff */
       int             (*abs_p_1)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t);
       int             (*abs_p_2)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t);
       int             (*abs_p_4)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t);
       int             (*abs_p_8)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t);

       /* read (single) */
       uint8_t         (*abs_r_1)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t);
       uint16_t        (*abs_r_2)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t);
       uint32_t        (*abs_r_4)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t);
       uint64_t        (*abs_r_8)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t);

       /* read (single) stream */
       uint8_t         (*abs_rs_1)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t);
       uint16_t        (*abs_rs_2)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t);
       uint32_t        (*abs_rs_4)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t);
       uint64_t        (*abs_rs_8)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t);

       /* read multiple */
       void            (*abs_rm_1)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, uint8_t *, bus_size_t);
       void            (*abs_rm_2)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, uint16_t *, bus_size_t);
       void            (*abs_rm_4)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, uint32_t *, bus_size_t);
       void            (*abs_rm_8)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, uint64_t *, bus_size_t);

       /* read multiple stream */
       void            (*abs_rms_1)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, uint8_t *, bus_size_t);
       void            (*abs_rms_2)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, uint16_t *, bus_size_t);
       void            (*abs_rms_4)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, uint32_t *, bus_size_t);
       void            (*abs_rms_8)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, uint64_t *, bus_size_t);

       /* read region */
       void            (*abs_rr_1)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, uint8_t *, bus_size_t);
       void            (*abs_rr_2)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, uint16_t *, bus_size_t);
       void            (*abs_rr_4)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, uint32_t *, bus_size_t);
       void            (*abs_rr_8)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, uint64_t *, bus_size_t);

       /* read region stream */
       void            (*abs_rrs_1)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, uint8_t *, bus_size_t);
       void            (*abs_rrs_2)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, uint16_t *, bus_size_t);
       void            (*abs_rrs_4)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, uint32_t *, bus_size_t);
       void            (*abs_rrs_8)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, uint64_t *, bus_size_t);

       /* write (single) */
       void            (*abs_w_1)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, uint8_t);
       void            (*abs_w_2)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, uint16_t);
       void            (*abs_w_4)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, uint32_t);
       void            (*abs_w_8)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, uint64_t);

       /* write (single) stream */
       void            (*abs_ws_1)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, uint8_t);
       void            (*abs_ws_2)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, uint16_t);
       void            (*abs_ws_4)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, uint32_t);
       void            (*abs_ws_8)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, uint64_t);

       /* write multiple */
       void            (*abs_wm_1)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, const uint8_t *, bus_size_t);
       void            (*abs_wm_2)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, const uint16_t *, bus_size_t);
       void            (*abs_wm_4)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, const uint32_t *, bus_size_t);
       void            (*abs_wm_8)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, const uint64_t *, bus_size_t);

       /* write multiple stream */
       void            (*abs_wms_1)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, const uint8_t *, bus_size_t);
       void            (*abs_wms_2)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, const uint16_t *, bus_size_t);
       void            (*abs_wms_4)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, const uint32_t *, bus_size_t);
       void            (*abs_wms_8)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, const uint64_t *, bus_size_t);

       /* write region */
       void            (*abs_wr_1)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, const uint8_t *, bus_size_t);
       void            (*abs_wr_2)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, const uint16_t *, bus_size_t);
       void            (*abs_wr_4)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, const uint32_t *, bus_size_t);
       void            (*abs_wr_8)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, const uint64_t *, bus_size_t);

       /* write region stream */
       void            (*abs_wrs_1)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, const uint8_t *, bus_size_t);
       void            (*abs_wrs_2)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, const uint16_t *, bus_size_t);
       void            (*abs_wrs_4)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, const uint32_t *, bus_size_t);
       void            (*abs_wrs_8)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, const uint64_t *, bus_size_t);

       /* set multiple */
       void            (*abs_sm_1)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, uint8_t, bus_size_t);
       void            (*abs_sm_2)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, uint16_t, bus_size_t);
       void            (*abs_sm_4)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, uint32_t, bus_size_t);
       void            (*abs_sm_8)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, uint64_t, bus_size_t);

       /* set region */
       void            (*abs_sr_1)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, uint8_t, bus_size_t);
       void            (*abs_sr_2)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, uint16_t, bus_size_t);
       void            (*abs_sr_4)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, uint32_t, bus_size_t);
       void            (*abs_sr_8)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, uint64_t, bus_size_t);

#if 0 /* See comment on __abs_copy below */
       /* copy */
       void            (*abs_c_1)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, bus_space_handle_t, bus_size_t,
                           bus_size_t);
       void            (*abs_c_2)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, bus_space_handle_t, bus_size_t,
                           bus_size_t);
       void            (*abs_c_4)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, bus_space_handle_t, bus_size_t,
                           bus_size_t);
       void            (*abs_c_8)(bus_space_tag_t, bus_space_handle_t,
                           bus_size_t, bus_space_handle_t, bus_size_t,
                           bus_size_t);
#endif
};

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

#define BUS_SPACE_BARRIER_READ  0x01    /* force read barrier */
#define BUS_SPACE_BARRIER_WRITE 0x02    /* force write barrier */

/*
* Flags used in various bus DMA methods.
*/
#define BUS_DMA_WAITOK          0x000   /* safe to sleep (pseudo-flag)       */
#define BUS_DMA_NOWAIT          0x001   /* not safe to sleep                 */
#define BUS_DMA_ALLOCNOW        0x002   /* perform resource allocation now   */
#define BUS_DMA_COHERENT        0x004   /* hint: map memory DMA coherent     */
#define BUS_DMA_STREAMING       0x008   /* hint: sequential, unidirectional */
#define BUS_DMA_BUS1            0x010   /* placeholders for bus functions... */
#define BUS_DMA_BUS2            0x020
#define BUS_DMA_BUS3            0x040
#define BUS_DMA_BUS4            0x080
#define BUS_DMA_READ            0x100   /* mapping is device -> memory only */
#define BUS_DMA_WRITE           0x200   /* mapping is memory -> device only */
#define BUS_DMA_NOCACHE         0x400   /* hint: map non-cached memory */

/* Forwards needed by prototypes below. */
struct mbuf;
struct uio;

/*
* Operations performed by bus_dmamap_sync().
*/
#define BUS_DMASYNC_PREREAD     0x01    /* pre-read synchronization */
#define BUS_DMASYNC_POSTREAD    0x02    /* post-read synchronization */
#define BUS_DMASYNC_PREWRITE    0x04    /* pre-write synchronization */
#define BUS_DMASYNC_POSTWRITE   0x08    /* post-write synchronization */

typedef struct atari_bus_dma_tag        *bus_dma_tag_t;
typedef struct atari_bus_dmamap         *bus_dmamap_t;

#define BUS_DMA_TAG_VALID(t)    ((t) != (bus_dma_tag_t)0)

/*
*      bus_dma_segment_t
*
*      Describes a single contiguous DMA transaction.  Values
*      are suitable for programming into DMA registers.
*/
struct atari_bus_dma_segment {
       bus_addr_t      ds_addr;        /* DMA address */
       bus_size_t      ds_len;         /* length of transfer */
};
typedef struct atari_bus_dma_segment    bus_dma_segment_t;

/*
*      bus_dma_tag_t
*
*      A machine-dependent opaque type describing the implementation of
*      DMA for a given bus.
*/
struct atari_bus_dma_tag {
       /*
        * The `bounce threshold' is checked while we are loading
        * the DMA map.  If the physical address of the segment
        * exceeds the threshold, an error will be returned.  The
        * caller can then take whatever action is necessary to
        * bounce the transfer.  If this value is 0, it will be
        * ignored.
        */
       bus_addr_t      _bounce_thresh;

       /*
        * The next value can be used to compensate for a constant
        * displacement between the address space view of the CPU
        * and the devices on the bus.
        */
       int32_t         _displacement;

       /*
        * DMA mapping methods.
        */
       int     (*_dmamap_create)(bus_dma_tag_t, bus_size_t, int,
                   bus_size_t, bus_size_t, int, bus_dmamap_t *);
       void    (*_dmamap_destroy)(bus_dma_tag_t, bus_dmamap_t);
       int     (*_dmamap_load)(bus_dma_tag_t, bus_dmamap_t, void *,
                   bus_size_t, struct proc *, int);
       int     (*_dmamap_load_mbuf)(bus_dma_tag_t, bus_dmamap_t,
                   struct mbuf *, int);
       int     (*_dmamap_load_uio)(bus_dma_tag_t, bus_dmamap_t,
                   struct uio *, int);
       int     (*_dmamap_load_raw)(bus_dma_tag_t, bus_dmamap_t,
                   bus_dma_segment_t *, int, bus_size_t, int);
       void    (*_dmamap_unload)(bus_dma_tag_t, bus_dmamap_t);
       void    (*_dmamap_sync)(bus_dma_tag_t, bus_dmamap_t,
                   bus_addr_t, bus_size_t, int);
};

/*
*      bus_dmamap_t
*
*      Describes a DMA mapping.
*/
struct atari_bus_dmamap {
       /*
        * PRIVATE MEMBERS: not for use my machine-independent code.
        */
       bus_size_t      _dm_size;          /* largest DMA transfer mappable */
       int             _dm_segcnt;        /* number of segs this map can map */
       bus_size_t      _dm_maxmaxsegsz;   /* fixed largest possible segment */
       bus_size_t      _dm_boundary;      /* don't cross this */
       bus_addr_t      _dm_bounce_thresh; /* bounce threshold; see tag */
       int             _dm_flags;         /* misc. flags */

       void            *_dm_cookie;       /* cookie for bus-specific funcs */

       /*
        * PUBLIC MEMBERS: these are used by machine-independent code.
        */
       bus_size_t      dm_maxsegsz;       /* largest possible segment */
       bus_size_t      dm_mapsize;     /* size of the mapping */
       int             dm_nsegs;       /* # valid segments in mapping */
       bus_dma_segment_t dm_segs[1];   /* segments; variable length */
};

#endif /* _ATARI_BUS_DEFS_H_ */

You are viewing proxied material from ftp.icm.edu.pl. The copyright of proxied material belongs to its original authors. Any comments or complaints in relation to proxied material should be directed to the original authors of the content concerned. Please see the disclaimer for more details.