xref: /linux/arch/powerpc/kernel/rtas_flash.c (revision 765532c8aaac624b5f8687af6d319c6a1138a257)
1 /*
2  *  c 2001 PPC 64 Team, IBM Corp
3  *
4  *      This program is free software; you can redistribute it and/or
5  *      modify it under the terms of the GNU General Public License
6  *      as published by the Free Software Foundation; either version
7  *      2 of the License, or (at your option) any later version.
8  *
9  * /proc/powerpc/rtas/firmware_flash interface
10  *
11  * This file implements a firmware_flash interface to pump a firmware
12  * image into the kernel.  At reboot time rtas_restart() will see the
13  * firmware image and flash it as it reboots (see rtas.c).
14  */
15 
16 #include <linux/module.h>
17 #include <linux/init.h>
18 #include <linux/slab.h>
19 #include <linux/proc_fs.h>
20 #include <asm/delay.h>
21 #include <asm/uaccess.h>
22 #include <asm/rtas.h>
23 #include <asm/abs_addr.h>
24 
25 #define MODULE_VERS "1.0"
26 #define MODULE_NAME "rtas_flash"
27 
28 #define FIRMWARE_FLASH_NAME "firmware_flash"
29 #define FIRMWARE_UPDATE_NAME "firmware_update"
30 #define MANAGE_FLASH_NAME "manage_flash"
31 #define VALIDATE_FLASH_NAME "validate_flash"
32 
33 /* General RTAS Status Codes */
34 #define RTAS_RC_SUCCESS  0
35 #define RTAS_RC_HW_ERR	-1
36 #define RTAS_RC_BUSY	-2
37 
38 /* Flash image status values */
39 #define FLASH_AUTH           -9002 /* RTAS Not Service Authority Partition */
40 #define FLASH_NO_OP          -1099 /* No operation initiated by user */
41 #define FLASH_IMG_SHORT	     -1005 /* Flash image shorter than expected */
42 #define FLASH_IMG_BAD_LEN    -1004 /* Bad length value in flash list block */
43 #define FLASH_IMG_NULL_DATA  -1003 /* Bad data value in flash list block */
44 #define FLASH_IMG_READY      0     /* Firmware img ready for flash on reboot */
45 
46 /* Manage image status values */
47 #define MANAGE_AUTH          -9002 /* RTAS Not Service Authority Partition */
48 #define MANAGE_ACTIVE_ERR    -9001 /* RTAS Cannot Overwrite Active Img */
49 #define MANAGE_NO_OP         -1099 /* No operation initiated by user */
50 #define MANAGE_PARAM_ERR     -3    /* RTAS Parameter Error */
51 #define MANAGE_HW_ERR        -1    /* RTAS Hardware Error */
52 
53 /* Validate image status values */
54 #define VALIDATE_AUTH          -9002 /* RTAS Not Service Authority Partition */
55 #define VALIDATE_NO_OP         -1099 /* No operation initiated by the user */
56 #define VALIDATE_INCOMPLETE    -1002 /* User copied < VALIDATE_BUF_SIZE */
57 #define VALIDATE_READY	       -1001 /* Firmware image ready for validation */
58 #define VALIDATE_PARAM_ERR     -3    /* RTAS Parameter Error */
59 #define VALIDATE_HW_ERR        -1    /* RTAS Hardware Error */
60 #define VALIDATE_TMP_UPDATE    0     /* Validate Return Status */
61 #define VALIDATE_FLASH_AUTH    1     /* Validate Return Status */
62 #define VALIDATE_INVALID_IMG   2     /* Validate Return Status */
63 #define VALIDATE_CUR_UNKNOWN   3     /* Validate Return Status */
64 #define VALIDATE_TMP_COMMIT_DL 4     /* Validate Return Status */
65 #define VALIDATE_TMP_COMMIT    5     /* Validate Return Status */
66 #define VALIDATE_TMP_UPDATE_DL 6     /* Validate Return Status */
67 
68 /* ibm,manage-flash-image operation tokens */
69 #define RTAS_REJECT_TMP_IMG   0
70 #define RTAS_COMMIT_TMP_IMG   1
71 
72 /* Array sizes */
73 #define VALIDATE_BUF_SIZE 4096
74 #define RTAS_MSG_MAXLEN   64
75 
76 /* Quirk - RTAS requires 4k list length and block size */
77 #define RTAS_BLKLIST_LENGTH 4096
78 #define RTAS_BLK_SIZE 4096
79 
80 struct flash_block {
81 	char *data;
82 	unsigned long length;
83 };
84 
85 /* This struct is very similar but not identical to
86  * that needed by the rtas flash update.
87  * All we need to do for rtas is rewrite num_blocks
88  * into a version/length and translate the pointers
89  * to absolute.
90  */
91 #define FLASH_BLOCKS_PER_NODE ((RTAS_BLKLIST_LENGTH - 16) / sizeof(struct flash_block))
92 struct flash_block_list {
93 	unsigned long num_blocks;
94 	struct flash_block_list *next;
95 	struct flash_block blocks[FLASH_BLOCKS_PER_NODE];
96 };
97 
98 static struct flash_block_list *rtas_firmware_flash_list;
99 
100 /* Use slab cache to guarantee 4k alignment */
101 static struct kmem_cache *flash_block_cache = NULL;
102 
103 #define FLASH_BLOCK_LIST_VERSION (1UL)
104 
105 /* Local copy of the flash block list.
106  * We only allow one open of the flash proc file and create this
107  * list as we go.  The rtas_firmware_flash_list varable will be
108  * set once the data is fully read.
109  *
110  * For convenience as we build the list we use virtual addrs,
111  * we do not fill in the version number, and the length field
112  * is treated as the number of entries currently in the block
113  * (i.e. not a byte count).  This is all fixed when calling
114  * the flash routine.
115  */
116 
117 /* Status int must be first member of struct */
118 struct rtas_update_flash_t
119 {
120 	int status;			/* Flash update status */
121 	struct flash_block_list *flist; /* Local copy of flash block list */
122 };
123 
124 /* Status int must be first member of struct */
125 struct rtas_manage_flash_t
126 {
127 	int status;			/* Returned status */
128 	unsigned int op;		/* Reject or commit image */
129 };
130 
131 /* Status int must be first member of struct */
132 struct rtas_validate_flash_t
133 {
134 	int status;		 	/* Returned status */
135 	char buf[VALIDATE_BUF_SIZE]; 	/* Candidate image buffer */
136 	unsigned int buf_size;		/* Size of image buf */
137 	unsigned int update_results;	/* Update results token */
138 };
139 
140 static DEFINE_SPINLOCK(flash_file_open_lock);
141 static struct proc_dir_entry *firmware_flash_pde;
142 static struct proc_dir_entry *firmware_update_pde;
143 static struct proc_dir_entry *validate_pde;
144 static struct proc_dir_entry *manage_pde;
145 
146 /* Do simple sanity checks on the flash image. */
147 static int flash_list_valid(struct flash_block_list *flist)
148 {
149 	struct flash_block_list *f;
150 	int i;
151 	unsigned long block_size, image_size;
152 
153 	/* Paranoid self test here.  We also collect the image size. */
154 	image_size = 0;
155 	for (f = flist; f; f = f->next) {
156 		for (i = 0; i < f->num_blocks; i++) {
157 			if (f->blocks[i].data == NULL) {
158 				return FLASH_IMG_NULL_DATA;
159 			}
160 			block_size = f->blocks[i].length;
161 			if (block_size <= 0 || block_size > RTAS_BLK_SIZE) {
162 				return FLASH_IMG_BAD_LEN;
163 			}
164 			image_size += block_size;
165 		}
166 	}
167 
168 	if (image_size < (256 << 10)) {
169 		if (image_size < 2)
170 			return FLASH_NO_OP;
171 	}
172 
173 	printk(KERN_INFO "FLASH: flash image with %ld bytes stored for hardware flash on reboot\n", image_size);
174 
175 	return FLASH_IMG_READY;
176 }
177 
178 static void free_flash_list(struct flash_block_list *f)
179 {
180 	struct flash_block_list *next;
181 	int i;
182 
183 	while (f) {
184 		for (i = 0; i < f->num_blocks; i++)
185 			kmem_cache_free(flash_block_cache, f->blocks[i].data);
186 		next = f->next;
187 		kmem_cache_free(flash_block_cache, f);
188 		f = next;
189 	}
190 }
191 
192 static int rtas_flash_release(struct inode *inode, struct file *file)
193 {
194 	struct proc_dir_entry *dp = PDE(file->f_path.dentry->d_inode);
195 	struct rtas_update_flash_t *uf;
196 
197 	uf = (struct rtas_update_flash_t *) dp->data;
198 	if (uf->flist) {
199 		/* File was opened in write mode for a new flash attempt */
200 		/* Clear saved list */
201 		if (rtas_firmware_flash_list) {
202 			free_flash_list(rtas_firmware_flash_list);
203 			rtas_firmware_flash_list = NULL;
204 		}
205 
206 		if (uf->status != FLASH_AUTH)
207 			uf->status = flash_list_valid(uf->flist);
208 
209 		if (uf->status == FLASH_IMG_READY)
210 			rtas_firmware_flash_list = uf->flist;
211 		else
212 			free_flash_list(uf->flist);
213 
214 		uf->flist = NULL;
215 	}
216 
217 	atomic_dec(&dp->count);
218 	return 0;
219 }
220 
221 static void get_flash_status_msg(int status, char *buf)
222 {
223 	char *msg;
224 
225 	switch (status) {
226 	case FLASH_AUTH:
227 		msg = "error: this partition does not have service authority\n";
228 		break;
229 	case FLASH_NO_OP:
230 		msg = "info: no firmware image for flash\n";
231 		break;
232 	case FLASH_IMG_SHORT:
233 		msg = "error: flash image short\n";
234 		break;
235 	case FLASH_IMG_BAD_LEN:
236 		msg = "error: internal error bad length\n";
237 		break;
238 	case FLASH_IMG_NULL_DATA:
239 		msg = "error: internal error null data\n";
240 		break;
241 	case FLASH_IMG_READY:
242 		msg = "ready: firmware image ready for flash on reboot\n";
243 		break;
244 	default:
245 		sprintf(buf, "error: unexpected status value %d\n", status);
246 		return;
247 	}
248 
249 	strcpy(buf, msg);
250 }
251 
252 /* Reading the proc file will show status (not the firmware contents) */
253 static ssize_t rtas_flash_read(struct file *file, char __user *buf,
254 			       size_t count, loff_t *ppos)
255 {
256 	struct proc_dir_entry *dp = PDE(file->f_path.dentry->d_inode);
257 	struct rtas_update_flash_t *uf;
258 	char msg[RTAS_MSG_MAXLEN];
259 	int msglen;
260 
261 	uf = (struct rtas_update_flash_t *) dp->data;
262 
263 	if (!strcmp(dp->name, FIRMWARE_FLASH_NAME)) {
264 		get_flash_status_msg(uf->status, msg);
265 	} else {	   /* FIRMWARE_UPDATE_NAME */
266 		sprintf(msg, "%d\n", uf->status);
267 	}
268 	msglen = strlen(msg);
269 	if (msglen > count)
270 		msglen = count;
271 
272 	if (ppos && *ppos != 0)
273 		return 0;	/* be cheap */
274 
275 	if (!access_ok(VERIFY_WRITE, buf, msglen))
276 		return -EINVAL;
277 
278 	if (copy_to_user(buf, msg, msglen))
279 		return -EFAULT;
280 
281 	if (ppos)
282 		*ppos = msglen;
283 	return msglen;
284 }
285 
286 /* constructor for flash_block_cache */
287 void rtas_block_ctor(void *ptr)
288 {
289 	memset(ptr, 0, RTAS_BLK_SIZE);
290 }
291 
292 /* We could be much more efficient here.  But to keep this function
293  * simple we allocate a page to the block list no matter how small the
294  * count is.  If the system is low on memory it will be just as well
295  * that we fail....
296  */
297 static ssize_t rtas_flash_write(struct file *file, const char __user *buffer,
298 				size_t count, loff_t *off)
299 {
300 	struct proc_dir_entry *dp = PDE(file->f_path.dentry->d_inode);
301 	struct rtas_update_flash_t *uf;
302 	char *p;
303 	int next_free;
304 	struct flash_block_list *fl;
305 
306 	uf = (struct rtas_update_flash_t *) dp->data;
307 
308 	if (uf->status == FLASH_AUTH || count == 0)
309 		return count;	/* discard data */
310 
311 	/* In the case that the image is not ready for flashing, the memory
312 	 * allocated for the block list will be freed upon the release of the
313 	 * proc file
314 	 */
315 	if (uf->flist == NULL) {
316 		uf->flist = kmem_cache_alloc(flash_block_cache, GFP_KERNEL);
317 		if (!uf->flist)
318 			return -ENOMEM;
319 	}
320 
321 	fl = uf->flist;
322 	while (fl->next)
323 		fl = fl->next; /* seek to last block_list for append */
324 	next_free = fl->num_blocks;
325 	if (next_free == FLASH_BLOCKS_PER_NODE) {
326 		/* Need to allocate another block_list */
327 		fl->next = kmem_cache_alloc(flash_block_cache, GFP_KERNEL);
328 		if (!fl->next)
329 			return -ENOMEM;
330 		fl = fl->next;
331 		next_free = 0;
332 	}
333 
334 	if (count > RTAS_BLK_SIZE)
335 		count = RTAS_BLK_SIZE;
336 	p = kmem_cache_alloc(flash_block_cache, GFP_KERNEL);
337 	if (!p)
338 		return -ENOMEM;
339 
340 	if(copy_from_user(p, buffer, count)) {
341 		kmem_cache_free(flash_block_cache, p);
342 		return -EFAULT;
343 	}
344 	fl->blocks[next_free].data = p;
345 	fl->blocks[next_free].length = count;
346 	fl->num_blocks++;
347 
348 	return count;
349 }
350 
351 static int rtas_excl_open(struct inode *inode, struct file *file)
352 {
353 	struct proc_dir_entry *dp = PDE(inode);
354 
355 	/* Enforce exclusive open with use count of PDE */
356 	spin_lock(&flash_file_open_lock);
357 	if (atomic_read(&dp->count) > 2) {
358 		spin_unlock(&flash_file_open_lock);
359 		return -EBUSY;
360 	}
361 
362 	atomic_inc(&dp->count);
363 	spin_unlock(&flash_file_open_lock);
364 
365 	return 0;
366 }
367 
368 static int rtas_excl_release(struct inode *inode, struct file *file)
369 {
370 	struct proc_dir_entry *dp = PDE(inode);
371 
372 	atomic_dec(&dp->count);
373 
374 	return 0;
375 }
376 
377 static void manage_flash(struct rtas_manage_flash_t *args_buf)
378 {
379 	s32 rc;
380 
381 	do {
382 		rc = rtas_call(rtas_token("ibm,manage-flash-image"), 1,
383 			       1, NULL, args_buf->op);
384 	} while (rtas_busy_delay(rc));
385 
386 	args_buf->status = rc;
387 }
388 
389 static ssize_t manage_flash_read(struct file *file, char __user *buf,
390 			       size_t count, loff_t *ppos)
391 {
392 	struct proc_dir_entry *dp = PDE(file->f_path.dentry->d_inode);
393 	struct rtas_manage_flash_t *args_buf;
394 	char msg[RTAS_MSG_MAXLEN];
395 	int msglen;
396 
397 	args_buf = (struct rtas_manage_flash_t *) dp->data;
398 	if (args_buf == NULL)
399 		return 0;
400 
401 	msglen = sprintf(msg, "%d\n", args_buf->status);
402 	if (msglen > count)
403 		msglen = count;
404 
405 	if (ppos && *ppos != 0)
406 		return 0;	/* be cheap */
407 
408 	if (!access_ok(VERIFY_WRITE, buf, msglen))
409 		return -EINVAL;
410 
411 	if (copy_to_user(buf, msg, msglen))
412 		return -EFAULT;
413 
414 	if (ppos)
415 		*ppos = msglen;
416 	return msglen;
417 }
418 
419 static ssize_t manage_flash_write(struct file *file, const char __user *buf,
420 				size_t count, loff_t *off)
421 {
422 	struct proc_dir_entry *dp = PDE(file->f_path.dentry->d_inode);
423 	struct rtas_manage_flash_t *args_buf;
424 	const char reject_str[] = "0";
425 	const char commit_str[] = "1";
426 	char stkbuf[10];
427 	int op;
428 
429 	args_buf = (struct rtas_manage_flash_t *) dp->data;
430 	if ((args_buf->status == MANAGE_AUTH) || (count == 0))
431 		return count;
432 
433 	op = -1;
434 	if (buf) {
435 		if (count > 9) count = 9;
436 		if (copy_from_user (stkbuf, buf, count)) {
437 			return -EFAULT;
438 		}
439 		if (strncmp(stkbuf, reject_str, strlen(reject_str)) == 0)
440 			op = RTAS_REJECT_TMP_IMG;
441 		else if (strncmp(stkbuf, commit_str, strlen(commit_str)) == 0)
442 			op = RTAS_COMMIT_TMP_IMG;
443 	}
444 
445 	if (op == -1)   /* buf is empty, or contains invalid string */
446 		return -EINVAL;
447 
448 	args_buf->op = op;
449 	manage_flash(args_buf);
450 
451 	return count;
452 }
453 
454 static void validate_flash(struct rtas_validate_flash_t *args_buf)
455 {
456 	int token = rtas_token("ibm,validate-flash-image");
457 	int update_results;
458 	s32 rc;
459 
460 	rc = 0;
461 	do {
462 		spin_lock(&rtas_data_buf_lock);
463 		memcpy(rtas_data_buf, args_buf->buf, VALIDATE_BUF_SIZE);
464 		rc = rtas_call(token, 2, 2, &update_results,
465 			       (u32) __pa(rtas_data_buf), args_buf->buf_size);
466 		memcpy(args_buf->buf, rtas_data_buf, VALIDATE_BUF_SIZE);
467 		spin_unlock(&rtas_data_buf_lock);
468 	} while (rtas_busy_delay(rc));
469 
470 	args_buf->status = rc;
471 	args_buf->update_results = update_results;
472 }
473 
474 static int get_validate_flash_msg(struct rtas_validate_flash_t *args_buf,
475 		                   char *msg)
476 {
477 	int n;
478 
479 	if (args_buf->status >= VALIDATE_TMP_UPDATE) {
480 		n = sprintf(msg, "%d\n", args_buf->update_results);
481 		if ((args_buf->update_results >= VALIDATE_CUR_UNKNOWN) ||
482 		    (args_buf->update_results == VALIDATE_TMP_UPDATE))
483 			n += sprintf(msg + n, "%s\n", args_buf->buf);
484 	} else {
485 		n = sprintf(msg, "%d\n", args_buf->status);
486 	}
487 	return n;
488 }
489 
490 static ssize_t validate_flash_read(struct file *file, char __user *buf,
491 			       size_t count, loff_t *ppos)
492 {
493 	struct proc_dir_entry *dp = PDE(file->f_path.dentry->d_inode);
494 	struct rtas_validate_flash_t *args_buf;
495 	char msg[RTAS_MSG_MAXLEN];
496 	int msglen;
497 
498 	args_buf = (struct rtas_validate_flash_t *) dp->data;
499 
500 	if (ppos && *ppos != 0)
501 		return 0;	/* be cheap */
502 
503 	msglen = get_validate_flash_msg(args_buf, msg);
504 	if (msglen > count)
505 		msglen = count;
506 
507 	if (!access_ok(VERIFY_WRITE, buf, msglen))
508 		return -EINVAL;
509 
510 	if (copy_to_user(buf, msg, msglen))
511 		return -EFAULT;
512 
513 	if (ppos)
514 		*ppos = msglen;
515 	return msglen;
516 }
517 
518 static ssize_t validate_flash_write(struct file *file, const char __user *buf,
519 				    size_t count, loff_t *off)
520 {
521 	struct proc_dir_entry *dp = PDE(file->f_path.dentry->d_inode);
522 	struct rtas_validate_flash_t *args_buf;
523 	int rc;
524 
525 	args_buf = (struct rtas_validate_flash_t *) dp->data;
526 
527 	if (dp->data == NULL) {
528 		dp->data = kmalloc(sizeof(struct rtas_validate_flash_t),
529 				GFP_KERNEL);
530 		if (dp->data == NULL)
531 			return -ENOMEM;
532 	}
533 
534 	/* We are only interested in the first 4K of the
535 	 * candidate image */
536 	if ((*off >= VALIDATE_BUF_SIZE) ||
537 		(args_buf->status == VALIDATE_AUTH)) {
538 		*off += count;
539 		return count;
540 	}
541 
542 	if (*off + count >= VALIDATE_BUF_SIZE)  {
543 		count = VALIDATE_BUF_SIZE - *off;
544 		args_buf->status = VALIDATE_READY;
545 	} else {
546 		args_buf->status = VALIDATE_INCOMPLETE;
547 	}
548 
549 	if (!access_ok(VERIFY_READ, buf, count)) {
550 		rc = -EFAULT;
551 		goto done;
552 	}
553 	if (copy_from_user(args_buf->buf + *off, buf, count)) {
554 		rc = -EFAULT;
555 		goto done;
556 	}
557 
558 	*off += count;
559 	rc = count;
560 done:
561 	if (rc < 0) {
562 		kfree(dp->data);
563 		dp->data = NULL;
564 	}
565 	return rc;
566 }
567 
568 static int validate_flash_release(struct inode *inode, struct file *file)
569 {
570 	struct proc_dir_entry *dp = PDE(file->f_path.dentry->d_inode);
571 	struct rtas_validate_flash_t *args_buf;
572 
573 	args_buf = (struct rtas_validate_flash_t *) dp->data;
574 
575 	if (args_buf->status == VALIDATE_READY) {
576 		args_buf->buf_size = VALIDATE_BUF_SIZE;
577 		validate_flash(args_buf);
578 	}
579 
580 	/* The matching atomic_inc was in rtas_excl_open() */
581 	atomic_dec(&dp->count);
582 
583 	return 0;
584 }
585 
586 static void rtas_flash_firmware(int reboot_type)
587 {
588 	unsigned long image_size;
589 	struct flash_block_list *f, *next, *flist;
590 	unsigned long rtas_block_list;
591 	int i, status, update_token;
592 
593 	if (rtas_firmware_flash_list == NULL)
594 		return;		/* nothing to do */
595 
596 	if (reboot_type != SYS_RESTART) {
597 		printk(KERN_ALERT "FLASH: firmware flash requires a reboot\n");
598 		printk(KERN_ALERT "FLASH: the firmware image will NOT be flashed\n");
599 		return;
600 	}
601 
602 	update_token = rtas_token("ibm,update-flash-64-and-reboot");
603 	if (update_token == RTAS_UNKNOWN_SERVICE) {
604 		printk(KERN_ALERT "FLASH: ibm,update-flash-64-and-reboot "
605 		       "is not available -- not a service partition?\n");
606 		printk(KERN_ALERT "FLASH: firmware will not be flashed\n");
607 		return;
608 	}
609 
610 	/*
611 	 * NOTE: the "first" block must be under 4GB, so we create
612 	 * an entry with no data blocks in the reserved buffer in
613 	 * the kernel data segment.
614 	 */
615 	spin_lock(&rtas_data_buf_lock);
616 	flist = (struct flash_block_list *)&rtas_data_buf[0];
617 	flist->num_blocks = 0;
618 	flist->next = rtas_firmware_flash_list;
619 	rtas_block_list = virt_to_abs(flist);
620 	if (rtas_block_list >= 4UL*1024*1024*1024) {
621 		printk(KERN_ALERT "FLASH: kernel bug...flash list header addr above 4GB\n");
622 		spin_unlock(&rtas_data_buf_lock);
623 		return;
624 	}
625 
626 	printk(KERN_ALERT "FLASH: preparing saved firmware image for flash\n");
627 	/* Update the block_list in place. */
628 	rtas_firmware_flash_list = NULL; /* too hard to backout on error */
629 	image_size = 0;
630 	for (f = flist; f; f = next) {
631 		/* Translate data addrs to absolute */
632 		for (i = 0; i < f->num_blocks; i++) {
633 			f->blocks[i].data = (char *)virt_to_abs(f->blocks[i].data);
634 			image_size += f->blocks[i].length;
635 		}
636 		next = f->next;
637 		/* Don't translate NULL pointer for last entry */
638 		if (f->next)
639 			f->next = (struct flash_block_list *)virt_to_abs(f->next);
640 		else
641 			f->next = NULL;
642 		/* make num_blocks into the version/length field */
643 		f->num_blocks = (FLASH_BLOCK_LIST_VERSION << 56) | ((f->num_blocks+1)*16);
644 	}
645 
646 	printk(KERN_ALERT "FLASH: flash image is %ld bytes\n", image_size);
647 	printk(KERN_ALERT "FLASH: performing flash and reboot\n");
648 	rtas_progress("Flashing        \n", 0x0);
649 	rtas_progress("Please Wait...  ", 0x0);
650 	printk(KERN_ALERT "FLASH: this will take several minutes.  Do not power off!\n");
651 	status = rtas_call(update_token, 1, 1, NULL, rtas_block_list);
652 	switch (status) {	/* should only get "bad" status */
653 	    case 0:
654 		printk(KERN_ALERT "FLASH: success\n");
655 		break;
656 	    case -1:
657 		printk(KERN_ALERT "FLASH: hardware error.  Firmware may not be not flashed\n");
658 		break;
659 	    case -3:
660 		printk(KERN_ALERT "FLASH: image is corrupt or not correct for this platform.  Firmware not flashed\n");
661 		break;
662 	    case -4:
663 		printk(KERN_ALERT "FLASH: flash failed when partially complete.  System may not reboot\n");
664 		break;
665 	    default:
666 		printk(KERN_ALERT "FLASH: unknown flash return code %d\n", status);
667 		break;
668 	}
669 	spin_unlock(&rtas_data_buf_lock);
670 }
671 
672 static void remove_flash_pde(struct proc_dir_entry *dp)
673 {
674 	if (dp) {
675 		kfree(dp->data);
676 		remove_proc_entry(dp->name, dp->parent);
677 	}
678 }
679 
680 static int initialize_flash_pde_data(const char *rtas_call_name,
681 				     size_t buf_size,
682 				     struct proc_dir_entry *dp)
683 {
684 	int *status;
685 	int token;
686 
687 	dp->data = kzalloc(buf_size, GFP_KERNEL);
688 	if (dp->data == NULL) {
689 		remove_flash_pde(dp);
690 		return -ENOMEM;
691 	}
692 
693 	/*
694 	 * This code assumes that the status int is the first member of the
695 	 * struct
696 	 */
697 	status = (int *) dp->data;
698 	token = rtas_token(rtas_call_name);
699 	if (token == RTAS_UNKNOWN_SERVICE)
700 		*status = FLASH_AUTH;
701 	else
702 		*status = FLASH_NO_OP;
703 
704 	return 0;
705 }
706 
707 static struct proc_dir_entry *create_flash_pde(const char *filename,
708 					       const struct file_operations *fops)
709 {
710 	return proc_create(filename, S_IRUSR | S_IWUSR, NULL, fops);
711 }
712 
713 static const struct file_operations rtas_flash_operations = {
714 	.owner		= THIS_MODULE,
715 	.read		= rtas_flash_read,
716 	.write		= rtas_flash_write,
717 	.open		= rtas_excl_open,
718 	.release	= rtas_flash_release,
719 	.llseek		= default_llseek,
720 };
721 
722 static const struct file_operations manage_flash_operations = {
723 	.owner		= THIS_MODULE,
724 	.read		= manage_flash_read,
725 	.write		= manage_flash_write,
726 	.open		= rtas_excl_open,
727 	.release	= rtas_excl_release,
728 	.llseek		= default_llseek,
729 };
730 
731 static const struct file_operations validate_flash_operations = {
732 	.owner		= THIS_MODULE,
733 	.read		= validate_flash_read,
734 	.write		= validate_flash_write,
735 	.open		= rtas_excl_open,
736 	.release	= validate_flash_release,
737 	.llseek		= default_llseek,
738 };
739 
740 static int __init rtas_flash_init(void)
741 {
742 	int rc;
743 
744 	if (rtas_token("ibm,update-flash-64-and-reboot") ==
745 		       RTAS_UNKNOWN_SERVICE) {
746 		printk(KERN_ERR "rtas_flash: no firmware flash support\n");
747 		return 1;
748 	}
749 
750 	firmware_flash_pde = create_flash_pde("powerpc/rtas/"
751 					      FIRMWARE_FLASH_NAME,
752 					      &rtas_flash_operations);
753 	if (firmware_flash_pde == NULL) {
754 		rc = -ENOMEM;
755 		goto cleanup;
756 	}
757 
758 	rc = initialize_flash_pde_data("ibm,update-flash-64-and-reboot",
759 			 	       sizeof(struct rtas_update_flash_t),
760 				       firmware_flash_pde);
761 	if (rc != 0)
762 		goto cleanup;
763 
764 	firmware_update_pde = create_flash_pde("powerpc/rtas/"
765 					       FIRMWARE_UPDATE_NAME,
766 					       &rtas_flash_operations);
767 	if (firmware_update_pde == NULL) {
768 		rc = -ENOMEM;
769 		goto cleanup;
770 	}
771 
772 	rc = initialize_flash_pde_data("ibm,update-flash-64-and-reboot",
773 			 	       sizeof(struct rtas_update_flash_t),
774 				       firmware_update_pde);
775 	if (rc != 0)
776 		goto cleanup;
777 
778 	validate_pde = create_flash_pde("powerpc/rtas/" VALIDATE_FLASH_NAME,
779 			      		&validate_flash_operations);
780 	if (validate_pde == NULL) {
781 		rc = -ENOMEM;
782 		goto cleanup;
783 	}
784 
785 	rc = initialize_flash_pde_data("ibm,validate-flash-image",
786 		                       sizeof(struct rtas_validate_flash_t),
787 				       validate_pde);
788 	if (rc != 0)
789 		goto cleanup;
790 
791 	manage_pde = create_flash_pde("powerpc/rtas/" MANAGE_FLASH_NAME,
792 				      &manage_flash_operations);
793 	if (manage_pde == NULL) {
794 		rc = -ENOMEM;
795 		goto cleanup;
796 	}
797 
798 	rc = initialize_flash_pde_data("ibm,manage-flash-image",
799 			               sizeof(struct rtas_manage_flash_t),
800 				       manage_pde);
801 	if (rc != 0)
802 		goto cleanup;
803 
804 	rtas_flash_term_hook = rtas_flash_firmware;
805 
806 	flash_block_cache = kmem_cache_create("rtas_flash_cache",
807 				RTAS_BLK_SIZE, RTAS_BLK_SIZE, 0,
808 				rtas_block_ctor);
809 	if (!flash_block_cache) {
810 		printk(KERN_ERR "%s: failed to create block cache\n",
811 				__func__);
812 		rc = -ENOMEM;
813 		goto cleanup;
814 	}
815 	return 0;
816 
817 cleanup:
818 	remove_flash_pde(firmware_flash_pde);
819 	remove_flash_pde(firmware_update_pde);
820 	remove_flash_pde(validate_pde);
821 	remove_flash_pde(manage_pde);
822 
823 	return rc;
824 }
825 
826 static void __exit rtas_flash_cleanup(void)
827 {
828 	rtas_flash_term_hook = NULL;
829 
830 	if (flash_block_cache)
831 		kmem_cache_destroy(flash_block_cache);
832 
833 	remove_flash_pde(firmware_flash_pde);
834 	remove_flash_pde(firmware_update_pde);
835 	remove_flash_pde(validate_pde);
836 	remove_flash_pde(manage_pde);
837 }
838 
839 module_init(rtas_flash_init);
840 module_exit(rtas_flash_cleanup);
841 MODULE_LICENSE("GPL");
842