sys/sys/efi.h

   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$
  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_SMBIOS                                \
  40         {0xeb9d2d31,0x2d88,0x11d3,0x9a,0x16,{0x00,0x90,0x27,0x3f,0xc1,0x4d}}
  41 #define EFI_TABLE_SMBIOS3                               \
  42         {0xf2fd1544,0x9794,0x4a2c,0x99,0x2e,{0xe5,0xbb,0xcf,0x20,0xe3,0x94}}
  43 #define EFI_TABLE_ESRT                                  \
  44         {0xb122a263,0x3661,0x4f68,0x99,0x29,{0x78,0xf8,0xb0,0xd6,0x21,0x80}}
  45 #define EFI_PROPERTIES_TABLE                    \
  46         {0x880aaca3,0x4adc,0x4a04,0x90,0x79,{0xb7,0x47,0x34,0x08,0x25,0xe5}}
  47
  48 enum efi_reset {
  49         EFI_RESET_COLD = 0,
  50         EFI_RESET_WARM = 1,
  51         EFI_RESET_SHUTDOWN = 2,
  52 };
  53
  54 typedef uint16_t        efi_char;
  55 typedef unsigned long efi_status;
  56
  57 struct efi_cfgtbl {
  58         struct uuid     ct_uuid;
  59         void            *ct_data;
  60 };
  61
  62 struct efi_md {
  63         uint32_t        md_type;
  64 #define EFI_MD_TYPE_NULL        0
  65 #define EFI_MD_TYPE_CODE        1       /* Loader text. */
  66 #define EFI_MD_TYPE_DATA        2       /* Loader data. */
  67 #define EFI_MD_TYPE_BS_CODE     3       /* Boot services text. */
  68 #define EFI_MD_TYPE_BS_DATA     4       /* Boot services data. */
  69 #define EFI_MD_TYPE_RT_CODE     5       /* Runtime services text. */
  70 #define EFI_MD_TYPE_RT_DATA     6       /* Runtime services data. */
  71 #define EFI_MD_TYPE_FREE        7       /* Unused/free memory. */
  72 #define EFI_MD_TYPE_BAD         8       /* Bad memory */
  73 #define EFI_MD_TYPE_RECLAIM     9       /* ACPI reclaimable memory. */
  74 #define EFI_MD_TYPE_FIRMWARE    10      /* ACPI NV memory */
  75 #define EFI_MD_TYPE_IOMEM       11      /* Memory-mapped I/O. */
  76 #define EFI_MD_TYPE_IOPORT      12      /* I/O port space. */
  77 #define EFI_MD_TYPE_PALCODE     13      /* PAL */
  78 #define EFI_MD_TYPE_PERSISTENT  14      /* Persistent memory. */
  79         uint32_t        __pad;
  80         uint64_t        md_phys;
  81         uint64_t        md_virt;
  82         uint64_t        md_pages;
  83         uint64_t        md_attr;
  84 #define EFI_MD_ATTR_UC          0x0000000000000001UL
  85 #define EFI_MD_ATTR_WC          0x0000000000000002UL
  86 #define EFI_MD_ATTR_WT          0x0000000000000004UL
  87 #define EFI_MD_ATTR_WB          0x0000000000000008UL
  88 #define EFI_MD_ATTR_UCE         0x0000000000000010UL
  89 #define EFI_MD_ATTR_WP          0x0000000000001000UL
  90 #define EFI_MD_ATTR_RP          0x0000000000002000UL
  91 #define EFI_MD_ATTR_XP          0x0000000000004000UL
  92 #define EFI_MD_ATTR_NV          0x0000000000008000UL
  93 #define EFI_MD_ATTR_MORE_RELIABLE \
  94                                 0x0000000000010000UL
  95 #define EFI_MD_ATTR_RO          0x0000000000020000UL
  96 #define EFI_MD_ATTR_RT          0x8000000000000000UL
  97 };
  98
  99 #define efi_next_descriptor(ptr, size) \
 100     ((struct efi_md *)(((uint8_t *)(ptr)) + (size)))
 101
 102 struct efi_tm {
 103         uint16_t        tm_year;                /* 1998 - 20XX */
 104         uint8_t         tm_mon;                 /* 1 - 12 */
 105         uint8_t         tm_mday;                /* 1 - 31 */
 106         uint8_t         tm_hour;                /* 0 - 23 */
 107         uint8_t         tm_min;                 /* 0 - 59 */
 108         uint8_t         tm_sec;                 /* 0 - 59 */
 109         uint8_t         __pad1;
 110         uint32_t        tm_nsec;                /* 0 - 999,999,999 */
 111         int16_t         tm_tz;                  /* -1440 to 1440 or 2047 */
 112         uint8_t         tm_dst;
 113         uint8_t         __pad2;
 114 };
 115
 116 struct efi_tmcap {
 117         uint32_t        tc_res;         /* 1e-6 parts per million */
 118         uint32_t        tc_prec;        /* hertz */
 119         uint8_t         tc_stz;         /* Set clears sub-second time */
 120 };
 121
 122 struct efi_tblhdr {
 123         uint64_t        th_sig;
 124         uint32_t        th_rev;
 125         uint32_t        th_hdrsz;
 126         uint32_t        th_crc32;
 127         uint32_t        __res;
 128 };
 129
 130 #define ESRT_FIRMWARE_RESOURCE_VERSION 1
 131
 132 struct efi_esrt_table {
 133         uint32_t        fw_resource_count;
 134         uint32_t        fw_resource_count_max;
 135         uint64_t        fw_resource_version;
 136         uint8_t         entries[];
 137 };
 138
 139 struct efi_esrt_entry_v1 {
 140         struct uuid     fw_class;
 141         uint32_t        fw_type;
 142         uint32_t        fw_version;
 143         uint32_t        lowest_supported_fw_version;
 144         uint32_t        capsule_flags;
 145         uint32_t        last_attempt_version;
 146         uint32_t        last_attempt_status;
 147 };
 148
 149 struct efi_prop_table {
 150         uint32_t        version;
 151         uint32_t        length;
 152         uint64_t        memory_protection_attribute;
 153 };
 154
 155 #ifdef _KERNEL
 156
 157 #ifdef EFIABI_ATTR
 158 struct efi_rt {
 159         struct efi_tblhdr rt_hdr;
 160         efi_status      (*rt_gettime)(struct efi_tm *, struct efi_tmcap *)
 161             EFIABI_ATTR;
 162         efi_status      (*rt_settime)(struct efi_tm *) EFIABI_ATTR;
 163         efi_status      (*rt_getwaketime)(uint8_t *, uint8_t *,
 164             struct efi_tm *) EFIABI_ATTR;
 165         efi_status      (*rt_setwaketime)(uint8_t, struct efi_tm *)
 166             EFIABI_ATTR;
 167         efi_status      (*rt_setvirtual)(u_long, u_long, uint32_t,
 168             struct efi_md *) EFIABI_ATTR;
 169         efi_status      (*rt_cvtptr)(u_long, void **) EFIABI_ATTR;
 170         efi_status      (*rt_getvar)(efi_char *, struct uuid *, uint32_t *,
 171             u_long *, void *) EFIABI_ATTR;
 172         efi_status      (*rt_scanvar)(u_long *, efi_char *, struct uuid *)
 173             EFIABI_ATTR;
 174         efi_status      (*rt_setvar)(efi_char *, struct uuid *, uint32_t,
 175             u_long, void *) EFIABI_ATTR;
 176         efi_status      (*rt_gethicnt)(uint32_t *) EFIABI_ATTR;
 177         efi_status      (*rt_reset)(enum efi_reset, efi_status, u_long,
 178             efi_char *) EFIABI_ATTR;
 179 };
 180 #endif
 181
 182 struct efi_systbl {
 183         struct efi_tblhdr st_hdr;
 184 #define EFI_SYSTBL_SIG  0x5453595320494249UL
 185         efi_char        *st_fwvendor;
 186         uint32_t        st_fwrev;
 187         uint32_t        __pad;
 188         void            *st_cin;
 189         void            *st_cinif;
 190         void            *st_cout;
 191         void            *st_coutif;
 192         void            *st_cerr;
 193         void            *st_cerrif;
 194         uint64_t        st_rt;
 195         void            *st_bs;
 196         u_long          st_entries;
 197         uint64_t        st_cfgtbl;
 198 };
 199
 200 extern vm_paddr_t efi_systbl_phys;
 201
 202 struct efirt_callinfo;
 203
 204 /* Internal MD EFI functions */
 205 int efi_arch_enter(void);
 206 void efi_arch_leave(void);
 207 vm_offset_t efi_phys_to_kva(vm_paddr_t);
 208 int efi_rt_arch_call(struct efirt_callinfo *);
 209 bool efi_create_1t1_map(struct efi_md *, int, int);
 210 void efi_destroy_1t1_map(void);
 211
 212 struct efi_ops {
 213         /*
 214          * The EFI calls might be virtualized in some environments, requiring
 215          * FreeBSD to use a different interface (ie: hypercalls) in order to
 216          * access them.
 217          */
 218         int     (*rt_ok)(void);
 219         int     (*get_table)(struct uuid *, void **);
 220         int     (*copy_table)(struct uuid *, void **, size_t, size_t *);
 221         int     (*get_time)(struct efi_tm *);
 222         int     (*get_time_capabilities)(struct efi_tmcap *);
 223         int     (*reset_system)(enum efi_reset);
 224         int     (*set_time)(struct efi_tm *);
 225         int     (*var_get)(uint16_t *, struct uuid *, uint32_t *, size_t *,
 226     void *);
 227         int     (*var_nextname)(size_t *, uint16_t *, struct uuid *);
 228         int     (*var_set)(uint16_t *, struct uuid *, uint32_t, size_t, void *);
 229 };
 230 extern const struct efi_ops *active_efi_ops;
 231
 232 /* Public MI EFI functions */
 233 static inline int efi_rt_ok(void)
 234 {
 235
 236         if (active_efi_ops->rt_ok == NULL)
 237                 return (ENXIO);
 238         return (active_efi_ops->rt_ok());
 239 }
 240
 241 static inline int efi_get_table(struct uuid *uuid, void **ptr)
 242 {
 243
 244         if (active_efi_ops->get_table == NULL)
 245                 return (ENXIO);
 246         return (active_efi_ops->get_table(uuid, ptr));
 247 }
 248
 249 static inline int efi_copy_table(struct uuid *uuid, void **buf,
 250     size_t buf_len, size_t *table_len)
 251 {
 252
 253         if (active_efi_ops->copy_table == NULL)
 254                 return (ENXIO);
 255         return (active_efi_ops->copy_table(uuid, buf, buf_len, table_len));
 256 }
 257
 258 static inline int efi_get_time(struct efi_tm *tm)
 259 {
 260
 261         if (active_efi_ops->get_time == NULL)
 262                 return (ENXIO);
 263         return (active_efi_ops->get_time(tm));
 264 }
 265
 266 static inline int efi_get_time_capabilities(struct efi_tmcap *tmcap)
 267 {
 268
 269         if (active_efi_ops->get_time_capabilities == NULL)
 270                 return (ENXIO);
 271         return (active_efi_ops->get_time_capabilities(tmcap));
 272 }
 273
 274 static inline int efi_reset_system(enum efi_reset type)
 275 {
 276
 277         if (active_efi_ops->reset_system == NULL)
 278                 return (ENXIO);
 279         return (active_efi_ops->reset_system(type));
 280 }
 281
 282 static inline int efi_set_time(struct efi_tm *tm)
 283 {
 284
 285         if (active_efi_ops->set_time == NULL)
 286                 return (ENXIO);
 287         return (active_efi_ops->set_time(tm));
 288 }
 289
 290 static inline int efi_var_get(uint16_t *name, struct uuid *vendor,
 291     uint32_t *attrib, size_t *datasize, void *data)
 292 {
 293
 294         if (active_efi_ops->var_get == NULL)
 295                 return (ENXIO);
 296         return (active_efi_ops->var_get(name, vendor, attrib, datasize, data));
 297 }
 298
 299 static inline int efi_var_nextname(size_t *namesize, uint16_t *name,
 300     struct uuid *vendor)
 301 {
 302
 303         if (active_efi_ops->var_nextname == NULL)
 304                 return (ENXIO);
 305         return (active_efi_ops->var_nextname(namesize, name, vendor));
 306 }
 307
 308 static inline int efi_var_set(uint16_t *name, struct uuid *vendor,
 309     uint32_t attrib, size_t datasize, void *data)
 310 {
 311
 312         if (active_efi_ops->var_set == NULL)
 313                 return (ENXIO);
 314         return (active_efi_ops->var_set(name, vendor, attrib, datasize, data));
 315 }
 316
 317 int efi_status_to_errno(efi_status status);
 318
 319 #endif  /* _KERNEL */
 320
 321 #endif /* _SYS_EFI_H_ */