demistify_config_pkg.vhd

-- DeMiSTifyConfig_pkg.vhd
-- Copyright 2021 by Alastair M. Robinson

library ieee;
use ieee.std_logic_1164.all;

package demistify_config_pkg is
constant demistify_romspace : integer := 14; -- 16k address space to accommodate 12K of ROM
constant demistify_romsize1 : integer := 13; -- 8k for the first chunk
constant demistify_romsize2 : integer := 12; -- 4k for the second chunk

-- Core-specific button mapping.
-- Joysticks are (currently) 8 bits width, with the directions in the lower four bits.
-- Button 1 is the main fire button, Button 2 is the secondary fire button to the right of button 1
-- Button 3 is a third (possibly less conveniently placed) button 
-- Button 4 is mapped as a "start" or "run" button.

-- By adjusting the following constants you can assign each button a place in the joystick bitmap.
-- The Megadrive core, for instance, expects the following bitmap:
-- start(7) C(6) B(5) A(4) directions(3:0)
-- Since Megadrive button B is the most important, we map button 1 -> B, button 2 -> C, button 3 -> A
-- and button 4 -> Start, hence button1 = 5, button2 = 6, button3 = 4 and button4 = 7,

constant demistify_button1 : integer := 4;
constant demistify_button2 : integer := 5;
constant demistify_button3 : integer := 6;
constant demistify_button4 : integer := 7;

constant demistify_serialdebug : std_logic := '0';


	-- Declare the guest component
	
	COMPONENT vic20_mist -- Rename to match the guest core
		PORT
		(
			CLOCK_27 :	IN STD_LOGIC;	-- Comment out one of these two lines
--			CLOCK_27 :	IN STD_LOGIC_VECTOR(1 downto 0);	-- to match the guest core
			LED : OUT STD_LOGIC;
			SDRAM_DQ		:	 INOUT STD_LOGIC_VECTOR(15 DOWNTO 0);
			SDRAM_A			:	 OUT STD_LOGIC_VECTOR(12 DOWNTO 0);
			SDRAM_DQML		:	 OUT STD_LOGIC;
			SDRAM_DQMH		:	 OUT STD_LOGIC;
			SDRAM_nWE		:	 OUT STD_LOGIC;
			SDRAM_nCAS		:	 OUT STD_LOGIC;
			SDRAM_nRAS		:	 OUT STD_LOGIC;
			SDRAM_nCS		:	 OUT STD_LOGIC;
			SDRAM_BA		:	 OUT STD_LOGIC_VECTOR(1 DOWNTO 0);
			SDRAM_CLK		:	 OUT STD_LOGIC;
			SDRAM_CKE		:	 OUT STD_LOGIC;
			UART_TX    :   OUT STD_LOGIC;
			UART_RX    :   IN STD_LOGIC :='1';
			SPI_DO		:	 OUT STD_LOGIC;
	-- 		We can't do bi-directional signals here, so we need separate in and out signals.
	--		If the guest core uses direct mode for ROM upload it will need to be adapted.
	--		SPI_SD_DI	:	 IN STD_LOGIC;
			SPI_DI		:	 IN STD_LOGIC;
			SPI_SCK		:	 IN STD_LOGIC;
			SPI_SS2		:	 IN STD_LOGIC;
			SPI_SS3		:	 IN STD_LOGIC;
	--		SPI_SS4		:	 IN STD_LOGIC;
			CONF_DATA0	:	 IN STD_LOGIC;
			AUDIO_L  : out std_logic;
			AUDIO_R  : out std_logic;
			VGA_HS		:	 OUT STD_LOGIC;
			VGA_VS		:	 OUT STD_LOGIC;
			VGA_R		:	 OUT STD_LOGIC_VECTOR(5 DOWNTO 0);
			VGA_G		:	 OUT STD_LOGIC_VECTOR(5 DOWNTO 0);
			VGA_B		:	 OUT STD_LOGIC_VECTOR(5 DOWNTO 0);
				VGA_DE  : out std_logic;
				VGA_CLK : out std_logic;
				vga_x_r : out STD_LOGIC_VECTOR(5 DOWNTO 0);
				vga_x_g : out STD_LOGIC_VECTOR(5 DOWNTO 0);
				vga_x_b : out STD_LOGIC_VECTOR(5 DOWNTO 0);
				vga_x_hs : out std_logic;
				vga_x_vs : out std_logic;
				HDMI_CLK : out std_logic;
				-- DAC_L  : OUT SIGNED(15 DOWNTO 0);
            	-- DAC_R  : OUT SIGNED(15 DOWNTO 0);
	 			DAC_L     : OUT STD_LOGIC_VECTOR (15 DOWNTO 0);
    			DAC_R     : OUT STD_LOGIC_VECTOR (15 DOWNTO 0);
			PS2_CLK_IN : in std_logic :='1';
			PS2_DAT_IN : in std_logic :='1';
			C64_KEYS : in std_logic_vector(64 downto 0) := (others=>'1');
			TAPE_BUTTON_N : in std_logic := '1';
			IEC_ATN_I : in std_logic := '1';
			IEC_DATA_I : in std_logic := '1';
			IEC_CLK_I : in std_logic := '1';
			IEC_ATN_O : out std_logic;
			IEC_DATA_O : out std_logic;
			IEC_CLK_O : out std_logic
		);
	END COMPONENT;
	

end package;