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.&nbsp;</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 transactions remaining in the DMA queue.&nbsp;</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/OSReport.html">OSReport</A></TH>
272<TD>A formatted message is displayed in the log window of the debugger.</TD>
273    </TR>
274    <TR>
275<TH nowrap><A href="Error/OSSetErrorHandler.html">OSSetErrorHandler</A></TH>
276<TD>Implements an error handler for the specified error type.</TD>
277    </TR>
278  </TBODY>
279</TABLE>
280
281<H2><A name="Exec">Execution</A></H2>
282<TABLE class="api_list" border="1" >
283  <TBODY>
284    <TR>
285<TH nowrap><A href="Reset/OSExec.html">OSExecl</A></TH>
286<TD>Executes new dol files (argument specified as a list).</TD>
287    </TR>
288    <TR>
289<TH nowrap><A href="Reset/OSExec.html">OSExecv</A></TH>
290<TD>Executes new dol files (argument specified as an array).</TD>
291    </TR>
292  </TBODY>
293</TABLE>
294
295<H2><A name="FastCast">Fast Cast</A></H2>
296<TABLE class="api_list" border="1" >
297  <TBODY>
298    <TR>
299<TH nowrap><A href="FastCast/OSf32tos16.html">OSf32tos16</A></TH>
300<TD>Fast-converts single-precision floating point values to signed 16-bit integers.</TD>
301    </TR>
302    <TR>
303<TH nowrap><A href="FastCast/OSf32tos8.html">OSf32tos8</A></TH>
304<TD>Fast-converts single-precision floating point values to signed 8-bit integers.</TD>
305    </TR>
306    <TR>
307<TH nowrap><A href="FastCast/OSf32tou16.html">OSf32tou16</A></TH>
308<TD>Fast-converts single-precision floating point values to unsigned 16-bit integers.</TD>
309    </TR>
310    <TR>
311<TH nowrap><A href="FastCast/OSf32tou8.html">OSf32tou8</A></TH>
312<TD>Fast-converts single-precision floating point values to unsigned 8-bit integers.</TD>
313    </TR>
314    <TR>
315<TH nowrap><A href="FastCast/OSInitFastCast.html">OSInitFastCast</A></TH>
316<TD>Sets up the floating point number/integer fast-cast feature.&nbsp;</TD>
317    </TR>
318    <TR>
319<TH nowrap><A href="FastCast/OSs16tof32.html">OSs16tof32</A></TH>
320<TD>Fast-converts signed 16-bit integers to 32-bit floating point values.</TD>
321    </TR>
322    <TR>
323<TH nowrap><A href="FastCast/OSs8tof32.html">OSs8tof32</A></TH>
324<TD>Fast-converts signed 8-bit integers to 32-bit floating point values.</TD>
325    </TR>
326    <TR>
327<TH nowrap><A href="FastCast/OSu16tof32.html">OSu16tof32</A></TH>
328<TD>Fast-converts unsigned 16-bit integers to 32-bit floating point values.</TD>
329    </TR>
330    <TR>
331<TH nowrap><A href="FastCast/OSu8tof32.html">OSu8tof32</A></TH>
332<TD>Fast-converts unsigned 8-bit integers to 32-bit floating point values.</TD>
333    </TR>
334    <TR>
335<TH nowrap><A href="FastCast/OSSetGQR.html">OSSetGQR[n]</A></TH>
336<TD>Sets value to a quantization register GQR in the Broadway CPU.</TD>
337    </TR>
338  </TBODY>
339</TABLE>
340
341<H2><A name="Font">Font</A></H2>
342<TABLE class="api_list" border="1" >
343  <TBODY>
344    <TR>
345<TH nowrap><A href="Font/OSGetFontEncode.html">OSGetFontEncode</A></TH>
346<TD>Checks the encoding method of a character font.</TD>
347    </TR>
348    <TR>
349<TH nowrap><A href="Font/OSGetFontTexel.html">OSGetFontTexel</A></TH>
350<TD>Retrieves the font texel image of the first text character from the specified string.</TD>
351    </TR>
352    <TR>
353<TH nowrap><A href="Font/OSGetFontTexture.html">OSGetFontTexture</A></TH>
354<TD>Gets a pointer to the font texture image of the first text character in the specified string.</TD>
355    </TR>
356    <TR>
357<TH nowrap><A href="Font/OSGetFontWidth.html">OSGetFontWidth</A></TH>
358<TD>Gets the texel width of the first text character in the specified string.</TD>
359    </TR>
360    <TR>
361<TH nowrap><A href="Font/OSInitFont.html">OSInitFont</A></TH>
362<TD>Loads and expands ROM font data.</TD>
363    </TR>
364    <TR>
365<TH nowrap><A href="Font/OSLoadFont.html">OSLoadFont</A></TH>
366<TD>Loads a ROM font.</TD>
367    </TR>
368  </TBODY>
369</TABLE>
370
371<H2><A name="Idle">Idle Function</A></H2>
372<TABLE class="api_list" border="1" >
373  <TBODY>
374    <TR>
375<TH nowrap><A href="Thread/OSGetIdleFunction.html">OSGetIdleFunction</A></TH>
376<TD>Gets the current background execution context.</TD>
377    </TR>
378    <TR>
379<TH nowrap><A href="Thread/OSSetIdleFunction.html">OSSetIdleFunction</A></TH>
380<TD>Generates a background execution context.</TD>
381    </TR>
382  </TBODY>
383</TABLE>
384
385<H2><A name="Initialization">Initialization</A></H2>
386<TABLE class="api_list" border="1" >
387  <TBODY>
388    <TR>
389<TH nowrap><A href="Init/OSGetConsoleSimulatedMem1Size.html">OSGetConsoleSimulatedMem1Size</A></TH>
390<TD>Gets the size of internal main memory (MEM1) that simulates a console.</TD>
391    </TR>
392    <TR>
393<TH nowrap><A href="Init/OSGetConsoleSimulatedMem2Size.html">OSGetConsoleSimulatedMem2Size</A></TH>
394<TD>Gets the size of external memory (MEM2) that simulates a console.</TD>
395    </TR>
396    <TR>
397<TH nowrap><A href="Init/OSGetConsoleType.html">OSGetConsoleType</A></TH>
398<TD>Checks the console type.</TD>
399    </TR>
400    <TR>
401<TH nowrap><A href="Init/OSGetAppGamename.html">OSGetAppGamename</A></TH>
402<TD>Gets the game name.</TD>
403    </TR>
404    <TR>
405<TH nowrap><A href="Init/OSGetAppType.html">OSGetAppType</A></TH>
406<TD>Gets the game type.</TD>
407    </TR>
408    <TR>
409<TH nowrap><A href="Init/OSGetPhysicalMem1Size.html">OSGetPhysicalMem1Size</A></TH>
410<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>
411    </TR>
412    <TR>
413<TH nowrap><A href="Init/OSGetPhysicalMem2Size.html">OSGetPhysicalMem2Size</A></TH>
414<TD>Gets the size of the external main memory (GDDR3) that is mounted in development machines.</TD>
415    </TR>
416    <TR>
417<TH nowrap><A href="Init/OSInit.html">OSInit</A></TH>
418<TD>Initializes the OS.&nbsp;</TD>
419    </TR>
420  </TBODY>
421</TABLE>
422
423<H2><A name="Interrupt">Interrupts</A></H2>
424<TABLE class="api_list" border="1" >
425  <TBODY>
426    <TR>
427<TH nowrap><A href="Interrupt/OSDisableInterrupts.html">OSDisableInterrupts</A></TH>
428<TD>Disables external interrupts.</TD>
429    </TR>
430    <TR>
431<TH nowrap><A href="Interrupt/OSEnableInterrupts.html">OSEnableInterrupts</A></TH>
432<TD>Enables external interrupts.</TD>
433    </TR>
434    <TR>
435<TH nowrap><A href="Interrupt/OSRestoreInterrupts.html">OSRestoreInterrupts</A></TH>
436<TD>Restores the interrupt state to a previous state.</TD>
437    </TR>
438  </TBODY>
439</TABLE>
440
441<H2><A name="Memory Allocation">Memory Allocation</A> (MEM Library is recommended)</H2>
442<TABLE class="api_list" border="1" >
443  <TBODY>
444    <TR>
445<TH nowrap><A href="Alloc/OSAddToHeap.html">OSAddToHeap</A></TH>
446<TD>Adds an arbitrary block of memory to the heap.</TD>
447    </TR>
448    <TR>
449<TH nowrap><A href="Alloc/OSAlloc.html">OSAlloc</A></TH>
450<TD>Allocates memory from the current heap.</TD>
451    </TR>
452    <TR>
453<TH nowrap><A href="Alloc/OSAllocFixed.html">OSAllocFixed</A></TH>
454<TD>Allocates the explicitly specified region of memory.</TD>
455    </TR>
456    <TR>
457<TH nowrap><A href="Alloc/OSAllocFromHeap.html">OSAllocFromHeap</A></TH>
458<TD>Allocates memory from the specified heap region.</TD>
459    </TR>
460    <TR>
461<TH nowrap><A href="Alloc/OSCheckHeap.html">OSCheckHeap</A></TH>
462<TD>Checks that the heap region is normal for debugging.</TD>
463    </TR>
464    <TR>
465<TH nowrap><A href="Alloc/OSCreateHeap.html">OSCreateHeap</A></TH>
466<TD>Creates a heap.</TD>
467    </TR>
468    <TR>
469<TH nowrap><A href="Alloc/OSDestroyHeap.html">OSDestroyHeap</A></TH>
470<TD>Destroys a heap.</TD>
471    </TR>
472    <TR>
473<TH nowrap><A href="Alloc/OSDumpHeap.html">OSDumpHeap</A></TH>
474<TD>Dumps statistical information and elements for the heap region.</TD>
475    </TR>
476    <TR>
477<TH nowrap><A href="Alloc/OSFree.html">OSFree</A></TH>
478<TD>Frees memory referenced by a pointer to the current heap.</TD>
479    </TR>
480    <TR>
481<TH nowrap><A href="Alloc/OSFreeToHeap.html">OSFreeToHeap</A></TH>
482<TD>Returns freed memory to the specified heap.</TD>
483    </TR>
484    <TR>
485<TH nowrap><A href="Alloc/OSInitAlloc.html">OSInitAlloc</A></TH>
486<TD>Initializes memory allocation services and the arena in which all heaps will reside.&nbsp;</TD>
487    </TR>
488    <TR>
489<TH nowrap><A href="Alloc/OSSetCurrentHeap.html">OSSetCurrentHeap</A></TH>
490<TD>Sets the current heap.</TD>
491    </TR>
492  </TBODY>
493</TABLE>
494
495<H2><A name="Memory Protection">Memory Protection</A></H2>
496<TABLE class="api_list" border="1" >
497  <TBODY>
498    <TR>
499<TH nowrap><A href="Mem_Protection/OSProtectRange.html">OSProtectRange</A></TH>
500<TD>Sets main memory access protection for the specified region.</TD>
501    </TR>
502    <TR>
503<TH nowrap><A href="Mem_Protection/OSDisableCodeExecOnMEM1Hi8MB.html">OSDisableCodeExecOnMEM1Hi8MB</A></TH>
504<TD>Disables code execution in the 8MB region of MEM1's second half.</TD>
505    </TR>
506    <TR>
507<TH nowrap><A href="Mem_Protection/OSDisableCodeExecOnMEM1Hi16MB.html">OSDisableCodeExecOnMEM1Hi16MB</A></TH>
508<TD>Disables code execution in the 16MB region of MEM1's second half.</TD>
509    </TR>
510    <TR>
511<TH nowrap><A href="Mem_Protection/OSEnableCodeExecOnMEM2Lo8MB.html">OSEnableCodeExecOnMEM2Lo8MB</A></TH>
512<TD>Enables code execution in the leading 8MB region of MEM2.</TD>
513    </TR>
514    <TR>
515<TH nowrap><A href="Mem_Protection/OSEnableCodeExecOnMEM2Lo16MB.html">OSEnableCodeExecOnMEM2Lo16MB</A></TH>
516<TD>Enables code execution in the leading 16MB region of MEM2.</TD>
517    </TR>
518  </TBODY>
519</TABLE>
520
521<H2><A name="Reset">Reset</A></H2>
522<TABLE class="api_list" border="1" >
523  <TBODY>
524    <TR>
525<TH nowrap><A href="Reset/OSIsRestart.html">OSIsRestart</A></TH>
526<TD>Checks whether boot up was from a restart.</TD>
527    </TR>
528    <TR>
529<TH nowrap><A href="Reset/OSGetResetCode.html">OSGetResetCode</A></TH>
530<TD>Returns the reset code.</TD>
531    </TR>
532    <TR>
533<TH nowrap><A href="Reset/OSGetSaveRegion.html">OSGetSaveRegion</A></TH>
534<TD>Gets the region specified by <CODE>OSSetSaveRegion</CODE>.</TD>
535    </TR>
536    <TR>
537<TH nowrap><A href="Reset/OSGetSavedRegion.html">OSGetSavedRegion</A></TH>
538<TD>Gets the region specified by <CODE>OSSetSaveRegion</CODE>.</TD>
539    </TR>
540    <TR>
541<TH nowrap><A href="Reset/OSSetSaveRegion.html">OSSetSaveRegion</A></TH>
542<TD>Sets a region that must not be cleared by <CODE>OSInit</CODE> after restart.</TD>
543    </TR>
544    <TR>
545<TH nowrap><A href="Reset/OSRebootSystem.html">OSRebootSystem</A></TH>
546<TD>Restarts (hot resets) the system.</TD>
547    </TR>
548    <TR>
549<TH nowrap><A href="Reset/OSRestart.html">OSRestart</A></TH>
550<TD>Restarts the application.</TD>
551    </TR>
552    <TR>
553<TH nowrap><A href="Reset/OSShutdownSystem.html">OSShutdownSystem</A></TH>
554<TD>Terminates execution of the applications and turns off the system power (shutdown).</TD>
555    </TR>
556  </TBODY>
557</TABLE>
558
559<H2><A name="Reset Button">RESET Button</A></H2>
560<TABLE class="api_list" border="1" >
561  <TBODY>
562    <TR>
563<TH nowrap><A href="Resetbutton/OSGetResetButtonState.html">OSGetResetButtonState</A></TH>
564<TD>Checks the current state of the RESET Button.</TD>
565    </TR>
566    <TR>
567<TH nowrap><A href="Resetbutton/OSSetResetCallback.html">OSSetResetCallback</A></TH>
568<TD>Registers a one-time reset callback.</TD>
569    </TR>
570    <TR>
571<TH nowrap><A href="Resetbutton/OSSetPowerCallback.html">OSSetPowerCallback</A></TH>
572<TD>Registers a one-time power button callback.</TD>
573    </TR>
574  </TBODY>
575</TABLE>
576
577<H2><A name="Relocatable">Relocatable Module System</A> (You can also use the RSO library)</H2>
578<TABLE class="api_list" border="1" >
579  <TBODY>
580    <TR>
581<TH nowrap><A href="Rel/OSLink.html">OSLink</A></TH>
582<TD>Links the specified module.</TD>
583    </TR>
584    <TR>
585<TH nowrap><A href="Rel/OSLink.html">OSLinkFixed</A></TH>
586<TD>Links the specified module and releases some memory that the relocatable module occupies.</TD>
587    </TR>
588    <TR>
589<TH nowrap><A href="Rel/OSUnlink.html">OSUnlink</A></TH>
590<TD>Unlinks the specified module.</TD>
591    </TR>
592    <TR>
593<TH nowrap><A href="Rel/OSSearchModule.html">OSSearchModule</A></TH>
594<TD>Searches for the module which includes the specified address.</TD>
595    </TR>
596    <TR>
597<TH nowrap><A href="Rel/OSSetStringTable.html">OSSetStringTable</A></TH>
598<TD>Specifies the module string table location.</TD>
599    </TR>
600  </TBODY>
601</TABLE>
602
603<H2><A name="Stack">Stack</A></H2>
604<TABLE class="api_list" border="1" >
605  <TBODY>
606    <TR>
607<TH nowrap><A href="Stack/OSClearStack.html">OSClearStack</A></TH>
608<TD>Sets specified value on the stack of the thread being called.</TD>
609    </TR>
610    <TR>
611<TH nowrap><A href="Stack/OSGetStackPointer.html">OSGetStackPointer</A></TH>
612<TD>Gets the current stack pointer address (r1).</TD>
613    </TR>
614    <TR>
615<TH nowrap><A href="Stack/OSSwitchFiber.html">OSSwitchFiber</A></TH>
616<TD>Executes a function that uses the new stack.</TD>
617    </TR>
618    <TR>
619<TH nowrap><A href="Stack/OSSwitchFiberEx.html">OSSwitchFiberEx</A></TH>
620<TD>Executes a function that uses the new stack. The function can pass an argument.</TD>
621    </TR>
622    <TR>
623<TH nowrap><A href="Stack/OSSwitchStack.html">OSSwitchStack</A></TH>
624<TD>Switches the current stack pointer.</TD>
625    </TR>
626  </TBODY>
627</TABLE>
628
629<H2><A name="Stopwatch">Stopwatch</A></H2>
630<TABLE class="api_list" border="1" >
631  <TBODY>
632    <TR>
633<TH nowrap><A href="Stopwatch/OSInitStopwatch.html">OSInitStopwatch</A></TH>
634<TD>Initializes designated stopwatch structure.</TD>
635    </TR>
636    <TR>
637<TH nowrap><A href="Stopwatch/OSStartStopwatch.html">OSStartStopwatch</A></TH>
638<TD>Records the current time (starts the stopwatch).</TD>
639    </TR>
640    <TR>
641<TH nowrap><A href="Stopwatch/OSStopStopwatch.html">OSStopStopwatch</A></TH>
642<TD>Records the current time (stops the stopwatch). Updates the cumulative time from <CODE>OSStartStopwatch</CODE>.</TD>
643    </TR>
644    <TR>
645<TH nowrap><A href="Stopwatch/OSCheckStopwatch.html">OSCheckStopwatch</A></TH>
646<TD>Checks whether the stopwatch function is running.</TD>
647    </TR>
648    <TR>
649<TH nowrap><A href="Stopwatch/OSResetStopwatch.html">OSResetStopwatch</A></TH>
650<TD>Initializes designated stopwatch structure.</TD>
651    </TR>
652    <TR>
653<TH nowrap><A href="Stopwatch/OSDumpStopwatch.html">OSDumpStopwatch</A></TH>
654<TD>Writes to the debug channel some information sets (interval, total time, and so on) measured by the stopwatch.</TD>
655    </TR>
656  </TBODY>
657</TABLE>
658
659<H2><A name="Synchronization">Synchronization</A></H2>
660<TABLE class="api_list" border="1" >
661  <TBODY>
662    <TR>
663<TH nowrap><A href="Synchronization/PPCSync.html">PPCSync</A></TH>
664<TD>Executes a standard PowerPC sync instruction.</TD>
665    </TR>
666  </TBODY>
667</TABLE>
668
669<H2><A name="Time">Time</A></H2>
670<TABLE class="api_list" border="1" >
671  <TBODY>
672    <TR>
673<TH nowrap><A href="Time/OSDiffTick.html">OSDiffTick</A></TH>
674<TD>Returns the difference between two tick values.</TD>
675    </TR>
676    <TR>
677<TH nowrap><A href="Time/OSGetTime.html">OSGetTime</A></TH>
678<TD>Gets the value of the time base register (64-bit width) in units of <CODE>OS_TIMER_CLOCK</CODE> Hz.</TD>
679    </TR>
680    <TR>
681<TH nowrap><A href="Time/OSGetTick.html">OSGetTick</A></TH>
682<TD>Gets a tick (gets the 32 low order bits of Broadway's time base register).</TD>
683    </TR>
684    <TR>
685<TH nowrap><A href="Time/OSTicksToCycles.html">OSTicksToCycles</A></TH>
686<TD>Converts time from ticks to CPU core cycle units (<CODE>OS_CORE_CLOCK</CODE> Hz).</TD>
687    </TR>
688    <TR>
689<TH nowrap><A href="Time/OSTicksToSeconds.html">OSTicksToSeconds</A></TH>
690<TD>Converts value from ticks to seconds.</TD>
691    </TR>
692    <TR>
693<TH nowrap><A href="Time/OSTicksToMilliseconds.html">OSTicksToMilliseconds</A></TH>
694<TD>Converts value from ticks to milliseconds.</TD>
695    </TR>
696    <TR>
697<TH nowrap><A href="Time/OSTicksToMicroseconds.html">OSTicksToMicroseconds</A></TH>
698<TD>Converts value from ticks to microseconds.</TD>
699    </TR>
700    <TR>
701<TH nowrap><A href="Time/OSTicksToNanoseconds.html">OSTicksToNanoseconds</A></TH>
702<TD>Converts value from ticks to nanoseconds.</TD>
703    </TR>
704    <TR>
705<TH nowrap><A href="Time/OSSecondsToTicks.html">OSSecondsToTicks</A></TH>
706<TD>Converts value from seconds to ticks.</TD>
707    </TR>
708    <TR>
709<TH nowrap><A href="Time/OSMillisecondsToTicks.html">OSMillisecondsToTicks</A></TH>
710<TD>Converts value from milliseconds to ticks.</TD>
711    </TR>
712    <TR>
713<TH nowrap><A href="Time/OSMicrosecondsToTicks.html">OSMicrosecondsToTicks</A></TH>
714<TD>Converts value from microseconds to ticks.</TD>
715    </TR>
716    <TR>
717<TH nowrap><A href="Time/OSNanosecondsToTicks.html">OSNanosecondsToTicks</A></TH>
718<TD>Converts value from nanoseconds to ticks.</TD>
719    </TR>
720    <TR>
721<TH nowrap><A href="Time/OSCalendarTimeToTicks.html">OSCalendarTimeToTicks</A></TH>
722<TD>Converts value from calendar time to ticks (<code>OS_TIMER_CLOCK</code> Hz).</TD>
723    </TR>
724    <TR>
725<TH nowrap><A href="Time/OSTicksToCalendarTime.html">OSTicksToCalendarTime</A></TH>
726<TD>( Converts value from ticks (<code>OS_TIMER_CLOCK</code> Hz) to calendar time.</TD>
727    </TR>
728  </TBODY>
729</TABLE>
730
731<H2><A name="Thread">Thread</A></H2>
732<TABLE class="api_list" border="1" >
733  <TBODY>
734    <TR>
735<TH nowrap><A href="Thread/OSCancelThread.html">OSCancelThread</A></TH>
736<TD>Stops the specified thread.&nbsp;</TD>
737    </TR>
738    <TR>
739<TH nowrap><A href="Thread/OSCheckActiveThreads.html">OSCheckActiveThreads</A></TH>
740<TD>Executes as many checks for normalcy as possible by tracing an active thread queue.</TD>
741    </TR>
742    <TR>
743<TH nowrap><A href="Thread/OSCreateThread.html">OSCreateThread</A></TH>
744<TD>Creates a new thread.</TD>
745    </TR>
746    <TR>
747<TH nowrap><A href="Thread/OSDetachThread.html">OSDetachThread</A></TH>
748<TD>Sets the detached attribute for the specified thread.&nbsp;</TD>
749    </TR>
750    <TR>
751<TH nowrap><A href="Thread/OSDisableScheduler.html">OSDisableScheduler</A></TH>
752<TD>Stops thread rescheduling temporarily.</TD>
753    </TR>
754    <TR>
755<TH nowrap><A href="Thread/OSEnableScheduler.html">OSEnableScheduler</A></TH>
756<TD>Restarts thread rescheduling.</TD>
757    </TR>
758    <TR>
759<TH nowrap><A href="Thread/OSExitThread.html">OSExitThread</A></TH>
760<TD>Ends the current (called) thread and switches to the next executable thread.</TD>
761    </TR>
762    <TR>
763<TH nowrap><A href="Thread/OSGetCurrentThread.html">OSGetCurrentThread</A></TH>
764<TD>Gets the pointer to the current thread.</TD>
765    </TR>
766    <TR>
767<TH nowrap><A href="Thread/OSGetThreadPriority.html">OSGetThreadPriority</A></TH>
768<TD>Returns the priority order that will become the scheduling base for the specified thread.</TD>
769    </TR>
770    <TR>
771<TH nowrap><A href="Thread/OSSetThreadSpecific.html">OSGetThreadSpecific</A></TH>
772<TD>Gets data specific to the thread that called this function.</TD>
773    </TR>
774    <TR>
775<TH nowrap><A href="Thread/OSInitThreadQueue.html">OSInitThreadQueue</A></TH>
776<TD>Initializes the thread queue that other thread functions use.</TD>
777    </TR>
778    <TR>
779<TH nowrap><A href="Thread/OSIsThreadSuspended.html">OSIsThreadSuspended</A></TH>
780<TD>Checks whether the specified thread is suspended.</TD>
781    </TR>
782    <TR>
783<TH nowrap><A href="Thread/OSIsThreadTerminated.html">OSIsThreadTerminated</A></TH>
784<TD>Checks whether the specified thread is stopped.</TD>
785    </TR>
786    <TR>
787<TH nowrap><A href="Thread/OSJoinThread.html">OSJoinThread</A></TH>
788<TD>Waits for the specified thread to terminate and reproduces information for that thread.</TD>
789    </TR>
790    <TR>
791<TH nowrap><A href="Thread/OSResumeThread.html">OSResumeThread</A></TH>
792<TD>Resumes the specified thread.</TD>
793    </TR>
794    <TR>
795<TH nowrap><A href="Thread/OSSetThreadPriority.html">OSSetThreadPriority</A></TH>
796<TD>Sets the priority level used as the scheduling base.</TD>
797    </TR>
798    <TR>
799<TH nowrap><A href="Thread/OSSetThreadSpecific.html">OSSetThreadSpecific</A></TH>
800<TD>Gets data specific to the thread that called this function.</TD>
801    </TR>
802    <TR>
803<TH nowrap><A href="Thread/OSSetSwitchThreadCallback.html">OSSetSwitchThreadCallback</A></TH>
804<TD>Registers a specified callback function.</TD>
805    </TR>
806    <TR>
807<TH nowrap><A href="Thread/OSSleepThread.html">OSSleepThread</A></TH>
808<TD>Suspends the current thread and inserts it into the specified thread queue.</TD>
809    </TR>
810    <TR>
811<TH nowrap><A href="Thread/OSSuspendThread.html">OSSuspendThread</A></TH>
812<TD>Suspends the specified thread.</TD>
813    </TR>
814    <TR>
815<TH nowrap><A href="Thread/OSWakeupThread.html">OSWakeupThread</A></TH>
816<TD>Wakes up all the threads in the specified thread queue.&nbsp;</TD>
817    </TR>
818    <TR>
819<TH nowrap><A href="Thread/OSYieldThread.html">OSYieldThread</A></TH>
820<TD>Performs thread rescheduling.</TD>
821    </TR>
822    <TR>
823<TH nowrap><A href="Thread/OSSleepMicroseconds.html">OSSleepMicroseconds</A></TH>
824<TD>Temporarily stops the current thread and sets executable status after the specified number of microseconds have elapsed.</TD>
825    </TR>
826    <TR>
827<TH nowrap><A href="Thread/OSSleepMilliseconds.html">OSSleepMilliseconds</A></TH>
828<TD>Temporarily stops the current thread and sets executable status after the specified number of milliseconds have elapsed.</TD>
829    </TR>
830    <TR>
831<TH nowrap><A href="Thread/OSSleepNanoseconds.html">OSSleepNanoseconds</A></TH>
832<TD>Temporarily stops the current thread and sets executable status after the specified number of nanoseconds have elapsed.</TD>
833    </TR>
834    <TR>
835<TH nowrap><A href="Thread/OSSleepSeconds.html">OSSleepSeconds</A></TH>
836<TD>Temporarily stops the current thread and sets executable status after the specified number of seconds have elapsed.</TD>
837    </TR>
838    <TR>
839<TH nowrap><A href="Thread/OSSleepTicks.html">OSSleepTicks</A></TH>
840<TD>Temporarily stops the current thread and sets executable status after the specified number of ticks have elapsed.</TD>
841    </TR>
842  </TBODY>
843</TABLE>
844
845<H2><A name="ThreadSynchronization">Thread Synchronization</A></H2>
846<H3>Mutexes and Condition Variables</H3>
847<TABLE class="api_list" border="1" >
848  <TBODY>
849    <TR>
850<TH nowrap><A href="Thread_Synchronization/OSInitCond.html">OSInitCond</A></TH>
851<TD>Initializes condition variables.&nbsp;</TD>
852    </TR>
853    <TR>
854<TH nowrap><A href="Thread_Synchronization/OSInitMutex.html">OSInitMutex</A></TH>
855<TD>Initializes mutexes.</TD>
856    </TR>
857    <TR>
858<TH nowrap><A href="Thread_Synchronization/OSLockMutex.html">OSLockMutex</A></TH>
859<TD>Attempts to lock the mutex that <CODE>mutex</CODE> specifies.</TD>
860    </TR>
861    <TR>
862<TH nowrap><A href="Thread_Synchronization/OSSignalCond.html">OSSignalCond</A></TH>
863<TD>Unblocks all the threads waiting on the specified condition variable.&nbsp;</TD>
864    </TR>
865    <TR>
866<TH nowrap><A href="Thread_Synchronization/OSTryLockMutex.html">OSTryLockMutex</A></TH>
867<TD>The calling thread tries to lock the mutex.</TD>
868    </TR>
869    <TR>
870<TH nowrap><A href="Thread_Synchronization/OSUnlockMutex.html">OSUnlockMutex</A></TH>
871<TD>The calling thread unlocks the mutex.</TD>
872    </TR>
873    <TR>
874<TH nowrap><A href="Thread_Synchronization/OSWaitCond.html">OSWaitCond</A></TH>
875<TD>Blocks the calling thread on the condition variable and releases the mutex.</TD>
876    </TR>
877  </TBODY>
878</TABLE>
879
880<H3>Message Queues</H3>
881<TABLE class="api_list" border="1" >
882  <TBODY>
883    <TR>
884<TH nowrap><A href="Thread_Synchronization/OSInitMessageQueue.html">OSInitMessageQueue</A></TH>
885<TD>Initializes the message queue structure.</TD>
886    </TR>
887    <TR>
888<TH nowrap><A href="Thread_Synchronization/OSJamMessage.html">OSJamMessage</A></TH>
889<TD>Inserts a message at the start of the specified message queue.</TD>
890    </TR>
891    <TR>
892<TH nowrap><A href="Thread_Synchronization/OSReceiveMessage.html">OSReceiveMessage</A></TH>
893<TD>Extracts a message from the message queue.</TD>
894    </TR>
895    <TR>
896<TH nowrap><A href="Thread_Synchronization/OSSendMessage.html">OSSendMessage</A></TH>
897<TD>Inserts a message at the end of the specified message queue.</TD>
898    </TR>
899  </TBODY>
900</TABLE>
901
902<H3>Semaphores</H3>
903<TABLE class="api_list" border="1" >
904  <TBODY>
905    <TR>
906<TH nowrap><A href="Thread_Synchronization/OSGetSemaphoreCount.html">OSGetSemaphoreCount</A></TH>
907<TD>Returns the current semaphore count.</TD>
908    </TR>
909    <TR>
910<TH nowrap><A href="Thread_Synchronization/OSInitSemaphore.html">OSInitSemaphore</A></TH>
911<TD>Initializes semaphores.</TD>
912    </TR>
913    <TR>
914<TH nowrap><A href="Thread_Synchronization/OSSignalSemaphore.html">OSSignalSemaphore</A></TH>
915<TD>Increments the specified semaphore count.</TD>
916    </TR>
917    <TR>
918<TH nowrap><A href="Thread_Synchronization/OSTryWaitSemaphore.html">OSTryWaitSemaphore</A></TH>
919<TD>If the semaphore count is greater than zero, the count is decremented.</TD>
920    </TR>
921    <TR>
922<TH nowrap><A href="Thread_Synchronization/OSWaitSemaphore.html">OSWaitSemaphore</A></TH>
923<TD>Decrements the specified semaphore count.</TD>
924    </TR>
925  </TBODY>
926</TABLE>
927
928<H2><A name="Hash">Hash</A></H3>
929<TABLE class="api_list" border="1" >
930  <TBODY>
931    <TR>
932<TH nowrap><A href="Hash/OSCalcCRC.html"><CODE>OSCalcCRC16</CODE></A></TH>
933<TD>Returns a 16-bit CRC value.</TD>
934    </TR>
935    <TR>
936<TH nowrap><A href="Hash/OSCalcCRC.html"><CODE>OSCalcCRC32</CODE></A></TH>
937<TD>Returns a 32-bit CRC value.</TD>
938    </TR>
939
940  </TBODY>
941</TABLE>
942
943<H2><A name="WiiMenu">Transitions to the Wii Menu or NAND Applications</A></H2>
944<TABLE class="api_list" border="1" >
945  <TBODY>
946    <TR>
947<TH nowrap><A href="WiiMenu/OSReturnToMenu.html">OSReturnToMenu</A></TH>
948<TD>Terminates execution of the applications and restores execution to the system menu.</TD>
949    </TR>
950    <TR>
951<TH nowrap><A href="WiiMenu/OSReturnToDataManager.html">OSReturnToDataManager</A></TH>
952<TD>Ends running applications and moves execution to the Data Management screen of System Menu.</TD>
953    </TR>
954    <TR>
955<TH nowrap><A href="WiiMenu/OSReturnToSetting.html">OSReturnToSetting</A></TH>
956<TD>Ends running applications and moves execution to the System Settings screen of System Menu.</TD>
957    </TR>
958    <TR>
959<TH nowrap><A href="Reset/OSLaunchManualViewer.html">OSLaunchManualViewer</A></TH>
960<TD>Ends running applications and transfers execution to the Manual viewer.<b><font color="red"> It cannot be used with disc applications.</font></b></TD>
961    </TR>
962  </TBODY>
963</TABLE>
964
965<br><br><br>
966
967<hr><p>CONFIDENTIAL</p></body>
968</HTML>