47
edits
Changes
no edit summary
Line 9:
Line 9:
|-
|-
|DCFlushRange
|DCFlushRange
−|<code>void DCFlushRange(const void *addr, size_t length);</code>
+|<code>void DCFlushRange(const void *addr, size_t length)</code>
|Flush the specified data cache blocks to memory
|Flush the specified data cache blocks to memory
|-
|-
|DCInvalidateRange
|DCInvalidateRange
−|<code>void DCInvalidateRange(void *addr, size_t length);</code>
+|<code>void DCInvalidateRange(void *addr, size_t length)</code>
|Invalidate the specified data cache blocks
|Invalidate the specified data cache blocks
|-
|-
|ICInvalidateRange
|ICInvalidateRange
−|<code>void ICInvalidateRange(const void *addr, size_t length);</code>
+|<code>void ICInvalidateRange(const void *addr, size_t length)</code>
|Invalidate the specified instruction cache blocks
|Invalidate the specified instruction cache blocks
|}
|}
Line 28:
Line 28:
|-
|-
|DisassemblePPCOpcode
|DisassemblePPCOpcode
−|<code>void DisassemblePPCOpcode(uint32_t *addr, char *instr_buf, int instr_len, find_symbol_t sym_func, int flags);</code>
+|<code>void DisassemblePPCOpcode(uint32_t *addr, char *instr_buf, int instr_len, find_symbol_t sym_func, int flags)</code>
|Disassemble a PPC opcode at addr and place it into instr_buf (instr_len must be 0x40 or lower)
|Disassemble a PPC opcode at addr and place it into instr_buf (instr_len must be 0x40 or lower)
|-
|-
|DisassemblePPCRange
|DisassemblePPCRange
−|<code>void DisassemblePPCRange(uint32_t *start, uint32_t *end, printf_t printf_func, find_symbol_t sym_func, int flags);</code>
+|<code>void DisassemblePPCRange(uint32_t *start, uint32_t *end, printf_t printf_func, find_symbol_t sym_func, int flags)</code>
|Disassemble PPC instructions from start to end, printing them using printf_func() with various flags applied
|Disassemble PPC instructions from start to end, printing them using printf_func() with various flags applied
|}
|}
Line 43:
Line 43:
|-
|-
|OSDynLoad_Acquire
|OSDynLoad_Acquire
−|<code>void OSDynLoad_Acquire(const char *rplname, uint32_t *handle);</code>
+|<code>void OSDynLoad_Acquire(const char *rplname, uint32_t *handle)</code>
|Acquire a handle to an RPL by name
|Acquire a handle to an RPL by name
|-
|-
|OSDynLoad_FindExport
|OSDynLoad_FindExport
−|<code>void OSDynLoad_FindExport(uint32_t handle, bool isdata, const char *symname, void **address);</code>
+|<code>void OSDynLoad_FindExport(uint32_t handle, bool isdata, const char *symname, void **address)</code>
|Get a symbol address from a loaded RPL
|Get a symbol address from a loaded RPL
|}
|}
Line 58:
Line 58:
|-
|-
|OSFatal
|OSFatal
−|<code>void OSFatal(const char *msg);</code>
+|<code>void OSFatal(const char *msg)</code>
−|Print a message to the screen then halts the system via: OSPanic("OSFatal.c", linenum, OSFatal_inputmsg);
+|Print a message to the screen then halts the system via: OSPanic("OSFatal.c", linenum, OSFatal_inputmsg)
|}
|}
Line 69:
Line 69:
|-
|-
|__os_snprintf
|__os_snprintf
−|<code>int __os_snprintf(char *buf, size_t n, const char *format, ... );</code>
+|<code>int __os_snprintf(char *buf, size_t n, const char *format, ... )</code>
|Format a string and place it in a buffer (just like [http://www.cplusplus.com/reference/cstdio/snprintf/ snprintf()])
|Format a string and place it in a buffer (just like [http://www.cplusplus.com/reference/cstdio/snprintf/ snprintf()])
|}
|}
Line 80:
Line 80:
|-
|-
|OSCreateThread
|OSCreateThread
−|<code>bool OSCreateThread(OSThread *thread, void (*entry)(int,void*), int argc, void *args, void *stack, size_t stack_size, int32_t priority, int16_t affinity);</code>
+|<code>bool OSCreateThread(OSThread *thread, void (*entry)(int,void*), int argc, void *args, void *stack, size_t stack_size, int32_t priority, int16_t affinity)</code>
|Create a (initially-paused) thread that starts at the specified entry point
|Create a (initially-paused) thread that starts at the specified entry point
|-
|-
|OSResumeThread
|OSResumeThread
−|<code>void OSResumeThread(OSThread *thread);</code>
+|<code>void OSResumeThread(OSThread *thread)</code>
|Resume a paused thread, causing it to be scheduled
|Resume a paused thread, causing it to be scheduled
|-
|-
|OSYieldThread
|OSYieldThread
−|<code>void OSYieldThread(void);</code>
+|<code>void OSYieldThread(void)</code>
|Yield control of the CPU, allowing another thread to run
|Yield control of the CPU, allowing another thread to run
|-
|-
|OSGetCurrentThread
|OSGetCurrentThread
−|<code>OSThread *OSGetCurrentThread(void);</code>
+|<code>OSThread *OSGetCurrentThread(void)</code>
|Get the OSThread structure ptr for the current thread.
|Get the OSThread structure ptr for the current thread.
|-
|-
|OSSetThreadAffinity
|OSSetThreadAffinity
−|<code>uint32_t OSSetThreadAffinity(OSThread* thread, int16_t affinity);</code>
+|<code>uint32_t OSSetThreadAffinity(OSThread* thread, int16_t affinity)</code>
|Sets the affinity for the specified thread. Returns 0 for failure, 1 for success.
|Sets the affinity for the specified thread. Returns 0 for failure, 1 for success.
|-
|-
|OSGetCoreId
|OSGetCoreId
−|<code>uint32_t OSGetCoreId(void);</code>
+|<code>uint32_t OSGetCoreId(void)</code>
|Returns the PowerPC coreid this code is running on(value of spr1007).
|Returns the PowerPC coreid this code is running on(value of spr1007).
|-
|-
|OSGetStackPointer
|OSGetStackPointer
−|<code>uint32_t *OSGetStackPointer(void);</code>
+|<code>uint32_t *OSGetStackPointer(void)</code>
|Returns the r1 register(aka "sp").
|Returns the r1 register(aka "sp").
|-
|-
|OSSwitchStack
|OSSwitchStack
−|<code>void OSSwitchStack(uint32_t *stackptr);</code>
+|<code>void OSSwitchStack(uint32_t *stackptr)</code>
|This basically sets the current thread's r1(aka sp) to the input address, and also calls internal coreinit functions with input_param=input_stackptr. Note that this overwrites data near the start of the specified address due to stack push/pop. This will return to the address LR was set to at function entry.
|This basically sets the current thread's r1(aka sp) to the input address, and also calls internal coreinit functions with input_param=input_stackptr. Note that this overwrites data near the start of the specified address due to stack push/pop. This will return to the address LR was set to at function entry.
|}
|}
Line 121:
Line 121:
|-
|-
|OSGetCodegenVirtAddrRange
|OSGetCodegenVirtAddrRange
−|<code>void OSGetCodegenVirtAddrRange(uint32_t *outaddr, uint32_t *outsize);</code>
+|<code>void OSGetCodegenVirtAddrRange(uint32_t *outaddr, uint32_t *outsize)</code>
|This calls syscall 0x4e00 then writes the output r3/r4 from the syscall, to outaddr/outsize. The outaddr value is codegen+0, outsize is the size of the entire codegen memory that's currently mapped. When codegen isn't available, the output values are all-zero.
|This calls syscall 0x4e00 then writes the output r3/r4 from the syscall, to outaddr/outsize. The outaddr value is codegen+0, outsize is the size of the entire codegen memory that's currently mapped. When codegen isn't available, the output values are all-zero.
|-
|-
|OSGetCodegenCore
|OSGetCodegenCore
−|<code>uint32_t OSGetCodegenCore(void);</code>
+|<code>uint32_t OSGetCodegenCore(void)</code>
|This returns (syscall_7600() & 0x3), which is the coreid that's allowed to use codegen.
|This returns (syscall_7600() & 0x3), which is the coreid that's allowed to use codegen.
|-
|-
|OSGetCodegenMode
|OSGetCodegenMode
−|<code>uint32_t OSGetCodegenMode(void);</code>
+|<code>uint32_t OSGetCodegenMode(void)</code>
|This returns (syscall_7600() & ~0x3), which contains some of the flags used by the kernel for codegen permission checking. The only bits which the kernel can ever set here are for bitmask 0xC0000000.
|This returns (syscall_7600() & ~0x3), which contains some of the flags used by the kernel for codegen permission checking. The only bits which the kernel can ever set here are for bitmask 0xC0000000.
|-
|-
|OSSwitchSecCodeGenMode
|OSSwitchSecCodeGenMode
−|<code>uint32_t OSSwitchSecCodeGenMode(bool flag);</code>
+|<code>uint32_t OSSwitchSecCodeGenMode(bool flag)</code>
|This adjusts the entire codegen memory permissions, if codegen is available. 0: RW- permissions. Non-zero: R-X permissions. This returns 0 for failure, non-zero for success.
|This adjusts the entire codegen memory permissions, if codegen is available. 0: RW- permissions. Non-zero: R-X permissions. This returns 0 for failure, non-zero for success.
|-
|-
|OSGetSecCodeGenMode
|OSGetSecCodeGenMode
−|<code>uint32_t OSGetSecCodeGenMode(void);</code>
+|<code>uint32_t OSGetSecCodeGenMode(void)</code>
|This just calls syscall 0x7700. Which then returns 1 when codegen is available+mapped, 0 otherwise.
|This just calls syscall 0x7700. Which then returns 1 when codegen is available+mapped, 0 otherwise.
|-
|-
|OSCodegenCopy
|OSCodegenCopy
−|<code>uint32_t OSCodegenCopy(uint32_t *dstaddr, uint32_t *srcaddr, uint32_t size);</code>
+|<code>uint32_t OSCodegenCopy(uint32_t *dstaddr, uint32_t *srcaddr, uint32_t size)</code>
|In coreinit this just executes syscall 0x7800. This returns 0 for failure, 1 for success. The dstaddr(+size) must be within the codegen memory(integer overflow with dstaddr+size is checked for). If all of the permissions/bounds checks pass(size must not be zero), the kernel will then set the codegen permissions to RW- with code used by SwitchSecCodeGenMode internally. Then it copies the input data from userland memory to the dstaddr with the specified size. Lastly, the codegen permissions are set to R-X with the previously mentioned internal function.
|In coreinit this just executes syscall 0x7800. This returns 0 for failure, 1 for success. The dstaddr(+size) must be within the codegen memory(integer overflow with dstaddr+size is checked for). If all of the permissions/bounds checks pass(size must not be zero), the kernel will then set the codegen permissions to RW- with code used by SwitchSecCodeGenMode internally. Then it copies the input data from userland memory to the dstaddr with the specified size. Lastly, the codegen permissions are set to R-X with the previously mentioned internal function.
|}
|}
Line 164:
Line 164:
|-
|-
|OSScreenShutdown
|OSScreenShutdown
−|void OSScreenShutdown(void);
+|void OSScreenShutdown(void)
|This just does the following two function calls: "OSScreenEnableEx(0, 0)" and "OSScreenEnableEx(1, 0)".
|This just does the following two function calls: "OSScreenEnableEx(0, 0)" and "OSScreenEnableEx(1, 0)".
|-
|-
Line 180:
Line 180:
|-
|-
|OSScreenFlipBuffersEx
|OSScreenFlipBuffersEx
−|void OSScreenFlipBuffersEx(int bufferNum);
+|void OSScreenFlipBuffersEx(int bufferNum)
|Do a buffer-swap, which results in the buffer previously being drawn to being displayed. This flushes data-cache for the framebuffer and updates coreinit + hw-regs state.
|Do a buffer-swap, which results in the buffer previously being drawn to being displayed. This flushes data-cache for the framebuffer and updates coreinit + hw-regs state.
|-
|-
|OSScreenClearBufferEx
|OSScreenClearBufferEx
−|void OSScreenClearBufferEx(int bufferNum, uint32_t colour);
+|void OSScreenClearBufferEx(int bufferNum, uint32_t colour)
|Fill the specified buffer with a certain color. This writes the input u32 value to coreinit screen state, then copies that u32 in state to every u32 in the single framebuffer(calculated with the total bytesize of a single framebuffer).
|Fill the specified buffer with a certain color. This writes the input u32 value to coreinit screen state, then copies that u32 in state to every u32 in the single framebuffer(calculated with the total bytesize of a single framebuffer).
|-
|-
|OSScreenPutPixelEx
|OSScreenPutPixelEx
−|void OSScreenPutPixelEx(int bufferNum, uint32_t posX, uint32_t posY, uint32_t colour);
+|void OSScreenPutPixelEx(int bufferNum, uint32_t posX, uint32_t posY, uint32_t colour)
|Draw a pixel of a certain color to the specified coordinates. This just writes the input u32 to the target location in the framebuffer, nothing is done with the data already stored in the framebuffer.
|Draw a pixel of a certain color to the specified coordinates. This just writes the input u32 to the target location in the framebuffer, nothing is done with the data already stored in the framebuffer.
|-
|-
|OSScreenPutFontEx
|OSScreenPutFontEx
−|void OSScreenPutFontEx(int bufferNum, uint32_t posX, uint32_t posY, const char *str);
+|void OSScreenPutFontEx(int bufferNum, uint32_t posX, uint32_t posY, const char *str)
|Write text to the specified buffer; unlike OSFatal() this doesn't halt your system.
|Write text to the specified buffer; unlike OSFatal() this doesn't halt your system.
|}
|}
Line 274:
Line 274:
/* 0x000 */ OSContext context;
/* 0x000 */ OSContext context;
/* 0x320 */ uint32_t threadTag; /* "tHrD" */
/* 0x320 */ uint32_t threadTag; /* "tHrD" */
− /* 0x324 */ uint8_t state; /* Thread state (0 None, 1 Ready, 2 Running, 4 Waiting, 8 Dead) */
+ /* 0x324 */ uint8_t state; /* Thread state (0 None, 1 Ready, 2 Running, 4 Waiting, 8 Dead) */
/* 0x325 */ uint8_t attr; /* Thread affinity (bits 0-2) and flags */
/* 0x325 */ uint8_t attr; /* Thread affinity (bits 0-2) and flags */
− /* 0x326 */ int16_t threadId;
+ /* 0x326 */ int16_t threadId;
/* 0x328 */ int32_t suspend; /* suspend counter, thread is suspended if greater zero */
/* 0x328 */ int32_t suspend; /* suspend counter, thread is suspended if greater zero */
− /* 0x32C */ int32_t priority; /* effective priority */
+ /* 0x32C */ int32_t priority; /* effective priority */
− /* 0x330 */ int32_t base; /* base priority, set on thread creation or via OSSetThreadPriority */
+ /* 0x330 */ int32_t base; /* base priority, set on thread creation or via OSSetThreadPriority */
− /* 0x334 */ int32_t val; /* thread exit value */
+ /* 0x334 */ int32_t val; /* thread exit value */
− /* 0x338 */ void* runQueue[3];
+ /* 0x338 */ void* runQueue[3];
− /* 0x344 */ OSThreadLink linkRun[3];
+ /* 0x344 */ OSThreadLink linkRun[3];
/* 0x35C */ void* queue;
/* 0x35C */ void* queue;
/* 0x360 */ OSThreadLink link;
/* 0x360 */ OSThreadLink link;
Line 289:
Line 289:
/* 0x37C */ OSMutexQueue queueMutex;
/* 0x37C */ OSMutexQueue queueMutex;
/* 0x38C */ OSThreadLink linkActive;
/* 0x38C */ OSThreadLink linkActive;
− /* 0x394 */ void* stackBase; /* high addr of stack area */
+ /* 0x394 */ void* stackBase; /* high addr of stack area */
/* 0x398 */ void* stackEnd; /* low addr of stack area */
/* 0x398 */ void* stackEnd; /* low addr of stack area */
/* 0x39C */ void* entryPoint; /* initial entry point */
/* 0x39C */ void* entryPoint; /* initial entry point */
− /* 0x3A0 */ __crt crt; /* used by GHS runtime */
+ /* 0x3A0 */ __crt crt; /* used by GHS runtime */
/* 0x578 */ int32_t _unused578;
/* 0x578 */ int32_t _unused578;
/* 0x57C */ void* specific[16]; /* used by OSSetThreadSpecific/OSGetThreadSpecific */
/* 0x57C */ void* specific[16]; /* used by OSSetThreadSpecific/OSGetThreadSpecific */
Line 329:
Line 329:
|-
|-
|FSInit
|FSInit
−|<code>void FSInit(void);</code>
+|<code>void FSInit(void)</code>
|Initializes the FS library
|Initializes the FS library
|Must be called before anything else! Can be called multiple times safely.
|Must be called before anything else! Can be called multiple times safely.
|-
|-
|FSShutdown
|FSShutdown
−|<code>void FSShutdown(void);</code>
+|<code>void FSShutdown(void)</code>
|Deinitializes the FS library
|Deinitializes the FS library
|The current implementation of this function doesn't do anything.
|The current implementation of this function doesn't do anything.
|-
|-
|FSAddClient
|FSAddClient
−|<code>FSStatus FSAddClient(FSClient *client, FSRetflag flag);</code>
+|<code>FSStatus FSAddClient(FSClient *client, FSRetflag flag)</code>
|Registers a new client for use
|Registers a new client for use
|Returns OK or MAX_CLIENTS(-3). Client size is 0x1700 bytes, should be 0x20 byte padded.
|Returns OK or MAX_CLIENTS(-3). Client size is 0x1700 bytes, should be 0x20 byte padded.
|-
|-
|FSDelClient
|FSDelClient
−|<code>FSStatus FSDelClient(FSClient *client, FSRetflag flag);</code>
+|<code>FSStatus FSDelClient(FSClient *client, FSRetflag flag)</code>
|Unregisters an existing client
|Unregisters an existing client
|See above for data size. The current implementation of this function never fails.
|See above for data size. The current implementation of this function never fails.
|-
|-
|FSGetClientNum
|FSGetClientNum
−|<code>int FSGetClientNum(void);</code>
+|<code>int FSGetClientNum(void)</code>
|Gets the number of registered clients
|Gets the number of registered clients
|
|
Line 362:
Line 362:
|-
|-
|FSInitCmdBlock
|FSInitCmdBlock
−|<code>void FSInitCmdBlock(FSCmdBlock *block);</code>
+|<code>void FSInitCmdBlock(FSCmdBlock *block)</code>
|Initializes a command block for use.
|Initializes a command block for use.
|Command Block size is 0xA80 bytes, should be 0x20 byte padded.
|Command Block size is 0xA80 bytes, should be 0x20 byte padded.
|-
|-
|FSCancelCommand
|FSCancelCommand
−|<code>void FSCancelCommand(FSClient *client, FSCmdBlock *block);</code>
+|<code>void FSCancelCommand(FSClient *client, FSCmdBlock *block)</code>
|Cancels the pending command
|Cancels the pending command
|Cannot cancel an ongoing command, it has to complete.
|Cannot cancel an ongoing command, it has to complete.
|-
|-
|FSCancelAllCommands
|FSCancelAllCommands
−|<code>void FSCancelAllCommands(FSClient *client);
+|<code>void FSCancelAllCommands(FSClient *client)
|Cancels all pending commands for the passed client.
|Cancels all pending commands for the passed client.
|Cannot cancel an ongoing command, it has to complete.
|Cannot cancel an ongoing command, it has to complete.
|-
|-
|FSSetUserData
|FSSetUserData
−|<code>void FSSetUserData(FSCmdBlock *block, void *user_data);</code>
+|<code>void FSSetUserData(FSCmdBlock *block, void *user_data)</code>
|Sets the user data for the passed command block
|Sets the user data for the passed command block
|
|
|-
|-
|FSGetUserData
|FSGetUserData
−|<code>void* FSGetUserData(FSCmdBlock *block);</code>
+|<code>void* FSGetUserData(FSCmdBlock *block)</code>
|Returns pointer to the user data
|Returns pointer to the user data
|Can return NULL if invalid, please error check.
|Can return NULL if invalid, please error check.
|-
|-
|FSSetCmdPriority
|FSSetCmdPriority
−|<code>void FSSetCmdPriority(FSCmdBlock *block, uint8_t priority);</code>
+|<code>void FSSetCmdPriority(FSCmdBlock *block, uint8_t priority)</code>
|Sets the priority for the passed command block
|Sets the priority for the passed command block
|Priority 0 is highest, 31 is lowest, 16 is default.
|Priority 0 is highest, 31 is lowest, 16 is default.
|-
|-
|FSGetCmdPriority
|FSGetCmdPriority
−|<code>int FSGetCmdPriority(FSCmdBlock *block);</code>
+|<code>int FSGetCmdPriority(FSCmdBlock *block)</code>
|Gets the priority for the passed command block
|Gets the priority for the passed command block
|Priority 0 is highest, 31 is lowest, 16 is default.
|Priority 0 is highest, 31 is lowest, 16 is default.
|-
|-
|FSGetCurrentCmdBlock
|FSGetCurrentCmdBlock
−|<code>FSCmdBlock* FSGetCurrentCmdBlock(FSClient *client);
+|<code>FSCmdBlock* FSGetCurrentCmdBlock(FSClient *client)
|Returns a pointer to the command block being processed.
|Returns a pointer to the command block being processed.
|May return NULL if invalid client or if nothing's processed, please error check.
|May return NULL if invalid client or if nothing's processed, please error check.