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 
28 #ifndef _LOADER_EFILIB_H
29 #define	_LOADER_EFILIB_H
30 
31 #include <stand.h>
32 #include <stdbool.h>
33 #include <sys/queue.h>
34 
35 extern EFI_HANDLE		IH;
36 extern EFI_SYSTEM_TABLE		*ST;
37 extern EFI_BOOT_SERVICES	*BS;
38 extern EFI_RUNTIME_SERVICES	*RS;
39 
40 extern struct devsw efipart_fddev;
41 extern struct devsw efipart_cddev;
42 extern struct devsw efipart_hddev;
43 extern struct devsw efinet_dev;
44 extern struct netif_driver efinetif;
45 
46 /* EFI block device data, included here to help efi_zfs_probe() */
47 typedef STAILQ_HEAD(pdinfo_list, pdinfo) pdinfo_list_t;
48 
49 typedef struct pdinfo
50 {
51 	STAILQ_ENTRY(pdinfo)	pd_link;	/* link in device list */
52 	pdinfo_list_t		pd_part;	/* list of partitions */
53 	EFI_HANDLE		pd_handle;
54 	EFI_HANDLE		pd_alias;
55 	EFI_DEVICE_PATH		*pd_devpath;
56 	EFI_BLOCK_IO		*pd_blkio;
57 	uint32_t		pd_unit;	/* unit number */
58 	uint32_t		pd_open;	/* reference counter */
59 	void			*pd_bcache;	/* buffer cache data */
60 	struct pdinfo		*pd_parent;	/* Linked items (eg partitions) */
61 	struct devsw		*pd_devsw;	/* Back pointer to devsw */
62 } pdinfo_t;
63 
64 pdinfo_list_t *efiblk_get_pdinfo_list(struct devsw *dev);
65 pdinfo_t *efiblk_get_pdinfo(struct devdesc *dev);
66 pdinfo_t *efiblk_get_pdinfo_by_handle(EFI_HANDLE h);
67 
68 void *efi_get_table(EFI_GUID *tbl);
69 EFI_STATUS OpenProtocolByHandle(EFI_HANDLE, EFI_GUID *, void **);
70 
71 int efi_getdev(void **, const char *, const char **);
72 char *efi_fmtdev(void *);
73 int efi_setcurrdev(struct env_var *, int, const void *);
74 
75 int efi_register_handles(struct devsw *, EFI_HANDLE *, EFI_HANDLE *, int);
76 EFI_HANDLE efi_find_handle(struct devsw *, int);
77 int efi_handle_lookup(EFI_HANDLE, struct devsw **, int *,  uint64_t *);
78 int efi_handle_update_dev(EFI_HANDLE, struct devsw *, int, uint64_t);
79 
80 EFI_DEVICE_PATH *efi_lookup_image_devpath(EFI_HANDLE);
81 EFI_DEVICE_PATH *efi_lookup_devpath(EFI_HANDLE);
82 void efi_close_devpath(EFI_HANDLE);
83 EFI_HANDLE efi_devpath_handle(EFI_DEVICE_PATH *);
84 EFI_DEVICE_PATH *efi_devpath_last_node(EFI_DEVICE_PATH *);
85 EFI_DEVICE_PATH *efi_devpath_trim(EFI_DEVICE_PATH *);
86 bool efi_devpath_match(EFI_DEVICE_PATH *, EFI_DEVICE_PATH *);
87 bool efi_devpath_is_prefix(EFI_DEVICE_PATH *, EFI_DEVICE_PATH *);
88 CHAR16 *efi_devpath_name(EFI_DEVICE_PATH *);
89 void efi_free_devpath_name(CHAR16 *);
90 
91 int efi_status_to_errno(EFI_STATUS);
92 EFI_STATUS errno_to_efi_status(int errno);
93 
94 void efi_time_init(void);
95 void efi_time_fini(void);
96 
97 EFI_STATUS efi_main(EFI_HANDLE Ximage, EFI_SYSTEM_TABLE* Xsystab);
98 
99 EFI_STATUS main(int argc, CHAR16 *argv[]);
100 void efi_exit(EFI_STATUS status) __dead2;
101 void delay(int usecs);
102 
103 /* EFI environment initialization. */
104 void efi_init_environment(void);
105 
106 /* EFI Memory type strings. */
107 const char *efi_memory_type(EFI_MEMORY_TYPE);
108 
109 /* CHAR16 utility functions. */
110 int wcscmp(CHAR16 *, CHAR16 *);
111 void cpy8to16(const char *, CHAR16 *, size_t);
112 void cpy16to8(const CHAR16 *, char *, size_t);
113 
114 /*
115  * Routines for interacting with EFI's env vars in a more unix-like
116  * way than the standard APIs. In addition, convenience routines for
117  * the loader setting / getting illumos specific variables.
118  */
119 
120 EFI_STATUS efi_illumos_getenv(const char *v, void *data, size_t *len);
121 EFI_STATUS efi_getenv(EFI_GUID *g, const char *v, void *data, size_t *len);
122 EFI_STATUS efi_global_getenv(const char *v, void *data, size_t *len);
123 EFI_STATUS efi_setenv_illumos_wcs(const char *varname, CHAR16 *valstr);
124 
125 /* guids and names */
126 bool efi_guid_to_str(const EFI_GUID *, char **);
127 bool efi_str_to_guid(const char *, EFI_GUID *);
128 bool efi_name_to_guid(const char *, EFI_GUID *);
129 bool efi_guid_to_name(EFI_GUID *, char **);
130 
131 /* efipart.c */
132 int	efipart_inithandles(void);
133 
134 #endif /* _LOADER_EFILIB_H */
135