hw/mac_nvram.c

   1 /*
   2  * PowerMac NVRAM emulation
   3  *
   4  * Copyright (c) 2005-2007 Fabrice Bellard
   5  * Copyright (c) 2007 Jocelyn Mayer
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  20  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  23  * THE SOFTWARE.
  24  */
  25 #include "hw.h"
  26 #include "firmware_abi.h"
  27 #include "sysemu/sysemu.h"
  28 #include "ppc/mac.h"
  29
  30 /* debug NVR */
  31 //#define DEBUG_NVR
  32
  33 #ifdef DEBUG_NVR
  34 #define NVR_DPRINTF(fmt, ...)                                   \
  35     do { printf("NVR: " fmt , ## __VA_ARGS__); } while (0)
  36 #else
  37 #define NVR_DPRINTF(fmt, ...)
  38 #endif
  39
  40 struct MacIONVRAMState {
  41     uint32_t size;
  42     MemoryRegion mem;
  43     unsigned int it_shift;
  44     uint8_t *data;
  45 };
  46
  47 #define DEF_SYSTEM_SIZE 0xc10
  48
  49 /* Direct access to NVRAM */
  50 uint8_t macio_nvram_read(MacIONVRAMState *s, uint32_t addr)
  51 {
  52     uint32_t ret;
  53
  54     if (addr < s->size) {
  55         ret = s->data[addr];
  56     } else {
  57         ret = -1;
  58     }
  59     NVR_DPRINTF("read addr %04" PRIx32 " val %" PRIx8 "\n", addr, ret);
  60
  61     return ret;
  62 }
  63
  64 void macio_nvram_write(MacIONVRAMState *s, uint32_t addr, uint8_t val)
  65 {
  66     NVR_DPRINTF("write addr %04" PRIx32 " val %" PRIx8 "\n", addr, val);
  67     if (addr < s->size) {
  68         s->data[addr] = val;
  69     }
  70 }
  71
  72 /* macio style NVRAM device */
  73 static void macio_nvram_writeb(void *opaque, hwaddr addr,
  74                                uint64_t value, unsigned size)
  75 {
  76     MacIONVRAMState *s = opaque;
  77
  78     addr = (addr >> s->it_shift) & (s->size - 1);
  79     s->data[addr] = value;
  80     NVR_DPRINTF("writeb addr %04" PHYS_PRIx " val %" PRIx64 "\n", addr, value);
  81 }
  82
  83 static uint64_t macio_nvram_readb(void *opaque, hwaddr addr,
  84                                   unsigned size)
  85 {
  86     MacIONVRAMState *s = opaque;
  87     uint32_t value;
  88
  89     addr = (addr >> s->it_shift) & (s->size - 1);
  90     value = s->data[addr];
  91     NVR_DPRINTF("readb addr %04x val %x\n", (int)addr, value);
  92
  93     return value;
  94 }
  95
  96 static const MemoryRegionOps macio_nvram_ops = {
  97     .read = macio_nvram_readb,
  98     .write = macio_nvram_writeb,
  99     .endianness = DEVICE_BIG_ENDIAN,
 100 };
 101
 102 static const VMStateDescription vmstate_macio_nvram = {
 103     .name = "macio_nvram",
 104     .version_id = 1,
 105     .minimum_version_id = 1,
 106     .minimum_version_id_old = 1,
 107     .fields      = (VMStateField[]) {
 108         VMSTATE_VBUFFER_UINT32(data, MacIONVRAMState, 0, NULL, 0, size),
 109         VMSTATE_END_OF_LIST()
 110     }
 111 };
 112
 113
 114 static void macio_nvram_reset(void *opaque)
 115 {
 116 }
 117
 118 MacIONVRAMState *macio_nvram_init (hwaddr size,
 119                                    unsigned int it_shift)
 120 {
 121     MacIONVRAMState *s;
 122
 123     s = g_malloc0(sizeof(MacIONVRAMState));
 124     s->data = g_malloc0(size);
 125     s->size = size;
 126     s->it_shift = it_shift;
 127
 128     memory_region_init_io(&s->mem, &macio_nvram_ops, s, "macio-nvram",
 129                           size << it_shift);
 130     vmstate_register(NULL, -1, &vmstate_macio_nvram, s);
 131     qemu_register_reset(macio_nvram_reset, s);
 132
 133     return s;
 134 }
 135
 136 void macio_nvram_setup_bar(MacIONVRAMState *s, MemoryRegion *bar,
 137                            hwaddr mem_base)
 138 {
 139     memory_region_add_subregion(bar, mem_base, &s->mem);
 140 }
 141
 142 /* Set up a system OpenBIOS NVRAM partition */
 143 void pmac_format_nvram_partition (MacIONVRAMState *nvr, int len)
 144 {
 145     unsigned int i;
 146     uint32_t start = 0, end;
 147     struct OpenBIOS_nvpart_v1 *part_header;
 148
 149     // OpenBIOS nvram variables
 150     // Variable partition
 151     part_header = (struct OpenBIOS_nvpart_v1 *)nvr->data;
 152     part_header->signature = OPENBIOS_PART_SYSTEM;
 153     pstrcpy(part_header->name, sizeof(part_header->name), "system");
 154
 155     end = start + sizeof(struct OpenBIOS_nvpart_v1);
 156     for (i = 0; i < nb_prom_envs; i++)
 157         end = OpenBIOS_set_var(nvr->data, end, prom_envs[i]);
 158
 159     // End marker
 160     nvr->data[end++] = '\0';
 161
 162     end = start + ((end - start + 15) & ~15);
 163     /* XXX: OpenBIOS is not able to grow up a partition. Leave some space for
 164        new variables. */
 165     if (end < DEF_SYSTEM_SIZE)
 166         end = DEF_SYSTEM_SIZE;
 167     OpenBIOS_finish_partition(part_header, end - start);
 168
 169     // free partition
 170     start = end;
 171     part_header = (struct OpenBIOS_nvpart_v1 *)&nvr->data[start];
 172     part_header->signature = OPENBIOS_PART_FREE;
 173     pstrcpy(part_header->name, sizeof(part_header->name), "free");
 174
 175     end = len;
 176     OpenBIOS_finish_partition(part_header, end - start);
 177 }