sys/sun4v/include/tte.h

   1 /*-
   2  * Copyright (c) 1997 Berkeley Software Design, Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  * 3. Berkeley Software Design Inc's name may not be used to endorse or
  13  *    promote products derived from this software without specific prior
  14  *    written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY BERKELEY SOFTWARE DESIGN INC ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL BERKELEY SOFTWARE DESIGN INC BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  *      from: BSDI: pmap.v9.h,v 1.10.2.6 1999/08/23 22:18:44 cp Exp
  29  * $FreeBSD$
  30  */
  31
  32 #ifndef _MACHINE_TTE_H_
  33 #define _MACHINE_TTE_H_
  34
  35 #define TTE_SHIFT       (4)
  36
  37 #define TD_SOFT2_SHIFT  (50)
  38 #define TD_DIAG_SHIFT   (41)
  39 #define TD_PA_SHIFT     (13)
  40 #define TD_SOFT_SHIFT   (7)
  41
  42 #define TD_SOFT2_BITS   (9)
  43 #define TD_DIAG_BITS    (9)
  44 #define TD_PA_CH_BITS   (30)
  45 #define TD_PA_SF_BITS   (28)
  46 #define TD_PA_BITS      (42)
  47 #define TD_SOFT_BITS    (6)
  48
  49 #define TD_SOFT2_MASK   ((1UL << TD_SOFT2_BITS) - 1)
  50 #define TD_DIAG_MASK    ((1UL << TD_DIAG_BITS) - 1)
  51 #define TD_PA_CH_MASK   ((1UL << TD_PA_CH_BITS) - 1)
  52 #define TD_PA_SF_MASK   ((1UL << TD_PA_SF_BITS) - 1)
  53 #define TD_PA_MASK      ((1UL << TD_PA_BITS) - 1)
  54 #define TD_SOFT_MASK    ((1UL << TD_SOFT_BITS) - 1)
  55
  56 #define TTE8K           (0UL)
  57 #define TTE64K          (1UL)
  58 #define TTE512K         (2UL)
  59 #define TTE4M           (3UL)
  60 #define TTE32M          (4UL)
  61 #define TTE256M         (5UL)
  62 #define TTE2G           (6UL)
  63 #define TTE16G          (7UL)
  64
  65 #define TD_PA(pa)       ((pa) & (TD_PA_MASK << TD_PA_SHIFT))
  66 /* NOTE: bit 6 of TD_SOFT will be sign-extended if used as an immediate. */
  67 #define TD_FAKE         ((1UL << 5) << TD_SOFT_SHIFT)
  68 #define TD_EXEC         ((1UL << 4) << TD_SOFT_SHIFT)
  69 #define TD_REF          ((1UL << 3) << TD_SOFT_SHIFT)
  70 #define TD_PV           ((1UL << 2) << TD_SOFT_SHIFT)
  71 #define TD_SW           ((1UL << 1) << TD_SOFT_SHIFT)
  72 #define TD_WIRED        ((1UL << 0) << TD_SOFT_SHIFT)
  73 #define TD_L            (1UL << 6)
  74 #define TD_CP           (1UL << 5)
  75 #define TD_CV           (1UL << 4)
  76 #define TD_E            (1UL << 3)
  77 #define TD_P            (1UL << 2)
  78 #define TD_W            (1UL << 1)
  79 #define TD_G            (1UL << 0)
  80
  81
  82 #define TTE_GET_PAGE_SIZE(tp) \
  83         (1 << TTE_GET_PAGE_SHIFT(tp))
  84 #define TTE_GET_PAGE_MASK(tp) \
  85         (TTE_GET_PAGE_SIZE(tp) - 1)
  86
  87 #define TTE_GET_PA(tte_data) \
  88         (tte_data & (TD_PA_MASK << TD_PA_SHIFT))
  89 #define TTE_GET_VPN(tp) \
  90         ((tp)->tte_vpn >> TV_SIZE_BITS)
  91 #define TTE_GET_VA(tp) \
  92         (TTE_GET_VPN(tp) << TTE_GET_PAGE_SHIFT(tp))
  93 #define TTE_GET_PMAP(tp) \
  94         (((tp)->tte_data & TD_P) != 0 ? \
  95          (kernel_pmap) : \
  96          (PHYS_TO_VM_PAGE(pmap_kextract((vm_offset_t)(tp)))->md.pmap))
  97 #define TTE_ZERO(tp) \
  98         memset(tp, 0, sizeof(*tp))
  99
 100 struct pmap;
 101 #define PTE_SHIFT       (3)
 102 #define PT_SHIFT        (PAGE_SHIFT - PTE_SHIFT)
 103
 104 #define VTD_SOFT_SHIFT  (56)
 105
 106 #define VTD_V           (1UL << 63)
 107 #define VTD_NFO         (1UL << 62)
 108 #define VTD_PA(pa)      ((pa) & (TD_PA_MASK << TD_PA_SHIFT))
 109 #define VTD_IE          (1UL << 12)
 110 #define VTD_E           (1UL << 11)
 111 #define VTD_CP          (1UL << 10)
 112 #define VTD_CV          (1UL << 9)
 113 #define VTD_P           (1UL << 8)
 114 #define VTD_X           (1UL << 7)
 115 #define VTD_W           (1UL << 6)
 116
 117 #define VTD_REF         (1UL << 5)
 118 #define VTD_SW_W        (1UL << 4)
 119 #define VTD_MANAGED     (1UL << 58)
 120 #define VTD_WIRED       (1UL << 57)
 121 #define VTD_LOCK        (1UL << 56)
 122
 123
 124
 125 #define VTD_8K          TTE8K
 126 #define VTD_64K         TTE64K
 127 #define VTD_512K        TTE512K
 128 #define VTD_4M          TTE4M
 129 #define VTD_32M         TTE32M
 130 #define VTD_256M        TTE256M
 131
 132
 133 /*
 134  * sparc64 compatibility for the loader
 135  */
 136
 137 #define TD_SIZE_SHIFT   (61)
 138 #define TS_4M           (3UL)
 139
 140 #define TD_V            (1UL << 63)
 141 #define TD_4M           (TS_4M << TD_SIZE_SHIFT)
 142
 143 /*
 144  * default flags for kernel pages
 145  */
 146 #define TTE_KERNEL            VTD_V | VTD_CP | VTD_CV | VTD_P | VTD_X | VTD_W | VTD_SW_W | VTD_REF | VTD_WIRED
 147 #define TTE_KERNEL_MINFLAGS   VTD_P
 148 #define TTE_MINFLAGS          VTD_V | VTD_CP | VTD_CV
 149
 150 #define VTD_SIZE_BITS   (4)
 151 #define VTD_SIZE_MASK   ((1 << VTD_SIZE_BITS) - 1)
 152
 153
 154 #define TTE_SIZE_SPREAD (3)
 155 #define TTE_PAGE_SHIFT(sz) \
 156         (PAGE_SHIFT + ((sz) * TTE_SIZE_SPREAD))
 157 #define TTE_GET_SIZE(tte_data) \
 158         (tte_data & VTD_SIZE_MASK)
 159 #define TTE_GET_PAGE_SHIFT(tte_data) \
 160         TTE_PAGE_SHIFT(TTE_GET_SIZE(tte_data))
 161
 162 #ifdef notyet
 163 typedef union {
 164         struct tte {
 165                 unsigned int    v:1;            /* <63> valid */
 166                 unsigned int    nfo:1;          /* <62> non-fault only */
 167                 unsigned int    sw:3;           /* <61:59> sw */
 168                 unsigned int    managed:1;      /* <58> managed */
 169                 unsigned int    wired:1;        /* <57> wired */
 170                 unsigned int    lock:1;         /* <56> sw - locked */
 171                 unsigned long   pa:43;          /* <55:13> pa */
 172                 unsigned int    ie:1;           /* <12> 1=invert endianness */
 173                 unsigned int    e:1;            /* <11> side effect */
 174                 unsigned int    cp:1;           /* <10> physically cache */
 175                 unsigned int    cv:1;           /* <9> virtually cache */
 176                 unsigned int    p:1;            /* <8> privilege required */
 177                 unsigned int    x:1;            /* <7> execute perm */
 178                 unsigned int    w:1;            /* <6> write perm */
 179                 unsigned int    ref:1;          /* <5> sw - ref */
 180                 unsigned int    wr_perm:1;      /* <4> sw - write perm */
 181                 unsigned int    rsvd:1;         /* <3> reserved */
 182                 unsigned int    sz:3;           /* <2:0> pagesize */
 183         } tte_bit;
 184         uint64_t                ll;
 185 } tte_t;
 186 #endif
 187
 188 #define tte_val         tte_bit.v               /* use < 0 check in asm */
 189 #define tte_size        tte_bit.sz
 190 #define tte_nfo         tte_bit.nfo
 191 #define tte_ie          tte_bit.ie
 192 #define tte_wired       tte_bit.wired
 193 #define tte_pa          tte_bit.pa
 194 #define tte_ref         tte_bit.ref
 195 #define tte_wr_perm     tte_bit.wr_perm
 196 #define tte_exec_perm   tte_bit.x
 197 #define tte_lock        tte_bit.lock
 198 #define tte_cp          tte_bit.cp
 199 #define tte_cv          tte_bit.cv
 200 #define tte_se          tte_bit.e
 201 #define tte_priv        tte_bit.p
 202 #define tte_hwwr        tte_bit.w
 203
 204 #define TTE_IS_VALID(ttep)      ((ttep)->tte_inthi < 0)
 205 #define TTE_SET_INVALID(ttep)   ((ttep)->tte_val = 0)
 206 #define TTE_IS_8K(ttep)         (TTE_CSZ(ttep) == TTE8K)
 207 #define TTE_IS_WIRED(ttep)      ((ttep)->tte_wired)
 208 #define TTE_IS_WRITABLE(ttep)   ((ttep)->tte_wr_perm)
 209 #define TTE_IS_EXECUTABLE(ttep) ((ttep)->tte_exec_perm)
 210 #define TTE_IS_PRIVILEGED(ttep) ((ttep)->tte_priv)
 211 #define TTE_IS_NOSYNC(ttep)     ((ttep)->tte_no_sync)
 212 #define TTE_IS_LOCKED(ttep)     ((ttep)->tte_lock)
 213 #define TTE_IS_SIDEFFECT(ttep)  ((ttep)->tte_se)
 214 #define TTE_IS_NFO(ttep)        ((ttep)->tte_nfo)
 215
 216 #define TTE_IS_REF(ttep)        ((ttep)->tte_ref)
 217 #define TTE_IS_MOD(ttep)        ((ttep)->tte_hwwr)
 218 #define TTE_IS_IE(ttep)         ((ttep)->tte_ie)
 219 #define TTE_SET_SUSPEND(ttep)   ((ttep)->tte_suspend = 1)
 220 #define TTE_CLR_SUSPEND(ttep)   ((ttep)->tte_suspend = 0)
 221 #define TTE_IS_SUSPEND(ttep)    ((ttep)->tte_suspend)
 222 #define TTE_SET_REF(ttep)       ((ttep)->tte_ref = 1)
 223 #define TTE_CLR_REF(ttep)       ((ttep)->tte_ref = 0)
 224 #define TTE_SET_LOCKED(ttep)    ((ttep)->tte_lock = 1)
 225 #define TTE_CLR_LOCKED(ttep)    ((ttep)->tte_lock = 0)
 226 #define TTE_SET_MOD(ttep)       ((ttep)->tte_hwwr = 1)
 227 #define TTE_CLR_MOD(ttep)       ((ttep)->tte_hwwr = 0)
 228 #define TTE_SET_RM(ttep)                                                \
 229         (((ttep)->tte_intlo) =                                          \
 230         (ttep)->tte_intlo | TTE_HWWR_INT | TTE_REF_INT)
 231 #define TTE_CLR_RM(ttep)                                                \
 232         (((ttep)->tte_intlo) =                                          \
 233         (ttep)->tte_intlo & ~(TTE_HWWR_INT | TTE_REF_INT))
 234
 235 #define TTE_SET_WRT(ttep)       ((ttep)->tte_wr_perm = 1)
 236 #define TTE_CLR_WRT(ttep)       ((ttep)->tte_wr_perm = 0)
 237 #define TTE_SET_EXEC(ttep)      ((ttep)->tte_exec_perm = 1)
 238 #define TTE_CLR_EXEC(ttep)      ((ttep)->tte_exec_perm = 0)
 239 #define TTE_SET_PRIV(ttep)      ((ttep)->tte_priv = 1)
 240 #define TTE_CLR_PRIV(ttep)      ((ttep)->tte_priv = 0)
 241
 242 #define TTE_BSZS_SHIFT(sz)      ((sz) * 3)
 243
 244 struct pmap;
 245
 246 void tte_clear_phys_bit(vm_page_t m, uint64_t flags);
 247
 248 void tte_set_phys_bit(vm_page_t m, uint64_t flags);
 249
 250 boolean_t tte_get_phys_bit(vm_page_t m, uint64_t flags);
 251
 252 void tte_clear_virt_bit(struct pmap *pmap, vm_offset_t va, uint64_t flags);
 253
 254 void tte_set_virt_bit(struct pmap *pmap, vm_offset_t va, uint64_t flags);
 255
 256 boolean_t tte_get_virt_bit(struct pmap *pmap, vm_offset_t va, uint64_t flags);
 257
 258 #endif /* !_MACHINE_TTE_H_ */