2 * Copyright (c) 2016 John Baldwin <jhb@FreeBSD.org>
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
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.
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
26 #include <sys/cdefs.h>
27 __FBSDID("$FreeBSD$");
33 static EFI_GUID ImageDevicePathGUID =
34 EFI_LOADED_IMAGE_DEVICE_PATH_PROTOCOL_GUID;
35 static EFI_GUID DevicePathGUID = DEVICE_PATH_PROTOCOL;
36 static EFI_GUID DevicePathToTextGUID = EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID;
37 static EFI_DEVICE_PATH_TO_TEXT_PROTOCOL *toTextProtocol;
38 static EFI_GUID DevicePathFromTextGUID = EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL_GUID;
39 static EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL *fromTextProtocol;
42 efi_lookup_image_devpath(EFI_HANDLE handle)
44 EFI_DEVICE_PATH *devpath;
47 status = OpenProtocolByHandle(handle, &ImageDevicePathGUID,
49 if (EFI_ERROR(status))
55 efi_lookup_devpath(EFI_HANDLE handle)
57 EFI_DEVICE_PATH *devpath;
60 status = OpenProtocolByHandle(handle, &DevicePathGUID,
62 if (EFI_ERROR(status))
68 efi_devpath_name(EFI_DEVICE_PATH *devpath)
74 if (toTextProtocol == NULL) {
75 status = BS->LocateProtocol(&DevicePathToTextGUID, NULL,
76 (VOID **)&toTextProtocol);
77 if (EFI_ERROR(status))
78 toTextProtocol = NULL;
80 if (toTextProtocol == NULL)
83 return (toTextProtocol->ConvertDevicePathToText(devpath, TRUE, TRUE));
87 efi_free_devpath_name(CHAR16 *text)
94 efi_name_to_devpath(const char *path)
96 EFI_DEVICE_PATH *devpath;
101 if (utf8_to_ucs2(path, &uv, &ul) != 0)
103 devpath = efi_name_to_devpath16(uv);
109 efi_name_to_devpath16(CHAR16 *path)
115 if (fromTextProtocol == NULL) {
116 status = BS->LocateProtocol(&DevicePathFromTextGUID, NULL,
117 (VOID **)&fromTextProtocol);
118 if (EFI_ERROR(status))
119 fromTextProtocol = NULL;
121 if (fromTextProtocol == NULL)
124 return (fromTextProtocol->ConvertTextToDevicePath(path));
127 void efi_devpath_free(EFI_DEVICE_PATH *devpath)
130 BS->FreePool(devpath);
134 efi_devpath_last_node(EFI_DEVICE_PATH *devpath)
137 if (IsDevicePathEnd(devpath))
139 while (!IsDevicePathEnd(NextDevicePathNode(devpath)))
140 devpath = NextDevicePathNode(devpath);
145 efi_devpath_trim(EFI_DEVICE_PATH *devpath)
147 EFI_DEVICE_PATH *node, *copy;
150 if ((node = efi_devpath_last_node(devpath)) == NULL)
152 prefix = (UINT8 *)node - (UINT8 *)devpath;
155 len = prefix + DevicePathNodeLength(NextDevicePathNode(node));
158 memcpy(copy, devpath, prefix);
159 node = (EFI_DEVICE_PATH *)((UINT8 *)copy + prefix);
160 SetDevicePathEndNode(node);
166 efi_devpath_handle(EFI_DEVICE_PATH *devpath)
172 * There isn't a standard way to locate a handle for a given
173 * device path. However, querying the EFI_DEVICE_PATH protocol
174 * for a given device path should give us a handle for the
175 * closest node in the path to the end that is valid.
177 status = BS->LocateDevicePath(&DevicePathGUID, &devpath, &h);
178 if (EFI_ERROR(status))
184 efi_devpath_match_node(EFI_DEVICE_PATH *devpath1, EFI_DEVICE_PATH *devpath2)
188 if (devpath1 == NULL || devpath2 == NULL)
190 if (DevicePathType(devpath1) != DevicePathType(devpath2) ||
191 DevicePathSubType(devpath1) != DevicePathSubType(devpath2))
193 len = DevicePathNodeLength(devpath1);
194 if (len != DevicePathNodeLength(devpath2))
196 if (memcmp(devpath1, devpath2, len) != 0)
202 _efi_devpath_match(EFI_DEVICE_PATH *devpath1, EFI_DEVICE_PATH *devpath2,
206 if (devpath1 == NULL || devpath2 == NULL)
211 IsDevicePathType(devpath1, MEDIA_DEVICE_PATH) &&
212 IsDevicePathType(devpath2, MEDIA_DEVICE_PATH))
214 if (!efi_devpath_match_node(devpath1, devpath2))
216 if (IsDevicePathEnd(devpath1))
218 devpath1 = NextDevicePathNode(devpath1);
219 devpath2 = NextDevicePathNode(devpath2);
224 * Are two devpaths identical?
227 efi_devpath_match(EFI_DEVICE_PATH *devpath1, EFI_DEVICE_PATH *devpath2)
229 return _efi_devpath_match(devpath1, devpath2, false);
233 * Like efi_devpath_match, but stops at when we hit the media device
234 * path node that specifies the partition information. If we match
235 * up to that point, then we're on the same disk.
238 efi_devpath_same_disk(EFI_DEVICE_PATH *devpath1, EFI_DEVICE_PATH *devpath2)
240 return _efi_devpath_match(devpath1, devpath2, true);
244 efi_devpath_is_prefix(EFI_DEVICE_PATH *prefix, EFI_DEVICE_PATH *path)
248 if (prefix == NULL || path == NULL)
252 if (IsDevicePathEnd(prefix))
255 if (DevicePathType(prefix) != DevicePathType(path) ||
256 DevicePathSubType(prefix) != DevicePathSubType(path))
259 len = DevicePathNodeLength(prefix);
260 if (len != DevicePathNodeLength(path))
263 if (memcmp(prefix, path, len) != 0)
266 prefix = NextDevicePathNode(prefix);
267 path = NextDevicePathNode(path);
273 * Skip over the 'prefix' part of path and return the part of the path
274 * that starts with the first node that's a MEDIA_DEVICE_PATH.
277 efi_devpath_to_media_path(EFI_DEVICE_PATH *path)
280 while (!IsDevicePathEnd(path)) {
281 if (DevicePathType(path) == MEDIA_DEVICE_PATH)
283 path = NextDevicePathNode(path);
289 efi_devpath_length(EFI_DEVICE_PATH *path)
291 EFI_DEVICE_PATH *start = path;
293 while (!IsDevicePathEnd(path))
294 path = NextDevicePathNode(path);
295 return ((UINTN)path - (UINTN)start) + DevicePathNodeLength(path);
299 efi_devpath_to_handle(EFI_DEVICE_PATH *path, EFI_HANDLE *handles, unsigned nhandles)
302 EFI_DEVICE_PATH *media, *devpath;
305 media = efi_devpath_to_media_path(path);
308 for (i = 0; i < nhandles; i++) {
310 devpath = efi_lookup_devpath(h);
313 if (!efi_devpath_match_node(media, efi_devpath_to_media_path(devpath)))