OS_UnlockCartridge

Syntax

#include <nitro/os.h>
s32 OS_UnlockCartridge( u16 lockID );
 

Arguments

lockID ID used to lock a cartridge.

Return Values

OS_UNLOCK_SUCCESS indicates that the lock was successfully released. (Defined as 0.) OS_UNLOCK_ERROR indicates that there was a lock release error. (Defined as a negative number.)

Description

Releases a lock and passes shared resource access rights to the ARM7 processor

When the unlock succeeds, it accesses the EXMEMCNT register and obtains access rights to the card bus.

When executed on an unlocked module (when trying to release with an ID different from the one that is currently locked), the lock will not be released. It will return an OS_UNLOCK_ERROR.

Internal Operation

Accesses the EXMEMCNT I/O register (0x4000204).

See Also

OS_LockCartridge, OS_TryLockCartridge, OS_UnlockCard, OS_GetLockID

Revision History

2004/11/04 Added Internal Operation description.
2004/07/23 OS_UnLockCard changed to OS_UnlockCard
2004/07/22 Argument format changed from u32 to u16.
2004/06/21 Initial version


CONFIDENTIAL