2 * PowerNV OPAL Firmware Update Interface
4 * Copyright 2013 IBM Corp.
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
14 #include <linux/kernel.h>
15 #include <linux/reboot.h>
16 #include <linux/init.h>
17 #include <linux/kobject.h>
18 #include <linux/sysfs.h>
19 #include <linux/slab.h>
21 #include <linux/vmalloc.h>
22 #include <linux/pagemap.h>
26 /* FLASH status codes */
27 #define FLASH_NO_OP -1099 /* No operation initiated by user */
28 #define FLASH_NO_AUTH -9002 /* Not a service authority partition */
30 /* Validate image status values */
31 #define VALIDATE_IMG_READY -1001 /* Image ready for validation */
32 #define VALIDATE_IMG_INCOMPLETE -1002 /* User copied < VALIDATE_BUF_SIZE */
34 /* Manage image status values */
35 #define MANAGE_ACTIVE_ERR -9001 /* Cannot overwrite active img */
37 /* Flash image status values */
38 #define FLASH_IMG_READY 0 /* Img ready for flash on reboot */
39 #define FLASH_INVALID_IMG -1003 /* Flash image shorter than expected */
40 #define FLASH_IMG_NULL_DATA -1004 /* Bad data in sg list entry */
41 #define FLASH_IMG_BAD_LEN -1005 /* Bad length in sg list entry */
43 /* Manage operation tokens */
44 #define FLASH_REJECT_TMP_SIDE 0 /* Reject temporary fw image */
45 #define FLASH_COMMIT_TMP_SIDE 1 /* Commit temporary fw image */
48 #define FLASH_UPDATE_CANCEL 0 /* Cancel update request */
49 #define FLASH_UPDATE_INIT 1 /* Initiate update */
51 /* Validate image update result tokens */
52 #define VALIDATE_TMP_UPDATE 0 /* T side will be updated */
53 #define VALIDATE_FLASH_AUTH 1 /* Partition does not have authority */
54 #define VALIDATE_INVALID_IMG 2 /* Candidate image is not valid */
55 #define VALIDATE_CUR_UNKNOWN 3 /* Current fixpack level is unknown */
57 * Current T side will be committed to P side before being replace with new
58 * image, and the new image is downlevel from current image
60 #define VALIDATE_TMP_COMMIT_DL 4
62 * Current T side will be committed to P side before being replaced with new
65 #define VALIDATE_TMP_COMMIT 5
67 * T side will be updated with a downlevel image
69 #define VALIDATE_TMP_UPDATE_DL 6
71 * The candidate image's release date is later than the system's firmware
72 * service entitlement date - service warranty period has expired
74 #define VALIDATE_OUT_OF_WRNTY 7
76 /* Validate buffer size */
77 #define VALIDATE_BUF_SIZE 4096
79 /* XXX: Assume candidate image size is <= 1GB */
80 #define MAX_IMAGE_SIZE 0x40000000
89 /* Candidate image data */
96 /* Candidate image header */
97 struct image_header_t {
103 struct validate_flash_t {
104 int status; /* Return status */
105 void *buf; /* Candidate image buffer */
106 uint32_t buf_size; /* Image size */
107 uint32_t result; /* Update results token */
110 struct manage_flash_t {
111 int status; /* Return status */
114 struct update_flash_t {
115 int status; /* Return status */
118 static struct image_header_t image_header;
119 static struct image_data_t image_data;
120 static struct validate_flash_t validate_flash_data;
121 static struct manage_flash_t manage_flash_data;
122 static struct update_flash_t update_flash_data;
124 static DEFINE_MUTEX(image_data_mutex);
127 * Validate candidate image
129 static inline void opal_flash_validate(void)
132 void *buf = validate_flash_data.buf;
135 ret = opal_validate_flash(__pa(buf), &size, &result);
137 validate_flash_data.status = ret;
138 validate_flash_data.buf_size = be32_to_cpu(size);
139 validate_flash_data.result = be32_to_cpu(result);
143 * Validate output format:
144 * validate result token
145 * current image version details
146 * new image version details
148 static ssize_t validate_show(struct kobject *kobj,
149 struct kobj_attribute *attr, char *buf)
151 struct validate_flash_t *args_buf = &validate_flash_data;
154 /* Candidate image is not validated */
155 if (args_buf->status < VALIDATE_TMP_UPDATE) {
156 len = sprintf(buf, "%d\n", args_buf->status);
161 len = sprintf(buf, "%d\n", args_buf->result);
163 /* Current and candidate image version details */
164 if ((args_buf->result != VALIDATE_TMP_UPDATE) &&
165 (args_buf->result < VALIDATE_CUR_UNKNOWN))
168 if (args_buf->buf_size > (VALIDATE_BUF_SIZE - len)) {
169 memcpy(buf + len, args_buf->buf, VALIDATE_BUF_SIZE - len);
170 len = VALIDATE_BUF_SIZE;
172 memcpy(buf + len, args_buf->buf, args_buf->buf_size);
173 len += args_buf->buf_size;
176 /* Set status to default */
177 args_buf->status = FLASH_NO_OP;
182 * Validate candidate firmware image
185 * We are only interested in first 4K bytes of the
188 static ssize_t validate_store(struct kobject *kobj,
189 struct kobj_attribute *attr,
190 const char *buf, size_t count)
192 struct validate_flash_t *args_buf = &validate_flash_data;
197 mutex_lock(&image_data_mutex);
199 if (image_data.status != IMAGE_READY ||
200 image_data.size < VALIDATE_BUF_SIZE) {
201 args_buf->result = VALIDATE_INVALID_IMG;
202 args_buf->status = VALIDATE_IMG_INCOMPLETE;
206 /* Copy first 4k bytes of candidate image */
207 memcpy(args_buf->buf, image_data.data, VALIDATE_BUF_SIZE);
209 args_buf->status = VALIDATE_IMG_READY;
210 args_buf->buf_size = VALIDATE_BUF_SIZE;
212 /* Validate candidate image */
213 opal_flash_validate();
216 mutex_unlock(&image_data_mutex);
221 * Manage flash routine
223 static inline void opal_flash_manage(uint8_t op)
225 struct manage_flash_t *const args_buf = &manage_flash_data;
227 args_buf->status = opal_manage_flash(op);
231 * Show manage flash status
233 static ssize_t manage_show(struct kobject *kobj,
234 struct kobj_attribute *attr, char *buf)
236 struct manage_flash_t *const args_buf = &manage_flash_data;
239 rc = sprintf(buf, "%d\n", args_buf->status);
240 /* Set status to default*/
241 args_buf->status = FLASH_NO_OP;
250 static ssize_t manage_store(struct kobject *kobj,
251 struct kobj_attribute *attr,
252 const char *buf, size_t count)
257 op = FLASH_REJECT_TMP_SIDE;
260 op = FLASH_COMMIT_TMP_SIDE;
266 /* commit/reject temporary image */
267 opal_flash_manage(op);
274 static int opal_flash_update(int op)
276 struct opal_sg_list *list;
278 int64_t rc = OPAL_PARAMETER;
280 if (op == FLASH_UPDATE_CANCEL) {
281 pr_alert("FLASH: Image update cancelled\n");
286 list = opal_vmalloc_to_sg_list(image_data.data, image_data.size);
290 /* First entry address */
293 pr_alert("FLASH: Image is %u bytes\n", image_data.size);
294 pr_alert("FLASH: Image update requested\n");
295 pr_alert("FLASH: Image will be updated during system reboot\n");
296 pr_alert("FLASH: This will take several minutes. Do not power off!\n");
299 rc = opal_update_flash(addr);
306 * Show candidate image status
308 static ssize_t update_show(struct kobject *kobj,
309 struct kobj_attribute *attr, char *buf)
311 struct update_flash_t *const args_buf = &update_flash_data;
312 return sprintf(buf, "%d\n", args_buf->status);
316 * Set update image flag
317 * 1 - Flash new image
318 * 0 - Cancel flash request
320 static ssize_t update_store(struct kobject *kobj,
321 struct kobj_attribute *attr,
322 const char *buf, size_t count)
324 struct update_flash_t *const args_buf = &update_flash_data;
327 mutex_lock(&image_data_mutex);
331 if (args_buf->status == FLASH_IMG_READY)
332 opal_flash_update(FLASH_UPDATE_CANCEL);
333 args_buf->status = FLASH_NO_OP;
336 /* Image is loaded? */
337 if (image_data.status == IMAGE_READY)
339 opal_flash_update(FLASH_UPDATE_INIT);
341 args_buf->status = FLASH_INVALID_IMG;
347 mutex_unlock(&image_data_mutex);
354 static void free_image_buf(void)
359 addr = image_data.data;
360 size = PAGE_ALIGN(image_data.size);
362 ClearPageReserved(vmalloc_to_page(addr));
366 vfree(image_data.data);
367 image_data.data = NULL;
368 image_data.status = IMAGE_INVALID;
372 * Allocate image buffer.
374 static int alloc_image_buf(char *buffer, size_t count)
379 if (count < sizeof(struct image_header_t)) {
380 pr_warn("FLASH: Invalid candidate image\n");
384 memcpy(&image_header, (void *)buffer, sizeof(struct image_header_t));
385 image_data.size = be32_to_cpu(image_header.size);
386 pr_debug("FLASH: Candidate image size = %u\n", image_data.size);
388 if (image_data.size > MAX_IMAGE_SIZE) {
389 pr_warn("FLASH: Too large image\n");
392 if (image_data.size < VALIDATE_BUF_SIZE) {
393 pr_warn("FLASH: Image is shorter than expected\n");
397 image_data.data = vzalloc(PAGE_ALIGN(image_data.size));
398 if (!image_data.data) {
399 pr_err("%s : Failed to allocate memory\n", __func__);
404 addr = image_data.data;
405 size = PAGE_ALIGN(image_data.size);
407 SetPageReserved(vmalloc_to_page(addr));
412 image_data.status = IMAGE_LOADING;
417 * Copy candidate image
419 * Parse candidate image header to get total image size
420 * and pre-allocate required memory.
422 static ssize_t image_data_write(struct file *filp, struct kobject *kobj,
423 struct bin_attribute *bin_attr,
424 char *buffer, loff_t pos, size_t count)
428 mutex_lock(&image_data_mutex);
432 /* Free memory, if already allocated */
436 /* Cancel outstanding image update request */
437 if (update_flash_data.status == FLASH_IMG_READY)
438 opal_flash_update(FLASH_UPDATE_CANCEL);
440 /* Allocate memory */
441 rc = alloc_image_buf(buffer, count);
446 if (image_data.status != IMAGE_LOADING) {
451 if ((pos + count) > image_data.size) {
456 memcpy(image_data.data + pos, (void *)buffer, count);
459 /* Set image status */
460 if ((pos + count) == image_data.size) {
461 pr_debug("FLASH: Candidate image loaded....\n");
462 image_data.status = IMAGE_READY;
466 mutex_unlock(&image_data_mutex);
472 * OPAL uses below sysfs files for code update.
473 * We create these files under /sys/firmware/opal.
475 * image : Interface to load candidate firmware image
476 * validate_flash : Validate firmware image
477 * manage_flash : Commit/Reject firmware image
478 * update_flash : Flash new firmware image
481 static struct bin_attribute image_data_attr = {
482 .attr = {.name = "image", .mode = 0200},
483 .size = MAX_IMAGE_SIZE, /* Limit image size */
484 .write = image_data_write,
487 static struct kobj_attribute validate_attribute =
488 __ATTR(validate_flash, 0600, validate_show, validate_store);
490 static struct kobj_attribute manage_attribute =
491 __ATTR(manage_flash, 0600, manage_show, manage_store);
493 static struct kobj_attribute update_attribute =
494 __ATTR(update_flash, 0600, update_show, update_store);
496 static struct attribute *image_op_attrs[] = {
497 &validate_attribute.attr,
498 &manage_attribute.attr,
499 &update_attribute.attr,
500 NULL /* need to NULL terminate the list of attributes */
503 static struct attribute_group image_op_attr_group = {
504 .attrs = image_op_attrs,
507 void __init opal_flash_init(void)
511 /* Allocate validate image buffer */
512 validate_flash_data.buf = kzalloc(VALIDATE_BUF_SIZE, GFP_KERNEL);
513 if (!validate_flash_data.buf) {
514 pr_err("%s : Failed to allocate memory\n", __func__);
518 /* Make sure /sys/firmware/opal directory is created */
520 pr_warn("FLASH: opal kobject is not available\n");
524 /* Create the sysfs files */
525 ret = sysfs_create_group(opal_kobj, &image_op_attr_group);
527 pr_warn("FLASH: Failed to create sysfs files\n");
531 ret = sysfs_create_bin_file(opal_kobj, &image_data_attr);
533 pr_warn("FLASH: Failed to create sysfs files\n");
537 /* Set default status */
538 validate_flash_data.status = FLASH_NO_OP;
539 manage_flash_data.status = FLASH_NO_OP;
540 update_flash_data.status = FLASH_NO_OP;
541 image_data.status = IMAGE_INVALID;
545 sysfs_remove_group(opal_kobj, &image_op_attr_group);
548 kfree(validate_flash_data.buf);