[PATCH] Make mkcompile_h use LANG=C and LC_ALL=C for $CC -v
[linux-2.6.git] / arch / powerpc / platforms / ps3 / os-area.c
1 /*
2  *  PS3 'Other OS' area data.
3  *
4  *  Copyright (C) 2006 Sony Computer Entertainment Inc.
5  *  Copyright 2006 Sony Corp.
6  *
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.
10  *
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.
15  *
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
19  */
20
21 #include <linux/kernel.h>
22 #include <linux/io.h>
23
24 #include <asm/lmb.h>
25
26 #include "platform.h"
27
28 enum {
29         OS_AREA_SEGMENT_SIZE = 0X200,
30 };
31
32 enum {
33         HEADER_LDR_FORMAT_RAW = 0,
34         HEADER_LDR_FORMAT_GZIP = 1,
35 };
36
37 /**
38  * struct os_area_header - os area header segment.
39  * @magic_num: Always 'cell_ext_os_area'.
40  * @hdr_version: Header format version number.
41  * @os_area_offset: Starting segment number of os image area.
42  * @ldr_area_offset: Starting segment number of bootloader image area.
43  * @ldr_format: HEADER_LDR_FORMAT flag.
44  * @ldr_size: Size of bootloader image in bytes.
45  *
46  * Note that the docs refer to area offsets.  These are offsets in units of
47  * segments from the start of the os area (top of the header).  These are
48  * better thought of as segment numbers.  The os area of the os area is
49  * reserved for the os image.
50  */
51
52 struct os_area_header {
53         s8 magic_num[16];
54         u32 hdr_version;
55         u32 os_area_offset;
56         u32 ldr_area_offset;
57         u32 _reserved_1;
58         u32 ldr_format;
59         u32 ldr_size;
60         u32 _reserved_2[6];
61 };
62
63 enum {
64         PARAM_BOOT_FLAG_GAME_OS = 0,
65         PARAM_BOOT_FLAG_OTHER_OS = 1,
66 };
67
68 enum {
69         PARAM_CTRL_BUTTON_O_IS_YES = 0,
70         PARAM_CTRL_BUTTON_X_IS_YES = 1,
71 };
72
73 /**
74  * struct os_area_params - os area params segment.
75  * @boot_flag: User preference of operating system, PARAM_BOOT_FLAG flag.
76  * @num_params: Number of params in this (params) segment.
77  * @rtc_diff: Difference in seconds between 1970 and the ps3 rtc value.
78  * @av_multi_out: User preference of AV output, PARAM_AV_MULTI_OUT flag.
79  * @ctrl_button: User preference of controller button config, PARAM_CTRL_BUTTON
80  *      flag.
81  * @static_ip_addr: User preference of static IP address.
82  * @network_mask: User preference of static network mask.
83  * @default_gateway: User preference of static default gateway.
84  * @dns_primary: User preference of static primary dns server.
85  * @dns_secondary: User preference of static secondary dns server.
86  *
87  * User preference of zero for static_ip_addr means use dhcp.
88  */
89
90 struct os_area_params {
91         u32 boot_flag;
92         u32 _reserved_1[3];
93         u32 num_params;
94         u32 _reserved_2[3];
95         /* param 0 */
96         s64 rtc_diff;
97         u8 av_multi_out;
98         u8 ctrl_button;
99         u8 _reserved_3[6];
100         /* param 1 */
101         u8 static_ip_addr[4];
102         u8 network_mask[4];
103         u8 default_gateway[4];
104         u8 _reserved_4[4];
105         /* param 2 */
106         u8 dns_primary[4];
107         u8 dns_secondary[4];
108         u8 _reserved_5[8];
109 };
110
111 /**
112  * struct saved_params - Static working copies of data from the 'Other OS' area.
113  *
114  * For the convinience of the guest, the HV makes a copy of the 'Other OS' area
115  * in flash to a high address in the boot memory region and then puts that RAM
116  * address and the byte count into the repository for retreval by the guest.
117  * We copy the data we want into a static variable and allow the memory setup
118  * by the HV to be claimed by the lmb manager.
119  */
120
121 struct saved_params {
122         /* param 0 */
123         s64 rtc_diff;
124         unsigned int av_multi_out;
125         unsigned int ctrl_button;
126         /* param 1 */
127         u8 static_ip_addr[4];
128         u8 network_mask[4];
129         u8 default_gateway[4];
130         /* param 2 */
131         u8 dns_primary[4];
132         u8 dns_secondary[4];
133 } static saved_params;
134
135 #define dump_header(_a) _dump_header(_a, __func__, __LINE__)
136 static void _dump_header(const struct os_area_header __iomem *h, const char* func,
137         int line)
138 {
139         pr_debug("%s:%d: h.magic_num:         '%s'\n", func, line,
140                 h->magic_num);
141         pr_debug("%s:%d: h.hdr_version:       %u\n", func, line,
142                 h->hdr_version);
143         pr_debug("%s:%d: h.os_area_offset:   %u\n", func, line,
144                 h->os_area_offset);
145         pr_debug("%s:%d: h.ldr_area_offset: %u\n", func, line,
146                 h->ldr_area_offset);
147         pr_debug("%s:%d: h.ldr_format:        %u\n", func, line,
148                 h->ldr_format);
149         pr_debug("%s:%d: h.ldr_size:          %xh\n", func, line,
150                 h->ldr_size);
151 }
152
153 #define dump_params(_a) _dump_params(_a, __func__, __LINE__)
154 static void _dump_params(const struct os_area_params __iomem *p, const char* func,
155         int line)
156 {
157         pr_debug("%s:%d: p.boot_flag:       %u\n", func, line, p->boot_flag);
158         pr_debug("%s:%d: p.num_params:      %u\n", func, line, p->num_params);
159         pr_debug("%s:%d: p.rtc_diff         %ld\n", func, line, p->rtc_diff);
160         pr_debug("%s:%d: p.av_multi_out     %u\n", func, line, p->av_multi_out);
161         pr_debug("%s:%d: p.ctrl_button:     %u\n", func, line, p->ctrl_button);
162         pr_debug("%s:%d: p.static_ip_addr:  %u.%u.%u.%u\n", func, line,
163                 p->static_ip_addr[0], p->static_ip_addr[1],
164                 p->static_ip_addr[2], p->static_ip_addr[3]);
165         pr_debug("%s:%d: p.network_mask:    %u.%u.%u.%u\n", func, line,
166                 p->network_mask[0], p->network_mask[1],
167                 p->network_mask[2], p->network_mask[3]);
168         pr_debug("%s:%d: p.default_gateway: %u.%u.%u.%u\n", func, line,
169                 p->default_gateway[0], p->default_gateway[1],
170                 p->default_gateway[2], p->default_gateway[3]);
171         pr_debug("%s:%d: p.dns_primary:     %u.%u.%u.%u\n", func, line,
172                 p->dns_primary[0], p->dns_primary[1],
173                 p->dns_primary[2], p->dns_primary[3]);
174         pr_debug("%s:%d: p.dns_secondary:   %u.%u.%u.%u\n", func, line,
175                 p->dns_secondary[0], p->dns_secondary[1],
176                 p->dns_secondary[2], p->dns_secondary[3]);
177 }
178
179 static int __init verify_header(const struct os_area_header *header)
180 {
181         if (memcmp(header->magic_num, "cell_ext_os_area", 16)) {
182                 pr_debug("%s:%d magic_num failed\n", __func__, __LINE__);
183                 return -1;
184         }
185
186         if (header->hdr_version < 1) {
187                 pr_debug("%s:%d hdr_version failed\n", __func__, __LINE__);
188                 return -1;
189         }
190
191         if (header->os_area_offset > header->ldr_area_offset) {
192                 pr_debug("%s:%d offsets failed\n", __func__, __LINE__);
193                 return -1;
194         }
195
196         return 0;
197 }
198
199 int __init ps3_os_area_init(void)
200 {
201         int result;
202         u64 lpar_addr;
203         unsigned int size;
204         struct os_area_header *header;
205         struct os_area_params *params;
206
207         result = ps3_repository_read_boot_dat_info(&lpar_addr, &size);
208
209         if (result) {
210                 pr_debug("%s:%d ps3_repository_read_boot_dat_info failed\n",
211                         __func__, __LINE__);
212                 return result;
213         }
214
215         header = (struct os_area_header *)__va(lpar_addr);
216         params = (struct os_area_params *)__va(lpar_addr + OS_AREA_SEGMENT_SIZE);
217
218         result = verify_header(header);
219
220         if (result) {
221                 pr_debug("%s:%d verify_header failed\n", __func__, __LINE__);
222                 dump_header(header);
223                 return -EIO;
224         }
225
226         dump_header(header);
227         dump_params(params);
228
229         saved_params.rtc_diff = params->rtc_diff;
230         saved_params.av_multi_out = params->av_multi_out;
231         saved_params.ctrl_button = params->ctrl_button;
232         memcpy(saved_params.static_ip_addr, params->static_ip_addr, 4);
233         memcpy(saved_params.network_mask, params->network_mask, 4);
234         memcpy(saved_params.default_gateway, params->default_gateway, 4);
235         memcpy(saved_params.dns_secondary, params->dns_secondary, 4);
236
237         return result;
238 }
239
240 /**
241  * ps3_os_area_rtc_diff - Returns the ps3 rtc diff value.
242  *
243  * The ps3 rtc maintains a value that approximates seconds since
244  * 2000-01-01 00:00:00 UTC.  Returns the exact number of seconds from 1970 to
245  * 2000 when saved_params.rtc_diff has not been properly set up.
246  */
247
248 u64 ps3_os_area_rtc_diff(void)
249 {
250         return saved_params.rtc_diff ? saved_params.rtc_diff : 946684800UL;
251 }
252
253 /**
254  * ps3_os_area_get_av_multi_out - Returns the default video mode.
255  */
256
257 enum ps3_param_av_multi_out ps3_os_area_get_av_multi_out(void)
258 {
259     return saved_params.av_multi_out;
260 }
261 EXPORT_SYMBOL_GPL(ps3_os_area_get_av_multi_out);