1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" />
7<title>LoadComponent</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/dsp/Overview.html">dsp</a>::<a href="../../../nn/dsp/CTR/Overview.html">CTR</a>::LoadComponent</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../../nn/Result/Overview.html">nn::Result</a> LoadComponent(
15     const <a href="../../../nn_types/u8.html">u8</a> pComponent[],
16     size_t size,
17     <a href="../../../nn_types/bit16.html">bit16</a> maskPram = 0xff,
18     <a href="../../../nn_types/bit16.html">bit16</a> maskDram = 0xff
19);
20</pre>
21    </div>
22<h2>Parameters</h2>
23    <div class="section">
24      <table class="arguments">
25        <thead>
26          <tr>
27            <td width="15" />
28<th>Name</th>
29<td>Description</td>
30          </tr>
31        </thead>
32        <tr>
33<td>in</td>
34<th>pComponent[]</th>
35<td>Component file address.</td>
36        </tr>
37        <tr>
38<td>in</td>
39<th>size</th>
40<td>Component file size.</td>
41        </tr>
42        <tr>
43<td>in</td>
44<th>maskPram</th>
45<td>Specifies the DSP-Pram blocks to use. Starting at the LSB, bits 0-7 indicate blocks 0-7, respectively. Bits 8-15 are ignored.</td>
46        </tr>
47        <tr>
48<td>in</td>
49<th>maskDram</th>
50<td>Specifies the DSP-Dram blocks to use. See <SPAN class="argument">maskDram</SPAN>.</td>
51        </tr> </table>
52    </div>
53<h2>Return Values</h2>
54<div class="section">Returns the function's execution result. Returns one of the <a href="../../../nn/Result/Overview.html"><CODE>Result</CODE></a> values listed below. <br />
55      <table class="arguments">
56        <thead>
57          <tr>
58<th>Value</th>
59<td>Description</td>
60          </tr>
61        </thead>
62        <tr>
63<th><CODE>Result::IsSuccess</CODE></th>
64<td>Process was successful.</td>
65        </tr>
66        <tr>
67<th><CODE>ResultNotInitialized</CODE></th>
68<td>The library is not initialized.</td>
69        </tr>
70        <tr>
71<th><CODE>ResultAlreadyExists</CODE></th>
72<td><CODE>dspcomponent</CODE> is already loaded.</td>
73        </tr>
74      </table> </div>
75<h2>Description</h2>
76    <div class="section">
77<p>Loads a DSP component file and starts the DSP.</p><p>
78This 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.
79      </p><p>
80When 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 <a href="../../../nn/dsp/CTR/UnloadComponent.html"><CODE>nn::dsp::CTR::UnloadComponent</CODE></a> function. This memory must be device memory.
81      </p></div>
82<h2>Revision History</h2>
83    <div class="section">
84      <dl class="history">
85        <dt>2011/02/09</dt>
86<dd>Added a note about Sleep Mode.<br />
87        </dd>
88        <dt>2010/01/29</dt>
89<dd>Initial version.<br />
90        </dd>
91      </dl>
92    </div>
93  <hr><p>CONFIDENTIAL</p></body>
94</html>