Skip to content
Snippets Groups Projects
rtas_flash.c 21.3 KiB
Newer Older
  • Learn to ignore specific revisions
  • Linus Torvalds's avatar
    Linus Torvalds committed
    /*
     *  c 2001 PPC 64 Team, IBM Corp
     *
     *      This program is free software; you can redistribute it and/or
     *      modify it under the terms of the GNU General Public License
     *      as published by the Free Software Foundation; either version
     *      2 of the License, or (at your option) any later version.
     *
    
     * /proc/powerpc/rtas/firmware_flash interface
    
    Linus Torvalds's avatar
    Linus Torvalds committed
     *
     * This file implements a firmware_flash interface to pump a firmware
     * image into the kernel.  At reboot time rtas_restart() will see the
     * firmware image and flash it as it reboots (see rtas.c).
     */
    
    #include <linux/module.h>
    #include <linux/init.h>
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    #include <linux/proc_fs.h>
    
    #include <linux/reboot.h>
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    #include <asm/delay.h>
    #include <asm/uaccess.h>
    #include <asm/rtas.h>
    
    #define MODULE_VERS "1.0"
    #define MODULE_NAME "rtas_flash"
    
    #define FIRMWARE_FLASH_NAME "firmware_flash"   
    #define FIRMWARE_UPDATE_NAME "firmware_update"
    #define MANAGE_FLASH_NAME "manage_flash"
    #define VALIDATE_FLASH_NAME "validate_flash"
    
    /* General RTAS Status Codes */
    #define RTAS_RC_SUCCESS  0
    #define RTAS_RC_HW_ERR	-1
    #define RTAS_RC_BUSY	-2
    
    /* Flash image status values */
    #define FLASH_AUTH           -9002 /* RTAS Not Service Authority Partition */
    #define FLASH_NO_OP          -1099 /* No operation initiated by user */	
    #define FLASH_IMG_SHORT	     -1005 /* Flash image shorter than expected */
    #define FLASH_IMG_BAD_LEN    -1004 /* Bad length value in flash list block */
    #define FLASH_IMG_NULL_DATA  -1003 /* Bad data value in flash list block */
    #define FLASH_IMG_READY      0     /* Firmware img ready for flash on reboot */
    
    /* Manage image status values */
    #define MANAGE_AUTH          -9002 /* RTAS Not Service Authority Partition */
    #define MANAGE_ACTIVE_ERR    -9001 /* RTAS Cannot Overwrite Active Img */
    #define MANAGE_NO_OP         -1099 /* No operation initiated by user */
    #define MANAGE_PARAM_ERR     -3    /* RTAS Parameter Error */
    #define MANAGE_HW_ERR        -1    /* RTAS Hardware Error */
    
    /* Validate image status values */
    #define VALIDATE_AUTH          -9002 /* RTAS Not Service Authority Partition */
    #define VALIDATE_NO_OP         -1099 /* No operation initiated by the user */
    #define VALIDATE_INCOMPLETE    -1002 /* User copied < VALIDATE_BUF_SIZE */
    #define VALIDATE_READY	       -1001 /* Firmware image ready for validation */
    #define VALIDATE_PARAM_ERR     -3    /* RTAS Parameter Error */
    #define VALIDATE_HW_ERR        -1    /* RTAS Hardware Error */
    
    
    /* ibm,validate-flash-image update result tokens */
    #define VALIDATE_TMP_UPDATE    0     /* T side will be updated */
    #define VALIDATE_FLASH_AUTH    1     /* Partition does not have authority */
    #define VALIDATE_INVALID_IMG   2     /* Candidate image is not valid */
    #define VALIDATE_CUR_UNKNOWN   3     /* Current fixpack level is unknown */
    /*
     * Current T side will be committed to P side before being replace with new
     * image, and the new image is downlevel from current image
     */
    #define VALIDATE_TMP_COMMIT_DL 4
    /*
     * Current T side will be committed to P side before being replaced with new
     * image
     */
    #define VALIDATE_TMP_COMMIT    5
    /*
     * T side will be updated with a downlevel image
     */
    #define VALIDATE_TMP_UPDATE_DL 6
    
    /*
     * The candidate image's release date is later than the system's firmware
     * service entitlement date - service warranty period has expired
     */
    #define VALIDATE_OUT_OF_WRNTY  7
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    /* ibm,manage-flash-image operation tokens */
    #define RTAS_REJECT_TMP_IMG   0
    #define RTAS_COMMIT_TMP_IMG   1
    
    /* Array sizes */
    #define VALIDATE_BUF_SIZE 4096    
    
    #define VALIDATE_MSG_LEN  256
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    #define RTAS_MSG_MAXLEN   64
    
    
    /* Quirk - RTAS requires 4k list length and block size */
    #define RTAS_BLKLIST_LENGTH 4096
    #define RTAS_BLK_SIZE 4096
    
    
    struct flash_block {
    	char *data;
    	unsigned long length;
    };
    
    /* This struct is very similar but not identical to
     * that needed by the rtas flash update.
     * All we need to do for rtas is rewrite num_blocks
     * into a version/length and translate the pointers
     * to absolute.
     */
    
    #define FLASH_BLOCKS_PER_NODE ((RTAS_BLKLIST_LENGTH - 16) / sizeof(struct flash_block))
    
    struct flash_block_list {
    	unsigned long num_blocks;
    	struct flash_block_list *next;
    	struct flash_block blocks[FLASH_BLOCKS_PER_NODE];
    };
    
    
    static struct flash_block_list *rtas_firmware_flash_list;
    
    /* Use slab cache to guarantee 4k alignment */
    
    static struct kmem_cache *flash_block_cache = NULL;
    
    #define FLASH_BLOCK_LIST_VERSION (1UL)
    
    
    /*
     * Local copy of the flash block list.
     *
     * The rtas_firmware_flash_list varable will be
    
     * set once the data is fully read.
    
    Linus Torvalds's avatar
    Linus Torvalds committed
     *
     * For convenience as we build the list we use virtual addrs,
     * we do not fill in the version number, and the length field
     * is treated as the number of entries currently in the block
    
     * (i.e. not a byte count).  This is all fixed when calling 
     * the flash routine.
    
    Linus Torvalds's avatar
    Linus Torvalds committed
     */
    
    /* Status int must be first member of struct */
    struct rtas_update_flash_t
    {
    	int status;			/* Flash update status */
    	struct flash_block_list *flist; /* Local copy of flash block list */
    };
    
    /* Status int must be first member of struct */
    struct rtas_manage_flash_t
    {
    	int status;			/* Returned status */
    };
    
    /* Status int must be first member of struct */
    struct rtas_validate_flash_t
    {
    	int status;		 	/* Returned status */	
    
    	char *buf;			/* Candidate image buffer */
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	unsigned int buf_size;		/* Size of image buf */
    	unsigned int update_results;	/* Update results token */
    };
    
    
    static struct rtas_update_flash_t rtas_update_flash_data;
    static struct rtas_manage_flash_t rtas_manage_flash_data;
    static struct rtas_validate_flash_t rtas_validate_flash_data;
    static DEFINE_MUTEX(rtas_update_flash_mutex);
    static DEFINE_MUTEX(rtas_manage_flash_mutex);
    static DEFINE_MUTEX(rtas_validate_flash_mutex);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    /* Do simple sanity checks on the flash image. */
    static int flash_list_valid(struct flash_block_list *flist)
    {
    	struct flash_block_list *f;
    	int i;
    	unsigned long block_size, image_size;
    
    	/* Paranoid self test here.  We also collect the image size. */
    	image_size = 0;
    	for (f = flist; f; f = f->next) {
    		for (i = 0; i < f->num_blocks; i++) {
    			if (f->blocks[i].data == NULL) {
    				return FLASH_IMG_NULL_DATA;
    			}
    			block_size = f->blocks[i].length;
    
    			if (block_size <= 0 || block_size > RTAS_BLK_SIZE) {
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    				return FLASH_IMG_BAD_LEN;
    			}
    			image_size += block_size;
    		}
    	}
    
    	if (image_size < (256 << 10)) {
    		if (image_size < 2) 
    			return FLASH_NO_OP;
    	}
    
    	printk(KERN_INFO "FLASH: flash image with %ld bytes stored for hardware flash on reboot\n", image_size);
    
    	return FLASH_IMG_READY;
    }
    
    static void free_flash_list(struct flash_block_list *f)
    {
    	struct flash_block_list *next;
    	int i;
    
    	while (f) {
    		for (i = 0; i < f->num_blocks; i++)
    
    			kmem_cache_free(flash_block_cache, f->blocks[i].data);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    		next = f->next;
    
    		kmem_cache_free(flash_block_cache, f);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    		f = next;
    	}
    }
    
    static int rtas_flash_release(struct inode *inode, struct file *file)
    {
    
    	struct rtas_update_flash_t *const uf = &rtas_update_flash_data;
    
    	mutex_lock(&rtas_update_flash_mutex);
    
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	if (uf->flist) {    
    		/* File was opened in write mode for a new flash attempt */
    		/* Clear saved list */
    
    		if (rtas_firmware_flash_list) {
    			free_flash_list(rtas_firmware_flash_list);
    			rtas_firmware_flash_list = NULL;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    		}
    
    		if (uf->status != FLASH_AUTH)  
    			uf->status = flash_list_valid(uf->flist);
    
    		if (uf->status == FLASH_IMG_READY) 
    
    			rtas_firmware_flash_list = uf->flist;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    		else
    			free_flash_list(uf->flist);
    
    		uf->flist = NULL;
    	}
    
    
    	mutex_unlock(&rtas_update_flash_mutex);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	return 0;
    }
    
    
    static size_t get_flash_status_msg(int status, char *buf)
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    {
    
    	const char *msg;
    	size_t len;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    	switch (status) {
    	case FLASH_AUTH:
    		msg = "error: this partition does not have service authority\n";
    		break;
    	case FLASH_NO_OP:
    		msg = "info: no firmware image for flash\n";
    		break;
    	case FLASH_IMG_SHORT:
    		msg = "error: flash image short\n";
    		break;
    	case FLASH_IMG_BAD_LEN:
    		msg = "error: internal error bad length\n";
    		break;
    	case FLASH_IMG_NULL_DATA:
    		msg = "error: internal error null data\n";
    		break;
    	case FLASH_IMG_READY:
    		msg = "ready: firmware image ready for flash on reboot\n";
    		break;
    	default:
    
    		return sprintf(buf, "error: unexpected status value %d\n",
    			       status);
    
    	len = strlen(msg);
    	memcpy(buf, msg, len + 1);
    	return len;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    }
    
    /* Reading the proc file will show status (not the firmware contents) */
    
    static ssize_t rtas_flash_read_msg(struct file *file, char __user *buf,
    				   size_t count, loff_t *ppos)
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    {
    
    	struct rtas_update_flash_t *const uf = &rtas_update_flash_data;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	char msg[RTAS_MSG_MAXLEN];
    
    	size_t len;
    	int status;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    
    	mutex_lock(&rtas_update_flash_mutex);
    	status = uf->status;
    	mutex_unlock(&rtas_update_flash_mutex);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    
    	/* Read as text message */
    	len = get_flash_status_msg(status, msg);
    	return simple_read_from_buffer(buf, count, ppos, msg, len);
    }
    
    static ssize_t rtas_flash_read_num(struct file *file, char __user *buf,
    				   size_t count, loff_t *ppos)
    {
    	struct rtas_update_flash_t *const uf = &rtas_update_flash_data;
    	char msg[RTAS_MSG_MAXLEN];
    	int status;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    
    	mutex_lock(&rtas_update_flash_mutex);
    	status = uf->status;
    	mutex_unlock(&rtas_update_flash_mutex);
    
    	/* Read as number */
    	sprintf(msg, "%d\n", status);
    
    	return simple_read_from_buffer(buf, count, ppos, msg, strlen(msg));
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    }
    
    /* We could be much more efficient here.  But to keep this function
     * simple we allocate a page to the block list no matter how small the
     * count is.  If the system is low on memory it will be just as well
     * that we fail....
     */
    
    static ssize_t rtas_flash_write(struct file *file, const char __user *buffer,
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    				size_t count, loff_t *off)
    {
    
    	struct rtas_update_flash_t *const uf = &rtas_update_flash_data;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	char *p;
    
    	int next_free, rc;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	struct flash_block_list *fl;
    
    
    	mutex_lock(&rtas_update_flash_mutex);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    	if (uf->status == FLASH_AUTH || count == 0)
    
    		goto out;	/* discard data */
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    	/* In the case that the image is not ready for flashing, the memory
    	 * allocated for the block list will be freed upon the release of the 
    	 * proc file
    	 */
    	if (uf->flist == NULL) {
    
    		uf->flist = kmem_cache_zalloc(flash_block_cache, GFP_KERNEL);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    		if (!uf->flist)
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	}
    
    	fl = uf->flist;
    	while (fl->next)
    		fl = fl->next; /* seek to last block_list for append */
    	next_free = fl->num_blocks;
    	if (next_free == FLASH_BLOCKS_PER_NODE) {
    		/* Need to allocate another block_list */
    
    		fl->next = kmem_cache_zalloc(flash_block_cache, GFP_KERNEL);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    		if (!fl->next)
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    		fl = fl->next;
    		next_free = 0;
    	}
    
    
    	if (count > RTAS_BLK_SIZE)
    		count = RTAS_BLK_SIZE;
    
    	p = kmem_cache_zalloc(flash_block_cache, GFP_KERNEL);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	if (!p)
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	
    	if(copy_from_user(p, buffer, count)) {
    
    		kmem_cache_free(flash_block_cache, p);
    
    		rc = -EFAULT;
    		goto error;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	}
    	fl->blocks[next_free].data = p;
    	fl->blocks[next_free].length = count;
    	fl->num_blocks++;
    
    out:
    	mutex_unlock(&rtas_update_flash_mutex);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	return count;
    
    
    nomem:
    	rc = -ENOMEM;
    error:
    	mutex_unlock(&rtas_update_flash_mutex);
    	return rc;
    
    /*
     * Flash management routines.
     */
    static void manage_flash(struct rtas_manage_flash_t *args_buf, unsigned int op)
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    {
    	s32 rc;
    
    
    		rc = rtas_call(rtas_token("ibm,manage-flash-image"), 1, 1,
    			       NULL, op);
    
    	} while (rtas_busy_delay(rc));
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    	args_buf->status = rc;
    }
    
    
    static ssize_t manage_flash_read(struct file *file, char __user *buf,
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    			       size_t count, loff_t *ppos)
    {
    
    	struct rtas_manage_flash_t *const args_buf = &rtas_manage_flash_data;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	char msg[RTAS_MSG_MAXLEN];
    
    	int msglen, status;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    
    	mutex_lock(&rtas_manage_flash_mutex);
    	status = args_buf->status;
    	mutex_unlock(&rtas_manage_flash_mutex);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    
    	msglen = sprintf(msg, "%d\n", status);
    
    	return simple_read_from_buffer(buf, count, ppos, msg, msglen);
    
    static ssize_t manage_flash_write(struct file *file, const char __user *buf,
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    				size_t count, loff_t *off)
    {
    
    	struct rtas_manage_flash_t *const args_buf = &rtas_manage_flash_data;
    	static const char reject_str[] = "0";
    	static const char commit_str[] = "1";
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	char stkbuf[10];
    
    	int op, rc;
    
    	mutex_lock(&rtas_manage_flash_mutex);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    	if ((args_buf->status == MANAGE_AUTH) || (count == 0))
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    		
    	op = -1;
    	if (buf) {
    		if (count > 9) count = 9;
    
    		rc = -EFAULT;
    		if (copy_from_user (stkbuf, buf, count))
    			goto error;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    		if (strncmp(stkbuf, reject_str, strlen(reject_str)) == 0) 
    			op = RTAS_REJECT_TMP_IMG;
    		else if (strncmp(stkbuf, commit_str, strlen(commit_str)) == 0) 
    			op = RTAS_COMMIT_TMP_IMG;
    	}
    	
    
    	if (op == -1) {   /* buf is empty, or contains invalid string */
    		rc = -EINVAL;
    		goto error;
    	}
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    
    	manage_flash(args_buf, op);
    out:
    	mutex_unlock(&rtas_manage_flash_mutex);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	return count;
    
    
    error:
    	mutex_unlock(&rtas_manage_flash_mutex);
    	return rc;
    
    /*
     * Validation routines.
     */
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    static void validate_flash(struct rtas_validate_flash_t *args_buf)
    {
    	int token = rtas_token("ibm,validate-flash-image");
    	int update_results;
    	s32 rc;	
    
    	rc = 0;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    		spin_lock(&rtas_data_buf_lock);
    		memcpy(rtas_data_buf, args_buf->buf, VALIDATE_BUF_SIZE);
    		rc = rtas_call(token, 2, 2, &update_results, 
    			       (u32) __pa(rtas_data_buf), args_buf->buf_size);
    		memcpy(args_buf->buf, rtas_data_buf, VALIDATE_BUF_SIZE);
    		spin_unlock(&rtas_data_buf_lock);
    
    	} while (rtas_busy_delay(rc));
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    	args_buf->status = rc;
    	args_buf->update_results = update_results;
    }
    
    static int get_validate_flash_msg(struct rtas_validate_flash_t *args_buf, 
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    {
    	int n;
    
    	if (args_buf->status >= VALIDATE_TMP_UPDATE) { 
    		n = sprintf(msg, "%d\n", args_buf->update_results);
    		if ((args_buf->update_results >= VALIDATE_CUR_UNKNOWN) ||
    		    (args_buf->update_results == VALIDATE_TMP_UPDATE))
    
    			n += snprintf(msg + n, msglen - n, "%s\n",
    					args_buf->buf);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	} else {
    		n = sprintf(msg, "%d\n", args_buf->status);
    	}
    	return n;
    }
    
    
    static ssize_t validate_flash_read(struct file *file, char __user *buf,
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    			       size_t count, loff_t *ppos)
    {
    
    	struct rtas_validate_flash_t *const args_buf =
    		&rtas_validate_flash_data;
    
    	char msg[VALIDATE_MSG_LEN];
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	int msglen;
    
    
    	mutex_lock(&rtas_validate_flash_mutex);
    
    	msglen = get_validate_flash_msg(args_buf, msg, VALIDATE_MSG_LEN);
    
    	mutex_unlock(&rtas_validate_flash_mutex);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    
    	return simple_read_from_buffer(buf, count, ppos, msg, msglen);
    
    static ssize_t validate_flash_write(struct file *file, const char __user *buf,
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    				    size_t count, loff_t *off)
    {
    
    	struct rtas_validate_flash_t *const args_buf =
    		&rtas_validate_flash_data;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	int rc;
    
    
    	mutex_lock(&rtas_validate_flash_mutex);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    	/* We are only interested in the first 4K of the
    	 * candidate image */
    	if ((*off >= VALIDATE_BUF_SIZE) || 
    		(args_buf->status == VALIDATE_AUTH)) {
    		*off += count;
    
    		mutex_unlock(&rtas_validate_flash_mutex);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    		return count;
    	}
    
    	if (*off + count >= VALIDATE_BUF_SIZE)  {
    		count = VALIDATE_BUF_SIZE - *off;
    		args_buf->status = VALIDATE_READY;	
    	} else {
    		args_buf->status = VALIDATE_INCOMPLETE;
    	}
    
    	if (!access_ok(VERIFY_READ, buf, count)) {
    		rc = -EFAULT;
    		goto done;
    	}
    	if (copy_from_user(args_buf->buf + *off, buf, count)) {
    		rc = -EFAULT;
    		goto done;
    	}
    
    	*off += count;
    	rc = count;
    done:
    
    	mutex_unlock(&rtas_validate_flash_mutex);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	return rc;
    }
    
    static int validate_flash_release(struct inode *inode, struct file *file)
    {
    
    	struct rtas_validate_flash_t *const args_buf =
    		&rtas_validate_flash_data;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    
    	mutex_lock(&rtas_validate_flash_mutex);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    	if (args_buf->status == VALIDATE_READY) {
    		args_buf->buf_size = VALIDATE_BUF_SIZE;
    		validate_flash(args_buf);
    	}
    
    
    	mutex_unlock(&rtas_validate_flash_mutex);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	return 0;
    }
    
    
    /*
     * On-reboot flash update applicator.
     */
    
    static void rtas_flash_firmware(int reboot_type)
    {
    	unsigned long image_size;
    	struct flash_block_list *f, *next, *flist;
    	unsigned long rtas_block_list;
    	int i, status, update_token;
    
    
    	if (rtas_firmware_flash_list == NULL)
    
    		return;		/* nothing to do */
    
    	if (reboot_type != SYS_RESTART) {
    		printk(KERN_ALERT "FLASH: firmware flash requires a reboot\n");
    		printk(KERN_ALERT "FLASH: the firmware image will NOT be flashed\n");
    		return;
    	}
    
    	update_token = rtas_token("ibm,update-flash-64-and-reboot");
    	if (update_token == RTAS_UNKNOWN_SERVICE) {
    		printk(KERN_ALERT "FLASH: ibm,update-flash-64-and-reboot "
    		       "is not available -- not a service partition?\n");
    		printk(KERN_ALERT "FLASH: firmware will not be flashed\n");
    		return;
    	}
    
    
    	/*
    	 * Just before starting the firmware flash, cancel the event scan work
    	 * to avoid any soft lockup issues.
    	 */
    	rtas_cancel_event_scan();
    
    
    	/*
    	 * NOTE: the "first" block must be under 4GB, so we create
    	 * an entry with no data blocks in the reserved buffer in
    	 * the kernel data segment.
    
    	spin_lock(&rtas_data_buf_lock);
    	flist = (struct flash_block_list *)&rtas_data_buf[0];
    	flist->num_blocks = 0;
    	flist->next = rtas_firmware_flash_list;
    
    	rtas_block_list = __pa(flist);
    
    	if (rtas_block_list >= 4UL*1024*1024*1024) {
    		printk(KERN_ALERT "FLASH: kernel bug...flash list header addr above 4GB\n");
    
    		spin_unlock(&rtas_data_buf_lock);
    
    		return;
    	}
    
    	printk(KERN_ALERT "FLASH: preparing saved firmware image for flash\n");
    	/* Update the block_list in place. */
    
    	rtas_firmware_flash_list = NULL; /* too hard to backout on error */
    
    	image_size = 0;
    	for (f = flist; f; f = next) {
    		/* Translate data addrs to absolute */
    		for (i = 0; i < f->num_blocks; i++) {
    
    			f->blocks[i].data = (char *)__pa(f->blocks[i].data);
    
    			image_size += f->blocks[i].length;
    		}
    		next = f->next;
    		/* Don't translate NULL pointer for last entry */
    		if (f->next)
    
    			f->next = (struct flash_block_list *)__pa(f->next);
    
    		else
    			f->next = NULL;
    		/* make num_blocks into the version/length field */
    		f->num_blocks = (FLASH_BLOCK_LIST_VERSION << 56) | ((f->num_blocks+1)*16);
    	}
    
    	printk(KERN_ALERT "FLASH: flash image is %ld bytes\n", image_size);
    	printk(KERN_ALERT "FLASH: performing flash and reboot\n");
    	rtas_progress("Flashing        \n", 0x0);
    	rtas_progress("Please Wait...  ", 0x0);
    	printk(KERN_ALERT "FLASH: this will take several minutes.  Do not power off!\n");
    	status = rtas_call(update_token, 1, 1, NULL, rtas_block_list);
    	switch (status) {	/* should only get "bad" status */
    	    case 0:
    		printk(KERN_ALERT "FLASH: success\n");
    		break;
    	    case -1:
    		printk(KERN_ALERT "FLASH: hardware error.  Firmware may not be not flashed\n");
    		break;
    	    case -3:
    		printk(KERN_ALERT "FLASH: image is corrupt or not correct for this platform.  Firmware not flashed\n");
    		break;
    	    case -4:
    		printk(KERN_ALERT "FLASH: flash failed when partially complete.  System may not reboot\n");
    		break;
    	    default:
    		printk(KERN_ALERT "FLASH: unknown flash return code %d\n", status);
    		break;
    	}
    
    	spin_unlock(&rtas_data_buf_lock);
    
    /*
     * Manifest of proc files to create
     */
    struct rtas_flash_file {
    	const char *filename;
    	const char *rtas_call_name;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	int *status;
    
    	const struct file_operations fops;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    };
    
    
    static const struct rtas_flash_file rtas_flash_files[] = {
    	{
    		.filename	= "powerpc/rtas/" FIRMWARE_FLASH_NAME,
    		.rtas_call_name	= "ibm,update-flash-64-and-reboot",
    		.status		= &rtas_update_flash_data.status,
    		.fops.read	= rtas_flash_read_msg,
    		.fops.write	= rtas_flash_write,
    		.fops.release	= rtas_flash_release,
    		.fops.llseek	= default_llseek,
    	},
    	{
    		.filename	= "powerpc/rtas/" FIRMWARE_UPDATE_NAME,
    		.rtas_call_name	= "ibm,update-flash-64-and-reboot",
    		.status		= &rtas_update_flash_data.status,
    		.fops.read	= rtas_flash_read_num,
    		.fops.write	= rtas_flash_write,
    		.fops.release	= rtas_flash_release,
    		.fops.llseek	= default_llseek,
    	},
    	{
    		.filename	= "powerpc/rtas/" VALIDATE_FLASH_NAME,
    		.rtas_call_name	= "ibm,validate-flash-image",
    		.status		= &rtas_validate_flash_data.status,
    		.fops.read	= validate_flash_read,
    		.fops.write	= validate_flash_write,
    		.fops.release	= validate_flash_release,
    		.fops.llseek	= default_llseek,
    	},
    	{
    		.filename	= "powerpc/rtas/" MANAGE_FLASH_NAME,
    		.rtas_call_name	= "ibm,manage-flash-image",
    		.status		= &rtas_manage_flash_data.status,
    		.fops.read	= manage_flash_read,
    		.fops.write	= manage_flash_write,
    		.fops.llseek	= default_llseek,
    	}
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    };
    
    
    static int __init rtas_flash_init(void)
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    {
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    	if (rtas_token("ibm,update-flash-64-and-reboot") ==
    		       RTAS_UNKNOWN_SERVICE) {
    
    		pr_info("rtas_flash: no firmware flash support\n");
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    		return 1;
    	}
    
    
    	rtas_validate_flash_data.buf = kzalloc(VALIDATE_BUF_SIZE, GFP_KERNEL);
    	if (!rtas_validate_flash_data.buf)
    		return -ENOMEM;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    
    	flash_block_cache = kmem_cache_create("rtas_flash_cache",
    					      RTAS_BLK_SIZE, RTAS_BLK_SIZE, 0,
    
    	if (!flash_block_cache) {
    		printk(KERN_ERR "%s: failed to create block cache\n",
    				__func__);
    		goto enomem_buf;
    
    	for (i = 0; i < ARRAY_SIZE(rtas_flash_files); i++) {
    		const struct rtas_flash_file *f = &rtas_flash_files[i];
    		int token;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    
    		if (!proc_create(f->filename, S_IRUSR | S_IWUSR, NULL, &f->fops))
    			goto enomem;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    
    		/*
    		 * This code assumes that the status int is the first member of the
    		 * struct
    		 */
    		token = rtas_token(f->rtas_call_name);
    		if (token == RTAS_UNKNOWN_SERVICE)
    			*f->status = FLASH_AUTH;
    		else
    			*f->status = FLASH_NO_OP;
    	}
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    
    	rtas_flash_term_hook = rtas_flash_firmware;
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    	return 0;
    
    
    enomem:
    	while (--i >= 0) {
    		const struct rtas_flash_file *f = &rtas_flash_files[i];
    		remove_proc_entry(f->filename, NULL);
    	}
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    
    
    	kmem_cache_destroy(flash_block_cache);
    enomem_buf:
    	kfree(rtas_validate_flash_data.buf);
    	return -ENOMEM;
    
    static void __exit rtas_flash_cleanup(void)
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    {
    
    	rtas_flash_term_hook = NULL;
    
    	if (rtas_firmware_flash_list) {
    		free_flash_list(rtas_firmware_flash_list);
    		rtas_firmware_flash_list = NULL;
    	}
    
    
    	for (i = 0; i < ARRAY_SIZE(rtas_flash_files); i++) {
    		const struct rtas_flash_file *f = &rtas_flash_files[i];
    		remove_proc_entry(f->filename, NULL);
    	}
    
    	kmem_cache_destroy(flash_block_cache);
    	kfree(rtas_validate_flash_data.buf);
    
    Linus Torvalds's avatar
    Linus Torvalds committed
    }
    
    module_init(rtas_flash_init);
    module_exit(rtas_flash_cleanup);
    MODULE_LICENSE("GPL");