xref: /freebsd/stand/efi/include/efilib.h (revision e6bfd18d21b225af6a0ed67ceeaf1293b7b9eba5)
1 /*-
2  * Copyright (c) 2000 Doug Rabson
3  * Copyright (c) 2006 Marcel Moolenaar
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
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 AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  *
27  * $FreeBSD$
28  */
29 
30 #ifndef _LOADER_EFILIB_H
31 #define	_LOADER_EFILIB_H
32 
33 #include <stand.h>
34 #include <stdbool.h>
35 #include <sys/queue.h>
36 
37 extern EFI_HANDLE		IH;
38 extern EFI_SYSTEM_TABLE		*ST;
39 extern EFI_BOOT_SERVICES	*BS;
40 extern EFI_RUNTIME_SERVICES	*RS;
41 
42 extern struct devsw efipart_fddev;
43 extern struct devsw efipart_cddev;
44 extern struct devsw efipart_hddev;
45 extern struct devsw efihttp_dev;
46 extern struct devsw efinet_dev;
47 extern struct netif_driver efinetif;
48 
49 /* EFI block device data, included here to help efi_zfs_probe() */
50 typedef STAILQ_HEAD(pdinfo_list, pdinfo) pdinfo_list_t;
51 
52 typedef struct pdinfo
53 {
54 	STAILQ_ENTRY(pdinfo)	pd_link;	/* link in device list */
55 	pdinfo_list_t		pd_part;	/* list of partitions */
56 	EFI_HANDLE		pd_handle;
57 	EFI_HANDLE		pd_alias;
58 	EFI_DEVICE_PATH		*pd_devpath;
59 	EFI_BLOCK_IO		*pd_blkio;
60 	uint32_t		pd_unit;	/* unit number */
61 	uint32_t		pd_open;	/* reference counter */
62 	void			*pd_bcache;	/* buffer cache data */
63 	struct pdinfo		*pd_parent;	/* Linked items (eg partitions) */
64 	struct devsw		*pd_devsw;	/* Back pointer to devsw */
65 } pdinfo_t;
66 
67 pdinfo_list_t *efiblk_get_pdinfo_list(struct devsw *dev);
68 pdinfo_t *efiblk_get_pdinfo(struct devdesc *dev);
69 pdinfo_t *efiblk_get_pdinfo_by_handle(EFI_HANDLE h);
70 pdinfo_t *efiblk_get_pdinfo_by_device_path(EFI_DEVICE_PATH *path);
71 
72 /* libefi.c */
73 void *efi_get_table(EFI_GUID *tbl);
74 EFI_STATUS OpenProtocolByHandle(EFI_HANDLE, EFI_GUID *, void **);
75 
76 static inline EFI_STATUS
77 efi_exit_boot_services(UINTN key)
78 {
79 	EFI_STATUS status;
80 
81 	status = BS->ExitBootServices(IH, key);
82 	if (!EFI_ERROR(status))
83 		boot_services_active = false;
84 	return (status);
85 }
86 
87 int efi_getdev(void **vdev, const char *devspec, const char **path);
88 
89 int efi_register_handles(struct devsw *, EFI_HANDLE *, EFI_HANDLE *, int);
90 EFI_HANDLE efi_find_handle(struct devsw *, int);
91 int efi_handle_lookup(EFI_HANDLE, struct devsw **, int *,  uint64_t *);
92 int efi_handle_update_dev(EFI_HANDLE, struct devsw *, int, uint64_t);
93 
94 EFI_DEVICE_PATH *efi_lookup_image_devpath(EFI_HANDLE);
95 EFI_DEVICE_PATH *efi_lookup_devpath(EFI_HANDLE);
96 void efi_close_devpath(EFI_HANDLE);
97 EFI_HANDLE efi_devpath_handle(EFI_DEVICE_PATH *);
98 EFI_DEVICE_PATH *efi_devpath_last_node(EFI_DEVICE_PATH *);
99 EFI_DEVICE_PATH *efi_devpath_trim(EFI_DEVICE_PATH *);
100 EFI_DEVICE_PATH *efi_devpath_next_instance(EFI_DEVICE_PATH *);
101 bool efi_devpath_match(EFI_DEVICE_PATH *, EFI_DEVICE_PATH *);
102 bool efi_devpath_match_node(EFI_DEVICE_PATH *, EFI_DEVICE_PATH *);
103 bool efi_devpath_is_prefix(EFI_DEVICE_PATH *, EFI_DEVICE_PATH *);
104 CHAR16 *efi_devpath_name(EFI_DEVICE_PATH *);
105 void efi_free_devpath_name(CHAR16 *);
106 bool efi_devpath_same_disk(EFI_DEVICE_PATH *, EFI_DEVICE_PATH *);
107 EFI_DEVICE_PATH *efi_devpath_to_media_path(EFI_DEVICE_PATH *);
108 UINTN efi_devpath_length(EFI_DEVICE_PATH *);
109 EFI_DEVICE_PATH *efi_name_to_devpath(const char *path);
110 EFI_DEVICE_PATH *efi_name_to_devpath16(CHAR16 *path);
111 void efi_devpath_free(EFI_DEVICE_PATH *dp);
112 EFI_HANDLE efi_devpath_to_handle(EFI_DEVICE_PATH *path, EFI_HANDLE *handles, unsigned nhandles);
113 
114 int efi_status_to_errno(EFI_STATUS);
115 EFI_STATUS errno_to_efi_status(int errno);
116 
117 void efi_time_init(void);
118 void efi_time_fini(void);
119 
120 int parse_uefi_con_out(void);
121 EFI_STATUS efi_main(EFI_HANDLE Ximage, EFI_SYSTEM_TABLE* Xsystab);
122 
123 EFI_STATUS main(int argc, CHAR16 *argv[]);
124 void efi_exit(EFI_STATUS status) __dead2;
125 
126 /* EFI environment initialization. */
127 void efi_init_environment(void);
128 
129 /* EFI Memory type strings. */
130 const char *efi_memory_type(EFI_MEMORY_TYPE);
131 
132 /* CHAR16 utility functions. */
133 int wcscmp(CHAR16 *, CHAR16 *);
134 void cpy8to16(const char *, CHAR16 *, size_t);
135 void cpy16to8(const CHAR16 *, char *, size_t);
136 
137 /*
138  * Routines for interacting with EFI's env vars in a more unix-like
139  * way than the standard APIs. In addition, convenience routines for
140  * the loader setting / getting FreeBSD specific variables.
141  */
142 
143 EFI_STATUS efi_delenv(EFI_GUID *guid, const char *varname);
144 EFI_STATUS efi_freebsd_delenv(const char *varname);
145 EFI_STATUS efi_freebsd_getenv(const char *v, void *data, __size_t *len);
146 EFI_STATUS efi_getenv(EFI_GUID *g, const char *v, void *data, __size_t *len);
147 EFI_STATUS efi_global_getenv(const char *v, void *data, __size_t *len);
148 EFI_STATUS efi_setenv(EFI_GUID *guid, const char *varname, UINT32 attr, void *data, __size_t len);
149 EFI_STATUS efi_setenv_freebsd_wcs(const char *varname, CHAR16 *valstr);
150 
151 /* guids and names */
152 bool efi_guid_to_str(const EFI_GUID *, char **);
153 bool efi_str_to_guid(const char *, EFI_GUID *);
154 bool efi_name_to_guid(const char *, EFI_GUID *);
155 bool efi_guid_to_name(EFI_GUID *, char **);
156 
157 /* efipart.c */
158 int	efipart_inithandles(void);
159 
160 #endif	/* _LOADER_EFILIB_H */
161