2 * Copyright (c) 2000 Doug Rabson
3 * Copyright (c) 2006 Marcel Moolenaar
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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.
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
30 #ifndef _LOADER_EFILIB_H
31 #define _LOADER_EFILIB_H
35 #include <sys/queue.h>
38 extern EFI_SYSTEM_TABLE *ST;
39 extern EFI_BOOT_SERVICES *BS;
40 extern EFI_RUNTIME_SERVICES *RS;
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;
49 /* EFI block device data, included here to help efi_zfs_probe() */
50 typedef STAILQ_HEAD(pdinfo_list, pdinfo) pdinfo_list_t;
54 STAILQ_ENTRY(pdinfo) pd_link; /* link in device list */
55 pdinfo_list_t pd_part; /* list of partitions */
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 */
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);
72 void *efi_get_table(EFI_GUID *tbl);
73 EFI_STATUS OpenProtocolByHandle(EFI_HANDLE, EFI_GUID *, void **);
75 int efi_getdev(void **vdev, const char *devspec, const char **path);
76 char *efi_fmtdev(void *vdev);
77 int efi_setcurrdev(struct env_var *ev, int flags, const void *value);
80 int efi_register_handles(struct devsw *, EFI_HANDLE *, EFI_HANDLE *, int);
81 EFI_HANDLE efi_find_handle(struct devsw *, int);
82 int efi_handle_lookup(EFI_HANDLE, struct devsw **, int *, uint64_t *);
83 int efi_handle_update_dev(EFI_HANDLE, struct devsw *, int, uint64_t);
85 EFI_DEVICE_PATH *efi_lookup_image_devpath(EFI_HANDLE);
86 EFI_DEVICE_PATH *efi_lookup_devpath(EFI_HANDLE);
87 EFI_HANDLE efi_devpath_handle(EFI_DEVICE_PATH *);
88 EFI_DEVICE_PATH *efi_devpath_last_node(EFI_DEVICE_PATH *);
89 EFI_DEVICE_PATH *efi_devpath_trim(EFI_DEVICE_PATH *);
90 bool efi_devpath_match(EFI_DEVICE_PATH *, EFI_DEVICE_PATH *);
91 bool efi_devpath_match_node(EFI_DEVICE_PATH *, EFI_DEVICE_PATH *);
92 bool efi_devpath_is_prefix(EFI_DEVICE_PATH *, EFI_DEVICE_PATH *);
93 CHAR16 *efi_devpath_name(EFI_DEVICE_PATH *);
94 void efi_free_devpath_name(CHAR16 *);
95 bool efi_devpath_same_disk(EFI_DEVICE_PATH *, EFI_DEVICE_PATH *);
96 EFI_DEVICE_PATH *efi_devpath_to_media_path(EFI_DEVICE_PATH *);
97 UINTN efi_devpath_length(EFI_DEVICE_PATH *);
98 EFI_DEVICE_PATH *efi_name_to_devpath(const char *path);
99 EFI_DEVICE_PATH *efi_name_to_devpath16(CHAR16 *path);
100 void efi_devpath_free(EFI_DEVICE_PATH *dp);
101 EFI_HANDLE efi_devpath_to_handle(EFI_DEVICE_PATH *path, EFI_HANDLE *handles, unsigned nhandles);
103 int efi_status_to_errno(EFI_STATUS);
104 EFI_STATUS errno_to_efi_status(int errno);
106 void efi_time_init(void);
107 void efi_time_fini(void);
109 EFI_STATUS efi_main(EFI_HANDLE Ximage, EFI_SYSTEM_TABLE* Xsystab);
111 EFI_STATUS main(int argc, CHAR16 *argv[]);
112 void efi_exit(EFI_STATUS status) __dead2;
113 void delay(int usecs);
115 /* EFI environment initialization. */
116 void efi_init_environment(void);
118 /* EFI Memory type strings. */
119 const char *efi_memory_type(EFI_MEMORY_TYPE);
121 /* CHAR16 utility functions. */
122 int wcscmp(CHAR16 *, CHAR16 *);
123 void cpy8to16(const char *, CHAR16 *, size_t);
124 void cpy16to8(const CHAR16 *, char *, size_t);
127 * Routines for interacting with EFI's env vars in a more unix-like
128 * way than the standard APIs. In addition, convenience routines for
129 * the loader setting / getting FreeBSD specific variables.
132 EFI_STATUS efi_delenv(EFI_GUID *guid, const char *varname);
133 EFI_STATUS efi_freebsd_delenv(const char *varname);
134 EFI_STATUS efi_freebsd_getenv(const char *v, void *data, __size_t *len);
135 EFI_STATUS efi_getenv(EFI_GUID *g, const char *v, void *data, __size_t *len);
136 EFI_STATUS efi_global_getenv(const char *v, void *data, __size_t *len);
137 EFI_STATUS efi_setenv(EFI_GUID *guid, const char *varname, UINT32 attr, void *data, __size_t len);
138 EFI_STATUS efi_setenv_freebsd_wcs(const char *varname, CHAR16 *valstr);
140 /* guids and names */
141 bool efi_guid_to_str(const EFI_GUID *, char **);
142 bool efi_str_to_guid(const char *, EFI_GUID *);
143 bool efi_name_to_guid(const char *, EFI_GUID *);
144 bool efi_guid_to_name(EFI_GUID *, char **);
147 int efipart_inithandles(void);
149 #endif /* _LOADER_EFILIB_H */