/*      $NetBSD: efi.h,v 1.3 2023/05/22 16:27:49 riastradh Exp $        */

/*-
 * Copyright (c) 2004 Marcel Moolenaar
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _DEV_EFI_EFI_H_
#define _DEV_EFI_EFI_H_

/*
 * Machine-independent UEFI protocol definitions.  Based on:
 *
 *      Unified Extensible Firmware Interface (UEFI) Specification,
 *      Version 2.9, UEFI Forum, Inc., March 2021.
 *
 * https://uefi.org/sites/default/files/resources/UEFI_Spec_2_9_2021_03_18.pdf
 */

#if defined(__i386__) || defined(__x86_64__)
#define EFIAPI  __attribute__((__ms_abi__))
#else
#define EFIAPI  /* empty */
#endif

#ifdef _LP64
#define EFIERR(x)               (0x8000000000000000 | (x))
#else
#define EFIERR(x)               (0x80000000 | (x))
#endif

#define EFI_SUCCESS             0
#define EFI_INVALID_PARAMETER   EFIERR(2)
#define EFI_UNSUPPORTED         EFIERR(3)
#define EFI_BUFFER_TOO_SMALL    EFIERR(5)
#define EFI_DEVICE_ERROR        EFIERR(7)
#define EFI_WRITE_PROTECTED     EFIERR(8)
#define EFI_OUT_OF_RESOURCES    EFIERR(9)
#define EFI_NOT_FOUND           EFIERR(14)
#define EFI_SECURITY_VIOLATION  EFIERR(26)

enum efi_reset {
        EFI_RESET_COLD,
        EFI_RESET_WARM,
        EFI_RESET_SHUTDOWN,
        EFI_RESET_PLATFORM_SPECIFIC,
};

typedef uint16_t        efi_char;
typedef unsigned long efi_status;

struct efi_cfgtbl {
        struct uuid     ct_uuid;
        void            *ct_data;
};

struct efi_md {
        uint32_t        md_type;
#define EFI_MD_TYPE_NULL        0
#define EFI_MD_TYPE_CODE        1       /* Loader text. */
#define EFI_MD_TYPE_DATA        2       /* Loader data. */
#define EFI_MD_TYPE_BS_CODE     3       /* Boot services text. */
#define EFI_MD_TYPE_BS_DATA     4       /* Boot services data. */
#define EFI_MD_TYPE_RT_CODE     5       /* Runtime services text. */
#define EFI_MD_TYPE_RT_DATA     6       /* Runtime services data. */
#define EFI_MD_TYPE_FREE        7       /* Unused/free memory. */
#define EFI_MD_TYPE_BAD         8       /* Bad memory */
#define EFI_MD_TYPE_RECLAIM     9       /* ACPI reclaimable memory. */
#define EFI_MD_TYPE_FIRMWARE    10      /* ACPI NV memory */
#define EFI_MD_TYPE_IOMEM       11      /* Memory-mapped I/O. */
#define EFI_MD_TYPE_IOPORT      12      /* I/O port space. */
#define EFI_MD_TYPE_PALCODE     13      /* PAL */
#define EFI_MD_TYPE_PMEM        14      /* Persistent memory. */
        uint32_t        __pad;
        uint64_t        md_phys;
        uint64_t        md_virt;
        uint64_t        md_pages;
        uint64_t        md_attr;
#define EFI_MD_ATTR_UC          0x0000000000000001UL
#define EFI_MD_ATTR_WC          0x0000000000000002UL
#define EFI_MD_ATTR_WT          0x0000000000000004UL
#define EFI_MD_ATTR_WB          0x0000000000000008UL
#define EFI_MD_ATTR_UCE         0x0000000000000010UL
#define EFI_MD_ATTR_WP          0x0000000000001000UL
#define EFI_MD_ATTR_RP          0x0000000000002000UL
#define EFI_MD_ATTR_XP          0x0000000000004000UL
#define EFI_MD_ATTR_NV          0x0000000000008000UL
#define EFI_MD_ATTR_MORE_RELIABLE 0x0000000000010000UL
#define EFI_MD_ATTR_RO          0x0000000000020000UL
#define EFI_MD_ATTR_SP          0x0000000000040000UL
#define EFI_MD_ATTR_CPU_CRYPTO  0x0000000000080000UL
#define EFI_MD_ATTR_RT          0x8000000000000000UL
};

struct efi_tm {
        uint16_t        tm_year;                /* 1998 - 20XX */
        uint8_t         tm_mon;                 /* 1 - 12 */
        uint8_t         tm_mday;                /* 1 - 31 */
        uint8_t         tm_hour;                /* 0 - 23 */
        uint8_t         tm_min;                 /* 0 - 59 */
        uint8_t         tm_sec;                 /* 0 - 59 */
        uint8_t         __pad1;
        uint32_t        tm_nsec;                /* 0 - 999,999,999 */
        int16_t         tm_tz;                  /* -1440 to 1440 or 2047 */
        uint8_t         tm_dst;
        uint8_t         __pad2;
};

struct efi_tmcap {
        uint32_t        tc_res;         /* 1e-6 parts per million */
        uint32_t        tc_prec;        /* hertz */
        uint8_t         tc_stz;         /* Set clears sub-second time */
};

struct efi_tblhdr {
        uint64_t        th_sig;
        uint32_t        th_rev;
        uint32_t        th_hdrsz;
        uint32_t        th_crc32;
        uint32_t        __res;
};

struct efi_rt {
        struct efi_tblhdr rt_hdr;
        efi_status      (*rt_gettime)(struct efi_tm *, struct efi_tmcap *)
                            EFIAPI;
        efi_status      (*rt_settime)(struct efi_tm *) EFIAPI;
        efi_status      (*rt_getwaketime)(uint8_t *, uint8_t *,
                            struct efi_tm *) EFIAPI;
        efi_status      (*rt_setwaketime)(uint8_t, struct efi_tm *) EFIAPI;
        efi_status      (*rt_setvirtual)(u_long, u_long, uint32_t,
                            struct efi_md *) EFIAPI;
        efi_status      (*rt_cvtptr)(u_long, void **) EFIAPI;
        efi_status      (*rt_getvar)(efi_char *, struct uuid *, uint32_t *,
                            u_long *, void *) EFIAPI;
        efi_status      (*rt_scanvar)(u_long *, efi_char *, struct uuid *)
                            EFIAPI;
        efi_status      (*rt_setvar)(efi_char *, struct uuid *, uint32_t,
                            u_long, void *) EFIAPI;
        efi_status      (*rt_gethicnt)(uint32_t *) EFIAPI;
        efi_status      (*rt_reset)(enum efi_reset, efi_status, u_long,
                            efi_char *) EFIAPI;
};

struct efi_systbl {
        struct efi_tblhdr st_hdr;
#define EFI_SYSTBL_SIG  0x5453595320494249UL
        efi_char        *st_fwvendor;
        uint32_t        st_fwrev;
#ifdef _LP64
        uint32_t        __pad;
#endif
        void            *st_cin;
        void            *st_cinif;
        void            *st_cout;
        void            *st_coutif;
        void            *st_cerr;
        void            *st_cerrif;
        struct efi_rt   *st_rt;
        void            *st_bs;
        u_long          st_entries;
        struct efi_cfgtbl *st_cfgtbl;
};
#ifdef _LP64
__CTASSERT(sizeof(struct efi_systbl) == 120);
#else
__CTASSERT(sizeof(struct efi_systbl) == 72);
#endif

#endif  /* _DEV_EFI_EFI_H_ */