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 #include <asm/ps3.h>
  26
  27 #include "platform.h"
  28
  29 enum {
  30         OS_AREA_SEGMENT_SIZE = 0X200,
  31 };
  32
  33 enum {
  34         HEADER_LDR_FORMAT_RAW = 0,
  35         HEADER_LDR_FORMAT_GZIP = 1,
  36 };
  37
  38 /**
  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.
  46  *
  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.
  51  */
  52
  53 struct os_area_header {
  54         s8 magic_num[16];
  55         u32 hdr_version;
  56         u32 os_area_offset;
  57         u32 ldr_area_offset;
  58         u32 _reserved_1;
  59         u32 ldr_format;
  60         u32 ldr_size;
  61         u32 _reserved_2[6];
  62 };
  63
  64 enum {
  65         PARAM_BOOT_FLAG_GAME_OS = 0,
  66         PARAM_BOOT_FLAG_OTHER_OS = 1,
  67 };
  68
  69 enum {
  70         PARAM_CTRL_BUTTON_O_IS_YES = 0,
  71         PARAM_CTRL_BUTTON_X_IS_YES = 1,
  72 };
  73
  74 /**
  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
  81  *      flag.
  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.
  87  *
  88  * User preference of zero for static_ip_addr means use dhcp.
  89  */
  90
  91 struct os_area_params {
  92         u32 boot_flag;
  93         u32 _reserved_1[3];
  94         u32 num_params;
  95         u32 _reserved_2[3];
  96         /* param 0 */
  97         s64 rtc_diff;
  98         u8 av_multi_out;
  99         u8 ctrl_button;
 100         u8 _reserved_3[6];
 101         /* param 1 */
 102         u8 static_ip_addr[4];
 103         u8 network_mask[4];
 104         u8 default_gateway[4];
 105         u8 _reserved_4[4];
 106         /* param 2 */
 107         u8 dns_primary[4];
 108         u8 dns_secondary[4];
 109         u8 _reserved_5[8];
 110 };
 111
 112 /**
 113  * struct saved_params - Static working copies of data from the 'Other OS' area.
 114  *
 115  * For the convinience of the guest, the HV makes a copy of the 'Other OS' area
 116  * in flash to a high address in the boot memory region and then puts that RAM
 117  * address and the byte count into the repository for retreval by the guest.
 118  * We copy the data we want into a static variable and allow the memory setup
 119  * by the HV to be claimed by the lmb manager.
 120  */
 121
 122 struct saved_params {
 123         /* param 0 */
 124         s64 rtc_diff;
 125         unsigned int av_multi_out;
 126         unsigned int ctrl_button;
 127         /* param 1 */
 128         u8 static_ip_addr[4];
 129         u8 network_mask[4];
 130         u8 default_gateway[4];
 131         /* param 2 */
 132         u8 dns_primary[4];
 133         u8 dns_secondary[4];
 134 } static saved_params;
 135
 136 #define dump_header(_a) _dump_header(_a, __func__, __LINE__)
 137 static void _dump_header(const struct os_area_header __iomem *h, const char* func,
 138         int line)
 139 {
 140         pr_debug("%s:%d: h.magic_num:         '%s'\n", func, line,
 141                 h->magic_num);
 142         pr_debug("%s:%d: h.hdr_version:       %u\n", func, line,
 143                 h->hdr_version);
 144         pr_debug("%s:%d: h.os_area_offset:   %u\n", func, line,
 145                 h->os_area_offset);
 146         pr_debug("%s:%d: h.ldr_area_offset: %u\n", func, line,
 147                 h->ldr_area_offset);
 148         pr_debug("%s:%d: h.ldr_format:        %u\n", func, line,
 149                 h->ldr_format);
 150         pr_debug("%s:%d: h.ldr_size:          %xh\n", func, line,
 151                 h->ldr_size);
 152 }
 153
 154 #define dump_params(_a) _dump_params(_a, __func__, __LINE__)
 155 static void _dump_params(const struct os_area_params __iomem *p, const char* func,
 156         int line)
 157 {
 158         pr_debug("%s:%d: p.boot_flag:       %u\n", func, line, p->boot_flag);
 159         pr_debug("%s:%d: p.num_params:      %u\n", func, line, p->num_params);
 160         pr_debug("%s:%d: p.rtc_diff         %ld\n", func, line, p->rtc_diff);
 161         pr_debug("%s:%d: p.av_multi_out     %u\n", func, line, p->av_multi_out);
 162         pr_debug("%s:%d: p.ctrl_button:     %u\n", func, line, p->ctrl_button);
 163         pr_debug("%s:%d: p.static_ip_addr:  %u.%u.%u.%u\n", func, line,
 164                 p->static_ip_addr[0], p->static_ip_addr[1],
 165                 p->static_ip_addr[2], p->static_ip_addr[3]);
 166         pr_debug("%s:%d: p.network_mask:    %u.%u.%u.%u\n", func, line,
 167                 p->network_mask[0], p->network_mask[1],
 168                 p->network_mask[2], p->network_mask[3]);
 169         pr_debug("%s:%d: p.default_gateway: %u.%u.%u.%u\n", func, line,
 170                 p->default_gateway[0], p->default_gateway[1],
 171                 p->default_gateway[2], p->default_gateway[3]);
 172         pr_debug("%s:%d: p.dns_primary:     %u.%u.%u.%u\n", func, line,
 173                 p->dns_primary[0], p->dns_primary[1],
 174                 p->dns_primary[2], p->dns_primary[3]);
 175         pr_debug("%s:%d: p.dns_secondary:   %u.%u.%u.%u\n", func, line,
 176                 p->dns_secondary[0], p->dns_secondary[1],
 177                 p->dns_secondary[2], p->dns_secondary[3]);
 178 }
 179
 180 static int __init verify_header(const struct os_area_header *header)
 181 {
 182         if (memcmp(header->magic_num, "cell_ext_os_area", 16)) {
 183                 pr_debug("%s:%d magic_num failed\n", __func__, __LINE__);
 184                 return -1;
 185         }
 186
 187         if (header->hdr_version < 1) {
 188                 pr_debug("%s:%d hdr_version failed\n", __func__, __LINE__);
 189                 return -1;
 190         }
 191
 192         if (header->os_area_offset > header->ldr_area_offset) {
 193                 pr_debug("%s:%d offsets failed\n", __func__, __LINE__);
 194                 return -1;
 195         }
 196
 197         return 0;
 198 }
 199
 200 int __init ps3_os_area_init(void)
 201 {
 202         int result;
 203         u64 lpar_addr;
 204         unsigned int size;
 205         struct os_area_header *header;
 206         struct os_area_params *params;
 207
 208         result = ps3_repository_read_boot_dat_info(&lpar_addr, &size);
 209
 210         if (result) {
 211                 pr_debug("%s:%d ps3_repository_read_boot_dat_info failed\n",
 212                         __func__, __LINE__);
 213                 return result;
 214         }
 215
 216         header = (struct os_area_header *)__va(lpar_addr);
 217         params = (struct os_area_params *)__va(lpar_addr + OS_AREA_SEGMENT_SIZE);
 218
 219         result = verify_header(header);
 220
 221         if (result) {
 222                 pr_debug("%s:%d verify_header failed\n", __func__, __LINE__);
 223                 dump_header(header);
 224                 return -EIO;
 225         }
 226
 227         dump_header(header);
 228         dump_params(params);
 229
 230         saved_params.rtc_diff = params->rtc_diff;
 231         saved_params.av_multi_out = params->av_multi_out;
 232         saved_params.ctrl_button = params->ctrl_button;
 233         memcpy(saved_params.static_ip_addr, params->static_ip_addr, 4);
 234         memcpy(saved_params.network_mask, params->network_mask, 4);
 235         memcpy(saved_params.default_gateway, params->default_gateway, 4);
 236         memcpy(saved_params.dns_secondary, params->dns_secondary, 4);
 237
 238         return result;
 239 }
 240
 241 /**
 242  * ps3_os_area_rtc_diff - Returns the ps3 rtc diff value.
 243  *
 244  * The ps3 rtc maintains a value that approximates seconds since
 245  * 2000-01-01 00:00:00 UTC.  Returns the exact number of seconds from 1970 to
 246  * 2000 when saved_params.rtc_diff has not been properly set up.
 247  */
 248
 249 u64 ps3_os_area_rtc_diff(void)
 250 {
 251         return saved_params.rtc_diff ? saved_params.rtc_diff : 946684800UL;
 252 }
 253
 254 /**
 255  * ps3_os_area_get_av_multi_out - Returns the default video mode.
 256  */
 257
 258 enum ps3_param_av_multi_out ps3_os_area_get_av_multi_out(void)
 259 {
 260     return saved_params.av_multi_out;
 261 }
 262 EXPORT_SYMBOL_GPL(ps3_os_area_get_av_multi_out);