mcp.h

Go to the documentation of this file.

#pragma once
#include <wut.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef int32_t MCPError;
 
typedef struct MCPDevice MCPDevice;
typedef struct MCPDeviceList MCPDeviceList;
typedef struct MCPInstallInfo MCPInstallInfo;
typedef struct MCPInstallProgress MCPInstallProgress;
typedef struct MCPInstallTitleInfo MCPInstallTitleInfo;
typedef struct MCPSysProdSettings MCPSysProdSettings;
typedef struct MCPSystemVersion MCPSystemVersion;
typedef struct MCPTitleListType MCPTitleListType;
 
typedef enum MCPAppType
{
   MCP_APP_TYPE_GAME_UPDATE            = 0x0800001B,
   MCP_APP_TYPE_GAME_DLC               = 0x0800000E,
   MCP_APP_TYPE_BOOT1                  = 0x10000009,
   MCP_APP_TYPE_SYSTEM_LIBRARIES       = 0x1000000A,
   MCP_APP_TYPE_BLUETOOTH_FIRMWARE     = 0x10000012,
   MCP_APP_TYPE_DRC_FIRMWARE           = 0x10000013,
   MCP_APP_TYPE_DRH_FIRMWARE           = 0x10000014,
   MCP_APP_TYPE_SYSTEM_VERSION         = 0x10000015,
   MCP_APP_TYPE_DRC_LANGUAGE           = 0x1000001A,
   MCP_APP_TYPE_EXCEPTIONS_DATA        = 0x18000010,
   MCP_APP_TYPE_SHARED_DATA            = 0x1800001C,
   MCP_APP_TYPE_CERT_STORE             = 0x1800001E,
   MCP_APP_TYPE_PATCH_MAP_DATA         = 0x18000023,
   MCP_APP_TYPE_WAGONU_MIGRATION_LIST  = 0x18000029,
   MCP_APP_TYPE_CAFFEINE_TITLE_LIST    = 0x18000030,
   MCP_APP_TYPE_MCP_TITLE_LIST         = 0x18000031,
   MCP_APP_TYPE_GAME                   = 0x80000000,
   MCP_APP_TYPE_GAME_WII               = 0x8000002E,
   MCP_APP_TYPE_SYSTEM_MENU            = 0x90000001,
   MCP_APP_TYPE_SYSTEM_UPDATER         = 0x9000000B,
   MCP_APP_TYPE_SYSTEM_APPS            = 0x90000020,
   MCP_APP_TYPE_ACCOUNT_APPS           = 0x90000021,
   MCP_APP_TYPE_SYSTEM_SETTINGS        = 0x90000022,
   MCP_APP_TYPE_ECO_PROCESS            = 0x9000002F,
   MCP_APP_TYPE_EMANUAL                = 0xD0000003,
   MCP_APP_TYPE_HOME_MENU              = 0xD0000004,
   MCP_APP_TYPE_ERROR_DISPLAY          = 0xD0000005,
   MCP_APP_TYPE_BROWSER                = 0xD0000006,
   MCP_APP_TYPE_MIIVERSE_POST          = 0xD000000D,
   MCP_APP_TYPE_MIIVERSE               = 0xD0000016,
   MCP_APP_TYPE_ESHOP                  = 0xD0000017,
   MCP_APP_TYPE_FRIEND_LIST            = 0xD0000018,
   MCP_APP_TYPE_DOWNLOAD_MANAGEMENT    = 0xD0000019,
   MCP_APP_TYPE_AOC_OVERLAY            = 0xD000002C,
   MCP_APP_TYPE_AMIIBO_SETTINGS        = 0xD0000033,
} MCPAppType;
 
typedef enum MCPDeviceType
{
   MCP_DEVICE_TYPE_AUTO                = 1, /* returns result for ODD, MLC and USB */
   MCP_DEVICE_TYPE_ODD                 = 2,
   MCP_DEVICE_TYPE_MLC                 = 3,
   MCP_DEVICE_TYPE_USB                 = 4,
   /* any value >= 5 is MCP_DEVICE_TYPE_AUTO */
} MCPDeviceType;
 
typedef enum MCPDeviceFlags
{
   MCP_DEVICE_FLAG_UNK_1               = 0x1,
   MCP_DEVICE_FLAG_UNK_2               = 0x2,
   MCP_DEVICE_FLAG_UNK_4               = 0x4,
   MCP_DEVICE_FLAG_UNK_8               = 0x8,
} MCPDeviceFlags;
 
typedef enum MCPInstallTarget
{
   MCP_INSTALL_TARGET_MLC              = 0,
   MCP_INSTALL_TARGET_USB              = 1,
} MCPInstallTarget;
 
typedef enum MCPRegion
{
   MCP_REGION_JAPAN                    = 0x01,
   MCP_REGION_USA                      = 0x02,
   MCP_REGION_EUROPE                   = 0x04,
   MCP_REGION_CHINA                    = 0x10,
   MCP_REGION_KOREA                    = 0x20,
   MCP_REGION_TAIWAN                   = 0x40,
} MCPRegion;
 
typedef enum MCPCompatAVFile
{
   MCP_COMPAT_AV_FILE_DMCU  = 0x00,
   MCP_COMPAT_AV_FILE_DEINT = 0x01,
} MCPCompatAVFile;
 
struct WUT_PACKED MCPDevice
{
   char type[8];
   char unk0x08[128];
   char filesystem[8];
   char path[0x27F];
   MCPDeviceFlags flags;
   uint32_t uid;
   uint32_t index;
};
WUT_CHECK_OFFSET(MCPDevice, 0x00, type);
WUT_CHECK_OFFSET(MCPDevice, 0x08, unk0x08);
WUT_CHECK_OFFSET(MCPDevice, 0x88, filesystem);
WUT_CHECK_OFFSET(MCPDevice, 0x90, path);
WUT_CHECK_OFFSET(MCPDevice, 0x30F, flags);
WUT_CHECK_OFFSET(MCPDevice, 0x313, uid);
WUT_CHECK_OFFSET(MCPDevice, 0x317, index);
WUT_CHECK_SIZE(MCPDevice, 0x31B);
 
struct MCPInstallInfo
{
   WUT_UNKNOWN_BYTES(0x27F);
};
WUT_CHECK_SIZE(MCPInstallInfo, 0x27F);
 
struct WUT_PACKED MCPInstallProgress
{
   uint32_t inProgress;
   uint64_t tid;
   uint64_t sizeTotal;
   uint64_t sizeProgress;
   uint32_t contentsTotal;
   uint32_t contentsProgress;
};
WUT_CHECK_OFFSET(MCPInstallProgress, 0x00, inProgress);
WUT_CHECK_OFFSET(MCPInstallProgress, 0x04, tid);
WUT_CHECK_OFFSET(MCPInstallProgress, 0x0C, sizeTotal);
WUT_CHECK_OFFSET(MCPInstallProgress, 0x14, sizeProgress);
WUT_CHECK_OFFSET(MCPInstallProgress, 0x1C, contentsTotal);
WUT_CHECK_OFFSET(MCPInstallProgress, 0x20, contentsProgress);
WUT_CHECK_SIZE(MCPInstallProgress, 0x24);
 
struct MCPInstallTitleInfo
{
   WUT_UNKNOWN_BYTES(0x27F);
};
WUT_CHECK_SIZE(MCPInstallTitleInfo, 0x27F);
 
struct WUT_PACKED MCPSysProdSettings
{
   MCPRegion product_area;
   uint16_t eeprom_version;
   WUT_PADDING_BYTES(2);
   MCPRegion game_region;
   WUT_UNKNOWN_BYTES(4);
   char ntsc_pal[5];
 
   char wifi_5ghz_country_code[4];
 
   uint8_t wifi_5ghz_country_code_revision;
 
   char code_id[8];
   char serial_id[12];
   WUT_UNKNOWN_BYTES(4);
   char model_number[16];
   uint32_t version;
};
WUT_CHECK_OFFSET(MCPSysProdSettings, 0x00, product_area);
WUT_CHECK_OFFSET(MCPSysProdSettings, 0x04, eeprom_version);
WUT_CHECK_OFFSET(MCPSysProdSettings, 0x08, game_region);
WUT_CHECK_OFFSET(MCPSysProdSettings, 0x10, ntsc_pal);
WUT_CHECK_OFFSET(MCPSysProdSettings, 0x15, wifi_5ghz_country_code);
WUT_CHECK_OFFSET(MCPSysProdSettings, 0x19, wifi_5ghz_country_code_revision);
WUT_CHECK_OFFSET(MCPSysProdSettings, 0x1A, code_id);
WUT_CHECK_OFFSET(MCPSysProdSettings, 0x22, serial_id);
WUT_CHECK_OFFSET(MCPSysProdSettings, 0x32, model_number);
WUT_CHECK_OFFSET(MCPSysProdSettings, 0x42, version);
WUT_CHECK_SIZE(MCPSysProdSettings, 0x46);
 
struct MCPSystemVersion
{
   uint32_t major;
   uint32_t minor;
   uint32_t patch;
   char region;
};
WUT_CHECK_OFFSET(MCPSystemVersion, 0x00, major);
WUT_CHECK_OFFSET(MCPSystemVersion, 0x04, minor);
WUT_CHECK_OFFSET(MCPSystemVersion, 0x08, patch);
WUT_CHECK_OFFSET(MCPSystemVersion, 0x0C, region);
WUT_CHECK_SIZE(MCPSystemVersion, 0x10);
 
struct WUT_PACKED MCPTitleListType
{
   uint64_t titleId;
   uint32_t groupId;
   char path[56];
   MCPAppType appType;
   uint16_t titleVersion;
   uint64_t osVersion;
   uint32_t sdkVersion;
   char indexedDevice[10];
   uint8_t unk0x60;
};
WUT_CHECK_OFFSET(MCPTitleListType, 0x00, titleId);
WUT_CHECK_OFFSET(MCPTitleListType, 0x08, groupId);
WUT_CHECK_OFFSET(MCPTitleListType, 0x0C, path);
WUT_CHECK_OFFSET(MCPTitleListType, 0x44, appType);
WUT_CHECK_OFFSET(MCPTitleListType, 0x48, titleVersion);
WUT_CHECK_OFFSET(MCPTitleListType, 0x4A, osVersion);
WUT_CHECK_OFFSET(MCPTitleListType, 0x52, sdkVersion);
WUT_CHECK_OFFSET(MCPTitleListType, 0x56, indexedDevice);
WUT_CHECK_OFFSET(MCPTitleListType, 0x60, unk0x60);
WUT_CHECK_SIZE(MCPTitleListType, 0x61);
 
MCPError
MCP_Open();
 
MCPError
MCP_Close(int handle);
 
MCPError
MCP_DeviceList(int handle,
               int *numDevices,
               MCPDevice *outDeviceList,
               uint32_t deviceListSizeInBytes);
 
MCPError
MCP_FullDeviceList(int handle,
                   int *numDevices,
                   MCPDevice *outDeviceList,
                   uint32_t deviceListSizeInBytes);
 
MCPError
MCP_GetOwnTitleInfo(int32_t handle,
                    MCPTitleListType *titleInfo);
 
MCPError
MCP_GetSysProdSettings(int32_t handle,
                       MCPSysProdSettings *settings);
 
MCPError
MCP_GetSystemVersion(int32_t handle,
                     MCPSystemVersion *systemVersion);
 
MCPError
MCP_GetTitleId(int32_t handle,
               uint64_t *outTitleId);
 
MCPError
MCP_GetTitleInfo(int32_t handle,
                 uint64_t titleId,
                 MCPTitleListType *titleInfo);
 
MCPError
MCP_InstallSetTargetDevice(int handle,
                           MCPInstallTarget device);
 
MCPError
MCP_InstallGetTargetDevice(int handle,
                           MCPInstallTarget *deviceOut);
 
MCPError
MCP_InstallSetTargetUsb(int handle,
                        int usb);
 
MCPError
MCP_InstallGetInfo(int handle,
                   const char *path,
                   MCPInstallInfo *out);
 
MCPError
MCP_InstallTitleAsync(int handle,
                      const char *path,
                      MCPInstallTitleInfo *out);
 
MCPError
MCP_InstallGetProgress(int handle,
                       MCPInstallProgress *installProgressOut);
 
MCPError
MCP_InstallTitleAbort(int handle);
 
MCPError
MCP_TitleCount(int32_t handle);
 
MCPError
MCP_TitleList(int32_t handle,
              uint32_t *outTitleCount,
              MCPTitleListType *titleList,
              uint32_t titleListSizeBytes);
 
MCPError
MCP_TitleListByAppType(int32_t handle,
                       MCPAppType appType,
                       uint32_t *outTitleCount,
                       MCPTitleListType *titleList,
                       uint32_t titleListSizeBytes);
 
MCPError
MCP_TitleListByUniqueId(int32_t handle,
                        uint32_t uniqueId,
                        uint32_t *outTitleCount,
                        MCPTitleListType *titleList,
                        uint32_t titleListSizeBytes);
 
MCPError
MCP_TitleListByDevice(int32_t handle,
                      const char *deviceName,
                      uint32_t *outTitleCount,
                      MCPTitleListType *titleList,
                      uint32_t titleListSizeBytes);
 
MCPError
MCP_TitleListByDeviceType(int32_t handle,
                          MCPDeviceType deviceType,
                          uint32_t *outTitleCount,
                          MCPTitleListType *titleList,
                          uint32_t titleListSizeBytes);
MCPError
MCP_TitleListByAppAndDevice(int32_t handle,
                            MCPAppType appType,
                            const char *deviceName,
                            uint32_t *outTitleCount,
                            MCPTitleListType *titleList,
                            uint32_t titleListSizeBytes);
 
MCPError
MCP_TitleListByAppAndDeviceType(int32_t handle,
                                MCPAppType appType,
                                MCPDeviceType deviceType,
                                uint32_t *outTitleCount,
                                MCPTitleListType *titleList,
                                uint32_t titleListSizeBytes);
 
MCPError
MCP_TitleListByUniqueIdAndIndexedDeviceAndAppType(int32_t handle,
                                                  uint32_t uniqueId,
                                                  const char *indexedDevice,
                                                  uint8_t unk0x60,
                                                  MCPAppType appType,
                                                  uint32_t *outTitleCount,
                                                  MCPTitleListType *titleList,
                                                  uint32_t titleListSizeBytes);
 
MCPError
MCP_UninstallTitleAsync(int32_t handle,
                        const char *path,
                        MCPInstallTitleInfo *out);
 
MCPError
MCP_CompatLoadAVFile(int32_t handle,
                     void *ptr,
                     uint32_t *size,
                     MCPCompatAVFile file);
 
MCPError
MCP_TriggerCrashLogCollection(int32_t handle);
 
MCPError
MCP_ChangeEcoSettings(int32_t handle,
                      uint32_t enable,
                      uint32_t maxOnTime,
                      uint16_t defaultOffTime);
 
static inline const char*
MCP_GetDeviceNameByDeviceType(MCPDeviceType deviceType) {
   switch (deviceType) {
      case MCP_DEVICE_TYPE_AUTO:
         return "auto";
      case MCP_DEVICE_TYPE_ODD:
         return "odd";
      case MCP_DEVICE_TYPE_MLC:
         return "mlc";
      case MCP_DEVICE_TYPE_USB:
         return "usb";
   }
   return "auto";
}
 
#ifdef __cplusplus
}
#endif