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    <style type="text/css"><!--
8      span.static_style
9      {
10        font-size			: 8pt;
11        color				: white;
12        font-weight			: bold;
13        background			: #44f;
14        border-left			: solid 1px #aaf;
15        border-top			: solid 1px #aaf;
16        border-right		: solid 1px #00c;
17        border-bottom		: solid 1px #00c;
18        padding-left		: 2px;
19        padding-right		: 2px;
20      }
21
22      span.virtual_style
23      {
24        font-size			 : 8pt;
25        color				 : white;
26        font-weight			: bold;
27        background			: #0a0;
28        border-left			: solid 1px #0f0;
29        border-top			: solid 1px #0f0;
30        border-right		: solid 1px #060;
31        border-bottom		: solid 1px #060;
32        padding-left		: 2px;
33        padding-right		: 2px;
34      }
35
36      span.protected_style
37      {
38        font-size			 : 8pt;
39        color				 : white;
40        font-weight			: bold;
41        background			: #444;
42        border-left			: solid 1px #ccc;
43        border-top			: solid 1px #ccc;
44        border-right		: solid 1px #222;
45        border-bottom		: solid 1px #222;
46        padding-left		: 2px;
47        padding-right		: 2px;
48      }
49        --></style>
50<title>nn::dsp::CTR</title>
51  </head>
52  <body>
53<h1><CODE>nn::dsp::CTR</CODE> Namespace</h1>
54<h2>Description</h2>
55    <div class="section">
56<p>The DSP namespace. <br />(This can also be written without the &quot;<CODE>::CTR</CODE>&quot; portion.)</p><!-- write here --></div>
57    <a name="class" id="class">
58<h2>Classes</h2>
59      <div class="section">
60        <table class="members">
61          <tr>
62<th class="category" colspan="2"><CODE>Result</CODE></th>
63          </tr>
64          <tr>
65            <th>
66<a href="../../../nn/dsp/CTR/ResultNotInitialized/Overview.html">nn::dsp::CTR::ResultNotInitialized</a>
67            </th>
68<td>Indicates that the library has not been initialized.</td>
69          </tr>
70          <tr>
71            <th>
72<a href="../../../nn/dsp/CTR/ResultAlreadyExists/Overview.html">nn::dsp::CTR::ResultAlreadyExists</a>
73            </th>
74<td>Indicates that it already exists.</td>
75          </tr> </table>
76      </div>
77    </a> <a name="function" id="function">
78<h2>Functions</h2>
79      <div class="section">
80        <table class="members">
81          <tr>
82<th class="category" colspan="3">Initialize/Finalize</th>
83          </tr>
84          <tr>
85            <td width="100">  </td>
86            <th>
87<a href="../../../nn/dsp/CTR/Initialize.html"><CODE>Initialize</CODE></a>
88            </th>
89<td>Initializes the DSP library and establishes a session with the DSP process.</td>
90          </tr>
91          <tr>
92            <td width="100">  </td>
93            <th>
94<a href="../../../nn/dsp/CTR/Finalize.html"><CODE>Finalize</CODE></a>
95            </th>
96<td>Shuts down the DSP library.</td>
97          </tr>
98          <tr>
99            <td width="100">  </td>
100            <th>
101<a href="../../../nn/dsp/CTR/LoadComponent.html"><CODE>LoadComponent</CODE></a>
102            </th>
103<td>Loads a DSP component file and starts the DSP.</td>
104          </tr>
105          <tr>
106            <td width="100">  </td>
107            <th>
108<a href="../../../nn/dsp/CTR/LoadDefaultComponent.html"><CODE>LoadDefaultComponent</CODE></a>
109            </th>
110<td>Loads the default DSP component file (sound) and starts the DSP.</td>
111          </tr>
112          <tr>
113            <td width="100">  </td>
114            <th>
115<a href="../../../nn/dsp/CTR/UnloadComponent.html"><CODE>UnloadComponent</CODE></a>
116            </th>
117<td>Stops the DSP.</td>
118          </tr>
119          <tr>
120<th class="category" colspan="3">CPU-DSP Communication</th>
121          </tr>
122          <tr>
123            <td width="100">  </td>
124            <th>
125<a href="../../../nn/dsp/CTR/RegisterInterruptEvents.html"><CODE>RegisterInterruptEvents</CODE></a>
126            </th>
127<td>Registers an event handle with the DSP process in order to receive DSP interrupts.</td>
128          </tr>
129          <tr>
130            <td width="100">  </td>
131            <th>
132<a href="../../../nn/dsp/CTR/RecvData.html"><CODE>RecvData</CODE></a>
133            </th>
134<td>Gets the value of a reply register.</td>
135          </tr>
136          <tr>
137            <td width="100">  </td>
138            <th>
139<a href="../../../nn/dsp/CTR/SendData.html"><CODE>SendData</CODE></a>
140            </th>
141<td>Sets the value of a command register.</td>
142          </tr>
143          <tr>
144            <td width="100">  </td>
145            <th>
146<a href="../../../nn/dsp/CTR/RecvDataIsReady.html"><CODE>RecvDataIsReady</CODE></a>
147            </th>
148<td>Determines whether a value has been written to the reply register.</td>
149          </tr>
150          <tr>
151            <td width="100">  </td>
152            <th>
153<a href="../../../nn/dsp/CTR/SendDataIsEmpty.html"><CODE>SendDataIsEmpty</CODE></a>
154            </th>
155<td>Determines whether a command register has been loaded.</td>
156          </tr>
157          <tr>
158            <td width="100">  </td>
159            <th>
160<a href="../../../nn/dsp/CTR/ReadPipeIfPossible.html"><CODE>ReadPipeIfPossible</CODE></a>
161            </th>
162<td>Reads data from a DSP pipe.</td>
163          </tr>
164          <tr>
165            <td width="100">  </td>
166            <th>
167<a href="../../../nn/dsp/CTR/WriteProcessPipe.html"><CODE>WriteProcessPipe</CODE></a>
168            </th>
169<td>Writes data to a DSP pipe.</td>
170          </tr>
171          <tr>
172            <td width="100">  </td>
173            <th>
174<a href="../../../nn/dsp/CTR/CheckSemaphoreRequest.html"><CODE>CheckSemaphoreRequest</CODE></a>
175            </th>
176<td>Gets a semaphore request.</td>
177          </tr>
178          <tr>
179            <td width="100">  </td>
180            <th>
181<a href="../../../nn/dsp/CTR/ClearSemaphore.html"><CODE>ClearSemaphore</CODE></a>
182            </th>
183<td>Clears semaphores.</td>
184          </tr>
185          <tr>
186            <td width="100">  </td>
187            <th>
188<a href="../../../nn/dsp/CTR/MaskSemaphore.html"><CODE>MaskSemaphore</CODE></a>
189            </th>
190<td>Sets a semaphore mask.</td>
191          </tr>
192          <tr>
193            <td width="100">  </td>
194            <th>
195<a href="../../../nn/dsp/CTR/GetSemaphore.html"><CODE>GetSemaphore</CODE></a>
196            </th>
197<td>Gets semaphore values.</td>
198          </tr>
199          <tr>
200            <td width="100">  </td>
201            <th>
202<a href="../../../nn/dsp/CTR/SetSemaphore.html"><CODE>SetSemaphore</CODE></a>
203            </th>
204<td>Sets semaphore values.</td>
205          </tr>
206          <tr>
207<th class="category" colspan="3">Other</th>
208          </tr>
209          <tr>
210            <td width="100">  </td>
211            <th>
212<a href="../../../nn/dsp/CTR/FlushDataCache.html"><CODE>FlushDataCache</CODE></a>
213            </th>
214<td>Writes data for the specified cache range back into memory and invalidates the cache.</td>
215          </tr>
216          <tr>
217            <td width="100">  </td>
218            <th>
219<a href="../../../nn/dsp/CTR/Sleep.html"><CODE>Sleep</CODE></a>
220            </th>
221<td>Temporarily interrupts the DSP and runs shutdown processing.</td>
222          </tr>
223          <tr>
224            <td width="100">  </td>
225            <th>
226<a href="../../../nn/dsp/CTR/WakeUp.html"><CODE>WakeUp</CODE></a>
227            </th>
228<td>Restores interrupted DSP processing.</td>
229          </tr>
230          <tr>
231            <td width="100">  </td>
232            <th>
233<a href="../../../nn/dsp/CTR/GetHeadphoneStatus.html"><CODE>GetHeadphoneStatus</CODE></a>
234            </th>
235<td>Gets whether headphones are plugged in.</td>
236          </tr> </table>
237      </div>
238    </a>
239<h2>Revision History</h2>
240    <div class="section">
241      <dl class="history">
242        <dt>2010/01/29</dt>
243<dd>Initial version.<br />
244        </dd>
245      </dl>
246    </div>
247  <hr><p>CONFIDENTIAL</p></body>
248</html>