xref: /netbsd-src/sys/arch/powerpc/include/oea/bat.h (revision e5548b402ae4c44fb816de42c7bba9581ce23ef5)
1 /*	$NetBSD: bat.h,v 1.7 2005/12/11 12:18:43 christos Exp $	*/
2 
3 /*-
4  * Copyright (c) 1999 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.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *	This product includes software developed by the NetBSD
21  *	Foundation, Inc. and its contributors.
22  * 4. Neither the name of The NetBSD Foundation nor the names of its
23  *    contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  */
38 
39 /*
40  * Copyright (C) 1995, 1996 Wolfgang Solfrank.
41  * Copyright (C) 1995, 1996 TooLs GmbH.
42  * All rights reserved.
43  *
44  * Redistribution and use in source and binary forms, with or without
45  * modification, are permitted provided that the following conditions
46  * are met:
47  * 1. Redistributions of source code must retain the above copyright
48  *    notice, this list of conditions and the following disclaimer.
49  * 2. Redistributions in binary form must reproduce the above copyright
50  *    notice, this list of conditions and the following disclaimer in the
51  *    documentation and/or other materials provided with the distribution.
52  * 3. All advertising materials mentioning features or use of this software
53  *    must display the following acknowledgement:
54  *	This product includes software developed by TooLs GmbH.
55  * 4. The name of TooLs GmbH may not be used to endorse or promote products
56  *    derived from this software without specific prior written permission.
57  *
58  * THIS SOFTWARE IS PROVIDED BY TOOLS GMBH ``AS IS'' AND ANY EXPRESS OR
59  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
60  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
61  * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
62  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
63  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
64  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
65  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
66  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
67  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
68  */
69 
70 #ifndef	_POWERPC_OEA_BAT_H_
71 #define	_POWERPC_OEA_BAT_H_
72 
73 #ifndef _LOCORE
74 struct bat {
75 	register_t batu;
76 	register_t batl;
77 };
78 #endif
79 
80 /* Lower BAT bits (all but PowerPC 601): */
81 #define	BAT_RPN		(~0x1ffff)	/* physical block start */
82 #define	BAT_XPN		0x00000e00	/* eXtended physical page number (0-2) */
83 #define	BAT_W		0x00000040	/* 1 = write-through, 0 = write-back */
84 #define	BAT_I		0x00000020	/* cache inhibit */
85 #define	BAT_M		0x00000010	/* memory coherency enable */
86 #define	BAT_G		0x00000008	/* guarded region (not on 601) */
87 #define	BAT_X		0x00000004	/* eXtended physical page number (3) */
88 
89 /*
90  * BAT_XPN and BAT_X are only used when HID0[XAEN] == 1 and are used
91  * to generate the 4 MSB of physical address
92  */
93 
94 #define	BAT_PP		0x00000003	/* PP mask */
95 #define	BAT_PP_NONE	0x00000000	/* no access permission */
96 #define	BAT_PP_RO_S	0x00000001	/* read-only (soft) */
97 #define	BAT_PP_RW	0x00000002	/* read/write */
98 #define	BAT_PP_RO	0x00000003	/* read-only */
99 
100 /* Upper BAT bits (all but PowerPC 601): */
101 #define	BAT_EPI		(~0x1ffffL)	/* effective block start */
102 #define	BAT_BL		0x00001ffc	/* block length */
103 #define	BAT_Vs		0x00000002	/* valid in supervisor mode */
104 #define	BAT_Vu		0x00000001	/* valid in user mode */
105 
106 #define	BAT_XBL		0x0001e000	/* eXtended Block Length (*) */
107 #define	BAT_XBL_512M	0x00002000	/* XBL for 512MB */
108 #define	BAT_XBL_1G	0x00006000	/* XBL for 1GB */
109 #define	BAT_XBL_2G	0x0000e000	/* XBL for 2GB */
110 #define	BAT_XBL_4G	0x0001e000	/* XBL for 4GB */
111 
112 #define	BAT_V		(BAT_Vs|BAT_Vu)
113 
114 /* Block Length encoding (all but PowerPC 601): */
115 #define	BAT_BL_128K	0x00000000
116 #define	BAT_BL_256K	0x00000004
117 #define	BAT_BL_512K	0x0000000c
118 #define	BAT_BL_1M	0x0000001c
119 #define	BAT_BL_2M	0x0000003c
120 #define	BAT_BL_4M	0x0000007c
121 #define	BAT_BL_8M	0x000000fc
122 #define	BAT_BL_16M	0x000001fc
123 #define	BAT_BL_32M	0x000003fc
124 #define	BAT_BL_64M	0x000007fc
125 #define	BAT_BL_128M	0x00000ffc
126 #define	BAT_BL_256M	0x00001ffc
127 
128 #define	BATU(va, len, v)						\
129 	(((va) & BAT_EPI) | ((len) & BAT_BL) | ((v) & BAT_V))
130 
131 #define	BATL(pa, wimg, pp)						\
132 	(((pa) & BAT_RPN) | (wimg) | (pp))
133 
134 #define BAT_VA_MATCH_P(batu,va) \
135   (((~(((batu)&BAT_BL)<<15))&(va)&BAT_EPI)==((batu)&BAT_EPI))
136 
137 #define BAT_PA_MATCH_P(batu,batl,pa) \
138   (((~(((batu)&BAT_BL)<<15))&(pa)&BAT_RPN)==((batl)&BAT_RPN))
139 
140 #define BAT_VALID_P(batu, msr) \
141   (((msr)&PSL_PR)?(((batu)&BAT_Vu)==BAT_Vu):(((batu)&BAT_Vs)==BAT_Vs))
142 
143 /* Lower BAT bits (PowerPC 601): */
144 #define	BAT601_PBN	0xfffe0000	/* physical block number */
145 #define	BAT601_V	0x00000040	/* valid */
146 #define	BAT601_BSM	0x0000003f	/* block size mask */
147 
148 /* Upper BAT bits (PowerPC 601): */
149 #define	BAT601_BLPI	0xfffe0000	/* block logical page index */
150 #define	BAT601_W	0x00000040	/* 1 = write-through, 0 = write-back */
151 #define	BAT601_I	0x00000020	/* cache inhibit */
152 #define	BAT601_M	0x00000010	/* memory coherency enable */
153 #define	BAT601_Ks	0x00000008	/* key-supervisor */
154 #define	BAT601_Ku	0x00000004	/* key-user */
155 
156 /*
157  * Permission bits on the PowerPC 601 are modified by the appropriate
158  * Key bit:
159  *
160  *	Key	PP	Access
161  *	0	NONE	read/write
162  *	0	RO_S	read/write
163  *	0	RW	read/write
164  *	0	RO	read-only
165  *
166  *	1	NONE	none
167  *	1	RO_S	read-only
168  *	1	RW	read/write
169  *	1	RO	read-only
170  */
171 #define	BAT601_PP	0x00000003
172 #define	BAT601_PP_NONE	0x00000000	/* no access permission */
173 #define	BAT601_PP_RO_S	0x00000001	/* read-only (soft) */
174 #define	BAT601_PP_RW	0x00000002	/* read/write */
175 #define	BAT601_PP_RO	0x00000003	/* read-only */
176 
177 /* Block Size Mask encoding (PowerPC 601): */
178 #define	BAT601_BSM_128K	0x00000000
179 #define	BAT601_BSM_256K	0x00000001
180 #define	BAT601_BSM_512K	0x00000003
181 #define	BAT601_BSM_1M	0x00000007
182 #define	BAT601_BSM_2M	0x0000000f
183 #define	BAT601_BSM_4M	0x0000001f
184 #define	BAT601_BSM_8M	0x0000003f
185 
186 #define	BATU601(va, wim, key, pp)					\
187 	(((va) & BAT601_BLPI) | (wim) | (key) | (pp))
188 
189 #define	BATL601(pa, size, v)						\
190 	(((pa) & BAT601_PBN) | (v) | (size))
191 
192 #define	BAT601_VA_MATCH_P(batu, batl, va)				\
193 	(((~(((batl)&BAT601_BSM)<<17))&(va)&BAT601_BLPI)==((batu)&BAT601_BLPI))
194 
195 #define	BAT601_VALID_P(batl) \
196 	((batl) & BAT601_V)
197 
198 #ifdef	_KERNEL
199 #ifndef _LOCORE
200 void oea_batinit(paddr_t, ...);
201 void oea_iobat_add(paddr_t, register_t);
202 void oea_iobat_remove(paddr_t);
203 extern struct bat battable[];
204 #endif
205 #endif
206 
207 #endif	/* _POWERPC_OEA_BAT_H_ */
208