coreinit.rpl is the the system library that provides direct access to Cafe OS services. It provides kernel calls, thread scheduling, memory management, and filesystem services. coreinit is the first RPL loaded by the loader, even before the main executable itself.
Functions
Cache
| Name | Prototype | Description |
|---|---|---|
| DCFlushRange | void DCFlushRange(const void *addr, size_t length);
|
Flush the specified data cache blocks to memory |
| DCInvalidateRange | void DCInvalidateRange(void *addr, size_t length);
|
Invalidate the specified data cache blocks |
| ICInvalidateRange | void ICInvalidateRange(const void *addr, size_t length);
|
Invalidate the specified instruction cache blocks |
Disassembler
| Name | Prototype | Description |
|---|---|---|
| DisassemblePPCOpcode | void DisassemblePPCOpcode(uint32_t *addr, char *instr_buf, int instr_len, find_symbol_t sym_func, int flags);
|
Disassemble a PPC opcode at addr and place it into instr_buf (instr_len must be 0x40 or lower) |
| DisassemblePPCRange | void DisassemblePPCRange(uint32_t *start, uint32_t *end, printf_t printf_func, find_symbol_t sym_func, int flags);
|
Disassemble PPC instructions from start to end, printing them using printf_func() with various flags applied |
Dynamic Linking
| Name | Prototype | Description |
|---|---|---|
| OSDynLoad_Acquire | void OSDynLoad_Acquire(const char *rplname, uint32_t *handle);
|
Acquire a handle to an RPL by name |
| OSDynLoad_FindExport | void OSDynLoad_FindExport(uint32_t handle, bool isdata, const char *symname, void **address);
|
Get a symbol address from a loaded RPL |
Error
| Name | Prototype | Description |
|---|---|---|
| OSFatal | void OSFatal(const char *msg);
|
Print a message to the screen and halts the system |
Filesystem
| Name | Prototype | Description | Notes |
|---|---|---|---|
| FSInit | void FSInit(void);
|
Initializes the FS library. | Must be called before anything else! Can be called multiple times safely. |
| FSAddClient | int FSAddClient(void *client, int ret_flag);
|
Registers a new client for use. | Returns 0 if successful. Client size is 0x1700 bytes, should be 0x20 byte padded. |
| FSInitCmdBlock | void FSInitCmdBlock(void *block);
|
Initializes a command block for use. | Command Block size is 0xA80 bytes, should be 0x20 byte padded. |
Internal
| Name | Prototype | Description |
|---|---|---|
| __os_snprintf | int __os_snprintf(char *buf, size_t n, const char *format, ... );
|
Format a string and place it in a buffer (just like snprintf()) |
Threads
| Name | Prototype | Description |
|---|---|---|
| OSCreateThread | bool OSCreateThread(OSThread *thread, void (*entry)(int,void*), int argc, void *args, void *stack, size_t stack_size, int32_t priority, int16_t affinity);
|
Create a (initially-paused) thread that starts at the specified entry point |
| OSResumeThread | void OSResumeThread(OSThread *thread);
|
Resume a paused thread, causing it to be scheduled |
| OSYieldThread | void OSYieldThread(void);
|
Yield control of the CPU, allowing another thread to run |
| OSGetCurrentThread | OSThread *OSGetCurrentThread(void);
|
Get the OSThread structure ptr for the current thread. |
| OSSetThreadAffinity | uint32_t OSSetThreadAffinity(OSThread* thread, int16_t affinity);
|
Sets the affinity for the specified thread. Returns 0 for failure, 1 for success. |
| OSGetCoreId | uint32_t OSGetCoreId(void);
|
Returns the PowerPC coreid this code is running on(value of spr1007). |
Screen
In all the functions below, bufferNum means: 0 = TV, 1 = Gamepad. "colour" in the form stored in memory is RGBA8. These functions can't be used without crashing, unless OSScreen was properly initialized. The below functions will immediately return if x/y is out-of-bounds.
| Name | Prototype | Description |
|---|---|---|
| OSScreenGetBufferSizeEx | uint32_t OSScreenGetBufferSizeEx(int bufferNum) | Get the size of the specified buffer |
| OSScreenFlipBuffersEx | uint32_t OSScreenFlipBuffersEx(int bufferNum); | Do a buffer-swap, which results in the buffer previously being drawn to being displayed. This flushes data-cache for the buffers and updates coreinit + hw-regs state. |
| OSScreenClearBufferEx | uint32_t OSScreenClearBufferEx(int bufferNum, uint32_t colour); | Fill the specified buffer with a certain color |
| OSScreenPutPixelEx | uint32_t OSScreenPutPixelEx(int bufferNum, uint32_t posX, uint32_t posY, uint32_t colour); | Draw a pixel of a certain color to the specified coordinates |
| OSScreenPutFontEx | uint32_t 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. |
Structures
Threads
| Name | Prototype |
|---|---|
| OSThread |
typedef struct {
char tag[8]; /* 0x000 "OSContxt" */
int32_t gpr[32]; /* 0x008 from OSDumpContext */
uint32_t cr; /* 0x088 from OSDumpContext */
uint32_t lr; /* 0x08c from OSDumpContext */
uint32_t ctr; /* 0x090 from context switch code */
uint32_t xer; /* 0x094 from context switch code */
uint32_t srr0; /* 0x098 from OSDumpContext */
uint32_t srr1; /* 0x09c from OSDumpContext */
char _unknowna0[0xb8 - 0xa0];
uint64_t fpr[32]; /* 0x0b8 from OSDumpContext */
int16_t spinLockCount; /* 0x1b8 from OSDumpContext */
char _unknown1ba[0x1bc - 0x1ba]; /* 0x1ba could genuinely be padding? */
uint32_t gqr[8]; /* 0x1bc from OSDumpContext */
char _unknown1dc[0x1e0 - 0x1dc];
uint64_t psf[32]; /* 0x1e0 from OSDumpContext */
int64_t coretime[3]; /* 0x2e0 from OSDumpContext */
int64_t starttime; /* 0x2f8 from OSDumpContext */
int32_t error; /* 0x300 from OSDumpContext */
char _unknown304[0x6a0 - 0x304];
} OSThread; /* 0x6a0 total length from RAM dumps */ |
Defines
Disassembler
printf_func() and find_symbol() have the following types:
typedef int (*printf_t)(char *fmt, ...);
typedef uint32_t (*find_symbol_t)(uint32_t addr, char *name_buf, int name_len);The flags argument of DisassemblePPCRange() and DisassemblePPCOpcode() is a bitmask of the following options:
#define DISASM_OMIT_ADDR 0x40 /* Don't print the address of the instruction */
#define DISASM_OMIT_OPCODE 0x80 /* Don't print the opcode of the instruction */
#define DISASM_GETSYM 0x100 /* Print the nearest symbol and the instruction's offset from it */Screen
| Name | Value | Description |
|---|---|---|
| SCREEN_BUF_TV | 0 | The buffer number for the TV |
| SCREEN_BUF_DRC0 | 1 | The buffer number for the first Gamepad |