blob: a99179d835382f1c1d6a3ea408cb593ef93f4a39 [file] [log] [blame]
Thomas Gleixner2874c5f2019-05-27 08:55:01 +02001// SPDX-License-Identifier: GPL-2.0-or-later
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * c 2001 PPC 64 Team, IBM Corp
4 *
Benjamin Herrenschmidt188917e2009-09-24 19:29:13 +00005 * /proc/powerpc/rtas/firmware_flash interface
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 *
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).
10 */
11
12#include <linux/module.h>
13#include <linux/init.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090014#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <linux/proc_fs.h>
Amerigo Wangc5f41752011-07-25 17:13:10 -070016#include <linux/reboot.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <asm/delay.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080018#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <asm/rtas.h>
20
21#define MODULE_VERS "1.0"
22#define MODULE_NAME "rtas_flash"
23
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"
28
29/* General RTAS Status Codes */
30#define RTAS_RC_SUCCESS 0
31#define RTAS_RC_HW_ERR -1
32#define RTAS_RC_BUSY -2
33
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 */
41
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 */
48
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 */
Vasant Hegdef51005d2013-04-23 04:20:48 +000056
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 */
62/*
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
65 */
66#define VALIDATE_TMP_COMMIT_DL 4
67/*
68 * Current T side will be committed to P side before being replaced with new
69 * image
70 */
71#define VALIDATE_TMP_COMMIT 5
72/*
73 * T side will be updated with a downlevel image
74 */
75#define VALIDATE_TMP_UPDATE_DL 6
Vasant Hegdefd2d37c2013-04-23 04:22:22 +000076/*
77 * The candidate image's release date is later than the system's firmware
78 * service entitlement date - service warranty period has expired
79 */
80#define VALIDATE_OUT_OF_WRNTY 7
Linus Torvalds1da177e2005-04-16 15:20:36 -070081
82/* ibm,manage-flash-image operation tokens */
83#define RTAS_REJECT_TMP_IMG 0
84#define RTAS_COMMIT_TMP_IMG 1
85
86/* Array sizes */
87#define VALIDATE_BUF_SIZE 4096
Vasant Hegdea94a1472013-05-07 16:54:47 +000088#define VALIDATE_MSG_LEN 256
Linus Torvalds1da177e2005-04-16 15:20:36 -070089#define RTAS_MSG_MAXLEN 64
90
John Roseae883ca2006-11-08 10:07:30 -060091/* Quirk - RTAS requires 4k list length and block size */
92#define RTAS_BLKLIST_LENGTH 4096
93#define RTAS_BLK_SIZE 4096
94
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +110095struct flash_block {
96 char *data;
97 unsigned long length;
98};
99
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
104 * to absolute.
105 */
John Roseae883ca2006-11-08 10:07:30 -0600106#define FLASH_BLOCKS_PER_NODE ((RTAS_BLKLIST_LENGTH - 16) / sizeof(struct flash_block))
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +1100107struct flash_block_list {
108 unsigned long num_blocks;
109 struct flash_block_list *next;
110 struct flash_block blocks[FLASH_BLOCKS_PER_NODE];
111};
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +1100112
Milton Millerbd2b64a2010-06-12 03:48:47 +0000113static struct flash_block_list *rtas_firmware_flash_list;
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +1100114
John Roseae883ca2006-11-08 10:07:30 -0600115/* Use slab cache to guarantee 4k alignment */
Christoph Lametere18b8902006-12-06 20:33:20 -0800116static struct kmem_cache *flash_block_cache = NULL;
John Roseae883ca2006-11-08 10:07:30 -0600117
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +1100118#define FLASH_BLOCK_LIST_VERSION (1UL)
119
David Howellse8eeded2013-04-13 00:48:49 +0100120/*
121 * Local copy of the flash block list.
122 *
123 * The rtas_firmware_flash_list varable will be
Milton Millerbd2b64a2010-06-12 03:48:47 +0000124 * set once the data is fully read.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 *
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
Milton Millerbd2b64a2010-06-12 03:48:47 +0000129 * (i.e. not a byte count). This is all fixed when calling
130 * the flash routine.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 */
132
133/* Status int must be first member of struct */
134struct rtas_update_flash_t
135{
136 int status; /* Flash update status */
137 struct flash_block_list *flist; /* Local copy of flash block list */
138};
139
140/* Status int must be first member of struct */
141struct rtas_manage_flash_t
142{
143 int status; /* Returned status */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144};
145
146/* Status int must be first member of struct */
147struct rtas_validate_flash_t
148{
149 int status; /* Returned status */
David Howellse8eeded2013-04-13 00:48:49 +0100150 char *buf; /* Candidate image buffer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 unsigned int buf_size; /* Size of image buf */
152 unsigned int update_results; /* Update results token */
153};
154
David Howellse8eeded2013-04-13 00:48:49 +0100155static struct rtas_update_flash_t rtas_update_flash_data;
156static struct rtas_manage_flash_t rtas_manage_flash_data;
157static struct rtas_validate_flash_t rtas_validate_flash_data;
158static DEFINE_MUTEX(rtas_update_flash_mutex);
159static DEFINE_MUTEX(rtas_manage_flash_mutex);
160static DEFINE_MUTEX(rtas_validate_flash_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
162/* Do simple sanity checks on the flash image. */
163static int flash_list_valid(struct flash_block_list *flist)
164{
165 struct flash_block_list *f;
166 int i;
167 unsigned long block_size, image_size;
168
169 /* Paranoid self test here. We also collect the image size. */
170 image_size = 0;
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;
175 }
176 block_size = f->blocks[i].length;
John Roseae883ca2006-11-08 10:07:30 -0600177 if (block_size <= 0 || block_size > RTAS_BLK_SIZE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 return FLASH_IMG_BAD_LEN;
179 }
180 image_size += block_size;
181 }
182 }
183
184 if (image_size < (256 << 10)) {
185 if (image_size < 2)
186 return FLASH_NO_OP;
187 }
188
189 printk(KERN_INFO "FLASH: flash image with %ld bytes stored for hardware flash on reboot\n", image_size);
190
191 return FLASH_IMG_READY;
192}
193
194static void free_flash_list(struct flash_block_list *f)
195{
196 struct flash_block_list *next;
197 int i;
198
199 while (f) {
200 for (i = 0; i < f->num_blocks; i++)
John Roseae883ca2006-11-08 10:07:30 -0600201 kmem_cache_free(flash_block_cache, f->blocks[i].data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 next = f->next;
John Roseae883ca2006-11-08 10:07:30 -0600203 kmem_cache_free(flash_block_cache, f);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204 f = next;
205 }
206}
207
208static int rtas_flash_release(struct inode *inode, struct file *file)
209{
David Howellse8eeded2013-04-13 00:48:49 +0100210 struct rtas_update_flash_t *const uf = &rtas_update_flash_data;
211
212 mutex_lock(&rtas_update_flash_mutex);
213
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 if (uf->flist) {
215 /* File was opened in write mode for a new flash attempt */
216 /* Clear saved list */
Milton Millerbd2b64a2010-06-12 03:48:47 +0000217 if (rtas_firmware_flash_list) {
218 free_flash_list(rtas_firmware_flash_list);
219 rtas_firmware_flash_list = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 }
221
222 if (uf->status != FLASH_AUTH)
223 uf->status = flash_list_valid(uf->flist);
224
225 if (uf->status == FLASH_IMG_READY)
Milton Millerbd2b64a2010-06-12 03:48:47 +0000226 rtas_firmware_flash_list = uf->flist;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 else
228 free_flash_list(uf->flist);
229
230 uf->flist = NULL;
231 }
232
David Howellse8eeded2013-04-13 00:48:49 +0100233 mutex_unlock(&rtas_update_flash_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 return 0;
235}
236
David Howellse8eeded2013-04-13 00:48:49 +0100237static size_t get_flash_status_msg(int status, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238{
David Howellse8eeded2013-04-13 00:48:49 +0100239 const char *msg;
240 size_t len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241
242 switch (status) {
243 case FLASH_AUTH:
244 msg = "error: this partition does not have service authority\n";
245 break;
246 case FLASH_NO_OP:
247 msg = "info: no firmware image for flash\n";
248 break;
249 case FLASH_IMG_SHORT:
250 msg = "error: flash image short\n";
251 break;
252 case FLASH_IMG_BAD_LEN:
253 msg = "error: internal error bad length\n";
254 break;
255 case FLASH_IMG_NULL_DATA:
256 msg = "error: internal error null data\n";
257 break;
258 case FLASH_IMG_READY:
259 msg = "ready: firmware image ready for flash on reboot\n";
260 break;
261 default:
David Howellse8eeded2013-04-13 00:48:49 +0100262 return sprintf(buf, "error: unexpected status value %d\n",
263 status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 }
265
David Howellse8eeded2013-04-13 00:48:49 +0100266 len = strlen(msg);
267 memcpy(buf, msg, len + 1);
268 return len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269}
270
271/* Reading the proc file will show status (not the firmware contents) */
David Howellse8eeded2013-04-13 00:48:49 +0100272static ssize_t rtas_flash_read_msg(struct file *file, char __user *buf,
273 size_t count, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274{
David Howellse8eeded2013-04-13 00:48:49 +0100275 struct rtas_update_flash_t *const uf = &rtas_update_flash_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 char msg[RTAS_MSG_MAXLEN];
David Howellse8eeded2013-04-13 00:48:49 +0100277 size_t len;
278 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279
David Howellse8eeded2013-04-13 00:48:49 +0100280 mutex_lock(&rtas_update_flash_mutex);
281 status = uf->status;
282 mutex_unlock(&rtas_update_flash_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283
David Howellse8eeded2013-04-13 00:48:49 +0100284 /* Read as text message */
285 len = get_flash_status_msg(status, msg);
286 return simple_read_from_buffer(buf, count, ppos, msg, len);
287}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288
David Howellse8eeded2013-04-13 00:48:49 +0100289static ssize_t rtas_flash_read_num(struct file *file, char __user *buf,
290 size_t count, loff_t *ppos)
291{
292 struct rtas_update_flash_t *const uf = &rtas_update_flash_data;
293 char msg[RTAS_MSG_MAXLEN];
294 int status;
295
296 mutex_lock(&rtas_update_flash_mutex);
297 status = uf->status;
298 mutex_unlock(&rtas_update_flash_mutex);
299
300 /* Read as number */
301 sprintf(msg, "%d\n", status);
Akinobu Mita4c4a5cf2010-12-24 20:03:59 +0000302 return simple_read_from_buffer(buf, count, ppos, msg, strlen(msg));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303}
304
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
308 * that we fail....
309 */
Al Viroefa54572005-04-26 11:26:53 -0700310static ssize_t rtas_flash_write(struct file *file, const char __user *buffer,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311 size_t count, loff_t *off)
312{
David Howellse8eeded2013-04-13 00:48:49 +0100313 struct rtas_update_flash_t *const uf = &rtas_update_flash_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 char *p;
David Howellse8eeded2013-04-13 00:48:49 +0100315 int next_free, rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316 struct flash_block_list *fl;
317
David Howellse8eeded2013-04-13 00:48:49 +0100318 mutex_lock(&rtas_update_flash_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319
320 if (uf->status == FLASH_AUTH || count == 0)
David Howellse8eeded2013-04-13 00:48:49 +0100321 goto out; /* discard data */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322
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
325 * proc file
326 */
327 if (uf->flist == NULL) {
Vasant Hegdefb4696c2013-04-28 18:43:56 +0000328 uf->flist = kmem_cache_zalloc(flash_block_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 if (!uf->flist)
David Howellse8eeded2013-04-13 00:48:49 +0100330 goto nomem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 }
332
333 fl = uf->flist;
334 while (fl->next)
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 */
Vasant Hegdefb4696c2013-04-28 18:43:56 +0000339 fl->next = kmem_cache_zalloc(flash_block_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340 if (!fl->next)
David Howellse8eeded2013-04-13 00:48:49 +0100341 goto nomem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 fl = fl->next;
343 next_free = 0;
344 }
345
John Roseae883ca2006-11-08 10:07:30 -0600346 if (count > RTAS_BLK_SIZE)
347 count = RTAS_BLK_SIZE;
Vasant Hegdefb4696c2013-04-28 18:43:56 +0000348 p = kmem_cache_zalloc(flash_block_cache, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349 if (!p)
David Howellse8eeded2013-04-13 00:48:49 +0100350 goto nomem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351
352 if(copy_from_user(p, buffer, count)) {
John Roseae883ca2006-11-08 10:07:30 -0600353 kmem_cache_free(flash_block_cache, p);
David Howellse8eeded2013-04-13 00:48:49 +0100354 rc = -EFAULT;
355 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356 }
357 fl->blocks[next_free].data = p;
358 fl->blocks[next_free].length = count;
359 fl->num_blocks++;
David Howellse8eeded2013-04-13 00:48:49 +0100360out:
361 mutex_unlock(&rtas_update_flash_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 return count;
David Howellse8eeded2013-04-13 00:48:49 +0100363
364nomem:
365 rc = -ENOMEM;
366error:
367 mutex_unlock(&rtas_update_flash_mutex);
368 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369}
370
David Howellse8eeded2013-04-13 00:48:49 +0100371/*
372 * Flash management routines.
373 */
374static void manage_flash(struct rtas_manage_flash_t *args_buf, unsigned int op)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 s32 rc;
377
John Rose507279d2006-06-05 16:31:48 -0500378 do {
David Howellse8eeded2013-04-13 00:48:49 +0100379 rc = rtas_call(rtas_token("ibm,manage-flash-image"), 1, 1,
380 NULL, op);
John Rose507279d2006-06-05 16:31:48 -0500381 } while (rtas_busy_delay(rc));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382
383 args_buf->status = rc;
384}
385
Al Viroefa54572005-04-26 11:26:53 -0700386static ssize_t manage_flash_read(struct file *file, char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 size_t count, loff_t *ppos)
388{
David Howellse8eeded2013-04-13 00:48:49 +0100389 struct rtas_manage_flash_t *const args_buf = &rtas_manage_flash_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 char msg[RTAS_MSG_MAXLEN];
David Howellse8eeded2013-04-13 00:48:49 +0100391 int msglen, status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392
David Howellse8eeded2013-04-13 00:48:49 +0100393 mutex_lock(&rtas_manage_flash_mutex);
394 status = args_buf->status;
395 mutex_unlock(&rtas_manage_flash_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396
David Howellse8eeded2013-04-13 00:48:49 +0100397 msglen = sprintf(msg, "%d\n", status);
Akinobu Mita4c4a5cf2010-12-24 20:03:59 +0000398 return simple_read_from_buffer(buf, count, ppos, msg, msglen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399}
400
Al Viroefa54572005-04-26 11:26:53 -0700401static ssize_t manage_flash_write(struct file *file, const char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 size_t count, loff_t *off)
403{
David Howellse8eeded2013-04-13 00:48:49 +0100404 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";
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 char stkbuf[10];
David Howellse8eeded2013-04-13 00:48:49 +0100408 int op, rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409
David Howellse8eeded2013-04-13 00:48:49 +0100410 mutex_lock(&rtas_manage_flash_mutex);
411
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 if ((args_buf->status == MANAGE_AUTH) || (count == 0))
David Howellse8eeded2013-04-13 00:48:49 +0100413 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414
415 op = -1;
416 if (buf) {
417 if (count > 9) count = 9;
David Howellse8eeded2013-04-13 00:48:49 +0100418 rc = -EFAULT;
419 if (copy_from_user (stkbuf, buf, count))
420 goto error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 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;
425 }
426
David Howellse8eeded2013-04-13 00:48:49 +0100427 if (op == -1) { /* buf is empty, or contains invalid string */
428 rc = -EINVAL;
429 goto error;
430 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431
David Howellse8eeded2013-04-13 00:48:49 +0100432 manage_flash(args_buf, op);
433out:
434 mutex_unlock(&rtas_manage_flash_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 return count;
David Howellse8eeded2013-04-13 00:48:49 +0100436
437error:
438 mutex_unlock(&rtas_manage_flash_mutex);
439 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440}
441
David Howellse8eeded2013-04-13 00:48:49 +0100442/*
443 * Validation routines.
444 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445static void validate_flash(struct rtas_validate_flash_t *args_buf)
446{
447 int token = rtas_token("ibm,validate-flash-image");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 int update_results;
449 s32 rc;
450
451 rc = 0;
John Rose507279d2006-06-05 16:31:48 -0500452 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 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);
John Rose507279d2006-06-05 16:31:48 -0500459 } while (rtas_busy_delay(rc));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460
461 args_buf->status = rc;
462 args_buf->update_results = update_results;
463}
464
465static int get_validate_flash_msg(struct rtas_validate_flash_t *args_buf,
Vasant Hegdea94a1472013-05-07 16:54:47 +0000466 char *msg, int msglen)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467{
468 int n;
469
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))
Vasant Hegdea94a1472013-05-07 16:54:47 +0000474 n += snprintf(msg + n, msglen - n, "%s\n",
475 args_buf->buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 } else {
477 n = sprintf(msg, "%d\n", args_buf->status);
478 }
479 return n;
480}
481
Al Viroefa54572005-04-26 11:26:53 -0700482static ssize_t validate_flash_read(struct file *file, char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483 size_t count, loff_t *ppos)
484{
David Howellse8eeded2013-04-13 00:48:49 +0100485 struct rtas_validate_flash_t *const args_buf =
486 &rtas_validate_flash_data;
Vasant Hegdea94a1472013-05-07 16:54:47 +0000487 char msg[VALIDATE_MSG_LEN];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 int msglen;
489
David Howellse8eeded2013-04-13 00:48:49 +0100490 mutex_lock(&rtas_validate_flash_mutex);
Vasant Hegdea94a1472013-05-07 16:54:47 +0000491 msglen = get_validate_flash_msg(args_buf, msg, VALIDATE_MSG_LEN);
David Howellse8eeded2013-04-13 00:48:49 +0100492 mutex_unlock(&rtas_validate_flash_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493
Akinobu Mita4c4a5cf2010-12-24 20:03:59 +0000494 return simple_read_from_buffer(buf, count, ppos, msg, msglen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495}
496
Al Viroefa54572005-04-26 11:26:53 -0700497static ssize_t validate_flash_write(struct file *file, const char __user *buf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498 size_t count, loff_t *off)
499{
David Howellse8eeded2013-04-13 00:48:49 +0100500 struct rtas_validate_flash_t *const args_buf =
501 &rtas_validate_flash_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 int rc;
503
David Howellse8eeded2013-04-13 00:48:49 +0100504 mutex_lock(&rtas_validate_flash_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505
506 /* We are only interested in the first 4K of the
507 * candidate image */
508 if ((*off >= VALIDATE_BUF_SIZE) ||
509 (args_buf->status == VALIDATE_AUTH)) {
510 *off += count;
David Howellse8eeded2013-04-13 00:48:49 +0100511 mutex_unlock(&rtas_validate_flash_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 return count;
513 }
514
515 if (*off + count >= VALIDATE_BUF_SIZE) {
516 count = VALIDATE_BUF_SIZE - *off;
517 args_buf->status = VALIDATE_READY;
518 } else {
519 args_buf->status = VALIDATE_INCOMPLETE;
520 }
521
Linus Torvalds96d4f262019-01-03 18:57:57 -0800522 if (!access_ok(buf, count)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 rc = -EFAULT;
524 goto done;
525 }
526 if (copy_from_user(args_buf->buf + *off, buf, count)) {
527 rc = -EFAULT;
528 goto done;
529 }
530
531 *off += count;
532 rc = count;
533done:
David Howellse8eeded2013-04-13 00:48:49 +0100534 mutex_unlock(&rtas_validate_flash_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535 return rc;
536}
537
538static int validate_flash_release(struct inode *inode, struct file *file)
539{
David Howellse8eeded2013-04-13 00:48:49 +0100540 struct rtas_validate_flash_t *const args_buf =
541 &rtas_validate_flash_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542
David Howellse8eeded2013-04-13 00:48:49 +0100543 mutex_lock(&rtas_validate_flash_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544
545 if (args_buf->status == VALIDATE_READY) {
546 args_buf->buf_size = VALIDATE_BUF_SIZE;
547 validate_flash(args_buf);
548 }
549
David Howellse8eeded2013-04-13 00:48:49 +0100550 mutex_unlock(&rtas_validate_flash_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 return 0;
552}
553
David Howellse8eeded2013-04-13 00:48:49 +0100554/*
555 * On-reboot flash update applicator.
556 */
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +1100557static void rtas_flash_firmware(int reboot_type)
558{
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;
563
Milton Millerbd2b64a2010-06-12 03:48:47 +0000564 if (rtas_firmware_flash_list == NULL)
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +1100565 return; /* nothing to do */
566
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");
570 return;
571 }
572
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");
578 return;
579 }
580
Milton Millerbd2b64a2010-06-12 03:48:47 +0000581 /*
Ravi K. Nittaladf17f562011-10-03 21:49:53 +0000582 * Just before starting the firmware flash, cancel the event scan work
583 * to avoid any soft lockup issues.
584 */
585 rtas_cancel_event_scan();
586
587 /*
Milton Millerbd2b64a2010-06-12 03:48:47 +0000588 * 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.
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +1100591 */
Milton Millerbd2b64a2010-06-12 03:48:47 +0000592 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;
Michael Ellerman3d267522012-07-25 21:19:56 +0000596 rtas_block_list = __pa(flist);
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +1100597 if (rtas_block_list >= 4UL*1024*1024*1024) {
598 printk(KERN_ALERT "FLASH: kernel bug...flash list header addr above 4GB\n");
Milton Millerbd2b64a2010-06-12 03:48:47 +0000599 spin_unlock(&rtas_data_buf_lock);
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +1100600 return;
601 }
602
603 printk(KERN_ALERT "FLASH: preparing saved firmware image for flash\n");
604 /* Update the block_list in place. */
Milton Millerbd2b64a2010-06-12 03:48:47 +0000605 rtas_firmware_flash_list = NULL; /* too hard to backout on error */
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +1100606 image_size = 0;
607 for (f = flist; f; f = next) {
608 /* Translate data addrs to absolute */
609 for (i = 0; i < f->num_blocks; i++) {
Thomas Falcon396a3432014-07-25 12:47:42 -0500610 f->blocks[i].data = (char *)cpu_to_be64(__pa(f->blocks[i].data));
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +1100611 image_size += f->blocks[i].length;
Thomas Falcon396a3432014-07-25 12:47:42 -0500612 f->blocks[i].length = cpu_to_be64(f->blocks[i].length);
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +1100613 }
614 next = f->next;
615 /* Don't translate NULL pointer for last entry */
616 if (f->next)
Thomas Falcon396a3432014-07-25 12:47:42 -0500617 f->next = (struct flash_block_list *)cpu_to_be64(__pa(f->next));
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +1100618 else
619 f->next = NULL;
620 /* make num_blocks into the version/length field */
621 f->num_blocks = (FLASH_BLOCK_LIST_VERSION << 56) | ((f->num_blocks+1)*16);
Thomas Falcon396a3432014-07-25 12:47:42 -0500622 f->num_blocks = cpu_to_be64(f->num_blocks);
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +1100623 }
624
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 */
632 case 0:
633 printk(KERN_ALERT "FLASH: success\n");
634 break;
635 case -1:
636 printk(KERN_ALERT "FLASH: hardware error. Firmware may not be not flashed\n");
637 break;
638 case -3:
639 printk(KERN_ALERT "FLASH: image is corrupt or not correct for this platform. Firmware not flashed\n");
640 break;
641 case -4:
642 printk(KERN_ALERT "FLASH: flash failed when partially complete. System may not reboot\n");
643 break;
644 default:
645 printk(KERN_ALERT "FLASH: unknown flash return code %d\n", status);
646 break;
647 }
Milton Millerbd2b64a2010-06-12 03:48:47 +0000648 spin_unlock(&rtas_data_buf_lock);
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +1100649}
650
David Howellse8eeded2013-04-13 00:48:49 +0100651/*
652 * Manifest of proc files to create
653 */
654struct rtas_flash_file {
655 const char *filename;
656 const char *rtas_call_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 int *status;
Alexey Dobriyan97a32532020-02-03 17:37:17 -0800658 const struct proc_ops ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659};
660
David Howellse8eeded2013-04-13 00:48:49 +0100661static const struct rtas_flash_file rtas_flash_files[] = {
662 {
663 .filename = "powerpc/rtas/" FIRMWARE_FLASH_NAME,
664 .rtas_call_name = "ibm,update-flash-64-and-reboot",
665 .status = &rtas_update_flash_data.status,
Alexey Dobriyan97a32532020-02-03 17:37:17 -0800666 .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,
David Howellse8eeded2013-04-13 00:48:49 +0100670 },
671 {
672 .filename = "powerpc/rtas/" FIRMWARE_UPDATE_NAME,
673 .rtas_call_name = "ibm,update-flash-64-and-reboot",
674 .status = &rtas_update_flash_data.status,
Alexey Dobriyan97a32532020-02-03 17:37:17 -0800675 .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,
David Howellse8eeded2013-04-13 00:48:49 +0100679 },
680 {
681 .filename = "powerpc/rtas/" VALIDATE_FLASH_NAME,
682 .rtas_call_name = "ibm,validate-flash-image",
683 .status = &rtas_validate_flash_data.status,
Alexey Dobriyan97a32532020-02-03 17:37:17 -0800684 .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,
David Howellse8eeded2013-04-13 00:48:49 +0100688 },
689 {
690 .filename = "powerpc/rtas/" MANAGE_FLASH_NAME,
691 .rtas_call_name = "ibm,manage-flash-image",
692 .status = &rtas_manage_flash_data.status,
Alexey Dobriyan97a32532020-02-03 17:37:17 -0800693 .ops.proc_read = manage_flash_read,
694 .ops.proc_write = manage_flash_write,
695 .ops.proc_lseek = default_llseek,
David Howellse8eeded2013-04-13 00:48:49 +0100696 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697};
698
Michael Ellerman1c21a292008-05-08 14:27:19 +1000699static int __init rtas_flash_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700{
David Howellse8eeded2013-04-13 00:48:49 +0100701 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702
703 if (rtas_token("ibm,update-flash-64-and-reboot") ==
704 RTAS_UNKNOWN_SERVICE) {
Anton Blanchard0e384982012-07-22 20:42:32 +0000705 pr_info("rtas_flash: no firmware flash support\n");
Anton Blanchard0c930692014-04-14 21:23:32 +1000706 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707 }
708
David Howellse8eeded2013-04-13 00:48:49 +0100709 rtas_validate_flash_data.buf = kzalloc(VALIDATE_BUF_SIZE, GFP_KERNEL);
710 if (!rtas_validate_flash_data.buf)
711 return -ENOMEM;
John Roseae883ca2006-11-08 10:07:30 -0600712
713 flash_block_cache = kmem_cache_create("rtas_flash_cache",
David Howellse8eeded2013-04-13 00:48:49 +0100714 RTAS_BLK_SIZE, RTAS_BLK_SIZE, 0,
Linus Torvalds5a148af2013-05-02 10:16:16 -0700715 NULL);
John Roseae883ca2006-11-08 10:07:30 -0600716 if (!flash_block_cache) {
717 printk(KERN_ERR "%s: failed to create block cache\n",
Harvey Harrisone48b1b42008-03-29 08:21:07 +1100718 __func__);
David Howellse8eeded2013-04-13 00:48:49 +0100719 goto enomem_buf;
John Roseae883ca2006-11-08 10:07:30 -0600720 }
David Howellse8eeded2013-04-13 00:48:49 +0100721
722 for (i = 0; i < ARRAY_SIZE(rtas_flash_files); i++) {
723 const struct rtas_flash_file *f = &rtas_flash_files[i];
724 int token;
725
Alexey Dobriyan97a32532020-02-03 17:37:17 -0800726 if (!proc_create(f->filename, 0600, NULL, &f->ops))
David Howellse8eeded2013-04-13 00:48:49 +0100727 goto enomem;
728
729 /*
730 * This code assumes that the status int is the first member of the
731 * struct
732 */
733 token = rtas_token(f->rtas_call_name);
734 if (token == RTAS_UNKNOWN_SERVICE)
735 *f->status = FLASH_AUTH;
736 else
737 *f->status = FLASH_NO_OP;
738 }
739
740 rtas_flash_term_hook = rtas_flash_firmware;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 return 0;
742
David Howellse8eeded2013-04-13 00:48:49 +0100743enomem:
744 while (--i >= 0) {
745 const struct rtas_flash_file *f = &rtas_flash_files[i];
746 remove_proc_entry(f->filename, NULL);
747 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748
David Howellse8eeded2013-04-13 00:48:49 +0100749 kmem_cache_destroy(flash_block_cache);
750enomem_buf:
751 kfree(rtas_validate_flash_data.buf);
752 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753}
754
Michael Ellerman1c21a292008-05-08 14:27:19 +1000755static void __exit rtas_flash_cleanup(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756{
David Howellse8eeded2013-04-13 00:48:49 +0100757 int i;
758
Paul Mackerrasf4fcbbe2005-11-03 14:41:19 +1100759 rtas_flash_term_hook = NULL;
John Roseae883ca2006-11-08 10:07:30 -0600760
Vasant Hegdead18a362013-02-08 01:18:36 +0000761 if (rtas_firmware_flash_list) {
762 free_flash_list(rtas_firmware_flash_list);
763 rtas_firmware_flash_list = NULL;
764 }
765
David Howellse8eeded2013-04-13 00:48:49 +0100766 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);
769 }
John Roseae883ca2006-11-08 10:07:30 -0600770
David Howellse8eeded2013-04-13 00:48:49 +0100771 kmem_cache_destroy(flash_block_cache);
772 kfree(rtas_validate_flash_data.buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773}
774
775module_init(rtas_flash_init);
776module_exit(rtas_flash_cleanup);
777MODULE_LICENSE("GPL");