1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * c 2001 PPC 64 Team, IBM Corp
5 * /proc/powerpc/rtas/firmware_flash interface
7 * This file implements a firmware_flash interface to pump a firmware
8 * image into the kernel. At reboot time rtas_restart() will see the
9 * firmware image and flash it as it reboots (see rtas.c).
12 #include <linux/module.h>
13 #include <linux/init.h>
14 #include <linux/slab.h>
15 #include <linux/proc_fs.h>
16 #include <linux/reboot.h>
17 #include <asm/delay.h>
18 #include <linux/uaccess.h>
21 #define MODULE_VERS "1.0"
22 #define MODULE_NAME "rtas_flash"
24 #define FIRMWARE_FLASH_NAME "firmware_flash"
25 #define FIRMWARE_UPDATE_NAME "firmware_update"
26 #define MANAGE_FLASH_NAME "manage_flash"
27 #define VALIDATE_FLASH_NAME "validate_flash"
29 /* General RTAS Status Codes */
30 #define RTAS_RC_SUCCESS 0
31 #define RTAS_RC_HW_ERR -1
32 #define RTAS_RC_BUSY -2
34 /* Flash image status values */
35 #define FLASH_AUTH -9002 /* RTAS Not Service Authority Partition */
36 #define FLASH_NO_OP -1099 /* No operation initiated by user */
37 #define FLASH_IMG_SHORT -1005 /* Flash image shorter than expected */
38 #define FLASH_IMG_BAD_LEN -1004 /* Bad length value in flash list block */
39 #define FLASH_IMG_NULL_DATA -1003 /* Bad data value in flash list block */
40 #define FLASH_IMG_READY 0 /* Firmware img ready for flash on reboot */
42 /* Manage image status values */
43 #define MANAGE_AUTH -9002 /* RTAS Not Service Authority Partition */
44 #define MANAGE_ACTIVE_ERR -9001 /* RTAS Cannot Overwrite Active Img */
45 #define MANAGE_NO_OP -1099 /* No operation initiated by user */
46 #define MANAGE_PARAM_ERR -3 /* RTAS Parameter Error */
47 #define MANAGE_HW_ERR -1 /* RTAS Hardware Error */
49 /* Validate image status values */
50 #define VALIDATE_AUTH -9002 /* RTAS Not Service Authority Partition */
51 #define VALIDATE_NO_OP -1099 /* No operation initiated by the user */
52 #define VALIDATE_INCOMPLETE -1002 /* User copied < VALIDATE_BUF_SIZE */
53 #define VALIDATE_READY -1001 /* Firmware image ready for validation */
54 #define VALIDATE_PARAM_ERR -3 /* RTAS Parameter Error */
55 #define VALIDATE_HW_ERR -1 /* RTAS Hardware Error */
57 /* ibm,validate-flash-image update result tokens */
58 #define VALIDATE_TMP_UPDATE 0 /* T side will be updated */
59 #define VALIDATE_FLASH_AUTH 1 /* Partition does not have authority */
60 #define VALIDATE_INVALID_IMG 2 /* Candidate image is not valid */
61 #define VALIDATE_CUR_UNKNOWN 3 /* Current fixpack level is unknown */
63 * Current T side will be committed to P side before being replace with new
64 * image, and the new image is downlevel from current image
66 #define VALIDATE_TMP_COMMIT_DL 4
68 * Current T side will be committed to P side before being replaced with new
71 #define VALIDATE_TMP_COMMIT 5
73 * T side will be updated with a downlevel image
75 #define VALIDATE_TMP_UPDATE_DL 6
77 * The candidate image's release date is later than the system's firmware
78 * service entitlement date - service warranty period has expired
80 #define VALIDATE_OUT_OF_WRNTY 7
82 /* ibm,manage-flash-image operation tokens */
83 #define RTAS_REJECT_TMP_IMG 0
84 #define RTAS_COMMIT_TMP_IMG 1
87 #define VALIDATE_BUF_SIZE 4096
88 #define VALIDATE_MSG_LEN 256
89 #define RTAS_MSG_MAXLEN 64
91 /* Quirk - RTAS requires 4k list length and block size */
92 #define RTAS_BLKLIST_LENGTH 4096
93 #define RTAS_BLK_SIZE 4096
100 /* This struct is very similar but not identical to
101 * that needed by the rtas flash update.
102 * All we need to do for rtas is rewrite num_blocks
103 * into a version/length and translate the pointers
106 #define FLASH_BLOCKS_PER_NODE ((RTAS_BLKLIST_LENGTH - 16) / sizeof(struct flash_block))
107 struct flash_block_list {
108 unsigned long num_blocks;
109 struct flash_block_list *next;
110 struct flash_block blocks[FLASH_BLOCKS_PER_NODE];
113 static struct flash_block_list *rtas_firmware_flash_list;
115 /* Use slab cache to guarantee 4k alignment */
116 static struct kmem_cache *flash_block_cache = NULL;
118 #define FLASH_BLOCK_LIST_VERSION (1UL)
121 * Local copy of the flash block list.
123 * The rtas_firmware_flash_list varable will be
124 * set once the data is fully read.
126 * For convenience as we build the list we use virtual addrs,
127 * we do not fill in the version number, and the length field
128 * is treated as the number of entries currently in the block
129 * (i.e. not a byte count). This is all fixed when calling
133 /* Status int must be first member of struct */
134 struct rtas_update_flash_t
136 int status; /* Flash update status */
137 struct flash_block_list *flist; /* Local copy of flash block list */
140 /* Status int must be first member of struct */
141 struct rtas_manage_flash_t
143 int status; /* Returned status */
146 /* Status int must be first member of struct */
147 struct rtas_validate_flash_t
149 int status; /* Returned status */
150 char *buf; /* Candidate image buffer */
151 unsigned int buf_size; /* Size of image buf */
152 unsigned int update_results; /* Update results token */
155 static struct rtas_update_flash_t rtas_update_flash_data;
156 static struct rtas_manage_flash_t rtas_manage_flash_data;
157 static struct rtas_validate_flash_t rtas_validate_flash_data;
158 static DEFINE_MUTEX(rtas_update_flash_mutex);
159 static DEFINE_MUTEX(rtas_manage_flash_mutex);
160 static DEFINE_MUTEX(rtas_validate_flash_mutex);
162 /* Do simple sanity checks on the flash image. */
163 static int flash_list_valid(struct flash_block_list *flist)
165 struct flash_block_list *f;
167 unsigned long block_size, image_size;
169 /* Paranoid self test here. We also collect the image size. */
171 for (f = flist; f; f = f->next) {
172 for (i = 0; i < f->num_blocks; i++) {
173 if (f->blocks[i].data == NULL) {
174 return FLASH_IMG_NULL_DATA;
176 block_size = f->blocks[i].length;
177 if (block_size <= 0 || block_size > RTAS_BLK_SIZE) {
178 return FLASH_IMG_BAD_LEN;
180 image_size += block_size;
184 if (image_size < (256 << 10)) {
189 printk(KERN_INFO "FLASH: flash image with %ld bytes stored for hardware flash on reboot\n", image_size);
191 return FLASH_IMG_READY;
194 static void free_flash_list(struct flash_block_list *f)
196 struct flash_block_list *next;
200 for (i = 0; i < f->num_blocks; i++)
201 kmem_cache_free(flash_block_cache, f->blocks[i].data);
203 kmem_cache_free(flash_block_cache, f);
208 static int rtas_flash_release(struct inode *inode, struct file *file)
210 struct rtas_update_flash_t *const uf = &rtas_update_flash_data;
212 mutex_lock(&rtas_update_flash_mutex);
215 /* File was opened in write mode for a new flash attempt */
216 /* Clear saved list */
217 if (rtas_firmware_flash_list) {
218 free_flash_list(rtas_firmware_flash_list);
219 rtas_firmware_flash_list = NULL;
222 if (uf->status != FLASH_AUTH)
223 uf->status = flash_list_valid(uf->flist);
225 if (uf->status == FLASH_IMG_READY)
226 rtas_firmware_flash_list = uf->flist;
228 free_flash_list(uf->flist);
233 mutex_unlock(&rtas_update_flash_mutex);
237 static size_t get_flash_status_msg(int status, char *buf)
244 msg = "error: this partition does not have service authority\n";
247 msg = "info: no firmware image for flash\n";
249 case FLASH_IMG_SHORT:
250 msg = "error: flash image short\n";
252 case FLASH_IMG_BAD_LEN:
253 msg = "error: internal error bad length\n";
255 case FLASH_IMG_NULL_DATA:
256 msg = "error: internal error null data\n";
258 case FLASH_IMG_READY:
259 msg = "ready: firmware image ready for flash on reboot\n";
262 return sprintf(buf, "error: unexpected status value %d\n",
267 memcpy(buf, msg, len + 1);
271 /* Reading the proc file will show status (not the firmware contents) */
272 static ssize_t rtas_flash_read_msg(struct file *file, char __user *buf,
273 size_t count, loff_t *ppos)
275 struct rtas_update_flash_t *const uf = &rtas_update_flash_data;
276 char msg[RTAS_MSG_MAXLEN];
280 mutex_lock(&rtas_update_flash_mutex);
282 mutex_unlock(&rtas_update_flash_mutex);
284 /* Read as text message */
285 len = get_flash_status_msg(status, msg);
286 return simple_read_from_buffer(buf, count, ppos, msg, len);
289 static ssize_t rtas_flash_read_num(struct file *file, char __user *buf,
290 size_t count, loff_t *ppos)
292 struct rtas_update_flash_t *const uf = &rtas_update_flash_data;
293 char msg[RTAS_MSG_MAXLEN];
296 mutex_lock(&rtas_update_flash_mutex);
298 mutex_unlock(&rtas_update_flash_mutex);
301 sprintf(msg, "%d\n", status);
302 return simple_read_from_buffer(buf, count, ppos, msg, strlen(msg));
305 /* We could be much more efficient here. But to keep this function
306 * simple we allocate a page to the block list no matter how small the
307 * count is. If the system is low on memory it will be just as well
310 static ssize_t rtas_flash_write(struct file *file, const char __user *buffer,
311 size_t count, loff_t *off)
313 struct rtas_update_flash_t *const uf = &rtas_update_flash_data;
316 struct flash_block_list *fl;
318 mutex_lock(&rtas_update_flash_mutex);
320 if (uf->status == FLASH_AUTH || count == 0)
321 goto out; /* discard data */
323 /* In the case that the image is not ready for flashing, the memory
324 * allocated for the block list will be freed upon the release of the
327 if (uf->flist == NULL) {
328 uf->flist = kmem_cache_zalloc(flash_block_cache, GFP_KERNEL);
335 fl = fl->next; /* seek to last block_list for append */
336 next_free = fl->num_blocks;
337 if (next_free == FLASH_BLOCKS_PER_NODE) {
338 /* Need to allocate another block_list */
339 fl->next = kmem_cache_zalloc(flash_block_cache, GFP_KERNEL);
346 if (count > RTAS_BLK_SIZE)
347 count = RTAS_BLK_SIZE;
348 p = kmem_cache_zalloc(flash_block_cache, GFP_KERNEL);
352 if(copy_from_user(p, buffer, count)) {
353 kmem_cache_free(flash_block_cache, p);
357 fl->blocks[next_free].data = p;
358 fl->blocks[next_free].length = count;
361 mutex_unlock(&rtas_update_flash_mutex);
367 mutex_unlock(&rtas_update_flash_mutex);
372 * Flash management routines.
374 static void manage_flash(struct rtas_manage_flash_t *args_buf, unsigned int op)
379 rc = rtas_call(rtas_token("ibm,manage-flash-image"), 1, 1,
381 } while (rtas_busy_delay(rc));
383 args_buf->status = rc;
386 static ssize_t manage_flash_read(struct file *file, char __user *buf,
387 size_t count, loff_t *ppos)
389 struct rtas_manage_flash_t *const args_buf = &rtas_manage_flash_data;
390 char msg[RTAS_MSG_MAXLEN];
393 mutex_lock(&rtas_manage_flash_mutex);
394 status = args_buf->status;
395 mutex_unlock(&rtas_manage_flash_mutex);
397 msglen = sprintf(msg, "%d\n", status);
398 return simple_read_from_buffer(buf, count, ppos, msg, msglen);
401 static ssize_t manage_flash_write(struct file *file, const char __user *buf,
402 size_t count, loff_t *off)
404 struct rtas_manage_flash_t *const args_buf = &rtas_manage_flash_data;
405 static const char reject_str[] = "0";
406 static const char commit_str[] = "1";
410 mutex_lock(&rtas_manage_flash_mutex);
412 if ((args_buf->status == MANAGE_AUTH) || (count == 0))
417 if (count > 9) count = 9;
419 if (copy_from_user (stkbuf, buf, count))
421 if (strncmp(stkbuf, reject_str, strlen(reject_str)) == 0)
422 op = RTAS_REJECT_TMP_IMG;
423 else if (strncmp(stkbuf, commit_str, strlen(commit_str)) == 0)
424 op = RTAS_COMMIT_TMP_IMG;
427 if (op == -1) { /* buf is empty, or contains invalid string */
432 manage_flash(args_buf, op);
434 mutex_unlock(&rtas_manage_flash_mutex);
438 mutex_unlock(&rtas_manage_flash_mutex);
443 * Validation routines.
445 static void validate_flash(struct rtas_validate_flash_t *args_buf)
447 int token = rtas_token("ibm,validate-flash-image");
453 spin_lock(&rtas_data_buf_lock);
454 memcpy(rtas_data_buf, args_buf->buf, VALIDATE_BUF_SIZE);
455 rc = rtas_call(token, 2, 2, &update_results,
456 (u32) __pa(rtas_data_buf), args_buf->buf_size);
457 memcpy(args_buf->buf, rtas_data_buf, VALIDATE_BUF_SIZE);
458 spin_unlock(&rtas_data_buf_lock);
459 } while (rtas_busy_delay(rc));
461 args_buf->status = rc;
462 args_buf->update_results = update_results;
465 static int get_validate_flash_msg(struct rtas_validate_flash_t *args_buf,
466 char *msg, int msglen)
470 if (args_buf->status >= VALIDATE_TMP_UPDATE) {
471 n = sprintf(msg, "%d\n", args_buf->update_results);
472 if ((args_buf->update_results >= VALIDATE_CUR_UNKNOWN) ||
473 (args_buf->update_results == VALIDATE_TMP_UPDATE))
474 n += snprintf(msg + n, msglen - n, "%s\n",
477 n = sprintf(msg, "%d\n", args_buf->status);
482 static ssize_t validate_flash_read(struct file *file, char __user *buf,
483 size_t count, loff_t *ppos)
485 struct rtas_validate_flash_t *const args_buf =
486 &rtas_validate_flash_data;
487 char msg[VALIDATE_MSG_LEN];
490 mutex_lock(&rtas_validate_flash_mutex);
491 msglen = get_validate_flash_msg(args_buf, msg, VALIDATE_MSG_LEN);
492 mutex_unlock(&rtas_validate_flash_mutex);
494 return simple_read_from_buffer(buf, count, ppos, msg, msglen);
497 static ssize_t validate_flash_write(struct file *file, const char __user *buf,
498 size_t count, loff_t *off)
500 struct rtas_validate_flash_t *const args_buf =
501 &rtas_validate_flash_data;
504 mutex_lock(&rtas_validate_flash_mutex);
506 /* We are only interested in the first 4K of the
508 if ((*off >= VALIDATE_BUF_SIZE) ||
509 (args_buf->status == VALIDATE_AUTH)) {
511 mutex_unlock(&rtas_validate_flash_mutex);
515 if (*off + count >= VALIDATE_BUF_SIZE) {
516 count = VALIDATE_BUF_SIZE - *off;
517 args_buf->status = VALIDATE_READY;
519 args_buf->status = VALIDATE_INCOMPLETE;
522 if (!access_ok(buf, count)) {
526 if (copy_from_user(args_buf->buf + *off, buf, count)) {
534 mutex_unlock(&rtas_validate_flash_mutex);
538 static int validate_flash_release(struct inode *inode, struct file *file)
540 struct rtas_validate_flash_t *const args_buf =
541 &rtas_validate_flash_data;
543 mutex_lock(&rtas_validate_flash_mutex);
545 if (args_buf->status == VALIDATE_READY) {
546 args_buf->buf_size = VALIDATE_BUF_SIZE;
547 validate_flash(args_buf);
550 mutex_unlock(&rtas_validate_flash_mutex);
555 * On-reboot flash update applicator.
557 static void rtas_flash_firmware(int reboot_type)
559 unsigned long image_size;
560 struct flash_block_list *f, *next, *flist;
561 unsigned long rtas_block_list;
562 int i, status, update_token;
564 if (rtas_firmware_flash_list == NULL)
565 return; /* nothing to do */
567 if (reboot_type != SYS_RESTART) {
568 printk(KERN_ALERT "FLASH: firmware flash requires a reboot\n");
569 printk(KERN_ALERT "FLASH: the firmware image will NOT be flashed\n");
573 update_token = rtas_token("ibm,update-flash-64-and-reboot");
574 if (update_token == RTAS_UNKNOWN_SERVICE) {
575 printk(KERN_ALERT "FLASH: ibm,update-flash-64-and-reboot "
576 "is not available -- not a service partition?\n");
577 printk(KERN_ALERT "FLASH: firmware will not be flashed\n");
582 * Just before starting the firmware flash, cancel the event scan work
583 * to avoid any soft lockup issues.
585 rtas_cancel_event_scan();
588 * NOTE: the "first" block must be under 4GB, so we create
589 * an entry with no data blocks in the reserved buffer in
590 * the kernel data segment.
592 spin_lock(&rtas_data_buf_lock);
593 flist = (struct flash_block_list *)&rtas_data_buf[0];
594 flist->num_blocks = 0;
595 flist->next = rtas_firmware_flash_list;
596 rtas_block_list = __pa(flist);
597 if (rtas_block_list >= 4UL*1024*1024*1024) {
598 printk(KERN_ALERT "FLASH: kernel bug...flash list header addr above 4GB\n");
599 spin_unlock(&rtas_data_buf_lock);
603 printk(KERN_ALERT "FLASH: preparing saved firmware image for flash\n");
604 /* Update the block_list in place. */
605 rtas_firmware_flash_list = NULL; /* too hard to backout on error */
607 for (f = flist; f; f = next) {
608 /* Translate data addrs to absolute */
609 for (i = 0; i < f->num_blocks; i++) {
610 f->blocks[i].data = (char *)cpu_to_be64(__pa(f->blocks[i].data));
611 image_size += f->blocks[i].length;
612 f->blocks[i].length = cpu_to_be64(f->blocks[i].length);
615 /* Don't translate NULL pointer for last entry */
617 f->next = (struct flash_block_list *)cpu_to_be64(__pa(f->next));
620 /* make num_blocks into the version/length field */
621 f->num_blocks = (FLASH_BLOCK_LIST_VERSION << 56) | ((f->num_blocks+1)*16);
622 f->num_blocks = cpu_to_be64(f->num_blocks);
625 printk(KERN_ALERT "FLASH: flash image is %ld bytes\n", image_size);
626 printk(KERN_ALERT "FLASH: performing flash and reboot\n");
627 rtas_progress("Flashing \n", 0x0);
628 rtas_progress("Please Wait... ", 0x0);
629 printk(KERN_ALERT "FLASH: this will take several minutes. Do not power off!\n");
630 status = rtas_call(update_token, 1, 1, NULL, rtas_block_list);
631 switch (status) { /* should only get "bad" status */
633 printk(KERN_ALERT "FLASH: success\n");
636 printk(KERN_ALERT "FLASH: hardware error. Firmware may not be not flashed\n");
639 printk(KERN_ALERT "FLASH: image is corrupt or not correct for this platform. Firmware not flashed\n");
642 printk(KERN_ALERT "FLASH: flash failed when partially complete. System may not reboot\n");
645 printk(KERN_ALERT "FLASH: unknown flash return code %d\n", status);
648 spin_unlock(&rtas_data_buf_lock);
652 * Manifest of proc files to create
654 struct rtas_flash_file {
655 const char *filename;
656 const char *rtas_call_name;
658 const struct proc_ops ops;
661 static const struct rtas_flash_file rtas_flash_files[] = {
663 .filename = "powerpc/rtas/" FIRMWARE_FLASH_NAME,
664 .rtas_call_name = "ibm,update-flash-64-and-reboot",
665 .status = &rtas_update_flash_data.status,
666 .ops.proc_read = rtas_flash_read_msg,
667 .ops.proc_write = rtas_flash_write,
668 .ops.proc_release = rtas_flash_release,
669 .ops.proc_lseek = default_llseek,
672 .filename = "powerpc/rtas/" FIRMWARE_UPDATE_NAME,
673 .rtas_call_name = "ibm,update-flash-64-and-reboot",
674 .status = &rtas_update_flash_data.status,
675 .ops.proc_read = rtas_flash_read_num,
676 .ops.proc_write = rtas_flash_write,
677 .ops.proc_release = rtas_flash_release,
678 .ops.proc_lseek = default_llseek,
681 .filename = "powerpc/rtas/" VALIDATE_FLASH_NAME,
682 .rtas_call_name = "ibm,validate-flash-image",
683 .status = &rtas_validate_flash_data.status,
684 .ops.proc_read = validate_flash_read,
685 .ops.proc_write = validate_flash_write,
686 .ops.proc_release = validate_flash_release,
687 .ops.proc_lseek = default_llseek,
690 .filename = "powerpc/rtas/" MANAGE_FLASH_NAME,
691 .rtas_call_name = "ibm,manage-flash-image",
692 .status = &rtas_manage_flash_data.status,
693 .ops.proc_read = manage_flash_read,
694 .ops.proc_write = manage_flash_write,
695 .ops.proc_lseek = default_llseek,
699 static int __init rtas_flash_init(void)
703 if (rtas_token("ibm,update-flash-64-and-reboot") ==
704 RTAS_UNKNOWN_SERVICE) {
705 pr_info("rtas_flash: no firmware flash support\n");
709 rtas_validate_flash_data.buf = kzalloc(VALIDATE_BUF_SIZE, GFP_KERNEL);
710 if (!rtas_validate_flash_data.buf)
713 flash_block_cache = kmem_cache_create_usercopy("rtas_flash_cache",
714 RTAS_BLK_SIZE, RTAS_BLK_SIZE,
715 0, 0, RTAS_BLK_SIZE, NULL);
716 if (!flash_block_cache) {
717 printk(KERN_ERR "%s: failed to create block cache\n",
722 for (i = 0; i < ARRAY_SIZE(rtas_flash_files); i++) {
723 const struct rtas_flash_file *f = &rtas_flash_files[i];
726 if (!proc_create(f->filename, 0600, NULL, &f->ops))
730 * This code assumes that the status int is the first member of the
733 token = rtas_token(f->rtas_call_name);
734 if (token == RTAS_UNKNOWN_SERVICE)
735 *f->status = FLASH_AUTH;
737 *f->status = FLASH_NO_OP;
740 rtas_flash_term_hook = rtas_flash_firmware;
745 const struct rtas_flash_file *f = &rtas_flash_files[i];
746 remove_proc_entry(f->filename, NULL);
749 kmem_cache_destroy(flash_block_cache);
751 kfree(rtas_validate_flash_data.buf);
755 static void __exit rtas_flash_cleanup(void)
759 rtas_flash_term_hook = NULL;
761 if (rtas_firmware_flash_list) {
762 free_flash_list(rtas_firmware_flash_list);
763 rtas_firmware_flash_list = NULL;
766 for (i = 0; i < ARRAY_SIZE(rtas_flash_files); i++) {
767 const struct rtas_flash_file *f = &rtas_flash_files[i];
768 remove_proc_entry(f->filename, NULL);
771 kmem_cache_destroy(flash_block_cache);
772 kfree(rtas_validate_flash_data.buf);
775 module_init(rtas_flash_init);
776 module_exit(rtas_flash_cleanup);
777 MODULE_LICENSE("GPL");