libElysianVMU 1.6.0
Full-featured, accurate, cross-platform library emulating the Dreamcast's Visual Memory Unit
Loading...
Searching...
No Matches
Data Fields
EvmuFlash Struct Reference
Peripherals

#include <evmu_flash.h>

Inheritance diagram for EvmuFlash:
EvmuPeripheral EvmuIMemory EvmuIBehavior EvmuFat EvmuFileManager

Data Fields

union { 
 
   EvmuFlashClass *   pClass 
 
   EvmuPeripheral   base 
 
};  
 
GblBool dataChanged
 
- Data Fields inherited from EvmuPeripheral
union { 
 
   EvmuPeripheralClass *   pClass 
 
   GblObject   base 
 
};  
 
GblFlags logLevel
 

Related Symbols

(Note that these are not member symbols.)

Read Methods

Methods for reading or fetching state data

EVMU_FLASH_PROGRAM_STATE EvmuFlash_programState (const EvmuFlash *pSelf)
 
size_t EvmuFlash_programBytes (const EvmuFlash *pSelf)
 
EvmuAddress EvmuFlash_targetAddress (const EvmuFlash *pSelf)
 
GblBool EvmuFlash_unlocked (const EvmuFlash *pSelf)
 
Memory Operations

Methods for read/write operations on flash memory

EvmuWord EvmuFlash_readByte (const EvmuFlash *pSelf, EvmuAddress address)
 
EVMU_RESULT EvmuFlash_readBytes (const EvmuFlash *pSelf, EvmuAddress base, void *pData, size_t *pBytes)
 
EVMU_RESULT EvmuFlash_writeByte (EvmuFlash *pSelf, EvmuAddress address, EvmuWord value)
 
EVMU_RESULT EvmuFlash_writeBytes (EvmuFlash *pSelf, EvmuAddress base, const void *pData, size_t *pBytes)
 
- Related Symbols inherited from EvmuPeripheral
 
- Related Symbols inherited from EvmuIMemory
 
 
 
 
 
 

Detailed Description

EvmuFlash offers the lowest, hardware-level access to the VMU's flash storage.

Unless you know what you're doing, it's advised to work with a higher level API.

See also
EvmuFat, EvmuFileManager

Definition at line 110 of file evmu_flash.h.

Friends And Related Symbol Documentation

◆ EvmuFlash_programBytes()

size_t EvmuFlash_programBytes ( const EvmuFlash * pSelf)
related

Returns the number of bytes remaining that can be written before reprogramming.

◆ EvmuFlash_programState()

EVMU_FLASH_PROGRAM_STATE EvmuFlash_programState ( const EvmuFlash * pSelf)
related

Returns the current state of the flash programming sequence for unlocking writes.

◆ EvmuFlash_readByte()

EvmuWord EvmuFlash_readByte ( const EvmuFlash * pSelf,
EvmuAddress address )
related

Reads a value from flash at the given address and returns its value.

◆ EvmuFlash_readBytes()

EVMU_RESULT EvmuFlash_readBytes ( const EvmuFlash * pSelf,
EvmuAddress base,
void * pData,
size_t * pBytes )
related

Reads the given number of bytes from flash into the buffer, returning the number successfully read.

◆ EvmuFlash_targetAddress()

EvmuAddress EvmuFlash_targetAddress ( const EvmuFlash * pSelf)
related

Returns the current target address of the next LDF or STF flash instruction.

◆ EvmuFlash_unlocked()

GblBool EvmuFlash_unlocked ( const EvmuFlash * pSelf)
related

Returns whether or not flash is currently unlocked for writing.

◆ EvmuFlash_writeByte()

EVMU_RESULT EvmuFlash_writeByte ( EvmuFlash * pSelf,
EvmuAddress address,
EvmuWord value )
related

Writes a value to flash at the given address (bypassing unlock sequence)

◆ EvmuFlash_writeBytes()

EVMU_RESULT EvmuFlash_writeBytes ( EvmuFlash * pSelf,
EvmuAddress base,
const void * pData,
size_t * pBytes )
related

Writes the given buffer to flash, returning nubmer of bytes written (bypassing unlock sequence)

Field Documentation

◆ base

EvmuPeripheral EvmuFlash::base

Inherited base instance structure.

Definition at line 110 of file evmu_flash.h.

◆ dataChanged

GblBool EvmuFlash::dataChanged

User toggle: will be set after a flash value changes, you can reset and poll for changes.

Definition at line 112 of file evmu_flash.h.

◆ pClass

EvmuFlashClass* EvmuFlash::pClass

Pointer to class/vtable structure.

Definition at line 110 of file evmu_flash.h.

The documentation for this struct was generated from the following file: