Home | History | Annotate | Line # | Download | only in include
bus_defs.h revision 1.11.2.2
      1  1.11.2.2  martin /*	$NetBSD: bus_defs.h,v 1.11.2.2 2020/04/08 14:07:29 martin 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.11.2.2  martin #define	BUS_SPACE_MAP_BUS1		0x0100
    101  1.11.2.2  martin #define	BUS_SPACE_MAP_BUS2		0x0200
    102  1.11.2.2  martin #define	BUS_SPACE_MAP_BUS3		0x0400
    103  1.11.2.2  martin #define	BUS_SPACE_MAP_BUS4		0x0800
    104  1.11.2.2  martin 
    105  1.11.2.2  martin #define	_ARM_BUS_SPACE_MAP_STRONGLY_ORDERED	BUS_SPACE_MAP_BUS1
    106  1.11.2.2  martin 
    107       1.1  dyoung struct bus_space {
    108       1.1  dyoung 	/* cookie */
    109       1.1  dyoung 	void		*bs_cookie;
    110       1.1  dyoung 
    111      1.11     ryo 	/* used for aarch64. require ".bs_cookie = bus_space" */
    112      1.11     ryo 	int		bs_stride;	/* offset <<= bs_stride (if needed) */
    113      1.11     ryo 	int		bs_flags;
    114      1.11     ryo 
    115       1.1  dyoung 	/* mapping/unmapping */
    116       1.1  dyoung 	int		(*bs_map)(void *, bus_addr_t, bus_size_t,
    117       1.1  dyoung 			    int, bus_space_handle_t *);
    118       1.1  dyoung 	void		(*bs_unmap)(void *, bus_space_handle_t,
    119       1.1  dyoung 			    bus_size_t);
    120       1.1  dyoung 	int		(*bs_subregion)(void *, bus_space_handle_t,
    121       1.1  dyoung 			    bus_size_t, bus_size_t, bus_space_handle_t *);
    122       1.1  dyoung 
    123       1.1  dyoung 	/* allocation/deallocation */
    124       1.1  dyoung 	int		(*bs_alloc)(void *, bus_addr_t, bus_addr_t,
    125       1.1  dyoung 			    bus_size_t, bus_size_t, bus_size_t, int,
    126       1.1  dyoung 			    bus_addr_t *, bus_space_handle_t *);
    127       1.1  dyoung 	void		(*bs_free)(void *, bus_space_handle_t,
    128       1.1  dyoung 			    bus_size_t);
    129       1.1  dyoung 
    130       1.1  dyoung 	/* get kernel virtual address */
    131       1.1  dyoung 	void *		(*bs_vaddr)(void *, bus_space_handle_t);
    132       1.1  dyoung 
    133       1.1  dyoung 	/* mmap bus space for user */
    134       1.1  dyoung 	paddr_t		(*bs_mmap)(void *, bus_addr_t, off_t, int, int);
    135       1.1  dyoung 
    136       1.1  dyoung 	/* barrier */
    137       1.1  dyoung 	void		(*bs_barrier)(void *, bus_space_handle_t,
    138       1.1  dyoung 			    bus_size_t, bus_size_t, int);
    139       1.1  dyoung 
    140       1.1  dyoung 	/* read (single) */
    141       1.5   skrll 	uint8_t		(*bs_r_1)(void *, bus_space_handle_t,
    142       1.1  dyoung 			    bus_size_t);
    143       1.5   skrll 	uint16_t	(*bs_r_2)(void *, bus_space_handle_t,
    144       1.1  dyoung 			    bus_size_t);
    145       1.5   skrll 	uint32_t	(*bs_r_4)(void *, bus_space_handle_t,
    146       1.1  dyoung 			    bus_size_t);
    147       1.5   skrll 	uint64_t	(*bs_r_8)(void *, bus_space_handle_t,
    148       1.1  dyoung 			    bus_size_t);
    149       1.1  dyoung 
    150       1.1  dyoung 	/* read multiple */
    151       1.1  dyoung 	void		(*bs_rm_1)(void *, bus_space_handle_t,
    152       1.5   skrll 			    bus_size_t, uint8_t *, bus_size_t);
    153       1.1  dyoung 	void		(*bs_rm_2)(void *, bus_space_handle_t,
    154       1.5   skrll 			    bus_size_t, uint16_t *, bus_size_t);
    155       1.1  dyoung 	void		(*bs_rm_4)(void *, bus_space_handle_t,
    156       1.5   skrll 			    bus_size_t, uint32_t *, bus_size_t);
    157       1.1  dyoung 	void		(*bs_rm_8)(void *, bus_space_handle_t,
    158       1.5   skrll 			    bus_size_t, uint64_t *, bus_size_t);
    159       1.1  dyoung 
    160       1.1  dyoung 	/* read region */
    161       1.1  dyoung 	void		(*bs_rr_1)(void *, bus_space_handle_t,
    162       1.5   skrll 			    bus_size_t, uint8_t *, bus_size_t);
    163       1.1  dyoung 	void		(*bs_rr_2)(void *, bus_space_handle_t,
    164       1.5   skrll 			    bus_size_t, uint16_t *, bus_size_t);
    165       1.1  dyoung 	void		(*bs_rr_4)(void *, bus_space_handle_t,
    166       1.5   skrll 			    bus_size_t, uint32_t *, bus_size_t);
    167       1.1  dyoung 	void		(*bs_rr_8)(void *, bus_space_handle_t,
    168       1.5   skrll 			    bus_size_t, uint64_t *, bus_size_t);
    169      1.11     ryo 
    170       1.1  dyoung 	/* write (single) */
    171       1.1  dyoung 	void		(*bs_w_1)(void *, bus_space_handle_t,
    172       1.5   skrll 			    bus_size_t, uint8_t);
    173       1.1  dyoung 	void		(*bs_w_2)(void *, bus_space_handle_t,
    174       1.5   skrll 			    bus_size_t, uint16_t);
    175       1.1  dyoung 	void		(*bs_w_4)(void *, bus_space_handle_t,
    176       1.5   skrll 			    bus_size_t, uint32_t);
    177       1.1  dyoung 	void		(*bs_w_8)(void *, bus_space_handle_t,
    178       1.5   skrll 			    bus_size_t, uint64_t);
    179       1.1  dyoung 
    180       1.1  dyoung 	/* write multiple */
    181       1.1  dyoung 	void		(*bs_wm_1)(void *, bus_space_handle_t,
    182       1.5   skrll 			    bus_size_t, const uint8_t *, bus_size_t);
    183       1.1  dyoung 	void		(*bs_wm_2)(void *, bus_space_handle_t,
    184       1.5   skrll 			    bus_size_t, const uint16_t *, bus_size_t);
    185       1.1  dyoung 	void		(*bs_wm_4)(void *, bus_space_handle_t,
    186       1.5   skrll 			    bus_size_t, const uint32_t *, bus_size_t);
    187       1.1  dyoung 	void		(*bs_wm_8)(void *, bus_space_handle_t,
    188       1.5   skrll 			    bus_size_t, const uint64_t *, bus_size_t);
    189      1.11     ryo 
    190       1.1  dyoung 	/* write region */
    191       1.1  dyoung 	void		(*bs_wr_1)(void *, bus_space_handle_t,
    192       1.5   skrll 			    bus_size_t, const uint8_t *, bus_size_t);
    193       1.1  dyoung 	void		(*bs_wr_2)(void *, bus_space_handle_t,
    194       1.5   skrll 			    bus_size_t, const uint16_t *, bus_size_t);
    195       1.1  dyoung 	void		(*bs_wr_4)(void *, bus_space_handle_t,
    196       1.5   skrll 			    bus_size_t, const uint32_t *, bus_size_t);
    197       1.1  dyoung 	void		(*bs_wr_8)(void *, bus_space_handle_t,
    198       1.5   skrll 			    bus_size_t, const uint64_t *, bus_size_t);
    199       1.1  dyoung 
    200       1.1  dyoung 	/* set multiple */
    201       1.1  dyoung 	void		(*bs_sm_1)(void *, bus_space_handle_t,
    202       1.5   skrll 			    bus_size_t, uint8_t, bus_size_t);
    203       1.1  dyoung 	void		(*bs_sm_2)(void *, bus_space_handle_t,
    204       1.5   skrll 			    bus_size_t, uint16_t, bus_size_t);
    205       1.1  dyoung 	void		(*bs_sm_4)(void *, bus_space_handle_t,
    206       1.5   skrll 			    bus_size_t, uint32_t, bus_size_t);
    207       1.1  dyoung 	void		(*bs_sm_8)(void *, bus_space_handle_t,
    208       1.5   skrll 			    bus_size_t, uint64_t, bus_size_t);
    209       1.1  dyoung 
    210       1.1  dyoung 	/* set region */
    211       1.1  dyoung 	void		(*bs_sr_1)(void *, bus_space_handle_t,
    212       1.5   skrll 			    bus_size_t, uint8_t, bus_size_t);
    213       1.1  dyoung 	void		(*bs_sr_2)(void *, bus_space_handle_t,
    214       1.5   skrll 			    bus_size_t, uint16_t, bus_size_t);
    215       1.1  dyoung 	void		(*bs_sr_4)(void *, bus_space_handle_t,
    216       1.5   skrll 			    bus_size_t, uint32_t, bus_size_t);
    217       1.1  dyoung 	void		(*bs_sr_8)(void *, bus_space_handle_t,
    218       1.5   skrll 			    bus_size_t, uint64_t, bus_size_t);
    219       1.1  dyoung 
    220       1.1  dyoung 	/* copy */
    221       1.1  dyoung 	void		(*bs_c_1)(void *, bus_space_handle_t, bus_size_t,
    222       1.1  dyoung 			    bus_space_handle_t, bus_size_t, bus_size_t);
    223       1.1  dyoung 	void		(*bs_c_2)(void *, bus_space_handle_t, bus_size_t,
    224       1.1  dyoung 			    bus_space_handle_t, bus_size_t, bus_size_t);
    225       1.1  dyoung 	void		(*bs_c_4)(void *, bus_space_handle_t, bus_size_t,
    226       1.1  dyoung 			    bus_space_handle_t, bus_size_t, bus_size_t);
    227       1.1  dyoung 	void		(*bs_c_8)(void *, bus_space_handle_t, bus_size_t,
    228       1.1  dyoung 			    bus_space_handle_t, bus_size_t, bus_size_t);
    229       1.1  dyoung 
    230       1.1  dyoung #ifdef __BUS_SPACE_HAS_STREAM_METHODS
    231       1.1  dyoung 	/* read stream (single) */
    232       1.5   skrll 	uint8_t		(*bs_r_1_s)(void *, bus_space_handle_t,
    233       1.1  dyoung 			    bus_size_t);
    234       1.5   skrll 	uint16_t	(*bs_r_2_s)(void *, bus_space_handle_t,
    235       1.1  dyoung 			    bus_size_t);
    236       1.5   skrll 	uint32_t	(*bs_r_4_s)(void *, bus_space_handle_t,
    237       1.1  dyoung 			    bus_size_t);
    238       1.5   skrll 	uint64_t	(*bs_r_8_s)(void *, bus_space_handle_t,
    239       1.1  dyoung 			    bus_size_t);
    240       1.1  dyoung 
    241       1.1  dyoung 	/* read multiple stream */
    242       1.1  dyoung 	void		(*bs_rm_1_s)(void *, bus_space_handle_t,
    243       1.5   skrll 			    bus_size_t, uint8_t *, bus_size_t);
    244       1.1  dyoung 	void		(*bs_rm_2_s)(void *, bus_space_handle_t,
    245       1.5   skrll 			    bus_size_t, uint16_t *, bus_size_t);
    246       1.1  dyoung 	void		(*bs_rm_4_s)(void *, bus_space_handle_t,
    247       1.5   skrll 			    bus_size_t, uint32_t *, bus_size_t);
    248       1.1  dyoung 	void		(*bs_rm_8_s)(void *, bus_space_handle_t,
    249       1.5   skrll 			    bus_size_t, uint64_t *, bus_size_t);
    250      1.11     ryo 
    251       1.1  dyoung 	/* read region stream */
    252       1.1  dyoung 	void		(*bs_rr_1_s)(void *, bus_space_handle_t,
    253       1.5   skrll 			    bus_size_t, uint8_t *, bus_size_t);
    254       1.1  dyoung 	void		(*bs_rr_2_s)(void *, bus_space_handle_t,
    255       1.5   skrll 			    bus_size_t, uint16_t *, bus_size_t);
    256       1.1  dyoung 	void		(*bs_rr_4_s)(void *, bus_space_handle_t,
    257       1.5   skrll 			    bus_size_t, uint32_t *, bus_size_t);
    258       1.1  dyoung 	void		(*bs_rr_8_s)(void *, bus_space_handle_t,
    259       1.5   skrll 			    bus_size_t, uint64_t *, bus_size_t);
    260      1.11     ryo 
    261       1.1  dyoung 	/* write stream (single) */
    262       1.1  dyoung 	void		(*bs_w_1_s)(void *, bus_space_handle_t,
    263       1.5   skrll 			    bus_size_t, uint8_t);
    264       1.1  dyoung 	void		(*bs_w_2_s)(void *, bus_space_handle_t,
    265       1.5   skrll 			    bus_size_t, uint16_t);
    266       1.1  dyoung 	void		(*bs_w_4_s)(void *, bus_space_handle_t,
    267       1.5   skrll 			    bus_size_t, uint32_t);
    268       1.1  dyoung 	void		(*bs_w_8_s)(void *, bus_space_handle_t,
    269       1.5   skrll 			    bus_size_t, uint64_t);
    270       1.1  dyoung 
    271       1.1  dyoung 	/* write multiple stream */
    272       1.1  dyoung 	void		(*bs_wm_1_s)(void *, bus_space_handle_t,
    273       1.5   skrll 			    bus_size_t, const uint8_t *, bus_size_t);
    274       1.1  dyoung 	void		(*bs_wm_2_s)(void *, bus_space_handle_t,
    275       1.5   skrll 			    bus_size_t, const uint16_t *, bus_size_t);
    276       1.1  dyoung 	void		(*bs_wm_4_s)(void *, bus_space_handle_t,
    277       1.5   skrll 			    bus_size_t, const uint32_t *, bus_size_t);
    278       1.1  dyoung 	void		(*bs_wm_8_s)(void *, bus_space_handle_t,
    279       1.5   skrll 			    bus_size_t, const uint64_t *, bus_size_t);
    280      1.11     ryo 
    281       1.1  dyoung 	/* write region stream */
    282       1.1  dyoung 	void		(*bs_wr_1_s)(void *, bus_space_handle_t,
    283       1.5   skrll 			    bus_size_t, const uint8_t *, bus_size_t);
    284       1.1  dyoung 	void		(*bs_wr_2_s)(void *, bus_space_handle_t,
    285       1.5   skrll 			    bus_size_t, const uint16_t *, bus_size_t);
    286       1.1  dyoung 	void		(*bs_wr_4_s)(void *, bus_space_handle_t,
    287       1.5   skrll 			    bus_size_t, const uint32_t *, bus_size_t);
    288       1.1  dyoung 	void		(*bs_wr_8_s)(void *, bus_space_handle_t,
    289       1.5   skrll 			    bus_size_t, const uint64_t *, bus_size_t);
    290       1.1  dyoung #endif	/* __BUS_SPACE_HAS_STREAM_METHODS */
    291      1.11     ryo 
    292      1.11     ryo #ifdef __BUS_SPACE_HAS_PROBING_METHODS
    293      1.11     ryo 	/* peek */
    294      1.11     ryo 	int		(*bs_pe_1)(void *, bus_space_handle_t,
    295      1.11     ryo 			    bus_size_t, uint8_t *);
    296      1.11     ryo 	int		(*bs_pe_2)(void *, bus_space_handle_t,
    297      1.11     ryo 			    bus_size_t, uint16_t *);
    298      1.11     ryo 	int		(*bs_pe_4)(void *, bus_space_handle_t,
    299      1.11     ryo 			    bus_size_t, uint32_t *);
    300      1.11     ryo 	int		(*bs_pe_8)(void *, bus_space_handle_t,
    301      1.11     ryo 			    bus_size_t, uint64_t *);
    302      1.11     ryo 
    303      1.11     ryo 	/* poke */
    304      1.11     ryo 	int		(*bs_po_1)(void *, bus_space_handle_t,
    305      1.11     ryo 			    bus_size_t, uint8_t);
    306      1.11     ryo 	int		(*bs_po_2)(void *, bus_space_handle_t,
    307      1.11     ryo 			    bus_size_t, uint16_t);
    308      1.11     ryo 	int		(*bs_po_4)(void *, bus_space_handle_t,
    309      1.11     ryo 			    bus_size_t, uint32_t);
    310      1.11     ryo 	int		(*bs_po_8)(void *, bus_space_handle_t,
    311      1.11     ryo 			    bus_size_t, uint64_t);
    312      1.11     ryo #endif /* __BUS_SPACE_HAS_PROBING_METHODS */
    313       1.1  dyoung };
    314       1.1  dyoung 
    315       1.1  dyoung #define	BUS_SPACE_BARRIER_READ	0x01
    316       1.1  dyoung #define	BUS_SPACE_BARRIER_WRITE	0x02
    317       1.1  dyoung 
    318       1.1  dyoung #define BUS_SPACE_ALIGNED_POINTER(p, t) ALIGNED_POINTER(p, t)
    319       1.1  dyoung 
    320       1.1  dyoung /* Bus Space DMA macros */
    321       1.1  dyoung 
    322       1.1  dyoung /*
    323       1.1  dyoung  * Flags used in various bus DMA methods.
    324       1.1  dyoung  */
    325       1.1  dyoung #define	BUS_DMA_WAITOK		0x000	/* safe to sleep (pseudo-flag) */
    326       1.1  dyoung #define	BUS_DMA_NOWAIT		0x001	/* not safe to sleep */
    327       1.1  dyoung #define	BUS_DMA_ALLOCNOW	0x002	/* perform resource allocation now */
    328       1.1  dyoung #define	BUS_DMA_COHERENT	0x004	/* hint: map memory DMA coherent */
    329       1.1  dyoung #define	BUS_DMA_STREAMING	0x008	/* hint: sequential, unidirectional */
    330       1.1  dyoung #define	BUS_DMA_BUS1		0x010	/* placeholders for bus functions... */
    331       1.1  dyoung #define	BUS_DMA_BUS2		0x020
    332       1.1  dyoung #define	BUS_DMA_BUS3		0x040
    333       1.1  dyoung #define	BUS_DMA_BUS4		0x080
    334       1.1  dyoung #define	BUS_DMA_READ		0x100	/* mapping is device -> memory only */
    335       1.1  dyoung #define	BUS_DMA_WRITE		0x200	/* mapping is memory -> device only */
    336       1.1  dyoung #define	BUS_DMA_NOCACHE		0x400	/* hint: map non-cached memory */
    337       1.1  dyoung 
    338       1.1  dyoung /*
    339       1.1  dyoung  * Private flags stored in the DMA map.
    340       1.1  dyoung  */
    341       1.2    matt #define	_BUS_DMAMAP_COHERENT	0x10000	/* no cache flush necessary on sync */
    342       1.7    matt #define	_BUS_DMAMAP_IS_BOUNCING	0x20000 /* is bouncing current xfer */
    343       1.8    matt #define	_BUS_DMAMAP_NOALLOC	0x40000	/* don't alloc memory from this range */
    344       1.1  dyoung 
    345       1.1  dyoung /* Forwards needed by prototypes below. */
    346       1.1  dyoung struct mbuf;
    347       1.1  dyoung struct uio;
    348       1.1  dyoung 
    349       1.1  dyoung /*
    350       1.1  dyoung  * Operations performed by bus_dmamap_sync().
    351       1.1  dyoung  */
    352       1.1  dyoung #define	BUS_DMASYNC_PREREAD	0x01	/* pre-read synchronization */
    353       1.1  dyoung #define	BUS_DMASYNC_POSTREAD	0x02	/* post-read synchronization */
    354       1.1  dyoung #define	BUS_DMASYNC_PREWRITE	0x04	/* pre-write synchronization */
    355       1.1  dyoung #define	BUS_DMASYNC_POSTWRITE	0x08	/* post-write synchronization */
    356       1.1  dyoung 
    357       1.1  dyoung typedef struct arm32_bus_dma_tag	*bus_dma_tag_t;
    358       1.1  dyoung typedef struct arm32_bus_dmamap		*bus_dmamap_t;
    359       1.1  dyoung 
    360       1.1  dyoung #define BUS_DMA_TAG_VALID(t)    ((t) != (bus_dma_tag_t)0)
    361       1.1  dyoung 
    362       1.1  dyoung /*
    363       1.1  dyoung  *	bus_dma_segment_t
    364       1.1  dyoung  *
    365       1.1  dyoung  *	Describes a single contiguous DMA transaction.  Values
    366       1.1  dyoung  *	are suitable for programming into DMA registers.
    367       1.1  dyoung  */
    368       1.1  dyoung struct arm32_bus_dma_segment {
    369       1.1  dyoung 	/*
    370       1.1  dyoung 	 * PUBLIC MEMBERS: these are used by machine-independent code.
    371       1.1  dyoung 	 */
    372       1.1  dyoung 	bus_addr_t	ds_addr;	/* DMA address */
    373       1.1  dyoung 	bus_size_t	ds_len;		/* length of transfer */
    374      1.11     ryo 
    375      1.11     ryo 	/*
    376      1.11     ryo 	 * PRIVATE MEMBERS:
    377      1.11     ryo 	 */
    378       1.3    matt 	uint32_t	_ds_flags;	/* _BUS_DMAMAP_COHERENT */
    379       1.1  dyoung };
    380       1.1  dyoung typedef struct arm32_bus_dma_segment	bus_dma_segment_t;
    381       1.1  dyoung 
    382       1.1  dyoung /*
    383       1.1  dyoung  *	arm32_dma_range
    384       1.1  dyoung  *
    385       1.1  dyoung  *	This structure describes a valid DMA range.
    386       1.1  dyoung  */
    387       1.1  dyoung struct arm32_dma_range {
    388       1.1  dyoung 	bus_addr_t	dr_sysbase;	/* system base address */
    389       1.1  dyoung 	bus_addr_t	dr_busbase;	/* appears here on bus */
    390       1.1  dyoung 	bus_size_t	dr_len;		/* length of range */
    391       1.3    matt 	uint32_t	dr_flags;	/* flags for range */
    392       1.1  dyoung };
    393       1.1  dyoung 
    394       1.1  dyoung /*
    395       1.1  dyoung  *	bus_dma_tag_t
    396       1.1  dyoung  *
    397       1.1  dyoung  *	A machine-dependent opaque type describing the implementation of
    398       1.1  dyoung  *	DMA for a given bus.
    399       1.1  dyoung  */
    400       1.1  dyoung 
    401       1.1  dyoung struct arm32_bus_dma_tag {
    402       1.1  dyoung 	/*
    403       1.1  dyoung 	 * DMA range for this tag.  If the page doesn't fall within
    404       1.1  dyoung 	 * one of these ranges, an error is returned.  The caller
    405       1.1  dyoung 	 * may then decide what to do with the transfer.  If the
    406       1.1  dyoung 	 * range pointer is NULL, it is ignored.
    407       1.1  dyoung 	 */
    408       1.1  dyoung 	struct arm32_dma_range *_ranges;
    409       1.1  dyoung 	int _nranges;
    410       1.1  dyoung 
    411       1.1  dyoung 	/*
    412       1.1  dyoung 	 * Opaque cookie for use by back-end.
    413       1.1  dyoung 	 */
    414       1.1  dyoung 	void *_cookie;
    415       1.1  dyoung 
    416       1.1  dyoung 	/*
    417       1.1  dyoung 	 * DMA mapping methods.
    418       1.1  dyoung 	 */
    419       1.1  dyoung 	int	(*_dmamap_create)(bus_dma_tag_t, bus_size_t, int,
    420       1.1  dyoung 		    bus_size_t, bus_size_t, int, bus_dmamap_t *);
    421       1.1  dyoung 	void	(*_dmamap_destroy)(bus_dma_tag_t, bus_dmamap_t);
    422       1.1  dyoung 	int	(*_dmamap_load)(bus_dma_tag_t, bus_dmamap_t, void *,
    423       1.1  dyoung 		    bus_size_t, struct proc *, int);
    424       1.1  dyoung 	int	(*_dmamap_load_mbuf)(bus_dma_tag_t, bus_dmamap_t,
    425       1.1  dyoung 		    struct mbuf *, int);
    426       1.1  dyoung 	int	(*_dmamap_load_uio)(bus_dma_tag_t, bus_dmamap_t,
    427       1.1  dyoung 		    struct uio *, int);
    428       1.1  dyoung 	int	(*_dmamap_load_raw)(bus_dma_tag_t, bus_dmamap_t,
    429       1.1  dyoung 		    bus_dma_segment_t *, int, bus_size_t, int);
    430       1.1  dyoung 	void	(*_dmamap_unload)(bus_dma_tag_t, bus_dmamap_t);
    431       1.1  dyoung 	void	(*_dmamap_sync_pre)(bus_dma_tag_t, bus_dmamap_t,
    432       1.1  dyoung 		    bus_addr_t, bus_size_t, int);
    433       1.1  dyoung 	void	(*_dmamap_sync_post)(bus_dma_tag_t, bus_dmamap_t,
    434       1.1  dyoung 		    bus_addr_t, bus_size_t, int);
    435       1.1  dyoung 
    436       1.1  dyoung 	/*
    437       1.1  dyoung 	 * DMA memory utility functions.
    438       1.1  dyoung 	 */
    439       1.1  dyoung 	int	(*_dmamem_alloc)(bus_dma_tag_t, bus_size_t, bus_size_t,
    440       1.1  dyoung 		    bus_size_t, bus_dma_segment_t *, int, int *, int);
    441       1.1  dyoung 	void	(*_dmamem_free)(bus_dma_tag_t,
    442       1.1  dyoung 		    bus_dma_segment_t *, int);
    443       1.1  dyoung 	int	(*_dmamem_map)(bus_dma_tag_t, bus_dma_segment_t *,
    444       1.1  dyoung 		    int, size_t, void **, int);
    445       1.1  dyoung 	void	(*_dmamem_unmap)(bus_dma_tag_t, void *, size_t);
    446       1.1  dyoung 	paddr_t	(*_dmamem_mmap)(bus_dma_tag_t, bus_dma_segment_t *,
    447       1.1  dyoung 		    int, off_t, int, int);
    448       1.2    matt 
    449       1.2    matt 	/*
    450       1.2    matt 	 * DMA tag utility functions
    451       1.2    matt 	 */
    452       1.2    matt 	int	(*_dmatag_subregion)(bus_dma_tag_t, bus_addr_t, bus_addr_t,
    453       1.2    matt 		     bus_dma_tag_t *, int);
    454       1.2    matt 	void	(*_dmatag_destroy)(bus_dma_tag_t);
    455       1.2    matt 
    456       1.2    matt 	/*
    457       1.2    matt 	 * State for bounce buffers
    458       1.2    matt 	 */
    459       1.2    matt 	int	_tag_needs_free;
    460       1.2    matt 	int	(*_may_bounce)(bus_dma_tag_t, bus_dmamap_t, int, int *);
    461       1.1  dyoung };
    462       1.1  dyoung 
    463       1.1  dyoung /*
    464       1.1  dyoung  *	bus_dmamap_t
    465       1.1  dyoung  *
    466       1.1  dyoung  *	Describes a DMA mapping.
    467       1.1  dyoung  */
    468       1.1  dyoung struct arm32_bus_dmamap {
    469       1.1  dyoung 	/*
    470       1.1  dyoung 	 * PRIVATE MEMBERS: not for use by machine-independent code.
    471       1.1  dyoung 	 */
    472       1.1  dyoung 	bus_size_t	_dm_size;	/* largest DMA transfer mappable */
    473       1.1  dyoung 	int		_dm_segcnt;	/* number of segs this map can map */
    474       1.1  dyoung 	bus_size_t	_dm_maxmaxsegsz; /* fixed largest possible segment */
    475       1.1  dyoung 	bus_size_t	_dm_boundary;	/* don't cross this */
    476       1.1  dyoung 	int		_dm_flags;	/* misc. flags */
    477       1.1  dyoung 
    478       1.1  dyoung 	void		*_dm_origbuf;	/* pointer to original buffer */
    479       1.1  dyoung 	int		_dm_buftype;	/* type of buffer */
    480       1.1  dyoung 	struct vmspace	*_dm_vmspace;	/* vmspace that owns the mapping */
    481       1.1  dyoung 
    482       1.1  dyoung 	void		*_dm_cookie;	/* cookie for bus-specific functions */
    483       1.1  dyoung 
    484       1.1  dyoung 	/*
    485       1.1  dyoung 	 * PUBLIC MEMBERS: these are used by machine-independent code.
    486       1.1  dyoung 	 */
    487       1.1  dyoung 	bus_size_t	dm_maxsegsz;	/* largest possible segment */
    488       1.1  dyoung 	bus_size_t	dm_mapsize;	/* size of the mapping */
    489       1.1  dyoung 	int		dm_nsegs;	/* # valid segments in mapping */
    490       1.1  dyoung 	bus_dma_segment_t dm_segs[1];	/* segments; variable length */
    491       1.1  dyoung };
    492       1.1  dyoung 
    493       1.2    matt /* _dm_buftype */
    494       1.2    matt #define	_BUS_DMA_BUFTYPE_INVALID	0
    495       1.2    matt #define	_BUS_DMA_BUFTYPE_LINEAR		1
    496       1.2    matt #define	_BUS_DMA_BUFTYPE_MBUF		2
    497       1.2    matt #define	_BUS_DMA_BUFTYPE_UIO		3
    498       1.2    matt #define	_BUS_DMA_BUFTYPE_RAW		4
    499       1.2    matt 
    500       1.1  dyoung #ifdef _ARM32_BUS_DMA_PRIVATE
    501       1.2    matt #define	_BUS_AVAIL_END	physical_end
    502       1.2    matt /*
    503       1.2    matt  * Cookie used for bounce buffers. A pointer to one of these it stashed in
    504       1.2    matt  * the DMA map.
    505       1.2    matt  */
    506       1.2    matt struct arm32_bus_dma_cookie {
    507       1.2    matt 	int	id_flags;		/* flags; see below */
    508       1.1  dyoung 
    509       1.2    matt 	/*
    510       1.2    matt 	 * Information about the original buffer used during
    511       1.2    matt 	 * DMA map syncs.  Note that origibuflen is only used
    512       1.2    matt 	 * for ID_BUFTYPE_LINEAR.
    513       1.2    matt 	 */
    514       1.2    matt 	union {
    515       1.2    matt 		void	*un_origbuf;		/* pointer to orig buffer if
    516       1.2    matt 						   bouncing */
    517       1.2    matt 		char	*un_linearbuf;
    518       1.2    matt 		struct mbuf	*un_mbuf;
    519       1.2    matt 		struct uio	*un_uio;
    520       1.2    matt 	} id_origbuf_un;
    521       1.2    matt #define	id_origbuf		id_origbuf_un.un_origbuf
    522       1.2    matt #define	id_origlinearbuf	id_origbuf_un.un_linearbuf
    523       1.2    matt #define	id_origmbuf		id_origbuf_un.un_mbuf
    524       1.2    matt #define	id_origuio		id_origbuf_un.un_uio
    525       1.2    matt 	bus_size_t id_origbuflen;	/* ...and size */
    526       1.2    matt 
    527       1.2    matt 	void	*id_bouncebuf;		/* pointer to the bounce buffer */
    528       1.2    matt 	bus_size_t id_bouncebuflen;	/* ...and size */
    529       1.2    matt 	int	id_nbouncesegs;		/* number of valid bounce segs */
    530       1.2    matt 	bus_dma_segment_t id_bouncesegs[0]; /* array of bounce buffer
    531       1.2    matt 					       physical memory segments */
    532       1.2    matt };
    533       1.1  dyoung 
    534       1.2    matt /* id_flags */
    535       1.2    matt #define	_BUS_DMA_IS_BOUNCING		0x04	/* is bouncing current xfer */
    536       1.2    matt #define	_BUS_DMA_HAS_BOUNCE		0x02	/* has bounce buffers */
    537       1.1  dyoung #endif /* _ARM32_BUS_DMA_PRIVATE */
    538       1.2    matt #define	_BUS_DMA_MIGHT_NEED_BOUNCE	0x01	/* may need bounce buffers */
    539       1.1  dyoung 
    540      1.10    matt #endif /* _ARM_BUS_DEFS_H_ */
    541