LoadComponent

nn::dsp::CTR::LoadComponent Function

Syntax

nn::Result LoadComponent(
     const u8 pComponent[],
     size_t size,
     bit16 maskPram = 0xff,
     bit16 maskDram = 0xff
);

Parameters

Name Description
in pComponent[] Component file address.
in size Component file size.
in maskPram Specifies the DSP-Pram blocks to use. Starting at the LSB, bits 0-7 indicate blocks 0-7, respectively. Bits 8-15 are ignored.
in maskDram Specifies the DSP-Dram blocks to use. See maskDram.

Return Values

Returns the function's execution result. Returns one of the Result values listed below.
Value Description
Result::IsSuccess Process was successful.
ResultNotInitialized The library is not initialized.
ResultAlreadyExists dspcomponent is already loaded.

Description

Loads a DSP component file and starts the DSP.

This function is provided to allow user applications to load the appropriate component when, in the future, the SDK provides DSP components other than the default. There are no plans to release the DSP development environment to users.

When the system enters Sleep Mode, DSP components are automatically unloaded. When the system recovers from Sleep Mode, they are automatically re-loaded. Loaded DSP components must therefore exist in memory before the application calls the nn::dsp::CTR::UnloadComponent function. This memory must be device memory.

Revision History

2011/02/09
Added a note about Sleep Mode.
2010/01/29
Initial version.

CONFIDENTIAL