romdev-mcp 0.1.1

package/src/platforms/genesis/lib/sgdk/include/ext/mw/mw-msg.h

@@ -0,0 +1,392 @@
+/************************************************************************//**
+ * \file
+ * \brief MegaWiFi command message definitions.
+ *
+ * \defgroup mw-msg mw-msg
+ * \{
+ *
+ * \brief MegaWiFi command message definitions.
+ *
+ * Contains the definition of the command codes and the data structures
+ * conforming the command message queries and responses. Usually this module
+ * is not directly used by the application, but by megawifi internally.
+ *
+ * \author Jesus Alonso (doragasu)
+ * \author Juan Antonio (PaCHoN)
+ * \date 2015~2025
+ ****************************************************************************/
+#ifndef _MW_MSG_H_
+#define _MW_MSG_H_
+
+#include "types.h"
+#include "sys.h"
+
+/// Maximum buffer length (bytes)
+#define MW_MSG_MAX_BUFLEN	512
+#define MW_MS_TO_FRAMES(ms)	(((ms)*60/500 + 1)/2)
+
+#define MW_BUFLEN 1500
+
+/// Command header length (command code and data length fields).
+#define MW_CMD_HEADLEN		(2 * sizeof(uint16_t))
+
+/// Maximum data length contained inside command buffer.
+#define MW_CMD_MAX_BUFLEN	(MW_MSG_MAX_BUFLEN - MW_CMD_HEADLEN)
+
+/// Maximum SSID length (including '\0').
+#define MW_SSID_MAXLEN		32
+/// Maximum password length (including '\0').
+#define MW_PASS_MAXLEN		64
+
+/// Gamertag nickname maximum length
+#define MW_GT_NICKNAME_MAX		32
+/// Gamertag security maximum length
+#define MW_GT_SECURITY_MAX		32
+/// Gamertag tagline maximum length
+#define MW_GT_TAGLINE_MAX		32
+/// Gamertag avatar graphick width in pixels
+#define MW_GT_AVATAR_WIDTH		32
+/// Gamertag avatar graphick height in pixels
+#define MW_GT_AVATAR_HEIGHT		48
+/// Telegram token maximum length
+#define MW_GT_TG_TOKEN_MAX		64
+
+/// Supported commands.
+enum PACKED mw_command {
+	MW_CMD_OK		 =   0,	///< OK command reply
+	MW_CMD_VERSION      	 =   1,	///< Get firmware version
+	MW_CMD_ECHO		 =   2,	///< Echo data
+	MW_CMD_AP_SCAN		 =   3,	///< Scan for access points
+	MW_CMD_AP_CFG		 =   4,	///< Configure access point
+	MW_CMD_AP_CFG_GET   	 =   5,	///< Get access point configuration
+	MW_CMD_IP_CURRENT 	 =   6,	///< Get current IPv4 configuration
+// Reserved
+	MW_CMD_IP_CFG		 =   8,	///< Configure IPv4
+	MW_CMD_IP_CFG_GET	 =   9,	///< Get IPv4 configuration
+	MW_CMD_DEF_AP_CFG	 =  10,	///< Set default AP configuration
+	MW_CMD_DEF_AP_CFG_GET	 =  11,	///< Get default AP configuration
+	MW_CMD_AP_JOIN		 =  12,	///< Join access point
+	MW_CMD_AP_LEAVE		 =  13,	///< Leave previously joined AP
+	MW_CMD_TCP_CON		 =  14,	///< Connect TCP socket
+	MW_CMD_TCP_BIND		 =  15,	///< Bind TCP socket to port
+// Reserved
+	MW_CMD_CLOSE		 =  17,	///< Disconnect and free TCP/UDP socket
+	MW_CMD_UDP_SET		 =  18,	///< Configure UDP socket
+// Reserved (for setting socket  options)
+	MW_CMD_SOCK_STAT	 =  20,	///< Get socket status
+	MW_CMD_PING		 =  21,	///< Ping host
+	MW_CMD_SNTP_CFG		 =  22,	///< Configure SNTP service
+	MW_CMD_SNTP_CFG_GET      =  23,  ///< Get SNTP configuration
+	MW_CMD_DATETIME		 =  24,	///< Get date and time
+	MW_CMD_DT_SET       	 =  25,	///< Set date and time
+	MW_CMD_FLASH_WRITE	 =  26,	///< Write to WiFi module flash
+	MW_CMD_FLASH_READ	 =  27,	///< Read from WiFi module flash
+	MW_CMD_FLASH_ERASE	 =  28,	///< Erase sector from WiFi flash
+	MW_CMD_FLASH_ID 	 =  29,	///< Get WiFi flash chip identifiers
+	MW_CMD_SYS_STAT		 =  30,	///< Get system status
+	MW_CMD_DEF_CFG_SET	 =  31,	///< Set default configuration
+	MW_CMD_HRNG_GET		 =  32,	///< Gets random numbers
+	MW_CMD_BSSID_GET	 =  33,	///< Gets the WiFi BSSID
+	MW_CMD_GAMERTAG_SET	 =  34,	///< Configures a gamertag
+	MW_CMD_GAMERTAG_GET	 =  35,	///< Gets a stored gamertag
+	MW_CMD_LOG		 =  36,	///< Write a message to log trace
+	MW_CMD_FACTORY_RESET	 =  37,	///< Set default configuratioSet default configuration
+	MW_CMD_SLEEP		 =  38,	///< Set the module to sleep mode
+	MW_CMD_HTTP_URL_SET	 =  39,	///< Set HTTP URL for request
+	MW_CMD_HTTP_METHOD_SET	 =  40,	///< Set HTTP request method
+	MW_CMD_HTTP_CERT_QUERY   =  41,	///< Query the X.509 hash of cert
+	MW_CMD_HTTP_CERT_SET	 =  42,	///< Set HTTPS certificate
+	MW_CMD_HTTP_HDR_ADD	 =  43,	///< Add HTTP request header
+	MW_CMD_HTTP_HDR_DEL	 =  44,	///< Delete HTTP request header
+	MW_CMD_HTTP_OPEN	 =  45,	///< Open HTTP request
+	MW_CMD_HTTP_FINISH	 =  46,	///< Finish HTTP request
+	MW_CMD_HTTP_CLEANUP	 =  47,	///< Clean request data
+// Reserved
+	MW_CMD_SERVER_URL_GET	 =  49,	///< Get the main server URL
+	MW_CMD_SERVER_URL_SET	 =  50,	///< Set the main server URL
+	MW_CMD_WIFI_ADV_GET	 =  51,	///< Get advanced WiFi parameters
+	MW_CMD_WIFI_ADV_SET	 =  52,	///< Set advanced WiFi parameters
+	MW_CMD_NV_CFG_SAVE	 =  53,	///< Save non-volatile config
+	MW_CMD_UPGRADE_LIST	 =  54,	///< Get firmware upgrade versions
+	MW_CMD_UPGRADE_PERFORM	 =  55,	///< Start firmware upgrade
+	MW_CMD_GAME_ENDPOINT_SET =  56,	///< Set game API endpoint
+	MW_CMD_GAME_KEYVAL_ADD	 =  57,	///< Add key/value appended to requests
+	MW_CMD_GAME_REQUEST	 =  58,	///< Perform a game API request
+	MW_CMD_ERROR		 = 255	///< Error command reply
+};
+
+/// Supported security protocols
+enum PACKED mw_security {
+	MW_SEC_OPEN = 0,	///< Open WiFi network
+	MW_SEC_WEP,		///< WEP security
+	MW_SEC_WPA_PSK,		///< WPA PSK security
+	MW_SEC_WPA2_PSK,	///< WPA2 PSK security
+	MW_SEC_WPA_WPA2_PSK,	///< WPA or WPA2 security
+	MW_SEC_WPA2_ENTERPRISE,	///< WPA2 Enterprise security
+	MW_SEC_WPA3_PSK,	///< WPA3 PSK security
+	MW_SEC_WPA2_WPA3_PSK,	///< WPA2 or WPA3 security
+	MW_SEC_WAPI_PSK,	///< WAPI PSK security
+	MW_SEC_OWE,		///< OWE security
+	MW_SEC_UNKNOWN,		///< Unknown security
+	__MW_SEC_MAX
+};
+
+/// WiFi PHY configuration for the connection to the AP
+enum PACKED mw_phy_type {
+	MW_PHY_11B = 1,		///< Legacy, do not use unless necessary
+	MW_PHY_11BG = 3,	///< No 802.11n compatibility
+	MW_PHY_11BGN = 7	///< 802.11bgn compatible
+};
+
+/// IPv4 address
+union ip_addr {
+	uint32_t addr;		///< IP address in 32 bit form
+	uint8_t byte[4];	///< IP address in 4-byte form
+};
+
+/// TCP/UDP address message
+struct mw_msg_in_addr {
+	char dst_port[6];	///< TCP destination port string
+	char src_port[6];	///< TCP source port string
+	uint8_t channel;	///< LSD channel used for communications
+	/// Data payload
+	char dst_addr[];
+};
+
+/// IP configuration parameters
+struct mw_ip_cfg {
+	union ip_addr addr;	///< Host IP address in binary format
+	union ip_addr mask;	///< Subnet mask in binary IP format
+	union ip_addr gateway;	///< Gateway IP address in binary format
+	union ip_addr dns1;	///< DNS server 1 IP address in binary format
+	union ip_addr dns2;	///< DNS server 2 IP address in binary format
+};
+
+/// \brief AP configuration message
+/// \warning If ssid length is MW_SSID_MAXLEN, the string will not be NULL
+///          terminated. Also if pass length equals MW_PASS_MAXLEN, pass
+//           string will not be NULL terminated.
+struct mw_msg_ap_cfg {
+	uint8_t cfg_num;		///< Configuration number
+	enum mw_phy_type phy_type;	///< PHY type bitmask
+	char ssid[MW_SSID_MAXLEN];	///< SSID string
+	char pass[MW_PASS_MAXLEN];	///< Password string
+};
+
+/// IP configuration message
+struct mw_msg_ip_cfg {
+	uint8_t cfg_slot;	///< Configuration slot
+	uint8_t reserved[3];	///< Reserved (set to 0)
+	struct mw_ip_cfg ip;	///< IPv4 configuration data
+};
+
+/// SNTP and timezone configuration
+struct mw_msg_sntp_cfg {
+	uint16_t up_delay;	///< Update delay in seconds (min: 15)
+	int8_t tz;		///< Timezone (from -11 to 13)
+	uint8_t dst;		///< Daylight savines (set to 1 to add 1 hour)
+	/// Up to 3 NTP server URLs, separated by a NULL character. A double
+	/// NULL marks the end of the server list.
+	char servers[MW_CMD_MAX_BUFLEN - 4];
+};
+
+/// Date and time message
+struct mw_msg_date_time {
+	uint32_t dt_bin[2];	///< Number of seconds since Epoch (64-bit)
+	/// Date and time in textual format
+	char dt_str[MW_CMD_MAX_BUFLEN - 2 * sizeof(uint32_t)];
+};
+
+/// Flash memory address and data
+struct mw_msg_flash_data {
+	uint32_t addr;		///< Flash memory address
+	/// Data associated to the address
+	uint8_t data[MW_CMD_MAX_BUFLEN - sizeof(uint32_t)];
+};
+
+/// Flash memory block
+struct mw_msg_flash_range {
+	uint32_t addr;		///< Start address
+	uint16_t len;		///< Length of the block
+};
+
+/// Bind message data
+struct mw_msg_bind {
+	uint32_t reserved;	///< Reserved, set to 0
+	uint16_t port;		///< Port to bind to
+	uint8_t  channel;	///< Channel used for the socket bound to port
+};
+
+/// Advanced WiFi configuration
+struct mw_wifi_adv_cfg {
+	uint8_t qos_enable;			///< WiFi QOS feature enable flag
+	uint8_t ampdu_rx_enable;		///< WiFi AMPDU RX feature enable flag
+	uint8_t rx_ba_win;			///< WiFi Block Ack RX window size
+	uint8_t rx_ampdu_buf_num;		///< WiFi AMPDU RX buffer number
+	uint32_t rx_ampdu_buf_len;		///< WiFi AMPDU RX buffer length
+	uint32_t rx_max_single_pkt_len;		///< WiFi RX max single packet size
+	uint32_t rx_buf_len;			///< WiFi RX buffer size
+	uint8_t amsdu_rx_enable;		///< WiFi AMSDU RX feature enable flag
+	uint8_t rx_buf_num;			///< WiFi RX buffer number
+	uint8_t rx_pkt_num;			///< WiFi RX packet number
+	uint8_t left_continuous_rx_buf_num;	///< WiFi Rx left continuous rx buffer number
+	uint8_t tx_buf_num;			///< WiFi TX buffer number
+	uint8_t reserved[3];			///< Unused, set to 0
+};
+
+/// Gamertag data
+struct mw_gamertag {
+	/// Unique gamertag id
+	int id;
+	/// User nickname
+	char nickname[MW_GT_NICKNAME_MAX];
+	/// User security string
+	char security[MW_GT_SECURITY_MAX];
+	/// User defined text tag
+	char tagline[MW_GT_TAGLINE_MAX];
+	/// Telegram token
+	char tg_token[MW_GT_TG_TOKEN_MAX];
+	/// Avatar image tiles
+	uint8_t avatar_tiles[MW_GT_AVATAR_WIDTH * MW_GT_AVATAR_HEIGHT / 2];
+	/// Avatar image palette
+	uint8_t avatar_pal[32];
+};
+
+/// Gamertag set message data
+struct mw_gamertag_set_msg {
+	uint8_t slot;			///< Slot to store gamertag (0 to 2)
+	uint8_t reserved[3];		///< Reserved, set to 0
+	struct mw_gamertag gamertag;	///< Gamertag to set
+};
+
+/// MwState Possible states of the system state machine.
+enum mw_state {
+	MW_ST_INIT = 0,		///< Initialization state.
+	MW_ST_IDLE,		///< Idle state, until connected to an AP.
+	MW_ST_AP_JOIN,		///< Trying to join an access point.
+	MW_ST_SCAN,		///< Scanning access points.
+	MW_ST_READY,		///< Connected to The Internet.
+	MW_ST_TRANSPARENT,	///< Transparent communication state.
+	MW_ST_MAX		///< Limit number for state machine.
+};
+
+/// Socket status.
+enum mw_sock_stat {
+	MW_SOCK_NONE = 0,	///< Unused socket.
+	MW_SOCK_TCP_LISTEN,	///< Socket bound and listening.
+	MW_SOCK_TCP_EST,	///< TCP socket, connection established.
+	MW_SOCK_UDP_READY	///< UDP socket ready for sending/receiving
+};
+
+/// System status
+union mw_msg_sys_stat {
+	uint32_t st_flags;		///< Accesses all the flags at once
+	struct {
+#if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
+		enum mw_state sys_stat:8;	///< System status
+		uint8_t online:1;	///< Module is connected to the Internet
+		uint8_t cfg_ok:1;	///< Configuration OK
+		uint8_t dt_ok:1;	///< Date and time synchronized at least once
+		uint8_t cfg:2;		///< Default network configuration
+		uint16_t reserved:3;	///< Reserved flags
+		uint16_t ch_ev:16;	///< Channel flags with the pending event
+#else
+		uint16_t ch_ev:16;	///< Channel flags with the pending event
+		uint16_t reserved:3;	///< Reserved flags
+		uint8_t cfg:2;		///< Default network configuration
+		uint8_t dt_ok:1;	///< Date and time synchronized at least once
+		uint8_t cfg_ok:1;	///< Configuration OK
+		uint8_t online:1;	///< Module is connected to the Internet
+		enum mw_state sys_stat:8;	///< System status
+#endif
+	};
+};
+
+/// Flash chip identifiers
+struct mw_flash_id {
+	uint16_t device;	///< Device ID
+	uint8_t manufacturer;	///< Manufacturer ID
+};
+
+/// Game API request
+struct mw_ga_request {
+	uint8_t method;		///< Request method
+	uint8_t num_paths;	///< Number of paths
+	uint8_t num_kv_pairs;	///< Number of key/value pairs
+	char req[];		///< Request data
+};
+
+struct mw_ping_request{
+	uint8_t retries;
+	char domain[64];
+};
+
+struct mw_ping_response{
+	uint32_t transmitted;
+    uint32_t received;
+    uint32_t total_time_ms;
+};
+
+struct mw_upgrade_list_response{
+	uint16_t total;
+	uint16_t len;
+    char *payload;
+};
+
+/// Command sent to system FSM
+typedef union mw_cmd {
+	char packet[MW_CMD_MAX_BUFLEN + 2 * sizeof(uint16_t)];	///< Packet raw data
+	struct {
+		uint16_t cmd;			///< Command code
+		uint16_t data_len;		///< Data length
+		// If datalen is nonzero, additional command data goes here until
+		// filling datalen bytes.
+		union {
+			uint8_t ch;		///< Channel number for channel related requests
+			/// RAW data in uint8_t format
+			uint8_t data[MW_CMD_MAX_BUFLEN];
+			/// RAW data in uint16_t format
+			uint16_t w_data[MW_CMD_MAX_BUFLEN / sizeof(uint16_t)];
+			/// RAW data in uint32_t format
+			uint32_t dw_data[MW_CMD_MAX_BUFLEN / sizeof(uint32_t)];
+			struct mw_msg_in_addr in_addr;		///< Internet address
+			struct mw_msg_ap_cfg ap_cfg;		///< Access Point configuration
+			struct mw_msg_ip_cfg ip_cfg;		///< IP configuration
+			struct mw_msg_sntp_cfg sntp_cfg;	///< SNTP client configuration
+			struct mw_msg_date_time date_time;	///< Date and time message
+			struct mw_msg_flash_data fl_data;	///< Flash memory data
+			struct mw_msg_flash_range fl_range;	///< Flash memory range
+			struct mw_msg_bind bind;		///< Bind message
+			struct mw_ping_request ping;    ///< Ping message
+			struct mw_ping_response ping_response;    ///< Ping message
+			struct mw_upgrade_list_response ug_list_response;    ///< Ping message
+			union mw_msg_sys_stat sys_stat;		///< System status
+			struct mw_gamertag_set_msg gamertag_set;///< Gamertag set
+			struct mw_gamertag gamertag_get;	///< Gamertag get
+			struct mw_wifi_adv_cfg wifi_adv_cfg;	///< Advanced WiFi configuration
+			struct mw_flash_id flash_id;		///< Flash chip identifiers
+			struct mw_ga_request ga_request;	///< Game API request
+			uint16_t fl_sect;	///< Flash sector
+			uint32_t fl_id;		///< Flash IDs
+			uint16_t rnd_len;	///< Length of the random buffer to fill
+		};
+	};
+} mw_cmd;
+
+/// \brief Payload with remote IP and port.
+///
+/// Data sent/received using UDP sockets, uses this special format when
+/// reuse flag has been set in the mw_udp_set() call. This allows the program
+/// using the UDP socket, to filter incoming IPs, and to be able to properly
+/// answer to incoming packets from several peers.
+struct mw_reuse_payload {
+	uint32_t remote_ip;	///< IP of the remote end
+	uint16_t remote_port;	///< Port of the remote end
+	/// Data payload
+	char payload[MW_CMD_MAX_BUFLEN - 4 - 2];
+};
+
+#endif //_MW_MSG_H_
+
+/** \} */
+

package/src/platforms/genesis/lib/sgdk/include/ext/mw/ssf_ed_pro.h

@@ -0,0 +1,38 @@
+/************************************************************************
+ * \brief Simple SSF driver to Everdrive PRO.
+ *
+ * \author Juan Antonio Ruiz (PaCHoN)
+ * \date   2024-2025
+ * \defgroup SSF SSF
+ * \brief
+ *      https://github.com/krikzz/mega-ed-pub
+*************************************** */
+#ifndef _SSF_ED_PRO_H_
+#define _SSF_ED_PRO_H_
+
+#include "types.h"
+
+#define REG_FIFO_DATA (*((volatile u16*)(0xA130D0)))
+#define REG_FIFO_STAT (*((volatile u16*)(0xA130D2)))
+#define REG_SYS_STAT (*((volatile u16*)(0xA130D4)))
+
+#define FIFO_CPU_RXF 0x8000 // fifo flags. system cpu can read
+#define FIFO_RXF_MSK 0x7FF
+#define STAT_PRO_PRESENT 0x55A0
+#define CMD_USB_WR 0x22
+
+#define MW_EDPRO_BUFLEN	1436
+#define MW_EDPRO_TXFIFO_LEN 512
+
+bool ssf_ed_pro_is_present(void);
+void ssf_ed_pro_write(u8 data);
+bool ssf_ed_pro_read_ready(void);
+bool ssf_ed_pro_write_ready(void);
+u8 ssf_ed_pro_read(void);
+
+/************************************************************************//**
+ * \brief Initializes the driver on Everdrive PRO.
+ ****************************************************************************/
+void ssf_ed_pro_init(void);
+
+#endif /*_SSF_ED_PRO_H_*/

package/src/platforms/genesis/lib/sgdk/include/ext/mw/ssf_ed_x7.h

@@ -0,0 +1,73 @@
+/************************************************************************
+ * \brief Simple SSF driver to Everdrive X7.
+ *
+ * \author Juan Antonio Ruiz (PaCHoN)
+ * \date   2024-2025
+ * \defgroup SSF SSF
+ * \brief
+ *      USB IO
+ *        0xA130E2 [........ DDDDDDDD] read/write
+ *        D data bits
+ * 
+ *      IO status
+ *        0xA130E4 [.C...... .....RWS] read only
+ *        S SPI controller ready. Not used on WIFI.
+ *        W USB fifo ready to write
+ *        R USB fifo ready to read
+ *        C SD card type. 0=SD, 1=SDHC. Not used on WIFI.
+*************************************** */
+#ifndef _SSF_ED_X7_H_
+#define _SSF_SSF_ED_X7_H_
+
+#include "types.h"
+
+//#define SSF_CTRL_P 0x8000 //register accesss protection bit. should be set, otherwise register will ignore any attempts to write
+//#define SSF_CTRL_X 0x4000 //32x mode
+//#define SSF_CTRL_W 0x2000 //ROM memory write protection
+//#define SSF_CTRL_L 0x1000 //led
+
+//#define USB_RD_BUSY while ((REG_STE & STE_USB_RD_RDY) == 0)
+//#define USB_WR_BUSY while ((REG_STE & STE_USB_WR_RDY) == 0)
+/**************************************** */
+
+
+/// SSF UART base address
+#define X7_UART_BASE		0xA13000
+
+/// Receiver holding register. Read only.
+#define X7_UART_DATA	          (*((volatile u16*)(X7_UART_BASE +  226)))
+#define X7_UART_STE	          (*((volatile u16*)(X7_UART_BASE +  228)))
+#define X7_UART_REG_CFG          (*((volatile u16*)(X7_UART_BASE +  230)))
+#define X7_UART_REG_SSF_CTRL     (*((volatile u16*)(X7_UART_BASE +  240)))
+
+#define SSF_CTRL_P 0x8000 //register accesss protection bit. should be set, otherwise register will ignore any attempts to write
+#define SSF_CTRL_X 0x4000 //32x mode
+#define SSF_CTRL_W 0x2000 //ROM memory write protection
+#define SSF_CTRL_L 0x1000 //led
+
+#define X7_UART_SPR X7_UART_DATA
+
+#define X7_UART_STE_WR_RDY 2//usb write ready bit
+#define X7_UART_STE_RD_RDY 4//usb read ready bit
+
+//spi chip select signal
+#define CFG_SPI_SS 1
+#define CFG_SPI_QRD 6
+#define CFG_SPI_QWR 2
+
+#define MW_EDX7_BUFLEN	1436
+#define MW_EDX7_TXFIFO_LEN 1
+
+bool ssf_ed_x7_is_present(void);
+void ssf_ed_x7_write(u8 data);
+bool ssf_ed_x7_read_ready(void);
+bool ssf_ed_x7_write_ready(void);
+u8 ssf_ed_x7_read(void);
+
+/************************************************************************//**
+ * \brief Initializes the driver on Everdrive X7.
+ ****************************************************************************/
+void ssf_ed_x7_init(void);
+
+#endif /*_SSF_ED_X7_H_*/
+

package/src/platforms/genesis/lib/sgdk/include/ext/serial/buffer.h

@@ -0,0 +1,8 @@
+#include "genesis.h"
+
+u16 buffer_init(u16 size);
+u8 buffer_read(void);
+void buffer_write(u8 data);
+u8 buffer_canRead(void);
+u16 buffer_available(void);
+void buffer_free(void);

package/src/platforms/genesis/lib/sgdk/include/ext/serial/serial.h

@@ -0,0 +1,133 @@
+/************************************************************************
+ * \brief Simple Serial Driver to comunicate by game port.
+ *
+ * \author Juan Antonio Ruiz (PaCHoN)
+ * \date   2024-2025
+ * \defgroup MW Serial
+ * \brief
+ *      ## Hardware
+ * 
+ *      ### Controller Port Pinout
+ *      
+ *      | Pin | Parallel Mode \*    | Serial Mode | I/O Reg Bit |
+ *      | --- | ------------------- | ----------- | ----------- |
+ *      | 1   | Up                  |             | UP (D0)     |
+ *      | 2   | Down                |             | DOWN (D1)   |
+ *      | 3   | Gnd / Left          |             | LEFT (D2)   |
+ *      | 4   | Gnd / Right         |             | RIGHT (D3)  |
+ *      | 5   | +5VDC               | +5VDC       |
+ *      | 6   | Button A / Button B | Tx          | TL (D4)     |
+ *      | 7   | Select              |             |
+ *      | 8   | Gnd                 | Gnd         |
+ *      | 9   | Start / Button C    | Rx          | TR (D5)     |
+ *      
+ *      \* Pins in parallel mode can have two interpretations, depending on if `Select` has been set low or high (L / H) from the console.
+ *      
+ *      ### Controller Plug
+ *      
+ *      Looking directly at plug (Female 9-pin Type D)
+ *      
+ *      ```
+ *      -------------
+ *      \ 5 4 3 2 1 /
+ *       \ 9 8 7 6 /
+ *        ---------
+ *      ```
+ *      
+ *      ### FTDI USB TTL Serial Cable
+ *      
+ *      From the [datasheet](https://www.ftdichip.com/Support/Documents/DataSheets/Cables/DS_TTL-232RG_CABLES.pdf):
+ *      
+ *      | Colour | Name | Type            | Description                                                                                                                        |
+ *      | ------ | ---- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
+ *      | Black  | GND  | GND             | Device ground supply pin.                                                                                                          |
+ *      | Brown  | CTS# | Input           | Clear to Send Control input / Handshake signal.                                                                                    |
+ *      | Red    | VCC  | Output or input | Power Supply Output except for the TTL-232RG-VIPWE were this is an input and power is supplied by the application interface logic. |
+ *      | Orange | TXD  | Output          | Transmit Asynchronous Data output.                                                                                                 |
+ *      | Yellow | RXD  | Input           | Receive Asynchronous Data input.                                                                                                   |
+ *      | Green  | RTS# | Output          | Request To Send Control Output / Handshake signal.                                                                                 |
+ *      
+ *      ### Mappings
+ *      
+ *      | FTDI Cable   | Mega Drive Port Pin |
+ *      | ------------ | ------------------- |
+ *      | Red (VCC)    | 5 (5v)              |
+ *      | Orange (TXD) | 9 (Rx)              |
+ *      | Yellow (RXD) | 6 (Tx)              |
+ *      | Black (GND)  | 8 (Gnd)             |
+ *      *************************************** */
+#ifndef _SERIAL_H_
+#define _SERIAL_H_
+
+#include "genesis.h"
+#include "types.h"
+
+#define PORT2_CTRL 0xA1000B
+#define PORT2_SCTRL 0xA10019
+#define PORT2_TX 0xA10015
+#define PORT2_RX 0xA10017
+
+#define EXT_CTRL 0xA1000D
+#define EXT_SCTRL 0xA1001F
+#define EXT_TX 0xA1001B
+#define EXT_RX 0xA1001D
+
+#define SCTRL_SIN 0x20
+#define SCTRL_SOUT 0x10
+#define SCTRL_300_BPS 0xC0
+#define SCTRL_1200_BPS 0x80
+#define SCTRL_2400_BPS 0x40
+#define SCTRL_4800_BPS 0x00
+
+#define SCTRL_TFUL 0x1
+#define SCTRL_RRDY 0x2
+#define SCTRL_RERR 0x4
+#define SCTRL_RINT 0x8
+
+#define CTRL_PCS_OUT 0x7F
+
+#define VDP_MODE_REG_3 0xB
+#define VDP_IE2 0x08
+#define INT_MASK_LEVEL_ENABLE_ALL 1
+
+#define SERIAL_BUFLEN	1
+#define SERIAL_TXFIFO_LEN 1
+
+typedef enum IoPort {
+    IoPort_Ext,
+    IoPort_Ctrl2
+} IoPort;
+
+bool serial_is_present(void);
+void serial_write(u8 data);
+bool serial_read_ready(void);
+bool serial_write_ready(void);
+u8 serial_read(void);
+void serial_init(void);
+
+void serial_reset_fifos(void);
+u16 serial_baud_rate(void);
+u8 serial_get_sctrl(void);
+void serial_set_sctrl(u8 value);
+
+/**
+ * \brief Set the serial mode (asynchronous or synchronous).
+ * \param value The mode to set. Use size of buffer for asynchronous mode, or 0 for synchronous mode.
+ * \return Number of bytes available to read in the receive buffer.
+ */
+u16 serial_set_mode(u16 value);
+
+/**
+ * \brief Get the current receive buffer length.
+ * \param port The I/O port to query.
+ * \return Number of bytes available to read in the receive buffer.
+ */
+void serial_set_port(IoPort port);
+
+/**
+ * \brief Get the current I/O port used for serial communication.
+ * \return The I/O port currently in use for serial communication.
+ */
+IoPort serial_get_port(void);
+
+#endif /*_SERIAL_H_*/