API Functions

Video Functions

• void ClearVram(void)
• void ClearVsyncFlag(void)
• void DrawMap2(unsigned char x,unsigned char y,const char *map)
• void DrawMap(unsigned char x,unsigned char y,const int *map)
• void FadeIn(unsigned char speed,bool blocking)
• void FadeOut(unsigned char speed,bool blocking)
• void Fill(int x,int y,int width,int height,int tile)
• void FontFill(int x,int y,int width,int height,int tile)
• unsigned char GetTile(char x, char y)
• unsigned char GetVsyncFlag(void)
• void MapSprite(unsigned char startSprite,const char *map)
• void MapSprite2(unsigned char startSprite, const char *map, u8 spriteFlags)
• void MoveSprite(unsigned char startSprite,unsigned char x,unsigned char y,unsigned char width,unsigned char height)
• void PrintBinaryByte(char x,char y,unsigned char byte)
• void PrintByte(int x,int y, unsigned char val,bool zeropad)
• void PrintChar(int x,int y,char c)
• void PrintHexByte(char x,char y,unsigned char byte)
• void PrintHexInt(char x,char y,int byte)
• void PrintInt(int x,int y, unsigned int,bool zeropad)
• void PrintLong(int x,int y, unsigned long val)
• void Print(int x,int y,const char *string)
• void SetFontTable(const char *data)
• void SetFontTilesIndex(unsigned char index)
• void SetRenderingParameters(u8 firstScanlineToRender, u8 verticalLinesToRender)
• void SetSpritesOptions(unsigned char params)
• void SetSpritesTileTable(const char *data)
• void SetSpriteVisibility(bool visible)
• void SetTileTable(const char *data)
• void SetSpritesTileTableBank(char bank, const char *data)
• void SetTile(char x,char y, unsigned int tileId)
• void SetUserRamTilesCount(u8 count)
• void WaitVsync(int count)

Sound Functions

• void InitMusicPlayer(const struct PatchStruct *patchPointersParam)
• void ResumeSong()
• void SetMasterVolume(unsigned char vol)
• void StartSong(const char *midiSong)
• void StopSong()
• void TriggerFx(unsigned char patch,unsigned char volume, bool retrig)
• void TriggerNote(unsigned char channel,unsigned char patch,unsigned char note,unsigned char volume)
• void EnableSoundEngine()
• void DisableSoundEngine()
• bool IsSongPlaying()

Controllers Functions

• unsigned char DetectControllers()
• void EnableSnesMouse(unsigned char spriteIndex,const char *spriteMap)
• unsigned char GetMouseSensitivity()
• unsigned int ReadJoypadExt(unsigned char joypadNo)
• unsigned int ReadJoypad(unsigned char joypadNo)
• bool SetMouseSensitivity(unsigned char value)

EEPROM Functions

• char EepromReadBlock(unsigned int blockId,struct EepromBlockStruct *block)
• char EepromWriteBlock(struct EepromBlockStruct *block)

Bootloader API Functions

The Bootloader API provides access to all types of SD cards and their filesystems which the bootloader is capable to handle. It doesn't require a bootloader to function (reverts to SDSC and FAT16 that case). It also supports asking for loading a new game with bootloaders which can provide such an interface.

To use the Bootloader API library, you need to include it in your Makefile. See the Bootloader library demo for example.

Bootloader API guide

• void SPI_Set_SD(void)
• void SPI_Set_Max(void)
• uint8_t SDC_CRC7_Byte(uint8_t crcval, uint8_t byte)
• uint16_t SDC_CRC16_Byte(uint16_t crcval, uint8_t byte)
• uint8_t SDC_Wait_FF(void)
• uint8_t SDC_Command(uint8_t cmd, uint32_t data)
• void SDC_Release(void)
• uint8_t SDC_Init(sdc_struct_t* sds)
• void SDC_CRC_Enable(sdc_struct_t* sds, uint8_t ena)
• uint32_t SDC_Command_Address(sdc_struct_t* sds, uint32_t sector)
• uint8_t SDC_Read_Sector(sdc_struct_t* sds, uint32_t sector)
• uint8_t SDC_Write_Sector(sdc_struct_t* sds, uint32_t sector)
• uint8_t FS_Init(sdc_struct_t* sds)
• uint32_t FS_Get_Sector(sdc_struct_t* sds)
• uint8_t FS_Read_Sector(sdc_struct_t* sds)
• uint8_t FS_Write_Sector(sdc_struct_t* sds)
• uint8_t FS_Next_Sector(sdc_struct_t* sds)
• void FS_Reset_Sector(sdc_struct_t* sds)
• void FS_Select_Root(sdc_struct_t* sds)
• void FS_Select_Cluster(sdc_struct_t* sds, uint32_t cluster)
• uint32_t FS_Get_File_Cluster(sdc_struct_t* sds, uint8_t* fdesc)
• uint32_t FS_Find(sdc_struct_t* sds, uint16_t ch01, uint16_t ch23, uint16_t ch45, uint16_t ch67, uint16_t ex01, uint16_t ex2x)
• uint32_t FS_Get_Pos(sdc_struct_t* sds)
• void FS_Set_Pos(sdc_struct_t* sds, uint32_t pos)
• void Bootld_Request(sdc_struct_t* sds)

SD Card Functions

• FRESULT pf_mount(FATFS* fs)
• FRESULT pf_open(const char* path)
• FRESULT pf_read(void* buff, WORD btr, WORD* br)
• FRESULT pf_write(const void* buff, WORD btw, WORD* bw)
• FRESULT pf_lseek(DWORD offset)
• FRESULT pf_opendir(DIR* dp, const char* path)
• FRESULT pf_readdir(DIR* dp, FILINFO* fno)

SPI Ram Functions

To use the SPI RAM library, you need to include it in your Makefile. See the SD-SPIRAM demo for example.

• void SpiRamInit(void)
• u8 SpiRamReadU8(u8 bank, u16 addr)
• s8 SpiRamReadS8(u8 bank, u16 addr)
• void SpiRamWriteU8(u8 bank, u16 addr, u8 val)
• void SpiRamWriteS8(u8 bank, u16 addr, s8 val)
• u16 SpiRamReadU16(u8 bank, u16 addr)
• s16 SpiRamReadS16(u8 bank, u16 addr)
• void SpiRamWriteU16(u8 bank, u16 addr, u16 val)
• void SpiRamWriteS16(u8 bank, u16 addr, s16 val)
• u32 SpiRamReadU32(u8 bank, u16 addr)
• s32 SpiRamReadS32(u8 bank, u16 addr)
• void SpiRamWriteU32(u8 bank, u16 addr, u32 val)
• void SpiRamWriteS32(u8 bank, u16 addr, s32 val)
• void SpiRamReadInto(u8 bank, u16 addr, void* dst, u16 len)
• void SpiRamWriteFrom(u8 bank, u16 addr, void* src, u16 len)
• void SpiRamSeqReadStart(u8 bank, u16 addr)
• u8 SpiRamSeqReadU8(void)
• s8 SpiRamSeqReadS8(void)
• u16 SpiRamSeqReadU16(void)
• s16 SpiRamSeqReadS16(void)
• u32 SpiRamSeqReadU32(void)
• s32 SpiRamSeqReadS32(void)
• void SpiRamSeqReadInto(void* dst, u16 len)
• void SpiRamSeqReadEnd(void)
• void SpiRamSeqWriteStart(u8 bank, u16 addr)
• void SpiRamSeqWriteU8(u8 val)
• void SpiRamSeqWriteS8(s8 val)
• void SpiRamSeqWriteU16(u16 val)
• void SpiRamSeqWriteS16(s16 val)
• void SpiRamSeqWriteU32(u32 val)
• void SpiRamSeqWriteS32(s32 val)
• void SpiRamSeqWriteFrom(void* src, u16 len)
• void SpiRamSeqWriteEnd(void)

Uart Functions

• void InitUartRxBuffer(void)
• void InitUartTxBuffer(void)
• void UartGoBack(u8 count)
• u8 UartUnreadCount(void)
• bool IsUartRxBufferEmpty(void)
• bool IsUartTxBufferEmpty(void)
• bool IsUartTxBufferFull(void)
• u8 UartSendChar(u8 data)
• s16 UartReadChar(void)

Miscellaneous Functions

• void SoftReset(void)
• void WaitUs(unsigned int microseconds)
• void SetUserPreVsyncCallback(VsyncCallBackFunc)
• void SetUserPostVsyncCallback(VsyncCallBackFunc)
• void SetLedOn(void)
• void SetLedOff(void)
• void ToggleLed(void)
• void GetTrueRandomSeed(void)
• u16 GetPrngNumber(u16 seed)
• unsigned char ReadPowerSwitch(void)

Kernel Internal Functions

Though you can use these functions, they are subject to change or be removed at any release.

• bool isEepromFormatted()
• unsigned char ReadEeprom(unsigned int addr)
• void WriteEeprom(unsigned int addr,unsigned char value)

Deprecated Functions

• void LoadMap(void)
• void RestoreTile(char x,char y)
• void SetFont(char x,char y, unsigned char tileId)
• void SetTileMap(const int *data)