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 name="GENERATOR" content="Microsoft FrontPage 5.0"> 6<META http-equiv="Content-Style-Type" content="text/css"> 7<LINK rel="stylesheet" type="text/css" href="../CSS/revolution.css"> 8<BASE target="main"> 9<TITLE>List of Operating System (OS) Functions</TITLE> 10</HEAD> 11<BODY> 12<H1><A name="Operating System API">List of Operating System (OS) Functions</A></H1> 13 14<H2><A name="Address Conversion">Address Conversion</A></H2> 15<TABLE class="api_list" border="1" > 16 <TBODY> 17 <TR> 18<TH nowrap><A href="Address/OSPhysicalToCached.html">OSPhysicalToCached</A></TH> 19<TD>Converts a physical address into a cached address.</TD> 20 </TR> 21 <TR> 22<TH nowrap><A href="Address/OSPhysicalToUncached.html">OSPhysicalToUncached</A></TH> 23<TD>Converts a physical address into an address outside the cache.</TD> 24 </TR> 25 <TR> 26<TH nowrap><A href="Address/OSCachedToPhysical.html">OSCachedToPhysical</A></TH> 27<TD>Converts a cached address into a physical address.</TD> 28 </TR> 29 <TR> 30<TH nowrap><A href="Address/OSUncachedToPhysical.html">OSUncachedToPhysical</A></TH> 31<TD>Converts an address outside the cache into a physical address.</TD> 32 </TR> 33 <TR> 34<TH nowrap><A href="Address/OSCachedToUncached.html">OSCachedToUncached</A></TH> 35<TD>Converts a cached address into an address outside the cache.</TD> 36 </TR> 37 <TR> 38<TH nowrap><A href="Address/OSUncachedToCached.html">OSUncachedToCached</A></TH> 39<TD>Converts an address outside the cache into a cached address.</TD> 40 </TR> 41 <TR> 42<TH nowrap><A href="Address/OSRoundUp32B.html">OSRoundUp32B</A></TH> 43<TD>Retrieves the closest 32-byte upper boundary.</TD> 44 </TR> 45 <TR> 46<TH nowrap><A href="Address/OSRoundDown32B.html">OSRoundDown32B</A></TH> 47<TD>Retrieves the closest 32-byte lower boundary.</TD> 48 </TR> 49 </TBODY> 50</TABLE> 51 52<H2><A name="Alarm">Alarms</A></H2> 53<TABLE class="api_list" border="1" > 54 <TBODY> 55 <TR> 56<TH nowrap><A href="Alarm/OSCancelAlarm.html">OSCancelAlarm</A></TH> 57<TD>Cancels the specified alarm.</TD> 58 </TR> 59 <TR> 60<TH nowrap><A href="Alarm/OSCancelAlarms.html">OSCancelAlarms</A></TH> 61<TD>Cancels alarm groups that have the same tag.</TD> 62 </TR> 63 <TR> 64<TH nowrap><A href="Alarm/OSCreateAlarm.html">OSCreateAlarm</A></TH> 65<TD>Initializes the structure for the specified alarm.</TD> 66 </TR> 67 <TR> 68<TH nowrap><A href="Alarm/OSSetAlarm.html">OSSetAlarm</A></TH> 69<TD>Sets an alarm.</TD> 70 </TR> 71 <TR> 72<TH nowrap><A href="Alarm/OSSetAlarmTag.html">OSSetAlarmTag</A></TH> 73<TD>Sets a tag to an alarm.</TD> 74 </TR> 75 <TR> 76<TH nowrap><A href="Alarm/OSSetPeriodicAlarm.html">OSSetPeriodicAlarm</A></TH> 77<TD>Sets a periodic alarm.</TD> 78 </TR> 79 <TR> 80<TH nowrap><A href="Alarm/OSSetAlarmUserData.html">OSSetAlarmUserData</A></TH> 81<TD>Sets user data in an alarm.</TD> 82 </TR> 83 <TR> 84<TH nowrap><A href="Alarm/OSGetAlarmUserData.html">OSGetAlarmUserData</A></TH> 85<TD>Gets user data from an alarm.</TD> 86 </TR> 87 </TBODY> 88</TABLE> 89 90<H2><A name="Arena">Arena</A></H2> 91<TABLE class="api_list" border="1" > 92 <TBODY> 93 <TR> 94<TH nowrap><A href="Arena/OSAllocFromMEM1ArenaHi.html">OSAllocFromMEM1ArenaHi</A></TH> 95<TD>Allocates <SPAN class="argument">size</SPAN> bytes from the upper boundary of the arena in internal main memory (MEM1 area).</TD> 96 </TR> 97 <TR> 98<TH nowrap><A href="Arena/OSAllocFromMEM1ArenaLo.html">OSAllocFromMEM1ArenaLo</A></TH> 99<TD>Allocates <SPAN class="argument">size</SPAN> bytes from the lower boundary of the arena in internal main memory (MEM1 area).</TD> 100 </TR> 101 <TR> 102<TH nowrap><A href="Arena/OSAllocFromMEM2ArenaHi.html">OSAllocFromMEM2ArenaHi</A></TH> 103<TD>Allocates <SPAN class="argument">size</SPAN> bytes from the upper boundary of the arena in external main memory (MEM2 area).</TD> 104 </TR> 105 <TR> 106<TH nowrap><A href="Arena/OSAllocFromMEM2ArenaLo.html">OSAllocFromMEM2ArenaLo</A></TH> 107<TD>Allocates <SPAN class="argument">size</SPAN> bytes from the lower boundary of the arena in external main memory (MEM2 area).</TD> 108 </TR> 109 <TR> 110<TH nowrap><A href="Arena/OSGetMEM1ArenaHi.html">OSGetMEM1ArenaHi</A></TH> 111<TD>Gets the upper boundary of the arena in internal main memory (MEM1 area).</TD> 112 </TR> 113 <TR> 114<TH nowrap><A href="Arena/OSGetMEM1ArenaLo.html">OSGetMEM1ArenaLo</A></TH> 115<TD>Gets the lower boundary of the arena in internal main memory (MEM1 area).</TD> 116 </TR> 117 <TR> 118<TH nowrap><A href="Arena/OSGetMEM2ArenaHi.html">OSGetMEM2ArenaHi</A></TH> 119<TD>Gets the upper boundary of the arena in external main memory (MEM2 area).</TD> 120 </TR> 121 <TR> 122<TH nowrap><A href="Arena/OSGetMEM2ArenaLo.html">OSGetMEM2ArenaLo</A></TH> 123<TD>Gets the lower boundary of the arena in external main memory (MEM2 area).</TD> 124 </TR> 125 <TR> 126<TH nowrap><A href="Arena/OSSetMEM1ArenaHi.html">OSSetMEM1ArenaHi</A></TH> 127<TD>Sets the upper boundary of the arena in internal main memory (MEM1 area).</TD> 128 </TR> 129 <TR> 130<TH nowrap><A href="Arena/OSSetMEM1ArenaLo.html">OSSetMEM1ArenaLo</A></TH> 131<TD>Sets the lower boundary of the arena in internal main memory (MEM1 area).</TD> 132 </TR> 133 <TR> 134<TH nowrap><A href="Arena/OSSetMEM2ArenaHi.html">OSSetMEM2ArenaHi</A></TH> 135<TD>Sets the upper boundary of the arena in external main memory (MEM2 area).</TD> 136 </TR> 137 <TR> 138<TH nowrap><A href="Arena/OSSetMEM2ArenaLo.html">OSSetMEM2ArenaLo</A></TH> 139<TD>Sets the lower boundary of the arena in external main memory (MEM2 area).</TD> 140 </TR> 141 </TBODY> 142</TABLE> 143 144<H2><A name="Cache">Cache (Data Cache)</A></H2> 145<H3>Data Cache</H3> 146<TABLE class="api_list" border="1" > 147 <TBODY> 148 <TR> 149<TH nowrap><A href="Cache/DCFlushRange.html">DCFlushRange</A></TH> 150<TD>Flushes the specified region of the data cache.</TD> 151 </TR> 152 <TR> 153<TH nowrap><A href="Cache/DCFlushRangeNoSync.html">DCFlushRangeNoSync</A></TH> 154<TD>Invalidates a specified data cache range.</TD> 155 </TR> 156 <TR> 157<TH nowrap><A href="Cache/DCFreeze.html">DCFreeze</A></TH> 158<TD>Current contents of the L1 data cache are locked and will not be invalidated.</TD> 159 </TR> 160 <TR> 161<TH nowrap><A href="Cache/DCInvalidateRange.html">DCInvalidateRange</A></TH> 162<TD>Invalidates the specified region of the data cache.</TD> 163 </TR> 164 <TR> 165<TH nowrap><A href="Cache/DCStoreRange.html">DCStoreRange</A></TH> 166<TD>Reflects (writes back) the data in the specified region of the data cache to real memory.</TD> 167 </TR> 168 <TR> 169<TH nowrap><A href="Cache/DCStoreRangeNoSync.html">DCStoreRangeNoSync</A></TH> 170<TD>Securely updates specified memory range with modified data in the cache.</TD> 171 </TR> 172 <TR> 173<TH nowrap><A href="Cache/DCTouchRange.html">DCTouchRange</A></TH> 174<TD>Loads specified range of memory into the cache.</TD> 175 </TR> 176 <TR> 177<TH nowrap><A href="Cache/DCUnfreeze.html">DCUnfreeze</A></TH> 178<TD>Cancels the effect of the <code>DCFreeze</code> function.</TD> 179 </TR> 180 <TR> 181<TH nowrap><A href="Cache/DCZeroRange.html">DCZeroRange</A></TH> 182<TD>Loads the range of memory into the cache and sets all cache blocks to zero.</TD> 183 </TR> 184 </TBODY> 185</TABLE> 186 187<H3>Instruction Cache</H3> 188<TABLE class="api_list" border="1" > 189 <TBODY> 190 <TR> 191<TH nowrap><A href="Cache/ICFreeze.html">ICFreeze</A></TH> 192<TD>Current contents of the L1 instruction cache are locked and will not be invalidated.</TD> 193 </TR> 194 <TR> 195<TH nowrap><A href="Cache/ICInvalidateRange.html">ICInvalidateRange</A></TH> 196<TD>Invalidates the specified region of the instruction cache.</TD> 197 </TR> 198 <TR> 199<TH nowrap><A href="Cache/ICUnfreeze.html">ICUnfreeze</A></TH> 200<TD>Cancels the effect of the <code>ICFreeze</code> function.</TD> 201 </TR> 202 </TBODY> 203</TABLE> 204 205<H3>Locked Cache</H3> 206<TABLE class="api_list" border="1" > 207 <TBODY> 208 <TR> 209<TH nowrap><A href="Cache/LCDisable.html">LCDisable</A></TH> 210<TD>Disables the locked cache and returns the cache to the normal 32-KB and 8-way set associative state.</TD> 211 </TR> 212 <TR> 213<TH nowrap><A href="Cache/LCEnable.html">LCEnable</A></TH> 214<TD>Enables the locked cache.</TD> 215 </TR> 216 <TR> 217<TH nowrap><A href="Cache/LCGetBase.html">LCGetBase</A></TH> 218<TD>Returns a base pointer to the locked cache region. </TD> 219 </TR> 220 <TR> 221<TH nowrap><A href="Cache/LCFlushQueue.html">LCFlushQueue</A></TH> 222<TD>Flushes the DMA queue and issues SYNC until all DMA transfers are committed.</TD> 223 </TR> 224 <TR> 225<TH nowrap><A href="Cache/LCLoadBlocks.html">LCLoadBlocks</A></TH> 226<TD>Places DMA transactions in the queue.</TD> 227 </TR> 228 <TR> 229<TH nowrap><A href="Cache/LCLoadData.html">LCLoadData</A></TH> 230<TD>Places DMA transactions in the queue.</TD> 231 </TR> 232 <TR> 233<TH nowrap><A href="Cache/LCQueueLength.html">LCQueueLength</A></TH> 234<TD>Returns the number of remaining transactions in the DMA queue. </TD> 235 </TR> 236 <TR> 237<TH nowrap><A href="Cache/LCQueueWait.html">LCQueueWait</A></TH> 238<TD>Polls the DMA queue length until it is less than or equal to the specified length.</TD> 239 </TR> 240 <TR> 241<TH nowrap><A href="Cache/LCStoreBlocks.html">LCStoreBlocks</A></TH> 242<TD>Places DMA transactions in the queue.</TD> 243 </TR> 244 <TR> 245<TH nowrap><A href="Cache/LCStoreData.html">LCStoreData</A></TH> 246<TD>Places DMA transactions in the queue.</TD> 247 </TR> 248 </TBODY> 249</TABLE> 250 251<H2><A name="Error">Error</A></H2> 252<TABLE class="api_list" border="1" > 253 <TBODY> 254 <TR> 255<TH nowrap><A href="Error/ASSERT.html">ASSERT</A></TH> 256<TD>Displays messages for debugging.</TD> 257 </TR> 258 <TR> 259<TH nowrap><A href="Error/ASSERTMSG.html">ASSERTMSG</A></TH> 260<TD>Displays messages for debugging (specified as a character string).</TD> 261 </TR> 262 <TR> 263<TH nowrap><A href="Error/OSFatal.html">OSFatal</A></TH> 264<TD>Stops program execution and displays the specified text message on the TV screen.</TD> 265 </TR> 266 <TR> 267<TH nowrap><A href="Error/OSHalt.html">OSHalt</A></TH> 268<TD>Displays the specified character string and stops the OS.</TD> 269 </TR> 270 <TR> 271<TH nowrap><A href="Error/OSProtectRange.html">OSProtectRange</A></TH> 272<TD>Sets main memory access protection for the specified region.</TD> 273 </TR> 274 <TR> 275<TH nowrap><A href="Error/OSReport.html">OSReport</A></TH> 276<TD>A formatted message is displayed in the log window of the debugger.</TD> 277 </TR> 278 <TR> 279<TH nowrap><A href="Error/OSSetErrorHandler.html">OSSetErrorHandler</A></TH> 280<TD>Implements an error handler for the specified error type.</TD> 281 </TR> 282 </TBODY> 283</TABLE> 284 285<H2><A name="Exec">Execution</A></H2> 286<TABLE class="api_list" border="1" > 287 <TBODY> 288 <TR> 289<TH nowrap><A href="Reset/OSExec.html">OSExecl</A></TH> 290<TD>Executes new dol files (argument specified as a list).</TD> 291 </TR> 292 <TR> 293<TH nowrap><A href="Reset/OSExec.html">OSExecv</A></TH> 294<TD>Executes new dol files (argument specified as an array).</TD> 295 </TR> 296 </TBODY> 297</TABLE> 298 299<H2><A name="FastCast">Fast Cast</A></H2> 300<TABLE class="api_list" border="1" > 301 <TBODY> 302 <TR> 303<TH nowrap><A href="FastCast/OSf32tos16.html">OSf32tos16</A></TH> 304<TD>Fast-converts single-precision floating point values to signed 16-bit integers.</TD> 305 </TR> 306 <TR> 307<TH nowrap><A href="FastCast/OSf32tos8.html">OSf32tos8</A></TH> 308<TD>Fast-converts single-precision floating point values to signed 8-bit integers.</TD> 309 </TR> 310 <TR> 311<TH nowrap><A href="FastCast/OSf32tou16.html">OSf32tou16</A></TH> 312<TD>Fast-converts single-precision floating point values to unsigned 16-bit integers.</TD> 313 </TR> 314 <TR> 315<TH nowrap><A href="FastCast/OSf32tou8.html">OSf32tou8</A></TH> 316<TD>Fast-converts single-precision floating point values to unsigned 8-bit integers.</TD> 317 </TR> 318 <TR> 319<TH nowrap><A href="FastCast/OSInitFastCast.html">OSInitFastCast</A></TH> 320<TD>Sets up the floating point number/integer fast-cast feature. </TD> 321 </TR> 322 <TR> 323<TH nowrap><A href="FastCast/OSs16tof32.html">OSs16tof32</A></TH> 324<TD>Fast-converts signed 16-bit integers to 32-bit floating point values.</TD> 325 </TR> 326 <TR> 327<TH nowrap><A href="FastCast/OSs8tof32.html">OSs8tof32</A></TH> 328<TD>Fast-converts signed 8-bit integers to 32-bit floating point values.</TD> 329 </TR> 330 <TR> 331<TH nowrap><A href="FastCast/OSu16tof32.html">OSu16tof32</A></TH> 332<TD>Fast-converts unsigned 16-bit integers to 32-bit floating point values.</TD> 333 </TR> 334 <TR> 335<TH nowrap><A href="FastCast/OSu8tof32.html">OSu8tof32</A></TH> 336<TD>Fast-converts unsigned 8-bit integers to 32-bit floating point values.</TD> 337 </TR> 338 <TR> 339<TH nowrap><A href="FastCast/OSSetGQR.html">OSSetGQR[n]</A></TH> 340<TD>Sets value to a quantization register GQR in the Broadway CPU.</TD> 341 </TR> 342 </TBODY> 343</TABLE> 344 345<H2><A name="Font">Font</A></H2> 346<TABLE class="api_list" border="1" > 347 <TBODY> 348<!-- <TR> <TD><B><A href="Font/intro.html">?????????</A></B></TD> <TD>?? ROM ????????</TD> </TR> --> 349 <TR> 350<TH nowrap><A href="Font/OSGetFontEncode.html">OSGetFontEncode</A></TH> 351<TD>Checks the encoding method of a character font.</TD> 352 </TR> 353 <TR> 354<TH nowrap><A href="Font/OSGetFontTexel.html">OSGetFontTexel</A></TH> 355<TD>Retrieves the font texel image of the first text character from the specified string.</TD> 356 </TR> 357 <TR> 358<TH nowrap><A href="Font/OSGetFontTexture.html">OSGetFontTexture</A></TH> 359<TD>Gets a pointer to the font texture image of the first text character in the specified string.</TD> 360 </TR> 361 <TR> 362<TH nowrap><A href="Font/OSGetFontWidth.html">OSGetFontWidth</A></TH> 363<TD>Gets the texel width of the first text character in the specified string.</TD> 364 </TR> 365 <TR> 366<TH nowrap><A href="Font/OSInitFont.html">OSInitFont</A></TH> 367<TD>Loads and expands ROM font data.</TD> 368 </TR> 369 <TR> 370<TH nowrap><A href="Font/OSLoadFont.html">OSLoadFont</A></TH> 371<TD>Loads a ROM font.</TD> 372 </TR> 373 </TBODY> 374</TABLE> 375 376<H2><A name="Idle">Idle Function</A></H2> 377<TABLE class="api_list" border="1" > 378 <TBODY> 379 <TR> 380<TH nowrap><A href="Thread/OSGetIdleFunction.html">OSGetIdleFunction</A></TH> 381<TD>Gets the current background execution context.</TD> 382 </TR> 383 <TR> 384<TH nowrap><A href="Thread/OSSetIdleFunction.html">OSSetIdleFunction</A></TH> 385<TD>Generates a background execution context.</TD> 386 </TR> 387 </TBODY> 388</TABLE> 389 390<H2><A name="Initialization">Initialization</A></H2> 391<TABLE class="api_list" border="1" > 392 <TBODY> 393 <TR> 394<TH nowrap><A href="Init/OSGetConsoleSimulatedMem1Size.html">OSGetConsoleSimulatedMem1Size</A></TH> 395<TD>Gets the size of internal main memory (MEM1) that simulates a console.</TD> 396 </TR> 397 <TR> 398<TH nowrap><A href="Init/OSGetConsoleSimulatedMem2Size.html">OSGetConsoleSimulatedMem2Size</A></TH> 399<TD>Gets the size of external memory (MEM2) that simulates a console.</TD> 400 </TR> 401 <TR> 402<TH nowrap><A href="Init/OSGetConsoleType.html">OSGetConsoleType</A></TH> 403<TD>Checks the console type.</TD> 404 </TR> 405 <TR> 406<TH nowrap><A href="Init/OSGetAppGamename.html">OSGetAppGamename</A></TH> 407<TD>Gets the game name.</TD> 408 </TR> 409 <TR> 410<TH nowrap><A href="Init/OSGetAppType.html">OSGetAppType</A></TH> 411<TD>Gets the game type.</TD> 412 </TR> 413 <TR> 414<TH nowrap><A href="Init/OSGetPhysicalMem1Size.html">OSGetPhysicalMem1Size</A></TH> 415<TD>This function is retained for compatibility with older versions. Gets the internal main memory size of the Hollywood that is mounted in development machines.</TD> 416 </TR> 417 <TR> 418<TH nowrap><A href="Init/OSGetPhysicalMem2Size.html">OSGetPhysicalMem2Size</A></TH> 419<TD>Gets the size of the external main memory (GDDR3) that is mounted in development machines.</TD> 420 </TR> 421 <TR> 422<TH nowrap><A href="Init/OSInit.html">OSInit</A></TH> 423<TD>Initializes the OS. </TD> 424 </TR> 425 </TBODY> 426</TABLE> 427 428<H2><A name="Interrupt">Interrupts</A></H2> 429<TABLE class="api_list" border="1" > 430 <TBODY> 431 <TR> 432<TH nowrap><A href="Interrupt/OSDisableInterrupts.html">OSDisableInterrupts</A></TH> 433<TD>Disables external interrupts.</TD> 434 </TR> 435 <TR> 436<TH nowrap><A href="Interrupt/OSEnableInterrupts.html">OSEnableInterrupts</A></TH> 437<TD>Enables external interrupts.</TD> 438 </TR> 439 <TR> 440<TH nowrap><A href="Interrupt/OSRestoreInterrupts.html">OSRestoreInterrupts</A></TH> 441<TD>Restores the interrupt state to a previous state.</TD> 442 </TR> 443 </TBODY> 444</TABLE> 445 446<H2><A name="Memory Allocation">Memory Allocation</A> (MEM Library is recommended)</H2> 447<TABLE class="api_list" border="1" > 448 <TBODY> 449 <TR> 450<TH nowrap><A href="Alloc/OSAddToHeap.html">OSAddToHeap</A></TH> 451<TD>Adds an arbitrary block of memory to the heap.</TD> 452 </TR> 453 <TR> 454<TH nowrap><A href="Alloc/OSAlloc.html">OSAlloc</A></TH> 455<TD>Allocates memory from the current heap.</TD> 456 </TR> 457 <TR> 458<TH nowrap><A href="Alloc/OSAllocFixed.html">OSAllocFixed</A></TH> 459<TD>Allocates the explicitly specified region of memory.</TD> 460 </TR> 461 <TR> 462<TH nowrap><A href="Alloc/OSAllocFromHeap.html">OSAllocFromHeap</A></TH> 463<TD>Allocates memory from the specified heap region.</TD> 464 </TR> 465 <TR> 466<TH nowrap><A href="Alloc/OSCheckHeap.html">OSCheckHeap</A></TH> 467<TD>Checks that the heap region is normal for debugging.</TD> 468 </TR> 469 <TR> 470<TH nowrap><A href="Alloc/OSCreateHeap.html">OSCreateHeap</A></TH> 471<TD>Creates a heap.</TD> 472 </TR> 473 <TR> 474<TH nowrap><A href="Alloc/OSDestroyHeap.html">OSDestroyHeap</A></TH> 475<TD>Destroys a heap.</TD> 476 </TR> 477 <TR> 478<TH nowrap><A href="Alloc/OSDumpHeap.html">OSDumpHeap</A></TH> 479<TD>Dumps statistical information and elements for the heap region.</TD> 480 </TR> 481 <TR> 482<TH nowrap><A href="Alloc/OSFree.html">OSFree</A></TH> 483<TD>Frees memory referenced by a pointer to the current heap.</TD> 484 </TR> 485 <TR> 486<TH nowrap><A href="Alloc/OSFreeToHeap.html">OSFreeToHeap</A></TH> 487<TD>Returns freed memory to the specified heap.</TD> 488 </TR> 489 <TR> 490<TH nowrap><A href="Alloc/OSInitAlloc.html">OSInitAlloc</A></TH> 491<TD>Initializes memory allocation services and the arena in which all heaps will reside. </TD> 492 </TR> 493 <TR> 494<TH nowrap><A href="Alloc/OSSetCurrentHeap.html">OSSetCurrentHeap</A></TH> 495<TD>Sets the current heap.</TD> 496 </TR> 497 </TBODY> 498</TABLE> 499 500<H2><A name="Reset">Resetting</A></H2> 501<TABLE class="api_list" border="1" > 502 <TBODY> 503<!-- <TR> <TH nowrap><A href="Reset/intro.html"><B>?????????</B></A></TH> <TD>??????�???????????????</TD> </TR> --> 504 <TR> 505<TH nowrap><A href="Reset/OSIsRestart.html">OSIsRestart</A></TH> 506<TD>Checks whether boot up was from a restart.</TD> 507 </TR> 508 <TR> 509<TH nowrap><A href="Reset/OSGetResetCode.html">OSGetResetCode</A></TH> 510<TD>Returns the reset code.</TD> 511 </TR> 512 <TR> 513<TH nowrap><A href="Reset/OSGetSaveRegion.html">OSGetSaveRegion</A></TH> 514<TD>Gets the region specified by <CODE>OSSetSaveRegion</CODE>.</TD> 515 </TR> 516 <TR> 517<TH nowrap><A href="Reset/OSGetSavedRegion.html">OSGetSavedRegion</A></TH> 518<TD>Gets the region specified by <CODE>OSSetSaveRegion</CODE>.</TD> 519 </TR> 520 <TR> 521<TH nowrap><A href="Reset/OSSetSaveRegion.html">OSSetSaveRegion</A></TH> 522<TD>Sets a region that must not be cleared by <CODE>OSInit</CODE> after restart.</TD> 523 </TR> 524 <TR> 525<TH nowrap><A href="Reset/OSRebootSystem.html">OSRebootSystem</A></TH> 526<TD>Restarts (hot resets) the system.</TD> 527 </TR> 528 <TR> 529<TH nowrap><A href="Reset/OSRestart.html">OSRestart</A></TH> 530<TD>Restarts the application.</TD> 531 </TR> 532 <TR> 533<TH nowrap><A href="Reset/OSReturnToMenu.html">OSReturnToMenu</A></TH> 534<TD>Terminates execution of the applications and restores execution to the system menu.</TD> 535 </TR> 536 <TR> 537<TH nowrap><A href="Reset/OSShutdownSystem.html">OSShutdownSystem</A></TH> 538<TD>Terminates execution of the applications and turns off the system power (shutdown).</TD> 539 </TR> 540 </TBODY> 541</TABLE> 542 543<H2><A name="Reset Button">RESET Button</A></H2> 544<TABLE class="api_list" border="1" > 545 <TBODY> 546 <TR> 547<TH nowrap><A href="Resetbutton/OSGetResetButtonState.html">OSGetResetButtonState</A></TH> 548<TD>Checks the current state of the RESET Button.</TD> 549 </TR> 550 <TR> 551<TH nowrap><A href="Resetbutton/OSSetResetCallback.html">OSSetResetCallback</A></TH> 552<TD>Registers a one-time reset callback.</TD> 553 </TR> 554 <TR> 555<TH nowrap><A href="Resetbutton/OSSetPowerCallback.html">OSSetPowerCallback</A></TH> 556<TD>Registers a one-time power button callback.</TD> 557 </TR> 558 </TBODY> 559</TABLE> 560 561<H2><A name="Relocatable">Relocatable Module System</A> (You can also use the RSO library)</H2> 562<TABLE class="api_list" border="1" > 563 <TBODY> 564<!-- <TR> <TH nowrap><A href="Rel/intro.html"><B>?????????</B></A></TH> <TD>????????????????????</TD> </TR> --> 565 <TR> 566<TH nowrap><A href="Rel/OSLink.html">OSLink</A></TH> 567<TD>Links the specified module.</TD> 568 </TR> 569 <TR> 570<TH nowrap><A href="Rel/OSLink.html">OSLinkFixed</A></TH> 571<TD>Links the specified module and releases some memory that the relocatable module occupies.</TD> 572 </TR> 573 <TR> 574<TH nowrap><A href="Rel/OSUnlink.html">OSUnlink</A></TH> 575<TD>Unlinks the specified module.</TD> 576 </TR> 577 <TR> 578<TH nowrap><A href="Rel/OSSearchModule.html">OSSearchModule</A></TH> 579<TD>Searches for the module which includes the specified address.</TD> 580 </TR> 581 <TR> 582<TH nowrap><A href="Rel/OSSetStringTable.html">OSSetStringTable</A></TH> 583<TD>Specifies the module string table location.</TD> 584 </TR> 585 </TBODY> 586</TABLE> 587 588<H2><A name="Stack">Stack</A></H2> 589<TABLE class="api_list" border="1" > 590 <TBODY> 591 <TR> 592<TH nowrap><A href="Stack/OSClearStack.html">OSClearStack</A></TH> 593<TD>Sets specified value on the stack of the thread being called.</TD> 594 </TR> 595 <TR> 596<TH nowrap><A href="Stack/OSGetStackPointer.html">OSGetStackPointer</A></TH> 597<TD>Gets the current stack pointer address (r1).</TD> 598 </TR> 599 <TR> 600<TH nowrap><A href="Stack/OSSwitchFiber.html">OSSwitchFiber</A></TH> 601<TD>Executes a function that uses the new stack.</TD> 602 </TR> 603 <TR> 604<TH nowrap><A href="Stack/OSSwitchFiberEx.html">OSSwitchFiberEx</A></TH> 605<TD>Executes a function that uses the new stack. The function can pass an argument.</TD> 606 </TR> 607 <TR> 608<TH nowrap><A href="Stack/OSSwitchStack.html">OSSwitchStack</A></TH> 609<TD>Switches the current stack pointer.</TD> 610 </TR> 611 </TBODY> 612</TABLE> 613 614<H2><A name="Stopwatch">Stopwatch</A></H2> 615<TABLE class="api_list" border="1" > 616 <TBODY> 617 <TR> 618<TH nowrap><A href="Stopwatch/OSInitStopwatch.html">OSInitStopwatch</A></TH> 619<TD>Initializes designated stopwatch structure.</TD> 620 </TR> 621 <TR> 622<TH nowrap><A href="Stopwatch/OSStartStopwatch.html">OSStartStopwatch</A></TH> 623<TD>Records the current time (starts the stopwatch).</TD> 624 </TR> 625 <TR> 626<TH nowrap><A href="Stopwatch/OSStopStopwatch.html">OSStopStopwatch</A></TH> 627<TD>Records the current time (stops the stopwatch). Updates the accumulated time since <CODE>OSStartStopwatch</CODE>.</TD> 628 </TR> 629 <TR> 630<TH nowrap><A href="Stopwatch/OSCheckStopwatch.html">OSCheckStopwatch</A></TH> 631<TD>Checks whether the stopwatch function is running.</TD> 632 </TR> 633 <TR> 634<TH nowrap><A href="Stopwatch/OSResetStopwatch.html">OSResetStopwatch</A></TH> 635<TD>Initializes designated stopwatch structure.</TD> 636 </TR> 637 <TR> 638<TH nowrap><A href="Stopwatch/OSDumpStopwatch.html">OSDumpStopwatch</A></TH> 639<TD>Writes to the debug channel some information sets (interval, total time, and so on) measured by the stopwatch.</TD> 640 </TR> 641 </TBODY> 642</TABLE> 643 644<H2><A name="Synchronization">Synchronization</A></H2> 645<TABLE class="api_list" border="1" > 646 <TBODY> 647 <TR> 648<TH nowrap><A href="Synchronization/PPCSync.html">PPCSync</A></TH> 649<TD>Executes a standard PowerPC sync instruction.</TD> 650 </TR> 651 </TBODY> 652</TABLE> 653 654<H2><A name="Time">Time</A></H2> 655<TABLE class="api_list" border="1" > 656 <TBODY> 657 <TR> 658<TH nowrap><A href="Time/OSDiffTick.html">OSDiffTick</A></TH> 659<TD>Returns the difference between two tick values.</TD> 660 </TR> 661 <TR> 662<TH nowrap><A href="Time/OSGetTime.html">OSGetTime</A></TH> 663<TD>Gets the value of the time base register (64-bit width) in units of <CODE>OS_TIMER_CLOCK</CODE> Hz.</TD> 664 </TR> 665 <TR> 666<TH nowrap><A href="Time/OSGetTick.html">OSGetTick</A></TH> 667<TD>Gets a tick (gets the 32 low order bits of Broadway's time base register).</TD> 668 </TR> 669 <TR> 670<TH nowrap><A href="Time/OSTicksToCycles.html">OSTicksToCycles</A></TH> 671<TD>Converts time from ticks to CPU core cycle units (<CODE>OS_CORE_CLOCK</CODE> Hz).</TD> 672 </TR> 673 <TR> 674<TH nowrap><A href="Time/OSTicksToSeconds.html">OSTicksToSeconds</A></TH> 675<TD>Converts value from ticks to seconds.</TD> 676 </TR> 677 <TR> 678<TH nowrap><A href="Time/OSTicksToMilliseconds.html">OSTicksToMilliseconds</A></TH> 679<TD>Converts value from ticks to milliseconds.</TD> 680 </TR> 681 <TR> 682<TH nowrap><A href="Time/OSTicksToMicroseconds.html">OSTicksToMicroseconds</A></TH> 683<TD>Converts value from ticks to microseconds.</TD> 684 </TR> 685 <TR> 686<TH nowrap><A href="Time/OSTicksToNanoseconds.html">OSTicksToNanoseconds</A></TH> 687<TD>Converts value from ticks to nanoseconds.</TD> 688 </TR> 689 <TR> 690<TH nowrap><A href="Time/OSSecondsToTicks.html">OSSecondsToTicks</A></TH> 691<TD>Converts value from seconds to ticks.</TD> 692 </TR> 693 <TR> 694<TH nowrap><A href="Time/OSMillisecondsToTicks.html">OSMillisecondsToTicks</A></TH> 695<TD>Converts value from milliseconds to ticks.</TD> 696 </TR> 697 <TR> 698<TH nowrap><A href="Time/OSMicrosecondsToTicks.html">OSMicrosecondsToTicks</A></TH> 699<TD>Converts value from microseconds to ticks.</TD> 700 </TR> 701 <TR> 702<TH nowrap><A href="Time/OSNanosecondsToTicks.html">OSNanosecondsToTicks</A></TH> 703<TD>Converts value from nanoseconds to ticks.</TD> 704 </TR> 705 <TR> 706<TH nowrap><A href="Time/OSCalendarTimeToTicks.html">OSCalendarTimeToTicks</A></TH> 707<TD>Converts value from calendar time to ticks (<code>OS_TIMER_CLOCK</code> Hz).</TD> 708 </TR> 709 <TR> 710<TH nowrap><A href="Time/OSTicksToCalendarTime.html">OSTicksToCalendarTime</A></TH> 711<TD>( Converts value from ticks (<code>OS_TIMER_CLOCK</code> Hz) to calendar time.</TD> 712 </TR> 713 </TBODY> 714</TABLE> 715 716<H2><A name="Thread">Thread</A></H2> 717<TABLE class="api_list" border="1" > 718 <TBODY> 719<!-- <TR> <TD><B><A href="Thread/intro.html">????</A></B></TD> <TD>Revolution OS ????????????????????</TD> </TR> --> 720 <TR> 721<TH nowrap><A href="Thread/OSCancelThread.html">OSCancelThread</A></TH> 722<TD>Stops the specified thread. </TD> 723 </TR> 724 <TR> 725<TH nowrap><A href="Thread/OSCheckActiveThreads.html">OSCheckActiveThreads</A></TH> 726<TD>Executes as many checks for normalcy as possible by tracing an active thread queue.</TD> 727 </TR> 728 <TR> 729<TH nowrap><A href="Thread/OSCreateThread.html">OSCreateThread</A></TH> 730<TD>Creates a new thread.</TD> 731 </TR> 732 <TR> 733<TH nowrap><A href="Thread/OSDetachThread.html">OSDetachThread</A></TH> 734<TD>Sets the detached attribute for the specified thread. </TD> 735 </TR> 736 <TR> 737<TH nowrap><A href="Thread/OSDisableScheduler.html">OSDisableScheduler</A></TH> 738<TD>Stops thread rescheduling temporarily.</TD> 739 </TR> 740 <TR> 741<TH nowrap><A href="Thread/OSEnableScheduler.html">OSEnableScheduler</A></TH> 742<TD>Restarts thread rescheduling.</TD> 743 </TR> 744 <TR> 745<TH nowrap><A href="Thread/OSExitThread.html">OSExitThread</A></TH> 746<TD>Ends the current (called) thread and switches to the next executable thread.</TD> 747 </TR> 748 <TR> 749<TH nowrap><A href="Thread/OSGetCurrentThread.html">OSGetCurrentThread</A></TH> 750<TD>Gets the pointer to the current thread.</TD> 751 </TR> 752 <TR> 753<TH nowrap><A href="Thread/OSGetThreadPriority.html">OSGetThreadPriority</A></TH> 754<TD>Returns the priority order that will become the scheduling base for the specified thread.</TD> 755 </TR> 756 <TR> 757<TH nowrap><A href="Thread/OSSetThreadSpecific.html">OSGetThreadSpecific</A></TH> 758<TD>Gets data specific to the thread that called this function.</TD> 759 </TR> 760 <TR> 761<TH nowrap><A href="Thread/OSInitThreadQueue.html">OSInitThreadQueue</A></TH> 762<TD>Initializes the thread queue that other thread functions use.</TD> 763 </TR> 764 <TR> 765<TH nowrap><A href="Thread/OSIsThreadSuspended.html">OSIsThreadSuspended</A></TH> 766<TD>Checks whether the specified thread is suspended.</TD> 767 </TR> 768 <TR> 769<TH nowrap><A href="Thread/OSIsThreadTerminated.html">OSIsThreadTerminated</A></TH> 770<TD>Checks whether the specified thread is stopped.</TD> 771 </TR> 772 <TR> 773<TH nowrap><A href="Thread/OSJoinThread.html">OSJoinThread</A></TH> 774<TD>Waits for the specified thread to terminate and reproduces information for that thread.</TD> 775 </TR> 776 <TR> 777<TH nowrap><A href="Thread/OSResumeThread.html">OSResumeThread</A></TH> 778<TD>Resumes the specified thread.</TD> 779 </TR> 780 <TR> 781<TH nowrap><A href="Thread/OSSetThreadPriority.html">OSSetThreadPriority</A></TH> 782<TD>Sets the priority level used as the scheduling base.</TD> 783 </TR> 784 <TR> 785<TH nowrap><A href="Thread/OSSetThreadSpecific.html">OSSetThreadSpecific</A></TH> 786<TD>Gets data specific to the thread that called this function.</TD> 787 </TR> 788 <TR> 789<TH nowrap><A href="Thread/OSSetSwitchThreadCallback.html">OSSetSwitchThreadCallback</A></TH> 790<TD>Registers a specified callback function.</TD> 791 </TR> 792 <TR> 793<TH nowrap><A href="Thread/OSSleepThread.html">OSSleepThread</A></TH> 794<TD>Suspends the current thread and inserts it into the specified thread queue.</TD> 795 </TR> 796 <TR> 797<TH nowrap><A href="Thread/OSSuspendThread.html">OSSuspendThread</A></TH> 798<TD>Suspends the specified thread.</TD> 799 </TR> 800 <TR> 801<TH nowrap><A href="Thread/OSWakeupThread.html">OSWakeupThread</A></TH> 802<TD>Wakes up all the threads in the specified thread queue. </TD> 803 </TR> 804 <TR> 805<TH nowrap><A href="Thread/OSYieldThread.html">OSYieldThread</A></TH> 806<TD>Performs thread rescheduling.</TD> 807 </TR> 808 <TR> 809<TH nowrap><A href="Thread/OSSleepMicroseconds.html">OSSleepMicroseconds</A></TH> 810<TD>Temporarily stops the current thread and sets executable status after the specified number of microseconds have elapsed.</TD> 811 </TR> 812 <TR> 813<TH nowrap><A href="Thread/OSSleepMilliseconds.html">OSSleepMilliseconds</A></TH> 814<TD>Temporarily stops the current thread and sets executable status after the specified number of milliseconds have elapsed.</TD> 815 </TR> 816 <TR> 817<TH nowrap><A href="Thread/OSSleepNanoseconds.html">OSSleepNanoseconds</A></TH> 818<TD>Temporarily stops the current thread and sets executable status after the specified number of nanoseconds have elapsed.</TD> 819 </TR> 820 <TR> 821<TH nowrap><A href="Thread/OSSleepSeconds.html">OSSleepSeconds</A></TH> 822<TD>Temporarily stops the current thread and sets executable status after the specified number of seconds have elapsed.</TD> 823 </TR> 824 <TR> 825<TH nowrap><A href="Thread/OSSleepTicks.html">OSSleepTicks</A></TH> 826<TD>Temporarily stops the current thread and sets executable status after the specified number of ticks have elapsed.</TD> 827 </TR> 828 </TBODY> 829</TABLE> 830 831<H2><A name="ThreadSynchronization">Thread Synchronization</A></H2> 832<H3>Mutexes and Condition Variables</H3> 833<TABLE class="api_list" border="1" > 834 <TBODY> 835 <TR> 836<TH nowrap><A href="Thread_Synchronization/OSInitCond.html">OSInitCond</A></TH> 837<TD>Initializes condition variables. </TD> 838 </TR> 839 <TR> 840<TH nowrap><A href="Thread_Synchronization/OSInitMutex.html">OSInitMutex</A></TH> 841<TD>Initializes mutexes.</TD> 842 </TR> 843 <TR> 844<TH nowrap><A href="Thread_Synchronization/OSLockMutex.html">OSLockMutex</A></TH> 845<TD>Attempts to lock the mutex that <CODE>mutex</CODE> specifies.</TD> 846 </TR> 847 <TR> 848<TH nowrap><A href="Thread_Synchronization/OSSignalCond.html">OSSignalCond</A></TH> 849<TD>Unblocks all the threads waiting on the specified condition variable. </TD> 850 </TR> 851 <TR> 852<TH nowrap><A href="Thread_Synchronization/OSTryLockMutex.html">OSTryLockMutex</A></TH> 853<TD>The calling thread tries to lock the mutex.</TD> 854 </TR> 855 <TR> 856<TH nowrap><A href="Thread_Synchronization/OSUnlockMutex.html">OSUnlockMutex</A></TH> 857<TD>The calling thread unlocks the mutex.</TD> 858 </TR> 859 <TR> 860<TH nowrap><A href="Thread_Synchronization/OSWaitCond.html">OSWaitCond</A></TH> 861<TD>Blocks the calling thread on the condition variable and releases the mutex.</TD> 862 </TR> 863 </TBODY> 864</TABLE> 865 866<H3>Message Queues</H3> 867<TABLE class="api_list" border="1" > 868 <TBODY> 869 <TR> 870<TH nowrap><A href="Thread_Synchronization/OSInitMessageQueue.html">OSInitMessageQueue</A></TH> 871<TD>Initializes the message queue structure.</TD> 872 </TR> 873 <TR> 874<TH nowrap><A href="Thread_Synchronization/OSJamMessage.html">OSJamMessage</A></TH> 875<TD>Inserts a message at the start of the specified message queue.</TD> 876 </TR> 877 <TR> 878<TH nowrap><A href="Thread_Synchronization/OSReceiveMessage.html">OSReceiveMessage</A></TH> 879<TD>Extracts a message from the message queue.</TD> 880 </TR> 881 <TR> 882<TH nowrap><A href="Thread_Synchronization/OSSendMessage.html">OSSendMessage</A></TH> 883<TD>Inserts a message at the end of the specified message queue.</TD> 884 </TR> 885 </TBODY> 886</TABLE> 887 888<H3>Semaphores</H3> 889<TABLE class="api_list" border="1" > 890 <TBODY> 891 <TR> 892<TH nowrap><A href="Thread_Synchronization/OSGetSemaphoreCount.html">OSGetSemaphoreCount</A></TH> 893<TD>Returns the current semaphore count.</TD> 894 </TR> 895 <TR> 896<TH nowrap><A href="Thread_Synchronization/OSInitSemaphore.html">OSInitSemaphore</A></TH> 897<TD>Initializes semaphores.</TD> 898 </TR> 899 <TR> 900<TH nowrap><A href="Thread_Synchronization/OSSignalSemaphore.html">OSSignalSemaphore</A></TH> 901<TD>Increments the specified semaphore count.</TD> 902 </TR> 903 <TR> 904<TH nowrap><A href="Thread_Synchronization/OSTryWaitSemaphore.html">OSTryWaitSemaphore</A></TH> 905<TD>If the semaphore count is greater than zero, the count is decremented.</TD> 906 </TR> 907 <TR> 908<TH nowrap><A href="Thread_Synchronization/OSWaitSemaphore.html">OSWaitSemaphore</A></TH> 909<TD>Decrements the specified semaphore count.</TD> 910 </TR> 911 </TBODY> 912</TABLE> 913<H2><A name="WiiMenu">Transitions to the Wii Menu or NAND Applications</A></H2> 914<TABLE class="api_list" border="1" > 915 <TBODY> 916 <TR> 917<TH nowrap><A href="WiiMenu/OSReturnToMenu.html">OSReturnToMenu</A></TH> 918<TD>Terminates execution of the applications and restores execution to the system menu.</TD> 919 </TR> 920 <TR> 921<TH nowrap><A href="WiiMenu/OSReturnToDataManager.html">OSReturnToDataManager</A></TH> 922<TD>Ends running applications and moves execution to the Data Management screen of System Menu.</TD> 923 </TR> 924 <TR> 925<TH nowrap><A href="WiiMenu/OSReturnToSetting.html">OSReturnToSetting</A></TH> 926<TD>Ends running applications and moves execution to the System Settings screen of System Menu.</TD> 927 </TR> 928 <TR> 929<TH nowrap><A href="Reset/OSLaunchManualViewer.html">OSLaunchManualViewer</A></TH> 930<TD>Ends running applications and moves execution to the Manual viewer.<b><font color="red">This cannot be used by disc applications.</font></b></TD> 931 </TR> 932 </TBODY> 933</TABLE> 934<hr><p>CONFIDENTIAL</p></body> 935</HTML>