Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
sfi.h
Go to the documentation of this file.
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_DEVS "DEVS"
74 #define SFI_SIG_GPIO "GPIO"
75 
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_NAME_LEN 16
81 
82 #define SFI_SYST_SEARCH_BEGIN 0x000E0000
83 #define SFI_SYST_SEARCH_END 0x000FFFFF
84 
85 #define SFI_GET_NUM_ENTRIES(ptable, entry_type) \
86  ((ptable->header.len - sizeof(struct sfi_table_header)) / \
87  (sizeof(entry_type)))
88 /*
89  * Table structures must be byte-packed to match the SFI specification,
90  * as they are provided by the BIOS.
91  */
99 } __packed;
100 
104 } __packed;
105 
106 /* Comply with UEFI spec 2.1 */
113 } __packed;
114 
117 } __packed;
118 
120  u32 hint; /* MWAIT hint */
121  u32 latency; /* latency in ms */
122 } __packed;
123 
125  u64 phys_addr; /* phy base addr for APIC reg */
126 } __packed;
127 
129  u32 freq_mhz; /* in MHZ */
130  u32 latency; /* transition latency in ms */
131  u32 ctrl_val; /* value to write to PERF_CTL */
132 } __packed;
133 
135  u64 phys_addr; /* pointer to where the wake vector locates */
136 } __packed;
137 
139  u64 phys_addr; /* phy base addr for the timer */
140  u32 freq_hz; /* in HZ */
142 } __packed;
143 
145  u64 phys_addr; /* phy base addr for the RTC */
147 } __packed;
148 
150  u8 type; /* bus type, I2C, SPI or ...*/
151 #define SFI_DEV_TYPE_SPI 0
152 #define SFI_DEV_TYPE_I2C 1
153 #define SFI_DEV_TYPE_UART 2
154 #define SFI_DEV_TYPE_HSI 3
155 #define SFI_DEV_TYPE_IPC 4
156 
157  u8 host_num; /* attached to host 0, 1...*/
162 } __packed;
163 
168 } __packed;
169 
171 
172 #ifdef CONFIG_SFI
173 extern void __init sfi_init(void);
174 extern int __init sfi_platform_init(void);
175 extern void __init sfi_init_late(void);
176 extern int sfi_table_parse(char *signature, char *oem_id, char *oem_table_id,
177  sfi_table_handler handler);
178 
179 extern int sfi_disabled;
180 static inline void disable_sfi(void)
181 {
182  sfi_disabled = 1;
183 }
184 
185 #else /* !CONFIG_SFI */
186 
187 static inline void sfi_init(void)
188 {
189 }
190 
191 static inline void sfi_init_late(void)
192 {
193 }
194 
195 #define sfi_disabled 0
196 
197 static inline int sfi_table_parse(char *signature, char *oem_id,
198  char *oem_table_id,
199  sfi_table_handler handler)
200 {
201  return -1;
202 }
203 
204 #endif /* !CONFIG_SFI */
205 
206 #endif /*_LINUX_SFI_H*/