1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22#include <linux/capability.h>
23#include <linux/types.h>
24#include <linux/errno.h>
25#include <linux/init.h>
26#include <linux/mm.h>
27#include <linux/module.h>
28#include <linux/string.h>
29#include <linux/smp.h>
30#include <linux/efi.h>
31#include <linux/sysfs.h>
32#include <linux/device.h>
33#include <linux/slab.h>
34#include <linux/ctype.h>
35#include <linux/ucs2_string.h>
36
37
38static struct efivars *__efivars;
39
40static bool efivar_wq_enabled = true;
41DECLARE_WORK(efivar_work, NULL);
42EXPORT_SYMBOL_GPL(efivar_work);
43
44static bool
45validate_device_path(struct efi_variable *var, int match, u8 *buffer,
46 unsigned long len)
47{
48 struct efi_generic_dev_path *node;
49 int offset = 0;
50
51 node = (struct efi_generic_dev_path *)buffer;
52
53 if (len < sizeof(*node))
54 return false;
55
56 while (offset <= len - sizeof(*node) &&
57 node->length >= sizeof(*node) &&
58 node->length <= len - offset) {
59 offset += node->length;
60
61 if ((node->type == EFI_DEV_END_PATH ||
62 node->type == EFI_DEV_END_PATH2) &&
63 node->sub_type == EFI_DEV_END_ENTIRE)
64 return true;
65
66 node = (struct efi_generic_dev_path *)(buffer + offset);
67 }
68
69
70
71
72
73
74 return false;
75}
76
77static bool
78validate_boot_order(struct efi_variable *var, int match, u8 *buffer,
79 unsigned long len)
80{
81
82 if ((len % 2) != 0)
83 return false;
84
85 return true;
86}
87
88static bool
89validate_load_option(struct efi_variable *var, int match, u8 *buffer,
90 unsigned long len)
91{
92 u16 filepathlength;
93 int i, desclength = 0, namelen;
94
95 namelen = ucs2_strnlen(var->VariableName, sizeof(var->VariableName));
96
97
98 for (i = match; i < match+4; i++) {
99 if (var->VariableName[i] > 127 ||
100 hex_to_bin(var->VariableName[i] & 0xff) < 0)
101 return true;
102 }
103
104
105 if (namelen > match + 4)
106 return false;
107
108
109 if (len < 8)
110 return false;
111
112 filepathlength = buffer[4] | buffer[5] << 8;
113
114
115
116
117
118 desclength = ucs2_strsize((efi_char16_t *)(buffer + 6), len - 6) + 2;
119
120
121 if (!desclength)
122 return false;
123
124
125
126
127
128
129 if ((desclength + filepathlength + 6) > len)
130 return false;
131
132
133
134
135 return validate_device_path(var, match, buffer + desclength + 6,
136 filepathlength);
137}
138
139static bool
140validate_uint16(struct efi_variable *var, int match, u8 *buffer,
141 unsigned long len)
142{
143
144 if (len != 2)
145 return false;
146
147 return true;
148}
149
150static bool
151validate_ascii_string(struct efi_variable *var, int match, u8 *buffer,
152 unsigned long len)
153{
154 int i;
155
156 for (i = 0; i < len; i++) {
157 if (buffer[i] > 127)
158 return false;
159
160 if (buffer[i] == 0)
161 return true;
162 }
163
164 return false;
165}
166
167struct variable_validate {
168 char *name;
169 bool (*validate)(struct efi_variable *var, int match, u8 *data,
170 unsigned long len);
171};
172
173static const struct variable_validate variable_validate[] = {
174 { "BootNext", validate_uint16 },
175 { "BootOrder", validate_boot_order },
176 { "DriverOrder", validate_boot_order },
177 { "Boot*", validate_load_option },
178 { "Driver*", validate_load_option },
179 { "ConIn", validate_device_path },
180 { "ConInDev", validate_device_path },
181 { "ConOut", validate_device_path },
182 { "ConOutDev", validate_device_path },
183 { "ErrOut", validate_device_path },
184 { "ErrOutDev", validate_device_path },
185 { "Timeout", validate_uint16 },
186 { "Lang", validate_ascii_string },
187 { "PlatformLang", validate_ascii_string },
188 { "", NULL },
189};
190
191bool
192efivar_validate(struct efi_variable *var, u8 *data, unsigned long len)
193{
194 int i;
195 u16 *unicode_name = var->VariableName;
196
197 for (i = 0; variable_validate[i].validate != NULL; i++) {
198 const char *name = variable_validate[i].name;
199 int match;
200
201 for (match = 0; ; match++) {
202 char c = name[match];
203 u16 u = unicode_name[match];
204
205
206 if (u > 127)
207 return true;
208
209
210 if (c == '*')
211 return variable_validate[i].validate(var,
212 match, data, len);
213
214
215 if (c != u)
216 break;
217
218
219 if (!c)
220 return variable_validate[i].validate(var,
221 match, data, len);
222 }
223 }
224
225 return true;
226}
227EXPORT_SYMBOL_GPL(efivar_validate);
228
229static efi_status_t
230check_var_size(u32 attributes, unsigned long size)
231{
232 const struct efivar_operations *fops = __efivars->ops;
233
234 if (!fops->query_variable_store)
235 return EFI_UNSUPPORTED;
236
237 return fops->query_variable_store(attributes, size);
238}
239
240static int efi_status_to_err(efi_status_t status)
241{
242 int err;
243
244 switch (status) {
245 case EFI_SUCCESS:
246 err = 0;
247 break;
248 case EFI_INVALID_PARAMETER:
249 err = -EINVAL;
250 break;
251 case EFI_OUT_OF_RESOURCES:
252 err = -ENOSPC;
253 break;
254 case EFI_DEVICE_ERROR:
255 err = -EIO;
256 break;
257 case EFI_WRITE_PROTECTED:
258 err = -EROFS;
259 break;
260 case EFI_SECURITY_VIOLATION:
261 err = -EACCES;
262 break;
263 case EFI_NOT_FOUND:
264 err = -ENOENT;
265 break;
266 default:
267 err = -EINVAL;
268 }
269
270 return err;
271}
272
273static bool variable_is_present(efi_char16_t *variable_name, efi_guid_t *vendor,
274 struct list_head *head)
275{
276 struct efivar_entry *entry, *n;
277 unsigned long strsize1, strsize2;
278 bool found = false;
279
280 strsize1 = ucs2_strsize(variable_name, 1024);
281 list_for_each_entry_safe(entry, n, head, list) {
282 strsize2 = ucs2_strsize(entry->var.VariableName, 1024);
283 if (strsize1 == strsize2 &&
284 !memcmp(variable_name, &(entry->var.VariableName),
285 strsize2) &&
286 !efi_guidcmp(entry->var.VendorGuid,
287 *vendor)) {
288 found = true;
289 break;
290 }
291 }
292 return found;
293}
294
295
296
297
298
299
300static unsigned long var_name_strnsize(efi_char16_t *variable_name,
301 unsigned long variable_name_size)
302{
303 unsigned long len;
304 efi_char16_t c;
305
306
307
308
309
310
311 for (len = 2; len <= variable_name_size; len += sizeof(c)) {
312 c = variable_name[(len / sizeof(c)) - 1];
313 if (!c)
314 break;
315 }
316
317 return min(len, variable_name_size);
318}
319
320
321
322
323
324static void dup_variable_bug(efi_char16_t *s16, efi_guid_t *vendor_guid,
325 unsigned long len16)
326{
327 size_t i, len8 = len16 / sizeof(efi_char16_t);
328 char *s8;
329
330
331
332
333
334
335 efivar_wq_enabled = false;
336
337 s8 = kzalloc(len8, GFP_KERNEL);
338 if (!s8)
339 return;
340
341 for (i = 0; i < len8; i++)
342 s8[i] = s16[i];
343
344 printk(KERN_WARNING "efivars: duplicate variable: %s-%pUl\n",
345 s8, vendor_guid);
346 kfree(s8);
347}
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362int efivar_init(int (*func)(efi_char16_t *, efi_guid_t, unsigned long, void *),
363 void *data, bool atomic, bool duplicates,
364 struct list_head *head)
365{
366 const struct efivar_operations *ops = __efivars->ops;
367 unsigned long variable_name_size = 1024;
368 efi_char16_t *variable_name;
369 efi_status_t status;
370 efi_guid_t vendor_guid;
371 int err = 0;
372
373 variable_name = kzalloc(variable_name_size, GFP_KERNEL);
374 if (!variable_name) {
375 printk(KERN_ERR "efivars: Memory allocation failed.\n");
376 return -ENOMEM;
377 }
378
379 spin_lock_irq(&__efivars->lock);
380
381
382
383
384
385
386 do {
387 variable_name_size = 1024;
388
389 status = ops->get_next_variable(&variable_name_size,
390 variable_name,
391 &vendor_guid);
392 switch (status) {
393 case EFI_SUCCESS:
394 if (!atomic)
395 spin_unlock_irq(&__efivars->lock);
396
397 variable_name_size = var_name_strnsize(variable_name,
398 variable_name_size);
399
400
401
402
403
404
405
406
407
408 if (duplicates &&
409 variable_is_present(variable_name, &vendor_guid, head)) {
410 dup_variable_bug(variable_name, &vendor_guid,
411 variable_name_size);
412 if (!atomic)
413 spin_lock_irq(&__efivars->lock);
414
415 status = EFI_NOT_FOUND;
416 break;
417 }
418
419 err = func(variable_name, vendor_guid, variable_name_size, data);
420 if (err)
421 status = EFI_NOT_FOUND;
422
423 if (!atomic)
424 spin_lock_irq(&__efivars->lock);
425
426 break;
427 case EFI_NOT_FOUND:
428 break;
429 default:
430 printk(KERN_WARNING "efivars: get_next_variable: status=%lx\n",
431 status);
432 status = EFI_NOT_FOUND;
433 break;
434 }
435
436 } while (status != EFI_NOT_FOUND);
437
438 spin_unlock_irq(&__efivars->lock);
439
440 kfree(variable_name);
441
442 return err;
443}
444EXPORT_SYMBOL_GPL(efivar_init);
445
446
447
448
449
450
451void efivar_entry_add(struct efivar_entry *entry, struct list_head *head)
452{
453 spin_lock_irq(&__efivars->lock);
454 list_add(&entry->list, head);
455 spin_unlock_irq(&__efivars->lock);
456}
457EXPORT_SYMBOL_GPL(efivar_entry_add);
458
459
460
461
462
463void efivar_entry_remove(struct efivar_entry *entry)
464{
465 spin_lock_irq(&__efivars->lock);
466 list_del(&entry->list);
467 spin_unlock_irq(&__efivars->lock);
468}
469EXPORT_SYMBOL_GPL(efivar_entry_remove);
470
471
472
473
474
475
476
477
478
479
480
481
482static void efivar_entry_list_del_unlock(struct efivar_entry *entry)
483{
484 WARN_ON(!spin_is_locked(&__efivars->lock));
485
486 list_del(&entry->list);
487 spin_unlock_irq(&__efivars->lock);
488}
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505int __efivar_entry_delete(struct efivar_entry *entry)
506{
507 const struct efivar_operations *ops = __efivars->ops;
508 efi_status_t status;
509
510 WARN_ON(!spin_is_locked(&__efivars->lock));
511
512 status = ops->set_variable(entry->var.VariableName,
513 &entry->var.VendorGuid,
514 0, 0, NULL);
515
516 return efi_status_to_err(status);
517}
518EXPORT_SYMBOL_GPL(__efivar_entry_delete);
519
520
521
522
523
524
525
526
527
528
529
530
531int efivar_entry_delete(struct efivar_entry *entry)
532{
533 const struct efivar_operations *ops = __efivars->ops;
534 efi_status_t status;
535
536 spin_lock_irq(&__efivars->lock);
537 status = ops->set_variable(entry->var.VariableName,
538 &entry->var.VendorGuid,
539 0, 0, NULL);
540 if (!(status == EFI_SUCCESS || status == EFI_NOT_FOUND)) {
541 spin_unlock_irq(&__efivars->lock);
542 return efi_status_to_err(status);
543 }
544
545 efivar_entry_list_del_unlock(entry);
546 return 0;
547}
548EXPORT_SYMBOL_GPL(efivar_entry_delete);
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571int efivar_entry_set(struct efivar_entry *entry, u32 attributes,
572 unsigned long size, void *data, struct list_head *head)
573{
574 const struct efivar_operations *ops = __efivars->ops;
575 efi_status_t status;
576 efi_char16_t *name = entry->var.VariableName;
577 efi_guid_t vendor = entry->var.VendorGuid;
578
579 spin_lock_irq(&__efivars->lock);
580
581 if (head && efivar_entry_find(name, vendor, head, false)) {
582 spin_unlock_irq(&__efivars->lock);
583 return -EEXIST;
584 }
585
586 status = check_var_size(attributes, size + ucs2_strsize(name, 1024));
587 if (status == EFI_SUCCESS || status == EFI_UNSUPPORTED)
588 status = ops->set_variable(name, &vendor,
589 attributes, size, data);
590
591 spin_unlock_irq(&__efivars->lock);
592
593 return efi_status_to_err(status);
594
595}
596EXPORT_SYMBOL_GPL(efivar_entry_set);
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615int efivar_entry_set_safe(efi_char16_t *name, efi_guid_t vendor, u32 attributes,
616 bool block, unsigned long size, void *data)
617{
618 const struct efivar_operations *ops = __efivars->ops;
619 unsigned long flags;
620 efi_status_t status;
621
622 if (!ops->query_variable_store)
623 return -ENOSYS;
624
625 if (!block) {
626 if (!spin_trylock_irqsave(&__efivars->lock, flags))
627 return -EBUSY;
628 } else {
629 spin_lock_irqsave(&__efivars->lock, flags);
630 }
631
632 status = check_var_size(attributes, size + ucs2_strsize(name, 1024));
633 if (status != EFI_SUCCESS) {
634 spin_unlock_irqrestore(&__efivars->lock, flags);
635 return -ENOSPC;
636 }
637
638 status = ops->set_variable(name, &vendor, attributes, size, data);
639
640 spin_unlock_irqrestore(&__efivars->lock, flags);
641
642 return efi_status_to_err(status);
643}
644EXPORT_SYMBOL_GPL(efivar_entry_set_safe);
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663struct efivar_entry *efivar_entry_find(efi_char16_t *name, efi_guid_t guid,
664 struct list_head *head, bool remove)
665{
666 struct efivar_entry *entry, *n;
667 int strsize1, strsize2;
668 bool found = false;
669
670 WARN_ON(!spin_is_locked(&__efivars->lock));
671
672 list_for_each_entry_safe(entry, n, head, list) {
673 strsize1 = ucs2_strsize(name, 1024);
674 strsize2 = ucs2_strsize(entry->var.VariableName, 1024);
675 if (strsize1 == strsize2 &&
676 !memcmp(name, &(entry->var.VariableName), strsize1) &&
677 !efi_guidcmp(guid, entry->var.VendorGuid)) {
678 found = true;
679 break;
680 }
681 }
682
683 if (!found)
684 return NULL;
685
686 if (remove)
687 list_del(&entry->list);
688
689 return entry;
690}
691EXPORT_SYMBOL_GPL(efivar_entry_find);
692
693
694
695
696
697
698int efivar_entry_size(struct efivar_entry *entry, unsigned long *size)
699{
700 const struct efivar_operations *ops = __efivars->ops;
701 efi_status_t status;
702
703 *size = 0;
704
705 spin_lock_irq(&__efivars->lock);
706 status = ops->get_variable(entry->var.VariableName,
707 &entry->var.VendorGuid, NULL, size, NULL);
708 spin_unlock_irq(&__efivars->lock);
709
710 if (status != EFI_BUFFER_TOO_SMALL)
711 return efi_status_to_err(status);
712
713 return 0;
714}
715EXPORT_SYMBOL_GPL(efivar_entry_size);
716
717
718
719
720
721
722
723
724
725
726
727
728int __efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
729 unsigned long *size, void *data)
730{
731 const struct efivar_operations *ops = __efivars->ops;
732 efi_status_t status;
733
734 WARN_ON(!spin_is_locked(&__efivars->lock));
735
736 status = ops->get_variable(entry->var.VariableName,
737 &entry->var.VendorGuid,
738 attributes, size, data);
739
740 return efi_status_to_err(status);
741}
742EXPORT_SYMBOL_GPL(__efivar_entry_get);
743
744
745
746
747
748
749
750
751int efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
752 unsigned long *size, void *data)
753{
754 const struct efivar_operations *ops = __efivars->ops;
755 efi_status_t status;
756
757 spin_lock_irq(&__efivars->lock);
758 status = ops->get_variable(entry->var.VariableName,
759 &entry->var.VendorGuid,
760 attributes, size, data);
761 spin_unlock_irq(&__efivars->lock);
762
763 return efi_status_to_err(status);
764}
765EXPORT_SYMBOL_GPL(efivar_entry_get);
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789int efivar_entry_set_get_size(struct efivar_entry *entry, u32 attributes,
790 unsigned long *size, void *data, bool *set)
791{
792 const struct efivar_operations *ops = __efivars->ops;
793 efi_char16_t *name = entry->var.VariableName;
794 efi_guid_t *vendor = &entry->var.VendorGuid;
795 efi_status_t status;
796 int err;
797
798 *set = false;
799
800 if (efivar_validate(&entry->var, data, *size) == false)
801 return -EINVAL;
802
803
804
805
806
807
808 spin_lock_irq(&__efivars->lock);
809
810
811
812
813 status = check_var_size(attributes, *size + ucs2_strsize(name, 1024));
814 if (status != EFI_SUCCESS) {
815 if (status != EFI_UNSUPPORTED) {
816 err = efi_status_to_err(status);
817 goto out;
818 }
819
820 if (*size > 65536) {
821 err = -ENOSPC;
822 goto out;
823 }
824 }
825
826 status = ops->set_variable(name, vendor, attributes, *size, data);
827 if (status != EFI_SUCCESS) {
828 err = efi_status_to_err(status);
829 goto out;
830 }
831
832 *set = true;
833
834
835
836
837
838
839
840 *size = 0;
841 status = ops->get_variable(entry->var.VariableName,
842 &entry->var.VendorGuid,
843 NULL, size, NULL);
844
845 if (status == EFI_NOT_FOUND)
846 efivar_entry_list_del_unlock(entry);
847 else
848 spin_unlock_irq(&__efivars->lock);
849
850 if (status && status != EFI_BUFFER_TOO_SMALL)
851 return efi_status_to_err(status);
852
853 return 0;
854
855out:
856 spin_unlock_irq(&__efivars->lock);
857 return err;
858
859}
860EXPORT_SYMBOL_GPL(efivar_entry_set_get_size);
861
862
863
864
865
866
867
868
869void efivar_entry_iter_begin(void)
870{
871 spin_lock_irq(&__efivars->lock);
872}
873EXPORT_SYMBOL_GPL(efivar_entry_iter_begin);
874
875
876
877
878
879
880void efivar_entry_iter_end(void)
881{
882 spin_unlock_irq(&__efivars->lock);
883}
884EXPORT_SYMBOL_GPL(efivar_entry_iter_end);
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908int __efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
909 struct list_head *head, void *data,
910 struct efivar_entry **prev)
911{
912 struct efivar_entry *entry, *n;
913 int err = 0;
914
915 if (!prev || !*prev) {
916 list_for_each_entry_safe(entry, n, head, list) {
917 err = func(entry, data);
918 if (err)
919 break;
920 }
921
922 if (prev)
923 *prev = entry;
924
925 return err;
926 }
927
928
929 list_for_each_entry_safe_continue((*prev), n, head, list) {
930 err = func(*prev, data);
931 if (err)
932 break;
933 }
934
935 return err;
936}
937EXPORT_SYMBOL_GPL(__efivar_entry_iter);
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953int efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
954 struct list_head *head, void *data)
955{
956 int err = 0;
957
958 efivar_entry_iter_begin();
959 err = __efivar_entry_iter(func, head, data, NULL);
960 efivar_entry_iter_end();
961
962 return err;
963}
964EXPORT_SYMBOL_GPL(efivar_entry_iter);
965
966
967
968
969
970
971
972struct kobject *efivars_kobject(void)
973{
974 if (!__efivars)
975 return NULL;
976
977 return __efivars->kobject;
978}
979EXPORT_SYMBOL_GPL(efivars_kobject);
980
981
982
983
984void efivar_run_worker(void)
985{
986 if (efivar_wq_enabled)
987 schedule_work(&efivar_work);
988}
989EXPORT_SYMBOL_GPL(efivar_run_worker);
990
991
992
993
994
995
996
997
998
999int efivars_register(struct efivars *efivars,
1000 const struct efivar_operations *ops,
1001 struct kobject *kobject)
1002{
1003 spin_lock_init(&efivars->lock);
1004 efivars->ops = ops;
1005 efivars->kobject = kobject;
1006
1007 __efivars = efivars;
1008
1009 return 0;
1010}
1011EXPORT_SYMBOL_GPL(efivars_register);
1012
1013
1014
1015
1016
1017
1018
1019
1020int efivars_unregister(struct efivars *efivars)
1021{
1022 int rv;
1023
1024 if (!__efivars) {
1025 printk(KERN_ERR "efivars not registered\n");
1026 rv = -EINVAL;
1027 goto out;
1028 }
1029
1030 if (__efivars != efivars) {
1031 rv = -EINVAL;
1032 goto out;
1033 }
1034
1035 __efivars = NULL;
1036
1037 rv = 0;
1038out:
1039 return rv;
1040}
1041EXPORT_SYMBOL_GPL(efivars_unregister);
1042