sys/sparc64/include/tte.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1997 Berkeley Software Design, Inc. All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  * 3. Berkeley Software Design Inc's name may not be used to endorse or
  15  *    promote products derived from this software without specific prior
  16  *    written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY BERKELEY SOFTWARE DESIGN INC ``AS IS'' AND
  19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL BERKELEY SOFTWARE DESIGN INC BE LIABLE
  22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  *
  30  *      from: BSDI: pmap.v9.h,v 1.10.2.6 1999/08/23 22:18:44 cp Exp
  31  * $FreeBSD$
  32  */
  33
  34 #ifndef _MACHINE_TTE_H_
  35 #define _MACHINE_TTE_H_
  36
  37 #define TTE_SHIFT       (5)
  38
  39 #define TD_SIZE_SHIFT   (61)
  40 #define TD_SOFT2_SHIFT  (50)
  41 #define TD_RSVD2_SHIFT  (49)
  42 #define TD_SIZE2_SHIFT  (48)
  43 #define TD_DIAG_SF_SHIFT        (41)
  44 #define TD_RSVD_CH_SHIFT        (43)
  45 #define TD_RSVD_OC_SHIFT        (47)
  46 #define TD_RSVD_PT_SHIFT        TD_RSVD_CH_SHIFT
  47 #define TD_RSVD_VE_SHIFT        (41)
  48 #define TD_PA_SHIFT     (13)
  49 #define TD_SOFT_SHIFT   (7)
  50
  51 #define TD_SIZE_BITS    (2)
  52 #define TD_SOFT2_BITS   (9)
  53 #define TD_RSVD2_BITS   (1)     /* US-IV+, SPARC64 VI, VII, VIIIfx */
  54 #define TD_SIZE2_BITS   (1)     /* US-IV+, SPARC64 VI, VII, VIIIfx */
  55 #define TD_DIAG_SF_BITS (9)     /* US-I, II{,e,i} */
  56 #define TD_RSVD_CH_BITS (7)     /* US-III{,i,+}, US-IV, SPARC64 V */
  57 #define TD_RSVD_OC_BITS (1)     /* SPARC64 VI, VII */
  58 #define TD_RSVD_PT_BITS (5)     /* US-IV+, SPARC64 VI, VII */
  59 #define TD_RSVD_VE_BITS (7)     /* SPARC64 VIIIfx */
  60 #define TD_PA_CH_BITS   (30)    /* US-III{,i,+}, US-IV{,+}, SPARC64 V */
  61 #define TD_PA_OC_BITS   (34)    /* SPARC64 VI, VII */
  62 #define TD_PA_SF_BITS   (28)    /* US-I, II{,e,i}, SPARC64 VIIIfx */
  63 #define TD_PA_BITS      TD_PA_CH_BITS
  64 #define TD_SOFT_BITS    (6)
  65
  66 #define TD_SIZE_MASK    ((1UL << TD_SIZE_BITS) - 1)
  67 #define TD_SOFT2_MASK   ((1UL << TD_SOFT2_BITS) - 1)
  68 #define TD_RSVD2_MASK   ((1UL << TD_RSVD2_BITS) - 1)
  69 #define TD_SIZE2_MASK   ((1UL << TD_SIZE2_BITS) - 1)
  70 #define TD_DIAG_SF_MASK ((1UL << TD_DIAG_SF_BITS) - 1)
  71 #define TD_RSVD_CH_MASK ((1UL << TD_RSVD_CH_BITS) - 1)
  72 #define TD_RSVD_OC_MASK ((1UL << TD_RSVD_OC_BITS) - 1)
  73 #define TD_RSVD_PT_MASK ((1UL << TD_RSVD_PT_BITS) - 1)
  74 #define TD_RSVD_VE_MASK ((1UL << TD_RSVD_VE_BITS) - 1)
  75 #define TD_PA_CH_MASK   ((1UL << TD_PA_CH_BITS) - 1)
  76 #define TD_PA_OC_MASK   ((1UL << TD_PA_OC_BITS) - 1)
  77 #define TD_PA_SF_MASK   ((1UL << TD_PA_SF_BITS) - 1)
  78 #define TD_PA_MASK      ((1UL << TD_PA_BITS) - 1)
  79 #define TD_SOFT_MASK    ((1UL << TD_SOFT_BITS) - 1)
  80
  81 #define TS_8K           (0UL)
  82 #define TS_64K          (1UL)
  83 #define TS_512K         (2UL)
  84 #define TS_4M           (3UL)
  85 #define TS_32M          (4UL)   /* US-IV+, SPARC64 VI, VII only */
  86 #define TS_256M         (5UL)   /* US-IV+, SPARC64 VI, VII only */
  87 #define TS_2G           (6UL)   /* SPARC64 VIIIfx only */
  88
  89 #define TS_MIN          TS_8K
  90 #define TS_MAX          TS_4M
  91
  92 #define TD_V            (1UL << 63)
  93 #define TD_8K           (TS_8K << TD_SIZE_SHIFT)
  94 #define TD_64K          (TS_64K << TD_SIZE_SHIFT)
  95 #define TD_512K         (TS_512K << TD_SIZE_SHIFT)
  96 #define TD_4M           (TS_4M << TD_SIZE_SHIFT)
  97 #define TD_32M                                                          \
  98         (((TS_32M & TD_SIZE_MASK) << TD_SIZE_SHIFT) |                   \
  99         (TD_SIZE2_MASK << TD_SIZE2_SHIFT))
 100 #define TD_256M                                                         \
 101         (((TS_256M & TD_SIZE_MASK) << TD_SIZE_SHIFT) |                  \
 102         (TD_SIZE2_MASK << TD_SIZE2_SHIFT))
 103 #define TD_2G                                                           \
 104         (((TS_2G & TD_SIZE_MASK) << TD_SIZE_SHIFT) |                    \
 105         (TD_SIZE2_MASK << TD_SIZE2_SHIFT))
 106 #define TD_NFO          (1UL << 60)
 107 #define TD_IE           (1UL << 59)
 108 #define TD_PA(pa)       ((pa) & (TD_PA_MASK << TD_PA_SHIFT))
 109 /* NOTE: bit 6 of TD_SOFT will be sign-extended if used as an immediate. */
 110 #define TD_FAKE         ((1UL << 5) << TD_SOFT_SHIFT)
 111 #define TD_EXEC         ((1UL << 4) << TD_SOFT_SHIFT)
 112 #define TD_REF          ((1UL << 3) << TD_SOFT_SHIFT)
 113 #define TD_PV           ((1UL << 2) << TD_SOFT_SHIFT)
 114 #define TD_SW           ((1UL << 1) << TD_SOFT_SHIFT)
 115 #define TD_WIRED        ((1UL << 0) << TD_SOFT_SHIFT)
 116 #define TD_L            (1UL << 6)
 117 #define TD_CP           (1UL << 5)
 118 #define TD_CV           (1UL << 4)
 119 #define TD_E            (1UL << 3)
 120 #define TD_P            (1UL << 2)
 121 #define TD_W            (1UL << 1)
 122 #define TD_G            (1UL << 0)
 123
 124 #define TV_SIZE_BITS    (TD_SIZE_BITS)
 125 #define TV_VPN(va, sz)  ((((va) >> TTE_PAGE_SHIFT(sz)) << TV_SIZE_BITS) | sz)
 126
 127 #define TTE_SIZE_SPREAD (3)
 128 #define TTE_PAGE_SHIFT(sz)                                              \
 129         (PAGE_SHIFT + ((sz) * TTE_SIZE_SPREAD))
 130
 131 #define TTE_GET_SIZE(tp)                                                \
 132         (((tp)->tte_data >> TD_SIZE_SHIFT) & TD_SIZE_MASK)
 133 #define TTE_GET_PAGE_SHIFT(tp)                                          \
 134         TTE_PAGE_SHIFT(TTE_GET_SIZE(tp))
 135 #define TTE_GET_PAGE_SIZE(tp)                                           \
 136         (1 << TTE_GET_PAGE_SHIFT(tp))
 137 #define TTE_GET_PAGE_MASK(tp)                                           \
 138         (TTE_GET_PAGE_SIZE(tp) - 1)
 139
 140 #define TTE_GET_PA(tp)                                                  \
 141         ((tp)->tte_data & (TD_PA_MASK << TD_PA_SHIFT))
 142 #define TTE_GET_VPN(tp)                                                 \
 143         ((tp)->tte_vpn >> TV_SIZE_BITS)
 144 #define TTE_GET_VA(tp)                                                  \
 145         (TTE_GET_VPN(tp) << TTE_GET_PAGE_SHIFT(tp))
 146 #define TTE_GET_PMAP(tp)                                                \
 147         (((tp)->tte_data & TD_P) != 0 ? (kernel_pmap) :                 \
 148         (PHYS_TO_VM_PAGE(pmap_kextract((vm_offset_t)(tp)))->md.pmap))
 149 #define TTE_ZERO(tp)                                                    \
 150         memset(tp, 0, sizeof(*tp))
 151
 152 struct pmap;
 153
 154 struct tte {
 155         u_long  tte_vpn;
 156         u_long  tte_data;
 157         TAILQ_ENTRY(tte) tte_link;
 158 };
 159
 160 static __inline int
 161 tte_match(struct tte *tp, vm_offset_t va)
 162 {
 163
 164         return (((tp->tte_data & TD_V) != 0) &&
 165             (tp->tte_vpn == TV_VPN(va, TTE_GET_SIZE(tp))));
 166 }
 167
 168 #endif /* !_MACHINE_TTE_H_ */