1 // SPDX-License-Identifier: GPL-2.0+
3 * EFI Test Driver for Runtime Services
5 * Copyright(C) 2012-2016 Canonical Ltd.
7 * This driver exports EFI runtime services interfaces into userspace, which
8 * allow to use and test UEFI runtime services provided by firmware.
12 #include <linux/miscdevice.h>
13 #include <linux/module.h>
14 #include <linux/init.h>
15 #include <linux/proc_fs.h>
16 #include <linux/efi.h>
17 #include <linux/security.h>
18 #include <linux/slab.h>
19 #include <linux/uaccess.h>
24 MODULE_DESCRIPTION("EFI Test Driver");
25 MODULE_LICENSE("GPL");
28 * Count the bytes in 'str', including the terminating NULL.
30 * Note this function returns the number of *bytes*, not the number of
33 static inline size_t user_ucs2_strsize(efi_char16_t __user *str)
35 efi_char16_t *s = str, c;
41 /* Include terminating NULL */
42 len = sizeof(efi_char16_t);
44 if (get_user(c, s++)) {
45 /* Can't read userspace memory for size */
50 if (get_user(c, s++)) {
51 /* Can't read userspace memory for size */
54 len += sizeof(efi_char16_t);
60 * Allocate a buffer and copy a ucs2 string from user space into it.
63 copy_ucs2_from_user_len(efi_char16_t **dst, efi_char16_t __user *src,
73 buf = memdup_user(src, len);
84 * Count the bytes in 'str', including the terminating NULL.
86 * Just a wrap for user_ucs2_strsize
89 get_ucs2_strsize_from_user(efi_char16_t __user *src, size_t *len)
91 *len = user_ucs2_strsize(src);
99 * Calculate the required buffer allocation size and copy a ucs2 string
100 * from user space into it.
102 * This function differs from copy_ucs2_from_user_len() because it
103 * calculates the size of the buffer to allocate by taking the length of
106 * If a non-zero value is returned, the caller MUST NOT access 'dst'.
108 * It is the caller's responsibility to free 'dst'.
111 copy_ucs2_from_user(efi_char16_t **dst, efi_char16_t __user *src)
115 len = user_ucs2_strsize(src);
118 return copy_ucs2_from_user_len(dst, src, len);
122 * Copy a ucs2 string to a user buffer.
124 * This function is a simple wrapper around copy_to_user() that does
125 * nothing if 'src' is NULL, which is useful for reducing the amount of
126 * NULL checking the caller has to do.
128 * 'len' specifies the number of bytes to copy.
131 copy_ucs2_to_user_len(efi_char16_t __user *dst, efi_char16_t *src, size_t len)
136 return copy_to_user(dst, src, len);
139 static long efi_runtime_get_variable(unsigned long arg)
141 struct efi_getvariable __user *getvariable_user;
142 struct efi_getvariable getvariable;
143 unsigned long datasize = 0, prev_datasize, *dz;
144 efi_guid_t vendor_guid, *vd = NULL;
146 efi_char16_t *name = NULL;
151 getvariable_user = (struct efi_getvariable __user *)arg;
153 if (copy_from_user(&getvariable, getvariable_user,
154 sizeof(getvariable)))
156 if (getvariable.data_size &&
157 get_user(datasize, getvariable.data_size))
159 if (getvariable.vendor_guid) {
160 if (copy_from_user(&vendor_guid, getvariable.vendor_guid,
161 sizeof(vendor_guid)))
166 if (getvariable.variable_name) {
167 rv = copy_ucs2_from_user(&name, getvariable.variable_name);
172 at = getvariable.attributes ? &attr : NULL;
173 dz = getvariable.data_size ? &datasize : NULL;
175 if (getvariable.data_size && getvariable.data) {
176 data = kmalloc(datasize, GFP_KERNEL);
183 prev_datasize = datasize;
184 status = efi.get_variable(name, vd, at, dz, data);
187 if (put_user(status, getvariable.status)) {
192 if (status != EFI_SUCCESS) {
193 if (status == EFI_BUFFER_TOO_SMALL) {
194 if (dz && put_user(datasize, getvariable.data_size)) {
203 if (prev_datasize < datasize) {
209 if (copy_to_user(getvariable.data, data, datasize)) {
215 if (at && put_user(attr, getvariable.attributes)) {
220 if (dz && put_user(datasize, getvariable.data_size))
229 static long efi_runtime_set_variable(unsigned long arg)
231 struct efi_setvariable __user *setvariable_user;
232 struct efi_setvariable setvariable;
233 efi_guid_t vendor_guid;
235 efi_char16_t *name = NULL;
239 setvariable_user = (struct efi_setvariable __user *)arg;
241 if (copy_from_user(&setvariable, setvariable_user, sizeof(setvariable)))
243 if (copy_from_user(&vendor_guid, setvariable.vendor_guid,
244 sizeof(vendor_guid)))
247 if (setvariable.variable_name) {
248 rv = copy_ucs2_from_user(&name, setvariable.variable_name);
253 data = memdup_user(setvariable.data, setvariable.data_size);
256 return PTR_ERR(data);
259 status = efi.set_variable(name, &vendor_guid,
260 setvariable.attributes,
261 setvariable.data_size, data);
263 if (put_user(status, setvariable.status)) {
268 rv = status == EFI_SUCCESS ? 0 : -EINVAL;
277 static long efi_runtime_get_time(unsigned long arg)
279 struct efi_gettime __user *gettime_user;
280 struct efi_gettime gettime;
285 gettime_user = (struct efi_gettime __user *)arg;
286 if (copy_from_user(&gettime, gettime_user, sizeof(gettime)))
289 status = efi.get_time(gettime.time ? &efi_time : NULL,
290 gettime.capabilities ? &cap : NULL);
292 if (put_user(status, gettime.status))
295 if (status != EFI_SUCCESS)
298 if (gettime.capabilities) {
299 efi_time_cap_t __user *cap_local;
301 cap_local = (efi_time_cap_t *)gettime.capabilities;
302 if (put_user(cap.resolution, &(cap_local->resolution)) ||
303 put_user(cap.accuracy, &(cap_local->accuracy)) ||
304 put_user(cap.sets_to_zero, &(cap_local->sets_to_zero)))
308 if (copy_to_user(gettime.time, &efi_time, sizeof(efi_time_t)))
315 static long efi_runtime_set_time(unsigned long arg)
317 struct efi_settime __user *settime_user;
318 struct efi_settime settime;
322 settime_user = (struct efi_settime __user *)arg;
323 if (copy_from_user(&settime, settime_user, sizeof(settime)))
325 if (copy_from_user(&efi_time, settime.time,
328 status = efi.set_time(&efi_time);
330 if (put_user(status, settime.status))
333 return status == EFI_SUCCESS ? 0 : -EINVAL;
336 static long efi_runtime_get_waketime(unsigned long arg)
338 struct efi_getwakeuptime __user *getwakeuptime_user;
339 struct efi_getwakeuptime getwakeuptime;
340 efi_bool_t enabled, pending;
344 getwakeuptime_user = (struct efi_getwakeuptime __user *)arg;
345 if (copy_from_user(&getwakeuptime, getwakeuptime_user,
346 sizeof(getwakeuptime)))
349 status = efi.get_wakeup_time(
350 getwakeuptime.enabled ? (efi_bool_t *)&enabled : NULL,
351 getwakeuptime.pending ? (efi_bool_t *)&pending : NULL,
352 getwakeuptime.time ? &efi_time : NULL);
354 if (put_user(status, getwakeuptime.status))
357 if (status != EFI_SUCCESS)
360 if (getwakeuptime.enabled && put_user(enabled,
361 getwakeuptime.enabled))
364 if (getwakeuptime.time) {
365 if (copy_to_user(getwakeuptime.time, &efi_time,
373 static long efi_runtime_set_waketime(unsigned long arg)
375 struct efi_setwakeuptime __user *setwakeuptime_user;
376 struct efi_setwakeuptime setwakeuptime;
381 setwakeuptime_user = (struct efi_setwakeuptime __user *)arg;
383 if (copy_from_user(&setwakeuptime, setwakeuptime_user,
384 sizeof(setwakeuptime)))
387 enabled = setwakeuptime.enabled;
388 if (setwakeuptime.time) {
389 if (copy_from_user(&efi_time, setwakeuptime.time,
393 status = efi.set_wakeup_time(enabled, &efi_time);
395 status = efi.set_wakeup_time(enabled, NULL);
397 if (put_user(status, setwakeuptime.status))
400 return status == EFI_SUCCESS ? 0 : -EINVAL;
403 static long efi_runtime_get_nextvariablename(unsigned long arg)
405 struct efi_getnextvariablename __user *getnextvariablename_user;
406 struct efi_getnextvariablename getnextvariablename;
407 unsigned long name_size, prev_name_size = 0, *ns = NULL;
409 efi_guid_t *vd = NULL;
410 efi_guid_t vendor_guid;
411 efi_char16_t *name = NULL;
414 getnextvariablename_user = (struct efi_getnextvariablename __user *)arg;
416 if (copy_from_user(&getnextvariablename, getnextvariablename_user,
417 sizeof(getnextvariablename)))
420 if (getnextvariablename.variable_name_size) {
421 if (get_user(name_size, getnextvariablename.variable_name_size))
424 prev_name_size = name_size;
427 if (getnextvariablename.vendor_guid) {
428 if (copy_from_user(&vendor_guid,
429 getnextvariablename.vendor_guid,
430 sizeof(vendor_guid)))
435 if (getnextvariablename.variable_name) {
436 size_t name_string_size = 0;
438 rv = get_ucs2_strsize_from_user(
439 getnextvariablename.variable_name,
444 * The name_size may be smaller than the real buffer size where
445 * variable name located in some use cases. The most typical
446 * case is passing a 0 to get the required buffer size for the
447 * 1st time call. So we need to copy the content from user
448 * space for at least the string size of variable name, or else
449 * the name passed to UEFI may not be terminated as we expected.
451 rv = copy_ucs2_from_user_len(&name,
452 getnextvariablename.variable_name,
453 prev_name_size > name_string_size ?
454 prev_name_size : name_string_size);
459 status = efi.get_next_variable(ns, name, vd);
461 if (put_user(status, getnextvariablename.status)) {
466 if (status != EFI_SUCCESS) {
467 if (status == EFI_BUFFER_TOO_SMALL) {
468 if (ns && put_user(*ns,
469 getnextvariablename.variable_name_size)) {
479 if (copy_ucs2_to_user_len(getnextvariablename.variable_name,
480 name, prev_name_size)) {
487 if (put_user(*ns, getnextvariablename.variable_name_size)) {
494 if (copy_to_user(getnextvariablename.vendor_guid, vd,
504 static long efi_runtime_get_nexthighmonocount(unsigned long arg)
506 struct efi_getnexthighmonotoniccount __user *getnexthighmonocount_user;
507 struct efi_getnexthighmonotoniccount getnexthighmonocount;
511 getnexthighmonocount_user = (struct
512 efi_getnexthighmonotoniccount __user *)arg;
514 if (copy_from_user(&getnexthighmonocount,
515 getnexthighmonocount_user,
516 sizeof(getnexthighmonocount)))
519 status = efi.get_next_high_mono_count(
520 getnexthighmonocount.high_count ? &count : NULL);
522 if (put_user(status, getnexthighmonocount.status))
525 if (status != EFI_SUCCESS)
528 if (getnexthighmonocount.high_count &&
529 put_user(count, getnexthighmonocount.high_count))
535 static long efi_runtime_reset_system(unsigned long arg)
537 struct efi_resetsystem __user *resetsystem_user;
538 struct efi_resetsystem resetsystem;
541 resetsystem_user = (struct efi_resetsystem __user *)arg;
542 if (copy_from_user(&resetsystem, resetsystem_user,
543 sizeof(resetsystem)))
545 if (resetsystem.data_size != 0) {
546 data = memdup_user((void *)resetsystem.data,
547 resetsystem.data_size);
549 return PTR_ERR(data);
552 efi.reset_system(resetsystem.reset_type, resetsystem.status,
553 resetsystem.data_size, (efi_char16_t *)data);
559 static long efi_runtime_query_variableinfo(unsigned long arg)
561 struct efi_queryvariableinfo __user *queryvariableinfo_user;
562 struct efi_queryvariableinfo queryvariableinfo;
564 u64 max_storage, remaining, max_size;
566 queryvariableinfo_user = (struct efi_queryvariableinfo __user *)arg;
568 if (copy_from_user(&queryvariableinfo, queryvariableinfo_user,
569 sizeof(queryvariableinfo)))
572 status = efi.query_variable_info(queryvariableinfo.attributes,
573 &max_storage, &remaining, &max_size);
575 if (put_user(status, queryvariableinfo.status))
578 if (status != EFI_SUCCESS)
581 if (put_user(max_storage,
582 queryvariableinfo.maximum_variable_storage_size))
585 if (put_user(remaining,
586 queryvariableinfo.remaining_variable_storage_size))
589 if (put_user(max_size, queryvariableinfo.maximum_variable_size))
595 static long efi_runtime_query_capsulecaps(unsigned long arg)
597 struct efi_querycapsulecapabilities __user *qcaps_user;
598 struct efi_querycapsulecapabilities qcaps;
599 efi_capsule_header_t *capsules;
605 qcaps_user = (struct efi_querycapsulecapabilities __user *)arg;
607 if (copy_from_user(&qcaps, qcaps_user, sizeof(qcaps)))
610 if (qcaps.capsule_count == ULONG_MAX)
613 capsules = kcalloc(qcaps.capsule_count + 1,
614 sizeof(efi_capsule_header_t), GFP_KERNEL);
618 for (i = 0; i < qcaps.capsule_count; i++) {
619 efi_capsule_header_t *c;
621 * We cannot dereference qcaps.capsule_header_array directly to
622 * obtain the address of the capsule as it resides in the
625 if (get_user(c, qcaps.capsule_header_array + i)) {
629 if (copy_from_user(&capsules[i], c,
630 sizeof(efi_capsule_header_t))) {
636 qcaps.capsule_header_array = &capsules;
638 status = efi.query_capsule_caps((efi_capsule_header_t **)
639 qcaps.capsule_header_array,
641 &max_size, &reset_type);
643 if (put_user(status, qcaps.status)) {
648 if (status != EFI_SUCCESS) {
653 if (put_user(max_size, qcaps.maximum_capsule_size)) {
658 if (put_user(reset_type, qcaps.reset_type))
666 static long efi_test_ioctl(struct file *file, unsigned int cmd,
670 case EFI_RUNTIME_GET_VARIABLE:
671 return efi_runtime_get_variable(arg);
673 case EFI_RUNTIME_SET_VARIABLE:
674 return efi_runtime_set_variable(arg);
676 case EFI_RUNTIME_GET_TIME:
677 return efi_runtime_get_time(arg);
679 case EFI_RUNTIME_SET_TIME:
680 return efi_runtime_set_time(arg);
682 case EFI_RUNTIME_GET_WAKETIME:
683 return efi_runtime_get_waketime(arg);
685 case EFI_RUNTIME_SET_WAKETIME:
686 return efi_runtime_set_waketime(arg);
688 case EFI_RUNTIME_GET_NEXTVARIABLENAME:
689 return efi_runtime_get_nextvariablename(arg);
691 case EFI_RUNTIME_GET_NEXTHIGHMONOTONICCOUNT:
692 return efi_runtime_get_nexthighmonocount(arg);
694 case EFI_RUNTIME_QUERY_VARIABLEINFO:
695 return efi_runtime_query_variableinfo(arg);
697 case EFI_RUNTIME_QUERY_CAPSULECAPABILITIES:
698 return efi_runtime_query_capsulecaps(arg);
700 case EFI_RUNTIME_RESET_SYSTEM:
701 return efi_runtime_reset_system(arg);
707 static int efi_test_open(struct inode *inode, struct file *file)
709 int ret = security_locked_down(LOCKDOWN_EFI_TEST);
714 if (!capable(CAP_SYS_ADMIN))
717 * nothing special to do here
718 * We do accept multiple open files at the same time as we
719 * synchronize on the per call operation.
724 static int efi_test_close(struct inode *inode, struct file *file)
730 * The various file operations we support.
732 static const struct file_operations efi_test_fops = {
733 .owner = THIS_MODULE,
734 .unlocked_ioctl = efi_test_ioctl,
735 .open = efi_test_open,
736 .release = efi_test_close,
740 static struct miscdevice efi_test_dev = {
746 static int __init efi_test_init(void)
750 ret = misc_register(&efi_test_dev);
752 pr_err("efi_test: can't misc_register on minor=%d\n",
760 static void __exit efi_test_exit(void)
762 misc_deregister(&efi_test_dev);
765 module_init(efi_test_init);
766 module_exit(efi_test_exit);