1 /*  Generic MTRR (Memory Type Range Register) ioctls.
2 
3     Copyright (C) 1997-1999  Richard Gooch
4 
5     This library is free software; you can redistribute it and/or
6     modify it under the terms of the GNU Library General Public
7     License as published by the Free Software Foundation; either
8     version 2 of the License, or (at your option) any later version.
9 
10     This library is distributed in the hope that it will be useful,
11     but WITHOUT ANY WARRANTY; without even the implied warranty of
12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13     Library General Public License for more details.
14 
15     You should have received a copy of the GNU Library General Public
16     License along with this library; if not, write to the Free
17     Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 
19     Richard Gooch may be reached by email at  rgooch@atnf.csiro.au
20     The postal address is:
21       Richard Gooch, c/o ATNF, P. O. Box 76, Epping, N.S.W., 2121, Australia.
22 */
23 #ifndef _ASM_X86_MTRR_H
24 #define _ASM_X86_MTRR_H
25 
26 #include <linux/types.h>
27 #include <linux/ioctl.h>
28 #include <linux/errno.h>
29 
30 #define	MTRR_IOCTL_BASE	'M'
31 
32 struct mtrr_sentry {
33     unsigned long base;    /*  Base address     */
34     unsigned int size;    /*  Size of region   */
35     unsigned int type;     /*  Type of region   */
36 };
37 
38 /* Warning: this structure has a different order from i386
39    on x86-64. The 32bit emulation code takes care of that.
40    But you need to use this for 64bit, otherwise your X server
41    will break. */
42 
43 #ifdef __i386__
44 struct mtrr_gentry {
45     unsigned int regnum;   /*  Register number  */
46     unsigned long base;    /*  Base address     */
47     unsigned int size;    /*  Size of region   */
48     unsigned int type;     /*  Type of region   */
49 };
50 
51 #else /* __i386__ */
52 
53 struct mtrr_gentry {
54     unsigned long base;    /*  Base address     */
55     unsigned int size;    /*  Size of region   */
56     unsigned int regnum;   /*  Register number  */
57     unsigned int type;     /*  Type of region   */
58 };
59 #endif /* !__i386__ */
60 
61 struct mtrr_var_range {
62 	__u32 base_lo;
63 	__u32 base_hi;
64 	__u32 mask_lo;
65 	__u32 mask_hi;
66 };
67 
68 /* In the Intel processor's MTRR interface, the MTRR type is always held in
69    an 8 bit field: */
70 typedef __u8 mtrr_type;
71 
72 #define MTRR_NUM_FIXED_RANGES 88
73 #define MTRR_MAX_VAR_RANGES 256
74 
75 struct mtrr_state_type {
76 	struct mtrr_var_range var_ranges[MTRR_MAX_VAR_RANGES];
77 	mtrr_type fixed_ranges[MTRR_NUM_FIXED_RANGES];
78 	unsigned char enabled;
79 	unsigned char have_fixed;
80 	mtrr_type def_type;
81 };
82 
83 #define MTRRphysBase_MSR(reg) (0x200 + 2 * (reg))
84 #define MTRRphysMask_MSR(reg) (0x200 + 2 * (reg) + 1)
85 
86 /*  These are the various ioctls  */
87 #define MTRRIOC_ADD_ENTRY        _IOW(MTRR_IOCTL_BASE,  0, struct mtrr_sentry)
88 #define MTRRIOC_SET_ENTRY        _IOW(MTRR_IOCTL_BASE,  1, struct mtrr_sentry)
89 #define MTRRIOC_DEL_ENTRY        _IOW(MTRR_IOCTL_BASE,  2, struct mtrr_sentry)
90 #define MTRRIOC_GET_ENTRY        _IOWR(MTRR_IOCTL_BASE, 3, struct mtrr_gentry)
91 #define MTRRIOC_KILL_ENTRY       _IOW(MTRR_IOCTL_BASE,  4, struct mtrr_sentry)
92 #define MTRRIOC_ADD_PAGE_ENTRY   _IOW(MTRR_IOCTL_BASE,  5, struct mtrr_sentry)
93 #define MTRRIOC_SET_PAGE_ENTRY   _IOW(MTRR_IOCTL_BASE,  6, struct mtrr_sentry)
94 #define MTRRIOC_DEL_PAGE_ENTRY   _IOW(MTRR_IOCTL_BASE,  7, struct mtrr_sentry)
95 #define MTRRIOC_GET_PAGE_ENTRY   _IOWR(MTRR_IOCTL_BASE, 8, struct mtrr_gentry)
96 #define MTRRIOC_KILL_PAGE_ENTRY  _IOW(MTRR_IOCTL_BASE,  9, struct mtrr_sentry)
97 
98 /*  These are the region types  */
99 #define MTRR_TYPE_UNCACHABLE 0
100 #define MTRR_TYPE_WRCOMB     1
101 /*#define MTRR_TYPE_         2*/
102 /*#define MTRR_TYPE_         3*/
103 #define MTRR_TYPE_WRTHROUGH  4
104 #define MTRR_TYPE_WRPROT     5
105 #define MTRR_TYPE_WRBACK     6
106 #define MTRR_NUM_TYPES       7
107 
108 #ifdef __KERNEL__
109 
110 /*  The following functions are for use by other drivers  */
111 # ifdef CONFIG_MTRR
112 extern u8 mtrr_type_lookup(u64 addr, u64 end);
113 extern void mtrr_save_fixed_ranges(void *);
114 extern void mtrr_save_state(void);
115 extern int mtrr_add(unsigned long base, unsigned long size,
116 		    unsigned int type, bool increment);
117 extern int mtrr_add_page(unsigned long base, unsigned long size,
118 			 unsigned int type, bool increment);
119 extern int mtrr_del(int reg, unsigned long base, unsigned long size);
120 extern int mtrr_del_page(int reg, unsigned long base, unsigned long size);
121 extern void mtrr_centaur_report_mcr(int mcr, u32 lo, u32 hi);
122 extern void mtrr_ap_init(void);
123 extern void mtrr_bp_init(void);
124 extern void set_mtrr_aps_delayed_init(void);
125 extern void mtrr_aps_init(void);
126 extern void mtrr_bp_restore(void);
127 extern int mtrr_trim_uncached_memory(unsigned long end_pfn);
128 extern int amd_special_default_mtrr(void);
129 #  else
mtrr_type_lookup(u64 addr,u64 end)130 static inline u8 mtrr_type_lookup(u64 addr, u64 end)
131 {
132 	/*
133 	 * Return no-MTRRs:
134 	 */
135 	return 0xff;
136 }
137 #define mtrr_save_fixed_ranges(arg) do {} while (0)
138 #define mtrr_save_state() do {} while (0)
mtrr_add(unsigned long base,unsigned long size,unsigned int type,bool increment)139 static inline int mtrr_add(unsigned long base, unsigned long size,
140 			   unsigned int type, bool increment)
141 {
142     return -ENODEV;
143 }
mtrr_add_page(unsigned long base,unsigned long size,unsigned int type,bool increment)144 static inline int mtrr_add_page(unsigned long base, unsigned long size,
145 				unsigned int type, bool increment)
146 {
147     return -ENODEV;
148 }
mtrr_del(int reg,unsigned long base,unsigned long size)149 static inline int mtrr_del(int reg, unsigned long base, unsigned long size)
150 {
151     return -ENODEV;
152 }
mtrr_del_page(int reg,unsigned long base,unsigned long size)153 static inline int mtrr_del_page(int reg, unsigned long base, unsigned long size)
154 {
155     return -ENODEV;
156 }
mtrr_trim_uncached_memory(unsigned long end_pfn)157 static inline int mtrr_trim_uncached_memory(unsigned long end_pfn)
158 {
159 	return 0;
160 }
mtrr_centaur_report_mcr(int mcr,u32 lo,u32 hi)161 static inline void mtrr_centaur_report_mcr(int mcr, u32 lo, u32 hi)
162 {
163 }
164 
165 #define mtrr_ap_init() do {} while (0)
166 #define mtrr_bp_init() do {} while (0)
167 #define set_mtrr_aps_delayed_init() do {} while (0)
168 #define mtrr_aps_init() do {} while (0)
169 #define mtrr_bp_restore() do {} while (0)
170 #  endif
171 
172 #ifdef CONFIG_COMPAT
173 #include <linux/compat.h>
174 
175 struct mtrr_sentry32 {
176     compat_ulong_t base;    /*  Base address     */
177     compat_uint_t size;    /*  Size of region   */
178     compat_uint_t type;     /*  Type of region   */
179 };
180 
181 struct mtrr_gentry32 {
182     compat_ulong_t regnum;   /*  Register number  */
183     compat_uint_t base;    /*  Base address     */
184     compat_uint_t size;    /*  Size of region   */
185     compat_uint_t type;     /*  Type of region   */
186 };
187 
188 #define MTRR_IOCTL_BASE 'M'
189 
190 #define MTRRIOC32_ADD_ENTRY      _IOW(MTRR_IOCTL_BASE,  0, struct mtrr_sentry32)
191 #define MTRRIOC32_SET_ENTRY      _IOW(MTRR_IOCTL_BASE,  1, struct mtrr_sentry32)
192 #define MTRRIOC32_DEL_ENTRY      _IOW(MTRR_IOCTL_BASE,  2, struct mtrr_sentry32)
193 #define MTRRIOC32_GET_ENTRY      _IOWR(MTRR_IOCTL_BASE, 3, struct mtrr_gentry32)
194 #define MTRRIOC32_KILL_ENTRY     _IOW(MTRR_IOCTL_BASE,  4, struct mtrr_sentry32)
195 #define MTRRIOC32_ADD_PAGE_ENTRY _IOW(MTRR_IOCTL_BASE,  5, struct mtrr_sentry32)
196 #define MTRRIOC32_SET_PAGE_ENTRY _IOW(MTRR_IOCTL_BASE,  6, struct mtrr_sentry32)
197 #define MTRRIOC32_DEL_PAGE_ENTRY _IOW(MTRR_IOCTL_BASE,  7, struct mtrr_sentry32)
198 #define MTRRIOC32_GET_PAGE_ENTRY _IOWR(MTRR_IOCTL_BASE, 8, struct mtrr_gentry32)
199 #define MTRRIOC32_KILL_PAGE_ENTRY		\
200 				 _IOW(MTRR_IOCTL_BASE,  9, struct mtrr_sentry32)
201 #endif /* CONFIG_COMPAT */
202 
203 #endif /* __KERNEL__ */
204 
205 #endif /* _ASM_X86_MTRR_H */
206