[mirror_ubuntu-hirsute-kernel.git] / arch / x86 / include / asm / uv / bios.h

#ifndef _ASM_X86_UV_BIOS_H
#define _ASM_X86_UV_BIOS_H

/*
 * UV BIOS layer definitions.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 *
 *  Copyright (c) 2008-2009 Silicon Graphics, Inc.  All Rights Reserved.
 *  Copyright (c) Russ Anderson <rja@sgi.com>
 */

#include <linux/rtc.h>

/*
 * Values for the BIOS calls.  It is passed as the first * argument in the
 * BIOS call.  Passing any other value in the first argument will result
 * in a BIOS_STATUS_UNIMPLEMENTED return status.
 */
enum uv_bios_cmd {
	UV_BIOS_COMMON,
	UV_BIOS_GET_SN_INFO,
	UV_BIOS_FREQ_BASE,
	UV_BIOS_WATCHLIST_ALLOC,
	UV_BIOS_WATCHLIST_FREE,
	UV_BIOS_MEMPROTECT,
	UV_BIOS_GET_PARTITION_ADDR,
	UV_BIOS_SET_LEGACY_VGA_TARGET
};

/*
 * Status values returned from a BIOS call.
 */
enum {
	BIOS_STATUS_MORE_PASSES		=  1,
	BIOS_STATUS_SUCCESS		=  0,
	BIOS_STATUS_UNIMPLEMENTED	= -ENOSYS,
	BIOS_STATUS_EINVAL		= -EINVAL,
	BIOS_STATUS_UNAVAIL		= -EBUSY
};

/* Address map parameters */
struct uv_gam_parameters {
	u64	mmr_base;
	u64	gru_base;
	u8	mmr_shift;	/* Convert PNode to MMR space offset */
	u8	gru_shift;	/* Convert PNode to GRU space offset */
	u8	gpa_shift;	/* Size of offset field in GRU phys addr */
	u8	unused1;
};

/* UV_TABLE_GAM_RANGE_ENTRY values */
#define UV_GAM_RANGE_TYPE_UNUSED	0 /* End of table */
#define UV_GAM_RANGE_TYPE_RAM		1 /* Normal RAM */
#define UV_GAM_RANGE_TYPE_NVRAM		2 /* Non-volatile memory */
#define UV_GAM_RANGE_TYPE_NV_WINDOW	3 /* NVMDIMM block window */
#define UV_GAM_RANGE_TYPE_NV_MAILBOX	4 /* NVMDIMM mailbox */
#define UV_GAM_RANGE_TYPE_HOLE		5 /* Unused address range */
#define UV_GAM_RANGE_TYPE_MAX		6

/* The structure stores PA bits 56:26, for 64MB granularity */
#define UV_GAM_RANGE_SHFT		26		/* 64MB */

struct uv_gam_range_entry {
	char	type;		/* Entry type: GAM_RANGE_TYPE_UNUSED, etc. */
	char	unused1;
	u16	nasid;		/* HNasid */
	u16	sockid;		/* Socket ID, high bits of APIC ID */
	u16	pnode;		/* Index to MMR and GRU spaces */
	u32	pxm;		/* ACPI proximity domain number */
	u32	limit;		/* PA bits 56:26 (UV_GAM_RANGE_SHFT) */
};

#define	UV_SYSTAB_SIG			"UVST"
#define	UV_SYSTAB_VERSION_1		1	/* UV1/2/3 BIOS version */
#define	UV_SYSTAB_VERSION_UV4		0x400	/* UV4 BIOS base version */
#define	UV_SYSTAB_VERSION_UV4_1		0x401	/* + gpa_shift */
#define	UV_SYSTAB_VERSION_UV4_2		0x402	/* + TYPE_NVRAM/WINDOW/MBOX */
#define	UV_SYSTAB_VERSION_UV4_LATEST	UV_SYSTAB_VERSION_UV4_2

#define	UV_SYSTAB_TYPE_UNUSED		0	/* End of table (offset == 0) */
#define	UV_SYSTAB_TYPE_GAM_PARAMS	1	/* GAM PARAM conversions */
#define	UV_SYSTAB_TYPE_GAM_RNG_TBL	2	/* GAM entry table */
#define	UV_SYSTAB_TYPE_MAX		3

/*
 * The UV system table describes specific firmware
 * capabilities available to the Linux kernel at runtime.
 */
struct uv_systab {
	char signature[4];	/* must be UV_SYSTAB_SIG */
	u32 revision;		/* distinguish different firmware revs */
	u64 function;		/* BIOS runtime callback function ptr */
	u32 size;		/* systab size (starting with _VERSION_UV4) */
	struct {
		u32 type:8;	/* type of entry */
		u32 offset:24;	/* byte offset from struct start to entry */
	} entry[1];		/* additional entries follow */
};
extern struct uv_systab *uv_systab;
/* (... end of definitions from UV BIOS ...) */

enum {
	BIOS_FREQ_BASE_PLATFORM = 0,
	BIOS_FREQ_BASE_INTERVAL_TIMER = 1,
	BIOS_FREQ_BASE_REALTIME_CLOCK = 2
};

union partition_info_u {
	u64	val;
	struct {
		u64	hub_version	:  8,
			partition_id	: 16,
			coherence_id	: 16,
			region_size	: 24;
	};
};

enum uv_memprotect {
	UV_MEMPROT_RESTRICT_ACCESS,
	UV_MEMPROT_ALLOW_AMO,
	UV_MEMPROT_ALLOW_RW
};

/*
 * bios calls have 6 parameters
 */
extern s64 uv_bios_call(enum uv_bios_cmd, u64, u64, u64, u64, u64);
extern s64 uv_bios_call_irqsave(enum uv_bios_cmd, u64, u64, u64, u64, u64);
extern s64 uv_bios_call_reentrant(enum uv_bios_cmd, u64, u64, u64, u64, u64);

extern s64 uv_bios_get_sn_info(int, int *, long *, long *, long *, long *);
extern s64 uv_bios_freq_base(u64, u64 *);
extern int uv_bios_mq_watchlist_alloc(unsigned long, unsigned int,
					unsigned long *);
extern int uv_bios_mq_watchlist_free(int, int);
extern s64 uv_bios_change_memprotect(u64, u64, enum uv_memprotect);
extern s64 uv_bios_reserved_page_pa(u64, u64 *, u64 *, u64 *);
extern int uv_bios_set_legacy_vga_target(bool decode, int domain, int bus);

#ifdef CONFIG_EFI
extern void uv_bios_init(void);
#else
void uv_bios_init(void) { }
#endif

extern unsigned long sn_rtc_cycles_per_second;
extern int uv_type;
extern long sn_partition_id;
extern long sn_coherency_id;
extern long sn_region_size;
extern long system_serial_number;
#define uv_partition_coherence_id()	(sn_coherency_id)

extern struct kobject *sgi_uv_kobj;	/* /sys/firmware/sgi_uv */

#endif /* _ASM_X86_UV_BIOS_H */
Commit	Line	Data
05e4d316 PA	1	#ifndef _ASM_X86_UV_BIOS_H
05e4d316 PA	2	#define _ASM_X86_UV_BIOS_H
7019cc2d RA	3
7019cc2d RA	4	/*
7f594232	5	* UV BIOS layer definitions.
7019cc2d RA	6	*
	7	* This program is free software; you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License as published by
	9	* the Free Software Foundation; either version 2 of the License, or
	10	* (at your option) any later version.
	11	*
	12	* This program is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	* GNU General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this program; if not, write to the Free Software
	19	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
7f594232	20	*
b76365a1 RA	21	* Copyright (c) 2008-2009 Silicon Graphics, Inc. All Rights Reserved.
b76365a1 RA	22	* Copyright (c) Russ Anderson <rja@sgi.com>
7019cc2d RA	23	*/
	24
	25	#include <linux/rtc.h>
	26
7f594232 RA	27	/*
	28	* Values for the BIOS calls. It is passed as the first * argument in the
	29	* BIOS call. Passing any other value in the first argument will result
	30	* in a BIOS_STATUS_UNIMPLEMENTED return status.
	31	*/
	32	enum uv_bios_cmd {
	33	UV_BIOS_COMMON,
	34	UV_BIOS_GET_SN_INFO,
64ccf2f9 RA	35	UV_BIOS_FREQ_BASE,
64ccf2f9 RA	36	UV_BIOS_WATCHLIST_ALLOC,
e8929c8a	37	UV_BIOS_WATCHLIST_FREE,
23c35700	38	UV_BIOS_MEMPROTECT,
841582ea MT	39	UV_BIOS_GET_PARTITION_ADDR,
841582ea MT	40	UV_BIOS_SET_LEGACY_VGA_TARGET
7f594232	41	};
7019cc2d	42
7f594232 RA	43	/*
	44	* Status values returned from a BIOS call.
	45	*/
7019cc2d	46	enum {
23c35700	47	BIOS_STATUS_MORE_PASSES = 1,
7f594232 RA	48	BIOS_STATUS_SUCCESS = 0,
	49	BIOS_STATUS_UNIMPLEMENTED = -ENOSYS,
	50	BIOS_STATUS_EINVAL = -EINVAL,
	51	BIOS_STATUS_UNAVAIL = -EBUSY
7019cc2d RA	52	};
7019cc2d RA	53
ef93bf80 MT	54	/* Address map parameters */
	55	struct uv_gam_parameters {
	56	u64 mmr_base;
	57	u64 gru_base;
	58	u8 mmr_shift; /* Convert PNode to MMR space offset */
	59	u8 gru_shift; /* Convert PNode to GRU space offset */
	60	u8 gpa_shift; /* Size of offset field in GRU phys addr */
	61	u8 unused1;
	62	};
	63
	64	/* UV_TABLE_GAM_RANGE_ENTRY values */
	65	#define UV_GAM_RANGE_TYPE_UNUSED 0 /* End of table */
	66	#define UV_GAM_RANGE_TYPE_RAM 1 /* Normal RAM */
	67	#define UV_GAM_RANGE_TYPE_NVRAM 2 /* Non-volatile memory */
	68	#define UV_GAM_RANGE_TYPE_NV_WINDOW 3 /* NVMDIMM block window */
	69	#define UV_GAM_RANGE_TYPE_NV_MAILBOX 4 /* NVMDIMM mailbox */
	70	#define UV_GAM_RANGE_TYPE_HOLE 5 /* Unused address range */
	71	#define UV_GAM_RANGE_TYPE_MAX 6
	72
	73	/* The structure stores PA bits 56:26, for 64MB granularity */
	74	#define UV_GAM_RANGE_SHFT 26 /* 64MB */
	75
	76	struct uv_gam_range_entry {
	77	char type; /* Entry type: GAM_RANGE_TYPE_UNUSED, etc. */
	78	char unused1;
	79	u16 nasid; /* HNasid */
	80	u16 sockid; /* Socket ID, high bits of APIC ID */
	81	u16 pnode; /* Index to MMR and GRU spaces */
	82	u32 pxm; /* ACPI proximity domain number */
	83	u32 limit; /* PA bits 56:26 (UV_GAM_RANGE_SHFT) */
	84	};
	85
	86	#define UV_SYSTAB_SIG "UVST"
	87	#define UV_SYSTAB_VERSION_1 1 /* UV1/2/3 BIOS version */
	88	#define UV_SYSTAB_VERSION_UV4 0x400 /* UV4 BIOS base version */
	89	#define UV_SYSTAB_VERSION_UV4_1 0x401 /* + gpa_shift */
	90	#define UV_SYSTAB_VERSION_UV4_2 0x402 /* + TYPE_NVRAM/WINDOW/MBOX */
	91	#define UV_SYSTAB_VERSION_UV4_LATEST UV_SYSTAB_VERSION_UV4_2
	92
	93	#define UV_SYSTAB_TYPE_UNUSED 0 /* End of table (offset == 0) */
	94	#define UV_SYSTAB_TYPE_GAM_PARAMS 1 /* GAM PARAM conversions */
	95	#define UV_SYSTAB_TYPE_GAM_RNG_TBL 2 /* GAM entry table */
	96	#define UV_SYSTAB_TYPE_MAX 3
	97
7f594232 RA	98	/*
	99	* The UV system table describes specific firmware
	100	* capabilities available to the Linux kernel at runtime.
	101	*/
	102	struct uv_systab {
ef93bf80	103	char signature[4]; /* must be UV_SYSTAB_SIG */
7f594232 RA	104	u32 revision; /* distinguish different firmware revs */
7f594232 RA	105	u64 function; /* BIOS runtime callback function ptr */
ef93bf80 MT	106	u32 size; /* systab size (starting with _VERSION_UV4) */
	107	struct {
	108	u32 type:8; /* type of entry */
	109	u32 offset:24; /* byte offset from struct start to entry */
	110	} entry[1]; /* additional entries follow */
7f594232	111	};
ef93bf80 MT	112	extern struct uv_systab *uv_systab;
ef93bf80 MT	113	/* (... end of definitions from UV BIOS ...) */
7019cc2d RA	114
7019cc2d RA	115	enum {
7f594232 RA	116	BIOS_FREQ_BASE_PLATFORM = 0,
	117	BIOS_FREQ_BASE_INTERVAL_TIMER = 1,
	118	BIOS_FREQ_BASE_REALTIME_CLOCK = 2
7019cc2d RA	119	};
7019cc2d RA	120
922402f1 RA	121	union partition_info_u {
	122	u64 val;
	123	struct {
	124	u64 hub_version : 8,
	125	partition_id : 16,
	126	coherence_id : 16,
	127	region_size : 24;
	128	};
	129	};
	130
e8929c8a RA	131	enum uv_memprotect {
	132	UV_MEMPROT_RESTRICT_ACCESS,
	133	UV_MEMPROT_ALLOW_AMO,
	134	UV_MEMPROT_ALLOW_RW
	135	};
	136
7f594232 RA	137	/*
	138	* bios calls have 6 parameters
	139	*/
	140	extern s64 uv_bios_call(enum uv_bios_cmd, u64, u64, u64, u64, u64);
	141	extern s64 uv_bios_call_irqsave(enum uv_bios_cmd, u64, u64, u64, u64, u64);
	142	extern s64 uv_bios_call_reentrant(enum uv_bios_cmd, u64, u64, u64, u64, u64);
	143
b76365a1	144	extern s64 uv_bios_get_sn_info(int, int , long , long , long , long *);
922402f1	145	extern s64 uv_bios_freq_base(u64, u64 *);
c2c9f115	146	extern int uv_bios_mq_watchlist_alloc(unsigned long, unsigned int,
64ccf2f9 RA	147	unsigned long *);
64ccf2f9 RA	148	extern int uv_bios_mq_watchlist_free(int, int);
e8929c8a	149	extern s64 uv_bios_change_memprotect(u64, u64, enum uv_memprotect);
23c35700	150	extern s64 uv_bios_reserved_page_pa(u64, u64 , u64 , u64 *);
841582ea	151	extern int uv_bios_set_legacy_vga_target(bool decode, int domain, int bus);
922402f1	152
ef93bf80	153	#ifdef CONFIG_EFI
7f594232	154	extern void uv_bios_init(void);
ef93bf80 MT	155	#else
	156	void uv_bios_init(void) { }
	157	#endif
7019cc2d	158
64ccf2f9	159	extern unsigned long sn_rtc_cycles_per_second;
922402f1 RA	160	extern int uv_type;
922402f1 RA	161	extern long sn_partition_id;
b0f20989 RA	162	extern long sn_coherency_id;
b0f20989 RA	163	extern long sn_region_size;
b76365a1	164	extern long system_serial_number;
ef93bf80	165	#define uv_partition_coherence_id() (sn_coherency_id)
922402f1	166
fc8c2d76	167	extern struct kobject sgi_uv_kobj; / /sys/firmware/sgi_uv */
7019cc2d	168
05e4d316	169	#endif /* _ASM_X86_UV_BIOS_H */