2
* GRUB -- GRand Unified Bootloader
3
* Copyright (C) 2006 Free Software Foundation, Inc.
5
* GRUB is free software; you can redistribute it and/or modify
6
* it under the terms of the GNU General Public License as published by
7
* the Free Software Foundation; either version 2 of the License, or
8
* (at your option) any later version.
10
* This program is distributed in the hope that it will be useful,
11
* but WITHOUT ANY WARRANTY; without even the implied warranty of
12
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
* GNU General Public License for more details.
15
* You should have received a copy of the GNU General Public License
16
* along with GRUB; if not, write to the Free Software
17
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20
#include <grub/disk.h>
21
#include <grub/partition.h>
23
#include <grub/types.h>
24
#include <grub/misc.h>
26
#include <grub/term.h>
27
#include <grub/efi/api.h>
28
#include <grub/efi/efi.h>
29
#include <grub/efi/disk.h>
31
struct grub_efidisk_data
33
grub_efi_handle_t handle;
34
grub_efi_device_path_t *device_path;
35
grub_efi_device_path_t *last_device_path;
36
grub_efi_block_io_t *block_io;
37
grub_efi_disk_io_t *disk_io;
38
struct grub_efidisk_data *next;
42
static grub_efi_guid_t disk_io_guid = GRUB_EFI_DISK_IO_GUID;
43
static grub_efi_guid_t block_io_guid = GRUB_EFI_BLOCK_IO_GUID;
45
static struct grub_efidisk_data *fd_devices;
46
static struct grub_efidisk_data *hd_devices;
47
static struct grub_efidisk_data *cd_devices;
49
/* Duplicate a device path. */
50
static grub_efi_device_path_t *
51
duplicate_device_path (const grub_efi_device_path_t *dp)
53
grub_efi_device_path_t *p;
54
grub_size_t total_size = 0;
56
for (p = (grub_efi_device_path_t *) dp;
58
p = GRUB_EFI_NEXT_DEVICE_PATH (p))
60
total_size += GRUB_EFI_DEVICE_PATH_LENGTH (p);
61
if (GRUB_EFI_END_ENTIRE_DEVICE_PATH (p))
65
p = grub_malloc (total_size);
69
grub_memcpy (p, dp, total_size);
73
/* Return the device path node right before the end node. */
74
static grub_efi_device_path_t *
75
find_last_device_path (const grub_efi_device_path_t *dp)
77
grub_efi_device_path_t *next, *p;
79
if (GRUB_EFI_END_ENTIRE_DEVICE_PATH (dp))
82
for (p = (grub_efi_device_path_t *) dp, next = GRUB_EFI_NEXT_DEVICE_PATH (p);
83
! GRUB_EFI_END_ENTIRE_DEVICE_PATH (next);
84
p = next, next = GRUB_EFI_NEXT_DEVICE_PATH (next))
90
/* Compare device paths. */
92
compare_device_paths (const grub_efi_device_path_t *dp1,
93
const grub_efi_device_path_t *dp2)
96
/* Return non-zero. */
101
grub_efi_uint8_t type1, type2;
102
grub_efi_uint8_t subtype1, subtype2;
103
grub_efi_uint16_t len1, len2;
106
type1 = GRUB_EFI_DEVICE_PATH_TYPE (dp1);
107
type2 = GRUB_EFI_DEVICE_PATH_TYPE (dp2);
110
return (int) type2 - (int) type1;
112
subtype1 = GRUB_EFI_DEVICE_PATH_SUBTYPE (dp1);
113
subtype2 = GRUB_EFI_DEVICE_PATH_SUBTYPE (dp2);
115
if (subtype1 != subtype2)
116
return (int) subtype1 - (int) subtype2;
118
len1 = GRUB_EFI_DEVICE_PATH_LENGTH (dp1);
119
len2 = GRUB_EFI_DEVICE_PATH_LENGTH (dp2);
122
return (int) len1 - (int) len2;
124
ret = grub_memcmp (dp1, dp2, len1);
128
if (GRUB_EFI_END_ENTIRE_DEVICE_PATH (dp1))
131
dp1 = (grub_efi_device_path_t *) ((char *) dp1 + len1);
132
dp2 = (grub_efi_device_path_t *) ((char *) dp2 + len2);
138
static struct grub_efidisk_data *
141
grub_efi_uintn_t num_handles;
142
grub_efi_handle_t *handles;
143
grub_efi_handle_t *handle;
144
struct grub_efidisk_data *devices = 0;
146
/* Find handles which support the disk io interface. */
147
handles = grub_efi_locate_handle (GRUB_EFI_BY_PROTOCOL, &disk_io_guid,
152
/* Make a linked list of devices. */
153
for (handle = handles; num_handles--; handle++)
155
grub_efi_device_path_t *dp;
156
grub_efi_device_path_t *ldp;
157
struct grub_efidisk_data *d;
158
grub_efi_block_io_t *bio;
159
grub_efi_disk_io_t *dio;
161
dp = grub_efi_get_device_path (*handle);
165
ldp = find_last_device_path (dp);
167
/* This is empty. Why? */
170
bio = grub_efi_open_protocol (*handle, &block_io_guid,
171
GRUB_EFI_OPEN_PROTOCOL_GET_PROTOCOL);
172
dio = grub_efi_open_protocol (*handle, &disk_io_guid,
173
GRUB_EFI_OPEN_PROTOCOL_GET_PROTOCOL);
175
/* This should not happen... Why? */
178
d = grub_malloc (sizeof (*d));
188
d->last_device_path = ldp;
200
/* Find the parent device. */
201
static struct grub_efidisk_data *
202
find_parent_device (struct grub_efidisk_data *devices,
203
struct grub_efidisk_data *d)
205
grub_efi_device_path_t *dp, *ldp;
206
struct grub_efidisk_data *parent;
208
dp = duplicate_device_path (d->device_path);
212
ldp = find_last_device_path (dp);
213
ldp->type = GRUB_EFI_END_DEVICE_PATH_TYPE;
214
ldp->subtype = GRUB_EFI_END_ENTIRE_DEVICE_PATH_SUBTYPE;
215
ldp->length[0] = sizeof (*ldp);
218
for (parent = devices; parent; parent = parent->next)
224
if (compare_device_paths (parent->device_path, dp) == 0)
227
if (! parent->last_device_path)
239
iterate_child_devices (struct grub_efidisk_data *devices,
240
struct grub_efidisk_data *d,
241
int (*hook) (struct grub_efidisk_data *child))
243
struct grub_efidisk_data *p;
245
for (p = devices; p; p = p->next)
247
grub_efi_device_path_t *dp, *ldp;
249
dp = duplicate_device_path (p->device_path);
253
ldp = find_last_device_path (dp);
254
ldp->type = GRUB_EFI_END_DEVICE_PATH_TYPE;
255
ldp->subtype = GRUB_EFI_END_ENTIRE_DEVICE_PATH_SUBTYPE;
256
ldp->length[0] = sizeof (*ldp);
259
if (compare_device_paths (dp, d->device_path) == 0)
272
/* Add a device into a list of devices in an ascending order. */
274
add_device (struct grub_efidisk_data **devices, struct grub_efidisk_data *d)
276
struct grub_efidisk_data **p;
277
struct grub_efidisk_data *n;
279
for (p = devices; *p; p = &((*p)->next))
283
ret = compare_device_paths (find_last_device_path ((*p)->device_path),
284
find_last_device_path (d->device_path));
286
ret = compare_device_paths ((*p)->device_path,
294
n = grub_malloc (sizeof (*n));
298
grub_memcpy (n, d, sizeof (*n));
303
/* Name the devices. */
305
name_devices (struct grub_efidisk_data *devices)
307
struct grub_efidisk_data *d;
309
/* First, identify devices by media device paths. */
310
for (d = devices; d; d = d->next)
312
grub_efi_device_path_t *dp;
314
dp = d->last_device_path;
318
if (GRUB_EFI_DEVICE_PATH_TYPE (dp) == GRUB_EFI_MEDIA_DEVICE_PATH_TYPE)
320
int is_hard_drive = 0;
322
switch (GRUB_EFI_DEVICE_PATH_SUBTYPE (dp))
324
case GRUB_EFI_HARD_DRIVE_DEVICE_PATH_SUBTYPE:
326
/* Fall through by intention. */
327
case GRUB_EFI_CDROM_DEVICE_PATH_SUBTYPE:
329
struct grub_efidisk_data *parent;
331
parent = find_parent_device (devices, d);
337
grub_printf ("adding a hard drive by a partition: ");
338
grub_print_device_path (parent->device_path);
340
add_device (&hd_devices, parent);
345
grub_printf ("adding a cdrom by a partition: ");
346
grub_print_device_path (parent->device_path);
348
add_device (&cd_devices, parent);
351
/* Mark the parent as used. */
352
parent->last_device_path = 0;
355
/* Mark itself as used. */
356
d->last_device_path = 0;
360
/* For now, ignore the others. */
366
/* Let's see what can be added more. */
367
for (d = devices; d; d = d->next)
369
grub_efi_device_path_t *dp;
370
grub_efi_block_io_media_t *m;
372
dp = d->last_device_path;
376
m = d->block_io->media;
377
if (m->logical_partition)
379
/* Only one partition in a non-media device. Assume that this
380
is a floppy drive. */
382
grub_printf ("adding a floppy by guessing: ");
383
grub_print_device_path (d->device_path);
385
add_device (&fd_devices, d);
387
else if (m->read_only && m->block_size > GRUB_DISK_SECTOR_SIZE)
389
/* This check is too heuristic, but assume that this is a
392
grub_printf ("adding a cdrom by guessing: ");
393
grub_print_device_path (d->device_path);
395
add_device (&cd_devices, d);
399
/* The default is a hard drive. */
401
grub_printf ("adding a hard drive by guessing: ");
402
grub_print_device_path (d->device_path);
404
add_device (&hd_devices, d);
410
free_devices (struct grub_efidisk_data *devices)
412
struct grub_efidisk_data *p, *q;
414
for (p = devices; p; p = q)
421
/* Enumerate all disks to name devices. */
423
enumerate_disks (void)
425
struct grub_efidisk_data *devices;
427
devices = make_devices ();
431
name_devices (devices);
432
free_devices (devices);
436
grub_efidisk_iterate (int (*hook) (const char *name))
438
struct grub_efidisk_data *d;
442
for (d = fd_devices, count = 0; d; d = d->next, count++)
444
grub_sprintf (buf, "fd%d", count);
445
grub_dprintf ("efidisk", "iterating %s\n", buf);
450
for (d = hd_devices, count = 0; d; d = d->next, count++)
452
grub_sprintf (buf, "hd%d", count);
453
grub_dprintf ("efidisk", "iterating %s\n", buf);
458
for (d = cd_devices, count = 0; d; d = d->next, count++)
460
grub_sprintf (buf, "cd%d", count);
461
grub_dprintf ("efidisk", "iterating %s\n", buf);
470
get_drive_number (const char *name)
474
if ((name[0] != 'f' && name[0] != 'h' && name[0] != 'c') || name[1] != 'd')
477
drive = grub_strtoul (name + 2, 0, 10);
478
if (grub_errno != GRUB_ERR_NONE)
484
grub_error (GRUB_ERR_UNKNOWN_DEVICE, "not a efidisk");
488
static struct grub_efidisk_data *
489
get_device (struct grub_efidisk_data *devices, int num)
491
struct grub_efidisk_data *d;
493
for (d = devices; d && num; d = d->next, num--)
503
grub_efidisk_open (const char *name, struct grub_disk *disk)
506
struct grub_efidisk_data *d = 0;
507
grub_efi_block_io_media_t *m;
509
grub_dprintf ("efidisk", "opening %s\n", name);
511
num = get_drive_number (name);
518
disk->has_partitions = 0;
519
d = get_device (fd_devices, num);
522
/* FIXME: a CDROM should have partitions, but not implemented yet. */
523
disk->has_partitions = 0;
524
d = get_device (cd_devices, num);
527
disk->has_partitions = 1;
528
d = get_device (hd_devices, num);
531
/* Never reach here. */
536
return grub_error (GRUB_ERR_UNKNOWN_DEVICE, "no such device");
538
disk->id = ((num << 8) | name[0]);
539
m = d->block_io->media;
540
/* FIXME: Probably it is better to store the block size in the disk,
541
and total sectors should be replaced with total blocks. */
542
grub_dprintf ("efidisk", "m = %p, last block = %llx, block size = %x\n",
543
m, m->last_block, m->block_size);
544
disk->total_sectors = (m->last_block
545
* (m->block_size >> GRUB_DISK_SECTOR_BITS));
548
grub_dprintf ("efidisk", "opening %s succeeded\n", name);
550
return GRUB_ERR_NONE;
554
grub_efidisk_close (struct grub_disk *disk __attribute__ ((unused)))
556
/* EFI disks do not allocate extra memory, so nothing to do here. */
557
grub_dprintf ("efidisk", "closing %s\n", disk->name);
561
grub_efidisk_read (struct grub_disk *disk, unsigned long sector,
562
unsigned long size, char *buf)
564
/* For now, use the disk io interface rather than the block io's. */
565
struct grub_efidisk_data *d;
566
grub_efi_disk_io_t *dio;
567
grub_efi_block_io_t *bio;
568
grub_efi_status_t status;
574
grub_dprintf ("efidisk", "reading 0x%lx sectors at the sector 0x%lx from %s\n",
575
size, sector, disk->name);
577
status = dio->read (dio, bio->media->media_id,
578
(grub_efi_uint64_t) sector << GRUB_DISK_SECTOR_BITS,
579
(grub_efi_uintn_t) size << GRUB_DISK_SECTOR_BITS,
581
if (status != GRUB_EFI_SUCCESS)
582
return grub_error (GRUB_ERR_READ_ERROR, "efidisk read error");
584
return GRUB_ERR_NONE;
588
grub_efidisk_write (struct grub_disk *disk, unsigned long sector,
589
unsigned long size, const char *buf)
591
/* For now, use the disk io interface rather than the block io's. */
592
struct grub_efidisk_data *d;
593
grub_efi_disk_io_t *dio;
594
grub_efi_block_io_t *bio;
595
grub_efi_status_t status;
601
grub_dprintf ("efidisk", "writing 0x%lx sectors at the sector 0x%lx to %s\n",
602
size, sector, disk->name);
604
status = dio->write (dio, bio->media->media_id,
605
(grub_efi_uint64_t) sector << GRUB_DISK_SECTOR_BITS,
606
(grub_efi_uintn_t) size << GRUB_DISK_SECTOR_BITS,
608
if (status != GRUB_EFI_SUCCESS)
609
return grub_error (GRUB_ERR_WRITE_ERROR, "efidisk write error");
611
return GRUB_ERR_NONE;
614
static struct grub_disk_dev grub_efidisk_dev =
617
.id = GRUB_DISK_DEVICE_EFIDISK_ID,
618
.iterate = grub_efidisk_iterate,
619
.open = grub_efidisk_open,
620
.close = grub_efidisk_close,
621
.read = grub_efidisk_read,
622
.write = grub_efidisk_write,
627
grub_efidisk_init (void)
630
grub_disk_dev_register (&grub_efidisk_dev);
634
grub_efidisk_fini (void)
636
free_devices (fd_devices);
637
free_devices (hd_devices);
638
free_devices (cd_devices);
639
grub_disk_dev_unregister (&grub_efidisk_dev);
642
/* Some utility functions to map GRUB devices with EFI devices. */
644
grub_efidisk_get_device_handle (grub_disk_t disk)
646
struct grub_efidisk_data *d;
649
if (disk->dev->id != GRUB_DISK_DEVICE_EFIDISK_ID)
653
type = disk->name[0];
658
/* This is the simplest case. */
662
/* FIXME: probably this is not correct. */
666
/* If this is the whole disk, just return its own data. */
667
if (! disk->partition)
670
/* Otherwise, we must query the corresponding device to the firmware. */
672
struct grub_efidisk_data *devices;
673
grub_efi_handle_t handle = 0;
674
auto int find_partition (struct grub_efidisk_data *c);
676
int find_partition (struct grub_efidisk_data *c)
678
grub_efi_hard_drive_device_path_t hd;
680
grub_memcpy (&hd, c->last_device_path, sizeof (hd));
682
if ((GRUB_EFI_DEVICE_PATH_TYPE (c->last_device_path)
683
== GRUB_EFI_MEDIA_DEVICE_PATH_TYPE)
684
&& (GRUB_EFI_DEVICE_PATH_SUBTYPE (c->last_device_path)
685
== GRUB_EFI_HARD_DRIVE_DEVICE_PATH_SUBTYPE)
686
&& (grub_partition_get_start (disk->partition)
687
== hd.partition_start)
688
&& (grub_partition_get_len (disk->partition)
689
== hd.partition_size))
698
devices = make_devices ();
699
iterate_child_devices (devices, d, find_partition);
700
free_devices (devices);
715
grub_efidisk_get_device_name (grub_efi_handle_t *handle)
717
grub_efi_device_path_t *dp, *ldp;
719
dp = grub_efi_get_device_path (handle);
723
ldp = find_last_device_path (dp);
727
if (GRUB_EFI_DEVICE_PATH_TYPE (ldp) == GRUB_EFI_MEDIA_DEVICE_PATH_TYPE
728
&& (GRUB_EFI_DEVICE_PATH_SUBTYPE (ldp)
729
== GRUB_EFI_HARD_DRIVE_DEVICE_PATH_SUBTYPE))
731
/* This is a hard disk partition. */
732
grub_disk_t parent = 0;
733
char *partition_name = 0;
735
grub_efi_device_path_t *dup_dp, *dup_ldp;
736
grub_efi_hard_drive_device_path_t hd;
737
auto int find_parent_disk (const char *name);
738
auto int find_partition (grub_disk_t disk, const grub_partition_t part);
740
/* Find the disk which is the parent of a given hard disk partition. */
741
int find_parent_disk (const char *name)
745
disk = grub_disk_open (name);
749
if (disk->dev->id == GRUB_DISK_DEVICE_EFIDISK_ID)
751
struct grub_efidisk_data *d;
754
if (compare_device_paths (d->device_path, dup_dp) == 0)
761
grub_disk_close (disk);
765
/* Find the identical partition. */
766
int find_partition (grub_disk_t disk __attribute__ ((unused)),
767
const grub_partition_t part)
769
if (grub_partition_get_start (part) == hd.partition_start
770
&& grub_partition_get_len (part) == hd.partition_size)
772
partition_name = grub_partition_get_name (part);
779
/* It is necessary to duplicate the device path so that GRUB
781
dup_dp = duplicate_device_path (dp);
785
dup_ldp = find_last_device_path (dup_dp);
786
dup_ldp->type = GRUB_EFI_END_DEVICE_PATH_TYPE;
787
dup_ldp->subtype = GRUB_EFI_END_ENTIRE_DEVICE_PATH_SUBTYPE;
788
dup_ldp->length[0] = sizeof (*dup_ldp);
789
dup_ldp->length[1] = 0;
791
grub_efidisk_iterate (find_parent_disk);
797
/* Find a partition which matches the hard drive device path. */
798
grub_memcpy (&hd, ldp, sizeof (hd));
799
grub_partition_iterate (parent, find_partition);
801
if (! partition_name)
803
grub_disk_close (parent);
807
device_name = grub_malloc (grub_strlen (parent->name) + 1
808
+ grub_strlen (partition_name) + 1);
811
grub_free (partition_name);
812
grub_disk_close (parent);
816
grub_sprintf (device_name, "%s,%s", parent->name, partition_name);
817
grub_free (partition_name);
818
grub_disk_close (parent);
823
/* This should be an entire disk. */
824
auto int find_disk (const char *name);
825
char *device_name = 0;
827
int find_disk (const char *name)
831
disk = grub_disk_open (name);
835
if (disk->id == GRUB_DISK_DEVICE_EFIDISK_ID)
837
struct grub_efidisk_data *d;
840
if (compare_device_paths (d->device_path, dp) == 0)
842
device_name = grub_strdup (disk->name);
843
grub_disk_close (disk);
848
grub_disk_close (disk);
853
grub_efidisk_iterate (find_disk);