xref: /netbsd-src/sys/arch/powerpc/include/bat.h (revision 89c5a767f8fc7a4633b2d409966e2becbb98ff92)
1 /*	$NetBSD: bat.h,v 1.2 1999/12/18 01:36:06 thorpej 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	_MACHINE_BAT_H_
71 #define	_MACHINE_BAT_H_
72 
73 struct bat {
74 	u_int32_t batu;
75 	u_int32_t batl;
76 };
77 
78 /* Lower BAT bits (all but PowerPC 601): */
79 #define	BAT_PBS		0xfffe0000	/* physical block start */
80 #define	BAT_W		0x00000040	/* 1 = write-through, 0 = write-back */
81 #define	BAT_I		0x00000020	/* cache inhibit */
82 #define	BAT_M		0x00000010	/* memory coherency enable */
83 #define	BAT_G		0x00000008	/* guarded region */
84 
85 #define	BAT_PP_NONE	0x00000000	/* no access permission */
86 #define	BAT_PP_RO_S	0x00000001	/* read-only (soft) */
87 #define	BAT_PP_RW	0x00000002	/* read/write */
88 #define	BAT_PP_RO	0x00000003	/* read-only */
89 
90 /* Upper BAT bits (all but PowerPC 601): */
91 #define	BAT_EBS		0xfffe0000	/* effective block start */
92 #define	BAT_BL		0x00001ffc	/* block length */
93 #define	BAT_Vs		0x00000002	/* valid in supervisor mode */
94 #define	BAT_Vu		0x00000001	/* valid in user mode */
95 
96 #define	BAT_V		(BAT_Vs|BAT_Vu)
97 
98 /* Block Length encoding (all but PowerPC 601): */
99 #define	BAT_BL_128K	0x00000000
100 #define	BAT_BL_256K	0x00000004
101 #define	BAT_BL_512K	0x0000000c
102 #define	BAT_BL_1M	0x0000001c
103 #define	BAT_BL_2M	0x0000003c
104 #define	BAT_BL_4M	0x0000007c
105 #define	BAT_BL_8M	0x000000fc
106 #define	BAT_BL_16M	0x000001fc
107 #define	BAT_BL_32M	0x000003fc
108 #define	BAT_BL_64M	0x000007fc
109 #define	BAT_BL_128M	0x00000ffc
110 #define	BAT_BL_256M	0x00001ffc
111 
112 #define	BATU(va, len, v)						\
113 	(((va) & BAT_EBS) | ((len) & BAT_BL) | ((v) & BAT_V))
114 
115 #define	BATL(pa, wimg, pp)						\
116 	(((pa) & BAT_PBS) | (wimg) | (pp))
117 
118 
119 /* Lower BAT bits (PowerPC 601): */
120 #define	BAT601_PBN	0xfffe0000	/* physical block number */
121 #define	BAT601_V	0x00000040	/* valid */
122 #define	BAT601_BSM	0x0000003f	/* block size mask */
123 
124 /* Upper BAT bits (PowerPC 601): */
125 #define	BAT601_BLPI	0xfffe0000	/* block logical page index */
126 #define	BAT601_W	0x00000040	/* 1 = write-through, 0 = write-back */
127 #define	BAT601_I	0x00000020	/* cache inhibit */
128 #define	BAT601_M	0x00000010	/* memory coherency enable */
129 #define	BAT601_Ks	0x00000008	/* key-supervisor */
130 #define	BAT601_Ku	0x00000004	/* key-user */
131 
132 /*
133  * Permission bits on the PowerPC 601 are modified by the appropriate
134  * Key bit:
135  *
136  *	Key	PP	Access
137  *	0	NONE	read/write
138  *	0	RO_S	read/write
139  *	0	RW	read/write
140  *	0	RO	read-only
141  *
142  *	1	NONE	none
143  *	1	RO_S	read-only
144  *	1	RW	read/write
145  *	1	RO	read-only
146  */
147 #define	BAT601_PP_NONE	0x00000000	/* no access permission */
148 #define	BAT601_PP_RO_S	0x00000001	/* read-only (soft) */
149 #define	BAT601_PP_RW	0x00000002	/* read/write */
150 #define	BAT601_PP_RO	0x00000003	/* read-only */
151 
152 /* Block Size Mask encoding (PowerPC 601): */
153 #define	BAT601_BSM_128K	0x00000000
154 #define	BAT601_BSM_256K	0x00000001
155 #define	BAT601_BSM_512K	0x00000003
156 #define	BAT601_BSM_1M	0x00000007
157 #define	BAT601_BSM_2M	0x0000000f
158 #define	BAT601_BSM_4M	0x0000001f
159 #define	BAT601_BSM_8M	0x0000003f
160 
161 #define	BATU601(va, wim, key, pp)					\
162 	(((va) & BAT601_BLPI) | (wim) | (key) | (pp))
163 
164 #define	BATL601(pa, size, v)						\
165 	(((pa) & BAT601_PBN) | (v) | (size))
166 
167 #ifdef	_KERNEL
168 extern struct bat battable[16];
169 #endif
170 
171 #endif	/* _MACHINE_BAT_H_ */
172