diff options
| author | Linus Torvalds <torvalds@linux-foundation.org> | 2016-05-16 16:06:27 -0400 |
|---|---|---|
| committer | Linus Torvalds <torvalds@linux-foundation.org> | 2016-05-16 16:06:27 -0400 |
| commit | 49817c33433a3cd6f320b13699e6746cc39b453b (patch) | |
| tree | 1eb8c4a4d585e648b0783741c02ab611149971d9 /drivers/firmware/efi/capsule.c | |
| parent | 230e51f21101e49c8d73018d414adbd0d57459a1 (diff) | |
| parent | 6c5450ef66816216e574885cf8d3ddb31ef77428 (diff) | |
Merge branch 'efi-core-for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/tip/tip
Pull EFI updates from Ingo Molnar:
"The main changes in this cycle were:
- Drop the unused EFI_SYSTEM_TABLES efi.flags bit and ensure the
ARM/arm64 EFI System Table mapping is read-only (Ard Biesheuvel)
- Add a comment to explain that one of the code paths in the x86/pat
code is only executed for EFI boot (Matt Fleming)
- Improve Secure Boot status checks on arm64 and handle unexpected
errors (Linn Crosetto)
- Remove the global EFI memory map variable 'memmap' as the same
information is already available in efi::memmap (Matt Fleming)
- Add EFI Memory Attribute table support for ARM/arm64 (Ard
Biesheuvel)
- Add EFI GOP framebuffer support for ARM/arm64 (Ard Biesheuvel)
- Add EFI Bootloader Control driver for storing reboot(2) data in EFI
variables for consumption by bootloaders (Jeremy Compostella)
- Add Core EFI capsule support (Matt Fleming)
- Add EFI capsule char driver (Kweh, Hock Leong)
- Unify EFI memory map code for ARM and arm64 (Ard Biesheuvel)
- Add generic EFI support for detecting when firmware corrupts CPU
status register bits (like IRQ flags) when performing EFI runtime
service calls (Mark Rutland)
... and other misc cleanups"
* 'efi-core-for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/tip/tip: (46 commits)
efivarfs: Make efivarfs_file_ioctl() static
efi: Merge boolean flag arguments
efi/capsule: Move 'capsule' to the stack in efi_capsule_supported()
efibc: Fix excessive stack footprint warning
efi/capsule: Make efi_capsule_pending() lockless
efi: Remove unnecessary (and buggy) .memmap initialization from the Xen EFI driver
efi/runtime-wrappers: Remove ARCH_EFI_IRQ_FLAGS_MASK #ifdef
x86/efi: Enable runtime call flag checking
arm/efi: Enable runtime call flag checking
arm64/efi: Enable runtime call flag checking
efi/runtime-wrappers: Detect firmware IRQ flag corruption
efi/runtime-wrappers: Remove redundant #ifdefs
x86/efi: Move to generic {__,}efi_call_virt()
arm/efi: Move to generic {__,}efi_call_virt()
arm64/efi: Move to generic {__,}efi_call_virt()
efi/runtime-wrappers: Add {__,}efi_call_virt() templates
efi/arm-init: Reserve rather than unmap the memory map for ARM as well
efi: Add misc char driver interface to update EFI firmware
x86/efi: Force EFI reboot to process pending capsules
efi: Add 'capsule' update support
...
Diffstat (limited to 'drivers/firmware/efi/capsule.c')
| -rw-r--r-- | drivers/firmware/efi/capsule.c | 308 |
1 files changed, 308 insertions, 0 deletions
diff --git a/drivers/firmware/efi/capsule.c b/drivers/firmware/efi/capsule.c new file mode 100644 index 000000000000..53b9fd2293ee --- /dev/null +++ b/drivers/firmware/efi/capsule.c | |||
| @@ -0,0 +1,308 @@ | |||
| 1 | /* | ||
| 2 | * EFI capsule support. | ||
| 3 | * | ||
| 4 | * Copyright 2013 Intel Corporation; author Matt Fleming | ||
| 5 | * | ||
| 6 | * This file is part of the Linux kernel, and is made available under | ||
| 7 | * the terms of the GNU General Public License version 2. | ||
| 8 | */ | ||
| 9 | |||
| 10 | #define pr_fmt(fmt) "efi: " fmt | ||
| 11 | |||
| 12 | #include <linux/slab.h> | ||
| 13 | #include <linux/mutex.h> | ||
| 14 | #include <linux/highmem.h> | ||
| 15 | #include <linux/efi.h> | ||
| 16 | #include <linux/vmalloc.h> | ||
| 17 | #include <asm/io.h> | ||
| 18 | |||
| 19 | typedef struct { | ||
| 20 | u64 length; | ||
| 21 | u64 data; | ||
| 22 | } efi_capsule_block_desc_t; | ||
| 23 | |||
| 24 | static bool capsule_pending; | ||
| 25 | static bool stop_capsules; | ||
| 26 | static int efi_reset_type = -1; | ||
| 27 | |||
| 28 | /* | ||
| 29 | * capsule_mutex serialises access to both capsule_pending and | ||
| 30 | * efi_reset_type and stop_capsules. | ||
| 31 | */ | ||
| 32 | static DEFINE_MUTEX(capsule_mutex); | ||
| 33 | |||
| 34 | /** | ||
| 35 | * efi_capsule_pending - has a capsule been passed to the firmware? | ||
| 36 | * @reset_type: store the type of EFI reset if capsule is pending | ||
| 37 | * | ||
| 38 | * To ensure that the registered capsule is processed correctly by the | ||
| 39 | * firmware we need to perform a specific type of reset. If a capsule is | ||
| 40 | * pending return the reset type in @reset_type. | ||
| 41 | * | ||
| 42 | * This function will race with callers of efi_capsule_update(), for | ||
| 43 | * example, calling this function while somebody else is in | ||
| 44 | * efi_capsule_update() but hasn't reached efi_capsue_update_locked() | ||
| 45 | * will miss the updates to capsule_pending and efi_reset_type after | ||
| 46 | * efi_capsule_update_locked() completes. | ||
| 47 | * | ||
| 48 | * A non-racy use is from platform reboot code because we use | ||
| 49 | * system_state to ensure no capsules can be sent to the firmware once | ||
| 50 | * we're at SYSTEM_RESTART. See efi_capsule_update_locked(). | ||
| 51 | */ | ||
| 52 | bool efi_capsule_pending(int *reset_type) | ||
| 53 | { | ||
| 54 | if (!capsule_pending) | ||
| 55 | return false; | ||
| 56 | |||
| 57 | if (reset_type) | ||
| 58 | *reset_type = efi_reset_type; | ||
| 59 | |||
| 60 | return true; | ||
| 61 | } | ||
| 62 | |||
| 63 | /* | ||
| 64 | * Whitelist of EFI capsule flags that we support. | ||
| 65 | * | ||
| 66 | * We do not handle EFI_CAPSULE_INITIATE_RESET because that would | ||
| 67 | * require us to prepare the kernel for reboot. Refuse to load any | ||
| 68 | * capsules with that flag and any other flags that we do not know how | ||
| 69 | * to handle. | ||
| 70 | */ | ||
| 71 | #define EFI_CAPSULE_SUPPORTED_FLAG_MASK \ | ||
| 72 | (EFI_CAPSULE_PERSIST_ACROSS_RESET | EFI_CAPSULE_POPULATE_SYSTEM_TABLE) | ||
| 73 | |||
| 74 | /** | ||
| 75 | * efi_capsule_supported - does the firmware support the capsule? | ||
| 76 | * @guid: vendor guid of capsule | ||
| 77 | * @flags: capsule flags | ||
| 78 | * @size: size of capsule data | ||
| 79 | * @reset: the reset type required for this capsule | ||
| 80 | * | ||
| 81 | * Check whether a capsule with @flags is supported by the firmware | ||
| 82 | * and that @size doesn't exceed the maximum size for a capsule. | ||
| 83 | * | ||
| 84 | * No attempt is made to check @reset against the reset type required | ||
| 85 | * by any pending capsules because of the races involved. | ||
| 86 | */ | ||
| 87 | int efi_capsule_supported(efi_guid_t guid, u32 flags, size_t size, int *reset) | ||
| 88 | { | ||
| 89 | efi_capsule_header_t capsule; | ||
| 90 | efi_capsule_header_t *cap_list[] = { &capsule }; | ||
| 91 | efi_status_t status; | ||
| 92 | u64 max_size; | ||
| 93 | |||
| 94 | if (flags & ~EFI_CAPSULE_SUPPORTED_FLAG_MASK) | ||
| 95 | return -EINVAL; | ||
| 96 | |||
| 97 | capsule.headersize = capsule.imagesize = sizeof(capsule); | ||
| 98 | memcpy(&capsule.guid, &guid, sizeof(efi_guid_t)); | ||
| 99 | capsule.flags = flags; | ||
| 100 | |||
| 101 | status = efi.query_capsule_caps(cap_list, 1, &max_size, reset); | ||
| 102 | if (status != EFI_SUCCESS) | ||
| 103 | return efi_status_to_err(status); | ||
| 104 | |||
| 105 | if (size > max_size) | ||
| 106 | return -ENOSPC; | ||
| 107 | |||
| 108 | return 0; | ||
| 109 | } | ||
| 110 | EXPORT_SYMBOL_GPL(efi_capsule_supported); | ||
| 111 | |||
| 112 | /* | ||
| 113 | * Every scatter gather list (block descriptor) page must end with a | ||
| 114 | * continuation pointer. The last continuation pointer of the last | ||
| 115 | * page must be zero to mark the end of the chain. | ||
| 116 | */ | ||
| 117 | #define SGLIST_PER_PAGE ((PAGE_SIZE / sizeof(efi_capsule_block_desc_t)) - 1) | ||
| 118 | |||
| 119 | /* | ||
| 120 | * How many scatter gather list (block descriptor) pages do we need | ||
| 121 | * to map @count pages? | ||
| 122 | */ | ||
| 123 | static inline unsigned int sg_pages_num(unsigned int count) | ||
| 124 | { | ||
| 125 | return DIV_ROUND_UP(count, SGLIST_PER_PAGE); | ||
| 126 | } | ||
| 127 | |||
| 128 | /** | ||
| 129 | * efi_capsule_update_locked - pass a single capsule to the firmware | ||
| 130 | * @capsule: capsule to send to the firmware | ||
| 131 | * @sg_pages: array of scatter gather (block descriptor) pages | ||
| 132 | * @reset: the reset type required for @capsule | ||
| 133 | * | ||
| 134 | * Since this function must be called under capsule_mutex check | ||
| 135 | * whether efi_reset_type will conflict with @reset, and atomically | ||
| 136 | * set it and capsule_pending if a capsule was successfully sent to | ||
| 137 | * the firmware. | ||
| 138 | * | ||
| 139 | * We also check to see if the system is about to restart, and if so, | ||
| 140 | * abort. This avoids races between efi_capsule_update() and | ||
| 141 | * efi_capsule_pending(). | ||
| 142 | */ | ||
| 143 | static int | ||
| 144 | efi_capsule_update_locked(efi_capsule_header_t *capsule, | ||
| 145 | struct page **sg_pages, int reset) | ||
| 146 | { | ||
| 147 | efi_physical_addr_t sglist_phys; | ||
| 148 | efi_status_t status; | ||
| 149 | |||
| 150 | lockdep_assert_held(&capsule_mutex); | ||
| 151 | |||
| 152 | /* | ||
| 153 | * If someone has already registered a capsule that requires a | ||
| 154 | * different reset type, we're out of luck and must abort. | ||
| 155 | */ | ||
| 156 | if (efi_reset_type >= 0 && efi_reset_type != reset) { | ||
| 157 | pr_err("Conflicting capsule reset type %d (%d).\n", | ||
| 158 | reset, efi_reset_type); | ||
| 159 | return -EINVAL; | ||
| 160 | } | ||
| 161 | |||
| 162 | /* | ||
| 163 | * If the system is getting ready to restart it may have | ||
| 164 | * called efi_capsule_pending() to make decisions (such as | ||
| 165 | * whether to force an EFI reboot), and we're racing against | ||
| 166 | * that call. Abort in that case. | ||
| 167 | */ | ||
| 168 | if (unlikely(stop_capsules)) { | ||
| 169 | pr_warn("Capsule update raced with reboot, aborting.\n"); | ||
| 170 | return -EINVAL; | ||
| 171 | } | ||
| 172 | |||
| 173 | sglist_phys = page_to_phys(sg_pages[0]); | ||
| 174 | |||
| 175 | status = efi.update_capsule(&capsule, 1, sglist_phys); | ||
| 176 | if (status == EFI_SUCCESS) { | ||
| 177 | capsule_pending = true; | ||
| 178 | efi_reset_type = reset; | ||
| 179 | } | ||
| 180 | |||
| 181 | return efi_status_to_err(status); | ||
| 182 | } | ||
| 183 | |||
| 184 | /** | ||
| 185 | * efi_capsule_update - send a capsule to the firmware | ||
| 186 | * @capsule: capsule to send to firmware | ||
| 187 | * @pages: an array of capsule data pages | ||
| 188 | * | ||
| 189 | * Build a scatter gather list with EFI capsule block descriptors to | ||
| 190 | * map the capsule described by @capsule with its data in @pages and | ||
| 191 | * send it to the firmware via the UpdateCapsule() runtime service. | ||
| 192 | * | ||
| 193 | * @capsule must be a virtual mapping of the first page in @pages | ||
| 194 | * (@pages[0]) in the kernel address space. That is, a | ||
| 195 | * capsule_header_t that describes the entire contents of the capsule | ||
| 196 | * must be at the start of the first data page. | ||
| 197 | * | ||
| 198 | * Even though this function will validate that the firmware supports | ||
| 199 | * the capsule guid, users will likely want to check that | ||
| 200 | * efi_capsule_supported() returns true before calling this function | ||
| 201 | * because it makes it easier to print helpful error messages. | ||
| 202 | * | ||
| 203 | * If the capsule is successfully submitted to the firmware, any | ||
| 204 | * subsequent calls to efi_capsule_pending() will return true. @pages | ||
| 205 | * must not be released or modified if this function returns | ||
| 206 | * successfully. | ||
| 207 | * | ||
| 208 | * Callers must be prepared for this function to fail, which can | ||
| 209 | * happen if we raced with system reboot or if there is already a | ||
| 210 | * pending capsule that has a reset type that conflicts with the one | ||
| 211 | * required by @capsule. Do NOT use efi_capsule_pending() to detect | ||
| 212 | * this conflict since that would be racy. Instead, submit the capsule | ||
| 213 | * to efi_capsule_update() and check the return value. | ||
| 214 | * | ||
| 215 | * Return 0 on success, a converted EFI status code on failure. | ||
| 216 | */ | ||
| 217 | int efi_capsule_update(efi_capsule_header_t *capsule, struct page **pages) | ||
| 218 | { | ||
| 219 | u32 imagesize = capsule->imagesize; | ||
| 220 | efi_guid_t guid = capsule->guid; | ||
| 221 | unsigned int count, sg_count; | ||
| 222 | u32 flags = capsule->flags; | ||
| 223 | struct page **sg_pages; | ||
| 224 | int rv, reset_type; | ||
| 225 | int i, j; | ||
| 226 | |||
| 227 | rv = efi_capsule_supported(guid, flags, imagesize, &reset_type); | ||
| 228 | if (rv) | ||
| 229 | return rv; | ||
| 230 | |||
| 231 | count = DIV_ROUND_UP(imagesize, PAGE_SIZE); | ||
| 232 | sg_count = sg_pages_num(count); | ||
| 233 | |||
| 234 | sg_pages = kzalloc(sg_count * sizeof(*sg_pages), GFP_KERNEL); | ||
| 235 | if (!sg_pages) | ||
| 236 | return -ENOMEM; | ||
| 237 | |||
| 238 | for (i = 0; i < sg_count; i++) { | ||
| 239 | sg_pages[i] = alloc_page(GFP_KERNEL); | ||
| 240 | if (!sg_pages[i]) { | ||
| 241 | rv = -ENOMEM; | ||
| 242 | goto out; | ||
| 243 | } | ||
| 244 | } | ||
| 245 | |||
| 246 | for (i = 0; i < sg_count; i++) { | ||
| 247 | efi_capsule_block_desc_t *sglist; | ||
| 248 | |||
| 249 | sglist = kmap(sg_pages[i]); | ||
| 250 | if (!sglist) { | ||
| 251 | rv = -ENOMEM; | ||
| 252 | goto out; | ||
| 253 | } | ||
| 254 | |||
| 255 | for (j = 0; j < SGLIST_PER_PAGE && count > 0; j++) { | ||
| 256 | u64 sz = min_t(u64, imagesize, PAGE_SIZE); | ||
| 257 | |||
| 258 | sglist[j].length = sz; | ||
| 259 | sglist[j].data = page_to_phys(*pages++); | ||
| 260 | |||
| 261 | imagesize -= sz; | ||
| 262 | count--; | ||
| 263 | } | ||
| 264 | |||
| 265 | /* Continuation pointer */ | ||
| 266 | sglist[j].length = 0; | ||
| 267 | |||
| 268 | if (i + 1 == sg_count) | ||
| 269 | sglist[j].data = 0; | ||
| 270 | else | ||
| 271 | sglist[j].data = page_to_phys(sg_pages[i + 1]); | ||
| 272 | |||
| 273 | kunmap(sg_pages[i]); | ||
| 274 | } | ||
| 275 | |||
| 276 | mutex_lock(&capsule_mutex); | ||
| 277 | rv = efi_capsule_update_locked(capsule, sg_pages, reset_type); | ||
| 278 | mutex_unlock(&capsule_mutex); | ||
| 279 | |||
| 280 | out: | ||
| 281 | for (i = 0; rv && i < sg_count; i++) { | ||
| 282 | if (sg_pages[i]) | ||
| 283 | __free_page(sg_pages[i]); | ||
| 284 | } | ||
| 285 | |||
| 286 | kfree(sg_pages); | ||
| 287 | return rv; | ||
| 288 | } | ||
| 289 | EXPORT_SYMBOL_GPL(efi_capsule_update); | ||
| 290 | |||
| 291 | static int capsule_reboot_notify(struct notifier_block *nb, unsigned long event, void *cmd) | ||
| 292 | { | ||
| 293 | mutex_lock(&capsule_mutex); | ||
| 294 | stop_capsules = true; | ||
| 295 | mutex_unlock(&capsule_mutex); | ||
| 296 | |||
| 297 | return NOTIFY_DONE; | ||
| 298 | } | ||
| 299 | |||
| 300 | static struct notifier_block capsule_reboot_nb = { | ||
| 301 | .notifier_call = capsule_reboot_notify, | ||
| 302 | }; | ||
| 303 | |||
| 304 | static int __init capsule_reboot_register(void) | ||
| 305 | { | ||
| 306 | return register_reboot_notifier(&capsule_reboot_nb); | ||
| 307 | } | ||
| 308 | core_initcall(capsule_reboot_register); | ||
