arch/x86/include/asm/uv/bios.h

   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  */
  32 enum 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  */
  46 enum {
  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 };
  53
  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
  98 /*
  99  * The UV system table describes specific firmware
 100  * capabilities available to the Linux kernel at runtime.
 101  */
 102 struct uv_systab {
 103         char signature[4];      /* must be UV_SYSTAB_SIG */
 104         u32 revision;           /* distinguish different firmware revs */
 105         u64 function;           /* BIOS runtime callback function ptr */
 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 */
 111 };
 112 extern struct uv_systab *uv_systab;
 113 /* (... end of definitions from UV BIOS ...) */
 114
 115 enum {
 116         BIOS_FREQ_BASE_PLATFORM = 0,
 117         BIOS_FREQ_BASE_INTERVAL_TIMER = 1,
 118         BIOS_FREQ_BASE_REALTIME_CLOCK = 2
 119 };
 120
 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
 131 enum uv_memprotect {
 132         UV_MEMPROT_RESTRICT_ACCESS,
 133         UV_MEMPROT_ALLOW_AMO,
 134         UV_MEMPROT_ALLOW_RW
 135 };
 136
 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
 144 extern s64 uv_bios_get_sn_info(int, int *, long *, long *, long *, long *);
 145 extern s64 uv_bios_freq_base(u64, u64 *);
 146 extern int uv_bios_mq_watchlist_alloc(unsigned long, unsigned int,
 147                                         unsigned long *);
 148 extern int uv_bios_mq_watchlist_free(int, int);
 149 extern s64 uv_bios_change_memprotect(u64, u64, enum uv_memprotect);
 150 extern s64 uv_bios_reserved_page_pa(u64, u64 *, u64 *, u64 *);
 151 extern int uv_bios_set_legacy_vga_target(bool decode, int domain, int bus);
 152
 153 #ifdef CONFIG_EFI
 154 extern void uv_bios_init(void);
 155 #else
 156 void uv_bios_init(void) { }
 157 #endif
 158
 159 extern unsigned long sn_rtc_cycles_per_second;
 160 extern int uv_type;
 161 extern long sn_partition_id;
 162 extern long sn_coherency_id;
 163 extern long sn_region_size;
 164 extern long system_serial_number;
 165 #define uv_partition_coherence_id()     (sn_coherency_id)
 166
 167 extern struct kobject *sgi_uv_kobj;     /* /sys/firmware/sgi_uv */
 168
 169 #endif /* _ASM_X86_UV_BIOS_H */