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