1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<HTML> 3<HEAD> 4<META http-equiv="Content-Type" content="text/html; charset=windows-1252"> 5<META http-equiv="Content-Style-Type" content="text/css"> 6<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 7.0.1.0 for Windows"> 7<BASE target="main"> 8<TITLE>List of Operations System Functions</TITLE> 9<LINK rel="stylesheet" href="../css/apilist.css"> 10</HEAD> 11<BODY> 12<H1>Operating System (OS) Function List</H1> 13<H3><A name="Init">Initialization</A></H3> 14<TABLE border="1" width="100%"> 15 <TBODY> 16 <TR> 17<TH width="25%"><A href="init/OS_Init.html" target="_self">OS_Init</A></TH> 18 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 19<TD>Initializes the system.</TD> 20 </TR> 21 <TR> 22<TH><A href="init/OS_InitChina.html" target="_self">OS_InitChina</A></TH> 23 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 24<TD>Initializes the system for applications designed for China.</TD> 25 </TR> 26 <TR> 27<TH><A href="init/OS_ShowAttentionChina.html" target="_self">OS_ShowAttentionChina</A></TH> 28 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 29<TD>Displays the startup screen for applications designed for China.</TD> 30 </TR> 31 <TR> 32<TH><A href="init/NitroStartUp.html" target="_self">NitroStartUp</A></TH> 33 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 34<TD>Describes initialization processes to be run before static constructor calls.</TD> 35 </TR> 36 <TR> 37<TH><A href="init/NitroStaticInit.html" target="_self">NitroStaticInit</A></TH> 38 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 39<TD>Describes the static initializer.</TD> 40 </TR> 41 </TBODY> 42</TABLE> 43<H3><A name="Reset">Reset</A></H3> 44<TABLE border="1" width="100%"> 45 <TBODY> 46 <TR> 47<TH width="25%"><A href="reset/OS_InitReset.html" target="_self">OS_InitReset</A></TH> 48 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 49<TD>Initializes the software reset system. </TD> 50 </TR> 51 <TR> 52<TH><A href="reset/OS_ResetSystem.html" target="_self">OS_ResetSystem</A></TH> 53 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 54<TD>Resets the software and re-runs the program.</TD> 55 </TR> 56 <TR> 57<TH><A href="reset/OS_GetResetParameter.html" target="_self">OS_GetResetParameter</A></TH> 58 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 59<TD>Obtains the reset parameter value.</TD> 60 </TR> 61 <TR><TD class="separator" colspan=3></TD></TR> 62 <TR> 63<TH><A href="appJump/OS_JumpToSystemMenu.html" target="_self">OS_JumpToSystemMenu</A></TH> 64 <TD><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD> 65<TD>This function performs a hardware reset and returns to the System Menu.</TD> 66 </TR> 67 <TR> 68<TH><A href="appJump/OS_RebootSystem.html" target="_self">OS_RebootSystem</A></TH> 69 <TD><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD> 70<TD>Performs a hardware reset, then restarts the calling application.</TD> 71 </TR> 72 <TR> 73<TH><A href="appJump/OS_IsRebooted.html" target="_self">OS_IsRebooted</A></TH> 74 <TD><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD> 75<TD>Determines whether the application has been rebooted by <code><a href="appJump/OS_RebootSystem.html">OS_RebootSystem</a></code>.</TD> 76 </TR> 77 <TR><TD class="separator" colspan=3></TD></TR> 78 <TR> 79<TH><A href="appJump/OS_JumpToWirelessSetting.html" target="_self">OS_JumpToWirelessSetting</A></TH> 80 <TD><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD> 81<TD>Performs a hardware reset and jumps to the <STRONG>Internet</STRONG> > <STRONG>Wireless Communications</STRONG> item within the System Settings.</TD> 82 </TR> 83 <TR> 84<TH><A href="appJump/OS_JumpToInternetSetting.html" target="_self">OS_JumpToInternetSetting</A></TH> 85 <TD><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD> 86<TD>Performs a hardware reset and jumps to the <STRONG>Internet</STRONG> item within the System Settings.</TD> 87 </TR> 88 <TR> 89<TH><A href="appJump/OS_JumpToEULAViewer.html" target="_self">OS_JumpToEULAViewer</A></TH> 90 <TD><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD> 91<TD>Performs a hardware reset and jumps to the <STRONG>Internet</STRONG> > <STRONG>"Terms of Use"</STRONG> item within the System Settings.</TD> 92 </TR> 93 </TBODY> 94</TABLE> 95<H3><A name="Cpsr">System State</A></H3> 96<TABLE border="1" width="100%"> 97 <TBODY> 98 <TR> 99<TH width="25%"><A href="system/OS_EnableInterrupts.html" target="_self">OS_EnableInterrupts</A></TH> 100 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 101<TD>Enables CPSR IRQ interrupts.</TD> 102 </TR> 103 <TR> 104<TH width="25%"><A href="system/OS_DisableInterrupts.html" target="_self">OS_DisableInterrupts</A></TH> 105 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 106<TD>Disables CPSR IRQ interrupts.</TD> 107 </TR> 108 <TR> 109<TH><A href="system/OS_RestoreInterrupts.html" target="_self">OS_RestoreInterrupts</A></TH> 110 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 111<TD>Puts CPSR IRQ interrupts into the specified state.</TD> 112 </TR> 113 <TR> 114<TH width="25%"><A href="system/OS_EnableInterrupts_IrqAndFiq.html" target="_self">OS_EnableInterrupts_IrqAndFiq</A></TH> 115 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 116<TD>Enables IRQ and FIQ interrupts in CPSR.</TD> 117 </TR> 118 <TR> 119<TH width="25%"><A href="system/OS_DisableInterrupts_IrqAndFiq.html" target="_self">OS_DisableInterrupts_IrqAndFiq</A></TH> 120 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 121<TD>Prohibits IRQ and FIQ interrupts in CPSR.</TD> 122 </TR> 123 <TR> 124<TH><A href="system/OS_RestoreInterrupts_IrqAndFiq.html" target="_self">OS_RestoreInterrupts_IrqAndFiq</A></TH> 125 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 126<TD>Sets IRQ and FIQ interrupts in CPSR to a specified status.</TD> 127 </TR> 128 <TR> 129<TH><A href="system/OS_GetCpsrIrq.html" target="_self">OS_GetCpsrIrq</A></TH> 130 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 131<TD>Obtains current CPSR IRQ and FIQ interrupts.</TD> 132 </TR> 133 <TR> 134<TH><A href="system/OS_GetProcMode.html" target="_self">OS_GetProcMode</A></TH> 135 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 136<TD>Obtains current processor mode.</TD> 137 </TR> 138 <TR><TD class="separator" colspan=3></TD></TR> 139 <TR> 140<TH><A href="system/OS_Halt.html" target="_self">OS_Halt</A></TH> 141 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 142<TD>Sets the processor to <CODE>HALT</CODE> status.</TD> 143 </TR> 144 <TR> 145<TH><A href="system/OS_Terminate.html" target="_self">OS_Terminate</A></TH> 146 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 147<TD>Sets the processor to HALT status and loops.</TD> 148 </TR> 149 <TR> 150<TH><A href="system/OS_Exit.html" target="_self">OS_Exit</A></TH> 151 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 152<TD>Displays the exit status, and calls <A href="system/OS_Terminate.html" target="_self"><CODE>OS_Terminate()</CODE></A>.</TD> 153 </TR> 154 <TR> 155<TH><A href="system/OS_FExit.html" target="_self">OS_FExit</A></TH> 156 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 157<TD>Displays the exit status, and calls the <A href="system/OS_Terminate.html" target="_self"><CODE>OS_Terminate</CODE></A> function. (Output is specified.)</TD> 158 </TR> 159 <TR><TD class="separator" colspan=3></TD></TR> 160 <TR> 161<TH><A href="system/OS_SpinWait.html" target="_self">OS_SpinWait</A></TH> 162 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 163<TD>Sets the processor to idle. (Based on the 2x multiplier of the base cycle.)</TD> 164 </TR> 165 <TR> 166<TH><A href="system/OS_SpinWait.html" target="_self">OS_SpinWaitCpuCycles</A></TH> 167 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 168<TD>Sets the processor to idle. (Based on CPU cycles.)</TD> 169 </TR> 170 <TR> 171<TH><A href="system/OS_SpinWait.html" target="_self">OS_SpinWaitSysCycles</A></TH> 172 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 173<TD>Sets the processor to idle. (Based on the base cycle.)</TD> 174 </TR> 175 </TBODY> 176</TABLE> 177<H3><A name="Tcm">TCM</A></H3> 178<TABLE border="1" width="100%"> 179 <TBODY> 180 <TR> 181<TH><A href="tcm/OS_EnableITCM.html" target="_self">OS_EnableITCM</A></TH> 182 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 183<TD>Enables the Instruction TCM.</TD> 184 </TR> 185 <TR> 186<TH><A href="tcm/OS_DisableITCM.html" target="_self">OS_DisableITCM</A></TH> 187 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 188<TD>Disables the Instruction TCM.</TD> 189 </TR> 190 <TR> 191<TH><A href="tcm/OS_GetITCMAddress.html" target="_self">OS_GetITCMAddress</A></TH> 192 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 193<TD>Obtains ITCM address.</TD> 194 </TR> 195 <TR> 196<TH><A href="tcm/OS_EnableDTCM.html" target="_self">OS_EnableDTCM</A></TH> 197 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 198<TD>Enables data TCM.</TD> 199 </TR> 200 <TR> 201<TH><A href="tcm/OS_DisableDTCM.html" target="_self">OS_DisableDTCM</A></TH> 202 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 203<TD>Disables data TCM.</TD> 204 </TR> 205 <TR> 206<TH><A href="tcm/OS_SetITCMParam.html" target="_self">OS_SetITCMParam</A></TH> 207 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 208<TD>Sets instruction TCM parameters.</TD> 209 </TR> 210 <TR> 211<TH><A href="tcm/OS_GetITCMParam.html" target="_self">OS_GetITCMParam</A></TH> 212 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 213<TD>Obtains instruction TCM parameters.</TD> 214 </TR> 215 <TR> 216<TH><A href="tcm/OS_SetDTCMParam.html" target="_self">OS_SetDTCMParam</A></TH> 217 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 218<TD>Sets data TCM parameters.</TD> 219 </TR> 220 <TR> 221<TH><A href="tcm/OS_GetDTCMParam.html" target="_self">OS_GetDTCMParam</A></TH> 222 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 223<TD>Obtains data TCM parameters.</TD> 224 </TR> 225 <TR> 226<TH><A href="tcm/OS_SetDTCMAddress.html" target="_self">OS_SetDTCMAddress</A></TH> 227 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 228<TD>Sets the data TCM address.</TD> 229 </TR> 230 <TR> 231<TH><A href="tcm/OS_GetDTCMAddress.html" target="_self">OS_GetDTCMAddress</A></TH> 232 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 233<TD>Obtains the data TCM address.</TD> 234 </TR> 235 </TBODY> 236</TABLE> 237<H3><A name="ProtectionUnit">Protection Unit</A></H3> 238<TABLE border="1" width="100%"> 239 <TBODY> 240 <TR> 241<TH><A href="protectionUnit/OS_EnableProtectionUnit.html" target="_self">OS_EnableProtectionUnit</A></TH> 242 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 243<TD>Enables the protection unit.</TD> 244 </TR> 245 <TR> 246<TH><A href="protectionUnit/OS_DisableProtectionUnit.html" target="_self">OS_DisableProtectionUnit</A></TH> 247 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 248<TD>Disables the protection unit.</TD> 249 </TR> 250 <TR> 251<TH><A href="protectionUnit/OS_SetProtectionRegion.html" target="_self">OS_SetProtectionRegion</A></TH> 252 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 253<TD>Sets the protection region.</TD> 254 </TR> 255 <TR> 256<TH><A href="protectionUnit/OS_SetProtectionRegion.html" target="_self">OS_SetProtectionRegionParam</A></TH> 257 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 258<TD>Sets the protection region parameters.</TD> 259 </TR> 260 <TR> 261<TH><A href="protectionUnit/OS_GetProtectionRegion.html" target="_self">OS_GetProtectionRegionAddress</A></TH> 262 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 263<TD>Obtains the base address of the protection region.</TD> 264 </TR> 265 <TR> 266<TH><A href="protectionUnit/OS_GetProtectionRegion.html" target="_self">OS_GetProtectionRegionSize</A></TH> 267 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 268<TD>Obtains the size of the protection region.</TD> 269 </TR> 270 <TR> 271<TH><A href="protectionUnit/OS_GetProtectionRegion.html" target="_self">OS_GetProtectionRegionParam</A></TH> 272 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 273<TD>Obtains the parameters of the protection region.</TD> 274 </TR> 275 <TR><TD class="separator" colspan=3></TD></TR> 276 <TR> 277<TH><A href="protectionUnit/OS_DumpProtectionRegion.html" target="_self">OS_DumpProtectionRegion</A></TH> 278 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 279<TD>Displays the status of the protection region settings. (Used in debugging.)</TD> 280 </TR> 281 </TBODY> 282</TABLE> 283<H3><A name="Exception">Exceptions</A></H3> 284<TABLE border="1" width="100%"> 285 <TBODY> 286 <TR> 287<TH nowrap width="25%"><A href="exception/OS_InitException.html" target="_self">OS_InitException</A></TH> 288 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 289<TD>Initializes the exception display system.</TD> 290 </TR> 291 <TR> 292<TH><A href="exception/OS_SetUserExceptionHandler.html" target="_self">OS_SetUserExceptionHandler</A></TH> 293 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 294<TD>Sets the user handler to be used when an exception is generated.</TD> 295 </TR> 296 <TR> 297<TH><A href="exception/OS_SetExceptionVectorLower.html" target="_self">OS_SetExceptionVectorLower</A></TH> 298 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 299<TD>Sets the exception vector position as a normalized address.</TD> 300 </TR> 301 <TR> 302<TH><A href="exception/OS_SetExceptionVectorUpper.html" target="_self">OS_SetExceptionVectorUpper</A></TH> 303 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 304<TD>Sets the exception vector position as a high vector.</TD> 305 </TR> 306 </TBODY> 307</TABLE> 308<H3><A name="Irq">Interrupts</A></H3> 309<TABLE border="1" width="100%"> 310 <TBODY> 311 <TR> 312<TH nowrap width="25%"><A href="irq/interrupts_list.html" target="_self">Types of Interrupts</A></TH> 313 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 314<TD>Lists the NITRO and TWL interrupt types.</TD> 315 </TR> 316 <TR><TD class="separator" colspan=3></TD></TR> 317 <TR> 318<TH nowrap width="25%"><A href="irq/OS_GetIrq.html" target="_self">OS_GetIrq</A></TH> 319 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 320<TD>This function obtains the current IRQ interrupt permission status.</TD> 321 </TR> 322 <TR> 323<TH nowrap width="25%"><A href="irq/OS_EnableIrq.html" target="_self">OS_EnableIrq</A></TH> 324 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 325<TD>Enables all IRQ interrupts.</TD> 326 </TR> 327 <TR> 328<TH nowrap width="25%"><A href="irq/OS_DisableIrq.html" target="_self">OS_DisableIrq</A></TH> 329 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 330<TD>Disables all IRQ interrupts.</TD> 331 </TR> 332 <TR> 333<TH><A href="irq/OS_RestoreIrq.html" target="_self">OS_RestoreIrq</A></TH> 334 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 335<TD>Puts all interrupts into a specified state.</TD> 336 </TR> 337 <TR><TD class="separator" colspan=3></TD></TR> 338 <TR> 339<TH><A href="irq/OS_SetIrqMask.html" target="_self">OS_SetIrqMask</A></TH> 340 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 341<TD>Sets IRQ interrupt parameters.</TD> 342 </TR> 343 <TR> 344<TH><A href="irq/OS_GetIrqMask.html" target="_self">OS_GetIrqMask</A></TH> 345 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 346<TD>Obtains currently established IRQ interrupt parameters.</TD> 347 </TR> 348 <TR> 349<TH><A href="irq/OS_EnableIrqMask.html" target="_self">OS_EnableIrqMask</A></TH> 350 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 351<TD>Enables IRQ of the specified interrupt parameters.</TD> 352 </TR> 353 <TR> 354<TH><A href="irq/OS_DisableIrqMask.html" target="_self">OS_DisableIrqMask</A></TH> 355 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 356<TD>Disables IRQ of the specified interrupt parameters.</TD> 357 </TR> 358 <TR><TD class="separator" colspan=3></TD></TR> 359 <TR> 360<TH><A href="irq/OS_ResetRequestIrqMask.html" target="_self">OS_ResetRequestIrqMask</A></TH> 361 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 362<TD>Releases the specified interrupt cause parameters.</TD> 363 </TR> 364 <TR> 365<TH><A href="irq/OS_GetRequestIrqMask.html" target="_self">OS_GetRequestIrqMask</A></TH> 366 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 367<TD>Obtains current interrupt request.</TD> 368 </TR> 369 <TR><TD class="separator" colspan=3></TD></TR> 370 <TR> 371<TH><A href="irq/OS_InitIrqTable.html" target="_self">OS_InitIrqTable</A></TH> 372 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 373<TD>Initializes IRQ handler table.</TD> 374 </TR> 375 <TR> 376<TH><A href="irq/OS_SetIrqFunction.html" target="_self">OS_SetIrqFunction</A></TH> 377 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 378<TD>Sets handler corresponding to the specified IRQ.</TD> 379 </TR> 380 <TR> 381<TH><A href="irq/OS_GetIrqFunction.html" target="_self">OS_GetIrqFunction</A></TH> 382 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 383<TD>Obtains a handler corresponding to the specified IRQ.</TD> 384 </TR> 385 <TR><TD class="separator" colspan=3></TD></TR> 386 <TR> 387<TH><A href="irq/OS_SetIrqCheckFlag.html">OS_SetIrqCheckFlag</A></TH> 388 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 389<TD>Sets the interrupt check flag.</TD> 390 </TR> 391 <TR> 392<TH><A href="irq/OS_ClearIrqCheckFlag.html">OS_ClearIrqCheckFlag</A></TH> 393 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 394<TD>Clears the interrupt check flag.</TD> 395 </TR> 396 <TR> 397<TH><A href="irq/OS_GetIrqCheckFlag.html">OS_GetIrqCheckFlag</A></TH> 398 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 399<TD>Obtains the interrupt check flag.</TD> 400 </TR> 401 <TR><TD class="separator" colspan=3></TD></TR> 402 <TR> 403<TH><A href="irq/OS_WaitIrq.html">OS_WaitIrq</A></TH> 404 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 405<TD>Waits for the specified IRQ.</TD> 406 </TR> 407 <TR> 408<TH><A href="irq/OS_WaitAnyIrq.html">OS_WaitAnyIrq</A></TH> 409 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 410<TD>Waits for all IRQs.</TD> 411 </TR> 412 <TR> 413<TH><A href="system/OS_WaitInterrupt.html">OS_WaitInterrupt</A></TH> 414 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 415<TD>Waits for the specified IRQ. (A thread switch is not performed.))</TD> 416 </TR> 417 <TR> 418<TH><A href="system/OS_WaitVBlankIntr.html">OS_WaitVBlankIntr</A></TH> 419 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 420<TD>Waits for V-Blank. (A thread switch is performed.)</TD> 421 </TR> 422 <TR> 423<TH><A href="irq/OS_GetVBlankCount.html">OS_GetVBlankCount</A></TH> 424 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 425<TD>Obtains the value of the V-Blank counter.</TD> 426 </TR> 427 </TBODY> 428</TABLE> 429<H3><A name="Timer">Timer</A></H3> 430<TABLE border="1" width="100%"> 431 <TBODY> 432 <TR> 433<TH width="25%"><A href="timer/OS_StartTimer.html" target="_self">OS_StartTimer</A></TH> 434 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 435<TD>Starts the timer. The counter value is 16-bit.</TD> 436 </TR> 437 <TR> 438<TH width="25%"><A href="timer/OS_StartTimer.html" target="_self">OS_StartTimer32</A></TH> 439 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 440<TD>When two timers are used, starts the 32-bit long timer.</TD> 441 </TR> 442 <TR> 443<TH><A href="timer/OS_StartTimer.html" target="_self">OS_StartTimer48</A></TH> 444 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 445<TD>When three timers are used, starts the 48-bit long timer.</TD> 446 </TR> 447 <TR> 448<TH><A href="timer/OS_StartTimer.html" target="_self">OS_StartTimer64</A></TH> 449 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 450<TD>When four timers are used, starts the 64-bit long timer.</TD> 451 </TR> 452 <TR> 453<TH><A href="timer/OS_StopTimer.html" target="_self">OS_StopTimer</A></TH> 454 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 455<TD>Stops the timer. The counter value is 16-bit.</TD> 456 </TR> 457 <TR> 458<TH><A href="timer/OS_StopTimer.html" target="_self">OS_StopTimer32</A></TH> 459 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 460<TD>Stops both timers. Used when there is a 32-bit timer.</TD> 461 </TR> 462 <TR> 463<TH><A href="timer/OS_StopTimer.html" target="_self">OS_StopTimer48</A></TH> 464 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 465<TD>Stops all three timers. Used when there is a 48-bit timer.</TD> 466 </TR> 467 <TR> 468<TH><A href="timer/OS_StopTimer.html" target="_self">OS_StopTimer64</A></TH> 469 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 470<TD>Stops all four timers. Used when there is a 64-bit timer.</TD> 471 </TR> 472 </TBODY> 473</TABLE> 474<H3><A name="Alarm">Alarms</A></H3> 475<TABLE border="1" width="100%"> 476 <TBODY> 477 <TR> 478<TH width="25%"><A href="alarm/OS_InitAlarm.html" target="_self">OS_InitAlarm</A></TH> 479 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 480<TD>Allocates a timer for an alarm system, and initializes it.</TD> 481 </TR> 482 <TR> 483<TH width="25%"><A href="alarm/OS_EndAlarm.html" target="_self">OS_EndAlarm</A></TH> 484 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 485<TD>Frees a timer that was allocated to an alarm system.</TD> 486 </TR> 487 <TR> 488<TH width="25%"><A href="alarm/OS_IsAlarmAvailable.html" target="_self">OS_IsAlarmAvailable</A></TH> 489 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 490<TD>Checks whether an alarm system is initialized and available.</TD> 491 </TR> 492 <TR> 493<TH width="25%"><A href="alarm/OS_CreateAlarm.html" target="_self">OS_CreateAlarm</A></TH> 494 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 495<TD>Initializes the alarm structure.</TD> 496 </TR> 497 <TR> 498<TH width="25%"><A href="alarm/OS_SetAlarm.html" target="_self">OS_SetAlarm</A></TH> 499 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 500<TD>Sets an alarm.</TD> 501 </TR> 502 <TR> 503<TH width="25%"><A href="alarm/OS_SetPeriodicAlarm.html" target="_self">OS_SetPeriodicAlarm</A></TH> 504 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 505<TD>Sets a periodic alarm.</TD> 506 </TR> 507 <TR> 508<TH width="25%"><A href="alarm/OS_SetAlarmTag.html" target="_self">OS_SetAlarmTag</A></TH> 509 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 510<TD>Sets a tag to an alarm.</TD> 511 </TR> 512 <TR> 513<TH width="25%"><A href="alarm/OS_CancelAlarm.html" target="_self">OS_CancelAlarm</A></TH> 514 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 515<TD>Cancels an alarm.</TD> 516 </TR> 517 <TR> 518<TH width="25%"><A href="alarm/OS_CancelAlarms.html" target="_self">OS_CancelAlarms</A></TH> 519 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 520<TD>Cancels alarms that have a specified tag.</TD> 521 </TR> 522 <TR> 523<TH width="25%"><A href="alarm/OS_CancelAllAlarms.html" target="_self">OS_CancelAllAlarms</A></TH> 524 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 525<TD>Cancels all alarms.</TD> 526 </TR> 527 </TBODY> 528</TABLE> 529<H3><A name="VAlarm">V-Count Alarms</A></H3> 530<TABLE border="1" width="100%"> 531 <TBODY> 532 <TR> 533<TH width="25%"><A href="valarm/OS_InitVAlarm.html" target="_self">OS_InitVAlarm</A></TH> 534 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 535<TD>Initializes a V-Count alarm system.</TD> 536 </TR> 537 <TR> 538<TH width="25%"><A href="valarm/OS_EndVAlarm.html" target="_self">OS_EndVAlarm</A></TH> 539 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 540<TD>Ends a V-Count alarm system.</TD> 541 </TR> 542 <TR> 543<TH width="25%"><A href="valarm/OS_IsVAlarmAvailable.html" target="_self">OS_IsVAlarmAvailable</A></TH> 544 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 545<TD>Checks whether a V-Count alarm system is initialized and available.</TD> 546 </TR> 547 <TR> 548<TH width="25%"><A href="valarm/OS_CreateVAlarm.html" target="_self">OS_CreateVAlarm</A></TH> 549 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 550<TD>Initializes a V-Count alarm structure.</TD> 551 </TR> 552 <TR> 553<TH width="25%"><A href="valarm/OS_SetVAlarm.html" target="_self">OS_SetVAlarm</A></TH> 554 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 555<TD>Sets a V-Count alarm.</TD> 556 </TR> 557 <TR> 558<TH width="25%"><A href="valarm/OS_SetOneTimeVAlarm.html" target="_self">OS_SetOneTimeVAlarm</A></TH> 559 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 560<TD>Sets a V-Count alarm. (Function added to maintain backward-compatibility.)</TD> 561 </TR> 562 <TR> 563<TH width="25%"><A href="valarm/OS_SetPeriodicVAlarm.html" target="_self">OS_SetPeriodicVAlarm</A></TH> 564 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 565<TD>Sets a periodic V-Count alarm.</TD> 566 </TR> 567 <TR> 568<TH width="25%"><A href="valarm/OS_SetVAlarmTag.html" target="_self">OS_SetVAlarmTag</A></TH> 569 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 570<TD>Sets a tag to a V-Count alarm.</TD> 571 </TR> 572 <TR> 573<TH width="25%"><A href="valarm/OS_CancelVAlarm.html" target="_self">OS_CancelVAlarm</A></TH> 574 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 575<TD>Cancels a V-Count alarm.</TD> 576 </TR> 577 <TR> 578<TH width="25%"><A href="valarm/OS_CancelVAlarms.html" target="_self">OS_CancelVAlarms</A></TH> 579 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 580<TD>Cancels V-Count alarms that have a specified tag.</TD> 581 </TR> 582 <TR> 583<TH width="25%"><A href="valarm/OS_CancelAllVAlarms.html" target="_self">OS_CancelAllVAlarms</A></TH> 584 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 585<TD>Cancels all V-Count alarms.</TD> 586 </TR> 587 </TBODY> 588</TABLE> 589<H3><A name="Time">Time</A></H3> 590<TABLE border="1" width="100%"> 591 <TBODY> 592 <TR> 593<TH width="25%"><A href="time/OS_InitTick.html" target="_self">OS_InitTick</A></TH> 594 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 595<TD>Allocates a timer for ticks.</TD> 596 </TR> 597 <TR> 598<TH width="25%"><A href="time/OS_IsTickAvailable.html" target="_self">OS_IsTickAvailable</A></TH> 599 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 600<TD>Checks whether a tick is initialized and available.</TD> 601 </TR> 602 <TR> 603<TH width="25%"><A href="time/OS_GetTick.html" target="_self">OS_GetTick</A></TH> 604 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 605<TD>Acquires a tick value.</TD> 606 </TR> 607 <TR> 608<TH width="25%"><A href="time/OS_GetTickLo.html" target="_self">OS_GetTickLo</A></TH> 609 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 610<TD>Acquires the low-order 16-bit value of a tick.</TD> 611 </TR> 612 <TR> 613<TH width="25%"><A href="time/OS_SetTick.html" target="_self">OS_SetTick</A></TH> 614 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 615<TD>Sets a tick value.</TD> 616 </TR> 617 <TR> 618<TH width="25%"><A href="time/OS_SecondsToTicks.html" target="_self">OS_MicroSecondsToTicks*</A></TH> 619 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 620<TD>Converts from microseconds to a tick value.</TD> 621 </TR> 622 <TR> 623<TH width="25%"><A href="time/OS_SecondsToTicks.html" target="_self">OS_MilliSecondsToTicks*</A></TH> 624 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 625<TD>Converts from milliseconds to a tick value.</TD> 626 </TR> 627 <TR> 628<TH width="25%"><A href="time/OS_SecondsToTicks.html" target="_self">OS_SecondsToTicks*</A></TH> 629 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 630<TD>Converts from seconds to a tick value.</TD> 631 </TR> 632 <TR> 633<TH width="25%"><A href="time/OS_TicksToSeconds.html" target="_self">OS_TicksToMicroSeconds*</A></TH> 634 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 635<TD>Converts from a tick value to microseconds.</TD> 636 </TR> 637 <TR> 638<TH width="25%"><A href="time/OS_TicksToSeconds.html" target="_self">OS_TicksToMilliSeconds*</A></TH> 639 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 640<TD>Converts from a tick value to milliseconds.</TD> 641 </TR> 642 <TR> 643<TH width="25%"><A href="time/OS_TicksToSeconds.html" target="_self">OS_TicksToSeconds*</A></TH> 644 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 645<TD>Converts from a tick value to seconds.</TD> 646 </TR> 647 </TBODY> 648</TABLE> 649<H3><A name="Thread">Thread</A></H3> 650<TABLE border="1" width="100%"> 651 <TBODY> 652 <TR> 653<TH width="25%"><A href="thread/OS_InitThread.html" target="_self">OS_InitThread</A></TH> 654 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 655<TD>Initializes a thread.</TD> 656 </TR> 657 <TR> 658<TH width="25%"><A href="thread/OS_IsThreadAvailable.html" target="_self">OS_IsThreadAvailable</A></TH> 659 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 660<TD>Checks whether a thread is initialized and available.</TD> 661 </TR> 662 <TR> 663<TH width="25%"><A href="thread/OS_CreateThread.html" target="_self">OS_CreateThread</A></TH> 664 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 665<TD>Creates threads.</TD> 666 </TR> 667 <TR> 668<TH><A href="thread/OS_InitThreadQueue.html" target="_self">OS_InitThreadQueue</A></TH> 669 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 670<TD>Creates a thread queue.</TD> 671 </TR> 672 <TR> 673<TH><A href="thread/OS_ExitThread.html" target="_self">OS_ExitThread</A></TH> 674 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 675<TD>Exits the current thread. Calls the destructor thread.</TD> 676 </TR> 677 <TR> 678<TH><A href="thread/OS_KillThread.html" target="_self">OS_KillThread</A></TH> 679 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 680<TD>Ends the specified thread. Calls the destructor thread.</TD> 681 </TR> 682 <TR> 683<TH><A href="thread/OS_KillThread.html" target="_self">OS_KillThreadWithPriority</A></TH> 684 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 685<TD>Sets the priority for the specified thread, and then exits. Calls the destructor thread.</TD> 686 </TR> 687 <TR> 688<TH><A href="thread/OS_DestroyThread.html" target="_self">OS_DestroyThread</A></TH> 689 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 690<TD>Ends the specified thread. The thread destructor is not called.</TD> 691 </TR> 692 <TR> 693<TH><A href="thread/OS_JoinThread.html">OS_JoinThread</A></TH> 694 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 695<TD>Joins a thread, and waits for it to terminate.</TD> 696 </TR> 697 <TR> 698<TH><A href="thread/OS_IsThreadTerminated.html">OS_IsThreadTerminated</A></TH> 699 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 700<TD>Determines whether the thread has completed.</TD> 701 </TR> 702 <TR> 703<TH><A href="thread/OS_SelectThread.html" target="_self">OS_SelectThread</A></TH> 704 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 705<TD>Specifies the next thread to be run.</TD> 706 </TR> 707 <TR> 708<TH><A href="thread/OS_SetSwitchThreadCallback.html" target="_self">OS_SetSwitchThreadCallback</A></TH> 709 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 710<TD>Sets the callback during thread-switching.</TD> 711 </TR> 712 <TR> 713<TH><A href="thread/OS_RescheduleThread.html" target="_self">OS_RescheduleThread</A></TH> 714 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 715<TD>Schedules threads.</TD> 716 </TR> 717 <TR> 718<TH><A href="thread/OS_YieldThread.html" target="_self">OS_YieldThread</A></TH> 719 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 720<TD>Allows threads with the same prority level to run, and performs thread scheduling.</TD> 721 </TR> 722 <TR> 723<TH><A href="thread/OS_SleepThread.html" target="_self">OS_SleepThread</A></TH> 724 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 725<TD>Puts the current thread into a sleep state.</TD> 726 </TR> 727 <TR> 728<TH><A href="thread/OS_SleepThreadDirect.html" target="_self">OS_SleepThreadDirect</A></TH> 729 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 730<TD>Puts the specified thread into a sleep state.</TD> 731 </TR> 732 <TR> 733<TH><A href="thread/OS_Sleep.html" target="_self">OS_Sleep</A></TH> 734 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 735<TD>Puts threads into a sleep state for a specified time.</TD> 736 </TR> 737 <TR> 738<TH><A href="thread/OS_WakeupThread.html" target="_self">OS_WakeupThread</A></TH> 739 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 740<TD>Puts all threads registered in the queue into an operable state.</TD> 741 </TR> 742 <TR> 743<TH><A href="thread/OS_WakeupThreadDirect.html" target="_self">OS_WakeupThreadDirect</A></TH> 744 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 745<TD>Puts the specified thread into an operable state.</TD> 746 </TR> 747 <TR> 748<TH><A href="thread/OS_SetThreadPriority.html" target="_self">OS_SetThreadPriority</A></TH> 749 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 750<TD>Sets thread priority.</TD> 751 </TR> 752 <TR> 753<TH><A href="thread/OS_GetThreadPriority.html" target="_self">OS_GetThreadPriority</A></TH> 754 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 755<TD>Obtains thread priority.</TD> 756 </TR> 757 <TR> 758<TH><A href="thread/OS_GetCurrentThread.html" target="_self">OS_GetCurrentThread</A></TH> 759 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 760<TD>Gets the current thread.</TD> 761 </TR> 762 <TR> 763<TH><A href="thread/OS_GetNumberOfThread.html" target="_self">OS_GetNumberOfThread</A></TH> 764 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 765<TD>Obtains the number of existing threads.</TD> 766 </TR> 767 <TR> 768<TH><A href="thread/OS_DisableScheduler.html" target="_self">OS_DisableScheduler</A></TH> 769 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 770<TD>Stops thread rescheduling temporarily.</TD> 771 </TR> 772 <TR> 773<TH><A href="thread/OS_EnableScheduler.html" target="_self">OS_EnableScheduler</A></TH> 774 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 775<TD>Restarts thread rescheduling.</TD> 776 </TR> 777 <TR> 778<TH><A href="thread/OS_SetThreadParameter.html" target="_self">OS_SetThreadrParameter</A></TH> 779 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 780<TD>Sets user parameters.</TD> 781 </TR> 782 <TR> 783<TH><A href="thread/OS_GetThreadParameter.html" target="_self">OS_GetThreadParameter</A></TH> 784 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 785<TD>Obtains user parameters.</TD> 786 </TR> 787 <TR> 788<TH><A href="thread/OS_SetThreadDestructor.html" target="_self">OS_SetThreadDestructor</A></TH> 789 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 790<TD>Sets the thread destructor.</TD> 791 </TR> 792 <TR> 793<TH><A href="thread/OS_GetThreadDestructor.html" target="_self">OS_GetThreadDestructor</A></TH> 794 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 795<TD>Obtains the thread destructor.</TD> 796 </TR> 797 <TR> 798<TH><A href="thread/OS_SetThreadDestructorStack.html" target="_self">OS_SetThreadDestructorStack</A></TH> 799 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 800<TD>Sets the stack to run the thread destructor.</TD> 801 </TR> 802 <TR> 803<TH><A href="thread/OS_DumpThreadList.html" target="_self">OS_DumpThreadList</A></TH> 804 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 805<TD>Displays all threads (for debugging).</TD> 806 </TR> 807 </TBODY> 808</TABLE> 809<H3><A name="Mutex">Exclusion Control</A></H3> 810<TABLE border="1" width="100%"> 811 <TBODY> 812 <TR> 813<TH width="25%"><A href="mutex/OS_InitMutex.html" target="_self">OS_InitMutex</A></TH> 814 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 815<TD>Initializes the mutex structure used for exclusive control.</TD> 816 </TR> 817 <TR> 818<TH width="25%"><A href="mutex/OS_LockMutex.html" target="_self">OS_LockMutex</A></TH> 819 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 820<TD>Locks a thread using mutex.</TD> 821 </TR> 822 <TR> 823<TH><A href="mutex/OS_UnlockMutex.html" target="_self">OS_UnlockMutex</A></TH> 824 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 825<TD>Releases a lock set on a thread by mutex.</TD> 826 </TR> 827 <TR> 828<TH><A href="mutex/OS_TryLockMutex.html" target="_self">OS_TryLockMutex</A></TH> 829 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 830<TD>Attempts to lock the thread locked with mutex.</TD> 831 </TR> 832 <TR><TD class="separator" colspan=3></TD></TR> 833 <TR> 834<TH><A href="mutex/OS_LockMutexRW.html" target="_self">OS_LockMutexR</A></TH> 835 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 836<TD>Locks a thread using mutex. (read lock)</TD> 837 </TR> 838 <TR> 839<TH><A href="mutex/OS_LockMutexRW.html">OS_LockMutexW</A></TH> 840 <TD><IMG src="../image/NTR.gif"><IMG src="../image/TWL.gif"></TD> 841<TD>Locks a thread using mutex. (write lock)</TD> 842 </TR> 843 <TR> 844<TH><A href="mutex/OS_UnlockMutexRW.html">OS_UnlockMutexR</A></TH> 845 <TD><IMG src="../image/NTR.gif"><IMG src="../image/TWL.gif"></TD> 846<TD>Releases a lock set on a thread by mutex. (read lock)</TD> 847 </TR> 848 <TR> 849<TH><A href="mutex/OS_UnlockMutexRW.html">OS_UnlockMutexW</A></TH> 850 <TD><IMG src="../image/NTR.gif"><IMG src="../image/TWL.gif"></TD> 851<TD>Releases a lock set on a thread by mutex. (write lock)</TD> 852 </TR> 853 <TR> 854<TH><A href="mutex/OS_UnlockMutexRW.html">OS_UnlockMutexRW</A></TH> 855 <TD><IMG src="../image/NTR.gif"><IMG src="../image/TWL.gif"></TD> 856<TD>Releases a lock set on a thread by mutex. (read/write lock)</TD> 857 </TR> 858 <TR> 859<TH><A href="mutex/OS_TryLockMutexRW.html">OS_TryLockMutexR</A></TH> 860 <TD><IMG src="../image/NTR.gif"><IMG src="../image/TWL.gif"></TD> 861<TD>Tries to lock the thread using mutex. (read lock)</TD> 862 </TR> 863 <TR> 864<TH><A href="mutex/OS_TryLockMutexRW.html">OS_TryLockMutexW</A></TH> 865 <TD><IMG src="../image/NTR.gif"><IMG src="../image/TWL.gif"></TD> 866<TD>Tries to lock the thread using mutex. (write lock)</TD> 867 </TR> 868 <TR> 869<TH><A href="mutex/OS_LockMutexFromToRW.html">OS_LockMutexFromRToW</A></TH> 870 <TD><IMG src="../image/NTR.gif"><IMG src="../image/TWL.gif"></TD> 871<TD>Changes a <CODE>read lock</CODE> mutex to <CODE>write lock</CODE>.</TD> 872 </TR> 873 <TR> 874<TH><A href="mutex/OS_LockMutexFromToRW.html">OS_LockMutexFromWToR</A></TH> 875 <TD><IMG src="../image/NTR.gif"><IMG src="../image/TWL.gif"></TD> 876<TD>Changes a <CODE>write lock</CODE> mutex to <CODE>read lock</CODE>.</TD> 877 </TR> 878 <TR> 879<TH><A href="mutex/OS_TryLockMutexFromToRW.html">OS_TryLockMutexFromRToW</A></TH> 880 <TD><IMG src="../image/NTR.gif"><IMG src="../image/TWL.gif"></TD> 881<TD>Tries to change the <CODE>read lock</CODE> mutex to <CODE>write lock</CODE>.</TD> 882 </TR> 883 <TR> 884<TH><A href="mutex/OS_TryLockMutexFromToRW.html">OS_TryLockMutexFromWToR</A></TH> 885 <TD><IMG src="../image/NTR.gif"><IMG src="../image/TWL.gif"></TD> 886<TD>Tries to change the <CODE>write lock</CODE> mutex to <CODE>read lock</CODE>.</TD> 887 </TR> 888 <TR><TD class="separator" colspan=3></TD></TR> 889 <TR> 890<TH width="25%"><A href="spinLock/OS_InitLock.html" target="_self">OS_InitLock</A></TH> 891 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 892<TD>Performs exclusive-control initialization.</TD> 893 </TR> 894 <TR> 895<TH><A href="spinLock/OS_LockCard.html" target="_self">OS_LockCard</A></TH> 896 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 897<TD>Spin locks the card for exclusive control.</TD> 898 </TR> 899 <TR> 900<TH><A href="spinLock/OS_LockCartridge.html" target="_self">OS_LockCartridge</A></TH> 901 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 902<TD>Spin locks the Game Pak for exclusive control.</TD> 903 </TR> 904 <TR> 905<TH><A href="spinLock/OS_UnlockCard.html" target="_self">OS_UnlockCard</A></TH> 906 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 907<TD>Releases a spin lock for a card.</TD> 908 </TR> 909 <TR> 910<TH><A href="spinLock/OS_UnlockCartridge.html" target="_self">OS_UnlockCartridge</A></TH> 911 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 912<TD>Releases a spin lock for a Game Pak.</TD> 913 </TR> 914 <TR> 915<TH><A href="spinLock/OS_TryLockCard.html" target="_self">OS_TryLockCard</A></TH> 916 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 917<TD>Attempts to spin lock a card for exclusive control.</TD> 918 </TR> 919 <TR> 920<TH><A href="spinLock/OS_TryLockCartridge.html" target="_self">OS_TryLockCartridge</A></TH> 921 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 922<TD>Attempts to spin lock a Game Pak for exclusive control.</TD> 923 </TR> 924 <TR> 925<TH><A href="spinLock/OS_GetLockID.html" target="_self">OS_GetLockID</A></TH> 926 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 927<TD>Obtains the lock ID for a spin lock.</TD> 928 </TR> 929 <TR> 930<TH><A href="spinLock/OS_ReleaseLockID.html" target="_self">OS_ReleaseLockID</A></TH> 931 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 932<TD>Releases the lock ID for a spin lock.</TD> 933 </TR> 934 </TBODY> 935</TABLE> 936<H3><A name="Context">Context</A></H3> 937<TABLE border="1" width="100%"> 938 <TBODY> 939 <TR> 940<TH width="25%"><A href="context/OS_InitContext.html" target="_self">OS_InitContext</A></TH> 941 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 942<TD>Initializes context.</TD> 943 </TR> 944 <TR> 945<TH width="25%"><A href="context/OS_SaveContext.html" target="_self">OS_SaveContext</A></TH> 946 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 947<TD>Saves current context.</TD> 948 </TR> 949 <TR> 950<TH><A href="context/OS_LoadContext.html" target="_self">OS_LoadContext</A></TH> 951 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 952<TD>Loads current context.</TD> 953 </TR> 954 <TR> 955<TH><A href="context/OS_DumpContext.html" target="_self">OS_DumpContext</A></TH> 956 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 957<TD>Displays contents of the context structure (for debugging). </TD> 958 </TR> 959 </TBODY> 960</TABLE> 961<H3><A name="Message">Messages</A></H3> 962<TABLE border="1" width="100%"> 963 <TBODY> 964 <TR> 965<TH width="25%"><A href="message/OS_InitMessageQueue.html" target="_self">OS_InitMessageQueue</A></TH> 966 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 967<TD>Initializes the message queue structure.</TD> 968 </TR> 969 <TR> 970<TH width="25%"><A href="message/OS_SendMessage.html" target="_self">OS_SendMessage</A></TH> 971 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 972<TD>Inserts a message at the end of the message queue.</TD> 973 </TR> 974 <TR> 975<TH><A href="message/OS_JamMessage.html" target="_self">OS_JamMessage</A></TH> 976 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 977<TD>Inserts a message at the beginning of the message queue.</TD> 978 </TR> 979 <TR> 980<TH><A href="message/OS_ReceiveMessage.html" target="_self">OS_ReceiveMessage</A></TH> 981 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 982<TD>Extracts a message from the message queue.</TD> 983 </TR> 984 <TR> 985<TH><A href="message/OS_ReadMessage.html" target="_self">OS_ReadMessage</A></TH> 986 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 987<TD>Copies the message that is first in the message queue.</TD> 988 </TR> 989 </TBODY> 990</TABLE> 991<H3><A name="Event">Events</A></H3> 992<TABLE border="1" width="100%"> 993 <TBODY> 994 <TR> 995<TH width="25%"><A href="event/OS_InitEvent.html" target="_self">OS_InitEvent</A></TH> 996 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 997<TD>Initializes the event structure.</TD> 998 </TR> 999 <TR> 1000<TH width="25%"><A href="event/OS_WaitEvent.html" target="_self">OS_WaitEvent*</A></TH> 1001 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1002<TD>Waits for an event.</TD> 1003 </TR> 1004 <TR> 1005<TH><A href="event/OS_SignalEvent.html" target="_self">OS_SignalEvent</A></TH> 1006 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1007<TD>Signals a thread that is waiting for an event.</TD> 1008 </TR> 1009 <TR> 1010<TH><A href="event/OS_PollEvent.html" target="_self">OS_PollEvent*</A></TH> 1011 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1012<TD>Finds out whether the completion conditions have been met to stop waiting for an event.</TD> 1013 </TR> 1014 <TR> 1015<TH><A href="event/OS_ClearEvent.html" target="_self">OS_ClearEvent</A></TH> 1016 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1017<TD>Clears the specified event flag.</TD> 1018 </TR> 1019 <TR> 1020<TH><A href="event/OS_ClearEvent.html" target="_self">OS_ClearAllEvent</A></TH> 1021 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1022<TD>Clears all event flags.</TD> 1023 </TR> 1024 </TBODY> 1025</TABLE> 1026<H3><A name="Cache">Cache</A></H3> 1027<TABLE border="1" width="100%"> 1028 <TBODY> 1029 <TR> 1030<TH width="25%"><A href="cache/DC_Enable.html" target="_self">DC_Enable</A></TH> 1031 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1032<TD>Allows all data caches to be used.</TD> 1033 </TR> 1034 <TR> 1035<TH width="25%"><A href="cache/DC_Disable.html" target="_self">DC_Disable</A></TH> 1036 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1037<TD>Prohibits all data caches from being used.</TD> 1038 </TR> 1039 <TR> 1040<TH width="25%"><A href="cache/DC_Restore.html" target="_self">DC_Restore</A></TH> 1041 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1042<TD>Specifies whether to allow use of all data caches.</TD> 1043 </TR> 1044 <TR> 1045<TH width="25%"><A href="cache/DC_InvalidateAll.html" target="_self">DC_InvalidateAll</A></TH> 1046 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1047<TD>Invalidates the data in the entire data cache region.</TD> 1048 </TR> 1049 <TR> 1050<TH width="25%"><A href="cache/DC_StoreAll.html" target="_self">DC_StoreAll</A><BR> <A href="cache/DC_StoreAll.html">(DC_CleanAll)</A></TH> 1051 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1052<TD>Stores all data from data cache regions to memory.</TD> 1053 </TR> 1054 <TR> 1055<TH width="25%"><A href="cache/DC_FlushAll.html" target="_self">DC_FlushAll</A><BR> <A href="cache/DC_FlushAll.html">(DC_CleanAndInvalidateAll)</A></TH> 1056 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1057<TD>Flushes all data in all data caches.</TD> 1058 </TR> 1059 <TR> 1060<TH width="25%"><A href="cache/DC_InvalidateRange.html" target="_self">DC_InvalidateRange</A></TH> 1061 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1062<TD>Invalidates data in the specified data cache region.</TD> 1063 </TR> 1064 <TR> 1065<TH width="25%"><A href="cache/DC_StoreRange.html" target="_self">DC_StoreRange</A><BR> <A href="cache/DC_StoreRange.html">(DC_CleanRange)</A></TH> 1066 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1067<TD>Stores data in the specified region of data cache to memory.</TD> 1068 </TR> 1069 <TR> 1070<TH width="25%"><A href="cache/DC_FlushRange.html" target="_self">DC_FlushRange</A><BR> <A href="cache/DC_FlushRange.html">(DC_CleanAndInvalidateRange)</A></TH> 1071 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1072<TD>Flushes the data cache in the specified region.</TD> 1073 </TR> 1074 <TR> 1075<TH width="25%"><A href="cache/DC_TouchRange.html" target="_self"><font color="#808080">DC_TouchRange</font></A></TH> 1076 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1077<TD><font color="#808080">Does nothing.</font></TD> 1078 </TR> 1079 <TR> 1080<TH width="25%"><A href="cache/DC_LockdownRange.html" target="_self">DC_LockdownRange</A></TH> 1081 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1082<TD>Locks the specified range of data cache.</TD> 1083 </TR> 1084 <TR> 1085<TH><A href="cache/DC_Unlockdown.html" target="_self">DC_Unlockdown</A></TH> 1086 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1087<TD>Releases the data cache in block-sized units.</TD> 1088 </TR> 1089 <TR> 1090<TH><A href="cache/DC_UnlockdownAll.html" target="_self">DC_UnlockdownAll</A></TH> 1091 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1092<TD>Releases the entire data cache.</TD> 1093 </TR> 1094 <TR> 1095<TH width="25%"><A href="cache/DC_WaitWriteBufferEmpty.html" target="_self">DC_WaitWriteBufferEmpty</A></TH> 1096 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1097<TD>Waits for the write buffer to empty.</TD> 1098 </TR> 1099 <TR><TD class="separator" colspan=3></TD></TR> 1100 <TR> 1101<TH width="25%"><A href="cache/IC_Enable.html" target="_self">IC_Enable</A></TH> 1102 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1103<TD>Allows the use of all instruction caches.</TD> 1104 </TR> 1105 <TR> 1106<TH width="25%"><A href="cache/IC_Disable.html" target="_self">IC_Disable</A></TH> 1107 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1108<TD>Prohibits the use of all instruction caches.</TD> 1109 </TR> 1110 <TR> 1111<TH width="25%"><A href="cache/IC_Restore.html" target="_self">IC_Restore</A></TH> 1112 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1113<TD>Specifies whether to permit use of all instruction caches.</TD> 1114 </TR> 1115 <TR> 1116<TH width="25%"><A href="cache/IC_InvalidateAll.html" target="_self">IC_InvalidateAll</A></TH> 1117 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1118<TD>Invalidates instruction code in the entire instruction cache region.</TD> 1119 </TR> 1120 <TR> 1121<TH width="25%"><A href="cache/IC_InvalidateRange.html" target="_self">IC_InvalidateRange</A></TH> 1122 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1123<TD>Disables the specified range of instruction cache.</TD> 1124 </TR> 1125 <TR> 1126<TH width="25%"><A href="cache/IC_PrefetchRange.html" target="_self">IC_PrefetchRange</A></TH> 1127 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1128<TD>Pre-fetches the specified range of instruction cache.</TD> 1129 </TR> 1130 <TR> 1131<TH width="25%"><A href="cache/IC_LockdownRange.html" target="_self">IC_LockdownRange</A></TH> 1132 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1133<TD>Locks down the specified range of instruction cache.</TD> 1134 </TR> 1135 <TR> 1136<TH><A href="cache/IC_Unlockdown.html" target="_self">IC_Unlockdown</A></TH> 1137 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1138<TD>Releases the instruction cache in block-sized units.</TD> 1139 </TR> 1140 <TR> 1141<TH><A href="cache/IC_UnlockdownAll.html" target="_self">IC_UnlockdownAll</A></TH> 1142 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1143<TD>Releases the entire instruction cache.</TD> 1144 </TR> 1145 </TBODY> 1146</TABLE> 1147<H3><A name="Arena">Arena</A></H3> 1148<TABLE border="1" width="100%"> 1149 <TBODY> 1150 <TR> 1151<TH width="25%"><A href="arena/OS_InitArena.html" target="_self">OS_InitArena</A></TH> 1152 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1153<TD>Initializes the arena.</TD> 1154 </TR> 1155 <TR> 1156<TH width="25%"><A href="arena/OS_EnableMainExArena.html" target="_self">OS_EnableMainExArena</A></TH> 1157 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1158<TD>Enables use of the main memory extended arena.</TD> 1159 </TR> 1160 <TR> 1161<TH width="25%"><A href="arena/OS_DisableMainExArena.html" target="_self">OS_DisableMainExArena</A></TH> 1162 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1163<TD>Disables the main memory extended arena.</TD> 1164 </TR> 1165 <TR><TD class="separator" colspan=3></TD></TR> 1166 <TR> 1167<TH width="25%"><A href="arena/OS_SetArenaHi.html" target="_self">OS_SetArenaHi</A></TH> 1168 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1169<TD>Sets the upper boundary of the arena.</TD> 1170 </TR> 1171 <TR> 1172<TH><A href="arena/OS_SetArenaHi.html" target="_self">OS_Set*ArenaHi</A></TH> 1173 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1174<TD>Sets the upper boundary of the arena. (Arena specification)</TD> 1175 </TR> 1176 <TR> 1177<TH><A href="arena/OS_SetArenaLo.html" target="_self">OS_SetArenaLo</A></TH> 1178 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1179<TD>Sets the lower boundary of the arena.</TD> 1180 </TR> 1181 <TR> 1182<TH><A href="arena/OS_SetArenaLo.html" target="_self">OS_Set*ArenaLo</A></TH> 1183 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1184<TD>Sets the lower boundary of the arena. (Arena specification)</TD> 1185 </TR> 1186 <TR> 1187<TH><A href="arena/OS_GetArenaHi.html" target="_self">OS_GetArenaHi</A></TH> 1188 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1189<TD>Obtains the upper boundary of the arena.</TD> 1190 </TR> 1191 <TR> 1192<TH><A href="arena/OS_GetArenaHi.html" target="_self">OS_Get*ArenaHi</A></TH> 1193 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1194<TD>Gets the upper boundary of the arena. (Arena specification)</TD> 1195 </TR> 1196 <TR> 1197<TH><A href="arena/OS_GetArenaLo.html" target="_self">OS_GetArenaLo</A></TH> 1198 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1199<TD>Obtains the lower boundary of the arena.</TD> 1200 </TR> 1201 <TR> 1202<TH><A href="arena/OS_GetArenaLo.html" target="_self">OS_Get*ArenaLo</A></TH> 1203 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1204<TD>Gets the lower boundary of the arena. (Arena specification)</TD> 1205 </TR> 1206 <TR><TD class="separator" colspan=3></TD></TR> 1207 <TR> 1208<TH><A href="arena/OS_AllocFromArenaHi.html" target="_self">OS_AllocFromArenaHi</A></TH> 1209 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1210<TD>Allocates a region of the specified size from the upper arena.</TD> 1211 </TR> 1212 <TR> 1213<TH><A href="arena/OS_AllocFromArenaHi.html" target="_self">OS_AllocFrom*ArenaHi</A></TH> 1214 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1215<TD>Allocates a region of the specified size from the upper arena. (Arena specification)</TD> 1216 </TR> 1217 <TR> 1218<TH><A href="arena/OS_AllocFromArenaLo.html" target="_self">OS_AllocFromArenaLo</A></TH> 1219 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1220<TD>Allocates a region of the specified size from the lower arena.</TD> 1221 </TR> 1222 <TR> 1223<TH><A href="arena/OS_AllocFromArenaLo.html" target="_self">OS_AllocFrom*ArenaLo</A></TH> 1224 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1225<TD>Allocates a region of the specified size from the lower arena. (Arena specification)</TD> 1226 </TR> 1227 <TR><TD class="separator" colspan=3></TD></TR> 1228 <TR> 1229<TH><A href="arena/OS_DumpArenaInfo.html" target="_self">OS_DumpArenaInfo</A></TH> 1230 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1231<TD>Displays the arena information. (Used in debugging.)</TD> 1232 </TR> 1233 <TR> 1234<TH><A href="arena/OS_DumpAllArenaInfo.html" target="_self">OS_DumpAllArenaInfo</A></TH> 1235 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1236<TD>Displays information for all arenas. (Used in debugging.)</TD> 1237 </TR> 1238 </TBODY> 1239</TABLE> 1240<H3><A name="Alloc">Memory Allocation</A></H3> 1241<TABLE border="1" width="100%"> 1242 <TBODY> 1243 <TR> 1244<TH width="25%"><A href="alloc/OS_InitAlloc.html" target="_self">OS_InitAlloc</A></TH> 1245 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1246<TD>Initializes memory allocation.</TD> 1247 </TR> 1248 <TR> 1249<TH width="25%"><A href="alloc/OS_ClearAlloc.html" target="_self">OS_ClearAlloc</A></TH> 1250 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1251<TD>Clears memory allocation.</TD> 1252 </TR> 1253 <TR><TD class="separator" colspan=3></TD></TR> 1254 <TR> 1255<TH width="25%"><A href="alloc/OS_CreateHeap.html" target="_self">OS_CreateHeap</A></TH> 1256 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1257<TD>Creates a heap.</TD> 1258 </TR> 1259 <TR> 1260<TH><A href="alloc/OS_DestroyHeap.html" target="_self">OS_DestroyHeap</A></TH> 1261 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1262<TD>Destroys a heap.</TD> 1263 </TR> 1264 <TR> 1265<TH><A href="alloc/OS_ClearHeap.html" target="_self">OS_ClearHeap</A></TH> 1266 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1267<TD>Initializes a heap</TD> 1268 </TR> 1269 <TR> 1270<TH><A href="alloc/OS_AddToHeap.html" target="_self">OS_AddToHeap</A></TH> 1271 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1272<TD>Adds the specified memory block to the heap.</TD> 1273 </TR> 1274 <TR> 1275<TH><A href="alloc/OS_SetCurrentHeap.html">OS_SetCurrentHeap</A></TH> 1276 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1277<TD>Sets the current heap.</TD> 1278 </TR> 1279 <TR><TD class="separator" colspan=3></TD></TR> 1280 <TR> 1281<TH><A href="alloc/OS_AllocFromHeap.html">OS_AllocFromHeap</A></TH> 1282 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1283<TD>Allocates memory from the heap.</TD> 1284 </TR> 1285 <TR> 1286<TH><A href="alloc/OS_AllocFromHeap.html">OS_AllocFrom*</A></TH> 1287 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1288<TD>Allocates memory from the heap. (Arena specification)</TD> 1289 </TR> 1290 <TR> 1291<TH><A href="alloc/OS_AllocFromHeap.html">OS_Alloc</A></TH> 1292 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1293<TD>Allocates memory from the heap. (Main memory arena)</TD> 1294 </TR> 1295 <TR> 1296<TH><A href="alloc/OS_AllocFixed.html">OS_AllocFixed</A></TH> 1297 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1298<TD>Allocates the specified region.</TD> 1299 </TR> 1300 <TR><TD class="separator" colspan=3></TD></TR> 1301 <TR> 1302<TH><A href="alloc/OS_FreeToHeap.html">OS_FreeToHeap</A></TH> 1303 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1304<TD>Frees memory to the heap.</TD> 1305 </TR> 1306 <TR> 1307<TH><A href="alloc/OS_FreeToHeap.html">OS_FreeTo*</A></TH> 1308 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1309<TD>Deallocates memory to the heap. (Arena specification)</TD> 1310 </TR> 1311 <TR> 1312<TH><A href="alloc/OS_FreeToHeap.html">OS_Free</A></TH> 1313 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1314<TD>Deallocates memory to the heap. (Main memory arena)</TD> 1315 </TR> 1316 <TR> 1317<TH><A href="alloc/OS_FreeAllToHeap.html">OS_FreeAllToHeap</A></TH> 1318 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1319<TD>Frees all allocated memory to the heap.</TD> 1320 </TR> 1321 <TR> 1322<TH><A href="alloc/OS_FreeAllToHeap.html">OS_FreeAllTo*</A></TH> 1323 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1324<TD>Deallocates all allocated memory to the heap. (Arena specification)</TD> 1325 </TR> 1326 <TR> 1327<TH><A href="alloc/OS_FreeAllToHeap.html">OS_FreeAll</A></TH> 1328 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1329<TD>Deallocates all allocated memory to the heap. (Main memory arena)</TD> 1330 </TR> 1331 <TR><TD class="separator" colspan=3></TD></TR> 1332 <TR> 1333<TH><A href="alloc/OS_CheckHeap.html">OS_CheckHeap</A></TH> 1334 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1335<TD>Checks the heap.</TD> 1336 </TR> 1337 <TR> 1338<TH><A href="alloc/OS_DumpHeap.html">OS_DumpHeap</A></TH> 1339 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1340<TD>Displays heap contents (for debugging). </TD> 1341 </TR> 1342 <TR><TD class="separator" colspan=3></TD></TR> 1343 <TR> 1344<TH><A href="alloc/OS_ReferentSize.html">OS_ReferentSize</A></TH> 1345 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1346<TD>Gets the size of the memory block (excluding the header).</TD> 1347 </TR> 1348 <TR> 1349<TH><A href="alloc/OS_VisitAllocated.html">OS_VisitAllocated</A></TH> 1350 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1351<TD>Applies the specified function to all memory blocks.</TD> 1352 </TR> 1353 <TR> 1354<TH><A href="alloc/OS_GetTotalAllocSize.html">OS_GetTotalAllocSize</A></TH> 1355 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1356<TD>Obtains the total size of the memory blocks allocated to the heap. The header is not included.</TD> 1357 </TR> 1358 <TR> 1359<TH><A href="alloc/OS_GetTotalOccupiedSize.html">OS_GetTotalOccupiedSize</A></TH> 1360 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1361<TD>Obtains the total size of the memory blocks (including the header) allocated to the heap.</TD> 1362 </TR> 1363 <TR> 1364<TH><A href="alloc/OS_GetTotalFreeSize.html">OS_GetTotalFreeSize</A></TH> 1365 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1366<TD>Obtains the total size of free blocks in heaps.</TD> 1367 </TR> 1368 <TR> 1369<TH><A href="alloc/OS_GetMaxFreeSize.html">OS_GetMaxFreeSize</A></TH> 1370 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1371<TD>Obtains the size of the largest free block in heaps.</TD> 1372 </TR> 1373 </TBODY> 1374</TABLE> 1375<H3><A name="Owner">System Information</A></H3> 1376<TABLE border="1" width="100%"> 1377 <TBODY> 1378 <TR> 1379<TH width="25%"><A href="ownerInfo/OS_GetOwnerInfo.html">OS_GetOwnerInfo</A></TH> 1380 <TD width="48"><img src="../image/NTR.gif"><img src="../image/BPT.gif"></TD> 1381<TD>Obtains owner information.</TD> 1382 </TR> 1383 <TR> 1384<TH width="25%"><A href="ownerInfo/OS_GetOwnerInfo.html">OS_GetOwnerInfoEx</A></TH> 1385 <TD width="48"><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD> 1386<TD>Gets owner information.</TD> 1387 </TR> 1388 <TR><TD class="separator" colspan=3></TD></TR> 1389 <TR> 1390<TH><A href="ownerInfo/OSOwnerInfo.html">OSOwnerInfo</A></TH> 1391 <TD><img src="../image/NTR.gif"><img src="../image/BPT.gif"></TD> 1392<TD>Structure that specifies owner information.</TD> 1393 </TR> 1394 <TR> 1395<TH><A href="ownerInfo/OSOwnerInfo.html">OSOwnerInfoEx</A></TH> 1396 <TD><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD> 1397<TD>Structure that specifies owner information.</TD> 1398 </TR> 1399 <TR><TD class="separator" colspan=3></TD></TR> 1400 <TR> 1401<TH><A href="ownerInfo/OS_GetOwnerRtcOffset.html">OS_GetOwnerRtcOffset</A></TH> 1402 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1403<TD>Obtains RTC modification offset information.</TD> 1404 </TR> 1405 <TR> 1406<TH><A href="ownerInfo/OS_GetMacAddress.html">OS_GetMacAddress</A></TH> 1407 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1408<TD>Obtains the unique MAC address for the Nintendo DS system.</TD> 1409 </TR> 1410 <TR> 1411<TH><A href="ownerInfo/OS_GetFavoriteColorTable.html">OS_GetFavoriteColorTable</A></TH> 1412 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1413<TD>Obtains a pointer to an array containing the RGBA color values that correspond to the IPL favorite color menu.</TD> 1414 </TR> 1415 <TR> 1416<TH><A href="ownerInfo/OS_GetFavoriteColor.html">OS_GetFavoriteColor</A></TH> 1417 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1418<TD>Obtains the color value of the "favorite color" from the owner information.</TD> 1419 </TR> 1420 <TR> 1421<TH><A href="ownerInfo/os_favorite_color_const.html">OS_FAVORITE_COLOR_*</A></TH> 1422 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1423<TD>Definition value of the "favorite color" from the owner information.</TD> 1424 </TR> 1425 <TR> 1426<TH><A href="ownerInfo/OS_IsAvailableWireless.html">OS_IsAvailableWireless</A></TH> 1427 <TD><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD> 1428<TD>Determine whether wireless communications features configured in the TWL console settings are available.</TD> 1429 </TR> 1430 <TR> 1431<TH><A href="ownerInfo/OS_IsAgreeEULA.html">OS_IsAgreeEULA</A></TH> 1432 <TD><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD> 1433<TD>Determines whether the EULA has been agreed to on this system.</TD> 1434 </TR> 1435 <TR> 1436<TH><A href="ownerInfo/OS_GetAgreedEULAVersion.html">OS_GetAgreedEULAVersion</A></TH> 1437 <TD><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD> 1438<TD>Gets the EULA version that the end user of this system has agreed to.</TD> 1439 </TR> 1440 <TR> 1441<TH><A href="ownerInfo/OS_IsParentalControledApp.html">OS_IsParentalControledApp</A></TH> 1442 <TD><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD> 1443<TD>Determines whether Parental Controls should be applied when an application is started up.</TD> 1444 </TR> 1445 <TR> 1446<TH><A href="ownerInfo/OS_IsRestrictPictoChatBoot.html">OS_IsRestrictPictoChatBoot</A></TH> 1447 <TD><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD> 1448<TD>Determines whether there is a restriction on starting PictoChat.</TD> 1449 </TR> 1450 <TR> 1451<TH><A href="ownerInfo/OS_IsRestrictDSDownloadBoot.html">OS_IsRestrictDSDownloadBoot</A></TH> 1452 <TD><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD> 1453<TD>Determines whether there is a restriction on starting DS download play.</TD> 1454 </TR> 1455 <TR> 1456<TH><A href="ownerInfo/OS_IsRestrictBrowserBoot.html">OS_IsRestrictBrowserBoot</A></TH> 1457 <TD><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD> 1458<TD>Determines whether there is a restriction on starting the Nintendo DSi browser.</TD> 1459 </TR> 1460 <TR> 1461<TH><A href="ownerInfo/OS_IsRestrictPrepaidPoint.html">OS_IsRestrictPrepaidPoint</A></TH> 1462 <TD><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD> 1463<TD>Determines whether there is a restriction on using Nintendo DSi Points.</TD> 1464 </TR> 1465 <TR> 1466<TH><A href="ownerInfo/OS_IsRestrictPhotoExchange.html">OS_IsRestrictPhotoExchange</A></TH> 1467 <TD><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD> 1468<TD>Determines whether there is a restriction on exchanging photo data.</TD> 1469 </TR> 1470 <TR> 1471<TH><A href="ownerInfo/OS_IsRestrictUGC.html">OS_IsRestrictUGC</A></TH> 1472 <TD><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD> 1473<TD>Determines whether there is a restriction on exchanging user-generated content.</TD> 1474 </TR> 1475 <TR> 1476<TH><A href="ownerInfo/OS_IsForceDisableWireless.html">OS_IsForceDisableWireless</A></TH> 1477 <TD><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD> 1478<TD>Determines whether use of wireless communications was prohibited when a TWL version was produced.</TD> 1479 </TR> 1480 <TR> 1481<TH><A href="ownerInfo/OS_GetRegion.html">OS_GetRegion</A></TH> 1482 <TD><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD> 1483<TD>Gets the region information.</TD> 1484 </TR> 1485 <TR> 1486<TH><A href="ownerInfo/OS_GetRegionCodeA3.html">OS_GetRegionCodeA3</A></TH> 1487 <TD><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD> 1488<TD>Gets a string that corresponds to the region code.</TD> 1489 </TR> 1490 <TR> 1491<TH><A href="ownerInfo/OS_GetRegionCodeA2.html">OS_GetRegionCodeA2</A></TH> 1492 <TD><img src="../image/BPT.gif"><img src="../image/TWL.gif"></TD> 1493<TD>Converts the TWL's proprietary country and region code numbers into <CODE>ISO 3166-1 alpha-2</CODE> format.</TD> 1494 </TR> 1495 <TR><TD class="separator" colspan=3></TD></TR> 1496 <TR> 1497<TH><A href="entropy/OS_GetLowEntropyData.html">OS_GetLowEntropyData</A></TH> 1498 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1499<TD>Different values are generated from system status each time it is run, and these values are returned.</TD> 1500 </TR> 1501 </TBODY> 1502</TABLE> 1503<H3><A name="BootInfo">Boot Information</A></H3> 1504<TABLE border="1" width="100%"> 1505 <TBODY> 1506 <TR> 1507<TH width="25%"><A href="bootInfo/OS_GetBootType.html">OS_GetBootType</A></TH> 1508 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1509<TD>Gets the current boot type.</TD> 1510 </TR> 1511 <TR> 1512<TH><A href="bootInfo/OS_GetBootInfo.html">OS_GetBootInfo</A></TH> 1513 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1514<TD>Gets information about the current boot.</TD> 1515 </TR> 1516 </TBODY> 1517</TABLE> 1518<H3><A name="Environment">Operating Environment</A></H3> 1519<TABLE border="1" width="100%"> 1520 <TBODY> 1521 <TR> 1522<TH><A href="consoleType/OS_IsRunOnEmulator.html" target="_self">OS_IsRunOnEmulator</A></TH> 1523 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1524<TD>Checks whether the application is running on the Ensata emulator. (Used in debugging)</TD> 1525 </TR> 1526 <TR> 1527<TH><A href="consoleType/OS_IsRunOnDebugger.html" target="_self">OS_IsRunOnDebugger</A></TH> 1528 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1529<TD>Checks whether the application is running on the DEBUGGER. (Used in debugging)</TD> 1530 </TR> 1531 <TR> 1532<TH><A href="consoleType/OS_IsRunOnTwl.html" target="_self">OS_IsRunOnTwl</A></TH> 1533 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1534<TD>Checks whether the application is running in TWL mode.</TD> 1535 </TR> 1536 <TR> 1537<TH><A href="consoleType/OS_GetConsoleType.html">OS_GetConsoleType</A></TH> 1538 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1539<TD>Checks the operation environment of the application. Returns a constant value for FINALROM builds.</TD> 1540 </TR> 1541 <TR> 1542<TH><A href="consoleType/OS_GetRunningConsoleType.html">OS_GetRunningConsoleType</A></TH> 1543 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1544<TD>Checks the operation environment of the application.</TD> 1545 </TR> 1546 <TR> 1547<TH><A href="system/OS_IsCodecTwlMode.html">OS_IsCodecTwlMode</A></TH> 1548 <TD><IMG src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1549<TD>Gets the operating mode of the CODEC.</TD> 1550 </TR> 1551 </TBODY> 1552</TABLE> 1553 1554<H3><A name="Debug-Print">Debug (String Display)</A></H3> 1555<TABLE border="1" width="100%"> 1556 <TBODY> 1557 <TR> 1558<TH width="25%"><A href="debug/OS_PutString.html" target="_self">OS_PutString</A></TH> 1559 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1560<TD>Outputs a string.</TD> 1561 </TR> 1562 <TR> 1563<TH width="25%"><A href="debug/OS_FPutString.html" target="_self">OS_FPutString</A></TH> 1564 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1565<TD>Outputs a string. (Output is specified.)</TD> 1566 </TR> 1567 <TR><TD class="separator" colspan=3></TD></TR> 1568 <TR> 1569<TH width="25%"><A href="debug/OS_Printf.html" target="_self">OS_Printf</A></TH> 1570 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1571<TD>Displays the string with formatting.</TD> 1572 </TR> 1573 <TR> 1574<TH width="25%"><A href="debug/OS_FPrintf.html" target="_self">OS_FPrintf</A></TH> 1575 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1576<TD>Displays the string with formatting. (Output is specified.)</TD> 1577 </TR> 1578 <TR> 1579<TH width="25%"><A href="debug/OS_TPrintf.html" target="_self">OS_TPrintf</A></TH> 1580 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1581<TD>Displays the string with formatting. This is a simplified version of <code>OS_Printf</code>.</TD> 1582 </TR> 1583 <TR> 1584<TH width="25%"><A href="debug/OS_TFPrintf.html" target="_self">OS_TFPrintf</A></TH> 1585 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1586<TD>Displays the string with formatting. This is a simplified version of <code>OS_Printf</code>. (Output is specified.)</TD> 1587 </TR> 1588 <TR> 1589<TH width="25%"><A href="debug/OS_VPrintf.html" target="_self">OS_VPrintf</A></TH> 1590 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1591<TD>Displays the string with formatting. Uses the list of arguments.</TD> 1592 </TR> 1593 <TR> 1594<TH width="25%"><A href="debug/OS_VFPrintf.html" target="_self">OS_VFPrintf</A></TH> 1595 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1596<TD>Displays the string with formatting. Uses the list of arguments. (Output is specified.)</TD> 1597 </TR> 1598 <TR> 1599<TH width="25%"><A href="debug/OS_TVPrintf.html" target="_self">OS_TVPrintf</A></TH> 1600 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1601<TD>Displays the string with formatting. This is a simplified version of <code>OS_VPrintf</code>.</TD> 1602 </TR> 1603 <TR> 1604<TH width="25%"><A href="debug/OS_TVFPrintf.html" target="_self">OS_TVFPrintf</A></TH> 1605 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1606<TD>Displays the string with formatting. This is a simplified version of <code>OS_VPrintf</code>. (Output is specified.)</TD> 1607 </TR> 1608 <TR><TD class="separator" colspan=3></TD></TR> 1609 <TR> 1610<TH width="25%"><A href="debug/OS_SPrintf.html" target="_self">OS_SPrintf</A></TH> 1611 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1612<TD><font color="gray">This function has been replaced with the <a href="../std/string/STD_TSPrintf.html"><code>STD_TSPrintf</code></a> function.</font></TD> 1613 </TR> 1614 <TR> 1615<TH width="25%"><A href="debug/OS_VSPrintf.html" target="_self">OS_VSPrintf</A></TH> 1616 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1617<TD><font color="gray">This function has been replaced with the <a href="../std/string/STD_TVSPrintf.html"><code>STD_TVSPrintf</code></a> function.</font></TD> 1618 </TR> 1619 <TR> 1620<TH width="25%"><A href="debug/OS_SNPrintf.html" target="_self">OS_SNPrintf</A></TH> 1621 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1622<TD><font color="gray">This function has been replaced with the <a href="../std/string/STD_TSNPrintf.html"><code>STD_TSNPrintf</code></a> function.</font></TD> 1623 </TR> 1624 <TR> 1625<TH width="25%"><A href="debug/OS_VSNPrintf.html" target="_self">OS_VSNPrintf</A></TH> 1626 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1627<TD><font color="gray">This function has been replaced with the <a href="../std/string/STD_TVSNPrintf.html"><code>STD_TVSNPrintf</code></a> function.</font></TD> 1628 </TR> 1629 <TR><TD class="separator" colspan=3></TD></TR> 1630 <TR> 1631<TH width="25%"><A href="debug/OS_TPrintfEx.html" target="_self">OS_TPrintfEx</A></TH> 1632 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1633<TD>Displays the string with formatting. This is an extended version of <CODE>OS_TPrintf</CODE>.</TD> 1634 </TR> 1635 <TR> 1636<TH width="25%"><A href="debug/OS_TFPrintfEx.html" target="_self">OS_TFPrintfEx</A></TH> 1637 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1638<TD>Displays the string with formatting. This is an extended version of <CODE>OS_TPrintf</CODE>. (Output is specified.)</TD> 1639 </TR> 1640 <TR> 1641<TH width="25%"><A href="debug/OS_TVPrintfEx.html" target="_self">OS_TVPrintfEx</A></TH> 1642 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1643<TD>Displays the string with formatting. This is an extended version of <CODE>OS_TVPrintf</CODE>.</TD> 1644 </TR> 1645 <TR> 1646<TH width="25%"><A href="debug/OS_TVFPrintfEx.html" target="_self">OS_TVFPrintfEx</A></TH> 1647 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1648<TD>Displays the string with formatting. This is an extended version of <CODE>OS_TVPrintf</CODE>. (Output is specified.)</TD> 1649 </TR> 1650 <TR> 1651<TH width="25%"><A href="debug/OS_VSNPrintfEx.html" target="_self">OS_VSNPrintfEx</A></TH> 1652 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1653<TD>Outputs the formatted string to the memory with the argument list. (The size is specified.)</TD> 1654 </TR> 1655 <TR><TD class="separator" colspan=3></TD></TR> 1656 <TR> 1657<TH><A href="debug/OS_Warning.html" target="_self">OS_Warning</A></TH> 1658 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1659<TD>Displays a warning.</TD> 1660 </TR> 1661 <TR> 1662<TH><A href="debug/OS_FWarning.html" target="_self">OS_FWarning</A></TH> 1663 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1664<TD>Displays a warning. (Output is specified.)</TD> 1665 </TR> 1666 <TR> 1667<TH><A href="debug/OS_TWarning.html" target="_self">OS_TWarning</A></TH> 1668 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1669<TD>Displays a warning. This is the simple version of <CODE>OS_Warning</CODE>.</TD> 1670 </TR> 1671 <TR> 1672<TH><A href="debug/OS_TFWarning.html" target="_self">OS_TFWarning</A></TH> 1673 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1674<TD>Displays a warning. This is the simple version of <CODE>OS_Warning</CODE>. (Output is specified.)</TD> 1675 </TR> 1676 <TR><TD class="separator" colspan=3></TD></TR> 1677 <TR> 1678<TH><A href="debug/OS_SetPrintOutput.html" target="_self">OS_SetPrintOutput</A></TH> 1679 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1680<TD>Specifies the output destination for output functions.</TD> 1681 </TR> 1682 <TR><TD class="separator" colspan=3></TD></TR> 1683 <TR> 1684<TH width="25%"><A href="debug/OS_InitPrintServer.html" target="_self"><font color="#808080">OS_InitPrintServer</font></A></TH> 1685 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1686<TD><font color="#808080">Initializes for display of debug message from ARM7. There is normally no need for this.</font></TD> 1687 </TR> 1688 <TR> 1689<TH width="25%"><A href="debug/OS_PrintServer.html" target="_self"><font color="#808080">OS_PrintServer</font></A></TH> 1690 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1691<TD><font color="#808080">Displays debug messages from ARM7. There is normally no need for this.</font></TD> 1692 </TR> 1693 </TBODY> 1694</TABLE> 1695<H3><A name="Debug-Assert">Debug (Assert)</A></H3> 1696<TABLE border="1" width="100%"> 1697 <TBODY> 1698 <TR> 1699<TH width="25%"><A href="debug/SDK_ASSERT.html">SDK_ASSERT*</A></TH> 1700 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1701<TD>Checks the requirements, displays a warning, and stops the application.</TD> 1702 </TR> 1703 <TR> 1704<TH><A href="debug/SDK_WARNING.html">SDK_WARNING</A></TH> 1705 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1706<TD>Checks the conditions, and displays a warning.</TD> 1707 </TR> 1708 <TR> 1709<TH><A href="debug/OS_Panic.html" target="_self">OS_Panic</A></TH> 1710 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1711<TD>Stops the application.</TD> 1712 </TR> 1713 <TR> 1714<TH><A href="debug/OS_FPanic.html" target="_self">OS_FPanic</A></TH> 1715 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1716<TD>Stops the application. (Output is specified.)</TD> 1717 </TR> 1718 <TR> 1719<TH><A href="debug/OS_TPanic.html" target="_self">OS_TPanic</A></TH> 1720 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1721<TD>Stops the application. This is a simplified version of <code>OS_Panic</code>.</TD> 1722 </TR> 1723 <TR> 1724<TH><A href="debug/OS_TFPanic.html" target="_self">OS_TFPanic</A></TH> 1725 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1726<TD>Stops the application. This is a simplified version of <code>OS_Panic</code>. (Output is specified.)</TD> 1727 </TR> 1728 <TR> 1729<TH><A href="debug/SDK_COMPILER_ASSERT.html" target="_self">SDK_COMPILER_ASSERT</A></TH> 1730 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1731<TD>Conditions are inspected when compiling, and if conditions are not met, a compile error is raised.</TD> 1732 </TR> 1733 </TBODY> 1734</TABLE> 1735<H3><A name="Debug-CallTrace">Debug (Function Call Trace)</A></H3> 1736<TABLE border="1" width="100%"> 1737 <TBODY> 1738 <TR> 1739<TH width="25%"><A href="callTrace/OS_InitCallTrace.html" target="_self">OS_InitCallTrace</A></TH> 1740 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1741<TD>Sets the buffer of the function call trace.</TD> 1742 </TR> 1743 <TR> 1744<TH width="25%"><A href="callTrace/OS_DumpCallTrace.html" target="_self">OS_DumpCallTrace</A></TH> 1745 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1746<TD>Displays the contents of the function call trace buffer.</TD> 1747 </TR> 1748 <TR> 1749<TH width="25%"><A href="callTrace/OS_DumpThreadCallTrace.html" target="_self">OS_DumpThreadCallTrace</A></TH> 1750 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1751<TD>Displays the contents of the function call trace buffer for the specified thread.</TD> 1752 </TR> 1753 <TR> 1754<TH width="25%"><A href="callTrace/OS_CalcCallTraceLines.html" target="_self">OS_CalcCallTraceLines</A></TH> 1755 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1756<TD>Calculates the number of lines for the function call trace from the buffer size.</TD> 1757 </TR> 1758 <TR> 1759<TH width="25%"><A href="callTrace/OS_CalcCallTraceBufferSize.html" target="_self">OS_CalcCallTraceBufferSize</A></TH> 1760 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1761<TD>Calculates the buffer size for the function call trace from the number of lines.</TD> 1762 </TR> 1763 <TR> 1764<TH width="25%"><A href="callTrace/OS_ClearCallTraceBuffer.html" target="_self">OS_ClearCallTraceBuffer</A></TH> 1765 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1766<TD>Clears the contents of the function call trace buffer.</TD> 1767 </TR> 1768 <TR> 1769<TH width="25%"><A href="callTrace/OS_EnableCallTrace.html" target="_self">OS_EnableCallTrace</A></TH> 1770 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1771<TD>Enables the function call trace.</TD> 1772 </TR> 1773 <TR> 1774<TH width="25%"><A href="callTrace/OS_DisableCallTrace.html" target="_self">OS_DisableCallTrace</A></TH> 1775 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1776<TD>Dsables the function call trace.</TD> 1777 </TR> 1778 <TR> 1779<TH width="25%"><A href="callTrace/OS_RestoreCallTrace.html" target="_self">OS_RestoreCallTrace</A></TH> 1780 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1781<TD>Sets the function call trace to enabled or disabled.</TD> 1782 </TR> 1783 </TBODY> 1784</TABLE> 1785<H3><A name="Debug-FunctionCost">Debug (Function Cost Measurement)</A></H3> 1786<TABLE border="1" width="100%"> 1787 <TBODY> 1788 <TR> 1789<TH width="25%"><A href="functionCost/OS_InitFunctionCost.html" target="_self">OS_InitFunctionCost</A></TH> 1790 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1791<TD>Sets the function cost measurement buffer.</TD> 1792 </TR> 1793 <TR> 1794<TH width="25%"><A href="functionCost/OS_CalcFunctionCostLines.html" target="_self">OS_CalcFunctionCostLines</A></TH> 1795 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1796<TD>Calculates the amount of information for the function cost measurement from the buffer size.</TD> 1797 </TR> 1798 <TR> 1799<TH width="25%"><A href="functionCost/OS_CalcFunctionCostBufferSize.html" target="_self">OS_CalcFunctionCostBufferSize</A></TH> 1800 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1801<TD>Calculates the buffer size for the function cost measurement from the number of lines.</TD> 1802 </TR> 1803 <TR> 1804<TH width="25%"><A href="functionCost/OS_ClearFunctionCostBuffer.html" target="_self">OS_ClearFunctionCostBuffer</A></TH> 1805 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1806<TD>Clears the contents of the function cost measurement buffer.</TD> 1807 </TR> 1808 <TR> 1809<TH width="25%"><A href="functionCost/OS_CheckFunctionCostBuffer.html" target="_self">OS_CheckFunctionCostBuffer</A></TH> 1810 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1811<TD>Checks whether the high-order position of the function cost calculation buffer was overwritten.</TD> 1812 </TR> 1813 <TR> 1814<TH width="25%"><A href="functionCost/OS_EnableFunctionCost.html" target="_self">OS_EnableFunctionCost</A></TH> 1815 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1816<TD>Enables function cost calculation.</TD> 1817 </TR> 1818 <TR> 1819<TH width="25%"><A href="functionCost/OS_DisableFunctionCost.html" target="_self">OS_DisableFunctionCost</A></TH> 1820 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1821<TD>Disables function cost calculation.</TD> 1822 </TR> 1823 <TR> 1824<TH width="25%"><A href="functionCost/OS_RestoreFunctionCost.html" target="_self">OS_RestoreFunctionCost</A></TH> 1825 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1826<TD>Sets function cost measurement to enabled or disabled.</TD> 1827 </TR> 1828 <TR> 1829<TH width="25%"><A href="functionCost/OS_InitStatistics.html" target="_self">OS_InitStatistics</A></TH> 1830 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1831<TD>Initializes the function cost calculation buffer.</TD> 1832 </TR> 1833 <TR> 1834<TH width="25%"><A href="functionCost/OS_CheckStatisticsBuffer.html" target="_self">OS_CheckStatisticsBuffer</A></TH> 1835 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1836<TD>Checks whether the high-order position of the function cost statistics buffer was overwritten.</TD> 1837 </TR> 1838 <TR> 1839<TH width="25%"><A href="functionCost/OS_CalcStatistics.html" target="_self">OS_CalcStatistics</A></TH> 1840 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1841<TD>Obtains the contents of the measurement buffer, and writes them to the function cost calculation buffer.</TD> 1842 </TR> 1843 <TR> 1844<TH width="25%"><A href="functionCost/OS_CalcThreadStatistics.html" target="_self">OS_CalcThreadStatistics</A></TH> 1845 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1846<TD>Obtains the contents of the measurement buffer, and writes them to the function cost calculation buffer with a thread specification.</TD> 1847 </TR> 1848 <TR> 1849<TH width="25%"><A href="functionCost/OS_DumpStatistics.html" target="_self">OS_DumpStatistics</A></TH> 1850 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1851<TD>Outputs the contents of the function cost calculation buffer.</TD> 1852 </TR> 1853 </TBODY> 1854</TABLE> 1855<H3><A name="Debug-Stack">Debug</A> (Stack Check)</H3> 1856<TABLE border="1" width="100%"> 1857 <TBODY> 1858 <TR> 1859<TH width="25%"><A href="stack/OS_SetThreadStackWarningOffset.html" target="_self">OS_SetThreadStackWarningOffset</A></TH> 1860 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1861<TD>Sets the warning level for the thread stack overflow check.</TD> 1862 </TR> 1863 <TR> 1864<TH width="25%"><A href="stack/OS_CheckStack.html" target="_self">OS_CheckStack</A></TH> 1865 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1866<TD>Checks the thread stack overflow.</TD> 1867 </TR> 1868 <TR> 1869<TH width="25%"><A href="stack/OS_GetStackStatus.html" target="_self">OS_GetStackStatus</A></TH> 1870 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1871<TD>Obtains the stack overflow status of the thread.</TD> 1872 </TR> 1873 <TR> 1874<TH width="25%"><A href="stack/OS_SetIrqStackChecker.html" target="_self">OS_SetIrqStackChecker</A></TH> 1875 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1876<TD>Set the magic number to check whether the stack used for IRQ mode has overflowed.</TD> 1877 </TR> 1878 <TR> 1879<TH width="25%"><A href="stack/OS_SetIrqStackWarningOffset.html" target="_self">OS_SetIrqStackWarningOffset</A></TH> 1880 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1881<TD>Set the warning level to check whether the stack used for IRQ mode has overflowed.</TD> 1882 </TR> 1883 <TR> 1884<TH width="25%"><A href="stack/OS_CheckIrqStack.html" target="_self">OS_CheckIrqStack</A></TH> 1885 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1886<TD>Check whether the stack used for IRQ mode has overflowed.</TD> 1887 </TR> 1888 <TR> 1889<TH width="25%"><A href="stack/OS_GetIrqStackStatus.html" target="_self">OS_GetIrqStackStatus</A></TH> 1890 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1891<TD>Obtains the overflow status of the stack used for IRQ mode.</TD> 1892 </TR> 1893 </TBODY> 1894</TABLE> 1895<H3><A name="Debug-Argument">Debug (Argument)</A></H3> 1896<TABLE border="1" width="100%"> 1897 <TBODY> 1898 <TR> 1899<TH width="25%"><A href="argument/OS_GetArgc.html">OS_GetArgc</A></TH> 1900 <TD width="48"><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1901<TD>Obtains the number of arguments.</TD> 1902 </TR> 1903 <TR> 1904<TH><A href="argument/OS_GetArgv.html">OS_GetArgv</A></TH> 1905 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1906<TD>Obtains the string position of arguments.</TD> 1907 </TR> 1908 <TR> 1909<TH><A href="argument/OS_GetOpt.html">OS_GetOpt*</A></TH> 1910 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1911<TD>Obtains information for the argument options for the command line.</TD> 1912 </TR> 1913 <TR> 1914<TH><A href="argument/OS_ConvertToArguments.html">OS_ConvertToArguments</A></TH> 1915 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1916<TD>Converts strings to argument data.</TD> 1917 </TR> 1918 <TR> 1919<TH><A href="argument/OS_SetArgumentBuffer.html">OS_SetArgumentBuffer</A></TH> 1920 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1921<TD>Sets argument data.</TD> 1922 </TR> 1923 <TR> 1924<TH><A href="argument/OS_GetArgumentBuffer.html">OS_GetArgumentBuffer</A></TH> 1925 <TD><img src="../image/NTR.gif"><img src="../image/TWL.gif"></TD> 1926<TD>Obtains argument data.</TD> 1927 </TR> 1928 </TBODY> 1929</TABLE> 1930 1931<table border="0" height="100%"><tr><td style="background-color : white;"></td></tr></table> 1932<hr><p>CONFIDENTIAL</p></body> 1933</HTML>
