romdev-mcp 0.1.1

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

@@ -0,0 +1,387 @@
+/**
+ *  \file   console.h
+ *  \brief  TTY text console
+ *  \author Andreas Dietrich
+ *  \date   09/2022
+ *
+ *  This unit provides a simple TTY text console. Characters are written as a
+ *  stream, where lines are automatically wrapped if the horizontal border of
+ *  the screen is reached. When at the bottom of the screen window, the console
+ *  content is moved up by one text line and a blank row is inserted.
+ *
+ *  Per default, the console occupies a standad screen of 40x28 tiles. All text
+ *  attributes, such as font, palette, plane etc., are taken from SGDK text
+ *  settings. Screen updates are done using DMA transfer mode (which can be
+ *  changed with CON_setTransferMethod()).
+ *
+ *  One of the use cases are assert messages. To this end, the Genesis state can
+ *  be automatically reset before text is displayed (see assert macro below).
+ */
+
+// *****************************************************************************
+//
+//  Includes
+//
+// *****************************************************************************
+
+#include "config.h"
+
+#if (MODULE_CONSOLE != 0)
+
+#include "types.h"
+#include "string.h"
+#include "maths.h"
+#include "dma.h"
+
+#pragma once
+
+// *****************************************************************************
+//
+//  Types
+//
+// *****************************************************************************
+
+/// Callback prototype for a vsprintf() function using va_list
+typedef int (*vsprintf_t)(char *buf, const char *fmt, va_list args);
+/// Callback prototype for a vsnprintf() function using va_list
+typedef int (*vsnprintf_t)(char *buf, int count, const char *fmt, va_list args);
+
+// *****************************************************************************
+//
+//  Macros
+//
+// *****************************************************************************
+
+/// Helper macro to stringify numbers
+#define str(s) xstr(s)
+/// Helper macro
+#define xstr(s) #s
+
+/**
+ *  \brief
+ *      Assert a condition.
+ *
+ *  \param condition
+ *      Expression that must evaluate to TRUE, otherwise an error error message
+ *      in printed to the console. This will also reset the system to the SGDK
+ *      default state.
+ *
+ *  Can be disabled by defining NDEBUG or using SGDK release build (LIB_DEBUG=0).
+ */
+
+#if !defined(NDEBUG) && (LIB_DEBUG != 0)
+#define con_assert(condition)                                                          \
+    if ( !(condition) )                                                                \
+    {                                                                                  \
+        CON_reset();                                                                   \
+        CON_systemResetOnNextWrite();                                                  \
+        CON_write(__FILE__":"str(__LINE__)": Assertion \'"str(condition)"\' failed."); \
+        while (TRUE);                                                                  \
+    }
+#else
+#define con_assert(condition)
+#endif
+
+/**
+ *  \brief
+ *      Assert a condition.
+ *
+ * Uppercase version. Same as assert().
+ */
+
+#define CON_ASSERT(condition) con_assert(condition)
+
+// *****************************************************************************
+//
+//  Function Declarations
+//
+// *****************************************************************************
+
+// -----------------------------------------------------------------------------
+// printf functions
+// -----------------------------------------------------------------------------
+
+/**
+ *  \brief
+ *      Standard C library sprintf function.
+ *
+ *  \param buf
+ *      Pointer to the buffer where the resulting C-string is stored.
+ *  \param fmt
+ *      C-string that contains the text to be written. It can optionally
+ *      contain embedded format specifiers that are replaced by the values
+ *      specified in subsequent additional arguments and formatted as requested.
+ *      (See https://en.wikipedia.org/wiki/Printf_format_string)
+ *  \param ... (additional arguments)
+ *      The function may expect a sequence of additional arguments, each
+ *      containing a value to be used to replace a format specifier in the
+ *      format string.
+ *  \return
+ *      The total number of characters written is returned. This count does not
+ *      include the additional null-character automatically appended at the end
+ *      of the string.
+ *
+ *  Composes a string that would result from using a standard C library printf
+ *  function. In case fmt includes format specifiers (beginning with %), the
+ *  additional arguments are formatted and inserted in the resulting string
+ *  replacing their respective specifiers.
+ *
+ *  This function is a wrapper for a vsprintf type function. Per default SGDK's
+ *  built-in vsprintf() is used. CON_setVsprintf() can be used to register
+ *  another implementation, e.g., stbsp_vsprintf().
+ */
+
+int CON_sprintf(char* buf, const char *fmt, ...)  __attribute__ ((format (printf, 2, 3)));
+
+/**
+ *  \brief
+ *      Standard C library snprintf function.
+ *
+ *  \param buf
+ *      Pointer to the buffer where the resulting C-string is stored.
+ *  \param count
+ *      Maximum number of bytes to be used in the buffer. The generated string
+ *      has a length of at most count-1, leaving space for the additional
+ *      terminating null-character.
+ *  \param fmt
+ *      C-string that contains the text to be written. It can optionally
+ *      contain embedded format specifiers that are replaced by the values
+ *      specified in subsequent additional arguments and formatted as requested.
+ *      (See https://en.wikipedia.org/wiki/Printf_format_string)
+ *  \param ... (additional arguments)
+ *      The function may expect a sequence of additional arguments, each
+ *      containing a value to be used to replace a format specifier in the
+ *      format string.
+ *  \return
+ *      The total number of characters written is returned. This count does not
+ *      include the additional null-character automatically appended at the end
+ *      of the string.
+ *
+ *  Composes a string that would result from using a standard C library printf
+ *  function. In case fmt includes format specifiers (beginning with %), the
+ *  additional arguments are formatted and inserted in the resulting string
+ *  replacing their respective specifiers.
+ *
+ *  This function is a wrapper for a vsnprintf type function. Per default no
+ *  function is registered. CON_setVsnprintf() can be used to register an
+ *  implementation, e.g., stbsp_vsnprintf().
+ */
+
+int CON_snprintf(char* buf, int count, const char *fmt, ...)  __attribute__ ((format (printf, 3, 4)));
+
+/**
+ *  \brief
+ *      Register a standard vsprintf function as callback for CON_sprintf()
+ *
+ *  \param vsprintf_func
+ *      Function pointer to a standard C library vsprintf function
+ *
+ *  Registers a callback function that will be wrapped by CON_sprintf(). The
+ *  funcion supplied needs to be a vsprintf function that takes va_list as
+ *  arguments, defined as follows:
+ *
+ *  typedef int (*vsprintf_t)(char *buf, const char *fmt, va_list args);
+ *
+ *  Possible implementations are SGDK's vsprintf() or alternatively
+ *  stbsp_vsprintf() (http://github.com/nothings/stb).
+ */
+
+void CON_setVsprintf(vsprintf_t vsprintf_func);
+
+/**
+ *  \brief
+ *      Register a standard vsnprintf function as callback for CON_snprintf()
+ *
+ *  \param vsnprintf_func
+ *      Function pointer to a standard C library vsnprintf function
+ *
+ *  Registers a callback function that will be wrapped by CON_snprintf(). The
+ *  funcion supplied needs to be a vsnprintf function that takes va_list as
+ *  arguments, defined as follows:
+ *
+ *  typedef int (*vsnprintf_t)(char *buf, int count, const char *fmt, va_list args);
+ *
+ *  A possible implementation is stbsp_vsnprintf()
+ *  (http://github.com/nothings/stb).
+ */
+
+void CON_setVsnprintf(vsnprintf_t vsnprintf_func);
+
+// -----------------------------------------------------------------------------
+// Console setup
+// -----------------------------------------------------------------------------
+
+/**
+ *  \brief
+ *      Set the size of the console window.
+ *
+ *  \param left
+ *      Position of the leftmost window column in tiles. Default is 0.
+ *  \param top
+ *      Position of the topmost window row in tiles. Default is 0.
+ *  \param width
+ *      Width of the console window in tiles. Default is 40.
+ *  \param height
+ *      Height of the console window in tiles. Default is 28.
+ *
+ *  If either width or height are 0 then VDP_getScreenWidth() and
+ *  VDP_getScreenHeight() will be used to determine suitable default values.
+ */
+
+void CON_setConsoleSize(u16 left, u16 top, u16 width, u16 height);
+
+/**
+ *  \brief
+ *      Set the size of the character line buffer.
+ *
+ *  \param size
+ *      Buffer size in bytes. This is the number of characters the buffer can
+ *      hold including a terminating null-character.
+ *
+ *  Sets the size of the character buffer that is used internally to compose
+ *  the formatted output string which is printed on the console.
+ *
+ *  Upon calling CON_setLineBufferSize(), the previous line buffer memory is
+ *  immedieately freed. The new buffer will be allocated once the next call to
+ *  CON_write() occurs.
+ *
+ *  Per default, the buffer size is set to 160 characters. Note that if only a
+ *  vsprintf function is registered (see CON_setVsprintf()), the user is
+ *  responsible for making sure a call to CON_write() does not exceed the line
+ *  buffer. In case a vsnprintf function is registered (see CON_setVsnprintf()),
+ *  it will automtically check the buffer size and prevent overflows.
+ */
+
+void CON_setLineBufferSize(u16 size);
+
+/**
+ *  \brief
+ *      Set the transfer method used to upload the console tile buffer to VDP
+ *      RAM.
+ *
+ *  \param tm
+ *      Transfer method. <br>
+ *      Accepted values are: <br>
+ *      - CPU <br>
+ *      - DMA <br>
+ *      - DMA_QUEUE <br>
+ *      - DMA_QUEUE_COPY
+ *
+ *  This sets the transfer method used with VDP_setTileMapDataRect(). The
+ *  default value is DMA, which will cause an immediate upload. Note that when
+ *  DMA_QUEUE or DMA_QUEUE_COPY is used, the user is responsible for triggering
+ *  DMA upload, e.g., by calling SYS_doVBlankProcess().
+ */
+
+void CON_setTransferMethod(TransferMethod tm);
+
+/**
+ *  \brief
+ *      Reset the console.
+ *
+ *  This function is a shortcut for:
+ *
+ *  CON_setConsoleSize(0, 0, 40, 28); <br>
+ *  CON_setLineBufferSize(160); <br>
+ *  CON_setTransferMethod(DMA);
+ */
+
+void CON_reset();
+
+/**
+ *  \brief
+ *      Reset the system to the SGDK default state when CON_write() is called
+ *      next time.
+ *
+ *  To reset the system the following SGDK functions will be called:
+ *
+ *  - SYS_disableInts() <br>
+ *  - YM2612_reset() <br>
+ *  - PSG_init() <br>
+ *  - Z80_init() <br>
+ *  - VDP_init()
+ */
+
+void CON_systemResetOnNextWrite();
+
+// -----------------------------------------------------------------------------
+// Console write functions
+// -----------------------------------------------------------------------------
+
+/**
+ *  \brief
+ *      Clear the console window.
+ *
+ *  This clears the console window by filling it with space characters. It is
+ *  assumed that the first tile of the font is a space character. DMA settings
+ *  apply here as well.
+ */
+
+void CON_clear();
+
+/**
+ *  \brief
+ *      Set a new cursor position.
+ *
+ *  \param x
+ *      New cursor x position.
+ *  \param y
+ *      New cursor y position.
+ *
+ *  This function specifies a new column and row for the cursor. This is the
+ *  position where the next character will appear when CON_write() is processed.
+ *  A position of (0,0) relates to the tile in the top/left corner.
+ */
+
+void CON_setCursorPosition(u16 x, u16 y);
+
+/**
+ *  \brief
+ *      Return the current cursor position.
+ *
+ *  \return
+ *      A 2D vector containing the current (x,y) position of the cursor, where
+ *      (0,0) means the top/left corner of the console window.
+ */
+
+V2u16 CON_getCursorPosition();
+
+/**
+ *  \brief
+ *      Write a C-string to the console window.
+ *
+ *  \param fmt
+ *      C-string that contains the text to be written. It can optionally
+ *      contain embedded format specifiers that are replaced by the values
+ *      specified in subsequent additional arguments and formatted as requested.
+ *      (See https://en.wikipedia.org/wiki/Printf_format_string)
+ *  \param ... (additional arguments)
+ *      The function may expect a sequence of additional arguments, each
+ *      containing a value to be used to replace a format specifier in the
+ *      format string.
+ *  \return
+ *      The total number of characters written is returned. This count does not
+ *      include the additional null-character automatically appended at the end
+ *      of the string.
+ *
+ *  This function writes a C-string into the console window where lines are
+ *  automatically wrapped if the horizontal border of the screen is reached.
+ *  When at the bottom of the screen window, the console content is moved up by
+ *  one text line and a blank row is inserted.
+ *
+ *  Internally it uses either vsprintf or vsnprintf functions that have been
+ *  registered with CON_setVsprintf() or CON_setVsnprintf(), respectively.
+ *
+ *  While processing the string, this function evaluates and executes escape
+ *  control sequences. The following control characters are supported:
+ *
+ *  - \\b : backspace <br>
+ *  - \\n : new line (line feed) <br>
+ *  - \\r : carriage return <br>
+ *  - \\t : horizontal tab <br>
+ *  - \\v : vertical tab
+ */
+
+int CON_write(const char *fmt, ...)  __attribute__ ((format (printf, 1, 2)));
+
+#endif // MODULE_CONSOLE

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

@@ -0,0 +1,116 @@
+/**
+ *  \file everdrive.h
+ *  \brief Everdrive support
+ *  \author Krikzz
+ *  \date XX/20XX
+ *
+ * This unit provides support for everdrive flash cart
+ */
+
+#ifndef _EVERDRIVE
+#define _EVERDRIVE
+
+#if (MODULE_EVERDRIVE != 0)
+
+//config register bits
+#define _SS 0
+#define _FULL_SPEED 1
+#define _SPI16 2
+#define _GAME_MODE 3
+#define _SMS_MODE 4
+#define _HARD_RESET 5
+#define _RAM_MODE_1 6
+#define _RAM_ON 7
+#define _VBL_CATCH 8
+#define _MEGAKEY_ON 9
+#define _MEGAKEY_REGION_1 10
+#define _SSF_MODE_ON 11
+#define _RAM_FS 12
+#define _CART 13
+
+//state register bits
+#define _SPI_READY 0
+#define _RY 1
+#define _SMS_KEY 2
+#define _SD_CART 3
+
+//everdrive hardware registers
+#define SPI_PORT *((volatile u16*) (0xA13000))
+#define CFG_PORT *((volatile u16*) (0xA13002))
+#define VBL_PORT *((volatile u16*) (0xA13004))
+#define SRAM_BANK_PORT *((volatile u16*) (0xA13006))
+#define VER_PORT *((volatile u16*) (0xA13008))
+#define ROM_MAP_PORT *((volatile u16*) (0xA1300a))
+
+
+#define CFGC(bit)(cfg &= ~(1 << bit), CFG_PORT = cfg)
+#define CFGS(bit)(cfg |= (1 << bit), CFG_PORT = cfg)
+
+#define IS_RY (CFG_PORT & (1 << _RY))
+#define IS_SPI_READY (CFG_PORT & (1 << _SPI_READY))
+#define IS_SMS_KEY_PRESSED (CFG_PORT & (1 << _SMS_KEY))
+#define IS_SD_SLOT_EMPTY (CFG_PORT & (1 << _SD_CART))
+
+#define SPI_HI_SPEED_ON CFGS(_FULL_SPEED)
+#define SPI_HI_SPEED_OFF CFGC(_FULL_SPEED)
+
+#define SPI16_ON CFGS(_SPI16);
+#define SPI16_OFF CFGC(_SPI16);
+
+#define SS_ON CFGC(_SS)
+#define SS_OFF CFGS(_SS)
+
+#define CART_ON CFGC(_CART)
+#define CART_OFF CFGS(_CART)
+
+#define RAM_ON CFGS(_RAM_ON);
+#define RAM_OFF CFGC(_RAM_ON);
+
+#define VBL_CATCH_ON CFGS(_VBL_CATCH);
+#define VBL_CATCH_OFF CFGC(_VBL_CATCH);
+
+#define SPI_BUSY while(!IS_SPI_READY)
+#define EPR_BUSY while(!IS_RY)
+
+
+
+extern u16 cfg;
+
+
+//SD/MMC card initialization. should be run just one times, aer this cart will be ready for work
+//will return 0 success
+u8 evd_mmcInit();
+
+
+//read block (512b) from SD/MMC card. mmc_addr should be multiple to 512
+//will return 0 success
+u8 evd_mmcRdBlock(u32 mmc_addr, u8 *stor);
+
+
+//write block (512b) to SD/MMC card. mmc_addr should be multiple to 512
+//will return 0 success
+u8 evd_mmcWrBlock(u32 mmc_addr, u8 *data_ptr);
+
+
+//erase flash memry sector(64kb). rom_addr should be multiple to 64k.
+//code of this function should be placed in ram because rom memory inaccessible while erase process
+//WARNING! this function may damage cart bios if sectors in range 0 - 0x40000 will be erased
+void evd_eprEraseBlock(u32 rom_addr);
+
+
+//write data to flash memory. len should be multiple to 4.
+//each byte of flah memory should be erased before writeing by evd_eprEraseBlock
+//code of this function should be placed in ram because rom memory inaccessible while writeing process
+//WARNING! this function may damage cart bios if memory will be writen in area 0 - 0x40000
+void evd_eprProgBlock(u16 *data, u32 rom_addr, u32 len);
+
+
+//everdrive initialization.
+//def_rom_bank = 0 if app placed in 0-0x400000 area, 1 if in 0x400000-0x800000 arae
+//_is_ram_app = 0 if app assembled for work in rom, 1 if app assembleed for work in ram
+void evd_init(u16 def_rom_bank, u8 _is_ram_app);
+
+
+#endif // MODULE_EVERDRIVE
+
+#endif

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

@@ -0,0 +1,84 @@
+/**
+ *  \file fat16.h
+ *  \brief FAT16 file system support
+ *  \author Krikzz
+ *  \date XX/20XX
+ *
+ * This unit provides basic FAT16 file system support through everdrive flash cart hardware
+ */
+
+#ifndef _FAT16_H
+#define _FAT16_H
+
+
+#if (MODULE_FAT16 != 0)
+
+#define FAT16_DIR_SIZE 32
+#define FAT16_TYPE_FILE  0x20
+#define FAT16_TYPE_DIR  0x10
+
+
+typedef struct {
+    u8 pointer[3]; //0
+    u8 oem_name[8]; //3
+    u16 byte_per_sector; //11
+    u8 sector_per_cluster; //13
+    u16 reserved_sectors; //14
+    u8 fat_copys; //16
+    u16 root_size; //17
+    u16 small_partition_sectros; //19
+    u8 drive_type; //21
+    u16 sectors_per_fat; //22
+    u16 sectors_per_track; //24
+    u16 heads; //26
+    u32 first_reserved_sectors; //28
+    u32 total_partition_sectors; //32
+    u16 drive_number; //36
+    u8 extendet_boot_signature; //38
+    u32 serial_number; //39
+    u8 drive_name[11]; //43
+    u8 fat_name[8]; //54
+} Fat16PBR;
+
+
+typedef struct {
+    u8 name[14];
+    u8 long_name[38];
+    u8 flags;
+    u16 entry;
+    u32 size;
+    u32 rec_addr;
+} Fat16Record;
+
+typedef struct {
+    Fat16Record records[FAT16_DIR_SIZE];
+    u16 entry;
+    volatile u16 size;
+} Fat16Dir;
+
+typedef struct {
+    Fat16Record *record;
+    u8 sectror_buff[512];
+    u16 cluster;
+    u32 pos;
+    u32 addr_buff;
+    u8 sector;
+} Fat16File;
+
+
+extern Fat16PBR fat16_pbr;
+
+
+u8 fat16Init();
+u8 fat16OpenDir(u16 entry, Fat16Dir *dir);
+u8 fat16OpenFile(Fat16Record *rec, Fat16File *file);
+u8 fat16ReadNextSector(Fat16File *file);
+u8 fat16WriteNextSector(Fat16File *file);
+u8 fat16DeleteRecord(Fat16Record *rec);
+u8 fat16CreateRecord(Fat16Record *rec, Fat16Dir *dir);
+u8 fat16SkipSectors(Fat16File *file, u16 num);
+
+#endif  /* MODULE_FAT16 */
+
+
+#endif  /* _FAT16_H */