xref: /minix/sys/arch/x86/include/bus_defs.h (revision 83ee113e)
1 /*	$NetBSD: bus_defs.h,v 1.2 2011/08/25 15:06:10 dyoung Exp $	*/
2 
3 /*-
4  * Copyright (c) 1996, 1997, 1998, 2001 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
9  * NASA Ames Research Center.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 /*
34  * Copyright (c) 1996 Charles M. Hannum.  All rights reserved.
35  * Copyright (c) 1996 Christopher G. Demetriou.  All rights reserved.
36  *
37  * Redistribution and use in source and binary forms, with or without
38  * modification, are permitted provided that the following conditions
39  * are met:
40  * 1. Redistributions of source code must retain the above copyright
41  *    notice, this list of conditions and the following disclaimer.
42  * 2. Redistributions in binary form must reproduce the above copyright
43  *    notice, this list of conditions and the following disclaimer in the
44  *    documentation and/or other materials provided with the distribution.
45  * 3. All advertising materials mentioning features or use of this software
46  *    must display the following acknowledgement:
47  *      This product includes software developed by Christopher G. Demetriou
48  *	for the NetBSD Project.
49  * 4. The name of the author may not be used to endorse or promote products
50  *    derived from this software without specific prior written permission
51  *
52  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
53  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
54  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
55  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
56  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
57  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
58  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
59  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
60  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
61  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
62  */
63 
64 #ifndef _X86_BUS_H_
65 #define _X86_BUS_H_
66 
67 #include <x86/busdefs.h>
68 
69 #ifdef BUS_SPACE_DEBUG
70 #define	BUS_SPACE_ALIGNED_ADDRESS(p, t)				\
71 	((((u_long)(p)) & (sizeof(t)-1)) == 0)
72 #define BUS_SPACE_ALIGNED_POINTER(p, t) BUS_SPACE_ALIGNED_ADDRESS(p, t)
73 #else
74 #define BUS_SPACE_ALIGNED_POINTER(p, t) ALIGNED_POINTER(p, t)
75 #endif /* BUS_SPACE_DEBUG */
76 
77 /*
78  * Bus address and size types
79  */
80 typedef paddr_t bus_addr_t;
81 typedef size_t bus_size_t;
82 
83 struct bus_space_tag;
84 typedef	struct bus_space_tag *bus_space_tag_t;
85 
86 struct bus_space_tag {
87 	int					bst_type;
88 	bus_space_tag_t				bst_super;
89 	/* bst_present: bitmap indicating overrides present (1) in *this* tag,
90 	 * bst_exists: bitmap indicating overrides present (1) in *this* tag
91 	 * or in an ancestor's tag (follow bst_super to ancestors)
92 	 */
93 	uint64_t				bst_present;
94 	uint64_t				bst_exists;
95 	const struct bus_space_overrides	*bst_ov;
96 	void					*bst_ctx;
97 };
98 
99 typedef	vaddr_t bus_space_handle_t;
100 
101 typedef struct x86_bus_dma_tag		*bus_dma_tag_t;
102 typedef struct x86_bus_dmamap		*bus_dmamap_t;
103 
104 #define BUS_DMA_TAG_VALID(__t)    ((__t) != NULL)
105 
106 /*
107  *	bus_dma_segment_t
108  *
109  *	Describes a single contiguous DMA transaction.  Values
110  *	are suitable for programming into DMA registers.
111  */
112 typedef struct x86_bus_dma_segment {
113 	bus_addr_t	ds_addr;	/* DMA address */
114 	bus_size_t	ds_len;		/* length of transfer */
115 } bus_dma_segment_t;
116 
117 /*
118  *	bus_dmamap_t
119  *
120  *	Describes a DMA mapping.  XXX exposing structure to LKM.
121  */
122 struct x86_bus_dmamap {
123 	/*
124 	 * PRIVATE MEMBERS: not for use by machine-independent code.
125 	 */
126 	bus_size_t	_dm_size;	/* largest DMA transfer mappable */
127 	int		_dm_segcnt;	/* number of segs this map can map */
128 	bus_size_t	_dm_maxmaxsegsz; /* fixed largest possible segment */
129 	bus_size_t	_dm_boundary;	/* don't cross this */
130 	bus_addr_t	_dm_bounce_thresh; /* bounce threshold; see tag */
131 	int		_dm_flags;	/* misc. flags */
132 
133 	void		*_dm_cookie;	/* cookie for bus-specific functions */
134 
135 	/*
136 	 * PUBLIC MEMBERS: these are used by machine-independent code.
137 	 */
138 	bus_size_t	dm_maxsegsz;	/* largest possible segment */
139 	bus_size_t	dm_mapsize;	/* size of the mapping */
140 	int		dm_nsegs;	/* # valid segments in mapping */
141 	bus_dma_segment_t dm_segs[1];	/* segments; variable length */
142 };
143 
144 #endif /* _X86_BUS_H_ */
145