SGDK/mapper_8h_source.html

#ifndef _MAPPER_H_

#define _MAPPER_H_


#include "config.h"

#include "types.h"


#define MAPPER_BASE     0xA130F1


#define BANK_SIZE       0x80000

#define BANK_IN_MASK    (BANK_SIZE - 1)

#define BANK_OUT_MASK   (0xFFFFFFFF ^ BANK_IN_MASK)


#if (ENABLE_BANK_SWITCH != 0)

    #define FAR(data) SYS_getFarData((void*) (data))

    #define FAR_SAFE(data, size) SYS_getFarDataSafe((void*) (data), size)

#else

    #define FAR(data) data

    #define FAR_SAFE(data, size) data

#endif


void SYS_resetBanks();


u16 SYS_getBank(u16 regionIndex);

void SYS_setBank(u16 regionIndex, u16 bankIndex);


void* SYS_getFarData(void* data);

void* SYS_getFarDataEx(void* data, bool high);

bool SYS_isCrossingBank(void* data, u32 size);

void* SYS_getFarDataSafe(void* data, u32 size);

void* SYS_getFarDataSafeEx(void* data, u32 size, bool high);


bool SYS_getNextFarAccessRegion();

void SYS_setNextFarAccessRegion(bool high);


#endif // _MAPPER_H_

config.h
Basic SGDK library configuration file.

SYS_getNextFarAccessRegion
bool SYS_getNextFarAccessRegion()
Retrieve the value of the next used region for FAR access with bank switch if data is not already acc...
Definition mapper.c:272

SYS_getFarDataSafe
void * SYS_getFarDataSafe(void *data, u32 size)
Make the given binary data ressource accessible and return a pointer to it (safe version with possibl...
Definition mapper.c:220

SYS_setBank
void SYS_setBank(u16 regionIndex, u16 bankIndex)
Set the current bank of specified region index.
Definition mapper.c:30

SYS_isCrossingBank
bool SYS_isCrossingBank(void *data, u32 size)
Returns TRUE if given binary data is crossing 2 512 KB banks.
Definition mapper.c:212

SYS_setNextFarAccessRegion
void SYS_setNextFarAccessRegion(bool high)
Set the value of the next used region for FAR access with bank switch if data is not already accessib...
Definition mapper.c:277

SYS_getFarData
void * SYS_getFarData(void *data)
Make the given binary data ressource accessible and return a pointer to it.
Definition mapper.c:168

SYS_getBank
u16 SYS_getBank(u16 regionIndex)
Returns the current bank of specified region index.
Definition mapper.c:25

SYS_getFarDataSafeEx
void * SYS_getFarDataSafeEx(void *data, u32 size, bool high)
Make the given binary data ressource accessible and return a pointer to it (safe version with possibl...
Definition mapper.c:246

SYS_resetBanks
void SYS_resetBanks()
Reset all banks to their initial / default value (automatically called at reset)
Definition mapper.c:17

SYS_getFarDataEx
void * SYS_getFarDataEx(void *data, bool high)
Make the given binary data ressource accessible and return a pointer to it.
Definition mapper.c:187

types.h
Types definition.

u32
unsigned long u32
Definition types.h:105

u16
unsigned short u16
Definition types.h:100