1/*-
2 * Copyright (c) 2016 Netflix, Inc.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 *    notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 *    notice, this list of conditions and the following disclaimer in the
11 *    documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23 * SUCH DAMAGE.
24 *
25 * $FreeBSD$
26 */
27
28#ifndef	_EFIVAR_H_
29#define	_EFIVAR_H_
30
31#include <uuid.h>
32#include <sys/efi.h>
33#include <sys/endian.h>
34#include <stdint.h>
35
36/* Shoud these be elsewhere ? */
37#define	EFI_VARIABLE_NON_VOLATILE		0x00000001
38#define	EFI_VARIABLE_BOOTSERVICE_ACCESS		0x00000002
39#define	EFI_VARIABLE_RUNTIME_ACCESS		0x00000004
40#define	EFI_VARIABLE_HARDWARE_ERROR_RECORD	0x00000008
41#define	EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS	0x00000010
42#define	EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS \
43						0x00000020
44#define	EFI_VARIABLE_APPEND_WRITE		0x00000040
45#if 0 /* todo */
46#define	EFI_VARIABLE_HAS_AUTH_HEADER
47#define EFI_VARIABLE_HAS_SIGNATURE
48#endif
49
50
51#ifndef _EFIVAR_EFI_GUID_T_DEF
52#define _EFIVAR_EFI_GUID_T_DEF
53typedef uuid_t efi_guid_t;
54#endif
55
56#if BYTE_ORDER == LITTLE_ENDIAN
57#define	EFI_GUID(a, b, c, d, e0, e1, e2, e3, e4, e5)			\
58	((efi_guid_t) {(a), (b), (c), (d) >> 8, (d) & 0xff,		\
59	{ (e0), (e1), (e2), (e3), (e4), (e5) }})
60#else
61#define	EFI_GUID(a, b, c, d, e0, e1, e2, e3, e4, e5)			\
62	((efi_guid_t) {(a), (b), (c), (d) & 0xff, (d) >> 8,		\
63	{ (e0), (e1), (e2), (e3), (e4), (e5) }})
64#endif
65
66#define EFI_GLOBAL_GUID EFI_GUID(0x8be4df61, 0x93ca, 0x11d2, 0xaa0d, \
67    0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c)
68
69int efi_append_variable(efi_guid_t guid, const char *name,
70    uint8_t *data, size_t data_size, uint32_t attributes);
71int efi_del_variable(efi_guid_t guid, const char *name);
72int efi_get_variable(efi_guid_t guid, const char *name,
73    uint8_t **data, size_t *data_size, uint32_t *attributes);
74int efi_get_variable_attributes(efi_guid_t guid, const char *name,
75    uint32_t *attributes);
76int efi_get_variable_size(efi_guid_t guid, const char *name, size_t *size);
77int efi_get_next_variable_name(efi_guid_t **guid, char **name);
78int efi_guid_cmp(const efi_guid_t *guid1, const efi_guid_t *guid2);
79int efi_guid_is_zero(const efi_guid_t *guid1);
80int efi_guid_to_name(efi_guid_t *guid, char **name);
81int efi_guid_to_symbol(efi_guid_t *guid, char **symbol);
82int efi_guid_to_str(const efi_guid_t *guid, char **sp);
83int efi_name_to_guid(const char *name, efi_guid_t *guid);
84int efi_set_variable(efi_guid_t guid, const char *name,
85    uint8_t *data, size_t data_size, uint32_t attributes);
86int efi_str_to_guid(const char *s, efi_guid_t *guid);
87int efi_variables_supported(void);
88
89/* FreeBSD extensions */
90struct uuid_table
91{
92	const char *uuid_str;
93	const char *name;
94	efi_guid_t guid;
95};
96
97int efi_known_guid(struct uuid_table **);
98
99extern const efi_guid_t efi_guid_empty;
100
101#endif /* _EFIVAR_H_ */
102