2020-02-28 16:04:28 +00:00
|
|
|
/*
|
|
|
|
DingusPPC - The Experimental PowerPC Macintosh emulator
|
2022-03-14 17:09:11 +00:00
|
|
|
Copyright (C) 2018-22 divingkatae and maximum
|
2020-02-28 16:04:28 +00:00
|
|
|
(theweirdo) spatium
|
|
|
|
|
|
|
|
(Contact divingkatae#1017 or powermax#2286 on Discord for more info)
|
|
|
|
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
|
|
it under the terms of the GNU General Public License as published by
|
|
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
|
|
(at your option) any later version.
|
|
|
|
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
GNU General Public License for more details.
|
|
|
|
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
|
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
*/
|
|
|
|
|
2019-08-23 21:34:19 +00:00
|
|
|
/** MacIO device family emulation
|
|
|
|
|
|
|
|
Mac I/O (MIO) is a family of ASICs to bring support for Apple legacy
|
2019-12-26 23:42:02 +00:00
|
|
|
I/O hardware to the PCI-based Power Macintosh. That legacy hardware has
|
2019-08-23 21:34:19 +00:00
|
|
|
existed long before Power Macintosh was introduced. It includes:
|
|
|
|
- versatile interface adapter (VIA)
|
|
|
|
- Sander-Woz integrated machine (SWIM) that is a floppy disk controller
|
|
|
|
- CUDA MCU for ADB, parameter RAM, realtime clock and power management support
|
|
|
|
- serial communication controller (SCC)
|
|
|
|
- Macintosh Enhanced SCSI Hardware (MESH)
|
|
|
|
|
|
|
|
In the 68k Macintosh era, all this hardware was implemented using several
|
2019-08-28 00:39:29 +00:00
|
|
|
custom chips. In a PCI-compatible Power Macintosh, the above devices are part
|
2019-08-23 21:34:19 +00:00
|
|
|
of the MIO chip itself. MIO's functional blocks implementing virtual devices
|
|
|
|
are called "cells", i.e. "VIA cell", "SWIM cell" etc.
|
|
|
|
|
|
|
|
MIO itself is PCI compliant while the legacy hardware it emulates isn't.
|
2019-12-26 23:42:02 +00:00
|
|
|
MIO occupies 512Kb of the PCI memory space divided into registers space and
|
|
|
|
DMA space. Access to emulated legacy devices is accomplished by reading from/
|
2019-08-23 21:34:19 +00:00
|
|
|
writing to MIO's PCI address space at predefined offsets.
|
|
|
|
|
|
|
|
MIO includes a DMA controller that offers 15 DMA channels implementing
|
|
|
|
Apple's own DMA protocol called descriptor-based DMA (DBDMA).
|
|
|
|
|
|
|
|
Official documentation (that is somewhat incomplete and erroneous) can be
|
|
|
|
found in the second chapter of the book "Macintosh Technology in the Common
|
|
|
|
Hardware Reference Platform" by Apple Computer, Inc.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef MACIO_H
|
|
|
|
#define MACIO_H
|
|
|
|
|
2021-10-23 18:17:47 +00:00
|
|
|
#include <devices/common/dbdma.h>
|
|
|
|
#include <devices/common/mmiodevice.h>
|
|
|
|
#include <devices/common/nvram.h>
|
2022-10-22 18:41:52 +00:00
|
|
|
#include <devices/common/ide/ide_hd.h>
|
2021-10-23 18:17:47 +00:00
|
|
|
#include <devices/common/pci/pcidevice.h>
|
|
|
|
#include <devices/common/pci/pcihost.h>
|
|
|
|
#include <devices/common/scsi/mesh.h>
|
2022-03-27 10:58:48 +00:00
|
|
|
#include <devices/common/scsi/sc53c94.h>
|
2021-10-23 18:17:47 +00:00
|
|
|
#include <devices/common/viacuda.h>
|
2022-03-13 20:02:39 +00:00
|
|
|
#include <devices/ethernet/mace.h>
|
2021-12-12 20:40:04 +00:00
|
|
|
#include <devices/floppy/swim3.h>
|
2021-10-23 18:17:47 +00:00
|
|
|
#include <devices/memctrl/memctrlbase.h>
|
2021-10-25 20:19:27 +00:00
|
|
|
#include <devices/serial/escc.h>
|
2021-10-23 18:17:47 +00:00
|
|
|
#include <devices/sound/awacs.h>
|
|
|
|
|
2020-05-12 18:55:45 +00:00
|
|
|
#include <cinttypes>
|
2021-10-24 22:26:02 +00:00
|
|
|
#include <memory>
|
2019-08-23 21:34:19 +00:00
|
|
|
|
2022-03-14 17:09:11 +00:00
|
|
|
/** Interrupt related constants. */
|
|
|
|
#define MACIO_INT_CLR 0x80UL // clears bits in the interrupt events registers
|
|
|
|
#define MACIO_INT_MODE 0x80000000UL // interrupt mode: 0 - native, 1 - 68k-style
|
|
|
|
|
2022-03-13 20:02:39 +00:00
|
|
|
/** Offsets to common MacIO interrupt registers. */
|
|
|
|
enum {
|
|
|
|
MIO_INT_EVENTS2 = 0x10,
|
|
|
|
MIO_INT_MASK2 = 0x14,
|
|
|
|
MIO_INT_CLEAR2 = 0x18,
|
|
|
|
MIO_INT_LEVELS2 = 0x1C,
|
|
|
|
MIO_INT_EVENTS1 = 0x20,
|
|
|
|
MIO_INT_MASK1 = 0x24,
|
|
|
|
MIO_INT_CLEAR1 = 0x28,
|
|
|
|
MIO_INT_LEVELS1 = 0x2C
|
|
|
|
};
|
|
|
|
|
2022-08-07 13:19:27 +00:00
|
|
|
class IobusDevice {
|
|
|
|
public:
|
|
|
|
virtual uint16_t iodev_read(uint32_t address) = 0;
|
|
|
|
virtual void iodev_write(uint32_t address, uint16_t value) = 0;
|
|
|
|
};
|
|
|
|
|
2022-03-13 20:02:39 +00:00
|
|
|
class GrandCentral : public PCIDevice, public InterruptCtrl {
|
|
|
|
public:
|
|
|
|
GrandCentral();
|
|
|
|
~GrandCentral() = default;
|
|
|
|
|
2022-07-15 18:52:13 +00:00
|
|
|
static std::unique_ptr<HWComponent> create() {
|
|
|
|
return std::unique_ptr<GrandCentral>(new GrandCentral());
|
|
|
|
}
|
|
|
|
|
2022-03-13 20:02:39 +00:00
|
|
|
// MMIO device methods
|
2022-08-22 10:16:31 +00:00
|
|
|
uint32_t read(uint32_t rgn_start, uint32_t offset, int size);
|
|
|
|
void write(uint32_t rgn_start, uint32_t offset, uint32_t value, int size);
|
2022-03-13 20:02:39 +00:00
|
|
|
|
|
|
|
// InterruptCtrl methods
|
|
|
|
uint32_t register_dev_int(IntSrc src_id);
|
|
|
|
uint32_t register_dma_int(IntSrc src_id);
|
|
|
|
void ack_int(uint32_t irq_id, uint8_t irq_line_state);
|
|
|
|
void ack_dma_int(uint32_t irq_id, uint8_t irq_line_state);
|
|
|
|
|
2022-08-07 13:19:27 +00:00
|
|
|
void attach_iodevice(int dev_num, IobusDevice* dev_obj);
|
|
|
|
|
2022-03-13 20:02:39 +00:00
|
|
|
protected:
|
|
|
|
void notify_bar_change(int bar_num);
|
|
|
|
|
|
|
|
private:
|
|
|
|
uint32_t base_addr = 0;
|
2022-03-28 16:25:41 +00:00
|
|
|
|
2022-07-19 23:36:45 +00:00
|
|
|
uint8_t emmo_pin; // factory tester status, active low
|
|
|
|
|
2022-03-28 16:25:41 +00:00
|
|
|
// interrupt state
|
2022-08-24 12:02:44 +00:00
|
|
|
uint32_t int_mask = 0;
|
|
|
|
uint32_t int_levels = 0;
|
|
|
|
uint32_t int_events = 0;
|
|
|
|
bool cpu_int_latch = false;
|
2022-03-13 20:02:39 +00:00
|
|
|
|
|
|
|
uint32_t nvram_addr_hi;
|
|
|
|
|
2022-08-07 13:19:27 +00:00
|
|
|
// IOBus devices
|
|
|
|
IobusDevice* iobus_devs[6] = { nullptr };
|
|
|
|
|
2022-07-18 09:48:23 +00:00
|
|
|
// subdevice objects
|
2022-06-13 21:15:48 +00:00
|
|
|
std::unique_ptr<AwacsScreamer> awacs; // AWACS audio codec instance
|
2022-07-18 09:48:23 +00:00
|
|
|
|
|
|
|
NVram* nvram; // NVRAM module
|
|
|
|
MaceController* mace;
|
|
|
|
ViaCuda* viacuda; // VIA cell with Cuda MCU attached to it
|
|
|
|
EsccController* escc; // ESCC serial controller
|
2022-10-22 18:41:52 +00:00
|
|
|
IdeHardDisk* ide_0; // Internal ATA
|
2022-07-18 09:48:23 +00:00
|
|
|
Sc53C94* scsi_0; // external SCSI
|
|
|
|
Swim3::Swim3Ctrl* swim3; // floppy disk controller
|
2022-03-13 20:02:39 +00:00
|
|
|
|
|
|
|
std::unique_ptr<DMAChannel> snd_out_dma;
|
|
|
|
};
|
|
|
|
|
2019-08-23 21:34:19 +00:00
|
|
|
/**
|
|
|
|
Heathrow ASIC emulation
|
|
|
|
|
|
|
|
Heathrow is a MIO-compliant ASIC used in the Gossamer architecture. It's
|
|
|
|
hard-wired to PCI device number 16. Its I/O memory (512Kb) will be configured
|
|
|
|
by the Macintosh firmware to live at 0xF3000000.
|
|
|
|
|
|
|
|
Emulated subdevices and their offsets within Heathrow I/O space:
|
|
|
|
----------------------------------------------------------------
|
|
|
|
mesh(SCSI) register space: 0x00010000, DMA space: 0x00008000
|
|
|
|
bmac(ethernet) register space: 0x00011000, DMA space: 0x00008200, 0x00008300
|
2021-10-25 20:19:27 +00:00
|
|
|
escc(compat) register space: 0x00012000, size: 0x00001000
|
|
|
|
DMA space: 0x00008400, size: 0x00000400
|
|
|
|
escc(MacRISC) register space: 0x00013000, size: 0x00001000
|
2019-08-23 21:34:19 +00:00
|
|
|
DMA space: 0x00008400, size: 0x00000400
|
|
|
|
escc:ch-a register space: 0x00013020, DMA space: 0x00008400, 0x00008500
|
|
|
|
escc:ch-b register space: 0x00013000, DMA space: 0x00008600, 0x00008700
|
|
|
|
davbus(sound) register space: 0x00014000, DMA space: 0x00008800, 0x00008900
|
|
|
|
SWIM3(floppy) register space: 0x00015000, DMA space: 0x00008100
|
|
|
|
NVRAM register space: 0x00060000, size: 0x00020000
|
|
|
|
IDE register space: 0x00020000, DMA space: 0x00008b00
|
|
|
|
VIA-CUDA register space: 0x00016000, size: 0x00002000
|
|
|
|
*/
|
|
|
|
|
2022-07-20 18:08:37 +00:00
|
|
|
/** Heathrow specific registers. */
|
|
|
|
enum {
|
|
|
|
MIO_HEAT_ID = 0x34, // IDs register
|
|
|
|
MIO_HEAT_FEAT_CTRL = 0x38, // feature control register
|
|
|
|
};
|
|
|
|
|
2022-03-13 20:00:16 +00:00
|
|
|
class HeathrowIC : public PCIDevice, public InterruptCtrl {
|
2019-08-23 21:34:19 +00:00
|
|
|
public:
|
2019-08-27 12:14:12 +00:00
|
|
|
HeathrowIC();
|
2021-10-24 22:26:02 +00:00
|
|
|
~HeathrowIC() = default;
|
2019-08-23 21:34:19 +00:00
|
|
|
|
2022-07-15 18:52:13 +00:00
|
|
|
static std::unique_ptr<HWComponent> create() {
|
|
|
|
return std::unique_ptr<HeathrowIC>(new HeathrowIC());
|
|
|
|
}
|
|
|
|
|
2022-03-13 20:00:16 +00:00
|
|
|
// MMIO device methods
|
2022-08-22 10:16:31 +00:00
|
|
|
uint32_t read(uint32_t rgn_start, uint32_t offset, int size);
|
|
|
|
void write(uint32_t rgn_start, uint32_t offset, uint32_t value, int size);
|
2019-08-23 21:34:19 +00:00
|
|
|
|
2022-03-13 20:00:16 +00:00
|
|
|
// InterruptCtrl methods
|
|
|
|
uint32_t register_dev_int(IntSrc src_id);
|
|
|
|
uint32_t register_dma_int(IntSrc src_id);
|
|
|
|
void ack_int(uint32_t irq_id, uint8_t irq_line_state);
|
|
|
|
void ack_dma_int(uint32_t irq_id, uint8_t irq_line_state);
|
|
|
|
|
2019-08-27 12:14:12 +00:00
|
|
|
protected:
|
2020-03-18 16:34:03 +00:00
|
|
|
uint32_t dma_read(uint32_t offset, int size);
|
|
|
|
void dma_write(uint32_t offset, uint32_t value, int size);
|
|
|
|
|
2019-08-27 12:14:12 +00:00
|
|
|
uint32_t mio_ctrl_read(uint32_t offset, int size);
|
|
|
|
void mio_ctrl_write(uint32_t offset, uint32_t value, int size);
|
|
|
|
|
2022-03-13 20:00:16 +00:00
|
|
|
void notify_bar_change(int bar_num);
|
|
|
|
|
2021-11-09 12:41:48 +00:00
|
|
|
void feature_control(const uint32_t value);
|
2022-08-24 12:14:42 +00:00
|
|
|
void clear_cpu_int();
|
2021-11-09 12:41:48 +00:00
|
|
|
|
2019-08-23 21:34:19 +00:00
|
|
|
private:
|
2022-08-24 12:14:42 +00:00
|
|
|
uint32_t base_addr = 0;
|
|
|
|
uint32_t int_events2 = 0;
|
|
|
|
uint32_t int_mask2 = 0;
|
|
|
|
uint32_t int_levels2 = 0;
|
|
|
|
uint32_t int_events1 = 0;
|
|
|
|
uint32_t int_mask1 = 0;
|
|
|
|
uint32_t int_levels1 = 0;
|
|
|
|
uint32_t feat_ctrl = 0; // features control register
|
|
|
|
uint32_t aux_ctrl = 0; // aux features control register
|
|
|
|
bool cpu_int_latch = false;
|
2019-08-27 12:14:12 +00:00
|
|
|
|
2022-07-20 18:08:37 +00:00
|
|
|
uint8_t cpu_id = 0xE0; // CPUID field (LSB of the MIO_HEAT_ID)
|
|
|
|
uint8_t mb_id = 0x70; // Media Bay ID (bits 15:8 of the MIO_HEAT_ID)
|
|
|
|
uint8_t mon_id = 0x10; // Monitor ID (bits 23:16 of the MIO_HEAT_ID)
|
|
|
|
uint8_t fp_id = 0x70; // Flat panel ID (MSB of the MIO_HEAT_ID)
|
|
|
|
uint8_t emmo_pin; // factory tester status, active low
|
|
|
|
|
2022-07-18 09:48:23 +00:00
|
|
|
// subdevice objects
|
2021-12-12 20:40:04 +00:00
|
|
|
std::unique_ptr<AwacsScreamer> screamer; // Screamer audio codec instance
|
2022-07-18 09:48:23 +00:00
|
|
|
|
|
|
|
NVram* nvram; // NVRAM
|
|
|
|
ViaCuda* viacuda; // VIA cell with Cuda MCU attached to it
|
|
|
|
MESHController* mesh; // MESH SCSI cell instance
|
|
|
|
EsccController* escc; // ESCC serial controller
|
2022-10-22 18:41:52 +00:00
|
|
|
IdeHardDisk* ide_0; // Internal ATA
|
2022-07-18 09:48:23 +00:00
|
|
|
Swim3::Swim3Ctrl* swim3; // floppy disk controller
|
2020-03-18 16:34:03 +00:00
|
|
|
|
2022-07-18 09:48:23 +00:00
|
|
|
std::unique_ptr<DMAChannel> snd_out_dma;
|
2019-08-23 21:34:19 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif /* MACIO_H */
|