text: /*
   * QEMU OldWorld PowerMac (currently ~G3 Beige) hardware System Emulator
   *
   * Copyright (c) 2004-2007 Fabrice Bellard
   * Copyright (c) 2007 Jocelyn Mayer
   *
   * Permission is hereby granted, free of charge, to any person obtaining a copy
   * of this software and associated documentation files (the "Software"), to deal
   * in the Software without restriction, including without limitation the rights
   * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   * copies of the Software, and to permit persons to whom the Software is
   * furnished to do so, subject to the following conditions:
   *
   * The above copyright notice and this permission notice shall be included in
   * all copies or substantial portions of the Software.
   *
   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
   * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   * THE SOFTWARE.
   */
  #include "hw.h"
  #include "ppc.h"
  #include "ppc_mac.h"
  #include "mac_dbdma.h"
  #include "nvram.h"
  #include "pc.h"
  #include "sysemu.h"
  #include "net.h"
  #include "isa.h"
  #include "pci.h"
  #include "boards.h"
  #include "fw_cfg.h"
  #include "escc.h"
  
  #define MAX_IDE_BUS 2
  #define VGA_BIOS_SIZE 65536
  #define CFG_ADDR 0xf0000510
  
  /* temporary frame buffer OSI calls for the video.x driver. The right
     solution is to modify the driver to use VGA PCI I/Os */
  /* XXX: to be removed. This is no way related to emulation */
  static int vga_osi_call (CPUState *env)
  {
      static int vga_vbl_enabled;
      int linesize;
  
      //    printf("osi_call R5=" REGX "\n", ppc_dump_gpr(env, 5));
  
      /* same handler as PearPC, coming from the original MOL video
         driver. */
      switch(env->gpr[5]) {
      case 4:
          break;
      case 28: /* set_vmode */
          if (env->gpr[6] != 1 || env->gpr[7] != 0)
              env->gpr[3] = 1;
          else
              env->gpr[3] = 0;
          break;
      case 29: /* get_vmode_info */
          if (env->gpr[6] != 0) {
              if (env->gpr[6] != 1 || env->gpr[7] != 0) {
                  env->gpr[3] = 1;
                  break;
              }
          }
          env->gpr[3] = 0;
          env->gpr[4] = (1 << 16) | 1; /* num_vmodes, cur_vmode */
          env->gpr[5] = (1 << 16) | 0; /* num_depths, cur_depth_mode */
          env->gpr[6] = (graphic_width << 16) | graphic_height; /* w, h */
          env->gpr[7] = 85 << 16; /* refresh rate */
          env->gpr[8] = (graphic_depth + 7) & ~7; /* depth (round to byte) */
          linesize = ((graphic_depth + 7) >> 3) * graphic_width;
          linesize = (linesize + 3) & ~3;
          env->gpr[9] = (linesize << 16) | 0; /* row_bytes, offset */
          break;
      case 31: /* set_video power */
          env->gpr[3] = 0;
          break;
      case 39: /* video_ctrl */
          if (env->gpr[6] == 0 || env->gpr[6] == 1)
              vga_vbl_enabled = env->gpr[6];
          env->gpr[3] = 0;
          break;
      case 47:
          break;
      case 59: /* set_color */
          /* R6 = index, R7 = RGB */
          env->gpr[3] = 0;
          break;
      case 64: /* get color */
          /* R6 = index */
          env->gpr[3] = 0;
          break;
      case 116: /* set hwcursor */
          /* R6 = x, R7 = y, R8 = visible, R9 = data */
          break;
      default:
          fprintf(stderr, "unsupported OSI call R5=" REGX "\n",
                  ppc_dump_gpr(env, 5));
          break;
      }
  
      return 1; /* osi_call handled */
  }
  
  static void ppc_heathrow_init (ram_addr_t ram_size, int vga_ram_size,
                                 const char *boot_device,
                                 const char *kernel_filename,
                                 const char *kernel_cmdline,
                                 const char *initrd_filename,
                                 const char *cpu_model)
  {
      CPUState *env = NULL, *envs[MAX_CPUS];
      char buf[1024];
      qemu_irq *pic, **heathrow_irqs;
      nvram_t nvram;
      m48t59_t *m48t59;
      int linux_boot, i;
      ram_addr_t ram_offset, vga_ram_offset, bios_offset, vga_bios_offset;
      uint32_t kernel_base, initrd_base;
      int32_t kernel_size, initrd_size;
      PCIBus *pci_bus;
      MacIONVRAMState *nvr;
      int vga_bios_size, bios_size;
      int pic_mem_index, nvram_mem_index, dbdma_mem_index, cuda_mem_index;
      int escc_mem_index, ide_mem_index[2];
      int ppc_boot_device;
      BlockDriverState *hd[MAX_IDE_BUS * MAX_IDE_DEVS];
      int index;
      void *fw_cfg;
      void *dbdma;
  
      linux_boot = (kernel_filename != NULL);
  
      /* init CPUs */
      if (cpu_model == NULL)
          cpu_model = "G3";
      for (i = 0; i < smp_cpus; i++) {
          env = cpu_init(cpu_model);
          if (!env) {
              fprintf(stderr, "Unable to find PowerPC CPU definition\n");
              exit(1);
          }
          /* Set time-base frequency to 16.6 Mhz */
          cpu_ppc_tb_init(env,  16600000UL);
          env->osi_call = vga_osi_call;
          qemu_register_reset(&cpu_ppc_reset, env);
          envs[i] = env;
      }
  
      /* allocate RAM */
      if (ram_size > (2047 << 20)) {
          fprintf(stderr,
                  "qemu: Too much memory for this machine: %d MB, maximum 2047 MB\n",
                  ((unsigned int)ram_size / (1 << 20)));
          exit(1);
      }
  
      ram_offset = qemu_ram_alloc(ram_size);
      cpu_register_physical_memory(0, ram_size, ram_offset);
  
      /* allocate VGA RAM */
      vga_ram_offset = qemu_ram_alloc(vga_ram_size);
  
      /* allocate and load BIOS */
      bios_offset = qemu_ram_alloc(BIOS_SIZE);
      if (bios_name == NULL)
          bios_name = PROM_FILENAME;
      snprintf(buf, sizeof(buf), "%s/%s", bios_dir, bios_name);
      cpu_register_physical_memory(PROM_ADDR, BIOS_SIZE, bios_offset | IO_MEM_ROM);
  
      /* Load OpenBIOS (ELF) */
      bios_size = load_elf(buf, 0, NULL, NULL, NULL);
      if (bios_size < 0 || bios_size > BIOS_SIZE) {
          cpu_abort(env, "qemu: could not load PowerPC bios '%s'\n", buf);
          exit(1);
      }
  
      /* allocate and load VGA BIOS */
      vga_bios_offset = qemu_ram_alloc(VGA_BIOS_SIZE);
      snprintf(buf, sizeof(buf), "%s/%s", bios_dir, VGABIOS_FILENAME);
      vga_bios_size = load_image(buf, phys_ram_base + vga_bios_offset + 8);
      if (vga_bios_size < 0) {
          /* if no bios is present, we can still work */
          fprintf(stderr, "qemu: warning: could not load VGA bios '%s'\n", buf);
          vga_bios_size = 0;
      } else {
          /* set a specific header (XXX: find real Apple format for NDRV
             drivers) */
          phys_ram_base[vga_bios_offset] = 'N';
          phys_ram_base[vga_bios_offset + 1] = 'D';
          phys_ram_base[vga_bios_offset + 2] = 'R';
          phys_ram_base[vga_bios_offset + 3] = 'V';
          cpu_to_be32w((uint32_t *)(phys_ram_base + vga_bios_offset + 4),
                       vga_bios_size);
          vga_bios_size += 8;
      }
  
      if (linux_boot) {
          uint64_t lowaddr = 0;
          kernel_base = KERNEL_LOAD_ADDR;
          /* Now we can load the kernel. The first step tries to load the kernel
             supposing PhysAddr = 0x00000000. If that was wrong the kernel is
             loaded again, the new PhysAddr being computed from lowaddr. */
          kernel_size = load_elf(kernel_filename, kernel_base, NULL, &lowaddr, NULL);
          if (kernel_size > 0 && lowaddr != KERNEL_LOAD_ADDR) {
              kernel_size = load_elf(kernel_filename, (2 * kernel_base) - lowaddr,
                                     NULL, 0, NULL);
          }
          if (kernel_size < 0)
              kernel_size = load_aout(kernel_filename, kernel_base,
                                      ram_size - kernel_base);
          if (kernel_size < 0)
              kernel_size = load_image_targphys(kernel_filename,
                                                kernel_base,
                                                ram_size - kernel_base);
          if (kernel_size < 0) {
              cpu_abort(env, "qemu: could not load kernel '%s'\n",
                        kernel_filename);
              exit(1);
          }
          /* load initrd */
          if (initrd_filename) {
              initrd_base = INITRD_LOAD_ADDR;
              initrd_size = load_image(initrd_filename,
                                       phys_ram_base + initrd_base);
              if (initrd_size < 0) {
                  cpu_abort(env, "qemu: could not load initial ram disk '%s'\n",
                            initrd_filename);
                  exit(1);
              }
          } else {
              initrd_base = 0;
              initrd_size = 0;
          }
          ppc_boot_device = 'm';
      } else {
          kernel_base = 0;
          kernel_size = 0;
          initrd_base = 0;
          initrd_size = 0;
          ppc_boot_device = '\0';
          for (i = 0; boot_device[i] != '\0'; i++) {
              /* TOFIX: for now, the second IDE channel is not properly
               *        used by OHW. The Mac floppy disk are not emulated.
               *        For now, OHW cannot boot from the network.
               */
  #if 0
              if (boot_device[i] >= 'a' && boot_device[i] <= 'f') {
                  ppc_boot_device = boot_device[i];
                  break;
              }
  #else
              if (boot_device[i] >= 'c' && boot_device[i] <= 'd') {
                  ppc_boot_device = boot_device[i];
                  break;
              }
  #endif
          }
          if (ppc_boot_device == '\0') {
              fprintf(stderr, "No valid boot device for G3 Beige machine\n");
              exit(1);
          }
      }
  
      isa_mem_base = 0x80000000;
  
      /* Register 2 MB of ISA IO space */
      isa_mmio_init(0xfe000000, 0x00200000);
  
      /* XXX: we register only 1 output pin for heathrow PIC */
      heathrow_irqs = qemu_mallocz(smp_cpus * sizeof(qemu_irq *));
      heathrow_irqs[0] =
          qemu_mallocz(smp_cpus * sizeof(qemu_irq) * 1);
      /* Connect the heathrow PIC outputs to the 6xx bus */
      for (i = 0; i < smp_cpus; i++) {
          switch (PPC_INPUT(env)) {
          case PPC_FLAGS_INPUT_6xx:
              heathrow_irqs[i] = heathrow_irqs[0] + (i * 1);
              heathrow_irqs[i][0] =
                  ((qemu_irq *)env->irq_inputs)[PPC6xx_INPUT_INT];
              break;
          default:
              cpu_abort(env, "Bus model not supported on OldWorld Mac machine\n");
              exit(1);
          }
      }
  
      /* init basic PC hardware */
      if (PPC_INPUT(env) != PPC_FLAGS_INPUT_6xx) {
          cpu_abort(env, "Only 6xx bus is supported on heathrow machine\n");
          exit(1);
      }
      pic = heathrow_pic_init(&pic_mem_index, 1, heathrow_irqs);
      pci_bus = pci_grackle_init(0xfec00000, pic);
      pci_vga_init(pci_bus, phys_ram_base + vga_ram_offset,
                   vga_ram_offset, vga_ram_size,
                   vga_bios_offset, vga_bios_size);
  
      escc_mem_index = escc_init(0x80013000, pic[0x0f], pic[0x10], serial_hds[0],
                                 serial_hds[1], ESCC_CLOCK, 4);
  
      for(i = 0; i < nb_nics; i++)
          pci_nic_init(pci_bus, &nd_table[i], -1, "ne2k_pci");
  
      /* First IDE channel is a CMD646 on the PCI bus */
  
      if (drive_get_max_bus(IF_IDE) >= MAX_IDE_BUS) {
          fprintf(stderr, "qemu: too many IDE bus\n");
          exit(1);
      }
      index = drive_get_index(IF_IDE, 0, 0);
      if (index == -1)
          hd[0] = NULL;
      else
          hd[0] =  drives_table[index].bdrv;
      index = drive_get_index(IF_IDE, 0, 1);
      if (index == -1)
          hd[1] = NULL;
      else
          hd[1] =  drives_table[index].bdrv;
      hd[3] = hd[2] = NULL;
      pci_cmd646_ide_init(pci_bus, hd, 0);
  
      /* Second IDE channel is a MAC IDE on the MacIO bus */
      index = drive_get_index(IF_IDE, 1, 0);
      if (index == -1)
          hd[0] = NULL;
      else
          hd[0] =  drives_table[index].bdrv;
      index = drive_get_index(IF_IDE, 1, 1);
      if (index == -1)
          hd[1] = NULL;
      else
          hd[1] =  drives_table[index].bdrv;
  
      dbdma = DBDMA_init(&dbdma_mem_index);
  
      ide_mem_index[0] = -1;
      ide_mem_index[1] = pmac_ide_init(hd, pic[0x0D], dbdma, 0x16, pic[0x02]);
  
      /* cuda also initialize ADB */
      cuda_init(&cuda_mem_index, pic[0x12]);
  
      adb_kbd_init(&adb_bus);
      adb_mouse_init(&adb_bus);
  
      nvr = macio_nvram_init(&nvram_mem_index, 0x2000, 4);
      pmac_format_nvram_partition(nvr, 0x2000);
  
      macio_init(pci_bus, PCI_DEVICE_ID_APPLE_343S1201, 1, pic_mem_index,
                 dbdma_mem_index, cuda_mem_index, nvr, 2, ide_mem_index,
                 escc_mem_index);
  
      if (usb_enabled) {
          usb_ohci_init_pci(pci_bus, 3, -1);
      }
  
      if (graphic_depth != 15 && graphic_depth != 32 && graphic_depth != 8)
          graphic_depth = 15;
  
      m48t59 = m48t59_init(0, 0xFFF04000, 0x0074, NVRAM_SIZE, 59);
      nvram.opaque = m48t59;
      nvram.read_fn = &m48t59_read;
      nvram.write_fn = &m48t59_write;
      PPC_NVRAM_set_params(&nvram, NVRAM_SIZE, "HEATHROW", ram_size,
                           ppc_boot_device, kernel_base, kernel_size,
                           kernel_cmdline,
                           initrd_base, initrd_size,
                           /* XXX: need an option to load a NVRAM image */
                           0,
                           graphic_width, graphic_height, graphic_depth);
      /* No PCI init: the BIOS will do it */
  
      fw_cfg = fw_cfg_init(0, 0, CFG_ADDR, CFG_ADDR + 2);
      fw_cfg_add_i32(fw_cfg, FW_CFG_ID, 1);
      fw_cfg_add_i64(fw_cfg, FW_CFG_RAM_SIZE, (uint64_t)ram_size);
      fw_cfg_add_i16(fw_cfg, FW_CFG_MACHINE_ID, ARCH_HEATHROW);
  }
  
  QEMUMachine heathrow_machine = {
      .name = "g3beige",
      .desc = "Heathrow based PowerMAC",
      .init = ppc_heathrow_init,
      .ram_require = BIOS_SIZE + VGA_BIOS_SIZE + VGA_RAM_SIZE,
      .max_cpus = MAX_CPUS,
  };
  