Merge pull request #345 from purpasmart96/apt_stubs

APT_U: Stub some functions & misc changes

src/core/hle/service/apt_u.cpp

@@ -41,6 +41,29 @@ enum class SignalType : u32 {
     ExitingApp      = 0xC,
 };
 
+/// App Id's used by APT functions
+enum class AppID : u32 {
+    HomeMenu           = 0x101,
+    AlternateMenu      = 0x103,
+    Camera             = 0x110,
+    FriendsList        = 0x112,
+    GameNotes          = 0x113,
+    InternetBrowser    = 0x114,
+    InstructionManual  = 0x115,
+    Notifications      = 0x116,
+    Miiverse           = 0x117,
+    SoftwareKeyboard1  = 0x201,
+    Ed                 = 0x202,
+    PnoteApp           = 0x204,
+    SnoteApp           = 0x205,
+    Error              = 0x206,
+    Mint               = 0x207,
+    Extrapad           = 0x208,
+    Memolib            = 0x209,
+    Application        = 0x300,
+    SoftwareKeyboard2  = 0x401,
+};
+
 void Initialize(Service::Interface* self) {
     u32* cmd_buff = Kernel::GetCommandBuffer();
 
@@ -56,16 +79,24 @@ void Initialize(Service::Interface* self) {
     _assert_msg_(KERNEL, (0 != lock_handle), "Cannot initialize without lock");
     Kernel::ReleaseMutex(lock_handle);
 
-    cmd_buff[1] = 0; // No error
+    cmd_buff[1] = RESULT_SUCCESS.raw; // No error
 }
 
+/**
+ * APT_U::NotifyToWait service function
+ *  Inputs:
+ *      1 : AppID
+ *  Outputs:
+ *      1 : Result of function, 0 on success, otherwise error code
+ */
 void NotifyToWait(Service::Interface* self) {
     u32* cmd_buff = Kernel::GetCommandBuffer();
     u32 app_id = cmd_buff[1];
     // TODO(Subv): Verify this, it seems to get SWKBD and Home Menu further.
     Kernel::SignalEvent(pause_event_handle);
+
+    cmd_buff[1] = RESULT_SUCCESS.raw; // No error
     LOG_WARNING(Service_APT, "(STUBBED) app_id=%u", app_id);
-    cmd_buff[1] = 0;
 }
 
 void GetLockHandle(Service::Interface* self) {
@@ -77,7 +108,7 @@ void GetLockHandle(Service::Interface* self) {
         lock_handle = Kernel::CreateMutex(false, "APT_U:Lock");
         Kernel::ReleaseMutex(lock_handle);
     }
-    cmd_buff[1] = 0; // No error
+    cmd_buff[1] = RESULT_SUCCESS.raw; // No error
 
     // Not sure what these parameters are used for, but retail apps check that they are 0 after
     // GetLockHandle has been called.
@@ -92,18 +123,94 @@ void GetLockHandle(Service::Interface* self) {
 void Enable(Service::Interface* self) {
     u32* cmd_buff = Kernel::GetCommandBuffer();
     u32 unk = cmd_buff[1]; // TODO(bunnei): What is this field used for?
-    cmd_buff[1] = 0; // No error
+    cmd_buff[1] = RESULT_SUCCESS.raw; // No error
     LOG_WARNING(Service_APT, "(STUBBED) called unk=0x%08X", unk);
 }
 
+/**
+ * APT_U::GetAppletManInfo service function.
+ *  Inputs:
+ *      1 : Unknown
+ *  Outputs:
+ *      1 : Result of function, 0 on success, otherwise error code
+ *      2 : Unknown u32 value
+ *      3 : Unknown u8 value
+ *      4 : Home Menu AppId
+ *      5 : AppID of currently active app
+ */
+void GetAppletManInfo(Service::Interface* self) {
+    u32* cmd_buff = Kernel::GetCommandBuffer();
+    u32 unk = cmd_buff[1];
+    cmd_buff[1] = RESULT_SUCCESS.raw; // No error
+    cmd_buff[2] = 0;
+    cmd_buff[3] = 0;
+    cmd_buff[4] = static_cast<u32>(AppID::HomeMenu); // Home menu AppID
+    cmd_buff[5] = static_cast<u32>(AppID::Application); // TODO(purpasmart96): Do this correctly
+
+    LOG_WARNING(Service_APT, "(STUBBED) called unk=0x%08X", unk);
+}
+
+/**
+ * APT_U::IsRegistered service function. This returns whether the specified AppID is registered with NS yet.
+ * An AppID is "registered" once the process associated with the AppID uses APT:Enable. Home Menu uses this
+ * command to determine when the launched process is running and to determine when to stop using GSP etc,
+ * while displaying the "Nintendo 3DS" loading screen.
+ *  Inputs:
+ *      1 : AppID
+ *  Outputs:
+ *      0 : Return header
+ *      1 : Result of function, 0 on success, otherwise error code
+ *      2 : Output, 0 = not registered, 1 = registered. 
+ */
+void IsRegistered(Service::Interface* self) {
+    u32* cmd_buff = Kernel::GetCommandBuffer();
+    u32 app_id = cmd_buff[1];
+    cmd_buff[1] = RESULT_SUCCESS.raw; // No error
+    cmd_buff[2] = 1; // Set to registered
+    LOG_WARNING(Service_APT, "(STUBBED) called app_id=0x%08X", app_id);
+}
+
 void InquireNotification(Service::Interface* self) {
     u32* cmd_buff = Kernel::GetCommandBuffer();
     u32 app_id = cmd_buff[1];
-    cmd_buff[1] = 0; // No error
+    cmd_buff[1] = RESULT_SUCCESS.raw; // No error
     cmd_buff[2] = static_cast<u32>(SignalType::None); // Signal type
     LOG_WARNING(Service_APT, "(STUBBED) called app_id=0x%08X", app_id);
 }
 
+/**
+ * APT_U::SendParameter service function. This sets the parameter data state. 
+ * Inputs:
+ *     1 : Source AppID
+ *     2 : Destination AppID
+ *     3 : Signal type
+ *     4 : Parameter buffer size, max size is 0x1000 (this can be zero)
+ *     5 : Value
+ *     6 : Handle to the destination process, likely used for shared memory (this can be zero)
+ *     7 : (Size<<14) | 2
+ *     8 : Input parameter buffer ptr
+ * Outputs:
+ *     0 : Return Header
+ *     1 : Result of function, 0 on success, otherwise error code
+*/
+void SendParameter(Service::Interface* self) {
+    u32* cmd_buff = Kernel::GetCommandBuffer();
+    u32 src_app_id          = cmd_buff[1];
+    u32 dst_app_id          = cmd_buff[2];
+    u32 signal_type         = cmd_buff[3];
+    u32 buffer_size         = cmd_buff[4];
+    u32 value               = cmd_buff[5];
+    u32 handle              = cmd_buff[6];
+    u32 size                = cmd_buff[7];
+    u32 in_param_buffer_ptr = cmd_buff[8];
+    
+    cmd_buff[1] = RESULT_SUCCESS.raw; // No error
+
+    LOG_WARNING(Service_APT, "(STUBBED) called src_app_id=0x%08X, dst_app_id=0x%08X, signal_type=0x%08X,"
+               "buffer_size=0x%08X, value=0x%08X, handle=0x%08X, size=0x%08X, in_param_buffer_ptr=0x%08X",
+               src_app_id, dst_app_id, signal_type, buffer_size, value, handle, size, in_param_buffer_ptr);
+}
+
 /**
  * APT_U::ReceiveParameter service function. This returns the current parameter data from NS state,
  * from the source process which set the parameters. Once finished, NS will clear a flag in the NS
@@ -115,8 +222,8 @@ void InquireNotification(Service::Interface* self) {
  *      2 : Parameter buffer size, max size is 0x1000
  *  Outputs:
  *      1 : Result of function, 0 on success, otherwise error code
- *      2 : Unknown, for now assume AppID of the process which sent these parameters
+ *      2 : AppID of the process which sent these parameters
- *      3 : Unknown, for now assume Signal type
+ *      3 : Signal type
  *      4 : Actual parameter buffer size, this is <= to the the input size
  *      5 : Value
  *      6 : Handle from the source process which set the parameters, likely used for shared memory
@@ -127,7 +234,7 @@ void ReceiveParameter(Service::Interface* self) {
     u32* cmd_buff = Kernel::GetCommandBuffer();
     u32 app_id = cmd_buff[1];
     u32 buffer_size = cmd_buff[2];
-    cmd_buff[1] = 0; // No error
+    cmd_buff[1] = RESULT_SUCCESS.raw; // No error
     cmd_buff[2] = 0;
     cmd_buff[3] = static_cast<u32>(SignalType::AppJustStarted); // Signal type
     cmd_buff[4] = 0x10; // Parameter buffer size (16)
@@ -159,7 +266,7 @@ void GlanceParameter(Service::Interface* self) {
     u32 app_id = cmd_buff[1];
     u32 buffer_size = cmd_buff[2];
 
-    cmd_buff[1] = 0; // No error
+    cmd_buff[1] = RESULT_SUCCESS.raw; // No error
     cmd_buff[2] = 0;
     cmd_buff[3] = static_cast<u32>(SignalType::AppJustStarted); // Signal type
     cmd_buff[4] = 0x10; // Parameter buffer size (16)
@@ -170,6 +277,36 @@ void GlanceParameter(Service::Interface* self) {
     LOG_WARNING(Service_APT, "(STUBBED) called app_id=0x%08X, buffer_size=0x%08X", app_id, buffer_size);
 }
 
+/**
+ * APT_U::CancelParameter service function. When the parameter data is available, and when the above
+ * specified fields match the ones in NS state(for the ones where the checks are enabled), this
+ * clears the flag which indicates that parameter data is available
+ * (same flag cleared by APT:ReceiveParameter).
+ *  Inputs:
+ *      1 : Flag, when non-zero NS will compare the word after this one with a field in the NS state.
+ *      2 : Unknown, this is the same as the first unknown field returned by APT:ReceiveParameter.
+ *      3 : Flag, when non-zero NS will compare the word after this one with a field in the NS state.
+ *      4 : AppID
+ *  Outputs:
+ *      0 : Return header
+ *      1 : Result of function, 0 on success, otherwise error code
+ *      2 : Status flag, 0 = failure due to no parameter data being available, or the above enabled
+ *          fields don't match the fields in NS state. 1 = success.
+ */
+void CancelParameter(Service::Interface* self) {
+    u32* cmd_buff = Kernel::GetCommandBuffer();
+    u32 flag1  = cmd_buff[1];
+    u32 unk    = cmd_buff[2];
+    u32 flag2  = cmd_buff[3];
+    u32 app_id = cmd_buff[4];
+
+    cmd_buff[1] = RESULT_SUCCESS.raw; // No error
+    cmd_buff[2] = 1; // Set to Success
+
+    LOG_WARNING(Service_APT, "(STUBBED) called flag1=0x%08X, unk=0x%08X, flag2=0x%08X, app_id=0x%08X",
+               flag1, unk, flag2, app_id);
+}
+
 /**
  * APT_U::AppletUtility service function
  *  Inputs:
@@ -191,7 +328,7 @@ void AppletUtility(Service::Interface* self) {
     u32 buffer1_addr = cmd_buff[5];
     u32 buffer2_addr = cmd_buff[65];
 
-    cmd_buff[1] = 0; // No error
+    cmd_buff[1] = RESULT_SUCCESS.raw; // No error
 
     LOG_WARNING(Service_APT, "(STUBBED) called unk=0x%08X, buffer1_size=0x%08x, buffer2_size=0x%08x, "
              "buffer1_addr=0x%08x, buffer2_addr=0x%08x", unk, buffer1_size, buffer2_size,
@@ -215,7 +352,7 @@ void GetSharedFont(Service::Interface* self) {
         memcpy(Memory::GetPointer(SHARED_FONT_VADDR), shared_font.data(), shared_font.size());
 
         cmd_buff[0] = 0x00440082;
-        cmd_buff[1] = 0; // No error
+        cmd_buff[1] = RESULT_SUCCESS.raw; // No error
         cmd_buff[2] = SHARED_FONT_VADDR;
         cmd_buff[4] = shared_font_mem;
     } else {
@@ -224,22 +361,70 @@ void GetSharedFont(Service::Interface* self) {
     }
 }
 
+/**
+ * APT_U::SetAppCpuTimeLimit service function
+ *  Inputs:
+ *      1 : Value, must be one
+ *      2 : Percentage of CPU time from 5 to 80
+ *  Outputs:
+ *      1 : Result of function, 0 on success, otherwise error code
+ */
+void SetAppCpuTimeLimit(Service::Interface* self) {
+    u32* cmd_buff = Kernel::GetCommandBuffer();
+    u32 value = cmd_buff[1];
+    u32 percent = cmd_buff[2];
+
+    if (value != 1) {
+        LOG_ERROR(Service_APT, "This value must be one!", value);
+    }
+
+    cmd_buff[1] = RESULT_SUCCESS.raw; // No error
+
+    LOG_WARNING(Service_APT, "(STUBBED) called percent=0x%08X, value=0x%08x", percent, value);
+}
+
+/**
+ * APT_U::GetAppCpuTimeLimit service function
+ *  Inputs:
+ *      1 : Value, must be one
+ *  Outputs:
+ *      0 : Return header
+ *      1 : Result of function, 0 on success, otherwise error code
+ *      2 : System core CPU time percentage
+ */
+void GetAppCpuTimeLimit(Service::Interface* self) {
+    u32* cmd_buff = Kernel::GetCommandBuffer();
+    u32 value = cmd_buff[1];
+
+    if (value != 1) {
+        LOG_ERROR(Service_APT, "This value must be one!", value);
+    }
+
+    // TODO(purpasmart96): This is incorrect, I'm pretty sure the percentage should
+    // be set by the application.
+
+    cmd_buff[1] = RESULT_SUCCESS.raw; // No error
+    cmd_buff[2] = 0x80; // Set to 80%
+
+    LOG_WARNING(Service_APT, "(STUBBED) called value=0x%08x", value);
+}
+
 const Interface::FunctionInfo FunctionTable[] = {
     {0x00010040, GetLockHandle,                   "GetLockHandle"},
     {0x00020080, Initialize,                      "Initialize"},
     {0x00030040, Enable,                          "Enable"},
     {0x00040040, nullptr,                         "Finalize"},
-    {0x00050040, nullptr,               "GetAppletManInfo"},
+    {0x00050040, GetAppletManInfo,                "GetAppletManInfo"},
     {0x00060040, nullptr,                         "GetAppletInfo"},
     {0x00070000, nullptr,                         "GetLastSignaledAppletId"},
     {0x00080000, nullptr,                         "CountRegisteredApplet"},
-    {0x00090040, nullptr,               "IsRegistered"},
+    {0x00090040, IsRegistered,                    "IsRegistered"},
     {0x000A0040, nullptr,                         "GetAttribute"},
     {0x000B0040, InquireNotification,             "InquireNotification"},
-    {0x000C0104, nullptr,               "SendParameter"},
+    {0x000C0104, SendParameter,                   "SendParameter"},
     {0x000D0080, ReceiveParameter,                "ReceiveParameter"},
     {0x000E0080, GlanceParameter,                 "GlanceParameter"},
-    {0x000F0100, nullptr,               "CancelParameter"},
+    {0x000F0100, CancelParameter,                 "CancelParameter"},
     {0x001000C2, nullptr,                         "DebugFunc"},
     {0x001100C0, nullptr,                         "MapProgramIdForDebug"},
     {0x00120040, nullptr,                         "SetHomeMenuAppletIdForDebug"},
@@ -303,8 +488,8 @@ const Interface::FunctionInfo FunctionTable[] = {
     {0x004C0000, nullptr,                         "SetFatalErrDispMode"},
     {0x004D0080, nullptr,                         "GetAppletProgramInfo"},
     {0x004E0000, nullptr,                         "HardwareResetAsync"},
-    {0x004F0080, nullptr,               "SetApplicationCpuTimeLimit"},
+    {0x004F0080, SetAppCpuTimeLimit,              "SetAppCpuTimeLimit"},
-    {0x00500040, nullptr,               "GetApplicationCpuTimeLimit"},
+    {0x00500040, GetAppCpuTimeLimit,              "GetAppCpuTimeLimit"},
 };
 
 ////////////////////////////////////////////////////////////////////////////////////////////////////