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