1 /* ofpath.c - calculate OpenFirmware path names given an OS device */
3 * GRUB -- GRand Unified Bootloader
4 * Copyright (C) 2009, 2011,2012, 2013 Free Software Foundation, Inc.
6 * GRUB is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * GRUB is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with GRUB. If not, see <http://www.gnu.org/licenses/>.
20 #undef OFPATH_STANDALONE
22 #ifndef OFPATH_STANDALONE
23 #include <grub/types.h>
24 #include <grub/util/misc.h>
25 #include <grub/util/ofpath.h>
26 #include <grub/i18n.h>
35 #include <sys/types.h>
44 GRUB_OFPATH_SPARC_WWN_ADDR = 1,
45 GRUB_OFPATH_SPARC_TGT_LUN,
46 } ofpath_sparc_addressing;
48 struct ofpath_sparc_hba
50 grub_uint32_t device_id;
51 ofpath_sparc_addressing addressing;
54 static struct ofpath_sparc_hba sparc_lsi_hba[] = {
55 /* Rhea, Jasper 320, LSI53C1020/1030. */
56 {0x30, GRUB_OFPATH_SPARC_TGT_LUN},
58 {0x50, GRUB_OFPATH_SPARC_TGT_LUN},
60 {0x56, GRUB_OFPATH_SPARC_TGT_LUN},
61 /* Pandora SAS-1068E. */
62 {0x58, GRUB_OFPATH_SPARC_TGT_LUN},
63 /* Aspen, Invader, LSI SAS-3108. */
64 {0x5d, GRUB_OFPATH_SPARC_TGT_LUN},
65 /* Niwot, SAS 2108. */
66 {0x79, GRUB_OFPATH_SPARC_TGT_LUN},
67 /* Erie, Falcon, LSI SAS 2008. */
68 {0x72, GRUB_OFPATH_SPARC_WWN_ADDR},
69 /* LSI WarpDrive 6203. */
70 {0x7e, GRUB_OFPATH_SPARC_WWN_ADDR},
72 {0x87, GRUB_OFPATH_SPARC_WWN_ADDR},
74 {0x97, GRUB_OFPATH_SPARC_WWN_ADDR},
78 static const int LSI_VENDOR_ID = 0x1000;
81 #ifdef OFPATH_STANDALONE
82 #define xmalloc malloc
84 grub_util_error (const char *fmt, ...)
88 fprintf (stderr, "ofpath: error: ");
90 vfprintf (stderr, fmt, ap);
97 grub_util_info (const char *fmt, ...)
101 fprintf (stderr, "ofpath: info: ");
103 vfprintf (stderr, fmt, ap);
105 fputc ('\n', stderr);
108 #define grub_util_warn grub_util_info
110 #define xstrdup strdup
114 kill_trailing_dir(char *path)
116 char *end = path + strlen(path) - 1;
131 trim_newline (char *path)
133 char *end = path + strlen(path) - 1;
139 #define MAX_DISK_CAT 64
142 find_obppath (const char *sysfs_path_orig)
144 char *sysfs_path, *path;
145 size_t path_size = strlen (sysfs_path_orig) + sizeof ("/obppath");
147 sysfs_path = xstrdup (sysfs_path_orig);
148 path = xmalloc (path_size);
157 snprintf(path, path_size, "%s/obppath", sysfs_path);
159 printf("Trying %s\n", path);
162 fd = open(path, O_RDONLY);
165 if (fd < 0 || fstat (fd, &st) < 0)
169 snprintf(path, path_size, "%s/devspec", sysfs_path);
170 fd = open(path, O_RDONLY);
174 if (fd < 0 || fstat (fd, &st) < 0)
178 kill_trailing_dir(sysfs_path);
179 if (!strcmp(sysfs_path, "/sys"))
181 grub_util_info (_("`obppath' not found in parent dirs of `%s',"
182 " no IEEE1275 name discovery"),
191 of_path = xmalloc (size + MAX_DISK_CAT + 1);
192 memset(of_path, 0, size + MAX_DISK_CAT + 1);
193 if (read(fd, of_path, size) < 0)
195 grub_util_info (_("cannot read `%s': %s"), path, strerror (errno));
204 trim_newline(of_path);
212 xrealpath (const char *in)
216 out = xmalloc (PATH_MAX);
217 out = realpath (in, out);
219 out = realpath (in, NULL);
222 grub_util_error (_("failed to get canonical path of `%s'"), in);
227 block_device_get_sysfs_path_and_link(const char *devicenode)
232 size_t tmp_size = strlen (devicenode) + sizeof ("/sys/block/");
233 char *tmp = xmalloc (tmp_size);
235 memcpy (tmp, "/sys/block/", sizeof ("/sys/block/"));
236 strcat (tmp, devicenode);
238 rpath = xrealpath (tmp);
239 rpath2 = xmalloc (strlen (rpath) + sizeof ("/device"));
240 strcpy (rpath2, rpath);
241 strcat (rpath2, "/device");
243 ret = xrealpath (rpath2);
254 return (c >= '0' && c <= '9');
258 trailing_digits (const char *p)
262 end = p + strlen(p) - 1;
265 if (! my_isdigit(*end))
274 __of_path_common(char *sysfs_path,
275 const char *device, int devno)
277 const char *digit_string;
278 char disk[MAX_DISK_CAT];
279 char *of_path = find_obppath(sysfs_path);
284 digit_string = trailing_digits (device);
285 if (*digit_string == '\0')
287 snprintf(disk, sizeof (disk), "/disk@%d", devno);
293 sscanf(digit_string, "%d", &part);
294 snprintf(disk, sizeof (disk), "/disk@%d:%c", devno, 'a' + (part - 1));
296 strcat(of_path, disk);
301 get_basename(char *p)
316 of_path_of_vdisk(const char *sys_devname __attribute__((unused)),
318 const char *devnode __attribute__((unused)),
319 const char *devicenode)
321 char *sysfs_path, *p;
325 sysfs_path = block_device_get_sysfs_path_and_link(devicenode);
326 p = get_basename (sysfs_path);
327 sscanf(p, "vdc-port-%d-%d", &devno, &junk);
328 ret = __of_path_common (sysfs_path, device, devno);
335 of_path_of_ide(const char *sys_devname __attribute__((unused)), const char *device,
336 const char *devnode __attribute__((unused)),
337 const char *devicenode)
339 char *sysfs_path, *p;
343 sysfs_path = block_device_get_sysfs_path_and_link(devicenode);
344 p = get_basename (sysfs_path);
345 sscanf(p, "%d.%d", &chan, &devno);
347 ret = __of_path_common(sysfs_path, device, 2 * chan + devno);
354 of_path_of_nvme(const char *sys_devname __attribute__((unused)),
356 const char *devnode __attribute__((unused)),
357 const char *devicenode)
359 char *sysfs_path, *of_path, disk[MAX_DISK_CAT];
360 const char *digit_string, *part_end;
362 digit_string = trailing_digits (device);
363 part_end = devicenode + strlen (devicenode) - 1;
365 if ((digit_string != '\0') && (*part_end == 'p'))
367 /* We have a partition number, strip it off. */
371 nvmedev = strdup (devicenode);
376 end = nvmedev + strlen (nvmedev) - 1;
379 sscanf (digit_string, "%d", &part);
380 snprintf (disk, sizeof (disk), "/disk@1:%c", 'a' + (part - 1));
381 sysfs_path = block_device_get_sysfs_path_and_link (nvmedev);
386 /* We do not have the parition. */
387 snprintf (disk, sizeof (disk), "/disk@1");
388 sysfs_path = block_device_get_sysfs_path_and_link (device);
391 of_path = find_obppath (sysfs_path);
393 strcat (of_path, disk);
398 vendor_is_ATA(const char *path)
405 path_size = strlen (path) + sizeof ("/vendor");
407 bufname = xmalloc (path_size);
409 snprintf (bufname, path_size, "%s/vendor", path);
410 fd = open (bufname, O_RDONLY);
412 grub_util_error (_("cannot open `%s': %s"), bufname, strerror (errno));
414 memset(bufcont, 0, sizeof (bufcont));
415 err = read(fd, bufcont, sizeof (bufcont));
417 grub_util_error (_("cannot open `%s': %s"), bufname, strerror (errno));
422 return (memcmp(bufcont, "ATA", 3) == 0);
427 check_hba_identifiers (const char *sysfs_path, int *vendor, int *device_id)
429 char *ed = strstr (sysfs_path, "host");
438 p = xstrdup (sysfs_path);
439 ed = strstr (p, "host");
443 path_size = (strlen (p) + sizeof ("vendor"));
444 path = xmalloc (path_size);
449 snprintf (path, path_size, "%svendor", p);
450 fd = open (path, O_RDONLY);
455 memset (buf, 0, sizeof (buf));
457 if (read (fd, buf, sizeof (buf) - 1) < 0)
461 sscanf (buf, "%x", vendor);
463 snprintf (path, path_size, "%sdevice", p);
464 fd = open (path, O_RDONLY);
469 memset (buf, 0, sizeof (buf));
471 if (read (fd, buf, sizeof (buf) - 1) < 0)
475 sscanf (buf, "%x", device_id);
484 check_sas (const char *sysfs_path, int *tgt, unsigned long int *sas_address)
486 char *ed = strstr (sysfs_path, "end_device");
495 /* SAS devices are identified using disk@$PHY_ID */
496 p = xstrdup (sysfs_path);
497 ed = strstr(p, "end_device");
502 while (*q && *q != '/')
506 path_size = (strlen (p) + strlen (ed)
507 + sizeof ("%s/sas_device/%s/phy_identifier"));
508 path = xmalloc (path_size);
509 snprintf (path, path_size, "%s/sas_device/%s/phy_identifier", p, ed);
510 fd = open (path, O_RDONLY);
512 grub_util_error (_("cannot open `%s': %s"), path, strerror (errno));
514 memset (phy, 0, sizeof (phy));
515 if (read (fd, phy, sizeof (phy) - 1) < 0)
516 grub_util_error (_("cannot read `%s': %s"), path, strerror (errno));
520 sscanf (phy, "%d", tgt);
522 snprintf (path, path_size, "%s/sas_device/%s/sas_address", p, ed);
523 fd = open (path, O_RDONLY);
525 grub_util_error (_("cannot open `%s': %s"), path, strerror (errno));
527 memset (phy, 0, sizeof (phy));
528 if (read (fd, phy, sizeof (phy) - 1) < 0)
529 grub_util_error (_("cannot read `%s': %s"), path, strerror (errno));
530 sscanf (phy, "%lx", sas_address);
538 of_path_of_scsi(const char *sys_devname __attribute__((unused)), const char *device,
539 const char *devnode __attribute__((unused)),
540 const char *devicenode)
542 const char *p, *digit_string, *disk_name;
543 int host, bus, tgt, lun;
544 unsigned long int sas_address = 0;
545 char *sysfs_path, disk[MAX_DISK_CAT - sizeof ("/fp@0,0")];
548 sysfs_path = block_device_get_sysfs_path_and_link(devicenode);
549 p = get_basename (sysfs_path);
550 sscanf(p, "%d:%d:%d:%d", &host, &bus, &tgt, &lun);
551 check_sas (sysfs_path, &tgt, &sas_address);
553 if (vendor_is_ATA(sysfs_path))
555 of_path = __of_path_common(sysfs_path, device, tgt);
560 of_path = find_obppath(sysfs_path);
564 if (strstr (of_path, "qlc"))
565 strcat (of_path, "/fp@0,0");
567 if (strstr (of_path, "sbus"))
572 digit_string = trailing_digits (device);
573 if (strncmp (of_path, "/vdevice/", sizeof ("/vdevice/") - 1) == 0)
575 unsigned long id = 0x8000 | (tgt << 8) | (bus << 5) | lun;
576 if (*digit_string == '\0')
578 snprintf(disk, sizeof (disk), "/%s@%04lx000000000000", disk_name, id);
584 sscanf(digit_string, "%d", &part);
585 snprintf(disk, sizeof (disk),
586 "/%s@%04lx000000000000:%c", disk_name, id, 'a' + (part - 1));
592 ofpath_sparc_addressing addressing = GRUB_OFPATH_SPARC_TGT_LUN;
593 int vendor = 0, device_id = 0;
596 check_hba_identifiers (sysfs_path, &vendor, &device_id);
598 if (vendor == LSI_VENDOR_ID)
600 struct ofpath_sparc_hba *lsi_hba;
603 * Over time different OF addressing schemes have been supported.
604 * There is no generic addressing scheme that works across
607 for (lsi_hba = sparc_lsi_hba; lsi_hba->device_id; lsi_hba++)
608 if (lsi_hba->device_id == device_id)
610 addressing = lsi_hba->addressing;
615 if (addressing == GRUB_OFPATH_SPARC_WWN_ADDR)
616 optr += snprintf (disk, sizeof (disk), "/%s@w%lx,%x", disk_name,
619 optr += snprintf (disk, sizeof (disk), "/%s@%x,%x", disk_name, tgt,
622 if (*digit_string != '\0')
626 sscanf (digit_string, "%d", &part);
627 snprintf (optr, sizeof (disk) - (optr - disk - 1), ":%c", 'a'
634 sas_id = bus << 16 | tgt << 8 | lun;
636 if (*digit_string == '\0')
638 snprintf(disk, sizeof (disk), "/sas/%s@%x", disk_name, sas_id);
644 sscanf(digit_string, "%d", &part);
645 snprintf(disk, sizeof (disk),
646 "/sas/%s@%x:%c", disk_name, sas_id, 'a' + (part - 1));
654 lunstr = xmalloc (20);
656 lunpart[0] = (lun >> 8) & 0xff;
657 lunpart[1] = lun & 0xff;
658 lunpart[2] = (lun >> 24) & 0xff;
659 lunpart[3] = (lun >> 16) & 0xff;
661 sprintf(lunstr, "%02x%02x%02x%02x00000000", lunpart[0], lunpart[1], lunpart[2], lunpart[3]);
662 long int longlun = atol(lunstr);
664 if (*digit_string == '\0')
666 snprintf(disk, sizeof (disk), "/sas/%s@%lx,%lu", disk_name, sas_address, longlun);
672 sscanf(digit_string, "%d", &part);
673 snprintf(disk, sizeof (disk),
674 "/sas/%s@%lx,%lu:%c", disk_name, sas_address, longlun, 'a' + (part - 1));
680 strcat(of_path, disk);
688 strip_trailing_digits (const char *p)
693 end = new + strlen(new) - 1;
696 if (! my_isdigit(*end))
705 grub_util_devname_to_ofpath (const char *sys_devname)
707 char *name_buf, *device, *devnode, *devicenode, *ofpath;
709 name_buf = xrealpath (sys_devname);
711 device = get_basename (name_buf);
712 devnode = strip_trailing_digits (name_buf);
713 devicenode = strip_trailing_digits (device);
715 if (device[0] == 'h' && device[1] == 'd')
716 ofpath = of_path_of_ide(name_buf, device, devnode, devicenode);
717 else if (device[0] == 's'
718 && (device[1] == 'd' || device[1] == 'r'))
719 ofpath = of_path_of_scsi(name_buf, device, devnode, devicenode);
720 else if (device[0] == 'v' && device[1] == 'd' && device[2] == 'i'
721 && device[3] == 's' && device[4] == 'k')
722 ofpath = of_path_of_vdisk(name_buf, device, devnode, devicenode);
723 else if (device[0] == 'f' && device[1] == 'd'
724 && device[2] == '0' && device[3] == '\0')
725 /* All the models I've seen have a devalias "floppy".
726 New models have no floppy at all. */
727 ofpath = xstrdup ("floppy");
728 else if (device[0] == 'n' && device[1] == 'v' && device[2] == 'm'
730 ofpath = of_path_of_nvme (name_buf, device, devnode, devicenode);
733 grub_util_warn (_("unknown device type %s"), device);
744 #ifdef OFPATH_STANDALONE
745 int main(int argc, char **argv)
751 printf(_("Usage: %s DEVICE\n"), argv[0]);
755 of_path = grub_util_devname_to_ofpath (argv[1]);
757 printf("%s\n", of_path);