drivers/firmware/efivars.c

   1 /*
   2  * EFI Variables - 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/capability.h>
  69 #include <linux/types.h>
  70 #include <linux/errno.h>
  71 #include <linux/init.h>
  72 #include <linux/mm.h>
  73 #include <linux/module.h>
  74 #include <linux/string.h>
  75 #include <linux/smp.h>
  76 #include <linux/efi.h>
  77 #include <linux/sysfs.h>
  78 #include <linux/kobject.h>
  79 #include <linux/device.h>
  80 #include <linux/slab.h>
  81 #include <linux/pstore.h>
  82
  83 #include <asm/uaccess.h>
  84
  85 #define EFIVARS_VERSION "0.08"
  86 #define EFIVARS_DATE "2004-May-17"
  87
  88 MODULE_AUTHOR("Matt Domsch <Matt_Domsch@Dell.com>");
  89 MODULE_DESCRIPTION("sysfs interface to EFI Variables");
  90 MODULE_LICENSE("GPL");
  91 MODULE_VERSION(EFIVARS_VERSION);
  92
  93 #define DUMP_NAME_LEN 52
  94
  95 /*
  96  * The maximum size of VariableName + Data = 1024
  97  * Therefore, it's reasonable to save that much
  98  * space in each part of the structure,
  99  * and we use a page for reading/writing.
 100  */
 101
 102 struct efi_variable {
 103         efi_char16_t  VariableName[1024/sizeof(efi_char16_t)];
 104         efi_guid_t    VendorGuid;
 105         unsigned long DataSize;
 106         __u8          Data[1024];
 107         efi_status_t  Status;
 108         __u32         Attributes;
 109 } __attribute__((packed));
 110
 111
 112 struct efivar_entry {
 113         struct efivars *efivars;
 114         struct efi_variable var;
 115         struct list_head list;
 116         struct kobject kobj;
 117 };
 118
 119 struct efivar_attribute {
 120         struct attribute attr;
 121         ssize_t (*show) (struct efivar_entry *entry, char *buf);
 122         ssize_t (*store)(struct efivar_entry *entry, const char *buf, size_t count);
 123 };
 124
 125 #define PSTORE_EFI_ATTRIBUTES \
 126         (EFI_VARIABLE_NON_VOLATILE | \
 127          EFI_VARIABLE_BOOTSERVICE_ACCESS | \
 128          EFI_VARIABLE_RUNTIME_ACCESS)
 129
 130 #define EFIVAR_ATTR(_name, _mode, _show, _store) \
 131 struct efivar_attribute efivar_attr_##_name = { \
 132         .attr = {.name = __stringify(_name), .mode = _mode}, \
 133         .show = _show, \
 134         .store = _store, \
 135 };
 136
 137 #define to_efivar_attr(_attr) container_of(_attr, struct efivar_attribute, attr)
 138 #define to_efivar_entry(obj)  container_of(obj, struct efivar_entry, kobj)
 139
 140 /*
 141  * Prototype for sysfs creation function
 142  */
 143 static int
 144 efivar_create_sysfs_entry(struct efivars *efivars,
 145                           unsigned long variable_name_size,
 146                           efi_char16_t *variable_name,
 147                           efi_guid_t *vendor_guid);
 148
 149 /* Return the number of unicode characters in data */
 150 static unsigned long
 151 utf16_strnlen(efi_char16_t *s, size_t maxlength)
 152 {
 153         unsigned long length = 0;
 154
 155         while (*s++ != 0 && length < maxlength)
 156                 length++;
 157         return length;
 158 }
 159
 160 static inline unsigned long
 161 utf16_strlen(efi_char16_t *s)
 162 {
 163         return utf16_strnlen(s, ~0UL);
 164 }
 165
 166 /*
 167  * Return the number of bytes is the length of this string
 168  * Note: this is NOT the same as the number of unicode characters
 169  */
 170 static inline unsigned long
 171 utf16_strsize(efi_char16_t *data, unsigned long maxlength)
 172 {
 173         return utf16_strnlen(data, maxlength/sizeof(efi_char16_t)) * sizeof(efi_char16_t);
 174 }
 175
 176 static inline int
 177 utf16_strncmp(const efi_char16_t *a, const efi_char16_t *b, size_t len)
 178 {
 179         while (1) {
 180                 if (len == 0)
 181                         return 0;
 182                 if (*a < *b)
 183                         return -1;
 184                 if (*a > *b)
 185                         return 1;
 186                 if (*a == 0) /* implies *b == 0 */
 187                         return 0;
 188                 a++;
 189                 b++;
 190                 len--;
 191         }
 192 }
 193
 194 static bool
 195 validate_device_path(struct efi_variable *var, int match, u8 *buffer,
 196                      unsigned long len)
 197 {
 198         struct efi_generic_dev_path *node;
 199         int offset = 0;
 200
 201         node = (struct efi_generic_dev_path *)buffer;
 202
 203         if (len < sizeof(*node))
 204                 return false;
 205
 206         while (offset <= len - sizeof(*node) &&
 207                node->length >= sizeof(*node) &&
 208                 node->length <= len - offset) {
 209                 offset += node->length;
 210
 211                 if ((node->type == EFI_DEV_END_PATH ||
 212                      node->type == EFI_DEV_END_PATH2) &&
 213                     node->sub_type == EFI_DEV_END_ENTIRE)
 214                         return true;
 215
 216                 node = (struct efi_generic_dev_path *)(buffer + offset);
 217         }
 218
 219         /*
 220          * If we're here then either node->length pointed past the end
 221          * of the buffer or we reached the end of the buffer without
 222          * finding a device path end node.
 223          */
 224         return false;
 225 }
 226
 227 static bool
 228 validate_boot_order(struct efi_variable *var, int match, u8 *buffer,
 229                     unsigned long len)
 230 {
 231         /* An array of 16-bit integers */
 232         if ((len % 2) != 0)
 233                 return false;
 234
 235         return true;
 236 }
 237
 238 static bool
 239 validate_load_option(struct efi_variable *var, int match, u8 *buffer,
 240                      unsigned long len)
 241 {
 242         u16 filepathlength;
 243         int i, desclength = 0, namelen;
 244
 245         namelen = utf16_strnlen(var->VariableName, sizeof(var->VariableName));
 246
 247         /* Either "Boot" or "Driver" followed by four digits of hex */
 248         for (i = match; i < match+4; i++) {
 249                 if (var->VariableName[i] > 127 ||
 250                     hex_to_bin(var->VariableName[i] & 0xff) < 0)
 251                         return true;
 252         }
 253
 254         /* Reject it if there's 4 digits of hex and then further content */
 255         if (namelen > match + 4)
 256                 return false;
 257
 258         /* A valid entry must be at least 8 bytes */
 259         if (len < 8)
 260                 return false;
 261
 262         filepathlength = buffer[4] | buffer[5] << 8;
 263
 264         /*
 265          * There's no stored length for the description, so it has to be
 266          * found by hand
 267          */
 268         desclength = utf16_strsize((efi_char16_t *)(buffer + 6), len - 6) + 2;
 269
 270         /* Each boot entry must have a descriptor */
 271         if (!desclength)
 272                 return false;
 273
 274         /*
 275          * If the sum of the length of the description, the claimed filepath
 276          * length and the original header are greater than the length of the
 277          * variable, it's malformed
 278          */
 279         if ((desclength + filepathlength + 6) > len)
 280                 return false;
 281
 282         /*
 283          * And, finally, check the filepath
 284          */
 285         return validate_device_path(var, match, buffer + desclength + 6,
 286                                     filepathlength);
 287 }
 288
 289 static bool
 290 validate_uint16(struct efi_variable *var, int match, u8 *buffer,
 291                 unsigned long len)
 292 {
 293         /* A single 16-bit integer */
 294         if (len != 2)
 295                 return false;
 296
 297         return true;
 298 }
 299
 300 static bool
 301 validate_ascii_string(struct efi_variable *var, int match, u8 *buffer,
 302                       unsigned long len)
 303 {
 304         int i;
 305
 306         for (i = 0; i < len; i++) {
 307                 if (buffer[i] > 127)
 308                         return false;
 309
 310                 if (buffer[i] == 0)
 311                         return true;
 312         }
 313
 314         return false;
 315 }
 316
 317 struct variable_validate {
 318         char *name;
 319         bool (*validate)(struct efi_variable *var, int match, u8 *data,
 320                          unsigned long len);
 321 };
 322
 323 static const struct variable_validate variable_validate[] = {
 324         { "BootNext", validate_uint16 },
 325         { "BootOrder", validate_boot_order },
 326         { "DriverOrder", validate_boot_order },
 327         { "Boot*", validate_load_option },
 328         { "Driver*", validate_load_option },
 329         { "ConIn", validate_device_path },
 330         { "ConInDev", validate_device_path },
 331         { "ConOut", validate_device_path },
 332         { "ConOutDev", validate_device_path },
 333         { "ErrOut", validate_device_path },
 334         { "ErrOutDev", validate_device_path },
 335         { "Timeout", validate_uint16 },
 336         { "Lang", validate_ascii_string },
 337         { "PlatformLang", validate_ascii_string },
 338         { "", NULL },
 339 };
 340
 341 static bool
 342 validate_var(struct efi_variable *var, u8 *data, unsigned long len)
 343 {
 344         int i;
 345         u16 *unicode_name = var->VariableName;
 346
 347         for (i = 0; variable_validate[i].validate != NULL; i++) {
 348                 const char *name = variable_validate[i].name;
 349                 int match;
 350
 351                 for (match = 0; ; match++) {
 352                         char c = name[match];
 353                         u16 u = unicode_name[match];
 354
 355                         /* All special variables are plain ascii */
 356                         if (u > 127)
 357                                 return true;
 358
 359                         /* Wildcard in the matching name means we've matched */
 360                         if (c == '*')
 361                                 return variable_validate[i].validate(var,
 362                                                              match, data, len);
 363
 364                         /* Case sensitive match */
 365                         if (c != u)
 366                                 break;
 367
 368                         /* Reached the end of the string while matching */
 369                         if (!c)
 370                                 return variable_validate[i].validate(var,
 371                                                              match, data, len);
 372                 }
 373         }
 374
 375         return true;
 376 }
 377
 378 static efi_status_t
 379 get_var_data_locked(struct efivars *efivars, struct efi_variable *var)
 380 {
 381         efi_status_t status;
 382
 383         var->DataSize = 1024;
 384         status = efivars->ops->get_variable(var->VariableName,
 385                                             &var->VendorGuid,
 386                                             &var->Attributes,
 387                                             &var->DataSize,
 388                                             var->Data);
 389         return status;
 390 }
 391
 392 static efi_status_t
 393 get_var_data(struct efivars *efivars, struct efi_variable *var)
 394 {
 395         efi_status_t status;
 396
 397         spin_lock(&efivars->lock);
 398         status = get_var_data_locked(efivars, var);
 399         spin_unlock(&efivars->lock);
 400
 401         if (status != EFI_SUCCESS) {
 402                 printk(KERN_WARNING "efivars: get_variable() failed 0x%lx!\n",
 403                         status);
 404         }
 405         return status;
 406 }
 407
 408 static ssize_t
 409 efivar_guid_read(struct efivar_entry *entry, char *buf)
 410 {
 411         struct efi_variable *var = &entry->var;
 412         char *str = buf;
 413
 414         if (!entry || !buf)
 415                 return 0;
 416
 417         efi_guid_unparse(&var->VendorGuid, str);
 418         str += strlen(str);
 419         str += sprintf(str, "\n");
 420
 421         return str - buf;
 422 }
 423
 424 static ssize_t
 425 efivar_attr_read(struct efivar_entry *entry, char *buf)
 426 {
 427         struct efi_variable *var = &entry->var;
 428         char *str = buf;
 429         efi_status_t status;
 430
 431         if (!entry || !buf)
 432                 return -EINVAL;
 433
 434         status = get_var_data(entry->efivars, var);
 435         if (status != EFI_SUCCESS)
 436                 return -EIO;
 437
 438         if (var->Attributes & 0x1)
 439                 str += sprintf(str, "EFI_VARIABLE_NON_VOLATILE\n");
 440         if (var->Attributes & 0x2)
 441                 str += sprintf(str, "EFI_VARIABLE_BOOTSERVICE_ACCESS\n");
 442         if (var->Attributes & 0x4)
 443                 str += sprintf(str, "EFI_VARIABLE_RUNTIME_ACCESS\n");
 444         return str - buf;
 445 }
 446
 447 static ssize_t
 448 efivar_size_read(struct efivar_entry *entry, char *buf)
 449 {
 450         struct efi_variable *var = &entry->var;
 451         char *str = buf;
 452         efi_status_t status;
 453
 454         if (!entry || !buf)
 455                 return -EINVAL;
 456
 457         status = get_var_data(entry->efivars, var);
 458         if (status != EFI_SUCCESS)
 459                 return -EIO;
 460
 461         str += sprintf(str, "0x%lx\n", var->DataSize);
 462         return str - buf;
 463 }
 464
 465 static ssize_t
 466 efivar_data_read(struct efivar_entry *entry, char *buf)
 467 {
 468         struct efi_variable *var = &entry->var;
 469         efi_status_t status;
 470
 471         if (!entry || !buf)
 472                 return -EINVAL;
 473
 474         status = get_var_data(entry->efivars, var);
 475         if (status != EFI_SUCCESS)
 476                 return -EIO;
 477
 478         memcpy(buf, var->Data, var->DataSize);
 479         return var->DataSize;
 480 }
 481 /*
 482  * We allow each variable to be edited via rewriting the
 483  * entire efi variable structure.
 484  */
 485 static ssize_t
 486 efivar_store_raw(struct efivar_entry *entry, const char *buf, size_t count)
 487 {
 488         struct efi_variable *new_var, *var = &entry->var;
 489         struct efivars *efivars = entry->efivars;
 490         efi_status_t status = EFI_NOT_FOUND;
 491
 492         if (count != sizeof(struct efi_variable))
 493                 return -EINVAL;
 494
 495         new_var = (struct efi_variable *)buf;
 496         /*
 497          * If only updating the variable data, then the name
 498          * and guid should remain the same
 499          */
 500         if (memcmp(new_var->VariableName, var->VariableName, sizeof(var->VariableName)) ||
 501                 efi_guidcmp(new_var->VendorGuid, var->VendorGuid)) {
 502                 printk(KERN_ERR "efivars: Cannot edit the wrong variable!\n");
 503                 return -EINVAL;
 504         }
 505
 506         if ((new_var->DataSize <= 0) || (new_var->Attributes == 0)){
 507                 printk(KERN_ERR "efivars: DataSize & Attributes must be valid!\n");
 508                 return -EINVAL;
 509         }
 510
 511         if ((new_var->Attributes & ~EFI_VARIABLE_MASK) != 0 ||
 512             validate_var(new_var, new_var->Data, new_var->DataSize) == false) {
 513                 printk(KERN_ERR "efivars: Malformed variable content\n");
 514                 return -EINVAL;
 515         }
 516
 517         spin_lock(&efivars->lock);
 518         status = efivars->ops->set_variable(new_var->VariableName,
 519                                             &new_var->VendorGuid,
 520                                             new_var->Attributes,
 521                                             new_var->DataSize,
 522                                             new_var->Data);
 523
 524         spin_unlock(&efivars->lock);
 525
 526         if (status != EFI_SUCCESS) {
 527                 printk(KERN_WARNING "efivars: set_variable() failed: status=%lx\n",
 528                         status);
 529                 return -EIO;
 530         }
 531
 532         memcpy(&entry->var, new_var, count);
 533         return count;
 534 }
 535
 536 static ssize_t
 537 efivar_show_raw(struct efivar_entry *entry, char *buf)
 538 {
 539         struct efi_variable *var = &entry->var;
 540         efi_status_t status;
 541
 542         if (!entry || !buf)
 543                 return 0;
 544
 545         status = get_var_data(entry->efivars, var);
 546         if (status != EFI_SUCCESS)
 547                 return -EIO;
 548
 549         memcpy(buf, var, sizeof(*var));
 550         return sizeof(*var);
 551 }
 552
 553 /*
 554  * Generic read/write functions that call the specific functions of
 555  * the attributes...
 556  */
 557 static ssize_t efivar_attr_show(struct kobject *kobj, struct attribute *attr,
 558                                 char *buf)
 559 {
 560         struct efivar_entry *var = to_efivar_entry(kobj);
 561         struct efivar_attribute *efivar_attr = to_efivar_attr(attr);
 562         ssize_t ret = -EIO;
 563
 564         if (!capable(CAP_SYS_ADMIN))
 565                 return -EACCES;
 566
 567         if (efivar_attr->show) {
 568                 ret = efivar_attr->show(var, buf);
 569         }
 570         return ret;
 571 }
 572
 573 static ssize_t efivar_attr_store(struct kobject *kobj, struct attribute *attr,
 574                                 const char *buf, size_t count)
 575 {
 576         struct efivar_entry *var = to_efivar_entry(kobj);
 577         struct efivar_attribute *efivar_attr = to_efivar_attr(attr);
 578         ssize_t ret = -EIO;
 579
 580         if (!capable(CAP_SYS_ADMIN))
 581                 return -EACCES;
 582
 583         if (efivar_attr->store)
 584                 ret = efivar_attr->store(var, buf, count);
 585
 586         return ret;
 587 }
 588
 589 static const struct sysfs_ops efivar_attr_ops = {
 590         .show = efivar_attr_show,
 591         .store = efivar_attr_store,
 592 };
 593
 594 static void efivar_release(struct kobject *kobj)
 595 {
 596         struct efivar_entry *var = container_of(kobj, struct efivar_entry, kobj);
 597         kfree(var);
 598 }
 599
 600 static EFIVAR_ATTR(guid, 0400, efivar_guid_read, NULL);
 601 static EFIVAR_ATTR(attributes, 0400, efivar_attr_read, NULL);
 602 static EFIVAR_ATTR(size, 0400, efivar_size_read, NULL);
 603 static EFIVAR_ATTR(data, 0400, efivar_data_read, NULL);
 604 static EFIVAR_ATTR(raw_var, 0600, efivar_show_raw, efivar_store_raw);
 605
 606 static struct attribute *def_attrs[] = {
 607         &efivar_attr_guid.attr,
 608         &efivar_attr_size.attr,
 609         &efivar_attr_attributes.attr,
 610         &efivar_attr_data.attr,
 611         &efivar_attr_raw_var.attr,
 612         NULL,
 613 };
 614
 615 static struct kobj_type efivar_ktype = {
 616         .release = efivar_release,
 617         .sysfs_ops = &efivar_attr_ops,
 618         .default_attrs = def_attrs,
 619 };
 620
 621 static struct pstore_info efi_pstore_info;
 622
 623 static inline void
 624 efivar_unregister(struct efivar_entry *var)
 625 {
 626         kobject_put(&var->kobj);
 627 }
 628
 629 #ifdef CONFIG_PSTORE
 630
 631 static int efi_pstore_open(struct pstore_info *psi)
 632 {
 633         struct efivars *efivars = psi->data;
 634
 635         spin_lock(&efivars->lock);
 636         efivars->walk_entry = list_first_entry(&efivars->list,
 637                                                struct efivar_entry, list);
 638         return 0;
 639 }
 640
 641 static int efi_pstore_close(struct pstore_info *psi)
 642 {
 643         struct efivars *efivars = psi->data;
 644
 645         spin_unlock(&efivars->lock);
 646         return 0;
 647 }
 648
 649 static ssize_t efi_pstore_read(u64 *id, enum pstore_type_id *type,
 650                                struct timespec *timespec,
 651                                char **buf, struct pstore_info *psi)
 652 {
 653         efi_guid_t vendor = LINUX_EFI_CRASH_GUID;
 654         struct efivars *efivars = psi->data;
 655         char name[DUMP_NAME_LEN];
 656         int i;
 657         unsigned int part, size;
 658         unsigned long time;
 659
 660         while (&efivars->walk_entry->list != &efivars->list) {
 661                 if (!efi_guidcmp(efivars->walk_entry->var.VendorGuid,
 662                                  vendor)) {
 663                         for (i = 0; i < DUMP_NAME_LEN; i++) {
 664                                 name[i] = efivars->walk_entry->var.VariableName[i];
 665                         }
 666                         if (sscanf(name, "dump-type%u-%u-%lu", type, &part, &time) == 3) {
 667                                 *id = part;
 668                                 timespec->tv_sec = time;
 669                                 timespec->tv_nsec = 0;
 670                                 get_var_data_locked(efivars, &efivars->walk_entry->var);
 671                                 size = efivars->walk_entry->var.DataSize;
 672                                 *buf = kmalloc(size, GFP_KERNEL);
 673                                 if (*buf == NULL)
 674                                         return -ENOMEM;
 675                                 memcpy(*buf, efivars->walk_entry->var.Data,
 676                                        size);
 677                                 efivars->walk_entry = list_entry(efivars->walk_entry->list.next,
 678                                                    struct efivar_entry, list);
 679                                 return size;
 680                         }
 681                 }
 682                 efivars->walk_entry = list_entry(efivars->walk_entry->list.next,
 683                                                  struct efivar_entry, list);
 684         }
 685         return 0;
 686 }
 687
 688 static int efi_pstore_write(enum pstore_type_id type, u64 *id,
 689                 unsigned int part, size_t size, struct pstore_info *psi)
 690 {
 691         char name[DUMP_NAME_LEN];
 692         char stub_name[DUMP_NAME_LEN];
 693         efi_char16_t efi_name[DUMP_NAME_LEN];
 694         efi_guid_t vendor = LINUX_EFI_CRASH_GUID;
 695         struct efivars *efivars = psi->data;
 696         struct efivar_entry *entry, *found = NULL;
 697         int i, ret = 0;
 698
 699         sprintf(stub_name, "dump-type%u-%u-", type, part);
 700         sprintf(name, "%s%lu", stub_name, get_seconds());
 701
 702         spin_lock(&efivars->lock);
 703
 704         for (i = 0; i < DUMP_NAME_LEN; i++)
 705                 efi_name[i] = stub_name[i];
 706
 707         /*
 708          * Clean up any entries with the same name
 709          */
 710
 711         list_for_each_entry(entry, &efivars->list, list) {
 712                 get_var_data_locked(efivars, &entry->var);
 713
 714                 if (efi_guidcmp(entry->var.VendorGuid, vendor))
 715                         continue;
 716                 if (utf16_strncmp(entry->var.VariableName, efi_name,
 717                                   utf16_strlen(efi_name)))
 718                         continue;
 719                 /* Needs to be a prefix */
 720                 if (entry->var.VariableName[utf16_strlen(efi_name)] == 0)
 721                         continue;
 722
 723                 /* found */
 724                 found = entry;
 725                 efivars->ops->set_variable(entry->var.VariableName,
 726                                            &entry->var.VendorGuid,
 727                                            PSTORE_EFI_ATTRIBUTES,
 728                                            0, NULL);
 729         }
 730
 731         if (found)
 732                 list_del(&found->list);
 733
 734         for (i = 0; i < DUMP_NAME_LEN; i++)
 735                 efi_name[i] = name[i];
 736
 737         efivars->ops->set_variable(efi_name, &vendor, PSTORE_EFI_ATTRIBUTES,
 738                                    size, psi->buf);
 739
 740         spin_unlock(&efivars->lock);
 741
 742         if (found)
 743                 efivar_unregister(found);
 744
 745         if (size)
 746                 ret = efivar_create_sysfs_entry(efivars,
 747                                           utf16_strsize(efi_name,
 748                                                         DUMP_NAME_LEN * 2),
 749                                           efi_name, &vendor);
 750
 751         *id = part;
 752         return ret;
 753 };
 754
 755 static int efi_pstore_erase(enum pstore_type_id type, u64 id,
 756                             struct pstore_info *psi)
 757 {
 758         efi_pstore_write(type, &id, (unsigned int)id, 0, psi);
 759
 760         return 0;
 761 }
 762 #else
 763 static int efi_pstore_open(struct pstore_info *psi)
 764 {
 765         return 0;
 766 }
 767
 768 static int efi_pstore_close(struct pstore_info *psi)
 769 {
 770         return 0;
 771 }
 772
 773 static ssize_t efi_pstore_read(u64 *id, enum pstore_type_id *type,
 774                                struct timespec *timespec,
 775                                char **buf, struct pstore_info *psi)
 776 {
 777         return -1;
 778 }
 779
 780 static int efi_pstore_write(enum pstore_type_id type, u64 *id,
 781                 unsigned int part, size_t size, struct pstore_info *psi)
 782 {
 783         return 0;
 784 }
 785
 786 static int efi_pstore_erase(enum pstore_type_id type, u64 id,
 787                             struct pstore_info *psi)
 788 {
 789         return 0;
 790 }
 791 #endif
 792
 793 static struct pstore_info efi_pstore_info = {
 794         .owner          = THIS_MODULE,
 795         .name           = "efi",
 796         .open           = efi_pstore_open,
 797         .close          = efi_pstore_close,
 798         .read           = efi_pstore_read,
 799         .write          = efi_pstore_write,
 800         .erase          = efi_pstore_erase,
 801 };
 802
 803 static ssize_t efivar_create(struct file *filp, struct kobject *kobj,
 804                              struct bin_attribute *bin_attr,
 805                              char *buf, loff_t pos, size_t count)
 806 {
 807         struct efi_variable *new_var = (struct efi_variable *)buf;
 808         struct efivars *efivars = bin_attr->private;
 809         struct efivar_entry *search_efivar, *n;
 810         unsigned long strsize1, strsize2;
 811         efi_status_t status = EFI_NOT_FOUND;
 812         int found = 0;
 813
 814         if (!capable(CAP_SYS_ADMIN))
 815                 return -EACCES;
 816
 817         if ((new_var->Attributes & ~EFI_VARIABLE_MASK) != 0 ||
 818             validate_var(new_var, new_var->Data, new_var->DataSize) == false) {
 819                 printk(KERN_ERR "efivars: Malformed variable content\n");
 820                 return -EINVAL;
 821         }
 822
 823         spin_lock(&efivars->lock);
 824
 825         /*
 826          * Does this variable already exist?
 827          */
 828         list_for_each_entry_safe(search_efivar, n, &efivars->list, list) {
 829                 strsize1 = utf16_strsize(search_efivar->var.VariableName, 1024);
 830                 strsize2 = utf16_strsize(new_var->VariableName, 1024);
 831                 if (strsize1 == strsize2 &&
 832                         !memcmp(&(search_efivar->var.VariableName),
 833                                 new_var->VariableName, strsize1) &&
 834                         !efi_guidcmp(search_efivar->var.VendorGuid,
 835                                 new_var->VendorGuid)) {
 836                         found = 1;
 837                         break;
 838                 }
 839         }
 840         if (found) {
 841                 spin_unlock(&efivars->lock);
 842                 return -EINVAL;
 843         }
 844
 845         /* now *really* create the variable via EFI */
 846         status = efivars->ops->set_variable(new_var->VariableName,
 847                                             &new_var->VendorGuid,
 848                                             new_var->Attributes,
 849                                             new_var->DataSize,
 850                                             new_var->Data);
 851
 852         if (status != EFI_SUCCESS) {
 853                 printk(KERN_WARNING "efivars: set_variable() failed: status=%lx\n",
 854                         status);
 855                 spin_unlock(&efivars->lock);
 856                 return -EIO;
 857         }
 858         spin_unlock(&efivars->lock);
 859
 860         /* Create the entry in sysfs.  Locking is not required here */
 861         status = efivar_create_sysfs_entry(efivars,
 862                                            utf16_strsize(new_var->VariableName,
 863                                                          1024),
 864                                            new_var->VariableName,
 865                                            &new_var->VendorGuid);
 866         if (status) {
 867                 printk(KERN_WARNING "efivars: variable created, but sysfs entry wasn't.\n");
 868         }
 869         return count;
 870 }
 871
 872 static ssize_t efivar_delete(struct file *filp, struct kobject *kobj,
 873                              struct bin_attribute *bin_attr,
 874                              char *buf, loff_t pos, size_t count)
 875 {
 876         struct efi_variable *del_var = (struct efi_variable *)buf;
 877         struct efivars *efivars = bin_attr->private;
 878         struct efivar_entry *search_efivar, *n;
 879         unsigned long strsize1, strsize2;
 880         efi_status_t status = EFI_NOT_FOUND;
 881         int found = 0;
 882
 883         if (!capable(CAP_SYS_ADMIN))
 884                 return -EACCES;
 885
 886         spin_lock(&efivars->lock);
 887
 888         /*
 889          * Does this variable already exist?
 890          */
 891         list_for_each_entry_safe(search_efivar, n, &efivars->list, list) {
 892                 strsize1 = utf16_strsize(search_efivar->var.VariableName, 1024);
 893                 strsize2 = utf16_strsize(del_var->VariableName, 1024);
 894                 if (strsize1 == strsize2 &&
 895                         !memcmp(&(search_efivar->var.VariableName),
 896                                 del_var->VariableName, strsize1) &&
 897                         !efi_guidcmp(search_efivar->var.VendorGuid,
 898                                 del_var->VendorGuid)) {
 899                         found = 1;
 900                         break;
 901                 }
 902         }
 903         if (!found) {
 904                 spin_unlock(&efivars->lock);
 905                 return -EINVAL;
 906         }
 907         /* force the Attributes/DataSize to 0 to ensure deletion */
 908         del_var->Attributes = 0;
 909         del_var->DataSize = 0;
 910
 911         status = efivars->ops->set_variable(del_var->VariableName,
 912                                             &del_var->VendorGuid,
 913                                             del_var->Attributes,
 914                                             del_var->DataSize,
 915                                             del_var->Data);
 916
 917         if (status != EFI_SUCCESS) {
 918                 printk(KERN_WARNING "efivars: set_variable() failed: status=%lx\n",
 919                         status);
 920                 spin_unlock(&efivars->lock);
 921                 return -EIO;
 922         }
 923         list_del(&search_efivar->list);
 924         /* We need to release this lock before unregistering. */
 925         spin_unlock(&efivars->lock);
 926         efivar_unregister(search_efivar);
 927
 928         /* It's dead Jim.... */
 929         return count;
 930 }
 931
 932 /*
 933  * Let's not leave out systab information that snuck into
 934  * the efivars driver
 935  */
 936 static ssize_t systab_show(struct kobject *kobj,
 937                            struct kobj_attribute *attr, char *buf)
 938 {
 939         char *str = buf;
 940
 941         if (!kobj || !buf)
 942                 return -EINVAL;
 943
 944         if (efi.mps != EFI_INVALID_TABLE_ADDR)
 945                 str += sprintf(str, "MPS=0x%lx\n", efi.mps);
 946         if (efi.acpi20 != EFI_INVALID_TABLE_ADDR)
 947                 str += sprintf(str, "ACPI20=0x%lx\n", efi.acpi20);
 948         if (efi.acpi != EFI_INVALID_TABLE_ADDR)
 949                 str += sprintf(str, "ACPI=0x%lx\n", efi.acpi);
 950         if (efi.smbios != EFI_INVALID_TABLE_ADDR)
 951                 str += sprintf(str, "SMBIOS=0x%lx\n", efi.smbios);
 952         if (efi.hcdp != EFI_INVALID_TABLE_ADDR)
 953                 str += sprintf(str, "HCDP=0x%lx\n", efi.hcdp);
 954         if (efi.boot_info != EFI_INVALID_TABLE_ADDR)
 955                 str += sprintf(str, "BOOTINFO=0x%lx\n", efi.boot_info);
 956         if (efi.uga != EFI_INVALID_TABLE_ADDR)
 957                 str += sprintf(str, "UGA=0x%lx\n", efi.uga);
 958
 959         return str - buf;
 960 }
 961
 962 static struct kobj_attribute efi_attr_systab =
 963                         __ATTR(systab, 0400, systab_show, NULL);
 964
 965 static struct attribute *efi_subsys_attrs[] = {
 966         &efi_attr_systab.attr,
 967         NULL,   /* maybe more in the future? */
 968 };
 969
 970 static struct attribute_group efi_subsys_attr_group = {
 971         .attrs = efi_subsys_attrs,
 972 };
 973
 974 static struct kobject *efi_kobj;
 975
 976 /*
 977  * efivar_create_sysfs_entry()
 978  * Requires:
 979  *    variable_name_size = number of bytes required to hold
 980  *                         variable_name (not counting the NULL
 981  *                         character at the end.
 982  *    efivars->lock is not held on entry or exit.
 983  * Returns 1 on failure, 0 on success
 984  */
 985 static int
 986 efivar_create_sysfs_entry(struct efivars *efivars,
 987                           unsigned long variable_name_size,
 988                           efi_char16_t *variable_name,
 989                           efi_guid_t *vendor_guid)
 990 {
 991         int i, short_name_size = variable_name_size / sizeof(efi_char16_t) + 38;
 992         char *short_name;
 993         struct efivar_entry *new_efivar;
 994
 995         short_name = kzalloc(short_name_size + 1, GFP_KERNEL);
 996         new_efivar = kzalloc(sizeof(struct efivar_entry), GFP_KERNEL);
 997
 998         if (!short_name || !new_efivar)  {
 999                 kfree(short_name);
1000                 kfree(new_efivar);
1001                 return 1;
1002         }
1003
1004         new_efivar->efivars = efivars;
1005         memcpy(new_efivar->var.VariableName, variable_name,
1006                 variable_name_size);
1007         memcpy(&(new_efivar->var.VendorGuid), vendor_guid, sizeof(efi_guid_t));
1008
1009         /* Convert Unicode to normal chars (assume top bits are 0),
1010            ala UTF-8 */
1011         for (i=0; i < (int)(variable_name_size / sizeof(efi_char16_t)); i++) {
1012                 short_name[i] = variable_name[i] & 0xFF;
1013         }
1014         /* This is ugly, but necessary to separate one vendor's
1015            private variables from another's.         */
1016
1017         *(short_name + strlen(short_name)) = '-';
1018         efi_guid_unparse(vendor_guid, short_name + strlen(short_name));
1019
1020         new_efivar->kobj.kset = efivars->kset;
1021         i = kobject_init_and_add(&new_efivar->kobj, &efivar_ktype, NULL,
1022                                  "%s", short_name);
1023         if (i) {
1024                 kfree(short_name);
1025                 kfree(new_efivar);
1026                 return 1;
1027         }
1028
1029         kobject_uevent(&new_efivar->kobj, KOBJ_ADD);
1030         kfree(short_name);
1031         short_name = NULL;
1032
1033         spin_lock(&efivars->lock);
1034         list_add(&new_efivar->list, &efivars->list);
1035         spin_unlock(&efivars->lock);
1036
1037         return 0;
1038 }
1039
1040 static int
1041 create_efivars_bin_attributes(struct efivars *efivars)
1042 {
1043         struct bin_attribute *attr;
1044         int error;
1045
1046         /* new_var */
1047         attr = kzalloc(sizeof(*attr), GFP_KERNEL);
1048         if (!attr)
1049                 return -ENOMEM;
1050
1051         attr->attr.name = "new_var";
1052         attr->attr.mode = 0200;
1053         attr->write = efivar_create;
1054         attr->private = efivars;
1055         efivars->new_var = attr;
1056
1057         /* del_var */
1058         attr = kzalloc(sizeof(*attr), GFP_KERNEL);
1059         if (!attr) {
1060                 error = -ENOMEM;
1061                 goto out_free;
1062         }
1063         attr->attr.name = "del_var";
1064         attr->attr.mode = 0200;
1065         attr->write = efivar_delete;
1066         attr->private = efivars;
1067         efivars->del_var = attr;
1068
1069         sysfs_bin_attr_init(efivars->new_var);
1070         sysfs_bin_attr_init(efivars->del_var);
1071
1072         /* Register */
1073         error = sysfs_create_bin_file(&efivars->kset->kobj,
1074                                       efivars->new_var);
1075         if (error) {
1076                 printk(KERN_ERR "efivars: unable to create new_var sysfs file"
1077                         " due to error %d\n", error);
1078                 goto out_free;
1079         }
1080         error = sysfs_create_bin_file(&efivars->kset->kobj,
1081                                       efivars->del_var);
1082         if (error) {
1083                 printk(KERN_ERR "efivars: unable to create del_var sysfs file"
1084                         " due to error %d\n", error);
1085                 sysfs_remove_bin_file(&efivars->kset->kobj,
1086                                       efivars->new_var);
1087                 goto out_free;
1088         }
1089
1090         return 0;
1091 out_free:
1092         kfree(efivars->del_var);
1093         efivars->del_var = NULL;
1094         kfree(efivars->new_var);
1095         efivars->new_var = NULL;
1096         return error;
1097 }
1098
1099 void unregister_efivars(struct efivars *efivars)
1100 {
1101         struct efivar_entry *entry, *n;
1102
1103         list_for_each_entry_safe(entry, n, &efivars->list, list) {
1104                 spin_lock(&efivars->lock);
1105                 list_del(&entry->list);
1106                 spin_unlock(&efivars->lock);
1107                 efivar_unregister(entry);
1108         }
1109         if (efivars->new_var)
1110                 sysfs_remove_bin_file(&efivars->kset->kobj, efivars->new_var);
1111         if (efivars->del_var)
1112                 sysfs_remove_bin_file(&efivars->kset->kobj, efivars->del_var);
1113         kfree(efivars->new_var);
1114         kfree(efivars->del_var);
1115         kset_unregister(efivars->kset);
1116 }
1117 EXPORT_SYMBOL_GPL(unregister_efivars);
1118
1119 int register_efivars(struct efivars *efivars,
1120                      const struct efivar_operations *ops,
1121                      struct kobject *parent_kobj)
1122 {
1123         efi_status_t status = EFI_NOT_FOUND;
1124         efi_guid_t vendor_guid;
1125         efi_char16_t *variable_name;
1126         unsigned long variable_name_size = 1024;
1127         int error = 0;
1128
1129         variable_name = kzalloc(variable_name_size, GFP_KERNEL);
1130         if (!variable_name) {
1131                 printk(KERN_ERR "efivars: Memory allocation failed.\n");
1132                 return -ENOMEM;
1133         }
1134
1135         spin_lock_init(&efivars->lock);
1136         INIT_LIST_HEAD(&efivars->list);
1137         efivars->ops = ops;
1138
1139         efivars->kset = kset_create_and_add("vars", NULL, parent_kobj);
1140         if (!efivars->kset) {
1141                 printk(KERN_ERR "efivars: Subsystem registration failed.\n");
1142                 error = -ENOMEM;
1143                 goto out;
1144         }
1145
1146         /*
1147          * Per EFI spec, the maximum storage allocated for both
1148          * the variable name and variable data is 1024 bytes.
1149          */
1150
1151         do {
1152                 variable_name_size = 1024;
1153
1154                 status = ops->get_next_variable(&variable_name_size,
1155                                                 variable_name,
1156                                                 &vendor_guid);
1157                 switch (status) {
1158                 case EFI_SUCCESS:
1159                         efivar_create_sysfs_entry(efivars,
1160                                                   variable_name_size,
1161                                                   variable_name,
1162                                                   &vendor_guid);
1163                         break;
1164                 case EFI_NOT_FOUND:
1165                         break;
1166                 default:
1167                         printk(KERN_WARNING "efivars: get_next_variable: status=%lx\n",
1168                                 status);
1169                         status = EFI_NOT_FOUND;
1170                         break;
1171                 }
1172         } while (status != EFI_NOT_FOUND);
1173
1174         error = create_efivars_bin_attributes(efivars);
1175         if (error)
1176                 unregister_efivars(efivars);
1177
1178         efivars->efi_pstore_info = efi_pstore_info;
1179
1180         efivars->efi_pstore_info.buf = kmalloc(4096, GFP_KERNEL);
1181         if (efivars->efi_pstore_info.buf) {
1182                 efivars->efi_pstore_info.bufsize = 1024;
1183                 efivars->efi_pstore_info.data = efivars;
1184                 spin_lock_init(&efivars->efi_pstore_info.buf_lock);
1185                 pstore_register(&efivars->efi_pstore_info);
1186         }
1187
1188 out:
1189         kfree(variable_name);
1190
1191         return error;
1192 }
1193 EXPORT_SYMBOL_GPL(register_efivars);
1194
1195 static struct efivars __efivars;
1196 static struct efivar_operations ops;
1197
1198 /*
1199  * For now we register the efi subsystem with the firmware subsystem
1200  * and the vars subsystem with the efi subsystem.  In the future, it
1201  * might make sense to split off the efi subsystem into its own
1202  * driver, but for now only efivars will register with it, so just
1203  * include it here.
1204  */
1205
1206 static int __init
1207 efivars_init(void)
1208 {
1209         int error = 0;
1210
1211         printk(KERN_INFO "EFI Variables Facility v%s %s\n", EFIVARS_VERSION,
1212                EFIVARS_DATE);
1213
1214         if (!efi_enabled)
1215                 return 0;
1216
1217         /* For now we'll register the efi directory at /sys/firmware/efi */
1218         efi_kobj = kobject_create_and_add("efi", firmware_kobj);
1219         if (!efi_kobj) {
1220                 printk(KERN_ERR "efivars: Firmware registration failed.\n");
1221                 return -ENOMEM;
1222         }
1223
1224         ops.get_variable = efi.get_variable;
1225         ops.set_variable = efi.set_variable;
1226         ops.get_next_variable = efi.get_next_variable;
1227         error = register_efivars(&__efivars, &ops, efi_kobj);
1228         if (error)
1229                 goto err_put;
1230
1231         /* Don't forget the systab entry */
1232         error = sysfs_create_group(efi_kobj, &efi_subsys_attr_group);
1233         if (error) {
1234                 printk(KERN_ERR
1235                        "efivars: Sysfs attribute export failed with error %d.\n",
1236                        error);
1237                 goto err_unregister;
1238         }
1239
1240         return 0;
1241
1242 err_unregister:
1243         unregister_efivars(&__efivars);
1244 err_put:
1245         kobject_put(efi_kobj);
1246         return error;
1247 }
1248
1249 static void __exit
1250 efivars_exit(void)
1251 {
1252         if (efi_enabled) {
1253                 unregister_efivars(&__efivars);
1254                 kobject_put(efi_kobj);
1255         }
1256 }
1257
1258 module_init(efivars_init);
1259 module_exit(efivars_exit);
1260