Home | History | Annotate | Line # | Download | only in oea
      1 /*	$NetBSD: bat.h,v 1.20 2020/07/06 10:31:23 rin 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 
     68 #ifdef _KERNEL_OPT
     69 #include "opt_ppcarch.h"
     70 #endif
     71 
     72 #include <powerpc/psl.h>
     73 
     74 struct bat {
     75 	register_t batu;
     76 	register_t batl;
     77 } __aligned(8);
     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 #define	BAT_WIMG	0x00000078	/* WIMG mask */
     89 
     90 /*
     91  * BAT_XPN and BAT_X are only used when HID0[XAEN] == 1 and are used
     92  * to generate the 4 MSB of physical address
     93  */
     94 
     95 #define	BAT_PP		0x00000003	/* PP mask */
     96 #define	BAT_PP_NONE	0x00000000	/* no access permission */
     97 #define	BAT_PP_RO_S	0x00000001	/* read-only (soft) */
     98 #define	BAT_PP_RW	0x00000002	/* read/write */
     99 #define	BAT_PP_RO	0x00000003	/* read-only */
    100 
    101 /* Upper BAT bits (all but PowerPC 601): */
    102 #define	BAT_EPI		(~0x1ffffL)	/* effective block start */
    103 #define	BAT_BL		0x00001ffc	/* block length */
    104 #define	BAT_Vs		0x00000002	/* valid in supervisor mode */
    105 #define	BAT_Vu		0x00000001	/* valid in user mode */
    106 
    107 #define	BAT_XBL		0x0001e000	/* eXtended Block Length (*) */
    108 #define	BAT_XBL_512M	0x00002000	/* XBL for 512MB */
    109 #define	BAT_XBL_1G	0x00006000	/* XBL for 1GB */
    110 #define	BAT_XBL_2G	0x0000e000	/* XBL for 2GB */
    111 #define	BAT_XBL_4G	0x0001e000	/* XBL for 4GB */
    112 
    113 #define	BAT_V		(BAT_Vs|BAT_Vu)
    114 
    115 /* Block Length encoding (all but PowerPC 601): */
    116 #define	BAT_BL_128K	0x00000000
    117 #define	BAT_BL_256K	0x00000004
    118 #define	BAT_BL_512K	0x0000000c
    119 #define	BAT_BL_1M	0x0000001c
    120 #define	BAT_BL_2M	0x0000003c
    121 #define	BAT_BL_4M	0x0000007c
    122 #define	BAT_BL_8M	0x000000fc
    123 #define	BAT_BL_16M	0x000001fc
    124 #define	BAT_BL_32M	0x000003fc
    125 #define	BAT_BL_64M	0x000007fc
    126 #define	BAT_BL_128M	0x00000ffc
    127 #define	BAT_BL_256M	0x00001ffc
    128 /* Extended Block Lengths (7455+) */
    129 #define	BAT_BL_512M	0x00003ffc
    130 #define	BAT_BL_1G	0x00007ffc
    131 #define	BAT_BL_2G	0x0000fffc
    132 #define	BAT_BL_4G	0x0001fffc
    133 
    134 #define	BAT_BL_TO_SIZE(bl)	(((bl)+4) << 15)
    135 
    136 #define	BATU(va, len, v)						\
    137 	(((va) & BAT_EPI) | ((len) & (BAT_BL|BAT_XBL)) | ((v) & BAT_V))
    138 
    139 #define	BATL(pa, wimg, pp)						\
    140 	(((pa) & BAT_RPN) | (wimg) | (pp))
    141 
    142 #define BAT_VA_MATCH_P(batu,va) \
    143   (((~(((batu)&(BAT_BL|BAT_XBL))<<15))&(va)&BAT_EPI)==((batu)&BAT_EPI))
    144 
    145 #define BAT_PA_MATCH_P(batu,batl,pa) \
    146   (((~(((batu)&(BAT_BL|BAT_XBL))<<15))&(pa)&BAT_RPN)==((batl)&BAT_RPN))
    147 
    148 #define BAT_VALID_P(batu, msr) \
    149   (((msr)&PSL_PR)?(((batu)&BAT_Vu)==BAT_Vu):(((batu)&BAT_Vs)==BAT_Vs))
    150 
    151 /* Lower BAT bits (PowerPC 601): */
    152 #define	BAT601_PBN	0xfffe0000	/* physical block number */
    153 #define	BAT601_V	0x00000040	/* valid */
    154 #define	BAT601_BSM	0x0000003f	/* block size mask */
    155 
    156 /* Upper BAT bits (PowerPC 601): */
    157 #define	BAT601_BLPI	0xfffe0000	/* block logical page index */
    158 #define	BAT601_W	0x00000040	/* 1 = write-through, 0 = write-back */
    159 #define	BAT601_I	0x00000020	/* cache inhibit */
    160 #define	BAT601_M	0x00000010	/* memory coherency enable */
    161 #define	BAT601_Ks	0x00000008	/* key-supervisor */
    162 #define	BAT601_Ku	0x00000004	/* key-user */
    163 
    164 /*
    165  * Permission bits on the PowerPC 601 are modified by the appropriate
    166  * Key bit:
    167  *
    168  *	Key	PP	Access
    169  *	0	NONE	read/write
    170  *	0	RO_S	read/write
    171  *	0	RW	read/write
    172  *	0	RO	read-only
    173  *
    174  *	1	NONE	none
    175  *	1	RO_S	read-only
    176  *	1	RW	read/write
    177  *	1	RO	read-only
    178  */
    179 #define	BAT601_PP	0x00000003
    180 #define	BAT601_PP_NONE	0x00000000	/* no access permission */
    181 #define	BAT601_PP_RO_S	0x00000001	/* read-only (soft) */
    182 #define	BAT601_PP_RW	0x00000002	/* read/write */
    183 #define	BAT601_PP_RO	0x00000003	/* read-only */
    184 
    185 /* Block Size Mask encoding (PowerPC 601): */
    186 #define	BAT601_BSM_128K	0x00000000
    187 #define	BAT601_BSM_256K	0x00000001
    188 #define	BAT601_BSM_512K	0x00000003
    189 #define	BAT601_BSM_1M	0x00000007
    190 #define	BAT601_BSM_2M	0x0000000f
    191 #define	BAT601_BSM_4M	0x0000001f
    192 #define	BAT601_BSM_8M	0x0000003f
    193 
    194 #define	BATU601(va, wim, key, pp)					\
    195 	(((va) & BAT601_BLPI) | (wim) | (key) | (pp))
    196 
    197 #define	BATL601(pa, size, v)						\
    198 	(((pa) & BAT601_PBN) | (v) | (size))
    199 
    200 #define	BAT601_VA_MATCH_P(batu, batl, va)				\
    201 	(((~(((batl)&BAT601_BSM)<<17))&(va)&BAT601_BLPI)==((batu)&BAT601_BLPI))
    202 
    203 #define	BAT601_VALID_P(batl) \
    204 	((batl) & BAT601_V)
    205 
    206 #define	BAT_VA2IDX(va)	((va) / (8*1024*1024))
    207 #define	BAT_IDX2VA(i)	((i) * (8*1024*1024))
    208 
    209 #if defined(_KERNEL) && !defined(_LOCORE)
    210 void oea_batinit(paddr_t, ...);
    211 void oea_iobat_add(paddr_t, register_t);
    212 void oea_iobat_remove(paddr_t);
    213 
    214 #if !defined (PPC_OEA64)
    215 extern struct bat battable[];
    216 #endif /* PPC_OEA */
    217 #endif
    218 
    219 #endif	/* _POWERPC_OEA_BAT_H_ */
    220