1#ifndef _ASM_X86_UV_BIOS_H
2#define _ASM_X86_UV_BIOS_H
3
4/*
5 * UV BIOS layer definitions.
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
20 *
21 * Copyright (c) 2008-2009 Silicon Graphics, Inc. All Rights Reserved.
22 * Copyright (c) Russ Anderson <rja@sgi.com>
23 */
24
25#include <linux/rtc.h>
26
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 */
32enum uv_bios_cmd {
33 UV_BIOS_COMMON,
34 UV_BIOS_GET_SN_INFO,
35 UV_BIOS_FREQ_BASE,
36 UV_BIOS_WATCHLIST_ALLOC,
37 UV_BIOS_WATCHLIST_FREE,
38 UV_BIOS_MEMPROTECT,
39 UV_BIOS_GET_PARTITION_ADDR,
40 UV_BIOS_SET_LEGACY_VGA_TARGET
41};
42
43/*
44 * Status values returned from a BIOS call.
45 */
46enum {
47 BIOS_STATUS_MORE_PASSES = 1,
48 BIOS_STATUS_SUCCESS = 0,
49 BIOS_STATUS_UNIMPLEMENTED = -ENOSYS,
50 BIOS_STATUS_EINVAL = -EINVAL,
51 BIOS_STATUS_UNAVAIL = -EBUSY,
52 BIOS_STATUS_ABORT = -EINTR,
53};
54
55/* Address map parameters */
56struct uv_gam_parameters {
57 u64 mmr_base;
58 u64 gru_base;
59 u8 mmr_shift; /* Convert PNode to MMR space offset */
60 u8 gru_shift; /* Convert PNode to GRU space offset */
61 u8 gpa_shift; /* Size of offset field in GRU phys addr */
62 u8 unused1;
63};
64
65/* UV_TABLE_GAM_RANGE_ENTRY values */
66#define UV_GAM_RANGE_TYPE_UNUSED 0 /* End of table */
67#define UV_GAM_RANGE_TYPE_RAM 1 /* Normal RAM */
68#define UV_GAM_RANGE_TYPE_NVRAM 2 /* Non-volatile memory */
69#define UV_GAM_RANGE_TYPE_NV_WINDOW 3 /* NVMDIMM block window */
70#define UV_GAM_RANGE_TYPE_NV_MAILBOX 4 /* NVMDIMM mailbox */
71#define UV_GAM_RANGE_TYPE_HOLE 5 /* Unused address range */
72#define UV_GAM_RANGE_TYPE_MAX 6
73
74/* The structure stores PA bits 56:26, for 64MB granularity */
75#define UV_GAM_RANGE_SHFT 26 /* 64MB */
76
77struct uv_gam_range_entry {
78 char type; /* Entry type: GAM_RANGE_TYPE_UNUSED, etc. */
79 char unused1;
80 u16 nasid; /* HNasid */
81 u16 sockid; /* Socket ID, high bits of APIC ID */
82 u16 pnode; /* Index to MMR and GRU spaces */
83 u32 unused2;
84 u32 limit; /* PA bits 56:26 (UV_GAM_RANGE_SHFT) */
85};
86
87#define UV_SYSTAB_SIG "UVST"
88#define UV_SYSTAB_VERSION_1 1 /* UV1/2/3 BIOS version */
89#define UV_SYSTAB_VERSION_UV4 0x400 /* UV4 BIOS base version */
90#define UV_SYSTAB_VERSION_UV4_1 0x401 /* + gpa_shift */
91#define UV_SYSTAB_VERSION_UV4_2 0x402 /* + TYPE_NVRAM/WINDOW/MBOX */
92#define UV_SYSTAB_VERSION_UV4_3 0x403 /* - GAM Range PXM Value */
93#define UV_SYSTAB_VERSION_UV4_LATEST UV_SYSTAB_VERSION_UV4_3
94
95#define UV_SYSTAB_TYPE_UNUSED 0 /* End of table (offset == 0) */
96#define UV_SYSTAB_TYPE_GAM_PARAMS 1 /* GAM PARAM conversions */
97#define UV_SYSTAB_TYPE_GAM_RNG_TBL 2 /* GAM entry table */
98#define UV_SYSTAB_TYPE_MAX 3
99
100/*
101 * The UV system table describes specific firmware
102 * capabilities available to the Linux kernel at runtime.
103 */
104struct uv_systab {
105 char signature[4]; /* must be UV_SYSTAB_SIG */
106 u32 revision; /* distinguish different firmware revs */
107 u64 function; /* BIOS runtime callback function ptr */
108 u32 size; /* systab size (starting with _VERSION_UV4) */
109 struct {
110 u32 type:8; /* type of entry */
111 u32 offset:24; /* byte offset from struct start to entry */
112 } entry[1]; /* additional entries follow */
113};
114extern struct uv_systab *uv_systab;
115/* (... end of definitions from UV BIOS ...) */
116
117enum {
118 BIOS_FREQ_BASE_PLATFORM = 0,
119 BIOS_FREQ_BASE_INTERVAL_TIMER = 1,
120 BIOS_FREQ_BASE_REALTIME_CLOCK = 2
121};
122
123union partition_info_u {
124 u64 val;
125 struct {
126 u64 hub_version : 8,
127 partition_id : 16,
128 coherence_id : 16,
129 region_size : 24;
130 };
131};
132
133enum uv_memprotect {
134 UV_MEMPROT_RESTRICT_ACCESS,
135 UV_MEMPROT_ALLOW_AMO,
136 UV_MEMPROT_ALLOW_RW
137};
138
139/*
140 * bios calls have 6 parameters
141 */
142extern s64 uv_bios_call(enum uv_bios_cmd, u64, u64, u64, u64, u64);
143extern s64 uv_bios_call_irqsave(enum uv_bios_cmd, u64, u64, u64, u64, u64);
144
145extern s64 uv_bios_get_sn_info(int, int *, long *, long *, long *, long *);
146extern s64 uv_bios_freq_base(u64, u64 *);
147extern int uv_bios_mq_watchlist_alloc(unsigned long, unsigned int,
148 unsigned long *);
149extern int uv_bios_mq_watchlist_free(int, int);
150extern s64 uv_bios_change_memprotect(u64, u64, enum uv_memprotect);
151extern s64 uv_bios_reserved_page_pa(u64, u64 *, u64 *, u64 *);
152extern int uv_bios_set_legacy_vga_target(bool decode, int domain, int bus);
153
154extern void uv_bios_init(void);
155
156extern unsigned long sn_rtc_cycles_per_second;
157extern int uv_type;
158extern long sn_partition_id;
159extern long sn_coherency_id;
160extern long sn_region_size;
161extern long system_serial_number;
162#define uv_partition_coherence_id() (sn_coherency_id)
163
164extern struct kobject *sgi_uv_kobj; /* /sys/firmware/sgi_uv */
165
166/*
167 * EFI runtime lock; cf. firmware/efi/runtime-wrappers.c for details
168 */
169extern struct semaphore __efi_uv_runtime_lock;
170
171#endif /* _ASM_X86_UV_BIOS_H */
172