/***************************************************************************

Ms.Pac-Man/Galaga - 20 Year Reunion

driver by Nicola Salmoria

Notes:
- There are four start buttons: the first two are for Ms. Pac-Man, the other two
  for Galaga.

- To play Pac-Man instead of Ms. Pac-Man, insert coins then enter the following
  sequence: U U U D D D L R L R L. A sound will play and the ghost will change
  from red to pink.

- Writes to the Z180 ASCI port:
  MS PAC-MAN/GALAGA
  arcade video system
  version 1.01
  (c) 2000 Cosmodog, Ltd.
  >
  and it listens for incoming characters.


TODO:
- Starfield.

- Convert to tilemaps & optimize video rendering, I was just too lazy to do it for now.

- Check the ASCI interface, there probably is fully working debug code.

- The timed interrupt is a kludge; it is supposed to be generated internally by
  the Z180, but the cpu core doesn't support that yet.

- Correct CPU speed... Zilog says Z180 comes in 6, 8, 10, 20 & 33MHz.
  20MHz is used as it "seems" right based on the music in Galaga

***************************************************************************/

#include "driver.h"
#include "machine/eeprom.h"
#include "cpu/z180/z180.h"
#include "pacman.h"
#include "sound/namco.h"
#include "sound/dac.h"

extern UINT8 *pacgal_charram,*pacgal_sprram;
extern UINT8 *pacgal_videoram,*pacgal_videoram2;
PALETTE_INIT( 20pacgal );
VIDEO_START( 20pacgal );
WRITE8_HANDLER( pacgal_lookup_w );
WRITE8_HANDLER( pacgal_active_game_w );
WRITE8_HANDLER( pacgal_videoram2_w );
WRITE8_HANDLER( pacgal_charram_w );
WRITE8_HANDLER( pacgal_sprram_w );
VIDEO_UPDATE( 20pacgal );



static const struct EEPROM_interface eeprom_interface =
{
	7,				/* address bits */
	8,				/* data bits */
	"*110",			/*  read command */
	"*101",			/* write command */
	0,				/* erase command */
	"*10000xxxxx",	/* lock command */
	"*10011xxxxx",	/* unlock command */
};

static NVRAM_HANDLER( eeprom )
{
	if (read_or_write)
		EEPROM_save(file);
	else
	{
		EEPROM_init(&eeprom_interface);

		if (file)
			EEPROM_load(file);
	}
}

static READ8_HANDLER( eeprom_r )
{
	int res;

	/* bit 7 is EEPROM data */
	res = EEPROM_read_bit() << 7;
	return res;
}

static WRITE8_HANDLER( eeprom_w )
{
	/* bit 7 is data */
	/* bit 6 is clock (active high) */
	/* bit 5 is cs (active low) */
	EEPROM_write_bit(data & 0x80);
	EEPROM_set_cs_line((data & 0x20) ? CLEAR_LINE : ASSERT_LINE);
	EEPROM_set_clock_line((data & 0x40) ? ASSERT_LINE : CLEAR_LINE);
}

static WRITE8_HANDLER( irqack_w )
{
	int bit = data & 1;
	cpu_interrupt_enable(0,bit);
	if (!bit)
		cpunum_set_input_line( 0, 0, CLEAR_LINE );
}

static WRITE8_HANDLER( flipscreen_w )
{
	flip_screen_set(data & 1);
}

static WRITE8_HANDLER( pacgal_dac_w )
{
	DAC_signed_data_w(0, data);
}

static WRITE8_HANDLER( coin_w )
{
	coin_counter_w(0,data & 1);
}



static ADDRESS_MAP_START( 20pacgal_map, ADDRESS_SPACE_PROGRAM, 8 )
	AM_RANGE(0x00000, 0x03fff) AM_ROM
	AM_RANGE(0x08000, 0x09fff) AM_ROM
	AM_RANGE(0x0a000, 0x0ffff) AM_MIRROR(0x40000) AM_ROM
	AM_RANGE(0x10000, 0x3ffff) AM_ROM
	AM_RANGE(0x44000, 0x447ff) AM_RAM AM_BASE(&pacgal_videoram)						// mspacman tilemap
	AM_RANGE(0x45040, 0x4505f) AM_WRITE(pacman_sound_w) AM_BASE(&namco_soundregs)
	AM_RANGE(0x44800, 0x45eff) AM_RAM
	AM_RANGE(0x45f00, 0x45fff) AM_WRITE(_20pacgal_wavedata_w) AM_BASE(&namco_wavedata) // sound wave data
	AM_RANGE(0x46000, 0x46fff) AM_WRITE(pacgal_charram_w) AM_BASE(&pacgal_charram)	// char gfx data
	AM_RANGE(0x47100, 0x47100) AM_RAM						// leftover from original Galaga code
	AM_RANGE(0x48000, 0x49fff) AM_ROM AM_BASE(&pacgal_videoram2)
	AM_RANGE(0x48000, 0x49fff) AM_WRITE(pacgal_videoram2_w)							// ROM or galaga tilemap (banked)
	AM_RANGE(0x4c000, 0x4dfff) AM_WRITE(pacgal_sprram_w) AM_BASE(&pacgal_sprram)	// sprite gfx data
	AM_RANGE(0x4e000, 0x4e17f) AM_WRITE(MWA8_RAM) AM_BASE(&spriteram)				// sprite registers
	AM_RANGE(0x4ff00, 0x4ffff) AM_WRITE(pacgal_lookup_w)							// sprite color lookup table
ADDRESS_MAP_END

static ADDRESS_MAP_START( 20pacgal_port, ADDRESS_SPACE_IO, 8 )
	ADDRESS_MAP_FLAGS( AMEF_ABITS(8) )
	AM_RANGE(0x00, 0x3f) AM_NOP /* Z180 internal registers */
	AM_RANGE(0x40, 0x7f) AM_NOP	/* Z180 internal registers */
	AM_RANGE(0x80, 0x80) AM_READ(input_port_0_r)
	AM_RANGE(0x81, 0x81) AM_READ(input_port_1_r)
	AM_RANGE(0x82, 0x82) AM_READ(input_port_2_r)
	AM_RANGE(0x80, 0x80) AM_WRITE(watchdog_reset_w)
	AM_RANGE(0x81, 0x81) AM_WRITE(MWA8_NOP)				// ??? pulsed by the timer irq
	AM_RANGE(0x82, 0x82) AM_WRITE(irqack_w)
	AM_RANGE(0x85, 0x86) AM_WRITE(MWA8_NOP)				// stars: rng seed (lo/hi)
	AM_RANGE(0x87, 0x87) AM_READWRITE(eeprom_r, eeprom_w)
	AM_RANGE(0x88, 0x88) AM_WRITE(pacgal_active_game_w)
	AM_RANGE(0x89, 0x89) AM_WRITE(pacgal_dac_w)
	AM_RANGE(0x8a, 0x8a) AM_WRITE(MWA8_NOP)				// stars: bits 3-4 = active set; bit 5 = enable
	AM_RANGE(0x8b, 0x8b) AM_WRITE(flipscreen_w)
	AM_RANGE(0x8f, 0x8f) AM_WRITE(coin_w)				// coin counter
ADDRESS_MAP_END



static INPUT_PORTS_START( 20pacgal )
	PORT_START
	PORT_BIT( 0x01, IP_ACTIVE_LOW, IPT_JOYSTICK_UP    )
	PORT_BIT( 0x02, IP_ACTIVE_LOW, IPT_JOYSTICK_LEFT  )
	PORT_BIT( 0x04, IP_ACTIVE_LOW, IPT_JOYSTICK_RIGHT )
	PORT_BIT( 0x08, IP_ACTIVE_LOW, IPT_JOYSTICK_DOWN  )
	PORT_BIT( 0x10, IP_ACTIVE_LOW, IPT_BUTTON1 ) PORT_COCKTAIL
	PORT_BIT( 0x20, IP_ACTIVE_LOW, IPT_COIN1 )
	PORT_BIT( 0x40, IP_ACTIVE_LOW, IPT_COIN2 )
	PORT_BIT( 0x80, IP_ACTIVE_LOW, IPT_BUTTON1 )

	PORT_START
	PORT_BIT( 0x01, IP_ACTIVE_LOW, IPT_JOYSTICK_UP    ) PORT_COCKTAIL
	PORT_BIT( 0x02, IP_ACTIVE_LOW, IPT_JOYSTICK_LEFT  ) PORT_COCKTAIL
	PORT_BIT( 0x04, IP_ACTIVE_LOW, IPT_JOYSTICK_RIGHT ) PORT_COCKTAIL
	PORT_BIT( 0x08, IP_ACTIVE_LOW, IPT_JOYSTICK_DOWN  ) PORT_COCKTAIL
	PORT_BIT( 0x10, IP_ACTIVE_LOW, IPT_START3 )
	PORT_BIT( 0x20, IP_ACTIVE_LOW, IPT_START1 )
	PORT_BIT( 0x40, IP_ACTIVE_LOW, IPT_START2 )
	PORT_BIT( 0x80, IP_ACTIVE_LOW, IPT_START4 )

	PORT_START
	PORT_BIT( 0x01, IP_ACTIVE_LOW, IPT_UNKNOWN )
	PORT_BIT( 0x02, IP_ACTIVE_LOW, IPT_UNKNOWN )
	PORT_BIT( 0x04, IP_ACTIVE_LOW, IPT_UNKNOWN )
	PORT_BIT( 0x08, IP_ACTIVE_LOW, IPT_UNKNOWN )
	PORT_BIT( 0x10, IP_ACTIVE_LOW, IPT_UNKNOWN )
	PORT_BIT( 0x20, IP_ACTIVE_LOW, IPT_UNKNOWN )
	PORT_BIT( 0x40, IP_ACTIVE_LOW, IPT_UNKNOWN )
	PORT_BIT( 0x80, IP_ACTIVE_LOW, IPT_SERVICE ) PORT_NAME( DEF_STR( Service_Mode )) PORT_CODE(KEYCODE_F2)
INPUT_PORTS_END



static const gfx_layout charlayout =
{
	8,8,
	256,
	2,
	{ 0, 4 },
	{ 8*8+0, 8*8+1, 8*8+2, 8*8+3, 0, 1, 2, 3 },
	{ 0*8, 1*8, 2*8, 3*8, 4*8, 5*8, 6*8, 7*8 },
	16*8
};


static const gfx_layout spritelayout =
{
	16,16,
	128,
	2,
	{ 0, 1 },
	{ 0*2, 1*2, 2*2, 3*2, 4*2, 5*2, 6*2, 7*2, 8*2, 9*2, 10*2, 11*2, 12*2, 13*2, 14*2, 15*2 },
	{ 0*32, 1*32, 2*32, 3*32, 4*32, 5*32, 6*32, 7*32, 8*32, 9*32, 10*32, 11*32, 12*32, 13*32, 14*32, 15*32 },
	16*32
};

static GFXDECODE_START( 20pacgal )
	/* the game dynamically modifies these */
	GFXDECODE_ENTRY( 0, 0, charlayout,   0, 64 )
	GFXDECODE_ENTRY( 0, 0, spritelayout, 0, 64 )
GFXDECODE_END

static const struct namco_interface namco_interface =
{
	3,	/* number of voices */
	-1,	/* memory region */
};

static MACHINE_DRIVER_START( 20pacgal )

	/* basic machine hardware */
	MDRV_CPU_ADD(Z180,20000000)	/* 20MHz ??? Needs to be verified! */
	MDRV_CPU_PROGRAM_MAP(20pacgal_map,0)
	MDRV_CPU_IO_MAP(20pacgal_port,0)
	MDRV_CPU_VBLANK_INT(irq0_line_assert,1)

	MDRV_SCREEN_REFRESH_RATE(60)
	MDRV_SCREEN_VBLANK_TIME(DEFAULT_60HZ_VBLANK_DURATION)

	MDRV_NVRAM_HANDLER(eeprom)

	/* video hardware */
	MDRV_VIDEO_ATTRIBUTES(VIDEO_TYPE_RASTER)
	MDRV_SCREEN_FORMAT(BITMAP_FORMAT_INDEXED16)
	MDRV_SCREEN_SIZE(36*8, 28*8)
	MDRV_SCREEN_VISIBLE_AREA(0*8, 36*8-1, 0*8, 28*8-1)
	MDRV_GFXDECODE(20pacgal)
	MDRV_PALETTE_LENGTH(0x1000)
	MDRV_COLORTABLE_LENGTH(0x100)
	MDRV_PALETTE_INIT(20pacgal)
	MDRV_VIDEO_START(20pacgal)
	MDRV_VIDEO_UPDATE(20pacgal)

	/* sound hardware */
	MDRV_SPEAKER_STANDARD_MONO("mono")

	MDRV_SOUND_ADD(NAMCO, 18432000/6/32)
	MDRV_SOUND_CONFIG(namco_interface)
	MDRV_SOUND_ROUTE(ALL_OUTPUTS, "mono", 1.0)

	MDRV_SOUND_ADD(DAC, 0)
	MDRV_SOUND_ROUTE(ALL_OUTPUTS, "mono", 1.0)
MACHINE_DRIVER_END



/***************************************************************************

  Game driver(s)

***************************************************************************/

ROM_START( 20pacgal )
	ROM_REGION( 0x100000, REGION_CPU1, 0 )	/* 1024k for Z180 address space */
	ROM_LOAD( "20th_101.u13", 0x00000, 0x40000, CRC(77159582) SHA1(c05e005a941cbdc806dcd76b315069362c792a72) )

	ROM_REGION( 0x8000, REGION_PROMS, 0 )	/* palette */
	ROM_LOAD( "20th_101.u14", 0x0000, 0x8000, CRC(c19d9ad0) SHA1(002581fbc2c32cdf7cfb0b0f64061591a462ec14) )
ROM_END



GAME( 2000, 20pacgal, 0, 20pacgal, 20pacgal, 0, ROT90, "Namco", "Ms. Pac-Man/Galaga - 20 Year Reunion", GAME_IMPERFECT_GRAPHICS )
