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
21 #define _FILE_OFFSET_BITS 64
33 #include <sys/socket.h>
34 #include <sys/types.h>
35 #include <sys/ioctl.h>
36 #include <linux/sockios.h>
39 #include <linux/ethtool.h>
42 #include "scsi_ioctls.h"
44 #include "efibootmgr.h"
45 #include "efivars_procfs.h"
46 #include "efivars_sysfs.h"
49 static struct efivar_kernel_calls *fs_kernel_calls;
52 load_option_path(EFI_LOAD_OPTION *option)
54 char *p = (char *) option;
55 return (EFI_DEVICE_PATH *)
56 (p + sizeof(uint32_t) /* Attributes */
57 + sizeof(uint16_t) /* FilePathListLength*/
58 + efichar_strsize(option->description)); /* Description */
62 efi_guid_unparse(efi_guid_t *guid, char *out)
64 sprintf(out, "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x",
65 guid->b[3], guid->b[2], guid->b[1], guid->b[0],
66 guid->b[5], guid->b[4], guid->b[7], guid->b[6],
67 guid->b[8], guid->b[9], guid->b[10], guid->b[11],
68 guid->b[12], guid->b[13], guid->b[14], guid->b[15]);
77 snprintf(name, PATH_MAX, "%s", SYSFS_DIR_EFI_VARS);
81 fs_kernel_calls = &sysfs_kernel_calls;
85 snprintf(name, PATH_MAX, "%s", PROCFS_DIR_EFI_VARS);
89 fs_kernel_calls = &procfs_kernel_calls;
92 fprintf(stderr, "Fatal: Couldn't open either sysfs or procfs directories for accessing EFI variables.\n");
93 fprintf(stderr, "Try 'modprobe efivars' as root.\n");
100 write_variable_to_file(efi_variable_t *var)
102 int fd, byteswritten;
103 if (!var || !opts.testfile) return EFI_INVALID_PARAMETER;
105 printf("Test mode: Writing to %s\n", opts.testfile);
106 fd = creat(opts.testfile, S_IRWXU);
108 perror("Couldn't write to testfile");
109 return EFI_INVALID_PARAMETER;
112 byteswritten = write(fd, var, sizeof(*var));
113 if (byteswritten == -1) {
114 perror("Writing to testfile");
122 read_variable(const char *name, efi_variable_t *var)
124 if (!name || !var) return EFI_INVALID_PARAMETER;
125 return fs_kernel_calls->read(name, var);
129 create_variable(efi_variable_t *var)
131 if (!var) return EFI_INVALID_PARAMETER;
132 if (opts.testfile) return write_variable_to_file(var);
133 return fs_kernel_calls->create(var);
137 delete_variable(efi_variable_t *var)
139 if (!var) return EFI_INVALID_PARAMETER;
140 if (opts.testfile) return write_variable_to_file(var);
141 return fs_kernel_calls->delete(var);
146 edit_variable(efi_variable_t *var)
149 if (!var) return EFI_INVALID_PARAMETER;
150 if (opts.testfile) return write_variable_to_file(var);
152 variable_to_name(var, name);
153 return fs_kernel_calls->edit(name, var);
157 create_or_edit_variable(efi_variable_t *var)
159 efi_variable_t testvar;
162 memcpy(&testvar, var, sizeof(*var));
163 variable_to_name(var, name);
165 if (read_variable(name, &testvar) == EFI_SUCCESS)
166 return edit_variable(var);
168 return create_variable(var);
172 select_boot_var_names(const struct dirent *d)
175 rc = sscanf(d->d_name, "Boot0%03x-%*s", &num);
180 read_boot_var_names(struct dirent ***namelist)
182 if (!fs_kernel_calls || !namelist) return -1;
183 return scandir(fs_kernel_calls->path,
184 namelist, select_boot_var_names,
194 efi_guid_t guid = BLKX_UNKNOWN_GUID;
195 char name[80], text_guid[40];
196 ACPI_DEVICE_PATH *path = (ACPI_DEVICE_PATH *)&(var.Data);
199 /* Allow global user option override */
201 switch (opts.edd_version)
203 case 0: /* No EDD information */
206 case 1: /* EDD 1.0 */
209 case 3: /* EDD 3.0 */
217 memset(&var, 0, sizeof(efi_variable_t));
218 efi_guid_unparse(&guid, text_guid);
219 sprintf(name, "blk0-%s", text_guid);
221 status = read_variable(name, &var);
222 if (status != EFI_SUCCESS) {
225 if (path->type == 2 && path->subtype == 1) rc = 3;
231 EFI_DEVICE_PATH, 0x01 (Hardware), 0x04 (Vendor), length 0x0018
232 This needs to know what EFI device has the boot device.
235 make_edd10_device_path(void *dest, uint32_t hardware_device)
237 VENDOR_DEVICE_PATH *hw;
238 char buffer[EDD10_HARDWARE_VENDOR_PATH_LENGTH];
239 efi_guid_t guid = EDD10_HARDWARE_VENDOR_PATH_GUID;
241 memset(buffer, 0, sizeof(buffer));
242 hw = (VENDOR_DEVICE_PATH *)buffer;
243 data = (uint32_t *)hw->data;
244 hw->type = 0x01; /* Hardware Device Path */
245 hw->subtype = 0x04; /* Vendor */
246 hw->length = EDD10_HARDWARE_VENDOR_PATH_LENGTH;
247 memcpy(&(hw->vendor_guid), &guid, sizeof(guid));
248 *data = hardware_device;
249 memcpy(dest, buffer, hw->length);
254 make_end_device_path(void *dest)
257 memset(&p, 0, sizeof(p));
258 p.type = 0x7F; /* End of Hardware Device Path */
259 p.subtype = 0xFF; /* End Entire Device Path */
260 p.length = sizeof(p);
261 memcpy(dest, &p, p.length);
266 make_acpi_device_path(void *dest, uint32_t _HID, uint32_t _UID)
269 memset(&p, 0, sizeof(p));
272 p.length = sizeof(p);
275 memcpy(dest, &p, p.length);
280 make_mac_addr_device_path(void *dest, char *mac, uint8_t iftype)
284 MAC_ADDR_DEVICE_PATH p;
285 memset(&p, 0, sizeof(p));
288 p.length = sizeof(p);
289 for (i=0; i < 14; i++) {
290 p.macaddr[i] = mac[i];
293 memcpy(dest, &p, p.length);
299 struct pci_dev *pci_dev;
300 struct list_head node;
303 static struct device *
304 is_parent_bridge(struct pci_dev *p, unsigned int target_bus)
307 unsigned int primary, secondary;
309 if ( (pci_read_word(p, PCI_HEADER_TYPE) & 0x7f) != PCI_HEADER_TYPE_BRIDGE)
312 primary=pci_read_byte(p, PCI_PRIMARY_BUS);
313 secondary=pci_read_byte(p, PCI_SECONDARY_BUS);
316 if (secondary != target_bus)
319 d = malloc(sizeof(struct device));
322 memset(d, 0, sizeof(*d));
323 INIT_LIST_HEAD(&d->node);
330 static struct device *
331 find_parent(struct pci_access *pacc, unsigned int target_bus)
336 for (p=pacc->devices; p; p=p->next) {
337 dev = is_parent_bridge(p, target_bus);
345 make_one_pci_device_path(void *dest, uint8_t device, uint8_t function)
348 memset(&p, 0, sizeof(p));
351 p.length = sizeof(p);
353 p.function = function;
354 memcpy(dest, &p, p.length);
359 make_pci_device_path(void *dest, uint8_t bus, uint8_t device, uint8_t function)
362 struct pci_access *pacc;
363 struct list_head *pos, *n;
364 LIST_HEAD(pci_parent_list);
375 dev = find_parent(pacc, bus);
377 list_add(&pci_parent_list, &dev->node);
378 bus = dev->pci_dev->bus;
380 } while (dev && bus);
383 list_for_each_safe(pos, n, &pci_parent_list) {
384 dev = list_entry(pos, struct device, node);
385 p += make_one_pci_device_path(p,
388 list_del(&dev->node);
392 p += make_one_pci_device_path(p, device, function);
396 return ((void *)p - dest);
400 make_scsi_device_path(void *dest, uint16_t id, uint16_t lun)
403 memset(&p, 0, sizeof(p));
406 p.length = sizeof(p);
409 memcpy(dest, &p, p.length);
414 make_harddrive_device_path(void *dest, uint32_t num, uint64_t start, uint64_t size,
416 uint8_t mbr_type, uint8_t signature_type)
418 HARDDRIVE_DEVICE_PATH p;
419 memset(&p, 0, sizeof(p));
422 p.length = sizeof(p);
426 if (signature) memcpy(p.signature, signature, 16);
427 p.mbr_type = mbr_type;
428 p.signature_type = signature_type;
429 memcpy(dest, &p, p.length);
434 make_file_path_device_path(void *dest, efi_char16_t *name)
436 FILE_PATH_DEVICE_PATH *p;
438 int namelen = efichar_strlen(name, -1);
439 int namesize = efichar_strsize(name);
441 memset(buffer, 0, sizeof(buffer));
442 p = (FILE_PATH_DEVICE_PATH *)buffer;
445 p->length = 4 + namesize;
446 efichar_strncpy(p->path_name,
449 memcpy(dest, buffer, p->length);
457 make_edd30_device_path(int fd, void *buffer)
460 unsigned char bus=0, device=0, function=0;
462 unsigned char host=0, channel=0, id=0, lun=0;
466 rc = disk_get_pci(fd, &bus, &device, &function);
469 memset(&idlun, 0, sizeof(idlun));
470 rc = get_scsi_idlun(fd, &idlun);
472 idlun_to_components(&idlun, &host, &channel, &id, &lun);
474 p += make_acpi_device_path (p, EISAID_PNP0A03, bus);
475 p += make_pci_device_path (p, bus, device, function);
476 p += make_scsi_device_path (p, id, lun);
477 return ((void *)p - buffer);
481 * make_disk_load_option()
484 * Returns 0 on error, length of load option created on success.
486 char *make_disk_load_option(char *p, char *disk)
491 int rc, edd_version=0;
492 uint8_t mbr_type=0, signature_type=0;
493 uint64_t start=0, size=0;
494 efi_char16_t os_loader_path[40];
496 memset(signature, 0, sizeof(signature));
498 disk_fd = open(opts.disk, O_RDWR);
500 sprintf(buffer, "Could not open disk %s", opts.disk);
505 if (opts.edd_version) {
506 edd_version = get_edd_version();
508 if (edd_version == 3) {
509 p += make_edd30_device_path(disk_fd, p);
511 else if (edd_version == 1) {
512 p += make_edd10_device_path(p, opts.edd10_devicenum);
516 rc = disk_get_partition_info (disk_fd, opts.part,
517 &start, &size, signature,
518 &mbr_type, &signature_type);
523 fprintf(stderr, "Error: no partition information on disk %s.\n"
524 " Cowardly refusing to create a boot option.\n",
529 p += make_harddrive_device_path (p, opts.part,
532 mbr_type, signature_type);
534 efichar_from_char(os_loader_path, opts.loader, sizeof(os_loader_path));
535 p += make_file_path_device_path (p, os_loader_path);
536 p += make_end_device_path (p);
542 * make_net_load_option()
543 * @data - load option returned
545 * Returns 0 on error, length of load option created on success.
547 char *make_net_load_option(char *p, char *iface)
549 /* copied pretty much verbatim from the ethtool source */
553 struct ethtool_drvinfo drvinfo;
555 memset(&ifr, 0, sizeof(ifr));
556 strcpy(ifr.ifr_name, iface);
557 drvinfo.cmd = ETHTOOL_GDRVINFO;
558 ifr.ifr_data = (caddr_t)&drvinfo;
559 /* Open control socket */
560 fd = socket(AF_INET, SOCK_DGRAM, 0);
562 perror("Cannot get control socket");
564 err = ioctl(fd, SIOCETHTOOL, &ifr);
566 perror("Cannot get driver information");
570 err = sscanf(drvinfo.bus_info, "%2x:%2x.%x", &bus, &slot, &func);
572 perror("Couldn't parse device location string.");
575 p += make_acpi_device_path(p, opts.acpi_hid, opts.acpi_uid);
576 p += make_pci_device_path(p, bus, (uint8_t)slot, (uint8_t)func);
578 err = ioctl(fd, SIOCGIFHWADDR, &ifr);
580 perror("Cannot get hardware address.");
583 p += make_mac_addr_device_path(p, ifr.ifr_ifru.ifru_hwaddr.sa_data, 0);
584 p += make_end_device_path (p);
589 * make_linux_load_option()
590 * @data - load option returned
592 * Returns 0 on error, length of load option created on success.
595 make_linux_load_option(void *data)
597 EFI_LOAD_OPTION *load_option = data;
599 efi_char16_t description[64];
600 unsigned long datasize=0;
602 /* Write Attributes */
603 if (opts.active) load_option->attributes = LOAD_OPTION_ACTIVE;
604 else load_option->attributes = 0;
606 p += sizeof(uint32_t);
607 /* skip writing file_path_list_length */
608 p += sizeof(uint16_t);
609 /* Write description. This is the text that appears on the screen for the load option. */
610 memset(description, 0, sizeof(description));
611 efichar_from_char(description, opts.label, sizeof(description));
612 efichar_strncpy(load_option->description, description, sizeof(description));
613 p += efichar_strsize(load_option->description);
618 p = (char *)make_net_load_option(p, opts.iface);
622 p = (char *)make_disk_load_option(p, opts.iface);
625 load_option->file_path_list_length = p - q;
627 datasize = (uint8_t *)p - (uint8_t *)data;
632 * append_extra_args()
633 * appends all arguments from argv[] not snarfed by getopt
634 * as one long string onto data, up to maxchars. allow for nulls
638 append_extra_args_ascii(void *data, unsigned long maxchars)
642 unsigned long usedchars=0;
646 for (i=opts.optind; i < opts.argc && usedchars < maxchars; i++) {
647 p = strncpy(p, opts.argv[i], maxchars-usedchars-1);
651 usedchars = p - (char *)data;
653 /* Put a space between args */
654 if (i < (opts.argc-1)) {
656 p = strncpy(p, " ", maxchars-usedchars-1);
658 usedchars = p - (char *)data;
662 /* Remember the NULL */
663 if (appended) return strlen(data) + 1;
668 append_extra_args_unicode(void *data, unsigned long maxchars)
672 unsigned long usedchars=0;
676 for (i=opts.optind; i < opts.argc && usedchars < maxchars; i++) {
677 p += efichar_from_char((efi_char16_t *)p, opts.argv[i],
679 usedchars = efichar_strsize(data) - sizeof(efi_char16_t);
682 /* Put a space between args */
683 if (i < (opts.argc-1)) {
684 p += efichar_from_char((efi_char16_t *)p, " ",
686 usedchars = efichar_strsize(data) -
687 sizeof(efi_char16_t);
691 if (appended) return efichar_strsize( (efi_char16_t *)data );
697 append_extra_args(void *data, unsigned long maxchars)
700 return append_extra_args_unicode(data, maxchars);
702 return append_extra_args_ascii(data, maxchars);
708 make_linux_efi_variable(efi_variable_t *var,
709 unsigned int free_number)
711 efi_guid_t guid = EFI_GLOBAL_VARIABLE;
713 unsigned char *optional_data=NULL;
714 unsigned long load_option_size = 0, opt_data_size=0;
716 memset(buffer, 0, sizeof(buffer));
718 /* VariableName needs to be BootXXXX */
719 sprintf(buffer, "Boot%04x", free_number);
721 efichar_from_char(var->VariableName, buffer, 1024);
723 memcpy(&(var->VendorGuid), &guid, sizeof(guid));
725 EFI_VARIABLE_NON_VOLATILE |
726 EFI_VARIABLE_BOOTSERVICE_ACCESS |
727 EFI_VARIABLE_RUNTIME_ACCESS;
729 /* Set Data[] and DataSize */
731 load_option_size = make_linux_load_option(var->Data);
733 if (!load_option_size) return 0;
735 /* Set OptionalData (passed as binary to the called app) */
736 optional_data = var->Data + load_option_size;
737 opt_data_size = append_extra_args(optional_data,
738 sizeof(var->Data) - load_option_size);
739 var->DataSize = load_option_size + opt_data_size;
740 return var->DataSize;
745 variable_to_name(efi_variable_t *var, char *name)
748 efichar_to_char(p, var->VariableName, PATH_MAX);
750 p += sprintf(p, "-");
751 efi_guid_unparse(&var->VendorGuid, p);