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 {
124 unsigned int av_multi_out;
125 } static saved_params;
127 static struct property property_rtc_diff = {
128 .name = "linux,rtc_diff",
129 .length = sizeof(saved_params.rtc_diff),
130 .value = &saved_params.rtc_diff,
133 static struct property property_av_multi_out = {
134 .name = "linux,av_multi_out",
135 .length = sizeof(saved_params.av_multi_out),
136 .value = &saved_params.av_multi_out,
140 * os_area_set_property - Add or overwrite a saved_params value to the device tree.
142 * Overwrites an existing property.
145 static void os_area_set_property(struct device_node *node,
146 struct property *prop)
149 struct property *tmp = of_find_property(node, prop->name, NULL);
152 pr_debug("%s:%d found %s\n", __func__, __LINE__, prop->name);
153 prom_remove_property(node, tmp);
156 result = prom_add_property(node, prop);
159 pr_debug("%s:%d prom_set_property failed\n", __func__,
164 * os_area_get_property - Get a saved_params value from the device tree.
168 static void __init os_area_get_property(struct device_node *node,
169 struct property *prop)
171 const struct property *tmp = of_find_property(node, prop->name, NULL);
174 BUG_ON(prop->length != tmp->length);
175 memcpy(prop->value, tmp->value, prop->length);
177 pr_debug("%s:%d not found %s\n", __func__, __LINE__,
181 #define dump_header(_a) _dump_header(_a, __func__, __LINE__)
182 static void _dump_header(const struct os_area_header *h, const char *func,
185 pr_debug("%s:%d: h.magic_num: '%s'\n", func, line,
187 pr_debug("%s:%d: h.hdr_version: %u\n", func, line,
189 pr_debug("%s:%d: h.os_area_offset: %u\n", func, line,
191 pr_debug("%s:%d: h.ldr_area_offset: %u\n", func, line,
193 pr_debug("%s:%d: h.ldr_format: %u\n", func, line,
195 pr_debug("%s:%d: h.ldr_size: %xh\n", func, line,
199 #define dump_params(_a) _dump_params(_a, __func__, __LINE__)
200 static void _dump_params(const struct os_area_params *p, const char *func,
203 pr_debug("%s:%d: p.boot_flag: %u\n", func, line, p->boot_flag);
204 pr_debug("%s:%d: p.num_params: %u\n", func, line, p->num_params);
205 pr_debug("%s:%d: p.rtc_diff %ld\n", func, line, p->rtc_diff);
206 pr_debug("%s:%d: p.av_multi_out %u\n", func, line, p->av_multi_out);
207 pr_debug("%s:%d: p.ctrl_button: %u\n", func, line, p->ctrl_button);
208 pr_debug("%s:%d: p.static_ip_addr: %u.%u.%u.%u\n", func, line,
209 p->static_ip_addr[0], p->static_ip_addr[1],
210 p->static_ip_addr[2], p->static_ip_addr[3]);
211 pr_debug("%s:%d: p.network_mask: %u.%u.%u.%u\n", func, line,
212 p->network_mask[0], p->network_mask[1],
213 p->network_mask[2], p->network_mask[3]);
214 pr_debug("%s:%d: p.default_gateway: %u.%u.%u.%u\n", func, line,
215 p->default_gateway[0], p->default_gateway[1],
216 p->default_gateway[2], p->default_gateway[3]);
217 pr_debug("%s:%d: p.dns_primary: %u.%u.%u.%u\n", func, line,
218 p->dns_primary[0], p->dns_primary[1],
219 p->dns_primary[2], p->dns_primary[3]);
220 pr_debug("%s:%d: p.dns_secondary: %u.%u.%u.%u\n", func, line,
221 p->dns_secondary[0], p->dns_secondary[1],
222 p->dns_secondary[2], p->dns_secondary[3]);
225 static int __init verify_header(const struct os_area_header *header)
227 if (memcmp(header->magic_num, "cell_ext_os_area", 16)) {
228 pr_debug("%s:%d magic_num failed\n", __func__, __LINE__);
232 if (header->hdr_version < 1) {
233 pr_debug("%s:%d hdr_version failed\n", __func__, __LINE__);
237 if (header->os_area_offset > header->ldr_area_offset) {
238 pr_debug("%s:%d offsets failed\n", __func__, __LINE__);
246 * os_area_queue_work_handler - Asynchronous write handler.
248 * An asynchronous write for flash memory and the device tree. Do not
249 * call directly, use os_area_queue_work().
252 static void os_area_queue_work_handler(struct work_struct *work)
254 struct device_node *node;
256 pr_debug(" -> %s:%d\n", __func__, __LINE__);
258 node = of_find_node_by_path("/");
261 os_area_set_property(node, &property_rtc_diff);
264 pr_debug("%s:%d of_find_node_by_path failed\n",
267 pr_debug(" <- %s:%d\n", __func__, __LINE__);
270 static void os_area_queue_work(void)
272 static DECLARE_WORK(q, os_area_queue_work_handler);
279 * ps3_os_area_save_params - Copy data from os area mirror to @saved_params.
281 * For the convenience of the guest, the HV makes a copy of the os area in
282 * flash to a high address in the boot memory region and then puts that RAM
283 * address and the byte count into the repository for retreval by the guest.
284 * We copy the data we want into a static variable and allow the memory setup
285 * by the HV to be claimed by the lmb manager.
288 void __init ps3_os_area_save_params(void)
293 struct os_area_header *header;
294 struct os_area_params *params;
296 pr_debug(" -> %s:%d\n", __func__, __LINE__);
298 result = ps3_repository_read_boot_dat_info(&lpar_addr, &size);
301 pr_debug("%s:%d ps3_repository_read_boot_dat_info failed\n",
306 header = (struct os_area_header *)__va(lpar_addr);
307 params = (struct os_area_params *)__va(lpar_addr
308 + OS_AREA_SEGMENT_SIZE);
310 result = verify_header(header);
313 /* Second stage kernels exit here. */
315 pr_debug("%s:%d verify_header failed\n", __func__, __LINE__);
323 saved_params.rtc_diff = params->rtc_diff;
324 saved_params.av_multi_out = params->av_multi_out;
325 saved_params.valid = 1;
327 memset(header, 0, sizeof(*header));
329 pr_debug(" <- %s:%d\n", __func__, __LINE__);
333 * ps3_os_area_init - Setup os area device tree properties as needed.
336 void __init ps3_os_area_init(void)
338 struct device_node *node;
340 pr_debug(" -> %s:%d\n", __func__, __LINE__);
342 node = of_find_node_by_path("/");
344 if (!saved_params.valid && node) {
345 /* Second stage kernels should have a dt entry. */
346 os_area_get_property(node, &property_rtc_diff);
347 os_area_get_property(node, &property_av_multi_out);
350 if(!saved_params.rtc_diff)
351 saved_params.rtc_diff = SECONDS_FROM_1970_TO_2000;
354 os_area_set_property(node, &property_rtc_diff);
355 os_area_set_property(node, &property_av_multi_out);
358 pr_debug("%s:%d of_find_node_by_path failed\n",
361 pr_debug(" <- %s:%d\n", __func__, __LINE__);
365 * ps3_os_area_get_rtc_diff - Returns the rtc diff value.
368 u64 ps3_os_area_get_rtc_diff(void)
370 return saved_params.rtc_diff;
374 * ps3_os_area_set_rtc_diff - Set the rtc diff value.
376 * An asynchronous write is needed to support writing updates from
377 * the timer interrupt context.
380 void ps3_os_area_set_rtc_diff(u64 rtc_diff)
382 if (saved_params.rtc_diff != rtc_diff) {
383 saved_params.rtc_diff = rtc_diff;
384 os_area_queue_work();
389 * ps3_os_area_get_av_multi_out - Returns the default video mode.
392 enum ps3_param_av_multi_out ps3_os_area_get_av_multi_out(void)
394 return saved_params.av_multi_out;
396 EXPORT_SYMBOL_GPL(ps3_os_area_get_av_multi_out);