blob: 5b770262c6737034dcb5c9947bde05375c71250f [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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 *
Benjamin Herrenschmidt188917e2009-09-24 19:29:13 +00009 * /proc/powerpc/rtas/firmware_flash interface
Linus Torvalds1da177e2005-04-16 15:20:36 -070010 *
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>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090018#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/proc_fs.h>
Amerigo Wangc5f41752011-07-25 17:13:10 -070020#include <linux/reboot.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070021#include <asm/delay.h>
22#include <asm/uaccess.h>
23#include <asm/rtas.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
John Roseae883ca2006-11-08 10:07:30 -060076/* Quirk - RTAS requires 4k list length and block size */
77#define RTAS_BLKLIST_LENGTH 4096
78#define RTAS_BLK_SIZE 4096
79
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +110080struct 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 */
John Roseae883ca2006-11-08 10:07:30 -060091#define FLASH_BLOCKS_PER_NODE ((RTAS_BLKLIST_LENGTH - 16) / sizeof(struct flash_block))
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +110092struct flash_block_list {
93 unsigned long num_blocks;
94 struct flash_block_list *next;
95 struct flash_block blocks[FLASH_BLOCKS_PER_NODE];
96};
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +110097
Milton Millerbd2b64a2010-06-12 03:48:47 +000098static struct flash_block_list *rtas_firmware_flash_list;
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +110099
John Roseae883ca2006-11-08 10:07:30 -0600100/* Use slab cache to guarantee 4k alignment */
Christoph Lametere18b8902006-12-06 20:33:20 -0800101static struct kmem_cache *flash_block_cache = NULL;
John Roseae883ca2006-11-08 10:07:30 -0600102
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +1100103#define FLASH_BLOCK_LIST_VERSION (1UL)
104
David Howellse8eeded2013-04-13 00:48:49 +0100105/*
106 * Local copy of the flash block list.
107 *
108 * The rtas_firmware_flash_list varable will be
Milton Millerbd2b64a2010-06-12 03:48:47 +0000109 * set once the data is fully read.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110 *
111 * For convenience as we build the list we use virtual addrs,
112 * we do not fill in the version number, and the length field
113 * is treated as the number of entries currently in the block
Milton Millerbd2b64a2010-06-12 03:48:47 +0000114 * (i.e. not a byte count). This is all fixed when calling
115 * the flash routine.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 */
117
118/* Status int must be first member of struct */
119struct rtas_update_flash_t
120{
121 int status; /* Flash update status */
122 struct flash_block_list *flist; /* Local copy of flash block list */
123};
124
125/* Status int must be first member of struct */
126struct rtas_manage_flash_t
127{
128 int status; /* Returned status */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129};
130
131/* Status int must be first member of struct */
132struct rtas_validate_flash_t
133{
134 int status; /* Returned status */
David Howellse8eeded2013-04-13 00:48:49 +0100135 char *buf; /* Candidate image buffer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 unsigned int buf_size; /* Size of image buf */
137 unsigned int update_results; /* Update results token */
138};
139
David Howellse8eeded2013-04-13 00:48:49 +0100140static struct rtas_update_flash_t rtas_update_flash_data;
141static struct rtas_manage_flash_t rtas_manage_flash_data;
142static struct rtas_validate_flash_t rtas_validate_flash_data;
143static DEFINE_MUTEX(rtas_update_flash_mutex);
144static DEFINE_MUTEX(rtas_manage_flash_mutex);
145static DEFINE_MUTEX(rtas_validate_flash_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146
147/* Do simple sanity checks on the flash image. */
148static int flash_list_valid(struct flash_block_list *flist)
149{
150 struct flash_block_list *f;
151 int i;
152 unsigned long block_size, image_size;
153
154 /* Paranoid self test here. We also collect the image size. */
155 image_size = 0;
156 for (f = flist; f; f = f->next) {
157 for (i = 0; i < f->num_blocks; i++) {
158 if (f->blocks[i].data == NULL) {
159 return FLASH_IMG_NULL_DATA;
160 }
161 block_size = f->blocks[i].length;
John Roseae883ca2006-11-08 10:07:30 -0600162 if (block_size <= 0 || block_size > RTAS_BLK_SIZE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 return FLASH_IMG_BAD_LEN;
164 }
165 image_size += block_size;
166 }
167 }
168
169 if (image_size < (256 << 10)) {
170 if (image_size < 2)
171 return FLASH_NO_OP;
172 }
173
174 printk(KERN_INFO "FLASH: flash image with %ld bytes stored for hardware flash on reboot\n", image_size);
175
176 return FLASH_IMG_READY;
177}
178
179static void free_flash_list(struct flash_block_list *f)
180{
181 struct flash_block_list *next;
182 int i;
183
184 while (f) {
185 for (i = 0; i < f->num_blocks; i++)
John Roseae883ca2006-11-08 10:07:30 -0600186 kmem_cache_free(flash_block_cache, f->blocks[i].data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 next = f->next;
John Roseae883ca2006-11-08 10:07:30 -0600188 kmem_cache_free(flash_block_cache, f);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 f = next;
190 }
191}
192
193static int rtas_flash_release(struct inode *inode, struct file *file)
194{
David Howellse8eeded2013-04-13 00:48:49 +0100195 struct rtas_update_flash_t *const uf = &rtas_update_flash_data;
196
197 mutex_lock(&rtas_update_flash_mutex);
198
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 if (uf->flist) {
200 /* File was opened in write mode for a new flash attempt */
201 /* Clear saved list */
Milton Millerbd2b64a2010-06-12 03:48:47 +0000202 if (rtas_firmware_flash_list) {
203 free_flash_list(rtas_firmware_flash_list);
204 rtas_firmware_flash_list = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 }
206
207 if (uf->status != FLASH_AUTH)
208 uf->status = flash_list_valid(uf->flist);
209
210 if (uf->status == FLASH_IMG_READY)
Milton Millerbd2b64a2010-06-12 03:48:47 +0000211 rtas_firmware_flash_list = uf->flist;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 else
213 free_flash_list(uf->flist);
214
215 uf->flist = NULL;
216 }
217
David Howellse8eeded2013-04-13 00:48:49 +0100218 mutex_unlock(&rtas_update_flash_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219 return 0;
220}
221
David Howellse8eeded2013-04-13 00:48:49 +0100222static size_t get_flash_status_msg(int status, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223{
David Howellse8eeded2013-04-13 00:48:49 +0100224 const char *msg;
225 size_t len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226
227 switch (status) {
228 case FLASH_AUTH:
229 msg = "error: this partition does not have service authority\n";
230 break;
231 case FLASH_NO_OP:
232 msg = "info: no firmware image for flash\n";
233 break;
234 case FLASH_IMG_SHORT:
235 msg = "error: flash image short\n";
236 break;
237 case FLASH_IMG_BAD_LEN:
238 msg = "error: internal error bad length\n";
239 break;
240 case FLASH_IMG_NULL_DATA:
241 msg = "error: internal error null data\n";
242 break;
243 case FLASH_IMG_READY:
244 msg = "ready: firmware image ready for flash on reboot\n";
245 break;
246 default:
David Howellse8eeded2013-04-13 00:48:49 +0100247 return sprintf(buf, "error: unexpected status value %d\n",
248 status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 }
250
David Howellse8eeded2013-04-13 00:48:49 +0100251 len = strlen(msg);
252 memcpy(buf, msg, len + 1);
253 return len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254}
255
256/* Reading the proc file will show status (not the firmware contents) */
David Howellse8eeded2013-04-13 00:48:49 +0100257static ssize_t rtas_flash_read_msg(struct file *file, char __user *buf,
258 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259{
David Howellse8eeded2013-04-13 00:48:49 +0100260 struct rtas_update_flash_t *const uf = &rtas_update_flash_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 char msg[RTAS_MSG_MAXLEN];
David Howellse8eeded2013-04-13 00:48:49 +0100262 size_t len;
263 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264
David Howellse8eeded2013-04-13 00:48:49 +0100265 mutex_lock(&rtas_update_flash_mutex);
266 status = uf->status;
267 mutex_unlock(&rtas_update_flash_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268
David Howellse8eeded2013-04-13 00:48:49 +0100269 /* Read as text message */
270 len = get_flash_status_msg(status, msg);
271 return simple_read_from_buffer(buf, count, ppos, msg, len);
272}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273
David Howellse8eeded2013-04-13 00:48:49 +0100274static ssize_t rtas_flash_read_num(struct file *file, char __user *buf,
275 size_t count, loff_t *ppos)
276{
277 struct rtas_update_flash_t *const uf = &rtas_update_flash_data;
278 char msg[RTAS_MSG_MAXLEN];
279 int status;
280
281 mutex_lock(&rtas_update_flash_mutex);
282 status = uf->status;
283 mutex_unlock(&rtas_update_flash_mutex);
284
285 /* Read as number */
286 sprintf(msg, "%d\n", status);
Akinobu Mita4c4a5cf2010-12-24 20:03:59 +0000287 return simple_read_from_buffer(buf, count, ppos, msg, strlen(msg));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288}
289
John Roseae883ca2006-11-08 10:07:30 -0600290/* constructor for flash_block_cache */
David Howellse8eeded2013-04-13 00:48:49 +0100291static void rtas_block_ctor(void *ptr)
John Roseae883ca2006-11-08 10:07:30 -0600292{
293 memset(ptr, 0, RTAS_BLK_SIZE);
294}
295
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296/* We could be much more efficient here. But to keep this function
297 * simple we allocate a page to the block list no matter how small the
298 * count is. If the system is low on memory it will be just as well
299 * that we fail....
300 */
Al Viroefa54572005-04-26 11:26:53 -0700301static ssize_t rtas_flash_write(struct file *file, const char __user *buffer,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302 size_t count, loff_t *off)
303{
David Howellse8eeded2013-04-13 00:48:49 +0100304 struct rtas_update_flash_t *const uf = &rtas_update_flash_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 char *p;
David Howellse8eeded2013-04-13 00:48:49 +0100306 int next_free, rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307 struct flash_block_list *fl;
308
David Howellse8eeded2013-04-13 00:48:49 +0100309 mutex_lock(&rtas_update_flash_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310
311 if (uf->status == FLASH_AUTH || count == 0)
David Howellse8eeded2013-04-13 00:48:49 +0100312 goto out; /* discard data */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313
314 /* In the case that the image is not ready for flashing, the memory
315 * allocated for the block list will be freed upon the release of the
316 * proc file
317 */
318 if (uf->flist == NULL) {
John Roseae883ca2006-11-08 10:07:30 -0600319 uf->flist = kmem_cache_alloc(flash_block_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 if (!uf->flist)
David Howellse8eeded2013-04-13 00:48:49 +0100321 goto nomem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 }
323
324 fl = uf->flist;
325 while (fl->next)
326 fl = fl->next; /* seek to last block_list for append */
327 next_free = fl->num_blocks;
328 if (next_free == FLASH_BLOCKS_PER_NODE) {
329 /* Need to allocate another block_list */
John Roseae883ca2006-11-08 10:07:30 -0600330 fl->next = kmem_cache_alloc(flash_block_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 if (!fl->next)
David Howellse8eeded2013-04-13 00:48:49 +0100332 goto nomem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333 fl = fl->next;
334 next_free = 0;
335 }
336
John Roseae883ca2006-11-08 10:07:30 -0600337 if (count > RTAS_BLK_SIZE)
338 count = RTAS_BLK_SIZE;
339 p = kmem_cache_alloc(flash_block_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340 if (!p)
David Howellse8eeded2013-04-13 00:48:49 +0100341 goto nomem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342
343 if(copy_from_user(p, buffer, count)) {
John Roseae883ca2006-11-08 10:07:30 -0600344 kmem_cache_free(flash_block_cache, p);
David Howellse8eeded2013-04-13 00:48:49 +0100345 rc = -EFAULT;
346 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 }
348 fl->blocks[next_free].data = p;
349 fl->blocks[next_free].length = count;
350 fl->num_blocks++;
David Howellse8eeded2013-04-13 00:48:49 +0100351out:
352 mutex_unlock(&rtas_update_flash_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 return count;
David Howellse8eeded2013-04-13 00:48:49 +0100354
355nomem:
356 rc = -ENOMEM;
357error:
358 mutex_unlock(&rtas_update_flash_mutex);
359 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360}
361
David Howellse8eeded2013-04-13 00:48:49 +0100362/*
363 * Flash management routines.
364 */
365static void manage_flash(struct rtas_manage_flash_t *args_buf, unsigned int op)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367 s32 rc;
368
John Rose507279d2006-06-05 16:31:48 -0500369 do {
David Howellse8eeded2013-04-13 00:48:49 +0100370 rc = rtas_call(rtas_token("ibm,manage-flash-image"), 1, 1,
371 NULL, op);
John Rose507279d2006-06-05 16:31:48 -0500372 } while (rtas_busy_delay(rc));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373
374 args_buf->status = rc;
375}
376
Al Viroefa54572005-04-26 11:26:53 -0700377static ssize_t manage_flash_read(struct file *file, char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 size_t count, loff_t *ppos)
379{
David Howellse8eeded2013-04-13 00:48:49 +0100380 struct rtas_manage_flash_t *const args_buf = &rtas_manage_flash_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 char msg[RTAS_MSG_MAXLEN];
David Howellse8eeded2013-04-13 00:48:49 +0100382 int msglen, status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383
David Howellse8eeded2013-04-13 00:48:49 +0100384 mutex_lock(&rtas_manage_flash_mutex);
385 status = args_buf->status;
386 mutex_unlock(&rtas_manage_flash_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387
David Howellse8eeded2013-04-13 00:48:49 +0100388 msglen = sprintf(msg, "%d\n", status);
Akinobu Mita4c4a5cf2010-12-24 20:03:59 +0000389 return simple_read_from_buffer(buf, count, ppos, msg, msglen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390}
391
Al Viroefa54572005-04-26 11:26:53 -0700392static ssize_t manage_flash_write(struct file *file, const char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 size_t count, loff_t *off)
394{
David Howellse8eeded2013-04-13 00:48:49 +0100395 struct rtas_manage_flash_t *const args_buf = &rtas_manage_flash_data;
396 static const char reject_str[] = "0";
397 static const char commit_str[] = "1";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 char stkbuf[10];
David Howellse8eeded2013-04-13 00:48:49 +0100399 int op, rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400
David Howellse8eeded2013-04-13 00:48:49 +0100401 mutex_lock(&rtas_manage_flash_mutex);
402
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 if ((args_buf->status == MANAGE_AUTH) || (count == 0))
David Howellse8eeded2013-04-13 00:48:49 +0100404 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405
406 op = -1;
407 if (buf) {
408 if (count > 9) count = 9;
David Howellse8eeded2013-04-13 00:48:49 +0100409 rc = -EFAULT;
410 if (copy_from_user (stkbuf, buf, count))
411 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 if (strncmp(stkbuf, reject_str, strlen(reject_str)) == 0)
413 op = RTAS_REJECT_TMP_IMG;
414 else if (strncmp(stkbuf, commit_str, strlen(commit_str)) == 0)
415 op = RTAS_COMMIT_TMP_IMG;
416 }
417
David Howellse8eeded2013-04-13 00:48:49 +0100418 if (op == -1) { /* buf is empty, or contains invalid string */
419 rc = -EINVAL;
420 goto error;
421 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422
David Howellse8eeded2013-04-13 00:48:49 +0100423 manage_flash(args_buf, op);
424out:
425 mutex_unlock(&rtas_manage_flash_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 return count;
David Howellse8eeded2013-04-13 00:48:49 +0100427
428error:
429 mutex_unlock(&rtas_manage_flash_mutex);
430 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431}
432
David Howellse8eeded2013-04-13 00:48:49 +0100433/*
434 * Validation routines.
435 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436static void validate_flash(struct rtas_validate_flash_t *args_buf)
437{
438 int token = rtas_token("ibm,validate-flash-image");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 int update_results;
440 s32 rc;
441
442 rc = 0;
John Rose507279d2006-06-05 16:31:48 -0500443 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 spin_lock(&rtas_data_buf_lock);
445 memcpy(rtas_data_buf, args_buf->buf, VALIDATE_BUF_SIZE);
446 rc = rtas_call(token, 2, 2, &update_results,
447 (u32) __pa(rtas_data_buf), args_buf->buf_size);
448 memcpy(args_buf->buf, rtas_data_buf, VALIDATE_BUF_SIZE);
449 spin_unlock(&rtas_data_buf_lock);
John Rose507279d2006-06-05 16:31:48 -0500450 } while (rtas_busy_delay(rc));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451
452 args_buf->status = rc;
453 args_buf->update_results = update_results;
454}
455
456static int get_validate_flash_msg(struct rtas_validate_flash_t *args_buf,
457 char *msg)
458{
459 int n;
460
461 if (args_buf->status >= VALIDATE_TMP_UPDATE) {
462 n = sprintf(msg, "%d\n", args_buf->update_results);
463 if ((args_buf->update_results >= VALIDATE_CUR_UNKNOWN) ||
464 (args_buf->update_results == VALIDATE_TMP_UPDATE))
465 n += sprintf(msg + n, "%s\n", args_buf->buf);
466 } else {
467 n = sprintf(msg, "%d\n", args_buf->status);
468 }
469 return n;
470}
471
Al Viroefa54572005-04-26 11:26:53 -0700472static ssize_t validate_flash_read(struct file *file, char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 size_t count, loff_t *ppos)
474{
David Howellse8eeded2013-04-13 00:48:49 +0100475 struct rtas_validate_flash_t *const args_buf =
476 &rtas_validate_flash_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 char msg[RTAS_MSG_MAXLEN];
478 int msglen;
479
David Howellse8eeded2013-04-13 00:48:49 +0100480 mutex_lock(&rtas_validate_flash_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481 msglen = get_validate_flash_msg(args_buf, msg);
David Howellse8eeded2013-04-13 00:48:49 +0100482 mutex_unlock(&rtas_validate_flash_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483
Akinobu Mita4c4a5cf2010-12-24 20:03:59 +0000484 return simple_read_from_buffer(buf, count, ppos, msg, msglen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485}
486
Al Viroefa54572005-04-26 11:26:53 -0700487static ssize_t validate_flash_write(struct file *file, const char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 size_t count, loff_t *off)
489{
David Howellse8eeded2013-04-13 00:48:49 +0100490 struct rtas_validate_flash_t *const args_buf =
491 &rtas_validate_flash_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 int rc;
493
David Howellse8eeded2013-04-13 00:48:49 +0100494 mutex_lock(&rtas_validate_flash_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495
496 /* We are only interested in the first 4K of the
497 * candidate image */
498 if ((*off >= VALIDATE_BUF_SIZE) ||
499 (args_buf->status == VALIDATE_AUTH)) {
500 *off += count;
David Howellse8eeded2013-04-13 00:48:49 +0100501 mutex_unlock(&rtas_validate_flash_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 return count;
503 }
504
505 if (*off + count >= VALIDATE_BUF_SIZE) {
506 count = VALIDATE_BUF_SIZE - *off;
507 args_buf->status = VALIDATE_READY;
508 } else {
509 args_buf->status = VALIDATE_INCOMPLETE;
510 }
511
512 if (!access_ok(VERIFY_READ, buf, count)) {
513 rc = -EFAULT;
514 goto done;
515 }
516 if (copy_from_user(args_buf->buf + *off, buf, count)) {
517 rc = -EFAULT;
518 goto done;
519 }
520
521 *off += count;
522 rc = count;
523done:
David Howellse8eeded2013-04-13 00:48:49 +0100524 mutex_unlock(&rtas_validate_flash_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 return rc;
526}
527
528static int validate_flash_release(struct inode *inode, struct file *file)
529{
David Howellse8eeded2013-04-13 00:48:49 +0100530 struct rtas_validate_flash_t *const args_buf =
531 &rtas_validate_flash_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532
David Howellse8eeded2013-04-13 00:48:49 +0100533 mutex_lock(&rtas_validate_flash_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534
535 if (args_buf->status == VALIDATE_READY) {
536 args_buf->buf_size = VALIDATE_BUF_SIZE;
537 validate_flash(args_buf);
538 }
539
David Howellse8eeded2013-04-13 00:48:49 +0100540 mutex_unlock(&rtas_validate_flash_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 return 0;
542}
543
David Howellse8eeded2013-04-13 00:48:49 +0100544/*
545 * On-reboot flash update applicator.
546 */
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +1100547static void rtas_flash_firmware(int reboot_type)
548{
549 unsigned long image_size;
550 struct flash_block_list *f, *next, *flist;
551 unsigned long rtas_block_list;
552 int i, status, update_token;
553
Milton Millerbd2b64a2010-06-12 03:48:47 +0000554 if (rtas_firmware_flash_list == NULL)
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +1100555 return; /* nothing to do */
556
557 if (reboot_type != SYS_RESTART) {
558 printk(KERN_ALERT "FLASH: firmware flash requires a reboot\n");
559 printk(KERN_ALERT "FLASH: the firmware image will NOT be flashed\n");
560 return;
561 }
562
563 update_token = rtas_token("ibm,update-flash-64-and-reboot");
564 if (update_token == RTAS_UNKNOWN_SERVICE) {
565 printk(KERN_ALERT "FLASH: ibm,update-flash-64-and-reboot "
566 "is not available -- not a service partition?\n");
567 printk(KERN_ALERT "FLASH: firmware will not be flashed\n");
568 return;
569 }
570
Milton Millerbd2b64a2010-06-12 03:48:47 +0000571 /*
Ravi K. Nittaladf17f562011-10-03 21:49:53 +0000572 * Just before starting the firmware flash, cancel the event scan work
573 * to avoid any soft lockup issues.
574 */
575 rtas_cancel_event_scan();
576
577 /*
Milton Millerbd2b64a2010-06-12 03:48:47 +0000578 * NOTE: the "first" block must be under 4GB, so we create
579 * an entry with no data blocks in the reserved buffer in
580 * the kernel data segment.
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +1100581 */
Milton Millerbd2b64a2010-06-12 03:48:47 +0000582 spin_lock(&rtas_data_buf_lock);
583 flist = (struct flash_block_list *)&rtas_data_buf[0];
584 flist->num_blocks = 0;
585 flist->next = rtas_firmware_flash_list;
Michael Ellerman3d267522012-07-25 21:19:56 +0000586 rtas_block_list = __pa(flist);
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +1100587 if (rtas_block_list >= 4UL*1024*1024*1024) {
588 printk(KERN_ALERT "FLASH: kernel bug...flash list header addr above 4GB\n");
Milton Millerbd2b64a2010-06-12 03:48:47 +0000589 spin_unlock(&rtas_data_buf_lock);
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +1100590 return;
591 }
592
593 printk(KERN_ALERT "FLASH: preparing saved firmware image for flash\n");
594 /* Update the block_list in place. */
Milton Millerbd2b64a2010-06-12 03:48:47 +0000595 rtas_firmware_flash_list = NULL; /* too hard to backout on error */
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +1100596 image_size = 0;
597 for (f = flist; f; f = next) {
598 /* Translate data addrs to absolute */
599 for (i = 0; i < f->num_blocks; i++) {
Michael Ellerman3d267522012-07-25 21:19:56 +0000600 f->blocks[i].data = (char *)__pa(f->blocks[i].data);
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +1100601 image_size += f->blocks[i].length;
602 }
603 next = f->next;
604 /* Don't translate NULL pointer for last entry */
605 if (f->next)
Michael Ellerman3d267522012-07-25 21:19:56 +0000606 f->next = (struct flash_block_list *)__pa(f->next);
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +1100607 else
608 f->next = NULL;
609 /* make num_blocks into the version/length field */
610 f->num_blocks = (FLASH_BLOCK_LIST_VERSION << 56) | ((f->num_blocks+1)*16);
611 }
612
613 printk(KERN_ALERT "FLASH: flash image is %ld bytes\n", image_size);
614 printk(KERN_ALERT "FLASH: performing flash and reboot\n");
615 rtas_progress("Flashing \n", 0x0);
616 rtas_progress("Please Wait... ", 0x0);
617 printk(KERN_ALERT "FLASH: this will take several minutes. Do not power off!\n");
618 status = rtas_call(update_token, 1, 1, NULL, rtas_block_list);
619 switch (status) { /* should only get "bad" status */
620 case 0:
621 printk(KERN_ALERT "FLASH: success\n");
622 break;
623 case -1:
624 printk(KERN_ALERT "FLASH: hardware error. Firmware may not be not flashed\n");
625 break;
626 case -3:
627 printk(KERN_ALERT "FLASH: image is corrupt or not correct for this platform. Firmware not flashed\n");
628 break;
629 case -4:
630 printk(KERN_ALERT "FLASH: flash failed when partially complete. System may not reboot\n");
631 break;
632 default:
633 printk(KERN_ALERT "FLASH: unknown flash return code %d\n", status);
634 break;
635 }
Milton Millerbd2b64a2010-06-12 03:48:47 +0000636 spin_unlock(&rtas_data_buf_lock);
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +1100637}
638
David Howellse8eeded2013-04-13 00:48:49 +0100639/*
640 * Manifest of proc files to create
641 */
642struct rtas_flash_file {
643 const char *filename;
644 const char *rtas_call_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645 int *status;
David Howellse8eeded2013-04-13 00:48:49 +0100646 const struct file_operations fops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647};
648
David Howellse8eeded2013-04-13 00:48:49 +0100649static const struct rtas_flash_file rtas_flash_files[] = {
650 {
651 .filename = "powerpc/rtas/" FIRMWARE_FLASH_NAME,
652 .rtas_call_name = "ibm,update-flash-64-and-reboot",
653 .status = &rtas_update_flash_data.status,
654 .fops.read = rtas_flash_read_msg,
655 .fops.write = rtas_flash_write,
656 .fops.release = rtas_flash_release,
657 .fops.llseek = default_llseek,
658 },
659 {
660 .filename = "powerpc/rtas/" FIRMWARE_UPDATE_NAME,
661 .rtas_call_name = "ibm,update-flash-64-and-reboot",
662 .status = &rtas_update_flash_data.status,
663 .fops.read = rtas_flash_read_num,
664 .fops.write = rtas_flash_write,
665 .fops.release = rtas_flash_release,
666 .fops.llseek = default_llseek,
667 },
668 {
669 .filename = "powerpc/rtas/" VALIDATE_FLASH_NAME,
670 .rtas_call_name = "ibm,validate-flash-image",
671 .status = &rtas_validate_flash_data.status,
672 .fops.read = validate_flash_read,
673 .fops.write = validate_flash_write,
674 .fops.release = validate_flash_release,
675 .fops.llseek = default_llseek,
676 },
677 {
678 .filename = "powerpc/rtas/" MANAGE_FLASH_NAME,
679 .rtas_call_name = "ibm,manage-flash-image",
680 .status = &rtas_manage_flash_data.status,
681 .fops.read = manage_flash_read,
682 .fops.write = manage_flash_write,
683 .fops.llseek = default_llseek,
684 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685};
686
Michael Ellerman1c21a292008-05-08 14:27:19 +1000687static int __init rtas_flash_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688{
David Howellse8eeded2013-04-13 00:48:49 +0100689 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690
691 if (rtas_token("ibm,update-flash-64-and-reboot") ==
692 RTAS_UNKNOWN_SERVICE) {
Anton Blanchard0e384982012-07-22 20:42:32 +0000693 pr_info("rtas_flash: no firmware flash support\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 return 1;
695 }
696
David Howellse8eeded2013-04-13 00:48:49 +0100697 rtas_validate_flash_data.buf = kzalloc(VALIDATE_BUF_SIZE, GFP_KERNEL);
698 if (!rtas_validate_flash_data.buf)
699 return -ENOMEM;
John Roseae883ca2006-11-08 10:07:30 -0600700
701 flash_block_cache = kmem_cache_create("rtas_flash_cache",
David Howellse8eeded2013-04-13 00:48:49 +0100702 RTAS_BLK_SIZE, RTAS_BLK_SIZE, 0,
703 rtas_block_ctor);
John Roseae883ca2006-11-08 10:07:30 -0600704 if (!flash_block_cache) {
705 printk(KERN_ERR "%s: failed to create block cache\n",
Harvey Harrisone48b1b42008-03-29 08:21:07 +1100706 __func__);
David Howellse8eeded2013-04-13 00:48:49 +0100707 goto enomem_buf;
John Roseae883ca2006-11-08 10:07:30 -0600708 }
David Howellse8eeded2013-04-13 00:48:49 +0100709
710 for (i = 0; i < ARRAY_SIZE(rtas_flash_files); i++) {
711 const struct rtas_flash_file *f = &rtas_flash_files[i];
712 int token;
713
714 if (!proc_create(f->filename, S_IRUSR | S_IWUSR, NULL, &f->fops))
715 goto enomem;
716
717 /*
718 * This code assumes that the status int is the first member of the
719 * struct
720 */
721 token = rtas_token(f->rtas_call_name);
722 if (token == RTAS_UNKNOWN_SERVICE)
723 *f->status = FLASH_AUTH;
724 else
725 *f->status = FLASH_NO_OP;
726 }
727
728 rtas_flash_term_hook = rtas_flash_firmware;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729 return 0;
730
David Howellse8eeded2013-04-13 00:48:49 +0100731enomem:
732 while (--i >= 0) {
733 const struct rtas_flash_file *f = &rtas_flash_files[i];
734 remove_proc_entry(f->filename, NULL);
735 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736
David Howellse8eeded2013-04-13 00:48:49 +0100737 kmem_cache_destroy(flash_block_cache);
738enomem_buf:
739 kfree(rtas_validate_flash_data.buf);
740 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741}
742
Michael Ellerman1c21a292008-05-08 14:27:19 +1000743static void __exit rtas_flash_cleanup(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744{
David Howellse8eeded2013-04-13 00:48:49 +0100745 int i;
746
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +1100747 rtas_flash_term_hook = NULL;
John Roseae883ca2006-11-08 10:07:30 -0600748
David Howellse8eeded2013-04-13 00:48:49 +0100749 for (i = 0; i < ARRAY_SIZE(rtas_flash_files); i++) {
750 const struct rtas_flash_file *f = &rtas_flash_files[i];
751 remove_proc_entry(f->filename, NULL);
752 }
John Roseae883ca2006-11-08 10:07:30 -0600753
David Howellse8eeded2013-04-13 00:48:49 +0100754 kmem_cache_destroy(flash_block_cache);
755 kfree(rtas_validate_flash_data.buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756}
757
758module_init(rtas_flash_init);
759module_exit(rtas_flash_cleanup);
760MODULE_LICENSE("GPL");