2 efivars_proc.[ch] - Manipulates EFI variables as exported in /proc/efi/vars
4 Copyright (C) 2001,2003 Dell Computer Corporation <Matt_Domsch@dell.com>
6 This program 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 2 of the License, or
9 (at your option) any later version.
11 This program 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 this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
32 #include <sys/socket.h>
33 #include <sys/types.h>
34 #include <sys/ioctl.h>
35 #include <linux/sockios.h>
36 #include <linux/types.h>
39 #include <asm/types.h>
40 #include <linux/ethtool.h>
43 #include "scsi_ioctls.h"
45 #include "efibootmgr.h"
46 #include "efivars_procfs.h"
47 #include "efivars_sysfs.h"
50 static struct efivar_kernel_calls *fs_kernel_calls;
53 load_option_path(EFI_LOAD_OPTION *option)
55 char *p = (char *) option;
56 return (EFI_DEVICE_PATH *)
57 (p + sizeof(uint32_t) /* Attributes */
58 + sizeof(uint16_t) /* FilePathListLength*/
59 + efichar_strsize(option->description)); /* Description */
63 efi_guid_unparse(efi_guid_t *guid, char *out)
65 sprintf(out, "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x",
66 guid->b[3], guid->b[2], guid->b[1], guid->b[0],
67 guid->b[5], guid->b[4], guid->b[7], guid->b[6],
68 guid->b[8], guid->b[9], guid->b[10], guid->b[11],
69 guid->b[12], guid->b[13], guid->b[14], guid->b[15]);
78 snprintf(name, PATH_MAX, "%s", SYSFS_DIR_EFI_VARS);
82 fs_kernel_calls = &sysfs_kernel_calls;
86 snprintf(name, PATH_MAX, "%s", PROCFS_DIR_EFI_VARS);
90 fs_kernel_calls = &procfs_kernel_calls;
93 fprintf(stderr, "Fatal: Couldn't open either sysfs or procfs directories for accessing EFI variables.\n");
94 fprintf(stderr, "Try 'modprobe efivars' as root.\n");
101 write_variable_to_file(efi_variable_t *var)
103 int fd, byteswritten;
104 if (!var || !opts.testfile) return EFI_INVALID_PARAMETER;
106 printf("Test mode: Writing to %s\n", opts.testfile);
107 fd = creat(opts.testfile, S_IRWXU);
109 perror("Couldn't write to testfile");
110 return EFI_INVALID_PARAMETER;
113 byteswritten = write(fd, var, sizeof(*var));
114 if (byteswritten == -1) {
115 perror("Writing to testfile");
123 read_variable(const char *name, efi_variable_t *var)
125 if (!name || !var) return EFI_INVALID_PARAMETER;
126 return fs_kernel_calls->read(name, var);
130 create_variable(efi_variable_t *var)
132 if (!var) return EFI_INVALID_PARAMETER;
133 if (opts.testfile) return write_variable_to_file(var);
134 return fs_kernel_calls->create(var);
138 delete_variable(efi_variable_t *var)
140 if (!var) return EFI_INVALID_PARAMETER;
141 if (opts.testfile) return write_variable_to_file(var);
142 return fs_kernel_calls->delete(var);
147 edit_variable(efi_variable_t *var)
150 if (!var) return EFI_INVALID_PARAMETER;
151 if (opts.testfile) return write_variable_to_file(var);
153 variable_to_name(var, name);
154 return fs_kernel_calls->edit(name, var);
158 create_or_edit_variable(efi_variable_t *var)
160 efi_variable_t testvar;
163 memcpy(&testvar, var, sizeof(*var));
164 variable_to_name(var, name);
166 if (read_variable(name, &testvar) == EFI_SUCCESS)
167 return edit_variable(var);
169 return create_variable(var);
173 select_boot_var_names(const struct dirent *d)
175 if (!strncmp(d->d_name, "Boot", 4) &&
176 isxdigit(d->d_name[4]) && isxdigit(d->d_name[5]) &&
177 isxdigit(d->d_name[6]) && isxdigit(d->d_name[7]) &&
184 read_boot_var_names(struct dirent ***namelist)
186 if (!fs_kernel_calls || !namelist) return -1;
187 return scandir(fs_kernel_calls->path,
188 namelist, select_boot_var_names,
198 efi_guid_t guid = BLKX_UNKNOWN_GUID;
199 char name[80], text_guid[40];
200 ACPI_DEVICE_PATH *path = (ACPI_DEVICE_PATH *)&(var.Data);
203 /* Allow global user option override */
205 switch (opts.edd_version)
207 case 0: /* No EDD information */
210 case 1: /* EDD 1.0 */
213 case 3: /* EDD 3.0 */
221 memset(&var, 0, sizeof(efi_variable_t));
222 efi_guid_unparse(&guid, text_guid);
223 sprintf(name, "blk0-%s", text_guid);
225 status = read_variable(name, &var);
226 if (status != EFI_SUCCESS) {
229 if (path->type == 2 && path->subtype == 1) rc = 3;
235 EFI_DEVICE_PATH, 0x01 (Hardware), 0x04 (Vendor), length 0x0018
236 This needs to know what EFI device has the boot device.
239 make_edd10_device_path(void *dest, uint32_t hardware_device)
241 VENDOR_DEVICE_PATH *hw;
242 char buffer[EDD10_HARDWARE_VENDOR_PATH_LENGTH];
243 efi_guid_t guid = EDD10_HARDWARE_VENDOR_PATH_GUID;
245 memset(buffer, 0, sizeof(buffer));
246 hw = (VENDOR_DEVICE_PATH *)buffer;
247 data = (uint32_t *)hw->data;
248 hw->type = 0x01; /* Hardware Device Path */
249 hw->subtype = 0x04; /* Vendor */
250 hw->length = EDD10_HARDWARE_VENDOR_PATH_LENGTH;
251 memcpy(&(hw->vendor_guid), &guid, sizeof(guid));
252 *data = hardware_device;
253 memcpy(dest, buffer, hw->length);
258 make_end_device_path(void *dest)
261 memset(&p, 0, sizeof(p));
262 p.type = 0x7F; /* End of Hardware Device Path */
263 p.subtype = 0xFF; /* End Entire Device Path */
264 p.length = sizeof(p);
265 memcpy(dest, &p, p.length);
270 make_acpi_device_path(void *dest, uint32_t _HID, uint32_t _UID)
273 memset(&p, 0, sizeof(p));
276 p.length = sizeof(p);
279 memcpy(dest, &p, p.length);
284 make_mac_addr_device_path(void *dest, char *mac, uint8_t iftype)
288 MAC_ADDR_DEVICE_PATH p;
289 memset(&p, 0, sizeof(p));
292 p.length = sizeof(p);
293 for (i=0; i < 14; i++) {
294 p.macaddr[i] = mac[i];
297 memcpy(dest, &p, p.length);
303 struct pci_dev *pci_dev;
304 struct list_head node;
307 static struct device *
308 is_parent_bridge(struct pci_dev *p, unsigned int target_bus)
311 unsigned int primary, secondary;
313 if ( (pci_read_word(p, PCI_HEADER_TYPE) & 0x7f) != PCI_HEADER_TYPE_BRIDGE)
316 primary=pci_read_byte(p, PCI_PRIMARY_BUS);
317 secondary=pci_read_byte(p, PCI_SECONDARY_BUS);
320 if (secondary != target_bus)
323 d = malloc(sizeof(struct device));
326 memset(d, 0, sizeof(*d));
327 INIT_LIST_HEAD(&d->node);
334 static struct device *
335 find_parent(struct pci_access *pacc, unsigned int target_bus)
340 for (p=pacc->devices; p; p=p->next) {
341 dev = is_parent_bridge(p, target_bus);
349 make_one_pci_device_path(void *dest, uint8_t device, uint8_t function)
352 memset(&p, 0, sizeof(p));
355 p.length = sizeof(p);
357 p.function = function;
358 memcpy(dest, &p, p.length);
363 make_pci_device_path(void *dest, uint8_t bus, uint8_t device, uint8_t function)
366 struct pci_access *pacc;
367 struct list_head *pos, *n;
368 LIST_HEAD(pci_parent_list);
379 dev = find_parent(pacc, bus);
381 list_add(&pci_parent_list, &dev->node);
382 bus = dev->pci_dev->bus;
384 } while (dev && bus);
387 list_for_each_safe(pos, n, &pci_parent_list) {
388 dev = list_entry(pos, struct device, node);
389 p += make_one_pci_device_path(p,
392 list_del(&dev->node);
396 p += make_one_pci_device_path(p, device, function);
400 return ((void *)p - dest);
404 make_scsi_device_path(void *dest, uint16_t id, uint16_t lun)
407 memset(&p, 0, sizeof(p));
410 p.length = sizeof(p);
413 memcpy(dest, &p, p.length);
418 make_harddrive_device_path(void *dest, uint32_t num, uint64_t start, uint64_t size,
420 uint8_t mbr_type, uint8_t signature_type)
422 HARDDRIVE_DEVICE_PATH p;
423 memset(&p, 0, sizeof(p));
426 p.length = sizeof(p);
430 if (signature) memcpy(p.signature, signature, 16);
431 p.mbr_type = mbr_type;
432 p.signature_type = signature_type;
433 memcpy(dest, &p, p.length);
438 make_file_path_device_path(void *dest, efi_char16_t *name)
440 FILE_PATH_DEVICE_PATH *p;
442 int namelen = efichar_strlen(name, -1);
443 int namesize = efichar_strsize(name);
445 memset(buffer, 0, sizeof(buffer));
446 p = (FILE_PATH_DEVICE_PATH *)buffer;
449 p->length = 4 + namesize;
450 efichar_strncpy(p->path_name,
453 memcpy(dest, buffer, p->length);
461 make_edd30_device_path(int fd, void *buffer)
464 unsigned char bus=0, device=0, function=0;
466 unsigned char host=0, channel=0, id=0, lun=0;
470 rc = disk_get_pci(fd, &bus, &device, &function);
473 memset(&idlun, 0, sizeof(idlun));
474 rc = get_scsi_idlun(fd, &idlun);
476 idlun_to_components(&idlun, &host, &channel, &id, &lun);
478 p += make_acpi_device_path (p, EISAID_PNP0A03, bus);
479 p += make_pci_device_path (p, bus, device, function);
480 p += make_scsi_device_path (p, id, lun);
481 return ((void *)p - buffer);
485 * make_disk_load_option()
488 * Returns 0 on error, length of load option created on success.
490 char *make_disk_load_option(char *p, char *disk)
495 int rc, edd_version=0;
496 uint8_t mbr_type=0, signature_type=0;
497 uint64_t start=0, size=0;
498 efi_char16_t os_loader_path[40];
500 memset(signature, 0, sizeof(signature));
502 disk_fd = open(opts.disk, O_RDWR);
504 sprintf(buffer, "Could not open disk %s", opts.disk);
509 if (opts.edd_version) {
510 edd_version = get_edd_version();
512 if (edd_version == 3) {
513 p += make_edd30_device_path(disk_fd, p);
515 else if (edd_version == 1) {
516 p += make_edd10_device_path(p, opts.edd10_devicenum);
520 rc = disk_get_partition_info (disk_fd, opts.part,
521 &start, &size, signature,
522 &mbr_type, &signature_type);
527 fprintf(stderr, "Error: no partition information on disk %s.\n"
528 " Cowardly refusing to create a boot option.\n",
533 p += make_harddrive_device_path (p, opts.part,
536 mbr_type, signature_type);
538 efichar_from_char(os_loader_path, opts.loader, sizeof(os_loader_path));
539 p += make_file_path_device_path (p, os_loader_path);
540 p += make_end_device_path (p);
546 * make_net_load_option()
547 * @data - load option returned
549 * Returns NULL on error, or p advanced by length of load option
550 * created on success.
552 char *make_net_load_option(char *p, char *iface)
554 /* copied pretty much verbatim from the ethtool source */
558 struct ethtool_drvinfo drvinfo;
560 memset(&ifr, 0, sizeof(ifr));
561 strcpy(ifr.ifr_name, iface);
562 drvinfo.cmd = ETHTOOL_GDRVINFO;
563 ifr.ifr_data = (caddr_t)&drvinfo;
564 /* Open control socket */
565 fd = socket(AF_INET, SOCK_DGRAM, 0);
567 perror("Cannot get control socket");
570 err = ioctl(fd, SIOCETHTOOL, &ifr);
572 perror("Cannot get driver information");
576 /* The domain part was added in 2.6 kernels. Test for that first. */
577 err = sscanf(drvinfo.bus_info, "%*x:%2x:%2x.%x", &bus, &slot, &func);
579 err = sscanf(drvinfo.bus_info, "%2x:%2x.%x", &bus, &slot, &func);
581 perror("Couldn't parse device location string.");
586 err = ioctl(fd, SIOCGIFHWADDR, &ifr);
588 perror("Cannot get hardware address.");
592 p += make_acpi_device_path(p, opts.acpi_hid, opts.acpi_uid);
593 p += make_pci_device_path(p, bus, (uint8_t)slot, (uint8_t)func);
594 p += make_mac_addr_device_path(p, ifr.ifr_ifru.ifru_hwaddr.sa_data, 0);
595 p += make_end_device_path (p);
602 * make_linux_load_option()
603 * @data - load option returned
605 * Returns 0 on error, length of load option created on success.
608 make_linux_load_option(void *data)
610 EFI_LOAD_OPTION *load_option = data;
612 efi_char16_t description[64];
613 unsigned long datasize=0;
615 /* Write Attributes */
616 if (opts.active) load_option->attributes = LOAD_OPTION_ACTIVE;
617 else load_option->attributes = 0;
619 p += sizeof(uint32_t);
620 /* skip writing file_path_list_length */
621 p += sizeof(uint16_t);
622 /* Write description. This is the text that appears on the screen for the load option. */
623 memset(description, 0, sizeof(description));
624 efichar_from_char(description, opts.label, sizeof(description));
625 efichar_strncpy(load_option->description, description, sizeof(description));
626 p += efichar_strsize(load_option->description);
631 p = (char *)make_net_load_option(p, opts.iface);
634 p = (char *)make_disk_load_option(p, opts.iface);
639 load_option->file_path_list_length = p - q;
641 datasize = (uint8_t *)p - (uint8_t *)data;
646 * append_extra_args()
647 * appends all arguments from argv[] not snarfed by getopt
648 * as one long string onto data, up to maxchars. allow for nulls
652 append_extra_args_ascii(void *data, unsigned long maxchars)
656 unsigned long usedchars=0;
660 for (i=opts.optind; i < opts.argc && usedchars < maxchars; i++) {
661 p = strncpy(p, opts.argv[i], maxchars-usedchars-1);
665 usedchars = p - (char *)data;
667 /* Put a space between args */
668 if (i < (opts.argc-1)) {
670 p = strncpy(p, " ", maxchars-usedchars-1);
672 usedchars = p - (char *)data;
676 /* Remember the NULL */
677 if (appended) return strlen(data) + 1;
682 append_extra_args_unicode(void *data, unsigned long maxchars)
686 unsigned long usedchars=0;
690 for (i=opts.optind; i < opts.argc && usedchars < maxchars; i++) {
691 p += efichar_from_char((efi_char16_t *)p, opts.argv[i],
693 usedchars = efichar_strsize(data) - sizeof(efi_char16_t);
696 /* Put a space between args */
697 if (i < (opts.argc-1)) {
698 p += efichar_from_char((efi_char16_t *)p, " ",
700 usedchars = efichar_strsize(data) -
701 sizeof(efi_char16_t);
705 if (appended) return efichar_strsize( (efi_char16_t *)data );
710 append_extra_args_file(void *data, unsigned long maxchars)
713 char *file = opts.extra_opts_file;
714 int fd = STDIN_FILENO;
716 unsigned long appended=0;
720 if (file && strncmp(file, "-", 1))
721 fd = open(file, O_RDONLY);
724 perror("Failed to open extra arguments file");
729 num_read = read(fd, p, maxchars - appended);
731 perror("Error reading extra arguments file");
734 else if (num_read>0) {
735 appended += num_read;
738 } while (num_read > 0 && ((maxchars - appended) > 0));
740 if (fd != STDIN_FILENO)
748 append_extra_args(void *data, unsigned long maxchars)
750 unsigned long bytes_written=0;
752 if (opts.extra_opts_file)
753 bytes_written += append_extra_args_file(data, maxchars);
756 bytes_written += append_extra_args_unicode(data, maxchars - bytes_written);
758 bytes_written += append_extra_args_ascii(data, maxchars - bytes_written);
759 return bytes_written;
765 make_linux_efi_variable(efi_variable_t *var,
766 unsigned int free_number)
768 efi_guid_t guid = EFI_GLOBAL_VARIABLE;
770 unsigned char *optional_data=NULL;
771 unsigned long load_option_size = 0, opt_data_size=0;
773 memset(buffer, 0, sizeof(buffer));
775 /* VariableName needs to be BootXXXX */
776 sprintf(buffer, "Boot%04X", free_number);
778 efichar_from_char(var->VariableName, buffer, 1024);
780 memcpy(&(var->VendorGuid), &guid, sizeof(guid));
782 EFI_VARIABLE_NON_VOLATILE |
783 EFI_VARIABLE_BOOTSERVICE_ACCESS |
784 EFI_VARIABLE_RUNTIME_ACCESS;
786 /* Set Data[] and DataSize */
788 load_option_size = make_linux_load_option(var->Data);
790 if (!load_option_size) return 0;
792 /* Set OptionalData (passed as binary to the called app) */
793 optional_data = var->Data + load_option_size;
794 opt_data_size = append_extra_args(optional_data,
795 sizeof(var->Data) - load_option_size);
796 var->DataSize = load_option_size + opt_data_size;
797 return var->DataSize;
802 variable_to_name(efi_variable_t *var, char *name)
805 efichar_to_char(p, var->VariableName, PATH_MAX);
807 p += sprintf(p, "-");
808 efi_guid_unparse(&var->VendorGuid, p);