romdev-mcp 0.1.1

package/src/platforms/snes/lib/pvsneslib/include/snes/dma.h

@@ -0,0 +1,381 @@
+/*---------------------------------------------------------------------------------
+
+    Copyright (C) 2012-2017
+        Alekmaul
+
+
+    This software is provided 'as-is', without any express or implied
+    warranty.  In no event will the authors be held liable for any
+    damages arising from the use of this software.
+
+    Permission is granted to anyone to use this software for any
+    purpose, including commercial applications, and to alter it and
+    redistribute it freely, subject to the following restrictions:
+
+    1.	The origin of this software must not be misrepresented; you
+        must not claim that you wrote the original software. If you use
+        this software in a product, an acknowledgment in the product
+        documentation would be appreciated but is not required.
+
+    2.	Altered source versions must be plainly marked as such, and
+        must not be misrepresented as being the original software.
+
+    3.	This notice may not be removed or altered from any source
+        distribution.
+
+---------------------------------------------------------------------------------*/
+/*! \file dma.h
+\brief Wrapper functions for direct memory access hardware
+
+*/
+#ifndef SNES_DMA_INCLUDE
+#define SNES_DMA_INCLUDE
+
+#include <snes/snestypes.h>
+
+#include <snes/background.h>
+#include <snes/sprite.h>
+#include <snes/video.h>
+
+/*!	\brief Bit defines for the HDMA channels */
+#define HDMA_CHANNEL0			(1 << 0)
+#define HDMA_CHANNEL1			(1 << 1)
+#define HDMA_CHANNEL2			(1 << 2)
+#define HDMA_CHANNEL3			(1 << 3)
+#define HDMA_CHANNEL4			(1 << 4)
+#define HDMA_CHANNEL5			(1 << 5)
+#define HDMA_CHANNEL6			(1 << 6)
+#define HDMA_CHANNEL7			(1 << 7)
+#define HDMA_CHANNELALL			(HDMA_CHANNEL0 | HDMA_CHANNEL1 | HDMA_CHANNEL2 | HDMA_CHANNEL3 | HDMA_CHANNEL4 | HDMA_CHANNEL5 | HDMA_CHANNEL6 | HDMA_CHANNEL7)
+
+/*!	\brief Bit defines for the window area main screen effect */
+#define MSWIN_BG1               (1 << 0) /*!< \brief Main Screen BG1 disable background */
+#define MSWIN_BG2               (1 << 1) /*!< \brief Main Screen BG2 disable background */
+#define MSWIN_BG3               (1 << 2) /*!< \brief Main Screen BG3 disable background */
+#define MSWIN_BG4               (1 << 3) /*!< \brief Main Screen BG4 disable background */
+
+#define MSWIN1_BG1MSKOUT        (1 << 0) /*!< \brief Window 1 area BG1 inside (0) outside(1) */
+#define MSWIN1_BG1MSKENABLE     (2 << 0) /*!< \brief Window 1 area BG1 enable */
+#define MSWIN2_BG1MSKOUT        (1 << 2) /*!< \brief Window 2 area BG1 inside (0) outside(1) */
+#define MSWIN2_BG1MSKENABLE     (2 << 2) /*!< \brief Window 2 area BG1 enable */
+#define MSWIN1_BG2MSKOUT        (1 << 4) /*!< \brief Window 1 area BG2 inside (0) outside(1) */
+#define MSWIN1_BG2MSKENABLE     (2 << 4) /*!< \brief Window 1 area BG2 enable */
+#define MSWIN2_BG2MSKOUT        (1 << 4) /*!< \brief Window 2 area BG2 inside (0) outside(1) */
+#define MSWIN2_BG2MSKENABLE     (2 << 4) /*!< \brief Window 2 area BG2 enable */
+#define MSWIN1_BG3MSKOUT        (1 << 0) /*!< \brief Window 1 area BG3 inside (0) outside(1) */
+#define MSWIN1_BG3MSKENABLE     (2 << 0) /*!< \brief Window 1 area BG3 enable */
+#define MSWIN2_BG3MSKOUT        (1 << 2) /*!< \brief Window 2 area BG3 inside (0) outside(1) */
+#define MSWIN2_BG3MSKENABLE     (2 << 2) /*!< \brief Window 2 area BG3 enable */
+#define MSWIN1_BG4MSKOUT        (1 << 4) /*!< \brief Window 1 area BG4 inside (0) outside(1) */
+#define MSWIN1_BG4MSKENABLE     (2 << 4) /*!< \brief Window 1 area BG4 enable */
+#define MSWIN2_BG4MSKOUT        (1 << 4) /*!< \brief Window 2 area BG4 inside (0) outside(1) */
+#define MSWIN2_BG4MSKENABLE     (2 << 4) /*!< \brief Window 2 area BG4 enable */
+
+/*!	\brief Bit defines for the DMA control registers */
+#define DMA_ENABLE 1
+
+typedef struct dmaMemory
+{
+    union
+    {
+        struct
+        {
+            unsigned short addr;
+            unsigned char bank;
+            unsigned char __pad;
+        } c;
+        void *p;
+    } mem;
+} dmaMemory;
+
+/*! \def REG_MDMAEN
+
+    \brief Select General Purpose DMA Channel(s) and Start Transfer (W)
+     7-0   General Purpose DMA Channel 7-0 Enable (0=Disable, 1=Enable)
+
+    When writing a non-zero value to this register, general purpose DMA
+    will be started immediately (after a few clk cycles). The CPU is paused
+    during the transfer. The transfer can be interrupted by H-DMA transfers.
+    If more than 1 bit is set in MDMAEN, then the separate transfers will be
+    executed in WHICH? priority order. The MDMAEN bits are cleared automatically
+    at transfer completion.
+    Do not use channels for GP-DMA which are activated as H-DMA in HDMAEN.
+
+*/
+#define REG_MDMAEN (*(vuint8 *)0x420B)
+
+/*! \def REG_HDMAEN
+
+    \brief Select H-Blank DMA (H-DMA) Channel(s) (W)
+     7-0   H-DMA Channel 7-0 Enable (0=Disable, 1=Enable)
+*/
+#define REG_HDMAEN (*(vuint8 *)0x420C)
+
+/*! \def REG_DMAP0
+    \def REG_DMAP1	(*(vuint8*)0x4310)
+    \def REG_DMAP2	(*(vuint8*)0x4320)
+    \def REG_DMAP3	(*(vuint8*)0x4330)
+    \def REG_DMAP4	(*(vuint8*)0x4340)
+    \def REG_DMAP5	(*(vuint8*)0x4350)
+    \def REG_DMAP6	(*(vuint8*)0x4360)
+    \def REG_DMAP7	(*(vuint8*)0x4370)
+    \brief DMA/HDMA Parameters (R/W)
+    7     Transfer Direction (0=A:CPU to B:I/O, 1=B:I/O to A:CPU)
+    6     Addressing Mode    (0=Direct Table, 1=Indirect Table)    (HDMA only)
+    5     Not used (R/W) (unused and unchanged by all DMA and HDMA)
+    4-3   A-BUS Address Step  (0=Increment, 2=Decrement, 1/3=Fixed) (DMA only)
+    2-0   Transfer Unit Select (0-4=see below, 5-7=Reserved)
+
+    DMA Transfer Unit Selection:
+    Mode  Bytes              B-Bus 21xxh Address   ;Usage Examples...
+    0  =  Transfer 1 byte    xx                    ;eg. for WRAM (port 2180h)
+    1  =  Transfer 2 bytes   xx, xx+1              ;eg. for VRAM (port 2118h/19h)
+    2  =  Transfer 2 bytes   xx, xx                ;eg. for OAM or CGRAM
+    3  =  Transfer 4 bytes   xx, xx,   xx+1, xx+1  ;eg. for BGnxOFS, M7x
+    4  =  Transfer 4 bytes   xx, xx+1, xx+2, xx+3  ;eg. for BGnSC, Window, APU..
+    5  =  Transfer 4 bytes   xx, xx+1, xx,   xx+1  ;whatever purpose, VRAM maybe
+    6  =  Transfer 2 bytes   xx, xx                ;same as mode 2
+    7  =  Transfer 4 bytes   xx, xx,   xx+1, xx+1  ;same as mode 3
+*/
+#define REG_DMAP0 (*(vuint8 *)0x4300)
+#define REG_DMAP1 (*(vuint8 *)0x4310)
+#define REG_DMAP2 (*(vuint8 *)0x4320)
+#define REG_DMAP3 (*(vuint8 *)0x4330)
+#define REG_DMAP4 (*(vuint8 *)0x4340)
+#define REG_DMAP5 (*(vuint8 *)0x4350)
+#define REG_DMAP6 (*(vuint8 *)0x4360)
+#define REG_DMAP7 (*(vuint8 *)0x4370)
+
+/*! \def REG_BBAD0
+    \def REG_BBAD1
+    \def REG_BBAD2
+    \def REG_BBAD3
+    \def REG_BBAD4
+    \def REG_BBAD5
+    \def REG_BBAD6
+    \def REG_BBAD7
+    \brief DMA/HDMA I/O-Bus Address (PPU-Bus aka B-Bus) (R/W)
+    For both DMA and HDMA:
+    7-0   B-Bus Address (selects an I/O Port which is mapped to 2100h-21FFh)
+*/
+#define REG_BBAD0 (*(vuint8 *)0x4301)
+#define REG_BBAD1 (*(vuint8 *)0x4311)
+#define REG_BBAD2 (*(vuint8 *)0x4321)
+#define REG_BBAD3 (*(vuint8 *)0x4331)
+#define REG_BBAD4 (*(vuint8 *)0x4341)
+#define REG_BBAD5 (*(vuint8 *)0x4351)
+#define REG_BBAD6 (*(vuint8 *)0x4361)
+#define REG_BBAD7 (*(vuint8 *)0x4371)
+
+/*! \def REG_A1T0LH
+    \def REG_A1T1LH
+    \def REG_A1T2LH
+    \def REG_A1T3LH
+    \def REG_A1T4LH
+    \def REG_A1T5LH
+    \def REG_A1T6LH
+    \def REG_A1T7LH
+
+    \def REG_A1B0
+    \def REG_A1B1
+    \def REG_A1B2
+    \def REG_A1B3
+    \def REG_A1B4
+    \def REG_A1B5
+    \def REG_A1B6
+    \def REG_A1B7
+    \brief 	A1TxL - HDMA Table Start Address (low) / DMA Current Addr (low) (R/W)
+    A1TxH - HDMA Table Start Address (hi) / DMA Current Addr (hi) (R/W)
+    A1Bx - HDMA Table Start Address (bank) / DMA Current Addr (bank) (R/W)
+
+    For normal DMA:
+    23-16  CPU-Bus Data Address Bank (constant, not incremented/decremented)
+    15-0   CPU-Bus Data Address (incremented/decremented/fixed, as selected)
+
+    For HDMA:
+    23-16  CPU-Bus Table Address Bank (constant, bank number for 43x8h/43x9h)
+    15-0   CPU-Bus Table Address      (constant, reload value for 43x8h/43x9h)
+*/
+#define REG_A1T0LH (*(vuint16 *)0x4302)
+#define REG_A1T1LH (*(vuint16 *)0x4312)
+#define REG_A1T2LH (*(vuint16 *)0x4322)
+#define REG_A1T3LH (*(vuint16 *)0x4332)
+#define REG_A1T4LH (*(vuint16 *)0x4342)
+#define REG_A1T5LH (*(vuint16 *)0x4352)
+#define REG_A1T6LH (*(vuint16 *)0x4362)
+#define REG_A1T7LH (*(vuint16 *)0x4372)
+
+#define REG_A1B0 (*(vuint8 *)0x4304)
+#define REG_A1B1 (*(vuint8 *)0x4314)
+#define REG_A1B2 (*(vuint8 *)0x4324)
+#define REG_A1B3 (*(vuint8 *)0x4334)
+#define REG_A1B4 (*(vuint8 *)0x4344)
+#define REG_A1B5 (*(vuint8 *)0x4354)
+#define REG_A1B6 (*(vuint8 *)0x4364)
+#define REG_A1B7 (*(vuint8 *)0x4374)
+
+/*! \def REG_DAS0LH
+    \def REG_DAS1LH
+    \def REG_DAS2LH
+    \def REG_DAS3LH
+    \def REG_DAS4LH
+    \def REG_DAS5LH
+    \def REG_DAS6LH
+    \def REG_DAS7LH
+    \brief Indirect HDMA Address (low) / DMA Byte-Counter (low) (R/W)
+    DASxL - Indirect HDMA Address (low) / DMA Byte-Counter (low) (R/W)
+    DASxH - Indirect HDMA Address (hi) / DMA Byte-Counter (hi) (R/W)
+    43x7h - DASBx - Indirect HDMA Address (bank) (R/W)
+
+    For normal DMA:
+    23-16  Not used
+    15-0   Number of bytes to be transferred (1..FFFFh=1..FFFFh, or 0=10000h)
+    (This is really a byte-counter; with a 4-byte "Transfer Unit", len=5 would
+    transfer one whole Unit, plus the first byte of the second Unit.)
+    (The 16bit value is decremented during transfer, and contains 0000h on end.)
+*/
+#define REG_DAS0LH (*(vuint16 *)0x4305)
+#define REG_DAS1LH (*(vuint16 *)0x4315)
+#define REG_DAS2LH (*(vuint16 *)0x4325)
+#define REG_DAS3LH (*(vuint16 *)0x4335)
+#define REG_DAS4LH (*(vuint16 *)0x4345)
+#define REG_DAS5LH (*(vuint16 *)0x4355)
+#define REG_DAS6LH (*(vuint16 *)0x4365)
+#define REG_DAS7LH (*(vuint16 *)0x4375)
+
+extern u8 HDMATable16[224 + 1]; /*!< \brief HDMA table accessible to change values */
+
+/*! \fn  dmaCopyCGram(u8 * source, u16 address, u16 size)
+    \brief copy data from source to destination using channel 0 of DMA available channels in half words
+    \param source the source to copy from
+    \param address cgram address to copy
+    \param size the size in bytes of the data to copy.
+*/
+void dmaCopyCGram(u8 *source, u16 address, u16 size);
+
+/*! \fn  dmaCopyVram(u8 * source, u16 address, u16 size)
+    \brief copy data from source to destination using channel 0 of DMA available channels in half words
+    \param source the source to copy from
+    \param address vram address to copy
+    \param size the size in bytes of the data to copy.
+*/
+void dmaCopyVram(u8 *source, u16 address, u16 size);
+
+/*! \fn  dmaCopySpr32Vram(u8 * source, u16 address)
+    \brief copy sprite 32pix size data from source to destination using channel 0 of DMA available channels in half words
+    \param source the source to copy from
+    \param address vram address to copy
+*/
+void dmaCopySpr32Vram(u8 *source, u16 address);
+
+/*! \fn  dmaCopySpr16Vram(u8 * source, u16 address)
+    \brief copy sprite 16pix size data from source to destination using channel 0 of DMA available channels in half words
+    \param source the source to copy from
+    \param address vram address to copy
+*/
+void dmaCopySpr16Vram(u8 *source, u16 address);
+
+/*! \fn  dmaFillVram8(u8 * source, u16 address, u16 size)
+    \brief fill the source data to destination using channel 0 of DMA available channels in half words<br>dmaFillVram is deprecated
+    \param source the value of source to copy from
+    \param address vram address to copy
+    \param size the size in bytes of the data to copy.
+*/
+void dmaFillVram8(u8 *source, u16 address, u16 size);
+
+/*! \fn  dmaFillVram16(u16 * source, u16 address, u16 size)
+    \brief fill the source data to destination using channel 0 of DMA available channels in words
+    \param source the value of source to copy from
+    \param address vram address to copy
+    \param size the size in words of the data to copy.
+*/
+void dmaFillVram16(u16 *source, u16 address, u16 size);
+
+/*! \fn  dmaClearVram(void)
+    \brief clear all vram data with #0
+*/
+void dmaClearVram(void);
+
+/*! \fn  dmaCopyOAram(u8 *source, u16 address, u16 size)
+    \brief copies Sprites from source to destination using channel 0 of DMA available channels in half words
+    \param source the source to copy from
+    \param address vram address to copy
+    \param size the size in bytes of the data to copy.
+*/
+void dmaCopyOAram(u8 *source, u16 address, u16 size);
+
+/*! \fn  dmaCopyVram7(u8 *source, u16 address, u16 size, u8 vrammodeinc, u16 dmacontrol)
+    \brief copies data from source to destination using channel 0 of DMA available channels in half words with VMAIN value
+    \param source the source to copy from
+    \param address vram address to copy
+    \param size the size in bytes of the data to copy.
+    \param vrammodeinc the value of REG_VMAIN (incr or not incr).
+    \param dmacontrol the value of DMA control register (incr or not incr, $18 or $19, and so on).
+*/
+void dmaCopyVram7(u8 *source, u16 address, u16 size, u8 vrammodeinc, u16 dmacontrol);
+
+/*! \fn  setModeHdmaGradient(u8 maxLevels)
+    \brief Do a brightness gradient on screen. Use HDMA Channels 3. 
+    \param maxLevels value between 1..15 for the maximum level of brightness (15=light, 1=near dark)
+*/
+void setModeHdmaGradient(u8 maxLevels);
+
+/*! \fn  setModeHdmaShadeUpDown(void)
+    \brief Do a brightness gradient from up/down to center of the screen. Use HDMA Channels 3.
+*/
+void setModeHdmaShadeUpDown(void);
+
+/*! \fn  setModeHdmaShading(unsigned char mode)
+    \brief Do a shading effect on screen. Use HDMA Channels 0 to 2.
+    \param mode value 0 disactivate 1, other value activate it
+*/
+void setModeHdmaShading(unsigned char mode);
+
+/*! \fn  setParallaxScrolling(u8 bgrnd)
+    \brief Do a parallax scrolling effect on screen. Use HDMA Channels 3.
+    \brief use HDMATable16 variable to store scrolling value
+    \brief each entry is number of lines (8bits) and scrolling value 16 bits (low & high)
+    \brief WARNING : no more than 112 values and last value MUST be $0000
+    \param bgrnd background for the parallax scrolling  (value 0..2)
+*/
+void setParallaxScrolling(u8 bgrnd);
+
+/*! \fn  setModeHdmaReset(u8 channels)
+    \brief Reset or Set HDMA channels
+	\param channels channels from HDMA_CHANNEL0 to HDMA_CHANNEL7. HDMA_CHANNELALL for all channels
+*/
+void setModeHdmaReset(u8 channels);
+
+/*! \fn  void setModeHdmaWindowReset(u8 channels)
+    \brief Reset or Set HDMA channels and remove WINDOW effect
+	\param channels channels from HDMA_CHANNEL0 to HDMA_CHANNEL7. HDMA_CHANNELALL for all channels
+*/
+void setModeHdmaWindowReset(u8 channels);
+
+/*! \fn  setModeHdmaColor(u8* hdmatable)
+    \brief Do a color gradient effect on screen (with color 0). Use HDMA Channels 6.
+    \param hdmatable table with gradient colors
+*/    
+void setModeHdmaColor(u8* hdmatable);
+
+/*! \fn  setModeHdmaWaves(u8 bgrnd)
+    \brief Do a waves effect on screen (init function). Use HDMA Channels 6.
+    \param bgrnd background for the wave effect (value 0..1)
+*/    
+void setModeHdmaWaves(u8 bgrnd);
+
+/*! \fn  setModeHdmaWavesMove(void)
+    \brief Animate the waves effect. Must be called during each frame.<br> setModeHdmaWaves must have been done to init it.
+*/
+void setModeHdmaWavesMove(void);
+
+/*! \fn  setModeHdmaWindow(u8 bgrnd, u8* hdmatableL,u8* hdmatableR)
+    \brief Do a window  effect on screen. Use HDMA Channels 4 & 5.
+    \param bgrnd background for the windows effect  (value MSWIN_BG1..MSWIN_BG4)
+    \param bgrndmask background mask (inside, outside) for the windows effect  (value MSWIN1_BG13MSKIN..MSWIN1_BG13MSKIN)
+    \param hdmatableL table with windows effect on the left
+    \param hdmatableR table with windows effect on the right
+*/    
+void setModeHdmaWindow(u8 bgrnd, u8 bgrndmask,u8* hdmatableL,u8* hdmatableR);
+
+#endif // SNES_DMA_INCLUDE

package/src/platforms/snes/lib/pvsneslib/include/snes/input.h

@@ -0,0 +1,289 @@
+/*---------------------------------------------------------------------------------
+
+    Input registers
+
+    Copyright (C) 2012-2013
+        Alekmaul
+
+    This software is provided 'as-is', without any express or implied
+    warranty.  In no event will the authors be held liable for any
+    damages arising from the use of this software.
+
+    Permission is granted to anyone to use this software for any
+    purpose, including commercial applications, and to alter it and
+    redistribute it freely, subject to the following restrictions:
+
+    1.	The origin of this software must not be misrepresented; you
+        must not claim that you wrote the original software. If you use
+        this software in a product, an acknowledgment in the product
+        documentation would be appreciated but is not required.
+
+    2.	Altered source versions must be plainly marked as such, and
+        must not be misrepresented as being the original software.
+
+    3.	This notice may not be removed or altered from any source
+        distribution.
+
+
+---------------------------------------------------------------------------------*/
+
+/*!
+ * \file input.h
+ * \brief input support.
+ *
+ * The inputs are automatically read by the \ref VBlank-ISR on non-lag frames.
+ */
+
+#ifndef SNES_INPUT_INCLUDE
+#define SNES_INPUT_INCLUDE
+
+#include <snes/snestypes.h>
+#include <snes/interrupt.h>
+
+/*!
+    \brief common values for pad input.
+
+    common values that can be used to test auto pad.
+*/
+//! enum values for the pad buttons.
+typedef enum KEYPAD_BITS
+{
+    KEY_A = BIT(7),       //!< pad A button.
+    KEY_B = BIT(15),      //!< pad B button.
+    KEY_SELECT = BIT(13), //!< pad SELECT button.
+    KEY_START = BIT(12),  //!< pad START button.
+    KEY_RIGHT = BIT(8),   //!< pad RIGHT button.
+    KEY_LEFT = BIT(9),    //!< pad LEFT button.
+    KEY_DOWN = BIT(10),   //!< pad DOWN button.
+    KEY_UP = BIT(11),     //!< pad UP button.
+    KEY_R = BIT(4),       //!< Right shoulder button.
+    KEY_L = BIT(5),       //!< Left shoulder button.
+    KEY_X = BIT(6),       //!< pad X button.
+    KEY_Y = BIT(14),      //!< pad Y button.
+} KEYPAD_BITS;
+
+/*!
+    \brief common values for SuperScope input.
+*/
+//! enum values for the SuperScope buttons and flags.
+typedef enum SUPERSCOPE_BITS
+{
+    SSC_FIRE = BIT(15),     //!< superscope FIRE button.
+    SSC_CURSOR = BIT(14),   //!< superscope CURSOR button.
+    SSC_PAUSE = BIT(12),    //!< superscope PAUSE button.
+    SSC_TURBO = BIT(13),    //!< superscope TURBO flag.
+    SSC_OFFSCREEN = BIT(9), //!< superscope OFFSCREEN flag.
+    SSC_NOISE = BIT(8),     //!< superscope NOISE flag.
+} SUPERSCOPE_BITS;
+
+/*!
+ * \brief Mouse sensitivity values
+ *
+ * enum values for the mouse sensitivity.
+ */
+typedef enum MOUSE_SENSITIVITY
+{
+    MOUSE_SLOW = 0,     //!< slow sensitivity
+    MOUSE_MEDIUM = 1,   //!< medium sensitivity
+    MOUSE_FAST = 2,     //!< fast sensitivity
+} MOUSE_SENSITIVITY;
+
+extern u16 pad_keys[5];     //!< current pad value
+extern u16 pad_keysold[5];  //!< previous pad value
+extern u16 pad_keysdown[5]; //!< newly pressed down pad keys
+
+extern u8 snes_mplay5;  /*!< \brief 1 if MultiPlay5 is connected */
+extern u8 snes_mouse;   /*!< \brief 1 if Mouse is going to be used */
+extern u8 snes_sscope;  /*!< \brief 1 if SuperScope is connected */
+
+extern u8 mouseConnect[2];        /*!< \brief 1 if Mouse present */
+extern u8 mouseButton[2];         /*!< \brief Mouse buttons that are pressed on this frame (Click mode). */
+extern u8 mousePressed[2];        /*!< \brief Mouse buttons that are currently pressed, stays until is unpressed (Turbo mode). */
+extern u8 mousePreviousPressed[2];/*!< \brief Mouse buttons held or pressed in the previous frame */
+extern u8 mouse_x[2];             /*!< \brief Mouse horizontal displacement. daaaaaaa, d = direction (1: left, 0: right), a = acceleration. */
+extern u8 mouse_y[2];             /*!< \brief Mouse vertical displacement. daaaaaaa, d = direction (1: up, 0: down), a = acceleration. */
+
+/*!
+ * \brief Mouse sensitivity
+ *
+ *  * When a mouse is connected to the port: sensitivity bits read from the mouse.
+ *  * When no mouse is connected: The sensitivity to set the mouse to when the mouse is connected to the console.
+ *
+ * CAUTION: The Hyperkin clone mouse ignores sensitivity changes and always reports a sensitivity of 0.
+ */
+extern u8 mouseSensitivity[2];
+
+/*!
+ * \brief Request a change mouse sensitivity.
+ *
+ * To prevent auto-joypad read corruption the change sensitivity commands are delayed until the
+ * next non-lag VBlank ISR (after the mouse data has been read).
+ *
+ * Values:
+ *  * `0x00`: No changes to mouse sensitivity.
+ *  * `0x01`: Cycle the mouse sensitivity once.
+ *  * `0x02-0x7f`: Cycle the mouse sensitivity twice.
+ *  * `0x80-0xff`: Set the sensitivity to `value & 3`.
+ *
+ * CAUTION: The Hyperkin clone mouse ignores sensitivity changes and always reports a sensitivity of 0.
+ */
+extern u8 mouseRequestChangeSensitivity[2];
+
+#define mouse_L 0x01 /*!< \brief SNES Mouse Left button mask.*/
+#define mouse_R 0x02 /*!< \brief SNES Mouse Right button mask.*/
+
+extern u16 scope_holddelay; /*!< \brief Hold delay. */
+extern u16 scope_repdelay;  /*!< \brief Repeat rate. */
+extern u16 scope_shothraw;  /*!< \brief Horizontal shot position, not adjusted. */
+extern u16 scope_shotvraw;  /*!< \brief Vertical shot position, not adjusted. */
+extern u16 scope_shoth;     /*!< \brief Horizontal shot position, adjusted for aim. */
+extern u16 scope_shotv;     /*!< \brief Vertical shot position, adjusted for aim. */
+extern u16 scope_centerh;   /*!< \brief 0x0000 is the center of the screen, positive values go to bottom right. */
+extern u16 scope_centerv;   /*!< \brief 0x0000 is the center of the screen, positive values go to bottom right. */
+extern u16 scope_down;      /*!< \brief flags that are currently true.*/
+extern u16 scope_now;       /*!< \brief flags that have become true this frame.*/
+extern u16 scope_held;      /*!< \brief flagsthat have been true for a certain length of time.*/
+extern u16 scope_last;      /*!< \brief flags that were true on the previous frame.*/
+extern u16 scope_sinceshot; /*!< \brief Number of frames elapsed since last shot was fired.*/
+
+/*! \def REG_JOYxLH
+
+    \brief SNES Controllers I/O Ports - Automatic Reading.
+    4218h/4219h - JOY1L/JOY1H - Joypad 1 (gameport 1, pin 4) (R)
+    421Ah/421Bh - JOY2L/JOY2H - Joypad 2 (gameport 2, pin 4) (R)
+    421Ch/421Dh - JOY3L/JOY3H - Joypad 3 (gameport 1, pin 5) (R)
+    421Eh/421Fh - JOY4L/JOY4H - Joypad 4 (gameport 2, pin 5) (R)
+
+    Register    Serial     Default
+    Bit         Transfer   Purpose
+    Number______Order______(Joypads)_____
+    15          1st        B Button         (1=Low=Pressed)
+    14          2nd        Y Button
+    13          3rd        Select Button
+    12          4th        Start Button
+    11          5th        Up
+    10          6th        Down
+    9           7th        Left
+    8           8th        Right
+    7           9th        A Button
+    6           10th       X Button
+    5           11th       L Button
+    4           12th       R Button
+    3           13th       0 (High)
+    2           14th       0 (High)
+    1           15th       0 (High)
+    0           16th       0 (High)
+
+    When enabled, the SNES will read 16 bits from each of the 4 controller port
+    data lines into registers $4218-f. This begins between H=32.5 and H=95.5 of
+    the first V-Blank scanline, and ends 4224 master cycles later. Register $4212
+    bit 0 is set during this time. Specifically, it begins at H=74.5 on the first
+    frame, and thereafter some multiple of 256 cycles after the start of the
+    previous read that falls within the observed range.
+
+    Reading $4218-f during this time will read back incorrect values. The only
+    reliable value is that no buttons pressed will return 0 (however, if buttons
+    are pressed 0 could still be returned incorrectly). Presumably reading $4016/7
+    or writing $4016 during this time will also screw things up.
+
+*/
+#define REG_JOYxLH(a) (((vuint16 *)0x4218)[(a)])
+
+/*!	\fn  padsCurrent(value)
+    \brief Return current value of selected pad
+    \param value pad index to use (0-1 or 0-4 if multiplayer 5 connected)
+    \return unsigned short of the current pad value
+*/
+// unsigned short padsCurrent(u16 value);
+#define padsCurrent(value) (pad_keys[value])
+
+/*!	\fn padsDown(value)
+    \brief Return value of down keys for selected pad
+    \param value pad index to use (0-1 or 0-4 if multiplayer 5 connected)
+    \return unsigned short of the newly pressed down keys (0 -> 1 transition)
+*/
+// unsigned short padsDown(u16 value);
+#define padsDown(value) (pad_keysdown[value])
+
+/*!	\fn padsUp(u16 value)
+    \brief Return value of up keys for selected pad
+    \param value pad index to use (0-1 or 0-4 if multiplayer 5 connected)
+    \return unsigned short of the released keys (1 -> 0 transition)
+*/
+unsigned short padsUp(u16 value);
+
+/*!	\fn padsClear(u16 value)
+    \brief Clear internal variables for selected pad
+    \param value pad index to use (0-1 or 0-4 if multiplayer 5 connected)
+*/
+void padsClear(u16 value);
+
+/*!	\fn detectMPlay5(void)
+    \brief Check if MultiPlayer5 is connected and populate snes_mplay5 (0 or 1 for connected)
+
+    \b CAUTION: REG_WRIO ($4201) must not be written to while MultiPlayer5 is active.
+    (Bit 7 of REG_WRIO must be set when Auto Joy reads the controllers, shortly after the VBlank Period starts.)
+*/
+void detectMPlay5(void);
+
+/*!	\fn detectMouse(void)
+    \brief Check if Mouse is connected and populate snes_mouse (0 or 1 for connected)
+*/
+void detectMouse(void);
+
+/*!	\fn detectSuperScope(void)
+    \brief Detects if SuperScope is connected on Port 1 (second controller port on console) and populate snes_sscope (0 or 1 for connected)
+*/
+void detectSuperScope(void);
+
+
+/*!
+ * \brief Enable mouse reading and set the initial mouse sensitivity
+ *
+ * Initialises mouse variables and enable mouse reading in the VBlank ISR.
+ *
+ * \param sensitivity sensitivity to use when  the mouse is connected to the console
+ * (has no effect on a Hyperkin clone mouse)
+ */
+void initMouse(u8 sensitivity);
+
+
+/*!
+ * \brief Queue a cycle mouse sensitivity command for the next VBlank.
+ *
+ * \param port the port the mouse is connected to (0 or 1).
+ *
+ * CAUTION:
+ *  * The changes to @ref mouseSensitivity are delayed one frame.
+ *  * This function will override any pending @ref mouseRequestChangeSensitivity commands.
+ *  * This function has no effect on the Hyperkin clone mouse.
+ */
+void mouseCycleSensitivity(u16 port);
+
+/*!
+ * \brief Queue a cycle mouse sensitivity twice (decrementing the sensitivity) command for the next VBlank.
+ *
+ * \param port the port the mouse is connected to (0 or 1).
+ *
+ * CAUTION:
+ *  * The changes to @ref mouseSensitivity are delayed one frame.
+ *  * This function will override any pending @ref mouseRequestChangeSensitivity commands.
+ *  * This function has no effect on the Hyperkin clone mouse.
+ */
+void mouseCycleSensitivityTwice(u16 port);
+
+/*!
+ * \brief Queue a set mouse sensitivity command (to be executed on the next VBlank).
+ *
+ * \param port the port the mouse is connected to (0 or 1).
+ * \param sensitivity the sensitivity to set the mouse to (0 - 2).
+ *
+ * CAUTION:
+ *  * The changes to @ref mouseSensitivity are delayed one frame.
+ *  * A sensitivity value of 3 is invalid.
+ *  * This function will override any pending @ref mouseRequestChangeSensitivity commands.
+ *  * This function has no effect on the Hyperkin clone mouse.
+ */
+void mouseSetSensitivity(u16 port, u8 sensitivity);
+
+#endif // SNES_PADS_INCLUDE