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>
30 OS_AREA_SEGMENT_SIZE = 0X200,
33 enum os_area_ldr_format {
34 HEADER_LDR_FORMAT_RAW = 0,
35 HEADER_LDR_FORMAT_GZIP = 1,
39 * struct os_area_header - os area header segment.
40 * @magic_num: Always 'cell_ext_os_area'.
41 * @hdr_version: Header format version number.
42 * @os_area_offset: Starting segment number of os image area.
43 * @ldr_area_offset: Starting segment number of bootloader image area.
44 * @ldr_format: HEADER_LDR_FORMAT flag.
45 * @ldr_size: Size of bootloader image in bytes.
47 * Note that the docs refer to area offsets. These are offsets in units of
48 * segments from the start of the os area (top of the header). These are
49 * better thought of as segment numbers. The os area of the os area is
50 * reserved for the os image.
53 struct os_area_header {
64 enum os_area_boot_flag {
65 PARAM_BOOT_FLAG_GAME_OS = 0,
66 PARAM_BOOT_FLAG_OTHER_OS = 1,
69 enum os_area_ctrl_button {
70 PARAM_CTRL_BUTTON_O_IS_YES = 0,
71 PARAM_CTRL_BUTTON_X_IS_YES = 1,
75 * struct os_area_params - os area params segment.
76 * @boot_flag: User preference of operating system, PARAM_BOOT_FLAG flag.
77 * @num_params: Number of params in this (params) segment.
78 * @rtc_diff: Difference in seconds between 1970 and the ps3 rtc value.
79 * @av_multi_out: User preference of AV output, PARAM_AV_MULTI_OUT flag.
80 * @ctrl_button: User preference of controller button config, PARAM_CTRL_BUTTON
82 * @static_ip_addr: User preference of static IP address.
83 * @network_mask: User preference of static network mask.
84 * @default_gateway: User preference of static default gateway.
85 * @dns_primary: User preference of static primary dns server.
86 * @dns_secondary: User preference of static secondary dns server.
88 * The ps3 rtc maintains a read-only value that approximates seconds since
89 * 2000-01-01 00:00:00 UTC.
91 * User preference of zero for static_ip_addr means use dhcp.
94 struct os_area_params {
105 u8 static_ip_addr[4];
107 u8 default_gateway[4];
115 #define SECONDS_FROM_1970_TO_2000 946684800LL
118 * struct saved_params - Static working copies of data from the PS3 'os area'.
121 struct saved_params {
123 unsigned int av_multi_out;
124 } static saved_params;
126 #define dump_header(_a) _dump_header(_a, __func__, __LINE__)
127 static void _dump_header(const struct os_area_header *h, const char *func,
130 pr_debug("%s:%d: h.magic_num: '%s'\n", func, line,
132 pr_debug("%s:%d: h.hdr_version: %u\n", func, line,
134 pr_debug("%s:%d: h.os_area_offset: %u\n", func, line,
136 pr_debug("%s:%d: h.ldr_area_offset: %u\n", func, line,
138 pr_debug("%s:%d: h.ldr_format: %u\n", func, line,
140 pr_debug("%s:%d: h.ldr_size: %xh\n", func, line,
144 #define dump_params(_a) _dump_params(_a, __func__, __LINE__)
145 static void _dump_params(const struct os_area_params *p, const char *func,
148 pr_debug("%s:%d: p.boot_flag: %u\n", func, line, p->boot_flag);
149 pr_debug("%s:%d: p.num_params: %u\n", func, line, p->num_params);
150 pr_debug("%s:%d: p.rtc_diff %ld\n", func, line, p->rtc_diff);
151 pr_debug("%s:%d: p.av_multi_out %u\n", func, line, p->av_multi_out);
152 pr_debug("%s:%d: p.ctrl_button: %u\n", func, line, p->ctrl_button);
153 pr_debug("%s:%d: p.static_ip_addr: %u.%u.%u.%u\n", func, line,
154 p->static_ip_addr[0], p->static_ip_addr[1],
155 p->static_ip_addr[2], p->static_ip_addr[3]);
156 pr_debug("%s:%d: p.network_mask: %u.%u.%u.%u\n", func, line,
157 p->network_mask[0], p->network_mask[1],
158 p->network_mask[2], p->network_mask[3]);
159 pr_debug("%s:%d: p.default_gateway: %u.%u.%u.%u\n", func, line,
160 p->default_gateway[0], p->default_gateway[1],
161 p->default_gateway[2], p->default_gateway[3]);
162 pr_debug("%s:%d: p.dns_primary: %u.%u.%u.%u\n", func, line,
163 p->dns_primary[0], p->dns_primary[1],
164 p->dns_primary[2], p->dns_primary[3]);
165 pr_debug("%s:%d: p.dns_secondary: %u.%u.%u.%u\n", func, line,
166 p->dns_secondary[0], p->dns_secondary[1],
167 p->dns_secondary[2], p->dns_secondary[3]);
170 static int __init verify_header(const struct os_area_header *header)
172 if (memcmp(header->magic_num, "cell_ext_os_area", 16)) {
173 pr_debug("%s:%d magic_num failed\n", __func__, __LINE__);
177 if (header->hdr_version < 1) {
178 pr_debug("%s:%d hdr_version failed\n", __func__, __LINE__);
182 if (header->os_area_offset > header->ldr_area_offset) {
183 pr_debug("%s:%d offsets failed\n", __func__, __LINE__);
191 * os_area_queue_work_handler - Asynchronous write handler.
193 * An asynchronous write for flash memory and the device tree. Do not
194 * call directly, use os_area_queue_work().
197 static void os_area_queue_work_handler(struct work_struct *work)
199 pr_debug(" -> %s:%d\n", __func__, __LINE__);
201 pr_debug(" <- %s:%d\n", __func__, __LINE__);
204 static void os_area_queue_work(void)
206 static DECLARE_WORK(q, os_area_queue_work_handler);
213 * ps3_os_area_save_params - Copy data from os area mirror to @saved_params.
215 * For the convenience of the guest, the HV makes a copy of the os area in
216 * flash to a high address in the boot memory region and then puts that RAM
217 * address and the byte count into the repository for retreval by the guest.
218 * We copy the data we want into a static variable and allow the memory setup
219 * by the HV to be claimed by the lmb manager.
222 void __init ps3_os_area_save_params(void)
227 struct os_area_header *header;
228 struct os_area_params *params;
230 pr_debug(" -> %s:%d\n", __func__, __LINE__);
232 result = ps3_repository_read_boot_dat_info(&lpar_addr, &size);
235 pr_debug("%s:%d ps3_repository_read_boot_dat_info failed\n",
240 header = (struct os_area_header *)__va(lpar_addr);
241 params = (struct os_area_params *)__va(lpar_addr
242 + OS_AREA_SEGMENT_SIZE);
244 result = verify_header(header);
247 pr_debug("%s:%d verify_header failed\n", __func__, __LINE__);
255 saved_params.rtc_diff = params->rtc_diff;
256 saved_params.av_multi_out = params->av_multi_out;
258 memset(header, 0, sizeof(*header));
260 pr_debug(" <- %s:%d\n", __func__, __LINE__);
264 * ps3_os_area_rtc_diff - Returns the rtc diff value.
267 u64 ps3_os_area_rtc_diff(void)
269 return saved_params.rtc_diff ? saved_params.rtc_diff
270 : SECONDS_FROM_1970_TO_2000;
274 * ps3_os_area_get_av_multi_out - Returns the default video mode.
277 enum ps3_param_av_multi_out ps3_os_area_get_av_multi_out(void)
279 return saved_params.av_multi_out;
281 EXPORT_SYMBOL_GPL(ps3_os_area_get_av_multi_out);