Home | History | Annotate | Line # | Download | only in include
bus_defs.h revision 1.11
      1  1.11     ryo /*	$NetBSD: bus_defs.h,v 1.11 2018/04/01 04:35:04 ryo Exp $	*/
      2   1.1  dyoung 
      3   1.1  dyoung /*-
      4   1.1  dyoung  * Copyright (c) 1996, 1997, 1998, 2001 The NetBSD Foundation, Inc.
      5   1.1  dyoung  * All rights reserved.
      6   1.1  dyoung  *
      7   1.1  dyoung  * This code is derived from software contributed to The NetBSD Foundation
      8   1.1  dyoung  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
      9   1.1  dyoung  * NASA Ames Research Center.
     10   1.1  dyoung  *
     11   1.1  dyoung  * Redistribution and use in source and binary forms, with or without
     12   1.1  dyoung  * modification, are permitted provided that the following conditions
     13   1.1  dyoung  * are met:
     14   1.1  dyoung  * 1. Redistributions of source code must retain the above copyright
     15   1.1  dyoung  *    notice, this list of conditions and the following disclaimer.
     16   1.1  dyoung  * 2. Redistributions in binary form must reproduce the above copyright
     17   1.1  dyoung  *    notice, this list of conditions and the following disclaimer in the
     18   1.1  dyoung  *    documentation and/or other materials provided with the distribution.
     19   1.1  dyoung  *
     20   1.1  dyoung  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     21   1.1  dyoung  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     22   1.1  dyoung  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     23   1.1  dyoung  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     24   1.1  dyoung  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     25   1.1  dyoung  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     26   1.1  dyoung  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     27   1.1  dyoung  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     28   1.1  dyoung  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     29   1.1  dyoung  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     30   1.1  dyoung  * POSSIBILITY OF SUCH DAMAGE.
     31   1.1  dyoung  */
     32   1.1  dyoung 
     33   1.1  dyoung /*
     34   1.1  dyoung  * Copyright (c) 1996 Charles M. Hannum.  All rights reserved.
     35   1.1  dyoung  * Copyright (c) 1996 Christopher G. Demetriou.  All rights reserved.
     36   1.1  dyoung  *
     37   1.1  dyoung  * Redistribution and use in source and binary forms, with or without
     38   1.1  dyoung  * modification, are permitted provided that the following conditions
     39   1.1  dyoung  * are met:
     40   1.1  dyoung  * 1. Redistributions of source code must retain the above copyright
     41   1.1  dyoung  *    notice, this list of conditions and the following disclaimer.
     42   1.1  dyoung  * 2. Redistributions in binary form must reproduce the above copyright
     43   1.1  dyoung  *    notice, this list of conditions and the following disclaimer in the
     44   1.1  dyoung  *    documentation and/or other materials provided with the distribution.
     45   1.1  dyoung  * 3. All advertising materials mentioning features or use of this software
     46   1.1  dyoung  *    must display the following acknowledgement:
     47   1.1  dyoung  *      This product includes software developed by Christopher G. Demetriou
     48   1.1  dyoung  *	for the NetBSD Project.
     49   1.1  dyoung  * 4. The name of the author may not be used to endorse or promote products
     50   1.1  dyoung  *    derived from this software without specific prior written permission
     51   1.1  dyoung  *
     52   1.1  dyoung  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     53   1.1  dyoung  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     54   1.1  dyoung  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     55   1.1  dyoung  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     56   1.1  dyoung  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     57   1.1  dyoung  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     58   1.1  dyoung  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     59   1.1  dyoung  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     60   1.1  dyoung  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     61   1.1  dyoung  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     62   1.1  dyoung  */
     63   1.1  dyoung 
     64  1.10    matt #ifndef _ARM_BUS_DEFS_H_
     65  1.10    matt #define _ARM_BUS_DEFS_H_
     66   1.1  dyoung 
     67   1.1  dyoung #if defined(_KERNEL_OPT)
     68   1.1  dyoung #include "opt_arm_bus_space.h"
     69   1.1  dyoung #endif
     70   1.1  dyoung 
     71   1.1  dyoung /*
     72   1.1  dyoung  * Addresses (in bus space).
     73   1.1  dyoung  */
     74   1.1  dyoung typedef u_long bus_addr_t;
     75   1.1  dyoung typedef u_long bus_size_t;
     76   1.1  dyoung 
     77   1.9    matt #define	PRIxBUSADDR	"lx"
     78   1.9    matt #define	PRIxBUSSIZE	"lx"
     79   1.9    matt #define	PRIuBUSSIZE	"lu"
     80   1.9    matt 
     81   1.1  dyoung /*
     82   1.1  dyoung  * Access methods for bus space.
     83   1.1  dyoung  */
     84   1.1  dyoung typedef struct bus_space *bus_space_tag_t;
     85   1.1  dyoung typedef u_long bus_space_handle_t;
     86   1.1  dyoung 
     87   1.9    matt #define	PRIxBSH		"lx"
     88   1.9    matt 
     89   1.1  dyoung /*
     90   1.1  dyoung  *	int bus_space_map(bus_space_tag_t t, bus_addr_t addr,
     91   1.1  dyoung  *	    bus_size_t size, int flags, bus_space_handle_t *bshp);
     92   1.1  dyoung  *
     93   1.1  dyoung  * Map a region of bus space.
     94   1.1  dyoung  */
     95   1.1  dyoung 
     96   1.1  dyoung #define	BUS_SPACE_MAP_CACHEABLE		0x01
     97   1.1  dyoung #define	BUS_SPACE_MAP_LINEAR		0x02
     98   1.1  dyoung #define	BUS_SPACE_MAP_PREFETCHABLE     	0x04
     99   1.1  dyoung 
    100   1.1  dyoung struct bus_space {
    101   1.1  dyoung 	/* cookie */
    102   1.1  dyoung 	void		*bs_cookie;
    103   1.1  dyoung 
    104  1.11     ryo 	/* used for aarch64. require ".bs_cookie = bus_space" */
    105  1.11     ryo 	int		bs_stride;	/* offset <<= bs_stride (if needed) */
    106  1.11     ryo 	int		bs_flags;
    107  1.11     ryo 
    108   1.1  dyoung 	/* mapping/unmapping */
    109   1.1  dyoung 	int		(*bs_map)(void *, bus_addr_t, bus_size_t,
    110   1.1  dyoung 			    int, bus_space_handle_t *);
    111   1.1  dyoung 	void		(*bs_unmap)(void *, bus_space_handle_t,
    112   1.1  dyoung 			    bus_size_t);
    113   1.1  dyoung 	int		(*bs_subregion)(void *, bus_space_handle_t,
    114   1.1  dyoung 			    bus_size_t, bus_size_t, bus_space_handle_t *);
    115   1.1  dyoung 
    116   1.1  dyoung 	/* allocation/deallocation */
    117   1.1  dyoung 	int		(*bs_alloc)(void *, bus_addr_t, bus_addr_t,
    118   1.1  dyoung 			    bus_size_t, bus_size_t, bus_size_t, int,
    119   1.1  dyoung 			    bus_addr_t *, bus_space_handle_t *);
    120   1.1  dyoung 	void		(*bs_free)(void *, bus_space_handle_t,
    121   1.1  dyoung 			    bus_size_t);
    122   1.1  dyoung 
    123   1.1  dyoung 	/* get kernel virtual address */
    124   1.1  dyoung 	void *		(*bs_vaddr)(void *, bus_space_handle_t);
    125   1.1  dyoung 
    126   1.1  dyoung 	/* mmap bus space for user */
    127   1.1  dyoung 	paddr_t		(*bs_mmap)(void *, bus_addr_t, off_t, int, int);
    128   1.1  dyoung 
    129   1.1  dyoung 	/* barrier */
    130   1.1  dyoung 	void		(*bs_barrier)(void *, bus_space_handle_t,
    131   1.1  dyoung 			    bus_size_t, bus_size_t, int);
    132   1.1  dyoung 
    133   1.1  dyoung 	/* read (single) */
    134   1.5   skrll 	uint8_t		(*bs_r_1)(void *, bus_space_handle_t,
    135   1.1  dyoung 			    bus_size_t);
    136   1.5   skrll 	uint16_t	(*bs_r_2)(void *, bus_space_handle_t,
    137   1.1  dyoung 			    bus_size_t);
    138   1.5   skrll 	uint32_t	(*bs_r_4)(void *, bus_space_handle_t,
    139   1.1  dyoung 			    bus_size_t);
    140   1.5   skrll 	uint64_t	(*bs_r_8)(void *, bus_space_handle_t,
    141   1.1  dyoung 			    bus_size_t);
    142   1.1  dyoung 
    143   1.1  dyoung 	/* read multiple */
    144   1.1  dyoung 	void		(*bs_rm_1)(void *, bus_space_handle_t,
    145   1.5   skrll 			    bus_size_t, uint8_t *, bus_size_t);
    146   1.1  dyoung 	void		(*bs_rm_2)(void *, bus_space_handle_t,
    147   1.5   skrll 			    bus_size_t, uint16_t *, bus_size_t);
    148   1.1  dyoung 	void		(*bs_rm_4)(void *, bus_space_handle_t,
    149   1.5   skrll 			    bus_size_t, uint32_t *, bus_size_t);
    150   1.1  dyoung 	void		(*bs_rm_8)(void *, bus_space_handle_t,
    151   1.5   skrll 			    bus_size_t, uint64_t *, bus_size_t);
    152   1.1  dyoung 
    153   1.1  dyoung 	/* read region */
    154   1.1  dyoung 	void		(*bs_rr_1)(void *, bus_space_handle_t,
    155   1.5   skrll 			    bus_size_t, uint8_t *, bus_size_t);
    156   1.1  dyoung 	void		(*bs_rr_2)(void *, bus_space_handle_t,
    157   1.5   skrll 			    bus_size_t, uint16_t *, bus_size_t);
    158   1.1  dyoung 	void		(*bs_rr_4)(void *, bus_space_handle_t,
    159   1.5   skrll 			    bus_size_t, uint32_t *, bus_size_t);
    160   1.1  dyoung 	void		(*bs_rr_8)(void *, bus_space_handle_t,
    161   1.5   skrll 			    bus_size_t, uint64_t *, bus_size_t);
    162  1.11     ryo 
    163   1.1  dyoung 	/* write (single) */
    164   1.1  dyoung 	void		(*bs_w_1)(void *, bus_space_handle_t,
    165   1.5   skrll 			    bus_size_t, uint8_t);
    166   1.1  dyoung 	void		(*bs_w_2)(void *, bus_space_handle_t,
    167   1.5   skrll 			    bus_size_t, uint16_t);
    168   1.1  dyoung 	void		(*bs_w_4)(void *, bus_space_handle_t,
    169   1.5   skrll 			    bus_size_t, uint32_t);
    170   1.1  dyoung 	void		(*bs_w_8)(void *, bus_space_handle_t,
    171   1.5   skrll 			    bus_size_t, uint64_t);
    172   1.1  dyoung 
    173   1.1  dyoung 	/* write multiple */
    174   1.1  dyoung 	void		(*bs_wm_1)(void *, bus_space_handle_t,
    175   1.5   skrll 			    bus_size_t, const uint8_t *, bus_size_t);
    176   1.1  dyoung 	void		(*bs_wm_2)(void *, bus_space_handle_t,
    177   1.5   skrll 			    bus_size_t, const uint16_t *, bus_size_t);
    178   1.1  dyoung 	void		(*bs_wm_4)(void *, bus_space_handle_t,
    179   1.5   skrll 			    bus_size_t, const uint32_t *, bus_size_t);
    180   1.1  dyoung 	void		(*bs_wm_8)(void *, bus_space_handle_t,
    181   1.5   skrll 			    bus_size_t, const uint64_t *, bus_size_t);
    182  1.11     ryo 
    183   1.1  dyoung 	/* write region */
    184   1.1  dyoung 	void		(*bs_wr_1)(void *, bus_space_handle_t,
    185   1.5   skrll 			    bus_size_t, const uint8_t *, bus_size_t);
    186   1.1  dyoung 	void		(*bs_wr_2)(void *, bus_space_handle_t,
    187   1.5   skrll 			    bus_size_t, const uint16_t *, bus_size_t);
    188   1.1  dyoung 	void		(*bs_wr_4)(void *, bus_space_handle_t,
    189   1.5   skrll 			    bus_size_t, const uint32_t *, bus_size_t);
    190   1.1  dyoung 	void		(*bs_wr_8)(void *, bus_space_handle_t,
    191   1.5   skrll 			    bus_size_t, const uint64_t *, bus_size_t);
    192   1.1  dyoung 
    193   1.1  dyoung 	/* set multiple */
    194   1.1  dyoung 	void		(*bs_sm_1)(void *, bus_space_handle_t,
    195   1.5   skrll 			    bus_size_t, uint8_t, bus_size_t);
    196   1.1  dyoung 	void		(*bs_sm_2)(void *, bus_space_handle_t,
    197   1.5   skrll 			    bus_size_t, uint16_t, bus_size_t);
    198   1.1  dyoung 	void		(*bs_sm_4)(void *, bus_space_handle_t,
    199   1.5   skrll 			    bus_size_t, uint32_t, bus_size_t);
    200   1.1  dyoung 	void		(*bs_sm_8)(void *, bus_space_handle_t,
    201   1.5   skrll 			    bus_size_t, uint64_t, bus_size_t);
    202   1.1  dyoung 
    203   1.1  dyoung 	/* set region */
    204   1.1  dyoung 	void		(*bs_sr_1)(void *, bus_space_handle_t,
    205   1.5   skrll 			    bus_size_t, uint8_t, bus_size_t);
    206   1.1  dyoung 	void		(*bs_sr_2)(void *, bus_space_handle_t,
    207   1.5   skrll 			    bus_size_t, uint16_t, bus_size_t);
    208   1.1  dyoung 	void		(*bs_sr_4)(void *, bus_space_handle_t,
    209   1.5   skrll 			    bus_size_t, uint32_t, bus_size_t);
    210   1.1  dyoung 	void		(*bs_sr_8)(void *, bus_space_handle_t,
    211   1.5   skrll 			    bus_size_t, uint64_t, bus_size_t);
    212   1.1  dyoung 
    213   1.1  dyoung 	/* copy */
    214   1.1  dyoung 	void		(*bs_c_1)(void *, bus_space_handle_t, bus_size_t,
    215   1.1  dyoung 			    bus_space_handle_t, bus_size_t, bus_size_t);
    216   1.1  dyoung 	void		(*bs_c_2)(void *, bus_space_handle_t, bus_size_t,
    217   1.1  dyoung 			    bus_space_handle_t, bus_size_t, bus_size_t);
    218   1.1  dyoung 	void		(*bs_c_4)(void *, bus_space_handle_t, bus_size_t,
    219   1.1  dyoung 			    bus_space_handle_t, bus_size_t, bus_size_t);
    220   1.1  dyoung 	void		(*bs_c_8)(void *, bus_space_handle_t, bus_size_t,
    221   1.1  dyoung 			    bus_space_handle_t, bus_size_t, bus_size_t);
    222   1.1  dyoung 
    223   1.1  dyoung #ifdef __BUS_SPACE_HAS_STREAM_METHODS
    224   1.1  dyoung 	/* read stream (single) */
    225   1.5   skrll 	uint8_t		(*bs_r_1_s)(void *, bus_space_handle_t,
    226   1.1  dyoung 			    bus_size_t);
    227   1.5   skrll 	uint16_t	(*bs_r_2_s)(void *, bus_space_handle_t,
    228   1.1  dyoung 			    bus_size_t);
    229   1.5   skrll 	uint32_t	(*bs_r_4_s)(void *, bus_space_handle_t,
    230   1.1  dyoung 			    bus_size_t);
    231   1.5   skrll 	uint64_t	(*bs_r_8_s)(void *, bus_space_handle_t,
    232   1.1  dyoung 			    bus_size_t);
    233   1.1  dyoung 
    234   1.1  dyoung 	/* read multiple stream */
    235   1.1  dyoung 	void		(*bs_rm_1_s)(void *, bus_space_handle_t,
    236   1.5   skrll 			    bus_size_t, uint8_t *, bus_size_t);
    237   1.1  dyoung 	void		(*bs_rm_2_s)(void *, bus_space_handle_t,
    238   1.5   skrll 			    bus_size_t, uint16_t *, bus_size_t);
    239   1.1  dyoung 	void		(*bs_rm_4_s)(void *, bus_space_handle_t,
    240   1.5   skrll 			    bus_size_t, uint32_t *, bus_size_t);
    241   1.1  dyoung 	void		(*bs_rm_8_s)(void *, bus_space_handle_t,
    242   1.5   skrll 			    bus_size_t, uint64_t *, bus_size_t);
    243  1.11     ryo 
    244   1.1  dyoung 	/* read region stream */
    245   1.1  dyoung 	void		(*bs_rr_1_s)(void *, bus_space_handle_t,
    246   1.5   skrll 			    bus_size_t, uint8_t *, bus_size_t);
    247   1.1  dyoung 	void		(*bs_rr_2_s)(void *, bus_space_handle_t,
    248   1.5   skrll 			    bus_size_t, uint16_t *, bus_size_t);
    249   1.1  dyoung 	void		(*bs_rr_4_s)(void *, bus_space_handle_t,
    250   1.5   skrll 			    bus_size_t, uint32_t *, bus_size_t);
    251   1.1  dyoung 	void		(*bs_rr_8_s)(void *, bus_space_handle_t,
    252   1.5   skrll 			    bus_size_t, uint64_t *, bus_size_t);
    253  1.11     ryo 
    254   1.1  dyoung 	/* write stream (single) */
    255   1.1  dyoung 	void		(*bs_w_1_s)(void *, bus_space_handle_t,
    256   1.5   skrll 			    bus_size_t, uint8_t);
    257   1.1  dyoung 	void		(*bs_w_2_s)(void *, bus_space_handle_t,
    258   1.5   skrll 			    bus_size_t, uint16_t);
    259   1.1  dyoung 	void		(*bs_w_4_s)(void *, bus_space_handle_t,
    260   1.5   skrll 			    bus_size_t, uint32_t);
    261   1.1  dyoung 	void		(*bs_w_8_s)(void *, bus_space_handle_t,
    262   1.5   skrll 			    bus_size_t, uint64_t);
    263   1.1  dyoung 
    264   1.1  dyoung 	/* write multiple stream */
    265   1.1  dyoung 	void		(*bs_wm_1_s)(void *, bus_space_handle_t,
    266   1.5   skrll 			    bus_size_t, const uint8_t *, bus_size_t);
    267   1.1  dyoung 	void		(*bs_wm_2_s)(void *, bus_space_handle_t,
    268   1.5   skrll 			    bus_size_t, const uint16_t *, bus_size_t);
    269   1.1  dyoung 	void		(*bs_wm_4_s)(void *, bus_space_handle_t,
    270   1.5   skrll 			    bus_size_t, const uint32_t *, bus_size_t);
    271   1.1  dyoung 	void		(*bs_wm_8_s)(void *, bus_space_handle_t,
    272   1.5   skrll 			    bus_size_t, const uint64_t *, bus_size_t);
    273  1.11     ryo 
    274   1.1  dyoung 	/* write region stream */
    275   1.1  dyoung 	void		(*bs_wr_1_s)(void *, bus_space_handle_t,
    276   1.5   skrll 			    bus_size_t, const uint8_t *, bus_size_t);
    277   1.1  dyoung 	void		(*bs_wr_2_s)(void *, bus_space_handle_t,
    278   1.5   skrll 			    bus_size_t, const uint16_t *, bus_size_t);
    279   1.1  dyoung 	void		(*bs_wr_4_s)(void *, bus_space_handle_t,
    280   1.5   skrll 			    bus_size_t, const uint32_t *, bus_size_t);
    281   1.1  dyoung 	void		(*bs_wr_8_s)(void *, bus_space_handle_t,
    282   1.5   skrll 			    bus_size_t, const uint64_t *, bus_size_t);
    283   1.1  dyoung #endif	/* __BUS_SPACE_HAS_STREAM_METHODS */
    284  1.11     ryo 
    285  1.11     ryo #ifdef __BUS_SPACE_HAS_PROBING_METHODS
    286  1.11     ryo 	/* peek */
    287  1.11     ryo 	int		(*bs_pe_1)(void *, bus_space_handle_t,
    288  1.11     ryo 			    bus_size_t, uint8_t *);
    289  1.11     ryo 	int		(*bs_pe_2)(void *, bus_space_handle_t,
    290  1.11     ryo 			    bus_size_t, uint16_t *);
    291  1.11     ryo 	int		(*bs_pe_4)(void *, bus_space_handle_t,
    292  1.11     ryo 			    bus_size_t, uint32_t *);
    293  1.11     ryo 	int		(*bs_pe_8)(void *, bus_space_handle_t,
    294  1.11     ryo 			    bus_size_t, uint64_t *);
    295  1.11     ryo 
    296  1.11     ryo 	/* poke */
    297  1.11     ryo 	int		(*bs_po_1)(void *, bus_space_handle_t,
    298  1.11     ryo 			    bus_size_t, uint8_t);
    299  1.11     ryo 	int		(*bs_po_2)(void *, bus_space_handle_t,
    300  1.11     ryo 			    bus_size_t, uint16_t);
    301  1.11     ryo 	int		(*bs_po_4)(void *, bus_space_handle_t,
    302  1.11     ryo 			    bus_size_t, uint32_t);
    303  1.11     ryo 	int		(*bs_po_8)(void *, bus_space_handle_t,
    304  1.11     ryo 			    bus_size_t, uint64_t);
    305  1.11     ryo #endif /* __BUS_SPACE_HAS_PROBING_METHODS */
    306   1.1  dyoung };
    307   1.1  dyoung 
    308   1.1  dyoung #define	BUS_SPACE_BARRIER_READ	0x01
    309   1.1  dyoung #define	BUS_SPACE_BARRIER_WRITE	0x02
    310   1.1  dyoung 
    311   1.1  dyoung #define BUS_SPACE_ALIGNED_POINTER(p, t) ALIGNED_POINTER(p, t)
    312   1.1  dyoung 
    313   1.1  dyoung /* Bus Space DMA macros */
    314   1.1  dyoung 
    315   1.1  dyoung /*
    316   1.1  dyoung  * Flags used in various bus DMA methods.
    317   1.1  dyoung  */
    318   1.1  dyoung #define	BUS_DMA_WAITOK		0x000	/* safe to sleep (pseudo-flag) */
    319   1.1  dyoung #define	BUS_DMA_NOWAIT		0x001	/* not safe to sleep */
    320   1.1  dyoung #define	BUS_DMA_ALLOCNOW	0x002	/* perform resource allocation now */
    321   1.1  dyoung #define	BUS_DMA_COHERENT	0x004	/* hint: map memory DMA coherent */
    322   1.1  dyoung #define	BUS_DMA_STREAMING	0x008	/* hint: sequential, unidirectional */
    323   1.1  dyoung #define	BUS_DMA_BUS1		0x010	/* placeholders for bus functions... */
    324   1.1  dyoung #define	BUS_DMA_BUS2		0x020
    325   1.1  dyoung #define	BUS_DMA_BUS3		0x040
    326   1.1  dyoung #define	BUS_DMA_BUS4		0x080
    327   1.1  dyoung #define	BUS_DMA_READ		0x100	/* mapping is device -> memory only */
    328   1.1  dyoung #define	BUS_DMA_WRITE		0x200	/* mapping is memory -> device only */
    329   1.1  dyoung #define	BUS_DMA_NOCACHE		0x400	/* hint: map non-cached memory */
    330   1.1  dyoung 
    331   1.1  dyoung /*
    332   1.1  dyoung  * Private flags stored in the DMA map.
    333   1.1  dyoung  */
    334   1.2    matt #define	_BUS_DMAMAP_COHERENT	0x10000	/* no cache flush necessary on sync */
    335   1.7    matt #define	_BUS_DMAMAP_IS_BOUNCING	0x20000 /* is bouncing current xfer */
    336   1.8    matt #define	_BUS_DMAMAP_NOALLOC	0x40000	/* don't alloc memory from this range */
    337   1.1  dyoung 
    338   1.1  dyoung /* Forwards needed by prototypes below. */
    339   1.1  dyoung struct mbuf;
    340   1.1  dyoung struct uio;
    341   1.1  dyoung 
    342   1.1  dyoung /*
    343   1.1  dyoung  * Operations performed by bus_dmamap_sync().
    344   1.1  dyoung  */
    345   1.1  dyoung #define	BUS_DMASYNC_PREREAD	0x01	/* pre-read synchronization */
    346   1.1  dyoung #define	BUS_DMASYNC_POSTREAD	0x02	/* post-read synchronization */
    347   1.1  dyoung #define	BUS_DMASYNC_PREWRITE	0x04	/* pre-write synchronization */
    348   1.1  dyoung #define	BUS_DMASYNC_POSTWRITE	0x08	/* post-write synchronization */
    349   1.1  dyoung 
    350   1.1  dyoung typedef struct arm32_bus_dma_tag	*bus_dma_tag_t;
    351   1.1  dyoung typedef struct arm32_bus_dmamap		*bus_dmamap_t;
    352   1.1  dyoung 
    353   1.1  dyoung #define BUS_DMA_TAG_VALID(t)    ((t) != (bus_dma_tag_t)0)
    354   1.1  dyoung 
    355   1.1  dyoung /*
    356   1.1  dyoung  *	bus_dma_segment_t
    357   1.1  dyoung  *
    358   1.1  dyoung  *	Describes a single contiguous DMA transaction.  Values
    359   1.1  dyoung  *	are suitable for programming into DMA registers.
    360   1.1  dyoung  */
    361   1.1  dyoung struct arm32_bus_dma_segment {
    362   1.1  dyoung 	/*
    363   1.1  dyoung 	 * PUBLIC MEMBERS: these are used by machine-independent code.
    364   1.1  dyoung 	 */
    365   1.1  dyoung 	bus_addr_t	ds_addr;	/* DMA address */
    366   1.1  dyoung 	bus_size_t	ds_len;		/* length of transfer */
    367  1.11     ryo 
    368  1.11     ryo 	/*
    369  1.11     ryo 	 * PRIVATE MEMBERS:
    370  1.11     ryo 	 */
    371   1.3    matt 	uint32_t	_ds_flags;	/* _BUS_DMAMAP_COHERENT */
    372   1.1  dyoung };
    373   1.1  dyoung typedef struct arm32_bus_dma_segment	bus_dma_segment_t;
    374   1.1  dyoung 
    375   1.1  dyoung /*
    376   1.1  dyoung  *	arm32_dma_range
    377   1.1  dyoung  *
    378   1.1  dyoung  *	This structure describes a valid DMA range.
    379   1.1  dyoung  */
    380   1.1  dyoung struct arm32_dma_range {
    381   1.1  dyoung 	bus_addr_t	dr_sysbase;	/* system base address */
    382   1.1  dyoung 	bus_addr_t	dr_busbase;	/* appears here on bus */
    383   1.1  dyoung 	bus_size_t	dr_len;		/* length of range */
    384   1.3    matt 	uint32_t	dr_flags;	/* flags for range */
    385   1.1  dyoung };
    386   1.1  dyoung 
    387   1.1  dyoung /*
    388   1.1  dyoung  *	bus_dma_tag_t
    389   1.1  dyoung  *
    390   1.1  dyoung  *	A machine-dependent opaque type describing the implementation of
    391   1.1  dyoung  *	DMA for a given bus.
    392   1.1  dyoung  */
    393   1.1  dyoung 
    394   1.1  dyoung struct arm32_bus_dma_tag {
    395   1.1  dyoung 	/*
    396   1.1  dyoung 	 * DMA range for this tag.  If the page doesn't fall within
    397   1.1  dyoung 	 * one of these ranges, an error is returned.  The caller
    398   1.1  dyoung 	 * may then decide what to do with the transfer.  If the
    399   1.1  dyoung 	 * range pointer is NULL, it is ignored.
    400   1.1  dyoung 	 */
    401   1.1  dyoung 	struct arm32_dma_range *_ranges;
    402   1.1  dyoung 	int _nranges;
    403   1.1  dyoung 
    404   1.1  dyoung 	/*
    405   1.1  dyoung 	 * Opaque cookie for use by back-end.
    406   1.1  dyoung 	 */
    407   1.1  dyoung 	void *_cookie;
    408   1.1  dyoung 
    409   1.1  dyoung 	/*
    410   1.1  dyoung 	 * DMA mapping methods.
    411   1.1  dyoung 	 */
    412   1.1  dyoung 	int	(*_dmamap_create)(bus_dma_tag_t, bus_size_t, int,
    413   1.1  dyoung 		    bus_size_t, bus_size_t, int, bus_dmamap_t *);
    414   1.1  dyoung 	void	(*_dmamap_destroy)(bus_dma_tag_t, bus_dmamap_t);
    415   1.1  dyoung 	int	(*_dmamap_load)(bus_dma_tag_t, bus_dmamap_t, void *,
    416   1.1  dyoung 		    bus_size_t, struct proc *, int);
    417   1.1  dyoung 	int	(*_dmamap_load_mbuf)(bus_dma_tag_t, bus_dmamap_t,
    418   1.1  dyoung 		    struct mbuf *, int);
    419   1.1  dyoung 	int	(*_dmamap_load_uio)(bus_dma_tag_t, bus_dmamap_t,
    420   1.1  dyoung 		    struct uio *, int);
    421   1.1  dyoung 	int	(*_dmamap_load_raw)(bus_dma_tag_t, bus_dmamap_t,
    422   1.1  dyoung 		    bus_dma_segment_t *, int, bus_size_t, int);
    423   1.1  dyoung 	void	(*_dmamap_unload)(bus_dma_tag_t, bus_dmamap_t);
    424   1.1  dyoung 	void	(*_dmamap_sync_pre)(bus_dma_tag_t, bus_dmamap_t,
    425   1.1  dyoung 		    bus_addr_t, bus_size_t, int);
    426   1.1  dyoung 	void	(*_dmamap_sync_post)(bus_dma_tag_t, bus_dmamap_t,
    427   1.1  dyoung 		    bus_addr_t, bus_size_t, int);
    428   1.1  dyoung 
    429   1.1  dyoung 	/*
    430   1.1  dyoung 	 * DMA memory utility functions.
    431   1.1  dyoung 	 */
    432   1.1  dyoung 	int	(*_dmamem_alloc)(bus_dma_tag_t, bus_size_t, bus_size_t,
    433   1.1  dyoung 		    bus_size_t, bus_dma_segment_t *, int, int *, int);
    434   1.1  dyoung 	void	(*_dmamem_free)(bus_dma_tag_t,
    435   1.1  dyoung 		    bus_dma_segment_t *, int);
    436   1.1  dyoung 	int	(*_dmamem_map)(bus_dma_tag_t, bus_dma_segment_t *,
    437   1.1  dyoung 		    int, size_t, void **, int);
    438   1.1  dyoung 	void	(*_dmamem_unmap)(bus_dma_tag_t, void *, size_t);
    439   1.1  dyoung 	paddr_t	(*_dmamem_mmap)(bus_dma_tag_t, bus_dma_segment_t *,
    440   1.1  dyoung 		    int, off_t, int, int);
    441   1.2    matt 
    442   1.2    matt 	/*
    443   1.2    matt 	 * DMA tag utility functions
    444   1.2    matt 	 */
    445   1.2    matt 	int	(*_dmatag_subregion)(bus_dma_tag_t, bus_addr_t, bus_addr_t,
    446   1.2    matt 		     bus_dma_tag_t *, int);
    447   1.2    matt 	void	(*_dmatag_destroy)(bus_dma_tag_t);
    448   1.2    matt 
    449   1.2    matt 	/*
    450   1.2    matt 	 * State for bounce buffers
    451   1.2    matt 	 */
    452   1.2    matt 	int	_tag_needs_free;
    453   1.2    matt 	int	(*_may_bounce)(bus_dma_tag_t, bus_dmamap_t, int, int *);
    454   1.1  dyoung };
    455   1.1  dyoung 
    456   1.1  dyoung /*
    457   1.1  dyoung  *	bus_dmamap_t
    458   1.1  dyoung  *
    459   1.1  dyoung  *	Describes a DMA mapping.
    460   1.1  dyoung  */
    461   1.1  dyoung struct arm32_bus_dmamap {
    462   1.1  dyoung 	/*
    463   1.1  dyoung 	 * PRIVATE MEMBERS: not for use by machine-independent code.
    464   1.1  dyoung 	 */
    465   1.1  dyoung 	bus_size_t	_dm_size;	/* largest DMA transfer mappable */
    466   1.1  dyoung 	int		_dm_segcnt;	/* number of segs this map can map */
    467   1.1  dyoung 	bus_size_t	_dm_maxmaxsegsz; /* fixed largest possible segment */
    468   1.1  dyoung 	bus_size_t	_dm_boundary;	/* don't cross this */
    469   1.1  dyoung 	int		_dm_flags;	/* misc. flags */
    470   1.1  dyoung 
    471   1.1  dyoung 	void		*_dm_origbuf;	/* pointer to original buffer */
    472   1.1  dyoung 	int		_dm_buftype;	/* type of buffer */
    473   1.1  dyoung 	struct vmspace	*_dm_vmspace;	/* vmspace that owns the mapping */
    474   1.1  dyoung 
    475   1.1  dyoung 	void		*_dm_cookie;	/* cookie for bus-specific functions */
    476   1.1  dyoung 
    477   1.1  dyoung 	/*
    478   1.1  dyoung 	 * PUBLIC MEMBERS: these are used by machine-independent code.
    479   1.1  dyoung 	 */
    480   1.1  dyoung 	bus_size_t	dm_maxsegsz;	/* largest possible segment */
    481   1.1  dyoung 	bus_size_t	dm_mapsize;	/* size of the mapping */
    482   1.1  dyoung 	int		dm_nsegs;	/* # valid segments in mapping */
    483   1.1  dyoung 	bus_dma_segment_t dm_segs[1];	/* segments; variable length */
    484   1.1  dyoung };
    485   1.1  dyoung 
    486   1.2    matt /* _dm_buftype */
    487   1.2    matt #define	_BUS_DMA_BUFTYPE_INVALID	0
    488   1.2    matt #define	_BUS_DMA_BUFTYPE_LINEAR		1
    489   1.2    matt #define	_BUS_DMA_BUFTYPE_MBUF		2
    490   1.2    matt #define	_BUS_DMA_BUFTYPE_UIO		3
    491   1.2    matt #define	_BUS_DMA_BUFTYPE_RAW		4
    492   1.2    matt 
    493   1.1  dyoung #ifdef _ARM32_BUS_DMA_PRIVATE
    494   1.2    matt #define	_BUS_AVAIL_END	physical_end
    495   1.2    matt /*
    496   1.2    matt  * Cookie used for bounce buffers. A pointer to one of these it stashed in
    497   1.2    matt  * the DMA map.
    498   1.2    matt  */
    499   1.2    matt struct arm32_bus_dma_cookie {
    500   1.2    matt 	int	id_flags;		/* flags; see below */
    501   1.1  dyoung 
    502   1.2    matt 	/*
    503   1.2    matt 	 * Information about the original buffer used during
    504   1.2    matt 	 * DMA map syncs.  Note that origibuflen is only used
    505   1.2    matt 	 * for ID_BUFTYPE_LINEAR.
    506   1.2    matt 	 */
    507   1.2    matt 	union {
    508   1.2    matt 		void	*un_origbuf;		/* pointer to orig buffer if
    509   1.2    matt 						   bouncing */
    510   1.2    matt 		char	*un_linearbuf;
    511   1.2    matt 		struct mbuf	*un_mbuf;
    512   1.2    matt 		struct uio	*un_uio;
    513   1.2    matt 	} id_origbuf_un;
    514   1.2    matt #define	id_origbuf		id_origbuf_un.un_origbuf
    515   1.2    matt #define	id_origlinearbuf	id_origbuf_un.un_linearbuf
    516   1.2    matt #define	id_origmbuf		id_origbuf_un.un_mbuf
    517   1.2    matt #define	id_origuio		id_origbuf_un.un_uio
    518   1.2    matt 	bus_size_t id_origbuflen;	/* ...and size */
    519   1.2    matt 
    520   1.2    matt 	void	*id_bouncebuf;		/* pointer to the bounce buffer */
    521   1.2    matt 	bus_size_t id_bouncebuflen;	/* ...and size */
    522   1.2    matt 	int	id_nbouncesegs;		/* number of valid bounce segs */
    523   1.2    matt 	bus_dma_segment_t id_bouncesegs[0]; /* array of bounce buffer
    524   1.2    matt 					       physical memory segments */
    525   1.2    matt };
    526   1.1  dyoung 
    527   1.2    matt /* id_flags */
    528   1.2    matt #define	_BUS_DMA_IS_BOUNCING		0x04	/* is bouncing current xfer */
    529   1.2    matt #define	_BUS_DMA_HAS_BOUNCE		0x02	/* has bounce buffers */
    530   1.1  dyoung #endif /* _ARM32_BUS_DMA_PRIVATE */
    531   1.2    matt #define	_BUS_DMA_MIGHT_NEED_BOUNCE	0x01	/* may need bounce buffers */
    532   1.1  dyoung 
    533  1.10    matt #endif /* _ARM_BUS_DEFS_H_ */
    534