include/linux/sfi.h

   1 /* sfi.h Simple Firmware Interface */
   2
   3 /*
   4
   5   This file is provided under a dual BSD/GPLv2 license.  When using or
   6   redistributing this file, you may do so under either license.
   7
   8   GPL LICENSE SUMMARY
   9
  10   Copyright(c) 2009 Intel Corporation. All rights reserved.
  11
  12   This program is free software; you can redistribute it and/or modify
  13   it under the terms of version 2 of the GNU General Public License as
  14   published by the Free Software Foundation.
  15
  16   This program is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19   General Public License for more details.
  20
  21   You should have received a copy of the GNU General Public License
  22   along with this program; if not, write to the Free Software
  23   Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
  24   The full GNU General Public License is included in this distribution
  25   in the file called LICENSE.GPL.
  26
  27   BSD LICENSE
  28
  29   Copyright(c) 2009 Intel Corporation. All rights reserved.
  30
  31   Redistribution and use in source and binary forms, with or without
  32   modification, are permitted provided that the following conditions
  33   are met:
  34
  35     * Redistributions of source code must retain the above copyright
  36       notice, this list of conditions and the following disclaimer.
  37     * Redistributions in binary form must reproduce the above copyright
  38       notice, this list of conditions and the following disclaimer in
  39       the documentation and/or other materials provided with the
  40       distribution.
  41     * Neither the name of Intel Corporation nor the names of its
  42       contributors may be used to endorse or promote products derived
  43       from this software without specific prior written permission.
  44
  45   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  46   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  47   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  48   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  49   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  50   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  51   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  52   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  53   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  54   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  55   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  56
  57 */
  58
  59 #ifndef _LINUX_SFI_H
  60 #define _LINUX_SFI_H
  61
  62 /* Table signatures reserved by the SFI specification */
  63 #define SFI_SIG_SYST            "SYST"
  64 #define SFI_SIG_FREQ            "FREQ"
  65 #define SFI_SIG_IDLE            "IDLE"
  66 #define SFI_SIG_CPUS            "CPUS"
  67 #define SFI_SIG_MTMR            "MTMR"
  68 #define SFI_SIG_MRTC            "MRTC"
  69 #define SFI_SIG_MMAP            "MMAP"
  70 #define SFI_SIG_APIC            "APIC"
  71 #define SFI_SIG_XSDT            "XSDT"
  72 #define SFI_SIG_WAKE            "WAKE"
  73 #define SFI_SIG_SPIB            "SPIB"
  74 #define SFI_SIG_I2CB            "I2CB"
  75 #define SFI_SIG_GPEM            "GPEM"
  76 #define SFI_SIG_DEVS            "DEVS"
  77 #define SFI_SIG_GPIO            "GPIO"
  78
  79 #define SFI_SIGNATURE_SIZE      4
  80 #define SFI_OEM_ID_SIZE         6
  81 #define SFI_OEM_TABLE_ID_SIZE   8
  82
  83 #define SFI_SYST_SEARCH_BEGIN           0x000E0000
  84 #define SFI_SYST_SEARCH_END             0x000FFFFF
  85
  86 #define SFI_GET_NUM_ENTRIES(ptable, entry_type) \
  87         ((ptable->header.len - sizeof(struct sfi_table_header)) / \
  88         (sizeof(entry_type)))
  89 /*
  90  * Table structures must be byte-packed to match the SFI specification,
  91  * as they are provided by the BIOS.
  92  */
  93 struct sfi_table_header {
  94         char    sig[SFI_SIGNATURE_SIZE];
  95         u32     len;
  96         u8      rev;
  97         u8      csum;
  98         char    oem_id[SFI_OEM_ID_SIZE];
  99         char    oem_table_id[SFI_OEM_TABLE_ID_SIZE];
 100 } __packed;
 101
 102 struct sfi_table_simple {
 103         struct sfi_table_header         header;
 104         u64                             pentry[1];
 105 } __packed;
 106
 107 /* Comply with UEFI spec 2.1 */
 108 struct sfi_mem_entry {
 109         u32     type;
 110         u64     phys_start;
 111         u64     virt_start;
 112         u64     pages;
 113         u64     attrib;
 114 } __packed;
 115
 116 struct sfi_cpu_table_entry {
 117         u32     apic_id;
 118 } __packed;
 119
 120 struct sfi_cstate_table_entry {
 121         u32     hint;           /* MWAIT hint */
 122         u32     latency;        /* latency in ms */
 123 } __packed;
 124
 125 struct sfi_apic_table_entry {
 126         u64     phys_addr;      /* phy base addr for APIC reg */
 127 } __packed;
 128
 129 struct sfi_freq_table_entry {
 130         u32     freq_mhz;       /* in MHZ */
 131         u32     latency;        /* transition latency in ms */
 132         u32     ctrl_val;       /* value to write to PERF_CTL */
 133 } __packed;
 134
 135 struct sfi_wake_table_entry {
 136         u64     phys_addr;      /* pointer to where the wake vector locates */
 137 } __packed;
 138
 139 struct sfi_timer_table_entry {
 140         u64     phys_addr;      /* phy base addr for the timer */
 141         u32     freq_hz;        /* in HZ */
 142         u32     irq;
 143 } __packed;
 144
 145 struct sfi_rtc_table_entry {
 146         u64     phys_addr;      /* phy base addr for the RTC */
 147         u32     irq;
 148 } __packed;
 149
 150 struct sfi_device_table_entry {
 151         u8      type;           /* bus type, I2C, SPI or ...*/
 152 #define SFI_DEV_TYPE_SPI        0
 153 #define SFI_DEV_TYPE_I2C        1
 154 #define SFI_DEV_TYPE_UART       2
 155 #define SFI_DEV_TYPE_HSI        3
 156 #define SFI_DEV_TYPE_IPC        4
 157
 158         u8      host_num;       /* attached to host 0, 1...*/
 159         u16     addr;
 160         u8      irq;
 161         u32     max_freq;
 162         char    name[16];
 163 } __packed;
 164
 165 struct sfi_gpio_table_entry {
 166         char    controller_name[16];
 167         u16     pin_no;
 168         char    pin_name[16];
 169 } __packed;
 170
 171 struct sfi_spi_table_entry {
 172         u16     host_num;       /* attached to host 0, 1...*/
 173         u16     cs;             /* chip select */
 174         u16     irq_info;
 175         char    name[16];
 176         u8      dev_info[10];
 177 } __packed;
 178
 179 struct sfi_i2c_table_entry {
 180         u16     host_num;
 181         u16     addr;           /* slave addr */
 182         u16     irq_info;
 183         char    name[16];
 184         u8      dev_info[10];
 185 } __packed;
 186
 187 struct sfi_gpe_table_entry {
 188         u16     logical_id;     /* logical id */
 189         u16     phys_id;        /* physical GPE id */
 190 } __packed;
 191
 192 typedef int (*sfi_table_handler) (struct sfi_table_header *table);
 193
 194 #ifdef CONFIG_SFI
 195 extern void __init sfi_init(void);
 196 extern int __init sfi_platform_init(void);
 197 extern void __init sfi_init_late(void);
 198 extern int sfi_table_parse(char *signature, char *oem_id, char *oem_table_id,
 199                                 sfi_table_handler handler);
 200
 201 extern int sfi_disabled;
 202 static inline void disable_sfi(void)
 203 {
 204         sfi_disabled = 1;
 205 }
 206
 207 #else /* !CONFIG_SFI */
 208
 209 static inline void sfi_init(void)
 210 {
 211 }
 212
 213 static inline void sfi_init_late(void)
 214 {
 215 }
 216
 217 #define sfi_disabled    0
 218
 219 static inline int sfi_table_parse(char *signature, char *oem_id,
 220                                         char *oem_table_id,
 221                                         sfi_table_handler handler)
 222 {
 223         return -1;
 224 }
 225
 226 #endif /* !CONFIG_SFI */
 227
 228 #endif /*_LINUX_SFI_H*/