CTRDG_EraseAgbFlashChip

Syntax

#include <nitro/ctrdg.h>
u16 CTRDG_EraseAgbFlashChip(void);
  
Corresponding AGB function: u16 (*EraseFlashChip)()

Arguments

None.

Return Values

Returns zero if the erasure succeeds. Returns a nonzero value if it fails.

Description

Completely erases all data on the AGB backup device chip.

The access cycle setting does not need to be set beforehand because it is created inside the function. In addition, the OS_InitTick function must be called in advance because clock ticks are used by this function to measure timeouts.

Note: All interrupts are disabled inside this function, and the cartridge bus is locked for a set period. In particular, when this function is called, do not use DMA that starts automatically during direct sound and V/H blank synchronization, display synchronization, cartridge request, and so on.

Note that the AGB backup device cannot be accessed normally with IS-NITRO-DEBUGGER version 1.66 or earlier.

See Also

CTRDG_EraseAgbFlashSector
CTRDG_EraseAgbFlashChipAsync
CTRDG_EraseAgbFlashSectorAsync

Revision History

2006/05/25 Added a description that the AGB backup device cannot be accessed normally with IS-NITRO-DEBUGGER version 1.66 or earlier.
2006/04/07 Initial version.


CONFIDENTIAL