[deliverable/linux.git] / arch / x86 / include / asm / mtrr.h

/*  Generic MTRR (Memory Type Range Register) ioctls.

    Copyright (C) 1997-1999  Richard Gooch

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free
    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

    Richard Gooch may be reached by email at  rgooch@atnf.csiro.au
    The postal address is:
      Richard Gooch, c/o ATNF, P. O. Box 76, Epping, N.S.W., 2121, Australia.
*/
#ifndef _ASM_X86_MTRR_H
#define _ASM_X86_MTRR_H

#include <linux/types.h>
#include <linux/ioctl.h>
#include <linux/errno.h>

#define	MTRR_IOCTL_BASE	'M'

struct mtrr_sentry {
    unsigned long base;    /*  Base address     */
    unsigned int size;    /*  Size of region   */
    unsigned int type;     /*  Type of region   */
};

/* Warning: this structure has a different order from i386
   on x86-64. The 32bit emulation code takes care of that.
   But you need to use this for 64bit, otherwise your X server
   will break. */

#ifdef __i386__
struct mtrr_gentry {
    unsigned int regnum;   /*  Register number  */
    unsigned long base;    /*  Base address     */
    unsigned int size;    /*  Size of region   */
    unsigned int type;     /*  Type of region   */
};

#else /* __i386__ */

struct mtrr_gentry {
    unsigned long base;    /*  Base address     */
    unsigned int size;    /*  Size of region   */
    unsigned int regnum;   /*  Register number  */
    unsigned int type;     /*  Type of region   */
};
#endif /* !__i386__ */

struct mtrr_var_range {
	__u32 base_lo;
	__u32 base_hi;
	__u32 mask_lo;
	__u32 mask_hi;
};

/* In the Intel processor's MTRR interface, the MTRR type is always held in
   an 8 bit field: */
typedef __u8 mtrr_type;

#define MTRR_NUM_FIXED_RANGES 88
#define MTRR_MAX_VAR_RANGES 256

struct mtrr_state_type {
	struct mtrr_var_range var_ranges[MTRR_MAX_VAR_RANGES];
	mtrr_type fixed_ranges[MTRR_NUM_FIXED_RANGES];
	unsigned char enabled;
	unsigned char have_fixed;
	mtrr_type def_type;
};

#define MTRRphysBase_MSR(reg) (0x200 + 2 * (reg))
#define MTRRphysMask_MSR(reg) (0x200 + 2 * (reg) + 1)

/*  These are the various ioctls  */
#define MTRRIOC_ADD_ENTRY        _IOW(MTRR_IOCTL_BASE,  0, struct mtrr_sentry)
#define MTRRIOC_SET_ENTRY        _IOW(MTRR_IOCTL_BASE,  1, struct mtrr_sentry)
#define MTRRIOC_DEL_ENTRY        _IOW(MTRR_IOCTL_BASE,  2, struct mtrr_sentry)
#define MTRRIOC_GET_ENTRY        _IOWR(MTRR_IOCTL_BASE, 3, struct mtrr_gentry)
#define MTRRIOC_KILL_ENTRY       _IOW(MTRR_IOCTL_BASE,  4, struct mtrr_sentry)
#define MTRRIOC_ADD_PAGE_ENTRY   _IOW(MTRR_IOCTL_BASE,  5, struct mtrr_sentry)
#define MTRRIOC_SET_PAGE_ENTRY   _IOW(MTRR_IOCTL_BASE,  6, struct mtrr_sentry)
#define MTRRIOC_DEL_PAGE_ENTRY   _IOW(MTRR_IOCTL_BASE,  7, struct mtrr_sentry)
#define MTRRIOC_GET_PAGE_ENTRY   _IOWR(MTRR_IOCTL_BASE, 8, struct mtrr_gentry)
#define MTRRIOC_KILL_PAGE_ENTRY  _IOW(MTRR_IOCTL_BASE,  9, struct mtrr_sentry)

/*  These are the region types  */
#define MTRR_TYPE_UNCACHABLE 0
#define MTRR_TYPE_WRCOMB     1
/*#define MTRR_TYPE_         2*/
/*#define MTRR_TYPE_         3*/
#define MTRR_TYPE_WRTHROUGH  4
#define MTRR_TYPE_WRPROT     5
#define MTRR_TYPE_WRBACK     6
#define MTRR_NUM_TYPES       7

#ifdef __KERNEL__

/*  The following functions are for use by other drivers  */
# ifdef CONFIG_MTRR
extern u8 mtrr_type_lookup(u64 addr, u64 end);
extern void mtrr_save_fixed_ranges(void *);
extern void mtrr_save_state(void);
extern int mtrr_add(unsigned long base, unsigned long size,
		    unsigned int type, bool increment);
extern int mtrr_add_page(unsigned long base, unsigned long size,
			 unsigned int type, bool increment);
extern int mtrr_del(int reg, unsigned long base, unsigned long size);
extern int mtrr_del_page(int reg, unsigned long base, unsigned long size);
extern void mtrr_centaur_report_mcr(int mcr, u32 lo, u32 hi);
extern void mtrr_ap_init(void);
extern void mtrr_bp_init(void);
extern void set_mtrr_aps_delayed_init(void);
extern void mtrr_aps_init(void);
extern void mtrr_bp_restore(void);
extern int mtrr_trim_uncached_memory(unsigned long end_pfn);
extern int amd_special_default_mtrr(void);
#  else
static inline u8 mtrr_type_lookup(u64 addr, u64 end)
{
	/*
	 * Return no-MTRRs:
	 */
	return 0xff;
}
#define mtrr_save_fixed_ranges(arg) do {} while (0)
#define mtrr_save_state() do {} while (0)
static inline int mtrr_add(unsigned long base, unsigned long size,
			   unsigned int type, bool increment)
{
    return -ENODEV;
}
static inline int mtrr_add_page(unsigned long base, unsigned long size,
				unsigned int type, bool increment)
{
    return -ENODEV;
}
static inline int mtrr_del(int reg, unsigned long base, unsigned long size)
{
    return -ENODEV;
}
static inline int mtrr_del_page(int reg, unsigned long base, unsigned long size)
{
    return -ENODEV;
}
static inline int mtrr_trim_uncached_memory(unsigned long end_pfn)
{
	return 0;
}
static inline void mtrr_centaur_report_mcr(int mcr, u32 lo, u32 hi)
{
}

#define mtrr_ap_init() do {} while (0)
#define mtrr_bp_init() do {} while (0)
#define set_mtrr_aps_delayed_init() do {} while (0)
#define mtrr_aps_init() do {} while (0)
#define mtrr_bp_restore() do {} while (0)
#  endif

#ifdef CONFIG_COMPAT
#include <linux/compat.h>

struct mtrr_sentry32 {
    compat_ulong_t base;    /*  Base address     */
    compat_uint_t size;    /*  Size of region   */
    compat_uint_t type;     /*  Type of region   */
};

struct mtrr_gentry32 {
    compat_ulong_t regnum;   /*  Register number  */
    compat_uint_t base;    /*  Base address     */
    compat_uint_t size;    /*  Size of region   */
    compat_uint_t type;     /*  Type of region   */
};

#define MTRR_IOCTL_BASE 'M'

#define MTRRIOC32_ADD_ENTRY      _IOW(MTRR_IOCTL_BASE,  0, struct mtrr_sentry32)
#define MTRRIOC32_SET_ENTRY      _IOW(MTRR_IOCTL_BASE,  1, struct mtrr_sentry32)
#define MTRRIOC32_DEL_ENTRY      _IOW(MTRR_IOCTL_BASE,  2, struct mtrr_sentry32)
#define MTRRIOC32_GET_ENTRY      _IOWR(MTRR_IOCTL_BASE, 3, struct mtrr_gentry32)
#define MTRRIOC32_KILL_ENTRY     _IOW(MTRR_IOCTL_BASE,  4, struct mtrr_sentry32)
#define MTRRIOC32_ADD_PAGE_ENTRY _IOW(MTRR_IOCTL_BASE,  5, struct mtrr_sentry32)
#define MTRRIOC32_SET_PAGE_ENTRY _IOW(MTRR_IOCTL_BASE,  6, struct mtrr_sentry32)
#define MTRRIOC32_DEL_PAGE_ENTRY _IOW(MTRR_IOCTL_BASE,  7, struct mtrr_sentry32)
#define MTRRIOC32_GET_PAGE_ENTRY _IOWR(MTRR_IOCTL_BASE, 8, struct mtrr_gentry32)
#define MTRRIOC32_KILL_PAGE_ENTRY		\
				 _IOW(MTRR_IOCTL_BASE,  9, struct mtrr_sentry32)
#endif /* CONFIG_COMPAT */

#endif /* __KERNEL__ */

#endif /* _ASM_X86_MTRR_H */
Commit	Line	Data
297a99e1 TG	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	*/
1965aae3 PA	23	#ifndef _ASM_X86_MTRR_H
1965aae3 PA	24	#define _ASM_X86_MTRR_H
297a99e1	25
d122072c	26	#include <linux/types.h>
297a99e1 TG	27	#include <linux/ioctl.h>
	28	#include <linux/errno.h>
	29
	30	#define MTRR_IOCTL_BASE 'M'
	31
9969b440	32	struct mtrr_sentry {
297a99e1 TG	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__
9969b440	44	struct mtrr_gentry {
297a99e1 TG	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
9969b440	53	struct mtrr_gentry {
297a99e1 TG	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
932d27a7	61	struct mtrr_var_range {
79f3b3cb KM	62	__u32 base_lo;
	63	__u32 base_hi;
	64	__u32 mask_lo;
	65	__u32 mask_hi;
932d27a7 SY	66	};
	67
	68	/* In the Intel processor's MTRR interface, the MTRR type is always held in
	69	an 8 bit field: */
79f3b3cb	70	typedef __u8 mtrr_type;
932d27a7 SY	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
297a99e1 TG	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
96a388de	108	#ifdef __KERNEL__
297a99e1 TG	109
	110	/* The following functions are for use by other drivers */
	111	# ifdef CONFIG_MTRR
52783fa8	112	extern u8 mtrr_type_lookup(u64 addr, u64 end);
297a99e1 TG	113	extern void mtrr_save_fixed_ranges(void *);
297a99e1 TG	114	extern void mtrr_save_state(void);
9969b440 JP	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);
297a99e1 TG	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);
d0af9eed SS	124	extern void set_mtrr_aps_delayed_init(void);
	125	extern void mtrr_aps_init(void);
	126	extern void mtrr_bp_restore(void);
99fc8d42	127	extern int mtrr_trim_uncached_memory(unsigned long end_pfn);
35605a10	128	extern int amd_special_default_mtrr(void);
297a99e1	129	# else
52783fa8 IM	130	static inline u8 mtrr_type_lookup(u64 addr, u64 end)
	131	{
	132	/*
	133	* Return no-MTRRs:
	134	*/
	135	return 0xff;
	136	}
297a99e1 TG	137	#define mtrr_save_fixed_ranges(arg) do {} while (0)
297a99e1 TG	138	#define mtrr_save_state() do {} while (0)
9969b440 JP	139	static inline int mtrr_add(unsigned long base, unsigned long size,
9969b440 JP	140	unsigned int type, bool increment)
297a99e1 TG	141	{
	142	return -ENODEV;
	143	}
9969b440	144	static inline int mtrr_add_page(unsigned long base, unsigned long size,
2d2ee8de	145	unsigned int type, bool increment)
297a99e1 TG	146	{
	147	return -ENODEV;
	148	}
9969b440	149	static inline int mtrr_del(int reg, unsigned long base, unsigned long size)
297a99e1 TG	150	{
	151	return -ENODEV;
	152	}
9969b440	153	static inline int mtrr_del_page(int reg, unsigned long base, unsigned long size)
297a99e1 TG	154	{
	155	return -ENODEV;
	156	}
99fc8d42 JB	157	static inline int mtrr_trim_uncached_memory(unsigned long end_pfn)
	158	{
	159	return 0;
	160	}
9969b440 JP	161	static inline void mtrr_centaur_report_mcr(int mcr, u32 lo, u32 hi)
	162	{
	163	}
297a99e1 TG	164
	165	#define mtrr_ap_init() do {} while (0)
	166	#define mtrr_bp_init() do {} while (0)
d0af9eed SS	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)
297a99e1 TG	170	# endif
	171
	172	#ifdef CONFIG_COMPAT
	173	#include <linux/compat.h>
	174
9969b440	175	struct mtrr_sentry32 {
297a99e1 TG	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
9969b440	181	struct mtrr_gentry32 {
297a99e1 TG	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
9969b440 JP	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)
297a99e1 TG	201	#endif /* CONFIG_COMPAT */
	202
	203	#endif /* __KERNEL__ */
	204
1965aae3	205	#endif /* _ASM_X86_MTRR_H */