N64® OS Functions in Alphabetical Order Nintendo® Confidential			To search the list, choose Find from the Edit menu in your browser.
OS_CYCLES_TO_NSEC Converts from CPU Count register cycles to nanoseconds OS_CYCLES_TO_USEC Converts from CPU Count register cycles to microseconds OS_DCACHE_ROUNDUP_ADDR Rounds up an address to an alignment matching that of the R4300 data cache line size (16 bytes) OS_DCACHE_ROUNDUP_SIZE Rounds up an integer value to match that of the R4300 data cache line size (16 bytes) OS_K0_TO_PHYSICAL Translates from a cached, direct-mapped CPU address to a physical address OS_K1_TO_PHYSICAL Translates from an uncached, direct-mapped CPU address to a physical address OS_NSEC_TO_CYCLES Converts from nanoseconds to CPU Count register cycles OS_PHYSICAL_TO_K0 Translates from a physical address to a cached, direct-mapped CPU address OS_PHYSICAL_TO_K1 Translates from a physical address to an uncached, direct-mapped CPU address OS_USEC_TO_CYCLES Converts from microseconds to CPU Count register cycles osAckRamromRead Is no longer needed osAckRamromWrite Is no longer needed osAiGetLength Returns the number of bytes remaining in the current DMA buffer osAiGetStatus Returns the hardware status of the audio interface osAiSetFrequency Based on a requested frequency (in Hz), it calculates the correct values for the internal divisors and returns the actual frequency generated by these divisors osAiSetNextBuffer Sets up the next DMA transfer from DRAM to the audio interface buffer osAppNMIBuffer Is a global variable that holds a 64-byte buffer that is cleared on a cold reset osCartRomInit Returns the required hardware status information when using the ROM Emulator osContGetQuery Returns Controller's status and type osContGetReadData Returns 3D Stick data and button settings to the pad osContInit Initializes the game Controller osContReset Resets all game Controllers osContSetCh Sets number of Controllers for reading osContStartQuery Sends Query command to the Controller to obtain Controller's status and type osContStartReadData Issues a read data command to obtain game Controller input settings osCreateLog Initializes the OSLog data structure osCreateMesgQueue Initializes a given OSMesgQueue structured message queue to an empty state osCreatePiManager Creates and starts the PI Manager system thread to provide mutual exclusion and synchronization support for the PI devices osCreateRegion Creates any number of memory regions at run-time osCreateScheduler Creates an RCP task scheduler osCreateThread Initializes a specified thread and puts it on an active queue to make it known to the N64 debugger osCreateViManager Invokes the video interface (VI) manager system thread at the beginning of an application osDestroyThread Removes a specified thread from the active queue as well as any other queue the thread may be on osDpGetCounters Get internal performance counters from the display processor osDpGetStatus Returns the hardware status of the display processor command status register osDpSetNextBuffer Updates the display processor pointers causing the display processor to begin reading an RDP display list from the DRAM buffer osDpSetStatus Updates the display processor command status register with status osEepromLongRead Reads multiple blocks of data from EEPROM osEepromLongWrite Writes multiple blocks of data to EEPROM osEepromProbe Requests the status of EEPROM, and returns 1 if EEPROM exists, 0 if it does not osEepromRead Issues a read EEPROM command to obtain 8 bytes of data from the specified address osEepromWrite Issues a write EEPROM command to write 8 bytes of data to the specified address osEPiGetDeviceType Gains access to EPI without using the PI Manager to get the PI information recognized by the PI handler osEPiLinkHandle Sets a pointer to the next member using an EPI handler osEPiRawReadIo Performs 32-bit IO read operation and stores the value osEPiRawStartDma Performs a polling operation to determine whether or not the interface is available before setting the DMA register osEPiRawWriteIo Performs a 32-bit IO write operation to the EPI's device address osEPiReadIo Performs 32-bit IO read operations from the PI device address osEPiStartDma Sets up a DMA transfer condition between RDRAM and the EPI device address space osEPiWriteIo Performs 32-bit IO write operations to the PI device address osFlushLog Transfers the log data to the host osFree De-allocates a buffer by putting the buffer back at the head of the region's free list osGetCause Returns the current value of the MIPS R4300 Cause register that describes the cause of the most recent exception osGetCompare Returns the current value of the R4300 Compare register osGetConfig Returns the current value of the R4300 Configuration register osGetCount Returns the current value of the MIPS R4300 Count register, a free running counter that increments at half the CPU clock speed osGetCurrFaultedThread Returns the most recent faulted thread or NULL if there is no faulted thread osGetFpcCsr Returns the current value of the R4300 floating-point control/status register osGetIntMask Gets the enabled interrupt mask osGetMemSize Confirms that the Memory Pak that comes with the N64 Disk Drive is inserted into the N64. All game Paks must use this function before using the Memory Pak osGetNextFaultedThread Returns the next faulted thread from the active thread queue based on the last thread osGetRegionBufCount Returns the total number of buffers created for the region osGetRegionBuffSize Returns the size (in bytes) allocated for each buffer in the region osGetSR Returns the current value of the R4300 Status register osGetThreadId Obtains the debugger identifier of a thread osGetThreadPri Returns the priority of the given thread osGetTime Returns the value of time in CPU Count register cycles since the last hard reset osGetTLBASID Returns the current TLB Address Space ID in the R4300 EntryHi register osGetTLBHi Reads the appropriate TLB entry and returns the value of the R4300 EntryHi register osGetTLBLo0 Reads the appropriate TLB entry and returns the value of the R4300 EntryLo0 register osGetTLBLo1 Reads the appropriate TLB entry and returns the value of the R4300 EntryLo1 register osGetTLBPageMask Reads the appropriate TLB entry and returns the value of the R4300 PageMask register osGlobals Includes the osTvType, osResetType, osMemSize, and osAppNMIBuffer Operating System global variables osInitialize Performs hardware and software initialization procedures osInitRdb Sets up an outgoing buffer for the rdb debug port osInvalDCache Invalidates CPU data cache lines osInvalICache Invalidates CPU instruction cache lines osJamMesg Copies the message to the front of the given message queue osLogEvent Adds an entry to the given log osMalloc Allocates a buffer by taking the buffer at the head of the region's free list and returns a pointer to that aligned buffer osMapTLB Sets the TLB entry index (ranges from 0 to 31) osMemSize Is a global variable that holds the installed main memory (DRAM) size in bytes osMotorInit Initializes the Rumble Pak osMotorStart Starts the Rumble Pak motor osMotorStop Stops the Rumble Pak motor osPfsAllocateFile Creates a new game note osPfsChecker Inspects and repairs the Controller Pak's file system osPfsDeleteFile Deletes a game note osPfsFileState Obtains game note information osPfsFindFile Searches the specified game note osPfsFreeBlocks Obtains the available number of bytes in a Controller Pak osPfsGetLabel Reads the label of a Controller Pak osPfsInit Initializes the Controller Pak's file handle osPfsInitPak Initializes the Controller Pak's file handle. Call this function when dealing with the Controller Pak for the first time or when the Controller Pak is initially inserted osPfsIsPlug Detects which Controller contains a Controller Pak osPfsNumFiles Acquires the maximum note number and the number of notes used osPfsReadWriteFile Reading and writes game note game data osPfsRepairld Repairs the Controller Pak file system osPfsReSizeFile Changes the capacity reserved for game notes osPfsSetLabel Writes to the Controller Pak label osPhysicalToVirtual Is a function version of OS_PHYSICAL_TO_K0 and thus returns the direct-mapped, cached KSEG0 address corresponding to the specified address osPiGetCmdQueue Returns a pointer to the command queue of the PI Manager or NULL if the PI Manager has not been started osPiGetStatus Returns the hardware status of the peripheral interface (PI) osPiRawReadIo Performs a 32-bit programmed IO read from a specified PI device address, and it returns the value in data. It also polls the interface for idleness before performing the operation osPiRawStartDma Sets up a DMA transfer between a specified RDRAM virtual address and a specified PI device address osPiRawWriteIo Performs a 32-bit programmed IO write to a specified PI device address osPiReadIo Performs a 32-bit programmed IO read from a specified PI device address and returns the value in data osPiStartDma Sets up a DMA transfer between RDRAM and PI device address space by sending a specified IO message block request to the PI manager osPiWriteIo Performs a 32-bit programmed IO write to a specified PI device address osProfile Is the group of functions (osProfileInit, osProfileStart, osProfileStop, osProfileFlush) that manage the execution-time profile for disjoint text spaces osProfileFlush Transfers profile data to the gperf tool (program) assuming gperf is running in server mode osProfileInit Initializes the profiled segment count buffers and starts an IO thread that communicates profile data to the host when requested by the gperf tool osProfileStart Starts the profiler's interval counter osProfileStop Turns off profiling osReadHost Set up the game-side connection to accept data from the host and copy it to DRAM osRecvMesg Copies the first message in the message queue into a specified address osResetType Is a global variable that saves the cause of a system reboot osScAddClient Adds a client to the RCP task scheduler osScGetTaskQ Gets the message queue used for communicating with the scheduler thread osScRemoveClient Removes a client from the RCP task scheduler osSendMesg Copies the message to the end of the given message queue osSetCause Sets the new value for the MIPS R4300 Cause register that describes the cause of the most recent exception osSetCompare Sets the new value for the R4300 Compare register osSetConfig Sets the new value for the R4300 Configuration register osSetErrorHandler Sets debug library error handling routine osSetEventMesg Associates a message queue and message with an event osSetFpcCsr Sets the new value for the R4300 floating-point control/status register osSetIntMask Set the enabled interrupt mask osSetSR Sets the new value for the R4300 Status register osSetThreadPri Sets the priority of specified thread osSetTime Sets the value of time in CPU Count register cycles osSetTimer Starts an interval or countdown timer osSetTLBASID Sets a system-wide address space identifier register that makes valid only mappings of the given address space identifier (as well as global mappings) osSpTaskLoad Loads the given task into the serial processor osSpTaskStart Is a macro that performs an osSpTaskLoad call followed by an osSpTaskStartGo call osSpTaskStartGo Causes the serial processor to begin executing osSpTaskYield Requests that the serial processor yield osSpTaskYielded Returns OS_TASK_YIELDED if the task successfully yielded; otherwise it returns 0 which indicates that the task finished normally before it could yield (and therefore should not be restarted later) osStartThread Starts or resumes a thread osStopThread Suspends a thread osStopTimer Stops an interval or countdown timer osSyncPrintf osSyncPrintf formats the given character string on the target and flushes the string back to the host immediately upon its invocation osTestHost Is no longer supported osTvType Is a global variable that indicates whether the N64 system is configured for PAL video timing (0), NTSC (1), or MPAL (2) osUnmapTLB Removes any existing even or odd page mapping for the TLB entry index osUnmapTLBAll Removes all mappings at all indexes (invalidates the entire TLB) osViBlack Blacks out the screen and still generates vertical retrace signals osViFade Fades between the first 2 scan lines of the frame buffer osViGetCurrentField Returns the field number (either 0 or 1) currently being used by the video interface osViGetCurrentFramebuffer Returns an opaque pointer to the currently displayed framebuffer osViGetCurrentLine Returns the current half line, sampled once per line osViGetCurrentMode Returns the video interface (VI) mode that is currently being used osViGetNextFramebuffer Returns an opaque pointer to the next framebuffer to be displayed osViGetStatus Returns the value of the video interface status/control register osViRepeatLine Repeats the first scan line of the frame buffer for the entire frame osVirtualToPhysical Translate an arbitrary CPU virtual address to its physical address, if such a translation exists osViSetEvent Registers a message queue and a message with the VI Manager osViSetMode Resets all current settings such X-Y scaling and special features (for example, gamma) to the default values defined in the global mode table osViSetSpecialFeatures Allows the caller to enable or disable various video interface special features such as GAMMA, GAMMA_DITHER, DIVOT, and DITHER_FILTER osViSetXScale Allows scaling the image up horizontally (in the X direction) to the required display format from a reduced number of rendered pixels per line osViSetYScale Allows scaling the image up vertically (in the Y direction) to the required display format from a reduced number of rendered lines per frame osViSwapBuffer Registers the frame buffer to be displayed at the next vertical retrace interrupt osWritebackDCache Writes back all data cache lines that contain the region osWritebackDCacheAll Writes back all cached locations to physical memory osWriteHost Attempts to copy data from the game to the host osYieldThread Yields the CPU and invokes the thread dispatcher Warning: all information in this document is confidential and covered by a non-disclosure agreement. You are responsible for keeping this information confidential and protected. Nintendo will vigorously enforce this responsibility. Copyright © 1998 Nintendo of America Inc. All rights reserved. Last updated January 1998