[mirror_ubuntu-focal-kernel.git] / arch / x86 / kernel / cpu / mtrr / mtrr.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * local MTRR defines.
 */

#include <linux/types.h>
#include <linux/stddef.h>

#define MTRR_CHANGE_MASK_FIXED     0x01
#define MTRR_CHANGE_MASK_VARIABLE  0x02
#define MTRR_CHANGE_MASK_DEFTYPE   0x04

extern unsigned int mtrr_usage_table[MTRR_MAX_VAR_RANGES];

struct mtrr_ops {
	u32	vendor;
	u32	use_intel_if;
	void	(*set)(unsigned int reg, unsigned long base,
		       unsigned long size, mtrr_type type);
	void	(*set_all)(void);

	void	(*get)(unsigned int reg, unsigned long *base,
		       unsigned long *size, mtrr_type *type);
	int	(*get_free_region)(unsigned long base, unsigned long size,
				   int replace_reg);
	int	(*validate_add_page)(unsigned long base, unsigned long size,
				     unsigned int type);
	int	(*have_wrcomb)(void);
};

extern int generic_get_free_region(unsigned long base, unsigned long size,
				   int replace_reg);
extern int generic_validate_add_page(unsigned long base, unsigned long size,
				     unsigned int type);

extern const struct mtrr_ops generic_mtrr_ops;

extern int positive_have_wrcomb(void);

/* library functions for processor-specific routines */
struct set_mtrr_context {
	unsigned long	flags;
	unsigned long	cr4val;
	u32		deftype_lo;
	u32		deftype_hi;
	u32		ccr3;
};

void set_mtrr_done(struct set_mtrr_context *ctxt);
void set_mtrr_cache_disable(struct set_mtrr_context *ctxt);
void set_mtrr_prepare_save(struct set_mtrr_context *ctxt);

void fill_mtrr_var_range(unsigned int index,
		u32 base_lo, u32 base_hi, u32 mask_lo, u32 mask_hi);
bool get_mtrr_state(void);
void mtrr_bp_pat_init(void);

extern void __init set_mtrr_ops(const struct mtrr_ops *ops);

extern u64 size_or_mask, size_and_mask;
extern const struct mtrr_ops *mtrr_if;

#define is_cpu(vnd)	(mtrr_if && mtrr_if->vendor == X86_VENDOR_##vnd)
#define use_intel()	(mtrr_if && mtrr_if->use_intel_if == 1)

extern unsigned int num_var_ranges;
extern u64 mtrr_tom2;
extern struct mtrr_state_type mtrr_state;

void mtrr_state_warn(void);
const char *mtrr_attrib_to_str(int x);
void mtrr_wrmsr(unsigned, unsigned, unsigned);

/* CPU specific mtrr init functions */
int amd_init_mtrr(void);
int cyrix_init_mtrr(void);
int centaur_init_mtrr(void);

extern int changed_by_mtrr_cleanup;
extern int mtrr_cleanup(unsigned address_bits);
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4	2	/*
3ec8dbcb	3	* local MTRR defines.
1da177e4 LT	4	*/
1da177e4 LT	5
2d2ee8de PJ	6	#include <linux/types.h>
2d2ee8de PJ	7	#include <linux/stddef.h>
1da177e4	8
1da177e4 LT	9	#define MTRR_CHANGE_MASK_FIXED 0x01
	10	#define MTRR_CHANGE_MASK_VARIABLE 0x02
	11	#define MTRR_CHANGE_MASK_DEFTYPE 0x04
	12
b558bc0a	13	extern unsigned int mtrr_usage_table[MTRR_MAX_VAR_RANGES];
99fc8d42	14
1da177e4 LT	15	struct mtrr_ops {
	16	u32 vendor;
	17	u32 use_intel_if;
1da177e4 LT	18	void (*set)(unsigned int reg, unsigned long base,
	19	unsigned long size, mtrr_type type);
	20	void (*set_all)(void);
	21
	22	void (get)(unsigned int reg, unsigned long base,
3ec8dbcb	23	unsigned long size, mtrr_type type);
365bff80 JB	24	int (*get_free_region)(unsigned long base, unsigned long size,
365bff80 JB	25	int replace_reg);
1da177e4 LT	26	int (*validate_add_page)(unsigned long base, unsigned long size,
	27	unsigned int type);
	28	int (*have_wrcomb)(void);
	29	};
	30
365bff80 JB	31	extern int generic_get_free_region(unsigned long base, unsigned long size,
365bff80 JB	32	int replace_reg);
1da177e4 LT	33	extern int generic_validate_add_page(unsigned long base, unsigned long size,
	34	unsigned int type);
	35
3b9cfc0a	36	extern const struct mtrr_ops generic_mtrr_ops;
1da177e4 LT	37
	38	extern int positive_have_wrcomb(void);
	39
	40	/* library functions for processor-specific routines */
	41	struct set_mtrr_context {
3ec8dbcb JSR	42	unsigned long flags;
	43	unsigned long cr4val;
	44	u32 deftype_lo;
	45	u32 deftype_hi;
	46	u32 ccr3;
1da177e4 LT	47	};
1da177e4 LT	48
1da177e4 LT	49	void set_mtrr_done(struct set_mtrr_context *ctxt);
	50	void set_mtrr_cache_disable(struct set_mtrr_context *ctxt);
	51	void set_mtrr_prepare_save(struct set_mtrr_context *ctxt);
	52
95ffa243 YL	53	void fill_mtrr_var_range(unsigned int index,
95ffa243 YL	54	u32 base_lo, u32 base_hi, u32 mask_lo, u32 mask_hi);
f9626104	55	bool get_mtrr_state(void);
ad025a73	56	void mtrr_bp_pat_init(void);
1da177e4	57
404f6aac	58	extern void __init set_mtrr_ops(const struct mtrr_ops *ops);
1da177e4	59
6c5806ca	60	extern u64 size_or_mask, size_and_mask;
3b9cfc0a	61	extern const struct mtrr_ops *mtrr_if;
1da177e4 LT	62
	63	#define is_cpu(vnd) (mtrr_if && mtrr_if->vendor == X86_VENDOR_##vnd)
	64	#define use_intel() (mtrr_if && mtrr_if->use_intel_if == 1)
	65
	66	extern unsigned int num_var_ranges;
95ffa243	67	extern u64 mtrr_tom2;
f0348c43	68	extern struct mtrr_state_type mtrr_state;
1da177e4	69
1da177e4	70	void mtrr_state_warn(void);
365bff80	71	const char *mtrr_attrib_to_str(int x);
1da177e4 LT	72	void mtrr_wrmsr(unsigned, unsigned, unsigned);
1da177e4 LT	73
16c02ed7 HH	74	/* CPU specific mtrr init functions */
	75	int amd_init_mtrr(void);
	76	int cyrix_init_mtrr(void);
	77	int centaur_init_mtrr(void);
0d890355 YL	78
	79	extern int changed_by_mtrr_cleanup;
	80	extern int mtrr_cleanup(unsigned address_bits);