sys/powerpc/include/tlb.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (C) 2006-2012 Semihalf.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. The name of the author may not be used to endorse or promote products
  16  *    derived from this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
  21  * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
  23  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  *
  29  * $FreeBSD$
  30  */
  31
  32 #ifndef _MACHINE_TLB_H_
  33 #define _MACHINE_TLB_H_
  34
  35 #if defined(BOOKE_E500)
  36
  37 /*  PowerPC E500 MAS registers */
  38 #define MAS0_TLBSEL(x)          ((x << 28) & 0x10000000)
  39 #define MAS0_ESEL(x)            ((x << 16) & 0x003F0000)
  40
  41 #define MAS0_TLBSEL1            0x10000000
  42 #define MAS0_TLBSEL0            0x00000000
  43 #define MAS0_ESEL_TLB1MASK      0x000F0000
  44 #define MAS0_ESEL_TLB0MASK      0x00030000
  45 #define MAS0_ESEL_SHIFT         16
  46 #define MAS0_NV_MASK            0x00000003
  47 #define MAS0_NV_SHIFT           0
  48
  49 #define MAS1_VALID              0x80000000
  50 #define MAS1_IPROT              0x40000000
  51 #define MAS1_TID_MASK           0x00FF0000
  52 #define MAS1_TID_SHIFT          16
  53 #define MAS1_TS_MASK            0x00001000
  54 #define MAS1_TS_SHIFT           12
  55 #define MAS1_TSIZE_MASK         0x00000F00
  56 #define MAS1_TSIZE_SHIFT        8
  57
  58 #define TLB_SIZE_4K             1
  59 #define TLB_SIZE_16K            2
  60 #define TLB_SIZE_64K            3
  61 #define TLB_SIZE_256K           4
  62 #define TLB_SIZE_1M             5
  63 #define TLB_SIZE_4M             6
  64 #define TLB_SIZE_16M            7
  65 #define TLB_SIZE_64M            8
  66 #define TLB_SIZE_256M           9
  67 #define TLB_SIZE_1G             10
  68 #define TLB_SIZE_4G             11
  69
  70 #ifdef __powerpc64__
  71 #define MAS2_EPN_MASK           0xFFFFFFFFFFFFF000UL
  72 #else
  73 #define MAS2_EPN_MASK           0xFFFFF000
  74 #endif
  75 #define MAS2_EPN_SHIFT          12
  76 #define MAS2_X0                 0x00000040
  77 #define MAS2_X1                 0x00000020
  78 #define MAS2_W                  0x00000010
  79 #define MAS2_I                  0x00000008
  80 #define MAS2_M                  0x00000004
  81 #define MAS2_G                  0x00000002
  82 #define MAS2_E                  0x00000001
  83 #define MAS2_WIMGE_MASK         0x0000007F
  84
  85 #define MAS3_RPN                0xFFFFF000
  86 #define MAS3_RPN_SHIFT          12
  87 #define MAS3_U0                 0x00000200
  88 #define MAS3_U1                 0x00000100
  89 #define MAS3_U2                 0x00000080
  90 #define MAS3_U3                 0x00000040
  91 #define MAS3_UX                 0x00000020
  92 #define MAS3_SX                 0x00000010
  93 #define MAS3_UW                 0x00000008
  94 #define MAS3_SW                 0x00000004
  95 #define MAS3_UR                 0x00000002
  96 #define MAS3_SR                 0x00000001
  97
  98 #define MAS4_TLBSELD1           0x10000000
  99 #define MAS4_TLBSELD0           0x00000000
 100 #define MAS4_TIDSELD_MASK       0x00030000
 101 #define MAS4_TIDSELD_SHIFT      16
 102 #define MAS4_TSIZED_MASK        0x00000F00
 103 #define MAS4_TSIZED_SHIFT       8
 104 #define MAS4_X0D                0x00000040
 105 #define MAS4_X1D                0x00000020
 106 #define MAS4_WD                 0x00000010
 107 #define MAS4_ID                 0x00000008
 108 #define MAS4_MD                 0x00000004
 109 #define MAS4_GD                 0x00000002
 110 #define MAS4_ED                 0x00000001
 111
 112 #define MAS6_SPID0_MASK         0x00FF0000
 113 #define MAS6_SPID0_SHIFT        16
 114 #define MAS6_SAS                0x00000001
 115
 116 #define MAS7_RPN                0x0000000F
 117
 118 #define MAS1_GETTID(mas1)       (((mas1) & MAS1_TID_MASK) >> MAS1_TID_SHIFT)
 119
 120 #define MAS2_TLB0_ENTRY_IDX_MASK        0x0007f000
 121 #define MAS2_TLB0_ENTRY_IDX_SHIFT       12
 122
 123 /*
 124  * Maximum number of TLB1 entries used for a permanent mapping of kernel
 125  * region (kernel image plus statically allocated data).
 126  */
 127 #define KERNEL_REGION_MAX_TLB_ENTRIES   4
 128
 129 /*
 130  * Use MAS2_X0 to mark entries which will be copied
 131  * to AP CPUs during SMP bootstrap. As result entries
 132  * marked with _TLB_ENTRY_SHARED will be shared by all CPUs.
 133  */
 134 #define _TLB_ENTRY_SHARED       (MAS2_X0)       /* XXX under SMP? */
 135 #define _TLB_ENTRY_IO   (MAS2_I | MAS2_G)
 136 #define _TLB_ENTRY_MEM  (MAS2_M)
 137
 138 #define TLB1_MAX_ENTRIES        64
 139
 140 #if !defined(LOCORE)
 141 typedef struct tlb_entry {
 142         vm_paddr_t phys;
 143         vm_offset_t virt;
 144         vm_size_t size;
 145         uint32_t mas1;
 146 #ifdef __powerpc64__
 147         uint64_t mas2;
 148 #else
 149         uint32_t mas2;
 150 #endif
 151         uint32_t mas3;
 152         uint32_t mas7;
 153 } tlb_entry_t;
 154
 155 void tlb1_inval_entry(unsigned int);
 156 void tlb1_init(void);
 157 #endif /* !LOCORE */
 158
 159 #elif defined(BOOKE_PPC4XX)
 160
 161 /* TLB Words */
 162 #define TLB_PAGEID              0
 163 #define TLB_XLAT                1
 164 #define TLB_ATTRIB              2
 165
 166 /* Page identification fields */
 167 #define TLB_EPN_MASK            (0xFFFFFC00 >> 0)
 168 #define TLB_VALID               (0x80000000 >> 22)
 169 #define TLB_TS                  (0x80000000 >> 23)
 170 #define TLB_SIZE_1K             (0x00000000 >> 24)
 171 #define TLB_SIZE_MASK           (0xF0000000 >> 24)
 172
 173 /* Translation fields */
 174 #define TLB_RPN_MASK            (0xFFFFFC00 >> 0)
 175 #define TLB_ERPN_MASK           (0xF0000000 >> 28)
 176
 177 /* Storage attribute and access control fields */
 178 #define TLB_WL1                 (0x80000000 >> 11)
 179 #define TLB_IL1I                (0x80000000 >> 12)
 180 #define TLB_IL1D                (0x80000000 >> 13)
 181 #define TLB_IL2I                (0x80000000 >> 14)
 182 #define TLB_IL2D                (0x80000000 >> 15)
 183 #define TLB_U0                  (0x80000000 >> 16)
 184 #define TLB_U1                  (0x80000000 >> 17)
 185 #define TLB_U2                  (0x80000000 >> 18)
 186 #define TLB_U3                  (0x80000000 >> 19)
 187 #define TLB_W                   (0x80000000 >> 20)
 188 #define TLB_I                   (0x80000000 >> 21)
 189 #define TLB_M                   (0x80000000 >> 22)
 190 #define TLB_G                   (0x80000000 >> 23)
 191 #define TLB_E                   (0x80000000 >> 24)
 192 #define TLB_UX                  (0x80000000 >> 26)
 193 #define TLB_UW                  (0x80000000 >> 27)
 194 #define TLB_UR                  (0x80000000 >> 28)
 195 #define TLB_SX                  (0x80000000 >> 29)
 196 #define TLB_SW                  (0x80000000 >> 30)
 197 #define TLB_SR                  (0x80000000 >> 31)
 198 #define TLB_SIZE                64
 199
 200 #define TLB_SIZE_4K             (0x10000000 >> 24)
 201 #define TLB_SIZE_16K            (0x20000000 >> 24)
 202 #define TLB_SIZE_64K            (0x30000000 >> 24)
 203 #define TLB_SIZE_256K           (0x40000000 >> 24)
 204 #define TLB_SIZE_1M             (0x50000000 >> 24)
 205 #define TLB_SIZE_16M            (0x70000000 >> 24)
 206 #define TLB_SIZE_256M           (0x90000000 >> 24)
 207 #define TLB_SIZE_1G             (0xA0000000 >> 24)
 208
 209 #endif /* BOOKE_E500 */
 210
 211 #define TID_KERNEL      0       /* TLB TID to use for kernel (shared) translations */
 212 #define TID_KRESERVED   1       /* Number of TIDs reserved for kernel */
 213 #define TID_URESERVED   0       /* Number of TIDs reserved for user */
 214 #define TID_MIN         (TID_KRESERVED + TID_URESERVED)
 215 #define TID_MAX         255
 216 #define TID_NONE        -1
 217
 218 #define TLB_UNLOCKED    0
 219
 220 #if !defined(LOCORE)
 221
 222 typedef int tlbtid_t;
 223
 224 struct pmap;
 225
 226 void tlb_lock(uintptr_t *);
 227 void tlb_unlock(uintptr_t *);
 228 void tlb1_ap_prep(void);
 229 int  tlb1_set_entry(vm_offset_t, vm_paddr_t, vm_size_t, uint32_t);
 230
 231 #endif /* !LOCORE */
 232
 233 #endif  /* _MACHINE_TLB_H_ */