WiiUBrew

Changes

Coreinit.rpl (view source)

Revision as of 20:53, 17 May 2023

4,425 bytes added ,  20:53, 17 May 2023
Cleanup and add ConsoleType
Line 1: Line 1:  
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.
 
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==
+
= Functions =
−
===Auto Power-Down===
+
== Auto Power-Down ==
 
The Auto Power-Down feature in the WiiU saves the battery of the console, shutting down in one hour when there is no user activity.
 
The Auto Power-Down feature in the WiiU saves the battery of the console, shutting down in one hour when there is no user activity.
 
{| class="wikitable"
 
{| class="wikitable"
Line 34: Line 34:  
|Returns the amount of seconds that are left until the WiiU powers down, if the Auto Power-Down setting is True. apd_secs is a pointer to the variable that stores the amount of seconds.
 
|Returns the amount of seconds that are left until the WiiU powers down, if the Auto Power-Down setting is True. apd_secs is a pointer to the variable that stores the amount of seconds.
 
|}
 
|}
−
===Memory===
+
 
 +
== Driver ==
 +
{| class="wikitable"
 +
!Name
 +
!Prototype
 +
!Description
 +
|-
 +
|OSDriver_Register
 +
|<code>uint32_t OSDriver_Register(char *drv_name, size_t name_len, void *buf1, void *buf2)</code>
 +
|Will register an OSDriver entity with the given name and bufs
 +
|-
 +
|OSDriver_Deregister
 +
|<code>uint32_t OSDriver_Deregister(char *drv_name, size_t name_len)</code>
 +
|Will try to find a OSDriver with the given name (and length because implementing a strlen was too hard), and deregister him
 +
|-
 +
|OSDriver_CopyToSaveArea
 +
|<code>uint32_t OSDriver_CopyToSaveArea(char *drv_name, size_t name_len, void *in_buf, size_t buf_size)</code>
 +
|Will copy buf to an OSDriver "safe" save area [0x44/4]
 +
|-
 +
|OSDriver_CopyFromSaveArea
 +
|<code>uint32_t OSDriver_CopyFromSaveArea(char *drv_name, size_t name_len, void *out_buf, size_t buf_size)</code>
 +
|Will copy data from the OSDriver save area to an user controlled buffer
 +
|}
 +
 
 +
== Memory ==
 
{| class="wikitable"
 
{| class="wikitable"
 
!Name
 
!Name
Line 41: Line 65:  
|-
 
|-
 
|memset
 
|memset
−
|<code>void memset(void *str, int c, size_t n)</code>  
+
|<code>void *memset(void *str, int c, size_t n)</code>  
 
|Call OSBlockSet (Looks like it does the same thing as standart memset). Copies the character c (an unsigned char) to the first n characters of the String pointed to by the argument str. See  [http://www.tutorialspoint.com/c_standard_library/c_function_memset.htm]
 
|Call OSBlockSet (Looks like it does the same thing as standart memset). Copies the character c (an unsigned char) to the first n characters of the String pointed to by the argument str. See  [http://www.tutorialspoint.com/c_standard_library/c_function_memset.htm]
 
|-
 
|-
 
|memclr
 
|memclr
−
|<code>void memclr(void *str, size_t n)</code>  
+
|<code>void *memclr(void *str, size_t n)</code>  
 
|Like memset but sets the memory to 0. Call OSBlockSet (memset) with 0 as second arg (r4).
 
|Like memset but sets the memory to 0. Call OSBlockSet (memset) with 0 as second arg (r4).
 
|-
 
|-
 
|memcpy
 
|memcpy
−
|<code>void memcpy(void *str1, const void *str2, size_t n)</code>  
+
|<code>void *memcpy(void *str1, const void *str2, size_t n)</code>  
 
|Call OSBlockMove with  1 as the  fourth arg (r6).Copies n characters from memory area str2 to memory area str1. See [http://www.tutorialspoint.com/c_standard_library/c_function_memcpy.htm]
 
|Call OSBlockMove with  1 as the  fourth arg (r6).Copies n characters from memory area str2 to memory area str1. See [http://www.tutorialspoint.com/c_standard_library/c_function_memcpy.htm]
 
|-
 
|-
 
|memmove
 
|memmove
−
|<code>void memmove(void *str1, const void *str2, size_t n)</code>  
+
|<code>void *memmove(void *str1, const void *str2, size_t n)</code>  
 
|Call OSBlockMove with 1 as the fourth arg (r6) exactly the same as memcpy.
 
|Call OSBlockMove with 1 as the fourth arg (r6) exactly the same as memcpy.
 
|-
 
|-
 
|MEMAllocFromDefaultHeapEx
 
|MEMAllocFromDefaultHeapEx
−
|<code>int MEMAllocFromDefaultHeapEx(int size, int alignment)</code>  
+
|<code>void *MEMAllocFromDefaultHeapEx(uint32_t size, int alignment)</code>  
 
|Allocates memory on the heap with the given size and memory alignment. This is typically in the 0x4??????? memory area
 
|Allocates memory on the heap with the given size and memory alignment. This is typically in the 0x4??????? memory area
 
|-
 
|-
 
|MEMFreeToDefaultHeap
 
|MEMFreeToDefaultHeap
−
|<code>void MEMFreeToDefaultHeap(int addr)</code>  
+
|<code>void MEMFreeToDefaultHeap(void* addr)</code>  
 
|Frees previously heap memory. addr is the address returned by MEMAllocFromDefaultHeapEx()
 
|Frees previously heap memory. addr is the address returned by MEMAllocFromDefaultHeapEx()
 
|-
 
|-
 
|OSAllocFromSystem
 
|OSAllocFromSystem
−
|<code>int OSAllocFromSystem(int size, int alignment)</code>  
+
|<code>void *OSAllocFromSystem(uint32_t size, int alignment)</code>  
 
|Allocates system memory with the given size and memory alignment. This is typically in the 0x10?????? memory area
 
|Allocates system memory with the given size and memory alignment. This is typically in the 0x10?????? memory area
 
|-
 
|-
 
|OSFreeToSystem
 
|OSFreeToSystem
−
|<code>void OSFreeToSystem(int addr)</code>  
+
|<code>void OSFreeToSystem(void* addr)</code>  
 
|Frees previously allocated system memory. addr is the address returned by OSAllocFromSystem()
 
|Frees previously allocated system memory. addr is the address returned by OSAllocFromSystem()
 
|-
 
|-
Line 81: Line 105:  
|}
 
|}
   −
===Cache===
+
== Cache ==
 
{| class="wikitable"
 
{| class="wikitable"
 
!Name
 
!Name
Line 100: Line 124:  
|}
 
|}
   −
===Disassembler===
+
== Disassembler ==
 
{| class="wikitable"
 
{| class="wikitable"
 
!Name
 
!Name
Line 115: Line 139:  
|}
 
|}
   −
===Dynamic Linking===
+
== Dynamic Linking ==
 
{| class="wikitable"
 
{| class="wikitable"
 
!Name
 
!Name
Line 126: Line 150:  
|-
 
|-
 
|OSDynLoad_IsModuleLoaded
 
|OSDynLoad_IsModuleLoaded
−
|<code>int OSDynLoad_Acquire(const char *rplname, uint32_t *handle)</code>  
+
|<code>int OSDynLoad_IsModuleLoaded(const char *rplname, uint32_t *handle)</code>  
 
|Checks if a module is loaded. If the target module is loaded the function set the existing handle to the module otherwise the handle is not set. Returns a errorcode.
 
|Checks if a module is loaded. If the target module is loaded the function set the existing handle to the module otherwise the handle is not set. Returns a errorcode.
 
|-
 
|-
Line 140: Line 164:  
Attempting to use OSDynLoad_Acquire() with rplname "nn_uds.rpl" / "test.rpl" (which Internet Browser itself doesn't import) under Internet Browser has the same result: OSDynLoad_Acquire() never returns. Launching a game which uses the former before running Internet Browser has the same result.
 
Attempting to use OSDynLoad_Acquire() with rplname "nn_uds.rpl" / "test.rpl" (which Internet Browser itself doesn't import) under Internet Browser has the same result: OSDynLoad_Acquire() never returns. Launching a game which uses the former before running Internet Browser has the same result.
   −
===Error===
+
== Error ==
 
{| class="wikitable"
 
{| class="wikitable"
 
!Name
 
!Name
Line 151: Line 175:  
|}
 
|}
   −
===Internal===
+
== Internal ==
 
{| class="wikitable"
 
{| class="wikitable"
 
!Name
 
!Name
Line 162: Line 186:  
|}
 
|}
   −
===Threads===
+
== Threads ==
 
{| class="wikitable"
 
{| class="wikitable"
 
!Name
 
!Name
Line 209: Line 233:  
|}
 
|}
   −
===Codegen===
+
== Codegen ==
 
These functions are used for managing the codegen/JIT area which begins at virtual-memory address 0x01800000. The codegen area size, whether codegen can be used at all, and permissions/etc are loaded from cos.xml for the process. Hence, almost all processes which don't use WebKit don't have access to codegen. These permissions include the coreid which is allowed to use codegen at all(with [[Internet Browser]] this is core1). These permissions also seem to include whether the process is allowed to use OSCodegenCopy([[Internet Browser]] isn't allowed to use it). Certain Virtual Console titles seem to be the only applications which are allowed to use OSCodegenCopy due to cos.xml(codegen_core is set to 40000001 for these, unlike 80000001 for browser-based titles).
 
These functions are used for managing the codegen/JIT area which begins at virtual-memory address 0x01800000. The codegen area size, whether codegen can be used at all, and permissions/etc are loaded from cos.xml for the process. Hence, almost all processes which don't use WebKit don't have access to codegen. These permissions include the coreid which is allowed to use codegen at all(with [[Internet Browser]] this is core1). These permissions also seem to include whether the process is allowed to use OSCodegenCopy([[Internet Browser]] isn't allowed to use it). Certain Virtual Console titles seem to be the only applications which are allowed to use OSCodegenCopy due to cos.xml(codegen_core is set to 40000001 for these, unlike 80000001 for browser-based titles).
   Line 242: Line 266:  
|}
 
|}
   −
=== Screen ===
+
== Screen ==
 
"bufferNum" is the screenid, see the below screen defines for that. OSScreen *only* supports values 0-1 for screenid. "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.
 
"bufferNum" is the screenid, see the below screen defines for that. OSScreen *only* supports values 0-1 for screenid. "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.
   Line 293: Line 317:  
|}
 
|}
   −
===OSSystem=== <!-- TODO: Find better name?? -->
+
== System ==
−
 
   
{| class="wikitable"
 
{| class="wikitable"
 
!Name
 
!Name
Line 303: Line 326:  
|<code>OSTime OSGetSystemTime(void)</code>
 
|<code>OSTime OSGetSystemTime(void)</code>
 
|Gets OSTime (which is just an int64_t) from tbu/tb (timebase upper/lower special purpose registers), same as get_timebase in kernel (FFF099E0 on 5.5.X)
 
|Gets OSTime (which is just an int64_t) from tbu/tb (timebase upper/lower special purpose registers), same as get_timebase in kernel (FFF099E0 on 5.5.X)
 +
|-
 +
|OSGetTime
 +
|<code>OSTime OSGetTime(void)</code>
 +
|Returns OSTime equal to then number of ticks from 1/1/2000 00:00
 
|-
 
|-
 
|OSTicksToCalendarTime
 
|OSTicksToCalendarTime
Line 338: Line 365:  
|OSGetConsoleType
 
|OSGetConsoleType
 
|<code>uint32_t OSGetConsoleType(void)</code>
 
|<code>uint32_t OSGetConsoleType(void)</code>
−
|Returns the console type e.g. 0x03000050.
+
|Returns the [[#ConsoleType|ConsoleType]].
 
|-
 
|-
 
|OSSleepTicks
 
|OSSleepTicks
Line 385: Line 412:  
|}
 
|}
   −
===Boot=== <!-- TODO: Find better name?? -->
+
== Boot ==
−
 
   
{| class="wikitable"
 
{| class="wikitable"
 
!Name
 
!Name
Line 413: Line 439:  
|}
 
|}
   −
==Filesystem==
+
== IOS ==
 +
{| class="wikitable"
 +
!Name
 +
!Prototype
 +
!Description
 +
|-
 +
|IOS_Open
 +
|<code>int IOS_Open(char *path, uint32_t mode)</code>
 +
|Gets an handle to an IOS device node at the specified path whith the given mode
 +
|-
 +
|IOS_Close
 +
|<code>int IOS_Close(int fd);</code>
 +
|Closes an handle to an IOS device node fd (returned by IOS_Open)
 +
|-
 +
|IOS_Ioctl
 +
|<code>int IOS_Ioctl(int fd, uint32_t request, void *input_buf, uint32_t input_buf_len, void *output_buf, uint32_t output_buf_len)</code>
 +
|Sends an ioctl request to an IOS device node fd; input_buf contains the input data for the request, output_buf cointains what the request returns
 +
|}
 +
 
 +
== MCP ==
 +
{| class="wikitable"
 +
!Name
 +
!Prototype
 +
!Description
 +
|-
 +
|MCP_Open
 +
|int MCP_Open()
 +
|Opens an handle to the MCP IOS node
 +
|-
 +
|MCP_Close
 +
|int MCP_Close(int handle)
 +
|Closes an handle to the MCP IOS node
 +
|-
 +
|MCP_DeviceList
 +
|int MCP_DeviceList(int handle, int *numDevices, MCPDeviceList *outDevices, uint32_t outBufferSize)
 +
|Gets a list of available devices
 +
|-
 +
|MCP_FullDeviceList
 +
|int MCP_FullDeviceList(int handle, int *numDevices, MCPDeviceList *outDevices, uint32_t outBufferSize)
 +
|Gets the full list of available devices
 +
|-
 +
|MCP_InstallSetTargetDevice
 +
|int MCP_InstallSetTargetDevice(int handle, MCPInstallTarget device)
 +
|Sets the the target device for title installation
 +
|-
 +
|MCP_InstallGetTargetDevice
 +
|int MCP_InstallGetTargetDevice(int handle, MCPInstallTarget *deviceOut)
 +
|Gets the target device for title installation
 +
|-
 +
|MCP_InstallSetTargetUsb
 +
|int MCP_InstallSetTargetUsb(int handle, int usb)
 +
|Sets the target USB device for installation
 +
|-
 +
|MCP_InstallGetInfo
 +
|int MCP_InstallGetInfo(int handle, char *path, MCPInstallInfo *out)
 +
|Gets informations about the install operation
 +
|-
 +
|MCP_InstallTitleAsync
 +
|int MCP_InstallTitleAsync(int handle, char *path, MCPInstallInfo *out)
 +
|Installs a title
 +
|-
 +
|MCP_InstallGetProgress
 +
|int MCP_InstallGetProgress(int handle, MCPInstallProgress *installProgressOut)
 +
|Gets installation progress
 +
|-
 +
|MCP_InstallTitleAbort
 +
|int MCP_InstallTitleAbort(int handle)
 +
|Aborts the installation of a title
 +
|-
 +
|MCP_UninstallTitleAsync
 +
|int MCP_UninstallTitleAsync(int handle, char *path, MCPInstallInfo *out)
 +
|Uninstalls a title
 +
|}
 +
 
 +
= Filesystem =
 
The FS* functions appear to only be used by regular applications, while the FSA* functions appear to only be used by system rpls.
 
The FS* functions appear to only be used by regular applications, while the FSA* functions appear to only be used by system rpls.
−
===Setup===
+
 
 +
== Setup ==
 
{| class="wikitable"
 
{| class="wikitable"
 
!Name
 
!Name
Line 448: Line 549:  
|}
 
|}
   −
===Command Blocks===
+
== Command Blocks ==
 
{| class="wikitable"
 
{| class="wikitable"
 
!Name
 
!Name
Line 496: Line 597:  
|}
 
|}
   −
===File Commands===
+
== File Commands ==
 
{| class="wikitable"
 
{| class="wikitable"
 
!Name
 
!Name
Line 644: Line 745:  
|}
 
|}
   −
== Structures ==
+
= Structures =
−
=== Threads ===
+
== Threads ==
−
 
   
{| class="wikitable"
 
{| class="wikitable"
 
!Name
 
!Name
Line 767: Line 867:  
|}
 
|}
   −
===System Info===
+
== System Info ==
 
{| class="wikitable"
 
{| class="wikitable"
 
!Name
 
!Name
Line 785: Line 885:  
|}
 
|}
   −
===Filesystem===
+
== Filesystem ==
 
<syntaxhighlight lang="C">
 
<syntaxhighlight lang="C">
 
typedef struct {uint8_t buffer[FS_CLIENT_BUFFER_SIZE];} FSClient;
 
typedef struct {uint8_t buffer[FS_CLIENT_BUFFER_SIZE];} FSClient;
Line 810: Line 910:  
</syntaxhighlight>
 
</syntaxhighlight>
   −
== Defines ==
+
= Defines =
−
===Filesystem===
+
== Filesystem ==
 
<syntaxhighlight lang="C">
 
<syntaxhighlight lang="C">
 
#define FS_CLIENT_BUFFER_SIZE  (5888) /* 0x1700 */
 
#define FS_CLIENT_BUFFER_SIZE  (5888) /* 0x1700 */
Line 863: Line 963:  
</syntaxhighlight>
 
</syntaxhighlight>
   −
=== Disassembler ===
+
== Disassembler ==
 
printf_func() and find_symbol() have the following types:
 
printf_func() and find_symbol() have the following types:
 
<syntaxhighlight lang="C">
 
<syntaxhighlight lang="C">
Line 877: Line 977:  
</syntaxhighlight>
 
</syntaxhighlight>
   −
===OSSystem===
+
== System ==
 +
=== Time ===
 
<syntaxhighlight lang="C">
 
<syntaxhighlight lang="C">
 
#define OSTime int64_t /* stored in timebase upper/lower */
 
#define OSTime int64_t /* stored in timebase upper/lower */
Line 895: Line 996:  
</syntaxhighlight>
 
</syntaxhighlight>
   −
=== Screen ===
+
=== ConsoleType ===
 +
{| class="wikitable"
 +
|-
 +
! Value
 +
! Description
 +
|-
 +
| 0x03000050
 +
| CAFE (Production/Test)
 +
|-
 +
| 0x11000021
 +
| NDEV 2.1
 +
|-
 +
| 0x11000022
 +
| Cortado (HW)
 +
|-
 +
| 0x11000023
 +
| Cortado (BW)
 +
|-
 +
| 0x11000024
 +
| Cortado (ESP-BW SCM)
 +
|-
 +
| 0x13000040
 +
| EV board (Evaluation)
 +
|-
 +
| 0x13000048
 +
| CAT-DEV (Development)
 +
|-
 +
| 0x13000050
 +
| CAFE (Development)
 +
|-
 +
| 0x23000050
 +
| OrchestraX
 +
|}
 +
 
 +
== Driver ==
 +
<syntaxhighlight lang="C">
 +
#define OSDRIVER_SIZE 0x4c
 +
 
 +
typedef struct OSDriver {
 +
 
 +
  char drv_name[0x40];  // 0x00 - 0x40
 +
  uint32_t unknown;      // 0x40 - 0x44
 +
  uint32_t *save_area;  // 0x44 - 0x48
 +
  struct OSDriver *next; // 0x48 - 0x4c
 +
 
 +
} OSDriver;
 +
</syntaxhighlight>
 +
 
 +
== Screen ==
 
{| class="wikitable"
 
{| class="wikitable"
 
!Name
 
!Name
Line 909: Line 1,058:  
|The buffer number for the first Gamepad
 
|The buffer number for the first Gamepad
 
|}
 
|}
 +
 +
== MCP ==
 +
<syntaxhighlight lang="C">
 +
typedef enum MCPInstallTarget {
 +
  MCP_INSTALL_TARGET_MLC  = 0,
 +
  MCP_INSTALL_TARGET_USB  = 1,
 +
} MCPInstallTarget;
 +
 +
typedef struct MCPInstallProgress {
 +
  uint32_t inProgress;
 +
  uint64_t tid;
 +
  uint64_t sizeTotal;
 +
  uint64_t sizeProgress;
 +
  uint32_t contentsTotal;
 +
  uint32_t contentsProgress;
 +
} MCPInstallProgress;
 +
 +
typedef struct MCPInstallInfo {
 +
  char unknown[0x27F];
 +
} MCPInstallInfo;
 +
 +
typedef struct MCPDevice {
 +
  char name[0x31B];
 +
} MCPDevice;
 +
 +
typedef struct MCPDeviceList {
 +
  MCPDevice devices[32];
 +
} MCPDeviceList;
 +
</syntaxhighlight>
Retrieved from "https://wiiubrew.org/wiki/Special:MobileDiff/2407...3679"