2 * Copyright (c) 2010 Marcel Moolenaar
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
31 #include <sys/param.h>
33 #include <sys/queue.h>
37 #include <bootstrap.h>
44 static EFI_GUID blkio_guid = BLOCK_IO_PROTOCOL;
46 static int efipart_initfd(void);
47 static int efipart_initcd(void);
48 static int efipart_inithd(void);
50 static int efipart_strategy(void *, int, daddr_t, size_t, char *, size_t *);
51 static int efipart_realstrategy(void *, int, daddr_t, size_t, char *, size_t *);
53 static int efipart_open(struct open_file *, ...);
54 static int efipart_close(struct open_file *);
55 static int efipart_ioctl(struct open_file *, u_long, void *);
57 static int efipart_printfd(int);
58 static int efipart_printcd(int);
59 static int efipart_printhd(int);
61 struct devsw efipart_fddev = {
64 .dv_init = efipart_initfd,
65 .dv_strategy = efipart_strategy,
66 .dv_open = efipart_open,
67 .dv_close = efipart_close,
68 .dv_ioctl = efipart_ioctl,
69 .dv_print = efipart_printfd,
73 struct devsw efipart_cddev = {
76 .dv_init = efipart_initcd,
77 .dv_strategy = efipart_strategy,
78 .dv_open = efipart_open,
79 .dv_close = efipart_close,
80 .dv_ioctl = efipart_ioctl,
81 .dv_print = efipart_printcd,
85 struct devsw efipart_hddev = {
88 .dv_init = efipart_inithd,
89 .dv_strategy = efipart_strategy,
90 .dv_open = efipart_open,
91 .dv_close = efipart_close,
92 .dv_ioctl = efipart_ioctl,
93 .dv_print = efipart_printhd,
97 static pdinfo_list_t fdinfo;
98 static pdinfo_list_t cdinfo;
99 static pdinfo_list_t hdinfo;
101 static EFI_HANDLE *efipart_handles = NULL;
102 static UINTN efipart_nhandles = 0;
105 efiblk_get_pdinfo_list(struct devsw *dev)
107 if (dev->dv_type == DEVT_DISK)
109 if (dev->dv_type == DEVT_CD)
111 if (dev->dv_type == DEVT_FD)
117 efiblk_get_pdinfo(struct devdesc *dev)
122 pdi = efiblk_get_pdinfo_list(dev->d_dev);
126 STAILQ_FOREACH(pd, pdi, pd_link) {
127 if (pd->pd_unit == dev->d_unit)
134 efiblk_pdinfo_count(pdinfo_list_t *pdi)
139 STAILQ_FOREACH(pd, pdi, pd_link) {
146 efipart_inithandles(void)
152 if (efipart_nhandles != 0) {
153 free(efipart_handles);
154 efipart_handles = NULL;
155 efipart_nhandles = 0;
160 status = BS->LocateHandle(ByProtocol, &blkio_guid, 0, &sz, hin);
161 if (status == EFI_BUFFER_TOO_SMALL) {
163 status = BS->LocateHandle(ByProtocol, &blkio_guid, 0, &sz,
165 if (EFI_ERROR(status))
168 if (EFI_ERROR(status))
169 return (efi_status_to_errno(status));
171 efipart_handles = hin;
172 efipart_nhandles = sz;
176 static ACPI_HID_DEVICE_PATH *
177 efipart_floppy(EFI_DEVICE_PATH *node)
179 ACPI_HID_DEVICE_PATH *acpi = NULL;
181 if (DevicePathType(node) == ACPI_DEVICE_PATH &&
182 DevicePathSubType(node) == ACPI_DP) {
183 acpi = (ACPI_HID_DEVICE_PATH *) node;
184 if (acpi->HID == EISA_PNP_ID(0x604) ||
185 acpi->HID == EISA_PNP_ID(0x700) ||
186 acpi->HID == EISA_ID(0x41d1, 0x701)) {
194 * Add or update entries with new handle data.
197 efipart_fdinfo_add(EFI_HANDLE handle, uint32_t uid, EFI_DEVICE_PATH *devpath)
201 fd = malloc(sizeof(pdinfo_t));
203 printf("Failed to register floppy %d, out of memory\n", uid);
206 memset(fd, 0, sizeof(pdinfo_t));
207 STAILQ_INIT(&fd->pd_part);
210 fd->pd_handle = handle;
211 fd->pd_devpath = devpath;
212 STAILQ_INSERT_TAIL(&fdinfo, fd, pd_link);
217 efipart_updatefd(void)
219 EFI_DEVICE_PATH *devpath, *node;
220 ACPI_HID_DEVICE_PATH *acpi;
223 nin = efipart_nhandles / sizeof (*efipart_handles);
224 for (i = 0; i < nin; i++) {
225 devpath = efi_lookup_devpath(efipart_handles[i]);
229 if ((node = efi_devpath_last_node(devpath)) == NULL)
231 if ((acpi = efipart_floppy(node)) != NULL) {
232 efipart_fdinfo_add(efipart_handles[i], acpi->UID,
243 rv = efipart_inithandles();
246 STAILQ_INIT(&fdinfo);
250 bcache_add_dev(efiblk_pdinfo_count(&fdinfo));
255 * Add or update entries with new handle data.
258 efipart_cdinfo_add(EFI_HANDLE handle, EFI_HANDLE alias,
259 EFI_DEVICE_PATH *devpath)
266 STAILQ_FOREACH(pd, &cdinfo, pd_link) {
267 if (efi_devpath_match(pd->pd_devpath, devpath) != 0) {
268 pd->pd_handle = handle;
269 pd->pd_alias = alias;
275 cd = malloc(sizeof(pdinfo_t));
277 printf("Failed to add cd %d, out of memory\n", unit);
280 memset(cd, 0, sizeof(pdinfo_t));
281 STAILQ_INIT(&cd->pd_part);
283 cd->pd_handle = handle;
285 cd->pd_alias = alias;
286 cd->pd_devpath = devpath;
287 STAILQ_INSERT_TAIL(&cdinfo, cd, pd_link);
292 efipart_updatecd(void)
295 EFI_DEVICE_PATH *devpath, *devpathcpy, *tmpdevpath, *node;
300 nin = efipart_nhandles / sizeof (*efipart_handles);
301 for (i = 0; i < nin; i++) {
302 devpath = efi_lookup_devpath(efipart_handles[i]);
306 if ((node = efi_devpath_last_node(devpath)) == NULL)
308 if (efipart_floppy(node) != NULL)
311 status = BS->HandleProtocol(efipart_handles[i],
312 &blkio_guid, (void **)&blkio);
313 if (EFI_ERROR(status))
316 * If we come across a logical partition of subtype CDROM
317 * it doesn't refer to the CD filesystem itself, but rather
318 * to any usable El Torito boot image on it. In this case
319 * we try to find the parent device and add that instead as
320 * that will be the CD filesystem.
322 if (DevicePathType(node) == MEDIA_DEVICE_PATH &&
323 DevicePathSubType(node) == MEDIA_CDROM_DP) {
324 devpathcpy = efi_devpath_trim(devpath);
325 if (devpathcpy == NULL)
327 tmpdevpath = devpathcpy;
328 status = BS->LocateDevicePath(&blkio_guid, &tmpdevpath,
331 if (EFI_ERROR(status))
333 devpath = efi_lookup_devpath(handle);
334 efipart_cdinfo_add(handle, efipart_handles[i],
339 if (DevicePathType(node) == MESSAGING_DEVICE_PATH &&
340 DevicePathSubType(node) == MSG_ATAPI_DP) {
341 efipart_cdinfo_add(efipart_handles[i], NULL,
346 /* USB or SATA cd without the media. */
347 if (blkio->Media->RemovableMedia &&
348 !blkio->Media->MediaPresent) {
349 efipart_cdinfo_add(efipart_handles[i], NULL,
360 rv = efipart_inithandles();
363 STAILQ_INIT(&cdinfo);
367 bcache_add_dev(efiblk_pdinfo_count(&cdinfo));
372 efipart_hdinfo_add(EFI_HANDLE disk_handle, EFI_HANDLE part_handle)
374 EFI_DEVICE_PATH *disk_devpath, *part_devpath;
375 HARDDRIVE_DEVICE_PATH *node;
377 pdinfo_t *hd, *pd, *last;
379 disk_devpath = efi_lookup_devpath(disk_handle);
380 part_devpath = efi_lookup_devpath(part_handle);
381 if (disk_devpath == NULL || part_devpath == NULL) {
384 node = (HARDDRIVE_DEVICE_PATH *)efi_devpath_last_node(part_devpath);
386 return (ENOENT); /* This should not happen. */
388 pd = malloc(sizeof(pdinfo_t));
390 printf("Failed to add disk, out of memory\n");
393 memset(pd, 0, sizeof(pdinfo_t));
394 STAILQ_INIT(&pd->pd_part);
396 STAILQ_FOREACH(hd, &hdinfo, pd_link) {
397 if (efi_devpath_match(hd->pd_devpath, disk_devpath) != 0) {
398 /* Add the partition. */
399 pd->pd_handle = part_handle;
400 pd->pd_unit = node->PartitionNumber;
401 pd->pd_devpath = part_devpath;
402 STAILQ_INSERT_TAIL(&hd->pd_part, pd, pd_link);
407 last = STAILQ_LAST(&hdinfo, pdinfo, pd_link);
409 unit = last->pd_unit + 1;
415 hd->pd_handle = disk_handle;
417 hd->pd_devpath = disk_devpath;
418 STAILQ_INSERT_TAIL(&hdinfo, hd, pd_link);
420 pd = malloc(sizeof(pdinfo_t));
422 printf("Failed to add partition, out of memory\n");
425 memset(pd, 0, sizeof(pdinfo_t));
426 STAILQ_INIT(&pd->pd_part);
428 /* Add the partition. */
429 pd->pd_handle = part_handle;
430 pd->pd_unit = node->PartitionNumber;
431 pd->pd_devpath = part_devpath;
432 STAILQ_INSERT_TAIL(&hd->pd_part, pd, pd_link);
438 * The MEDIA_FILEPATH_DP has device name.
439 * From U-Boot sources it looks like names are in the form
440 * of typeN:M, where type is interface type, N is disk id
441 * and M is partition id.
444 efipart_hdinfo_add_filepath(EFI_HANDLE disk_handle)
446 EFI_DEVICE_PATH *devpath;
447 FILEPATH_DEVICE_PATH *node;
452 /* First collect and verify all the data */
453 if ((devpath = efi_lookup_devpath(disk_handle)) == NULL)
455 node = (FILEPATH_DEVICE_PATH *)efi_devpath_last_node(devpath);
457 return (ENOENT); /* This should not happen. */
459 pd = malloc(sizeof(pdinfo_t));
461 printf("Failed to add disk, out of memory\n");
464 memset(pd, 0, sizeof(pdinfo_t));
465 STAILQ_INIT(&pd->pd_part);
466 last = STAILQ_LAST(&hdinfo, pdinfo, pd_link);
468 unit = last->pd_unit + 1;
472 /* FILEPATH_DEVICE_PATH has 0 terminated string */
473 for (len = 0; node->PathName[len] != 0; len++)
475 if ((pathname = malloc(len + 1)) == NULL) {
476 printf("Failed to add disk, out of memory\n");
480 cpy16to8(node->PathName, pathname, len + 1);
481 p = strchr(pathname, ':');
484 * Assume we are receiving handles in order, first disk handle,
485 * then partitions for this disk. If this assumption proves
486 * false, this code would need update.
488 if (p == NULL) { /* no colon, add the disk */
489 pd->pd_handle = disk_handle;
491 pd->pd_devpath = devpath;
492 STAILQ_INSERT_TAIL(&hdinfo, pd, pd_link);
496 p++; /* skip the colon */
497 unit = (int)strtol(p, NULL, 0);
500 * We should have disk registered, if not, we are receiving
501 * handles out of order, and this code should be reworked
502 * to create "blank" disk for partition, and to find the
503 * disk based on PathName compares.
506 printf("BUG: No disk for partition \"%s\"\n", pathname);
511 /* Add the partition. */
512 pd->pd_handle = disk_handle;
514 pd->pd_devpath = devpath;
515 STAILQ_INSERT_TAIL(&last->pd_part, pd, pd_link);
521 efipart_updatehd(void)
524 EFI_DEVICE_PATH *devpath, *devpathcpy, *tmpdevpath, *node;
529 nin = efipart_nhandles / sizeof (*efipart_handles);
530 for (i = 0; i < nin; i++) {
531 devpath = efi_lookup_devpath(efipart_handles[i]);
535 if ((node = efi_devpath_last_node(devpath)) == NULL)
537 if (efipart_floppy(node) != NULL)
540 status = BS->HandleProtocol(efipart_handles[i],
541 &blkio_guid, (void **)&blkio);
542 if (EFI_ERROR(status))
545 if (DevicePathType(node) == MEDIA_DEVICE_PATH &&
546 DevicePathSubType(node) == MEDIA_HARDDRIVE_DP) {
547 devpathcpy = efi_devpath_trim(devpath);
548 if (devpathcpy == NULL)
550 tmpdevpath = devpathcpy;
551 status = BS->LocateDevicePath(&blkio_guid, &tmpdevpath,
554 if (EFI_ERROR(status))
557 * We do not support nested partitions.
559 devpathcpy = efi_lookup_devpath(handle);
560 if (devpathcpy == NULL)
562 if ((node = efi_devpath_last_node(devpathcpy)) == NULL)
564 if (DevicePathType(node) == MEDIA_DEVICE_PATH &&
565 DevicePathSubType(node) == MEDIA_HARDDRIVE_DP)
567 efipart_hdinfo_add(handle, efipart_handles[i]);
571 if (DevicePathType(node) == MEDIA_DEVICE_PATH &&
572 DevicePathSubType(node) == MEDIA_FILEPATH_DP) {
573 efipart_hdinfo_add_filepath(efipart_handles[i]);
584 rv = efipart_inithandles();
587 STAILQ_INIT(&hdinfo);
591 bcache_add_dev(efiblk_pdinfo_count(&hdinfo));
596 efipart_print_common(struct devsw *dev, pdinfo_list_t *pdlist, int verbose)
604 struct disk_devdesc pd_dev;
607 if (STAILQ_EMPTY(pdlist))
610 printf("%s devices:", dev->dv_name);
611 if ((ret = pager_output("\n")) != 0)
614 STAILQ_FOREACH(pd, pdlist, pd_link) {
616 if (verbose) { /* Output the device path. */
617 text = efi_devpath_name(efi_lookup_devpath(h));
620 efi_free_devpath_name(text);
621 if ((ret = pager_output("\n")) != 0)
625 snprintf(line, sizeof(line),
626 " %s%d", dev->dv_name, pd->pd_unit);
628 status = BS->HandleProtocol(h, &blkio_guid, (void **)&blkio);
629 if (!EFI_ERROR(status)) {
631 blkio->Media->LastBlock == 0? 0:
632 (unsigned long long) (blkio->Media->LastBlock + 1));
633 if (blkio->Media->LastBlock != 0) {
634 printf(" X %u", blkio->Media->BlockSize);
637 if (blkio->Media->MediaPresent) {
638 if (blkio->Media->RemovableMedia)
639 printf(" (removable)");
641 printf(" (no media)");
642 if ((ret = pager_output("\n")) != 0)
644 if (!blkio->Media->MediaPresent)
647 pd->pd_blkio = blkio;
649 pd_dev.d_unit = pd->pd_unit;
651 pd_dev.d_partition = -1;
652 pd_dev.d_opendata = blkio;
653 ret = disk_open(&pd_dev, blkio->Media->BlockSize *
654 (blkio->Media->LastBlock + 1),
655 blkio->Media->BlockSize);
657 ret = disk_print(&pd_dev, line, verbose);
662 /* Do not fail from disk_open() */
666 if ((ret = pager_output("\n")) != 0)
674 efipart_printfd(int verbose)
676 return (efipart_print_common(&efipart_fddev, &fdinfo, verbose));
680 efipart_printcd(int verbose)
682 return (efipart_print_common(&efipart_cddev, &cdinfo, verbose));
686 efipart_printhd(int verbose)
688 return (efipart_print_common(&efipart_hddev, &hdinfo, verbose));
692 efipart_open(struct open_file *f, ...)
695 struct disk_devdesc *dev;
701 dev = va_arg(args, struct disk_devdesc*);
706 pd = efiblk_get_pdinfo((struct devdesc *)dev);
710 if (pd->pd_blkio == NULL) {
711 status = BS->HandleProtocol(pd->pd_handle, &blkio_guid,
712 (void **)&pd->pd_blkio);
713 if (EFI_ERROR(status))
714 return (efi_status_to_errno(status));
717 blkio = pd->pd_blkio;
718 if (!blkio->Media->MediaPresent)
722 if (pd->pd_bcache == NULL)
723 pd->pd_bcache = bcache_allocate();
725 if (dev->d_dev->dv_type == DEVT_DISK) {
726 return (disk_open(dev,
727 blkio->Media->BlockSize * (blkio->Media->LastBlock + 1),
728 blkio->Media->BlockSize));
734 efipart_close(struct open_file *f)
736 struct disk_devdesc *dev;
739 dev = (struct disk_devdesc *)(f->f_devdata);
743 pd = efiblk_get_pdinfo((struct devdesc *)dev);
748 if (pd->pd_open == 0) {
750 bcache_free(pd->pd_bcache);
751 pd->pd_bcache = NULL;
753 if (dev->d_dev->dv_type == DEVT_DISK)
754 return (disk_close(dev));
759 efipart_ioctl(struct open_file *f, u_long cmd, void *data)
761 struct disk_devdesc *dev;
765 dev = (struct disk_devdesc *)(f->f_devdata);
769 pd = efiblk_get_pdinfo((struct devdesc *)dev);
773 if (dev->d_dev->dv_type == DEVT_DISK) {
774 rc = disk_ioctl(dev, cmd, data);
780 case DIOCGSECTORSIZE:
781 *(u_int *)data = pd->pd_blkio->Media->BlockSize;
784 *(uint64_t *)data = pd->pd_blkio->Media->BlockSize *
785 (pd->pd_blkio->Media->LastBlock + 1);
795 * efipart_readwrite()
796 * Internal equivalent of efipart_strategy(), which operates on the
797 * media-native block size. This function expects all I/O requests
798 * to be within the media size and returns an error if such is not
802 efipart_readwrite(EFI_BLOCK_IO *blkio, int rw, daddr_t blk, daddr_t nblks,
809 if (blk < 0 || blk > blkio->Media->LastBlock)
811 if ((blk + nblks - 1) > blkio->Media->LastBlock)
814 switch (rw & F_MASK) {
816 status = blkio->ReadBlocks(blkio, blkio->Media->MediaId, blk,
817 nblks * blkio->Media->BlockSize, buf);
820 if (blkio->Media->ReadOnly)
822 status = blkio->WriteBlocks(blkio, blkio->Media->MediaId, blk,
823 nblks * blkio->Media->BlockSize, buf);
829 if (EFI_ERROR(status)) {
830 printf("%s: rw=%d, blk=%ju size=%ju status=%lu\n", __func__, rw,
831 blk, nblks, EFI_ERROR_CODE(status));
833 return (efi_status_to_errno(status));
837 efipart_strategy(void *devdata, int rw, daddr_t blk, size_t size,
838 char *buf, size_t *rsize)
840 struct bcache_devdata bcd;
841 struct disk_devdesc *dev;
844 dev = (struct disk_devdesc *)devdata;
848 pd = efiblk_get_pdinfo((struct devdesc *)dev);
852 if (pd->pd_blkio->Media->RemovableMedia &&
853 !pd->pd_blkio->Media->MediaPresent)
856 bcd.dv_strategy = efipart_realstrategy;
857 bcd.dv_devdata = devdata;
858 bcd.dv_cache = pd->pd_bcache;
860 if (dev->d_dev->dv_type == DEVT_DISK) {
861 return (bcache_strategy(&bcd, rw, blk + dev->d_offset,
864 return (bcache_strategy(&bcd, rw, blk, size, buf, rsize));
868 efipart_realstrategy(void *devdata, int rw, daddr_t blk, size_t size,
869 char *buf, size_t *rsize)
871 struct disk_devdesc *dev = (struct disk_devdesc *)devdata;
874 uint64_t off, disk_blocks, d_offset = 0;
876 size_t blkoff, blksz;
878 size_t diskend, readstart;
880 if (dev == NULL || blk < 0)
883 pd = efiblk_get_pdinfo((struct devdesc *)dev);
887 blkio = pd->pd_blkio;
891 if (size == 0 || (size % 512) != 0)
896 * Get disk blocks, this value is either for whole disk or for
900 if (dev->d_dev->dv_type == DEVT_DISK) {
901 if (disk_ioctl(dev, DIOCGMEDIASIZE, &disk_blocks) == 0) {
902 /* DIOCGMEDIASIZE does return bytes. */
903 disk_blocks /= blkio->Media->BlockSize;
905 d_offset = dev->d_offset;
907 if (disk_blocks == 0)
908 disk_blocks = blkio->Media->LastBlock + 1 - d_offset;
910 /* make sure we don't read past disk end */
911 if ((off + size) / blkio->Media->BlockSize > d_offset + disk_blocks) {
912 diskend = d_offset + disk_blocks;
913 readstart = off / blkio->Media->BlockSize;
915 if (diskend <= readstart) {
920 size = diskend - readstart;
921 size = size * blkio->Media->BlockSize;
927 if ((size % blkio->Media->BlockSize == 0) &&
928 (off % blkio->Media->BlockSize == 0))
929 return (efipart_readwrite(blkio, rw,
930 off / blkio->Media->BlockSize,
931 size / blkio->Media->BlockSize, buf));
934 * The block size of the media is not a multiple of I/O.
936 blkbuf = malloc(blkio->Media->BlockSize);
941 blk = off / blkio->Media->BlockSize;
942 blkoff = off % blkio->Media->BlockSize;
943 blksz = blkio->Media->BlockSize - blkoff;
945 error = efipart_readwrite(blkio, rw, blk, 1, blkbuf);
950 bcopy(blkbuf + blkoff, buf, blksz);
955 blksz = blkio->Media->BlockSize;