blob: 7f770c638e99d670840ed99856dce0b07a660f8b [file] [log] [blame]
Feng Tang117a9ac2009-08-14 15:10:24 -04001/* 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"
Feng Tang5487ab42010-05-25 16:40:47 +080073#define SFI_SIG_DEVS "DEVS"
74#define SFI_SIG_GPIO "GPIO"
Feng Tang117a9ac2009-08-14 15:10:24 -040075
76#define SFI_SIGNATURE_SIZE 4
77#define SFI_OEM_ID_SIZE 6
78#define SFI_OEM_TABLE_ID_SIZE 8
79
80#define SFI_SYST_SEARCH_BEGIN 0x000E0000
81#define SFI_SYST_SEARCH_END 0x000FFFFF
82
83#define SFI_GET_NUM_ENTRIES(ptable, entry_type) \
84 ((ptable->header.len - sizeof(struct sfi_table_header)) / \
85 (sizeof(entry_type)))
86/*
87 * Table structures must be byte-packed to match the SFI specification,
88 * as they are provided by the BIOS.
89 */
90struct sfi_table_header {
91 char sig[SFI_SIGNATURE_SIZE];
92 u32 len;
93 u8 rev;
94 u8 csum;
95 char oem_id[SFI_OEM_ID_SIZE];
96 char oem_table_id[SFI_OEM_TABLE_ID_SIZE];
97} __packed;
98
99struct sfi_table_simple {
100 struct sfi_table_header header;
101 u64 pentry[1];
102} __packed;
103
104/* Comply with UEFI spec 2.1 */
105struct sfi_mem_entry {
106 u32 type;
107 u64 phys_start;
108 u64 virt_start;
109 u64 pages;
110 u64 attrib;
111} __packed;
112
113struct sfi_cpu_table_entry {
114 u32 apic_id;
115} __packed;
116
117struct sfi_cstate_table_entry {
118 u32 hint; /* MWAIT hint */
119 u32 latency; /* latency in ms */
120} __packed;
121
122struct sfi_apic_table_entry {
123 u64 phys_addr; /* phy base addr for APIC reg */
124} __packed;
125
126struct sfi_freq_table_entry {
127 u32 freq_mhz; /* in MHZ */
128 u32 latency; /* transition latency in ms */
129 u32 ctrl_val; /* value to write to PERF_CTL */
130} __packed;
131
132struct sfi_wake_table_entry {
133 u64 phys_addr; /* pointer to where the wake vector locates */
134} __packed;
135
136struct sfi_timer_table_entry {
137 u64 phys_addr; /* phy base addr for the timer */
138 u32 freq_hz; /* in HZ */
139 u32 irq;
140} __packed;
141
142struct sfi_rtc_table_entry {
143 u64 phys_addr; /* phy base addr for the RTC */
144 u32 irq;
145} __packed;
146
Feng Tang5487ab42010-05-25 16:40:47 +0800147struct sfi_device_table_entry {
148 u8 type; /* bus type, I2C, SPI or ...*/
149#define SFI_DEV_TYPE_SPI 0
150#define SFI_DEV_TYPE_I2C 1
151#define SFI_DEV_TYPE_UART 2
152#define SFI_DEV_TYPE_HSI 3
153#define SFI_DEV_TYPE_IPC 4
154
155 u8 host_num; /* attached to host 0, 1...*/
156 u16 addr;
157 u8 irq;
158 u32 max_freq;
159 char name[16];
160} __packed;
161
162struct sfi_gpio_table_entry {
163 char controller_name[16];
164 u16 pin_no;
165 char pin_name[16];
166} __packed;
167
Feng Tang117a9ac2009-08-14 15:10:24 -0400168typedef int (*sfi_table_handler) (struct sfi_table_header *table);
169
170#ifdef CONFIG_SFI
171extern void __init sfi_init(void);
172extern int __init sfi_platform_init(void);
173extern void __init sfi_init_late(void);
174extern int sfi_table_parse(char *signature, char *oem_id, char *oem_table_id,
175 sfi_table_handler handler);
176
177extern int sfi_disabled;
178static inline void disable_sfi(void)
179{
180 sfi_disabled = 1;
181}
182
183#else /* !CONFIG_SFI */
184
185static inline void sfi_init(void)
186{
187}
188
189static inline void sfi_init_late(void)
190{
191}
192
193#define sfi_disabled 0
194
195static inline int sfi_table_parse(char *signature, char *oem_id,
196 char *oem_table_id,
197 sfi_table_handler handler)
198{
199 return -1;
200}
201
202#endif /* !CONFIG_SFI */
203
204#endif /*_LINUX_SFI_H*/