efi.h revision 306404
1/*-
2 * Copyright (c) 2004 Marcel Moolenaar
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 *
26 * $FreeBSD: stable/11/sys/sys/efi.h 306404 2016-09-28 09:48:39Z kib $
27 */
28
29#ifndef _SYS_EFI_H_
30#define _SYS_EFI_H_
31
32#include <sys/uuid.h>
33#include <machine/efi.h>
34
35#define	EFI_PAGE_SHIFT		12
36#define	EFI_PAGE_SIZE		(1 << EFI_PAGE_SHIFT)
37#define	EFI_PAGE_MASK		(EFI_PAGE_SIZE - 1)
38
39#define	EFI_TABLE_ACPI20			\
40	{0x8868e871,0xe4f1,0x11d3,0xbc,0x22,{0x00,0x80,0xc7,0x3c,0x88,0x81}}
41#define	EFI_TABLE_SAL				\
42	{0xeb9d2d32,0x2d88,0x11d3,0x9a,0x16,{0x00,0x90,0x27,0x3f,0xc1,0x4d}}
43
44enum efi_reset {
45	EFI_RESET_COLD,
46	EFI_RESET_WARM
47};
48
49typedef uint16_t	efi_char;
50typedef unsigned long efi_status;
51
52struct efi_cfgtbl {
53	struct uuid	ct_uuid;
54	uint64_t	ct_data;
55};
56
57struct efi_md {
58	uint32_t	md_type;
59#define	EFI_MD_TYPE_NULL	0
60#define	EFI_MD_TYPE_CODE	1	/* Loader text. */
61#define	EFI_MD_TYPE_DATA	2	/* Loader data. */
62#define	EFI_MD_TYPE_BS_CODE	3	/* Boot services text. */
63#define	EFI_MD_TYPE_BS_DATA	4	/* Boot services data. */
64#define	EFI_MD_TYPE_RT_CODE	5	/* Runtime services text. */
65#define	EFI_MD_TYPE_RT_DATA	6	/* Runtime services data. */
66#define	EFI_MD_TYPE_FREE	7	/* Unused/free memory. */
67#define	EFI_MD_TYPE_BAD		8	/* Bad memory */
68#define	EFI_MD_TYPE_RECLAIM	9	/* ACPI reclaimable memory. */
69#define	EFI_MD_TYPE_FIRMWARE	10	/* ACPI NV memory */
70#define	EFI_MD_TYPE_IOMEM	11	/* Memory-mapped I/O. */
71#define	EFI_MD_TYPE_IOPORT	12	/* I/O port space. */
72#define	EFI_MD_TYPE_PALCODE	13	/* PAL */
73	uint32_t	__pad;
74	uint64_t	md_phys;
75	void		*md_virt;
76	uint64_t	md_pages;
77	uint64_t	md_attr;
78#define	EFI_MD_ATTR_UC		0x0000000000000001UL
79#define	EFI_MD_ATTR_WC		0x0000000000000002UL
80#define	EFI_MD_ATTR_WT		0x0000000000000004UL
81#define	EFI_MD_ATTR_WB		0x0000000000000008UL
82#define	EFI_MD_ATTR_UCE		0x0000000000000010UL
83#define	EFI_MD_ATTR_WP		0x0000000000001000UL
84#define	EFI_MD_ATTR_RP		0x0000000000002000UL
85#define	EFI_MD_ATTR_XP		0x0000000000004000UL
86#define	EFI_MD_ATTR_RT		0x8000000000000000UL
87};
88
89#define efi_next_descriptor(ptr, size) \
90    ((struct efi_md *)(((uint8_t *)(ptr)) + (size)))
91
92struct efi_tm {
93	uint16_t	tm_year;		/* 1998 - 20XX */
94	uint8_t		tm_mon;			/* 1 - 12 */
95	uint8_t		tm_mday;		/* 1 - 31 */
96	uint8_t		tm_hour;		/* 0 - 23 */
97	uint8_t		tm_min;			/* 0 - 59 */
98	uint8_t		tm_sec;			/* 0 - 59 */
99	uint8_t		__pad1;
100	uint32_t	tm_nsec;		/* 0 - 999,999,999 */
101	int16_t		tm_tz;			/* -1440 to 1440 or 2047 */
102	uint8_t		tm_dst;
103	uint8_t		__pad2;
104};
105
106struct efi_tmcap {
107	uint32_t	tc_res;		/* 1e-6 parts per million */
108	uint32_t	tc_prec;	/* hertz */
109	uint8_t		tc_stz;		/* Set clears sub-second time */
110};
111
112struct efi_tblhdr {
113	uint64_t	th_sig;
114	uint32_t	th_rev;
115	uint32_t	th_hdrsz;
116	uint32_t	th_crc32;
117	uint32_t	__res;
118};
119
120struct efi_rt {
121	struct efi_tblhdr rt_hdr;
122	efi_status	(*rt_gettime)(struct efi_tm *, struct efi_tmcap *)
123	    EFIABI_ATTR;
124	efi_status	(*rt_settime)(struct efi_tm *) EFIABI_ATTR;
125	efi_status	(*rt_getwaketime)(uint8_t *, uint8_t *,
126	    struct efi_tm *) EFIABI_ATTR;
127	efi_status	(*rt_setwaketime)(uint8_t, struct efi_tm *)
128	    EFIABI_ATTR;
129	efi_status	(*rt_setvirtual)(u_long, u_long, uint32_t,
130	    struct efi_md *) EFIABI_ATTR;
131	efi_status	(*rt_cvtptr)(u_long, void **) EFIABI_ATTR;
132	efi_status	(*rt_getvar)(efi_char *, struct uuid *, uint32_t *,
133	    u_long *, void *) EFIABI_ATTR;
134	efi_status	(*rt_scanvar)(u_long *, efi_char *, struct uuid *)
135	    EFIABI_ATTR;
136	efi_status	(*rt_setvar)(efi_char *, struct uuid *, uint32_t,
137	    u_long, void *) EFIABI_ATTR;
138	efi_status	(*rt_gethicnt)(uint32_t *) EFIABI_ATTR;
139	efi_status	(*rt_reset)(enum efi_reset, efi_status, u_long,
140	    efi_char *) EFIABI_ATTR;
141};
142
143struct efi_systbl {
144	struct efi_tblhdr st_hdr;
145#define	EFI_SYSTBL_SIG	0x5453595320494249UL
146	efi_char	*st_fwvendor;
147	uint32_t	st_fwrev;
148	uint32_t	__pad;
149	void		*st_cin;
150	void		*st_cinif;
151	void		*st_cout;
152	void		*st_coutif;
153	void		*st_cerr;
154	void		*st_cerrif;
155	uint64_t	st_rt;
156	void		*st_bs;
157	u_long		st_entries;
158	uint64_t	st_cfgtbl;
159};
160
161extern vm_paddr_t efi_systbl;
162#endif /* _SYS_EFI_H_ */
163