2 * PS3 flash memory os area.
4 * Copyright (C) 2006 Sony Computer Entertainment Inc.
5 * Copyright 2006 Sony Corp.
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; version 2 of the License.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 #include <linux/kernel.h>
23 #include <linux/workqueue.h>
25 #include <linux/syscalls.h>
26 #include <linux/ctype.h>
33 OS_AREA_SEGMENT_SIZE = 0X200,
36 enum os_area_ldr_format {
37 HEADER_LDR_FORMAT_RAW = 0,
38 HEADER_LDR_FORMAT_GZIP = 1,
41 #define OS_AREA_HEADER_MAGIC_NUM "cell_ext_os_area"
44 * struct os_area_header - os area header segment.
45 * @magic_num: Always 'cell_ext_os_area'.
46 * @hdr_version: Header format version number.
47 * @db_area_offset: Starting segment number of other os database area.
48 * @ldr_area_offset: Starting segment number of bootloader image area.
49 * @ldr_format: HEADER_LDR_FORMAT flag.
50 * @ldr_size: Size of bootloader image in bytes.
52 * Note that the docs refer to area offsets. These are offsets in units of
53 * segments from the start of the os area (top of the header). These are
54 * better thought of as segment numbers. The os area of the os area is
55 * reserved for the os image.
58 struct os_area_header {
69 enum os_area_boot_flag {
70 PARAM_BOOT_FLAG_GAME_OS = 0,
71 PARAM_BOOT_FLAG_OTHER_OS = 1,
74 enum os_area_ctrl_button {
75 PARAM_CTRL_BUTTON_O_IS_YES = 0,
76 PARAM_CTRL_BUTTON_X_IS_YES = 1,
80 * struct os_area_params - os area params segment.
81 * @boot_flag: User preference of operating system, PARAM_BOOT_FLAG flag.
82 * @num_params: Number of params in this (params) segment.
83 * @rtc_diff: Difference in seconds between 1970 and the ps3 rtc value.
84 * @av_multi_out: User preference of AV output, PARAM_AV_MULTI_OUT flag.
85 * @ctrl_button: User preference of controller button config, PARAM_CTRL_BUTTON
87 * @static_ip_addr: User preference of static IP address.
88 * @network_mask: User preference of static network mask.
89 * @default_gateway: User preference of static default gateway.
90 * @dns_primary: User preference of static primary dns server.
91 * @dns_secondary: User preference of static secondary dns server.
93 * The ps3 rtc maintains a read-only value that approximates seconds since
94 * 2000-01-01 00:00:00 UTC.
96 * User preference of zero for static_ip_addr means use dhcp.
99 struct os_area_params {
110 u8 static_ip_addr[4];
112 u8 default_gateway[4];
120 #define OS_AREA_DB_MAGIC_NUM "-db-"
123 * struct os_area_db - Shared flash memory database.
124 * @magic_num: Always '-db-'.
125 * @version: os_area_db format version number.
126 * @index_64: byte offset of the database id index for 64 bit variables.
127 * @count_64: number of usable 64 bit index entries
128 * @index_32: byte offset of the database id index for 32 bit variables.
129 * @count_32: number of usable 32 bit index entries
130 * @index_16: byte offset of the database id index for 16 bit variables.
131 * @count_16: number of usable 16 bit index entries
133 * Flash rom storage for exclusive use by guests running in the other os lpar.
134 * The current system configuration allocates 1K (two segments) for other os
153 * enum os_area_db_owner - Data owners.
156 enum os_area_db_owner {
157 OS_AREA_DB_OWNER_ANY = -1,
158 OS_AREA_DB_OWNER_NONE = 0,
159 OS_AREA_DB_OWNER_PROTOTYPE = 1,
160 OS_AREA_DB_OWNER_LINUX = 2,
161 OS_AREA_DB_OWNER_PETITBOOT = 3,
162 OS_AREA_DB_OWNER_MAX = 32,
165 enum os_area_db_key {
166 OS_AREA_DB_KEY_ANY = -1,
167 OS_AREA_DB_KEY_NONE = 0,
168 OS_AREA_DB_KEY_RTC_DIFF = 1,
169 OS_AREA_DB_KEY_VIDEO_MODE = 2,
170 OS_AREA_DB_KEY_MAX = 8,
173 struct os_area_db_id {
178 static const struct os_area_db_id os_area_db_id_empty = {
179 .owner = OS_AREA_DB_OWNER_NONE,
180 .key = OS_AREA_DB_KEY_NONE
183 static const struct os_area_db_id os_area_db_id_any = {
184 .owner = OS_AREA_DB_OWNER_ANY,
185 .key = OS_AREA_DB_KEY_ANY
188 static const struct os_area_db_id os_area_db_id_rtc_diff = {
189 .owner = OS_AREA_DB_OWNER_LINUX,
190 .key = OS_AREA_DB_KEY_RTC_DIFF
193 static const struct os_area_db_id os_area_db_id_video_mode = {
194 .owner = OS_AREA_DB_OWNER_LINUX,
195 .key = OS_AREA_DB_KEY_VIDEO_MODE
198 #define SECONDS_FROM_1970_TO_2000 946684800LL
201 * struct saved_params - Static working copies of data from the PS3 'os area'.
203 * The order of preference we use for the rtc_diff source:
204 * 1) The database value.
205 * 2) The game os value.
206 * 3) The number of seconds from 1970 to 2000.
209 struct saved_params {
212 unsigned int av_multi_out;
213 } static saved_params;
215 static struct property property_rtc_diff = {
216 .name = "linux,rtc_diff",
217 .length = sizeof(saved_params.rtc_diff),
218 .value = &saved_params.rtc_diff,
221 static struct property property_av_multi_out = {
222 .name = "linux,av_multi_out",
223 .length = sizeof(saved_params.av_multi_out),
224 .value = &saved_params.av_multi_out,
228 * os_area_set_property - Add or overwrite a saved_params value to the device tree.
230 * Overwrites an existing property.
233 static void os_area_set_property(struct device_node *node,
234 struct property *prop)
237 struct property *tmp = of_find_property(node, prop->name, NULL);
240 pr_debug("%s:%d found %s\n", __func__, __LINE__, prop->name);
241 prom_remove_property(node, tmp);
244 result = prom_add_property(node, prop);
247 pr_debug("%s:%d prom_set_property failed\n", __func__,
252 * os_area_get_property - Get a saved_params value from the device tree.
256 static void __init os_area_get_property(struct device_node *node,
257 struct property *prop)
259 const struct property *tmp = of_find_property(node, prop->name, NULL);
262 BUG_ON(prop->length != tmp->length);
263 memcpy(prop->value, tmp->value, prop->length);
265 pr_debug("%s:%d not found %s\n", __func__, __LINE__,
269 static void dump_field(char *s, const u8 *field, int size_of_field)
274 for (i = 0; i < size_of_field; i++)
275 s[i] = isprint(field[i]) ? field[i] : '.';
280 #define dump_header(_a) _dump_header(_a, __func__, __LINE__)
281 static void _dump_header(const struct os_area_header *h, const char *func,
284 char str[sizeof(h->magic_num) + 1];
286 dump_field(str, h->magic_num, sizeof(h->magic_num));
287 pr_debug("%s:%d: h.magic_num: '%s'\n", func, line,
289 pr_debug("%s:%d: h.hdr_version: %u\n", func, line,
291 pr_debug("%s:%d: h.db_area_offset: %u\n", func, line,
293 pr_debug("%s:%d: h.ldr_area_offset: %u\n", func, line,
295 pr_debug("%s:%d: h.ldr_format: %u\n", func, line,
297 pr_debug("%s:%d: h.ldr_size: %xh\n", func, line,
301 #define dump_params(_a) _dump_params(_a, __func__, __LINE__)
302 static void _dump_params(const struct os_area_params *p, const char *func,
305 pr_debug("%s:%d: p.boot_flag: %u\n", func, line, p->boot_flag);
306 pr_debug("%s:%d: p.num_params: %u\n", func, line, p->num_params);
307 pr_debug("%s:%d: p.rtc_diff %ld\n", func, line, p->rtc_diff);
308 pr_debug("%s:%d: p.av_multi_out %u\n", func, line, p->av_multi_out);
309 pr_debug("%s:%d: p.ctrl_button: %u\n", func, line, p->ctrl_button);
310 pr_debug("%s:%d: p.static_ip_addr: %u.%u.%u.%u\n", func, line,
311 p->static_ip_addr[0], p->static_ip_addr[1],
312 p->static_ip_addr[2], p->static_ip_addr[3]);
313 pr_debug("%s:%d: p.network_mask: %u.%u.%u.%u\n", func, line,
314 p->network_mask[0], p->network_mask[1],
315 p->network_mask[2], p->network_mask[3]);
316 pr_debug("%s:%d: p.default_gateway: %u.%u.%u.%u\n", func, line,
317 p->default_gateway[0], p->default_gateway[1],
318 p->default_gateway[2], p->default_gateway[3]);
319 pr_debug("%s:%d: p.dns_primary: %u.%u.%u.%u\n", func, line,
320 p->dns_primary[0], p->dns_primary[1],
321 p->dns_primary[2], p->dns_primary[3]);
322 pr_debug("%s:%d: p.dns_secondary: %u.%u.%u.%u\n", func, line,
323 p->dns_secondary[0], p->dns_secondary[1],
324 p->dns_secondary[2], p->dns_secondary[3]);
327 static int verify_header(const struct os_area_header *header)
329 if (memcmp(header->magic_num, OS_AREA_HEADER_MAGIC_NUM,
330 sizeof(header->magic_num))) {
331 pr_debug("%s:%d magic_num failed\n", __func__, __LINE__);
335 if (header->hdr_version < 1) {
336 pr_debug("%s:%d hdr_version failed\n", __func__, __LINE__);
340 if (header->db_area_offset > header->ldr_area_offset) {
341 pr_debug("%s:%d offsets failed\n", __func__, __LINE__);
348 static int db_verify(const struct os_area_db *db)
350 if (memcmp(db->magic_num, OS_AREA_DB_MAGIC_NUM,
351 sizeof(db->magic_num))) {
352 pr_debug("%s:%d magic_num failed\n", __func__, __LINE__);
356 if (db->version != 1) {
357 pr_debug("%s:%d version failed\n", __func__, __LINE__);
370 const struct os_area_db *db;
371 struct os_area_db_id match_id;
372 struct db_index *idx;
373 struct db_index *last_idx;
381 static unsigned int db_align_up(unsigned int val, unsigned int size)
383 return (val + (size - 1)) & (~(size - 1));
387 * db_for_each_64 - Iterator for 64 bit entries.
389 * A NULL value for id can be used to match all entries.
390 * OS_AREA_DB_OWNER_ANY and OS_AREA_DB_KEY_ANY can be used to match all.
393 static int db_for_each_64(const struct os_area_db *db,
394 const struct os_area_db_id *match_id, struct db_iterator *i)
399 i->match_id = match_id ? *match_id : os_area_db_id_any;
400 i->idx = (void *)db + db->index_64;
401 i->last_idx = i->idx + db->count_64;
402 i->value_64 = (void *)db + db->index_64
403 + db_align_up(db->count_64, 8);
409 if (i->idx >= i->last_idx) {
410 pr_debug("%s:%d: reached end\n", __func__, __LINE__);
414 if (i->match_id.owner != OS_AREA_DB_OWNER_ANY
415 && i->match_id.owner != (int)i->idx->owner)
417 if (i->match_id.key != OS_AREA_DB_KEY_ANY
418 && i->match_id.key != (int)i->idx->key)
424 static int db_delete_64(struct os_area_db *db, const struct os_area_db_id *id)
426 struct db_iterator i;
428 for (i.db = NULL; db_for_each_64(db, id, &i); ) {
430 pr_debug("%s:%d: got (%d:%d) %llxh\n", __func__, __LINE__,
431 i.idx->owner, i.idx->key,
432 (unsigned long long)*i.value_64);
441 static int db_set_64(struct os_area_db *db, const struct os_area_db_id *id,
444 struct db_iterator i;
446 pr_debug("%s:%d: (%d:%d) <= %llxh\n", __func__, __LINE__,
447 id->owner, id->key, (unsigned long long)value);
449 if (!id->owner || id->owner == OS_AREA_DB_OWNER_ANY
450 || id->key == OS_AREA_DB_KEY_ANY) {
451 pr_debug("%s:%d: bad id: (%d:%d)\n", __func__,
452 __LINE__, id->owner, id->key);
456 db_delete_64(db, id);
459 if (db_for_each_64(db, &os_area_db_id_empty, &i)) {
461 pr_debug("%s:%d: got (%d:%d) %llxh\n", __func__, __LINE__,
462 i.idx->owner, i.idx->key,
463 (unsigned long long)*i.value_64);
465 i.idx->owner = id->owner;
466 i.idx->key = id->key;
469 pr_debug("%s:%d: set (%d:%d) <= %llxh\n", __func__, __LINE__,
470 i.idx->owner, i.idx->key,
471 (unsigned long long)*i.value_64);
474 pr_debug("%s:%d: database full.\n",
479 static int db_get_64(const struct os_area_db *db,
480 const struct os_area_db_id *id, uint64_t *value)
482 struct db_iterator i;
485 if (db_for_each_64(db, id, &i)) {
486 *value = *i.value_64;
487 pr_debug("%s:%d: found %lld\n", __func__, __LINE__,
488 (long long int)*i.value_64);
491 pr_debug("%s:%d: not found\n", __func__, __LINE__);
495 static int db_get_rtc_diff(const struct os_area_db *db, int64_t *rtc_diff)
497 return db_get_64(db, &os_area_db_id_rtc_diff, (uint64_t*)rtc_diff);
500 #define dump_db(a) _dump_db(a, __func__, __LINE__)
501 static void _dump_db(const struct os_area_db *db, const char *func,
504 char str[sizeof(db->magic_num) + 1];
506 dump_field(str, db->magic_num, sizeof(db->magic_num));
507 pr_debug("%s:%d: db.magic_num: '%s'\n", func, line,
509 pr_debug("%s:%d: db.version: %u\n", func, line,
511 pr_debug("%s:%d: db.index_64: %u\n", func, line,
513 pr_debug("%s:%d: db.count_64: %u\n", func, line,
515 pr_debug("%s:%d: db.index_32: %u\n", func, line,
517 pr_debug("%s:%d: db.count_32: %u\n", func, line,
519 pr_debug("%s:%d: db.index_16: %u\n", func, line,
521 pr_debug("%s:%d: db.count_16: %u\n", func, line,
525 static void os_area_db_init(struct os_area_db *db)
528 HEADER_SIZE = offsetof(struct os_area_db, _db_data),
530 VALUES_64_COUNT = 57,
532 VALUES_32_COUNT = 57,
534 VALUES_16_COUNT = 57,
537 memset(db, 0, sizeof(struct os_area_db));
539 memcpy(db->magic_num, OS_AREA_DB_MAGIC_NUM, sizeof(db->magic_num));
541 db->index_64 = HEADER_SIZE;
542 db->count_64 = VALUES_64_COUNT;
543 db->index_32 = HEADER_SIZE
544 + INDEX_64_COUNT * sizeof(struct db_index)
545 + VALUES_64_COUNT * sizeof(u64);
546 db->count_32 = VALUES_32_COUNT;
547 db->index_16 = HEADER_SIZE
548 + INDEX_64_COUNT * sizeof(struct db_index)
549 + VALUES_64_COUNT * sizeof(u64)
550 + INDEX_32_COUNT * sizeof(struct db_index)
551 + VALUES_32_COUNT * sizeof(u32);
552 db->count_16 = VALUES_16_COUNT;
554 /* Rules to check db layout. */
556 BUILD_BUG_ON(sizeof(struct db_index) != 1);
557 BUILD_BUG_ON(sizeof(struct os_area_db) != 2 * OS_AREA_SEGMENT_SIZE);
558 BUILD_BUG_ON(INDEX_64_COUNT & 0x7);
559 BUILD_BUG_ON(VALUES_64_COUNT > INDEX_64_COUNT);
560 BUILD_BUG_ON(INDEX_32_COUNT & 0x7);
561 BUILD_BUG_ON(VALUES_32_COUNT > INDEX_32_COUNT);
562 BUILD_BUG_ON(INDEX_16_COUNT & 0x7);
563 BUILD_BUG_ON(VALUES_16_COUNT > INDEX_16_COUNT);
564 BUILD_BUG_ON(HEADER_SIZE
565 + INDEX_64_COUNT * sizeof(struct db_index)
566 + VALUES_64_COUNT * sizeof(u64)
567 + INDEX_32_COUNT * sizeof(struct db_index)
568 + VALUES_32_COUNT * sizeof(u32)
569 + INDEX_16_COUNT * sizeof(struct db_index)
570 + VALUES_16_COUNT * sizeof(u16)
571 > sizeof(struct os_area_db));
575 * update_flash_db - Helper for os_area_queue_work_handler.
579 static void update_flash_db(void)
585 static const unsigned int buf_len = 8 * OS_AREA_SEGMENT_SIZE;
586 const struct os_area_header *header;
587 struct os_area_db* db;
589 /* Read in header and db from flash. */
591 file = sys_open("/dev/ps3flash", O_RDWR, 0);
594 pr_debug("%s:%d sys_open failed\n", __func__, __LINE__);
598 header = kmalloc(buf_len, GFP_KERNEL);
601 pr_debug("%s:%d kmalloc failed\n", __func__, __LINE__);
605 offset = sys_lseek(file, 0, SEEK_SET);
608 pr_debug("%s:%d sys_lseek failed\n", __func__, __LINE__);
609 goto fail_header_seek;
612 count = sys_read(file, (char __user *)header, buf_len);
614 result = count < OS_AREA_SEGMENT_SIZE || verify_header(header)
615 || count < header->db_area_offset * OS_AREA_SEGMENT_SIZE;
618 pr_debug("%s:%d verify_header failed\n", __func__, __LINE__);
623 /* Now got a good db offset and some maybe good db data. */
625 db = (void*)header + header->db_area_offset * OS_AREA_SEGMENT_SIZE;
627 result = db_verify(db);
630 printk(KERN_NOTICE "%s:%d: Verify of flash database failed, "
631 "formatting.\n", __func__, __LINE__);
636 /* Now got good db data. */
638 db_set_64(db, &os_area_db_id_rtc_diff, saved_params.rtc_diff);
640 offset = sys_lseek(file, header->db_area_offset * OS_AREA_SEGMENT_SIZE,
643 if (offset != header->db_area_offset * OS_AREA_SEGMENT_SIZE) {
644 pr_debug("%s:%d sys_lseek failed\n", __func__, __LINE__);
648 count = sys_write(file, (const char __user *)db,
649 sizeof(struct os_area_db));
651 if (count < sizeof(struct os_area_db)) {
652 pr_debug("%s:%d sys_write failed\n", __func__, __LINE__);
666 * os_area_queue_work_handler - Asynchronous write handler.
668 * An asynchronous write for flash memory and the device tree. Do not
669 * call directly, use os_area_queue_work().
672 static void os_area_queue_work_handler(struct work_struct *work)
674 struct device_node *node;
676 pr_debug(" -> %s:%d\n", __func__, __LINE__);
678 node = of_find_node_by_path("/");
681 os_area_set_property(node, &property_rtc_diff);
684 pr_debug("%s:%d of_find_node_by_path failed\n",
687 #if defined(CONFIG_PS3_FLASH) || defined(CONFIG_PS3_FLASH_MODULE)
690 printk(KERN_WARNING "%s:%d: No flash rom driver configured.\n",
693 pr_debug(" <- %s:%d\n", __func__, __LINE__);
696 static void os_area_queue_work(void)
698 static DECLARE_WORK(q, os_area_queue_work_handler);
705 * ps3_os_area_save_params - Copy data from os area mirror to @saved_params.
707 * For the convenience of the guest the HV makes a copy of the os area in
708 * flash to a high address in the boot memory region and then puts that RAM
709 * address and the byte count into the repository for retrieval by the guest.
710 * We copy the data we want into a static variable and allow the memory setup
711 * by the HV to be claimed by the lmb manager.
713 * The os area mirror will not be available to a second stage kernel, and
714 * the header verify will fail. In this case, the saved_params values will
715 * be set from flash memory or the passed in device tree in ps3_os_area_init().
718 void __init ps3_os_area_save_params(void)
723 struct os_area_header *header;
724 struct os_area_params *params;
725 struct os_area_db *db;
727 pr_debug(" -> %s:%d\n", __func__, __LINE__);
729 result = ps3_repository_read_boot_dat_info(&lpar_addr, &size);
732 pr_debug("%s:%d ps3_repository_read_boot_dat_info failed\n",
737 header = (struct os_area_header *)__va(lpar_addr);
738 params = (struct os_area_params *)__va(lpar_addr
739 + OS_AREA_SEGMENT_SIZE);
741 result = verify_header(header);
744 /* Second stage kernels exit here. */
745 pr_debug("%s:%d verify_header failed\n", __func__, __LINE__);
750 db = (struct os_area_db *)__va(lpar_addr
751 + header->db_area_offset * OS_AREA_SEGMENT_SIZE);
757 result = db_verify(db) || db_get_rtc_diff(db, &saved_params.rtc_diff);
759 saved_params.rtc_diff = params->rtc_diff ? params->rtc_diff
760 : SECONDS_FROM_1970_TO_2000;
761 saved_params.av_multi_out = params->av_multi_out;
762 saved_params.valid = 1;
764 memset(header, 0, sizeof(*header));
766 pr_debug(" <- %s:%d\n", __func__, __LINE__);
770 * ps3_os_area_init - Setup os area device tree properties as needed.
773 void __init ps3_os_area_init(void)
775 struct device_node *node;
777 pr_debug(" -> %s:%d\n", __func__, __LINE__);
779 node = of_find_node_by_path("/");
781 if (!saved_params.valid && node) {
782 /* Second stage kernels should have a dt entry. */
783 os_area_get_property(node, &property_rtc_diff);
784 os_area_get_property(node, &property_av_multi_out);
787 if(!saved_params.rtc_diff)
788 saved_params.rtc_diff = SECONDS_FROM_1970_TO_2000;
791 os_area_set_property(node, &property_rtc_diff);
792 os_area_set_property(node, &property_av_multi_out);
795 pr_debug("%s:%d of_find_node_by_path failed\n",
798 pr_debug(" <- %s:%d\n", __func__, __LINE__);
802 * ps3_os_area_get_rtc_diff - Returns the rtc diff value.
805 u64 ps3_os_area_get_rtc_diff(void)
807 return saved_params.rtc_diff;
811 * ps3_os_area_set_rtc_diff - Set the rtc diff value.
813 * An asynchronous write is needed to support writing updates from
814 * the timer interrupt context.
817 void ps3_os_area_set_rtc_diff(u64 rtc_diff)
819 if (saved_params.rtc_diff != rtc_diff) {
820 saved_params.rtc_diff = rtc_diff;
821 os_area_queue_work();
826 * ps3_os_area_get_av_multi_out - Returns the default video mode.
829 enum ps3_param_av_multi_out ps3_os_area_get_av_multi_out(void)
831 return saved_params.av_multi_out;
833 EXPORT_SYMBOL_GPL(ps3_os_area_get_av_multi_out);