drivers/firmware/efi/efivars.c

   1 /*
   2  * Originally from efivars.c,
   3  *
   4  * Copyright (C) 2001,2003,2004 Dell <Matt_Domsch@dell.com>
   5  * Copyright (C) 2004 Intel Corporation <matthew.e.tolentino@intel.com>
   6  *
   7  * This code takes all variables accessible from EFI runtime and
   8  *  exports them via sysfs
   9  *
  10  *  This program is free software; you can redistribute it and/or modify
  11  *  it under the terms of the GNU General Public License as published by
  12  *  the Free Software Foundation; either version 2 of the License, or
  13  *  (at your option) any later version.
  14  *
  15  *  This program is distributed in the hope that it will be useful,
  16  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  *  GNU General Public License for more details.
  19  *
  20  *  You should have received a copy of the GNU General Public License
  21  *  along with this program; if not, write to the Free Software
  22  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  23  *
  24  * Changelog:
  25  *
  26  *  17 May 2004 - Matt Domsch <Matt_Domsch@dell.com>
  27  *   remove check for efi_enabled in exit
  28  *   add MODULE_VERSION
  29  *
  30  *  26 Apr 2004 - Matt Domsch <Matt_Domsch@dell.com>
  31  *   minor bug fixes
  32  *
  33  *  21 Apr 2004 - Matt Tolentino <matthew.e.tolentino@intel.com)
  34  *   converted driver to export variable information via sysfs
  35  *   and moved to drivers/firmware directory
  36  *   bumped revision number to v0.07 to reflect conversion & move
  37  *
  38  *  10 Dec 2002 - Matt Domsch <Matt_Domsch@dell.com>
  39  *   fix locking per Peter Chubb's findings
  40  *
  41  *  25 Mar 2002 - Matt Domsch <Matt_Domsch@dell.com>
  42  *   move uuid_unparse() to include/asm-ia64/efi.h:efi_guid_unparse()
  43  *
  44  *  12 Feb 2002 - Matt Domsch <Matt_Domsch@dell.com>
  45  *   use list_for_each_safe when deleting vars.
  46  *   remove ifdef CONFIG_SMP around include <linux/smp.h>
  47  *   v0.04 release to linux-ia64@linuxia64.org
  48  *
  49  *  20 April 2001 - Matt Domsch <Matt_Domsch@dell.com>
  50  *   Moved vars from /proc/efi to /proc/efi/vars, and made
  51  *   efi.c own the /proc/efi directory.
  52  *   v0.03 release to linux-ia64@linuxia64.org
  53  *
  54  *  26 March 2001 - Matt Domsch <Matt_Domsch@dell.com>
  55  *   At the request of Stephane, moved ownership of /proc/efi
  56  *   to efi.c, and now efivars lives under /proc/efi/vars.
  57  *
  58  *  12 March 2001 - Matt Domsch <Matt_Domsch@dell.com>
  59  *   Feedback received from Stephane Eranian incorporated.
  60  *   efivar_write() checks copy_from_user() return value.
  61  *   efivar_read/write() returns proper errno.
  62  *   v0.02 release to linux-ia64@linuxia64.org
  63  *
  64  *  26 February 2001 - Matt Domsch <Matt_Domsch@dell.com>
  65  *   v0.01 release to linux-ia64@linuxia64.org
  66  */
  67
  68 #include <linux/efi.h>
  69 #include <linux/module.h>
  70 #include <linux/slab.h>
  71 #include <linux/ucs2_string.h>
  72
  73 #define EFIVARS_VERSION "0.08"
  74 #define EFIVARS_DATE "2004-May-17"
  75
  76 MODULE_AUTHOR("Matt Domsch <Matt_Domsch@Dell.com>");
  77 MODULE_DESCRIPTION("sysfs interface to EFI Variables");
  78 MODULE_LICENSE("GPL");
  79 MODULE_VERSION(EFIVARS_VERSION);
  80
  81 LIST_HEAD(efivar_sysfs_list);
  82 EXPORT_SYMBOL_GPL(efivar_sysfs_list);
  83
  84 static struct kset *efivars_kset;
  85
  86 static struct bin_attribute *efivars_new_var;
  87 static struct bin_attribute *efivars_del_var;
  88
  89 struct efivar_attribute {
  90         struct attribute attr;
  91         ssize_t (*show) (struct efivar_entry *entry, char *buf);
  92         ssize_t (*store)(struct efivar_entry *entry, const char *buf, size_t count);
  93 };
  94
  95 #define EFIVAR_ATTR(_name, _mode, _show, _store) \
  96 struct efivar_attribute efivar_attr_##_name = { \
  97         .attr = {.name = __stringify(_name), .mode = _mode}, \
  98         .show = _show, \
  99         .store = _store, \
 100 };
 101
 102 #define to_efivar_attr(_attr) container_of(_attr, struct efivar_attribute, attr)
 103 #define to_efivar_entry(obj)  container_of(obj, struct efivar_entry, kobj)
 104
 105 /*
 106  * Prototype for sysfs creation function
 107  */
 108 static int
 109 efivar_create_sysfs_entry(struct efivar_entry *new_var);
 110
 111 static ssize_t
 112 efivar_guid_read(struct efivar_entry *entry, char *buf)
 113 {
 114         struct efi_variable *var = &entry->var;
 115         char *str = buf;
 116
 117         if (!entry || !buf)
 118                 return 0;
 119
 120         efi_guid_unparse(&var->VendorGuid, str);
 121         str += strlen(str);
 122         str += sprintf(str, "\n");
 123
 124         return str - buf;
 125 }
 126
 127 static ssize_t
 128 efivar_attr_read(struct efivar_entry *entry, char *buf)
 129 {
 130         struct efi_variable *var = &entry->var;
 131         char *str = buf;
 132
 133         if (!entry || !buf)
 134                 return -EINVAL;
 135
 136         var->DataSize = 1024;
 137         if (efivar_entry_get(entry, &var->Attributes, &var->DataSize, var->Data))
 138                 return -EIO;
 139
 140         if (var->Attributes & EFI_VARIABLE_NON_VOLATILE)
 141                 str += sprintf(str, "EFI_VARIABLE_NON_VOLATILE\n");
 142         if (var->Attributes & EFI_VARIABLE_BOOTSERVICE_ACCESS)
 143                 str += sprintf(str, "EFI_VARIABLE_BOOTSERVICE_ACCESS\n");
 144         if (var->Attributes & EFI_VARIABLE_RUNTIME_ACCESS)
 145                 str += sprintf(str, "EFI_VARIABLE_RUNTIME_ACCESS\n");
 146         if (var->Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD)
 147                 str += sprintf(str, "EFI_VARIABLE_HARDWARE_ERROR_RECORD\n");
 148         if (var->Attributes & EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS)
 149                 str += sprintf(str,
 150                         "EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS\n");
 151         if (var->Attributes &
 152                         EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS)
 153                 str += sprintf(str,
 154                         "EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS\n");
 155         if (var->Attributes & EFI_VARIABLE_APPEND_WRITE)
 156                 str += sprintf(str, "EFI_VARIABLE_APPEND_WRITE\n");
 157         return str - buf;
 158 }
 159
 160 static ssize_t
 161 efivar_size_read(struct efivar_entry *entry, char *buf)
 162 {
 163         struct efi_variable *var = &entry->var;
 164         char *str = buf;
 165
 166         if (!entry || !buf)
 167                 return -EINVAL;
 168
 169         var->DataSize = 1024;
 170         if (efivar_entry_get(entry, &var->Attributes, &var->DataSize, var->Data))
 171                 return -EIO;
 172
 173         str += sprintf(str, "0x%lx\n", var->DataSize);
 174         return str - buf;
 175 }
 176
 177 static ssize_t
 178 efivar_data_read(struct efivar_entry *entry, char *buf)
 179 {
 180         struct efi_variable *var = &entry->var;
 181
 182         if (!entry || !buf)
 183                 return -EINVAL;
 184
 185         var->DataSize = 1024;
 186         if (efivar_entry_get(entry, &var->Attributes, &var->DataSize, var->Data))
 187                 return -EIO;
 188
 189         memcpy(buf, var->Data, var->DataSize);
 190         return var->DataSize;
 191 }
 192 /*
 193  * We allow each variable to be edited via rewriting the
 194  * entire efi variable structure.
 195  */
 196 static ssize_t
 197 efivar_store_raw(struct efivar_entry *entry, const char *buf, size_t count)
 198 {
 199         struct efi_variable *new_var, *var = &entry->var;
 200         efi_char16_t *name;
 201         unsigned long size;
 202         efi_guid_t vendor;
 203         u32 attributes;
 204         u8 *data;
 205         int err;
 206
 207         if (count != sizeof(struct efi_variable))
 208                 return -EINVAL;
 209
 210         new_var = (struct efi_variable *)buf;
 211
 212         attributes = new_var->Attributes;
 213         vendor = new_var->VendorGuid;
 214         name = new_var->VariableName;
 215         size = new_var->DataSize;
 216         data = new_var->Data;
 217
 218         /*
 219          * If only updating the variable data, then the name
 220          * and guid should remain the same
 221          */
 222         if (memcmp(name, var->VariableName, sizeof(var->VariableName)) ||
 223                 efi_guidcmp(vendor, var->VendorGuid)) {
 224                 printk(KERN_ERR "efivars: Cannot edit the wrong variable!\n");
 225                 return -EINVAL;
 226         }
 227
 228         if ((size <= 0) || (attributes == 0)){
 229                 printk(KERN_ERR "efivars: DataSize & Attributes must be valid!\n");
 230                 return -EINVAL;
 231         }
 232
 233         if ((attributes & ~EFI_VARIABLE_MASK) != 0 ||
 234             efivar_validate(new_var, data, size) == false) {
 235                 printk(KERN_ERR "efivars: Malformed variable content\n");
 236                 return -EINVAL;
 237         }
 238
 239         memcpy(&entry->var, new_var, count);
 240
 241         err = efivar_entry_set(entry, attributes, size, data, NULL);
 242         if (err) {
 243                 printk(KERN_WARNING "efivars: set_variable() failed: status=%d\n", err);
 244                 return -EIO;
 245         }
 246
 247         return count;
 248 }
 249
 250 static ssize_t
 251 efivar_show_raw(struct efivar_entry *entry, char *buf)
 252 {
 253         struct efi_variable *var = &entry->var;
 254
 255         if (!entry || !buf)
 256                 return 0;
 257
 258         var->DataSize = 1024;
 259         if (efivar_entry_get(entry, &entry->var.Attributes,
 260                              &entry->var.DataSize, entry->var.Data))
 261                 return -EIO;
 262
 263         memcpy(buf, var, sizeof(*var));
 264
 265         return sizeof(*var);
 266 }
 267
 268 /*
 269  * Generic read/write functions that call the specific functions of
 270  * the attributes...
 271  */
 272 static ssize_t efivar_attr_show(struct kobject *kobj, struct attribute *attr,
 273                                 char *buf)
 274 {
 275         struct efivar_entry *var = to_efivar_entry(kobj);
 276         struct efivar_attribute *efivar_attr = to_efivar_attr(attr);
 277         ssize_t ret = -EIO;
 278
 279         if (!capable(CAP_SYS_ADMIN))
 280                 return -EACCES;
 281
 282         if (efivar_attr->show) {
 283                 ret = efivar_attr->show(var, buf);
 284         }
 285         return ret;
 286 }
 287
 288 static ssize_t efivar_attr_store(struct kobject *kobj, struct attribute *attr,
 289                                 const char *buf, size_t count)
 290 {
 291         struct efivar_entry *var = to_efivar_entry(kobj);
 292         struct efivar_attribute *efivar_attr = to_efivar_attr(attr);
 293         ssize_t ret = -EIO;
 294
 295         if (!capable(CAP_SYS_ADMIN))
 296                 return -EACCES;
 297
 298         if (efivar_attr->store)
 299                 ret = efivar_attr->store(var, buf, count);
 300
 301         return ret;
 302 }
 303
 304 static const struct sysfs_ops efivar_attr_ops = {
 305         .show = efivar_attr_show,
 306         .store = efivar_attr_store,
 307 };
 308
 309 static void efivar_release(struct kobject *kobj)
 310 {
 311         struct efivar_entry *var = container_of(kobj, struct efivar_entry, kobj);
 312         kfree(var);
 313 }
 314
 315 static EFIVAR_ATTR(guid, 0400, efivar_guid_read, NULL);
 316 static EFIVAR_ATTR(attributes, 0400, efivar_attr_read, NULL);
 317 static EFIVAR_ATTR(size, 0400, efivar_size_read, NULL);
 318 static EFIVAR_ATTR(data, 0400, efivar_data_read, NULL);
 319 static EFIVAR_ATTR(raw_var, 0600, efivar_show_raw, efivar_store_raw);
 320
 321 static struct attribute *def_attrs[] = {
 322         &efivar_attr_guid.attr,
 323         &efivar_attr_size.attr,
 324         &efivar_attr_attributes.attr,
 325         &efivar_attr_data.attr,
 326         &efivar_attr_raw_var.attr,
 327         NULL,
 328 };
 329
 330 static struct kobj_type efivar_ktype = {
 331         .release = efivar_release,
 332         .sysfs_ops = &efivar_attr_ops,
 333         .default_attrs = def_attrs,
 334 };
 335
 336 static ssize_t efivar_create(struct file *filp, struct kobject *kobj,
 337                              struct bin_attribute *bin_attr,
 338                              char *buf, loff_t pos, size_t count)
 339 {
 340         struct efi_variable *new_var = (struct efi_variable *)buf;
 341         struct efivar_entry *new_entry;
 342         unsigned long size;
 343         u32 attributes;
 344         u8 *data;
 345         int err;
 346
 347         if (!capable(CAP_SYS_ADMIN))
 348                 return -EACCES;
 349
 350         if (count != sizeof(*new_var))
 351                 return -EINVAL;
 352
 353         attributes = new_var->Attributes;
 354         size = new_var->DataSize;
 355         data = new_var->Data;
 356
 357         if ((attributes & ~EFI_VARIABLE_MASK) != 0 ||
 358             efivar_validate(new_var, data, size) == false) {
 359                 printk(KERN_ERR "efivars: Malformed variable content\n");
 360                 return -EINVAL;
 361         }
 362
 363         new_entry = kzalloc(sizeof(*new_entry), GFP_KERNEL);
 364         if (!new_entry)
 365                 return -ENOMEM;
 366
 367         memcpy(&new_entry->var, new_var, sizeof(*new_var));
 368
 369         err = efivar_entry_set(new_entry, attributes, size,
 370                                data, &efivar_sysfs_list);
 371         if (err) {
 372                 if (err == -EEXIST)
 373                         err = -EINVAL;
 374                 goto out;
 375         }
 376
 377         if (efivar_create_sysfs_entry(new_entry)) {
 378                 printk(KERN_WARNING "efivars: failed to create sysfs entry.\n");
 379                 kfree(new_entry);
 380         }
 381         return count;
 382
 383 out:
 384         kfree(new_entry);
 385         return err;
 386 }
 387
 388 static ssize_t efivar_delete(struct file *filp, struct kobject *kobj,
 389                              struct bin_attribute *bin_attr,
 390                              char *buf, loff_t pos, size_t count)
 391 {
 392         struct efi_variable *del_var = (struct efi_variable *)buf;
 393         struct efivar_entry *entry;
 394         efi_char16_t *name;
 395         efi_guid_t vendor;
 396         int err = 0;
 397
 398         if (!capable(CAP_SYS_ADMIN))
 399                 return -EACCES;
 400
 401         if (count != sizeof(*del_var))
 402                 return -EINVAL;
 403
 404         name = del_var->VariableName;
 405         vendor = del_var->VendorGuid;
 406
 407         efivar_entry_iter_begin();
 408         entry = efivar_entry_find(name, vendor, &efivar_sysfs_list, true);
 409         if (!entry)
 410                 err = -EINVAL;
 411         else if (__efivar_entry_delete(entry))
 412                 err = -EIO;
 413
 414         if (err) {
 415                 efivar_entry_iter_end();
 416                 return err;
 417         }
 418
 419         if (!entry->scanning) {
 420                 efivar_entry_iter_end();
 421                 efivar_unregister(entry);
 422         } else
 423                 efivar_entry_iter_end();
 424
 425         /* It's dead Jim.... */
 426         return count;
 427 }
 428
 429 /**
 430  * efivar_create_sysfs_entry - create a new entry in sysfs
 431  * @new_var: efivar entry to create
 432  *
 433  * Returns 1 on failure, 0 on success
 434  */
 435 static int
 436 efivar_create_sysfs_entry(struct efivar_entry *new_var)
 437 {
 438         int i, short_name_size;
 439         char *short_name;
 440         unsigned long variable_name_size;
 441         efi_char16_t *variable_name;
 442
 443         variable_name = new_var->var.VariableName;
 444         variable_name_size = ucs2_strlen(variable_name) * sizeof(efi_char16_t);
 445
 446         /*
 447          * Length of the variable bytes in ASCII, plus the '-' separator,
 448          * plus the GUID, plus trailing NUL
 449          */
 450         short_name_size = variable_name_size / sizeof(efi_char16_t)
 451                                 + 1 + EFI_VARIABLE_GUID_LEN + 1;
 452
 453         short_name = kzalloc(short_name_size, GFP_KERNEL);
 454
 455         if (!short_name)
 456                 return 1;
 457
 458         /* Convert Unicode to normal chars (assume top bits are 0),
 459            ala UTF-8 */
 460         for (i=0; i < (int)(variable_name_size / sizeof(efi_char16_t)); i++) {
 461                 short_name[i] = variable_name[i] & 0xFF;
 462         }
 463         /* This is ugly, but necessary to separate one vendor's
 464            private variables from another's.         */
 465
 466         *(short_name + strlen(short_name)) = '-';
 467         efi_guid_unparse(&new_var->var.VendorGuid,
 468                          short_name + strlen(short_name));
 469
 470         new_var->kobj.kset = efivars_kset;
 471
 472         i = kobject_init_and_add(&new_var->kobj, &efivar_ktype,
 473                                    NULL, "%s", short_name);
 474         kfree(short_name);
 475         if (i)
 476                 return 1;
 477
 478         kobject_uevent(&new_var->kobj, KOBJ_ADD);
 479         efivar_entry_add(new_var, &efivar_sysfs_list);
 480
 481         return 0;
 482 }
 483
 484 static int
 485 create_efivars_bin_attributes(void)
 486 {
 487         struct bin_attribute *attr;
 488         int error;
 489
 490         /* new_var */
 491         attr = kzalloc(sizeof(*attr), GFP_KERNEL);
 492         if (!attr)
 493                 return -ENOMEM;
 494
 495         attr->attr.name = "new_var";
 496         attr->attr.mode = 0200;
 497         attr->write = efivar_create;
 498         efivars_new_var = attr;
 499
 500         /* del_var */
 501         attr = kzalloc(sizeof(*attr), GFP_KERNEL);
 502         if (!attr) {
 503                 error = -ENOMEM;
 504                 goto out_free;
 505         }
 506         attr->attr.name = "del_var";
 507         attr->attr.mode = 0200;
 508         attr->write = efivar_delete;
 509         efivars_del_var = attr;
 510
 511         sysfs_bin_attr_init(efivars_new_var);
 512         sysfs_bin_attr_init(efivars_del_var);
 513
 514         /* Register */
 515         error = sysfs_create_bin_file(&efivars_kset->kobj, efivars_new_var);
 516         if (error) {
 517                 printk(KERN_ERR "efivars: unable to create new_var sysfs file"
 518                         " due to error %d\n", error);
 519                 goto out_free;
 520         }
 521
 522         error = sysfs_create_bin_file(&efivars_kset->kobj, efivars_del_var);
 523         if (error) {
 524                 printk(KERN_ERR "efivars: unable to create del_var sysfs file"
 525                         " due to error %d\n", error);
 526                 sysfs_remove_bin_file(&efivars_kset->kobj, efivars_new_var);
 527                 goto out_free;
 528         }
 529
 530         return 0;
 531 out_free:
 532         kfree(efivars_del_var);
 533         efivars_del_var = NULL;
 534         kfree(efivars_new_var);
 535         efivars_new_var = NULL;
 536         return error;
 537 }
 538
 539 static int efivar_update_sysfs_entry(efi_char16_t *name, efi_guid_t vendor,
 540                                      unsigned long name_size, void *data)
 541 {
 542         struct efivar_entry *entry = data;
 543
 544         if (efivar_entry_find(name, vendor, &efivar_sysfs_list, false))
 545                 return 0;
 546
 547         memcpy(entry->var.VariableName, name, name_size);
 548         memcpy(&(entry->var.VendorGuid), &vendor, sizeof(efi_guid_t));
 549
 550         return 1;
 551 }
 552
 553 static void efivar_update_sysfs_entries(struct work_struct *work)
 554 {
 555         struct efivar_entry *entry;
 556         int err;
 557
 558         /* Add new sysfs entries */
 559         while (1) {
 560                 entry = kzalloc(sizeof(*entry), GFP_KERNEL);
 561                 if (!entry)
 562                         return;
 563
 564                 err = efivar_init(efivar_update_sysfs_entry, entry,
 565                                   true, false, &efivar_sysfs_list);
 566                 if (!err)
 567                         break;
 568
 569                 efivar_create_sysfs_entry(entry);
 570         }
 571
 572         kfree(entry);
 573 }
 574
 575 static int efivars_sysfs_callback(efi_char16_t *name, efi_guid_t vendor,
 576                                   unsigned long name_size, void *data)
 577 {
 578         struct efivar_entry *entry;
 579
 580         entry = kzalloc(sizeof(*entry), GFP_KERNEL);
 581         if (!entry)
 582                 return -ENOMEM;
 583
 584         memcpy(entry->var.VariableName, name, name_size);
 585         memcpy(&(entry->var.VendorGuid), &vendor, sizeof(efi_guid_t));
 586
 587         efivar_create_sysfs_entry(entry);
 588
 589         return 0;
 590 }
 591
 592 static int efivar_sysfs_destroy(struct efivar_entry *entry, void *data)
 593 {
 594         efivar_entry_remove(entry);
 595         efivar_unregister(entry);
 596         return 0;
 597 }
 598
 599 static void efivars_sysfs_exit(void)
 600 {
 601         /* Remove all entries and destroy */
 602         __efivar_entry_iter(efivar_sysfs_destroy, &efivar_sysfs_list, NULL, NULL);
 603
 604         if (efivars_new_var)
 605                 sysfs_remove_bin_file(&efivars_kset->kobj, efivars_new_var);
 606         if (efivars_del_var)
 607                 sysfs_remove_bin_file(&efivars_kset->kobj, efivars_del_var);
 608         kfree(efivars_new_var);
 609         kfree(efivars_del_var);
 610         kset_unregister(efivars_kset);
 611 }
 612
 613 int efivars_sysfs_init(void)
 614 {
 615         struct kobject *parent_kobj = efivars_kobject();
 616         int error = 0;
 617
 618         if (!efi_enabled(EFI_RUNTIME_SERVICES))
 619                 return -ENODEV;
 620
 621         /* No efivars has been registered yet */
 622         if (!parent_kobj)
 623                 return 0;
 624
 625         printk(KERN_INFO "EFI Variables Facility v%s %s\n", EFIVARS_VERSION,
 626                EFIVARS_DATE);
 627
 628         efivars_kset = kset_create_and_add("vars", NULL, parent_kobj);
 629         if (!efivars_kset) {
 630                 printk(KERN_ERR "efivars: Subsystem registration failed.\n");
 631                 return -ENOMEM;
 632         }
 633
 634         efivar_init(efivars_sysfs_callback, NULL, false,
 635                     true, &efivar_sysfs_list);
 636
 637         error = create_efivars_bin_attributes();
 638         if (error) {
 639                 efivars_sysfs_exit();
 640                 return error;
 641         }
 642
 643         INIT_WORK(&efivar_work, efivar_update_sysfs_entries);
 644
 645         return 0;
 646 }
 647 EXPORT_SYMBOL_GPL(efivars_sysfs_init);
 648
 649 module_init(efivars_sysfs_init);
 650 module_exit(efivars_sysfs_exit);