NS services: Difference between revisions
No edit summary |
|||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 349: | Line 349: | ||
== ListApplicationRecord == | == ListApplicationRecord == | ||
Takes a type-0x6 output buffer containing an array of | Takes a type-0x6 output buffer containing an array of [[#ApplicationRecord]] and an s32 entry_offset, returns an output s32 out_entrycount. | ||
Returns an array of entries with the below format using the specified offset and count. | Returns an array of entries with the below format using the specified offset and count. | ||
== LaunchApplication == | == LaunchApplication == | ||
| Line 429: | Line 397: | ||
Loads cached [[control.nacp]] to buf+0 and the cached icon to buf+0x4000. Returns an error if the buffer is too small. | Loads cached [[control.nacp]] to buf+0 and the cached icon to buf+0x4000. Returns an error if the buffer is too small. | ||
== ListApplicationContentMetaStatus == | == ListApplicationContentMetaStatus == | ||
Takes a type-0x6 output buffer containing an array of | Takes a type-0x6 output buffer containing an array of [[#ApplicationContentMetaStatus]], an input s32 index and [[NCM_services#ApplicationId|ApplicationId]], returns an output s32 out_entrycount. | ||
Returns 0x10-byte entries using the specified [[NCM_services#ApplicationId|ApplicationId]] starting at the specified index. Can only return game titles. The second entry if any is the update-title usually. When the input entryindex is >= totalentries, this will return 0 with out_entrycount=0. | Returns 0x10-byte entries using the specified [[NCM_services#ApplicationId|ApplicationId]] starting at the specified index. Can only return game titles. The second entry if any is the update-title usually. When the input entryindex is >= totalentries, this will return 0 with out_entrycount=0. | ||
= ns:am2, ns:ec, ns:rid, ns:rt, ns:web, ns:ro, ns:sweb = | |||
These are "nn::ns::detail::IServiceGetterInterface". | |||
= ns:am2, ns:ec, ns:rid, ns:rt, ns:web, ns:ro, ns:sweb = | |||
These are "nn::ns::detail::IServiceGetterInterface". | |||
These commands check a state field for a command-specific bit and returns an error if not set, this is likely a permissions check for service+command. | These commands check a state field for a command-specific bit and returns an error if not set, this is likely a permissions check for service+command. | ||
| Line 767: | Line 687: | ||
|- | |- | ||
| 420 || [19.0.0+] CloneApplicationControlDataCacheForDebug | | 420 || [19.0.0+] CloneApplicationControlDataCacheForDebug | ||
|- | |||
| 421 || [20.0.0+] | |||
|- | |||
| 422 || [20.0.0+] | |||
|- | |||
| 423 || [20.0.0+] | |||
|- | |||
| 424 || [20.0.0+] | |||
|- | |||
| 425 || [20.0.0+] | |||
|- | |||
| 426 || [20.0.0+] | |||
|- | |||
| 427 || [20.0.0+] | |||
|- | |- | ||
| 502 || [[#RequestCheckGameCardRegistration]] | | 502 || [[#RequestCheckGameCardRegistration]] | ||
| Line 789: | Line 723: | ||
|- | |- | ||
| 512 || [19.0.0+] IsGameCardApplicationRunning | | 512 || [19.0.0+] IsGameCardApplicationRunning | ||
|- | |||
| 513 || [20.0.0+] | |||
|- | |||
| 514 || [20.0.0+] | |||
|- | |||
| 515 || [20.0.0+] | |||
|- | |- | ||
| 600 || [[#CountApplicationContentMeta]] | | 600 || [[#CountApplicationContentMeta]] | ||
| Line 864: | Line 804: | ||
| 916 || [11.0.0+] IsApplicationAutoDeleteDisabled | | 916 || [11.0.0+] IsApplicationAutoDeleteDisabled | ||
|- | |- | ||
| | | 917 || [20.0.0+] | ||
|- | |- | ||
| | | 918 || [20.0.0+] | ||
|- | |- | ||
| 1002 || [3.0.0-9.2.0] [[#RequestVerifyAddOnContentsRights]] | | 919 || [20.0.0+] | ||
|- | |||
| 920 || [20.0.0+] | |||
|- | |||
| 921 || [20.0.0+] | |||
|- | |||
| 922 || [20.0.0+] | |||
|- | |||
| 923 || [20.0.0+] | |||
|- | |||
| 928 || [20.0.0+] | |||
|- | |||
| 929 || [20.0.0+] | |||
|- | |||
| 930 || [20.0.0+] | |||
|- | |||
| 931 || [20.0.0+] | |||
|- | |||
| 933 || [20.1.0+] | |||
|- | |||
| 1000 || [[#RequestVerifyApplicationDeprecated]] | |||
|- | |||
| 1001 || CorruptApplicationForDebug | |||
|- | |||
| 1002 || [3.0.0-9.2.0] [[#RequestVerifyAddOnContentsRights]] | |||
|- | |- | ||
| 1003 || [5.0.0+] [[#RequestVerifyApplication]] | | 1003 || [5.0.0+] [[#RequestVerifyApplication]] | ||
| Line 913: | Line 877: | ||
|- | |- | ||
| 1506 || [9.0.0+] GetSdCardStartupStatus | | 1506 || [9.0.0+] GetSdCardStartupStatus | ||
|- | |||
| 1508 || [20.0.0+] | |||
|- | |||
| 1509 || [20.0.0+] | |||
|- | |||
| 1510 || [20.0.0+] | |||
|- | |||
| 1511 || [20.0.0+] | |||
|- | |||
| 1512 || [20.0.0+] | |||
|- | |- | ||
| 1600 || GetSystemSeedForPseudoDeviceId | | 1600 || GetSystemSeedForPseudoDeviceId | ||
| Line 929: | Line 903: | ||
|- | |- | ||
| 1705 || [11.0.0+] [[#IsPatchAutoDeletableApplication]] | | 1705 || [11.0.0+] [[#IsPatchAutoDeletableApplication]] | ||
|- | |||
| 1706 || [20.0.0+] | |||
|- | |- | ||
| 1800 || IsNotificationSetupCompleted | | 1800 || IsNotificationSetupCompleted | ||
| Line 983: | Line 959: | ||
|- | |- | ||
| 2018 || [5.0.0+] [[#GetApplicationDeliveryInfoHash]] | | 2018 || [5.0.0+] [[#GetApplicationDeliveryInfoHash]] | ||
|- | |||
| 2019 || [20.0.0+] | |||
|- | |- | ||
| 2050 || [6.0.0+] [[#GetApplicationRightsOnClient]] | | 2050 || [6.0.0+] [[#GetApplicationRightsOnClient]] | ||
|- | |- | ||
| 2051 || [9.0.0+] InvalidateRightsIdCache | | 2051 || [9.0.0+] InvalidateRightsIdCache | ||
|- | |||
| 2052 || [20.0.0+] | |||
|- | |||
| 2053 || [20.0.0+] | |||
|- | |- | ||
| 2100 || [6.0.0+] [[#GetApplicationTerminateResult]] | | 2100 || [6.0.0+] [[#GetApplicationTerminateResult]] | ||
| Line 1,019: | Line 1,001: | ||
|- | |- | ||
| 2182 || [6.0.0+] SetActiveRightsContextUsingStateToRightsEnvironment | | 2182 || [6.0.0+] SetActiveRightsContextUsingStateToRightsEnvironment | ||
|- | |||
| 2183 || [20.1.0+] | |||
|- | |- | ||
| 2190 || [6.0.0+] [[#GetRightsEnvironmentHandleForApplication]] | | 2190 || [6.0.0+] [[#GetRightsEnvironmentHandleForApplication]] | ||
| Line 1,055: | Line 1,039: | ||
|- | |- | ||
| 2361 || [19.0.0+] GetMaxApplicationDownloadTaskCount | | 2361 || [19.0.0+] GetMaxApplicationDownloadTaskCount | ||
|- | |||
| 2362 || [20.0.0+] | |||
|- | |||
| 2363 || [20.0.0+] | |||
|- | |||
| 2364 || [20.0.0+] | |||
|- | |||
| 2365 || [20.0.0+] | |||
|- | |||
| 2366 || [20.0.0+] | |||
|- | |||
| 2367 || [20.0.0+] | |||
|- | |||
| 2368 || [20.0.0+] | |||
|- | |- | ||
| 2400 || [8.0.0+] [[#GetPromotionInfo]] | | 2400 || [8.0.0+] [[#GetPromotionInfo]] | ||
| Line 1,060: | Line 1,058: | ||
| 2401 || [8.0.0+] CountPromotionInfo | | 2401 || [8.0.0+] CountPromotionInfo | ||
|- | |- | ||
| 2402 || [8.0.0+] ListPromotionInfo | | 2402 || [8.0.0+] [[#ListPromotionInfo|ListPromotionInfo]] | ||
|- | |- | ||
| 2403 || [8.0.0+] [[#ImportPromotionJsonForDebug]] | | 2403 || [8.0.0+] [[#ImportPromotionJsonForDebug]] | ||
| Line 1,095: | Line 1,093: | ||
|- | |- | ||
| 2524 || [19.0.0+] | | 2524 || [19.0.0+] | ||
|- | |||
| 2525 || [20.0.0+] | |||
|- | |- | ||
| 2800 || [9.0.0+] GetApplicationIdOfPreomia | | 2800 || [9.0.0+] GetApplicationIdOfPreomia | ||
| Line 1,142: | Line 1,142: | ||
| 3105 || [18.0.0+] GetApplicationStartupMovie | | 3105 || [18.0.0+] GetApplicationStartupMovie | ||
|- | |- | ||
| | | 4000 || [20.0.0+] | ||
|- | |||
| 4004 || [20.0.0+] | |||
|- | |||
| 4006 || [20.0.0+] | |||
|- | |||
| 4007 || [20.0.0+] | |||
|- | |- | ||
| | | 4008 || [20.0.0+] | ||
|- | |- | ||
| | | 4009 || [20.0.0+] | ||
| | |- | ||
| 4010 || [20.0.0+] | |||
[ | |- | ||
| 4011 || [20.0.0+] | |||
|- | |||
| 4012 || [20.0.0+] | |||
|- | |||
| 4013 || [20.0.0+] | |||
|- | |||
| 4015 || [20.0.0+] | |||
|- | |||
| 4017 || [20.0.0+] | |||
|- | |||
| 4019 || [20.0.0+] | |||
|- | |||
| 4020 || [20.0.0+] | |||
|- | |||
| 4021 || [20.0.0+] | |||
|- | |||
| 4022 || [20.0.0+] | |||
|- | |||
| 4023 || [20.0.0+] | |||
|- | |||
| 4024 || [20.0.0+] | |||
|- | |||
| 4025 || [20.0.0+] | |||
|- | |||
| 4026 || [20.0.0+] | |||
|- | |||
| 4027 || [20.0.0+] | |||
|- | |||
| 4028 || [20.0.0+] | |||
|- | |||
| 4029 || [20.0.0+] | |||
|- | |||
| 4030 || [20.0.0+] | |||
|- | |||
| 4031 || [20.0.0+] | |||
|- | |||
| 4032 || [20.0.0+] | |||
|- | |||
| 4033 || [20.0.0+] | |||
|- | |||
| 4034 || [20.0.0+] | |||
|- | |||
| 4035 || [20.0.0+] | |||
|- | |||
| 4037 || [20.0.0+] | |||
|- | |||
| 4038 || [20.0.0+] | |||
|- | |||
| 4039 || [20.0.0+] | |||
|- | |||
| 4040 || [20.0.0+] | |||
|- | |||
| 4041 || [20.0.0+] | |||
|- | |||
| 4042 || [20.0.0+] | |||
|- | |||
| 4043 || [20.0.0+] | |||
|- | |||
| 4044 || [20.0.0+] | |||
|- | |||
| 4045 || [20.0.0+] | |||
|- | |||
| 4046 || [20.0.0+] | |||
|- | |||
| 4049 || [20.0.0+] | |||
|- | |||
| 4050 || [20.0.0+] | |||
|- | |||
| 4051 || [20.0.0+] | |||
|- | |||
| 4052 || [20.0.0+] | |||
|- | |||
| 4053 || [20.0.0+] | |||
|- | |||
| 4054 || [20.0.0+] | |||
|- | |||
| 4055 || [20.0.0+] | |||
|- | |||
| 4056 || [20.0.0+] | |||
|- | |||
| 4057 || [20.0.0+] | |||
|- | |||
| 4058 || [20.0.0+] | |||
|- | |||
| 4059 || [20.0.0+] | |||
|- | |||
| 4060 || [20.0.0+] | |||
|- | |||
| 4061 || [20.0.0+] | |||
|- | |||
| 4062 || [20.0.0+] | |||
|- | |||
| 4063 || [20.0.0+] | |||
|- | |||
| 4064 || [20.0.0+] | |||
|- | |||
| 4065 || [20.0.0+] | |||
|- | |||
| 4066 || [20.0.0+] | |||
|- | |||
| 4067 || [20.0.0+] | |||
|- | |||
| 4068 || [20.0.0+] | |||
|- | |||
| 4069 || [20.0.0+] | |||
|- | |||
| 4070 || [20.0.0+] | |||
|- | |||
| 4071 || [20.0.0+] | |||
|- | |||
| 4072 || [20.0.0+] | |||
|- | |||
| 4073 || [20.0.0+] | |||
|- | |||
| 4074 || [20.0.0+] | |||
|- | |||
| 4075 || [20.0.0+] | |||
|- | |||
| 4076 || [20.0.0+] | |||
|- | |||
| 4077 || [20.0.0+] | |||
|- | |||
| 4078 || [20.0.0+] | |||
|- | |||
| 4079 || [20.0.0+] | |||
|- | |||
| 4080 || [20.0.0+] | |||
|- | |||
| 4081 || [20.0.0+] | |||
|- | |||
| 4083 || [20.0.0+] | |||
|- | |||
| 4084 || [20.0.0+] | |||
|- | |||
| 4085 || [20.0.0+] | |||
|- | |||
| 4086 || [20.0.0+] | |||
|- | |||
| 4087 || [20.0.0+] | |||
|- | |||
| 4088 || [20.0.0+] | |||
|- | |||
| 4089 || [20.0.0+] | |||
|- | |||
| 4090 || [20.0.0+] | |||
|- | |||
| 4091 || [20.0.0+] | |||
|- | |||
| 4092 || [20.0.0+] | |||
|- | |||
| 4093 || [20.0.0+] | |||
|- | |||
| 4094 || [20.0.0+] | |||
|- | |||
| 4095 || [20.0.0+] | |||
|- | |||
| 4096 || [20.0.0+] | |||
|- | |||
| 4097 || [20.0.0+] | |||
|- | |||
| 5000 || [18.0.0+] | |||
|- | |||
| 5001 || [18.0.0+] | |||
|- | |||
| 9999 || [10.0.0-10.2.0] GetApplicationCertificate | |||
|} | |||
[4.0.0+] RequestDownloadAddOnContent now takes an additional 8-bytes of input. | |||
==== | ==== GetApplicationRecordUpdateSystemEvent ==== | ||
No input | No input, returns an output Event handle with EventClearMode=1. | ||
==== | ==== GetApplicationViewDeprecated ==== | ||
Takes a type-0x6 output buffer containing an array of [[#ApplicationViewDeprecated]], a type-0x5 input buffer containing an array of u64 [[NCM_services#ApplicationId|ApplicationIds]], no output. | |||
On newer system-versions this is the same as [[#GetApplicationView]], except this converts the output from the func called in the loop from [[#ApplicationView]] to [[#ApplicationViewDeprecated]]. | |||
==== | ==== DeleteApplicationEntity ==== | ||
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output. | Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output. | ||
==== | ==== DeleteApplicationCompletely ==== | ||
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output. | Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output. | ||
==== | ==== DeleteRedundantApplicationEntity ==== | ||
No input/output. | No input/output. | ||
==== | ==== IsApplicationEntityMovable ==== | ||
Takes an input u8 [[NCM_services#StorageId|StorageId]], returns | Takes an input u8 [[NCM_services#StorageId|StorageId]], an [[NCM_services#ApplicationId|ApplicationId]], returns an output u8 bool. | ||
==== MoveApplicationEntity ==== | |||
Takes an input u8 [[NCM_services#StorageId|StorageId]], an [[NCM_services#ApplicationId|ApplicationId]], no output. | |||
==== | ==== RequestApplicationUpdateInfo ==== | ||
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[# | Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncValue]]. | ||
The data that can be read from the [[#IAsyncValue]] is [[#ApplicationUpdateInfo]]. | |||
Before using the cmd, official sw uses [[Network_Interface_services#IsAnyInternetRequestAccepted|IsAnyInternetRequestAccepted]] with the output from [[Network_Interface_services#GetClientId|GetClientId]], throwing an error when the returned bool is false. | |||
[ | ==== CancelApplicationDownload ==== | ||
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output. | |||
[ | ==== ResumeApplicationDownload ==== | ||
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output. | |||
==== | ==== CheckApplicationLaunchVersion ==== | ||
Takes an input [[NCM_services#ApplicationId|ApplicationId]], | Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output. | ||
[ | ==== CalculateApplicationDownloadRequiredSize ==== | ||
Takes an input u8 [[NCM_services#StorageId|StorageId]], an [[NCM_services#ApplicationId|ApplicationId]], returns an output s64. | |||
==== CleanupSdCard ==== | |||
No input/output. | |||
==== | ==== GetSdCardMountStatusChangedEvent ==== | ||
No input, returns an output Event handle with EventClearMode=0. | |||
==== GetGameCardUpdateDetectionEvent ==== | |||
No input, returns an output Event handle with EventClearMode=0. | |||
[ | ==== DisableApplicationAutoDelete ==== | ||
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output. | |||
[ | ==== EnableApplicationAutoDelete ==== | ||
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output. | |||
==== | ==== SetApplicationTerminateResult ==== | ||
[ | Takes an input u32 Result, an [[NCM_services#ApplicationId|ApplicationId]], no output. | ||
[ | ==== ClearApplicationTerminateResult ==== | ||
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output. | |||
==== | ==== GetLastSdCardMountUnexpectedResult ==== | ||
No input/output. | No input/output. | ||
==== GetRequestServerStopper ==== | |||
No input, returns an output [[#IRequestServerStopper]]. | |||
==== CancelApplicationApplyDelta ==== | |||
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output. | |||
[[NCM_services# | ==== ResumeApplicationApplyDelta ==== | ||
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output. | |||
==== CalculateApplicationApplyDeltaRequiredSize ==== | |||
Takes an input u8 [[NCM_services#StorageId|StorageId]], an [[NCM_services#ApplicationId|ApplicationId]], returns an output s64. | |||
==== | ==== ResumeAll ==== | ||
No input/output. | |||
==== GetStorageSize ==== | |||
Takes an input u8 [[NCM_services#StorageId|StorageId]], returns two output s64s. | |||
This temporarily mounts the [[Filesystem_services#OpenContentStorageFileSystem|ContentStorage]] specified by the StorageId (must be BuiltInUser or SdCard). The two output s64s are the output from [[Filesystem_services#GetTotalSpaceSize|GetTotalSpaceSize]] and [[Filesystem_services#GetFreeSpaceSize|GetFreeSpaceSize]] with this ContentStorage, with it this being unmounted afterwards. | |||
==== | ==== RequestUpdateApplication2 ==== | ||
Takes an input | Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncResult]]. | ||
See [[#RequestApplicationUpdateInfo]] regarding nifm. | |||
==== | ==== LaunchApplication ==== | ||
Takes an input [[ | Takes an input u8 ProgramIndex, an input [[#ApplicationLaunchInfo]], returns an output u64. | ||
[18.0.0+] Now takes a total of 0x58 bytes of input. | |||
[19.0.0+] Now takes a total of 0x88 bytes of input. | |||
==== GetApplicationLaunchInfo ==== | |||
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output [[#ApplicationLaunchInfo]]. | |||
[18.0.0+] Now returns a total of 0x50 bytes of output. | |||
[19.0.0+] Now returns a total of 0x80 bytes of output. | |||
==== AcquireApplicationLaunchInfo ==== | |||
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output [[#ApplicationLaunchInfo]]. | |||
This is | This verifies that a state flag is set and that a state field matches the input ApplicationId, throwing an error otherwise. The [[#ApplicationLaunchInfo]] from state is copied to output, then the state flag is cleared. | ||
[18.0.0+] Now returns a total of 0x50 bytes of output. | |||
[19.0.0+] Now returns a total of 0x80 bytes of output. | |||
==== GetMainApplicationProgramIndexByApplicationLaunchInfo ==== | |||
[18.0.0+] Now takes a total of 0x50 bytes of input. | |||
[19.0.0+] Now returns a total of 0x80 bytes of output. | |||
==== | ==== LaunchDevMenu ==== | ||
No input/output. | |||
This is used by AM cmd [[Applet_Manager_services#LaunchDevMenu|LaunchDevMenu]]. | |||
This loads ProgramIds from [[System_Settings|system-settings]] <code>ns.applet!devmenu_id</code> and <code>ns.applet!devoverlaydisp_id</code>, which only exists on devunits. An error is thrown if loading these fail. | |||
[ | |||
[[NCM_services#ncm|OpenContentMetaDatabase]] is used with StorageId = NandSystem, then IContentMetaDatabase GetLatestContentMetaKey is used with both of the above ProgramIds to verify that the cmd is successful. | |||
[[ | Then if the above succeeds, the above titles are launched with the above StorageId via [[Process_Manager_services|pmshell]] LaunchProgram ([10.0.0+] [[PGL_services#LaunchProgram|pgl]] with pgl_launch_flags=0), with a 0.5s sleep-thread afterwards on success. [[Process_Manager_services#LaunchFlags|LaunchFlags]] value 0xB is used here. | ||
==== DeleteUserSaveDataAll ==== | |||
Takes an input [[Account_services#Uid|Uid]], returns an output [[#IProgressMonitorForDeleteUserSaveDataAll]]. | |||
On success, [[#IProgressMonitorForDeleteUserSaveDataAll]] GetProgress is used with the output being copied into object state. | |||
==== DeleteUserSystemSaveData ==== | |||
Takes an input [[Account_services#Uid|Uid]], an u64 SystemSaveDataId, no output. | |||
==== DeleteSaveData ==== | |||
Takes an input u8 [[Filesystem_services#SaveDataSpaceId|SaveDataSpaceId]], an u64 SaveDataId, no output. | |||
==== | ==== UnregisterNetworkServiceAccount ==== | ||
Takes an input | Takes an input [[Account_services#Uid|Uid]], no output. | ||
==== UnregisterNetworkServiceAccountWithUserSaveDataDeletion ==== | |||
Takes an input [[Account_services#Uid|Uid]], no output. | |||
==== LaunchLibraryApplet ==== | |||
Takes an input u64 [[NCM_services#ProgramId|ProgramId]], returns an output u64. | |||
The | The specified program is launched with StorageId=BuiltInSystem via [[Process_Manager_services|pmshell]] LaunchProgram ([10.0.0+] [[PGL_services#LaunchProgram|pgl]] with pgl_launch_flags=0). [[Process_Manager_services#LaunchFlags|LaunchFlags]] value 0x9 is used here. The output u64 from here is written to the output for this cmd, on success. | ||
This is used by [[Applet_Manager_services|AM]]. | |||
==== LaunchSystemApplet ==== | |||
No input, returns an output u64. | |||
A state flag must be non-zero, otherwise an error is thrown. When a state field is value 1, a hard-coded ProgramId for MaintenanceMenu is used. Otherwise, the ProgramId is loaded from [[System_Settings|system-setting]] <code>ns.applet!system_applet_id</code> ([20.0.0+] <code>ns.applet!system_applet_id_gen2</code>). | |||
The SystemApplet is launched with StorageId=BuiltInSystem via [[Process_Manager_services|pmshell]] LaunchProgram ([10.0.0+] [[PGL_services#LaunchProgram|pgl]] with pgl_launch_flags=0). [[Process_Manager_services#LaunchFlags|LaunchFlags]] value 0x9 is used here. The output u64 from here is written to the output for this cmd, on success. | |||
This is used by [[Applet_Manager_services|AM]]. | |||
==== LaunchOverlayApplet ==== | |||
No input, returns an output u64. | |||
A state flag must be non-zero, otherwise an error is thrown. The ProgramId is loaded from [[System_Settings|system-setting]] <code>ns.applet!overlay_applet_id</code>. | |||
= | The OverlayApplet is launched with StorageId=BuiltInSystem via [[Process_Manager_services|pmshell]] LaunchProgram ([10.0.0+] [[PGL_services#LaunchProgram|pgl]] with pgl_launch_flags=0). [[Process_Manager_services#LaunchFlags|LaunchFlags]] value 0x9 is used here. The output u64 from here is written to the output for this cmd, on success. | ||
This is used by [[Applet_Manager_services|AM]]. | |||
==== | ==== RequestDownloadApplicationControlData ==== | ||
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncResult]]. | |||
See [[#RequestApplicationUpdateInfo]] regarding nifm. | |||
==== | ==== GetApplicationControlProperty ==== | ||
[18.0.0+] Now takes a total of 0x58 bytes of input. | |||
==== | ==== ListApplicationTitle ==== | ||
Takes an input TransferMemory handle, a type-0x5 input buffer containing an array of u64 [[NCM_services#ApplicationId|ApplicationIds]], an u8 [[#ApplicationControlSource]], an u64 size, returns an output Event handle and an [[#IAsyncValue]]. | |||
[[qlaunch]] uses value 0x1 for the u8. | |||
= | The user-process creates the TransferMemory with permissions=R--. | ||
The data available with [[#IAsyncValue]] Get is a s32 for the offset within the TransferMemory where the output data is located, GetSize returns the total byte-size of the data located here. The data located here is the [[NACP_Format|NACP]] title-entry for each specified ApplicationId. | |||
The TransferMemory size must be at least: count*sizeof([[NACP_Format|title-entry]]) + count*sizeof(u64) + count*[[#GetApplicationControlData|0x24000]]. | |||
[ | |||
[ | This is essentially an async wrapper for [[#GetApplicationControlData]], with support for multiple ApplicationIds. | ||
==== | ==== ListApplicationIcon ==== | ||
Takes an input TransferMemory handle, a type-0x5 input buffer containing an array of u64 [[NCM_services#ApplicationId|ApplicationIds]], an u8 [[#ApplicationControlSource]], an u64 size, returns an output Event handle and an [[#IAsyncValue]]. | |||
= | The user-process creates the TransferMemory with permissions=R--. | ||
The data available with [[#IAsyncValue]] Get is a s32 for the offset within the TransferMemory where the output data is located, GetSize returns the total byte-size of the data located here. This data is: an u64 for total entries, an array of u64s for each icon size, then the icon JPEGs for the specified ApplicationIds. | |||
The | The TransferMemory size must be at least: 0x4 + count*sizeof(u64) + count*[[#GetApplicationControlData|0x20000]] + count*sizeof(u64) + [[#GetApplicationControlData|0x24000]]. | ||
This is essentially an async wrapper for [[#GetApplicationControlData]], with support for multiple ApplicationIds. | |||
==== | ==== RequestCheckGameCardRegistration ==== | ||
Takes an input | Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncResult]]. | ||
See [[#RequestApplicationUpdateInfo]] regarding nifm. | |||
==== | ==== RequestGameCardRegistrationGoldPoint ==== | ||
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[# | Takes an input [[Account_services#Uid|Uid]], an [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncValue]]. | ||
The data that can be read from the [[#IAsyncValue]] is 4-bytes. | |||
See [[#RequestApplicationUpdateInfo]] regarding nifm. | |||
==== RequestRegisterGameCard ==== | |||
Takes an input s32, an [[Account_services#Uid|Uid]], an [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncResult]]. | |||
See [[#RequestApplicationUpdateInfo]] regarding nifm. | |||
==== | ==== GetGameCardMountFailureEvent ==== | ||
No input, returns an output Event handle with EventClearMode=0. | |||
==== | ==== IsGameCardInserted ==== | ||
No input, returns an output u8 bool. | |||
==== EnsureGameCardAccess ==== | |||
No input/output. | |||
==== | ==== GetLastGameCardMountFailureResult ==== | ||
No input/output. | No input/output. | ||
==== | ==== ListApplicationIdOnGameCard ==== | ||
Takes a type-0x6 output buffer containing an array of u64 [[NCM_services#ApplicationId|ApplicationIds]], returns an output s32 for total output entries. | |||
==== | ==== GetGameCardPlatformRegion ==== | ||
No input | No input, returns an u8 '''GameCardPlatformRegion''' (0x00 = Global, 0x01 = China). | ||
This calls [[Filesystem_services#IDeviceOperator|fsp-srv IDeviceOperator]] GetGameCardCompatibilityType and returns the result. | |||
==== | ==== ListAvailableAddOnContent ==== | ||
[10.0.0+] This now takes a total of 0x10-bytes of input instead of a total of 0x18-bytes of input. | |||
[15.0.0+] This now takes a total of 0x8-bytes of input instead of a total of 0x10-bytes of input. | |||
==== | ==== RequestDownloadTaskListData ==== | ||
No input, returns an output Event handle and an [[#IAsyncValue]]. | |||
==== TouchApplication ==== | |||
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output. | |||
==== | ==== IsApplicationUpdateRequested ==== | ||
Takes | Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output u8 bool and an u32. | ||
The output u32 is only valid when the output bool is set. | |||
==== | ==== WithdrawApplicationUpdateRequest ==== | ||
Takes | Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output. | ||
[ | ==== RequestVerifyApplicationDeprecated ==== | ||
Takes an input TransferMemory handle, an [[NCM_services#ApplicationId|ApplicationId]], an u64 size, returns an output Event handle and an [[#IProgressAsyncResult]]. | |||
On newer system-versions this calls the same func as [[#RequestVerifyApplication]], with the u32 value set to 0x7. | |||
==== RequestVerifyAddOnContentsRights ==== | |||
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IProgressAsyncResult]]. | |||
==== | ==== RequestVerifyApplication ==== | ||
Takes | Takes an input TransferMemory handle, an u32, an [[NCM_services#ApplicationId|ApplicationId]], an u64 size, returns an output Event handle and an [[#IProgressAsyncResult]]. | ||
Official sw creates the TransferMemory with an user-specified buffer with permissions=0. [[qlaunch]] uses buffer size 0x100000. | |||
Official sw has an additional wrapper func which calls the original wrapper func, this uses value 0x7 for the u32. This is the same func used by [[qlaunch]]. | |||
==== IsAnyApplicationEntityInstalled ==== | |||
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output u8 bool. | |||
==== | ==== CleanupUnavailableAddOnContents ==== | ||
Takes | Takes an input u64 [[NCM_services#ApplicationId|ApplicationId]], an [[Account_services#Uid|Uid]], no output. | ||
==== RequestMoveApplicationEntity ==== | |||
Takes an input TransferMemory handle, a type-0x5 input buffer containing an array of [[NCM_services#StorageId|StorageId]], a [[NCM_services#StorageId|StorageId]], an u32 bitfield of "nn::ns::KeepApplicationEntityFlagTag", an [[NCM_services#ApplicationId|ApplicationId]], an u64 tmem_size, returns an output Event handle and an [[#IProgressAsyncResult]]. | |||
= | The TransferMemory uses permissions=0. | ||
==== EstimateSizeToMove ==== | |||
Takes a type-0x5 input buffer containing an array of [[NCM_services#StorageId|StorageId]], a [[NCM_services#StorageId|StorageId]], an u32 bitfield of "nn::ns::KeepApplicationEntityFlagTag", an [[NCM_services#ApplicationId|ApplicationId]], returns an output s64. | |||
This calls a func also used by [[#RequestMoveApplicationEntity]], then calls another func. | |||
==== FormatSdCard ==== | |||
No input/output. | |||
==== | ==== NeedsSystemUpdateToFormatSdCard ==== | ||
No input, returns an output u8 bool. | |||
==== GetLastSdCardFormatUnexpectedResult ==== | |||
No input/output. | |||
==== GetApplicationView ==== | |||
Takes a type-0x6 output buffer containing an array of [[#ApplicationView]], a type-0x5 input buffer containing an array of u64 [[NCM_services#ApplicationId|ApplicationIds]], no output. | |||
==== | ==== GetApplicationViewDownloadErrorContext ==== | ||
Takes | Takes a type-0x16 output buffer containg an [[Error_Applet#ErrorContext|ErrorContext]], an u64 [[NCM_services#ApplicationId|ApplicationId]], no output. | ||
==== GetApplicationViewWithPromotionInfo ==== | |||
Takes a type-0x6 output buffer containing an array of [[#ApplicationViewWithPromotionInfo]], a type-0x5 input buffer containing an array of u64 [[NCM_services#ApplicationId|ApplicationIds]], no output. | |||
==== | ==== IsPatchAutoDeletableApplication ==== | ||
Takes | Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output bool. | ||
Compares the input ApplicationId with the value of [[System_Settings|system-setting]] <code>ns.application!auto_deletable_application_id_on_not_enough_space</code>, with the bool being set to the comparsion result. | |||
==== ListLastNotificationInfo ==== | |||
Takes a type-0x6 buffer containing an array with struct entry size 0x90-bytes. Returns 4-bytes of output. | |||
[19.0.0+] The struct size is now 0x98-bytes. | |||
==== | ==== ListNotificationTask ==== | ||
Takes a type- | Takes a type-0x6 buffer containing an array with struct entry size 0xB0-bytes. Returns 4-bytes of output. | ||
The | [19.0.0+] The struct size is now 0xB8-bytes. | ||
==== RequestDownloadApplicationPrepurchasedRights ==== | |||
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncResult]]. | |||
See [[#RequestApplicationUpdateInfo]] regarding nifm. | |||
==== GetSystemDeliveryInfo ==== | |||
Takes a type-0x16 output buffer containing a [[#SystemDeliveryInfo]], no output. | |||
This generates a [[#SystemDeliveryInfo]] using the currently installed SystemUpdate meta title. | |||
[[ | ==== SelectLatestSystemDeliveryInfo ==== | ||
Takes a type-0x15 input buffer containing a [[#SystemDeliveryInfo]], a type-0x5 input buffer containing an array of [[#SystemDeliveryInfo]], a type-0x5 input buffer containing an array of [[#ApplicationDeliveryInfo]], and returns an output s32. | |||
This determines the latest version from the input [[#ApplicationDeliveryInfo]] array, using value 0 if the array is empty. If this value is less than a state field, the state field value is used instead. Then this selects a [[#SystemDeliveryInfo]] with the latest version from the input array, where the minimum version is the previously mentioned value. The version must also be also be at least the version value from the type-0x15 [[#SystemDeliveryInfo]] buffer. This also does various validation, etc. The output s32 is an index in that array for the selected entry, -1 if none found. | |||
==== VerifyDeliveryProtocolVersion ==== | |||
Takes a type-0x15 input buffer containing a [[#SystemDeliveryInfo]], no output. | |||
This | This validates the [[#SystemDeliveryInfo]] HMAC and the protocol-version fields. Then the meta version is compared with a state field, an error is returned on match otherwise 0 is returned. | ||
==== GetApplicationDeliveryInfo ==== | |||
Takes a type-0x6 output buffer containing an array of [[#ApplicationDeliveryInfo]], an input u32 bitmask <code>nn::ns::ApplicationDeliveryAttributeTag</code>, an [[NCM_services#ApplicationId|ApplicationId]], and returns an output s32 total_out. | |||
An error is thrown if any bit is set in ApplicationDeliveryAttributeTag besides bit1. The output array-count must be at least 1: only 1 entry will be written to this array (hence on success total_out will also only be 1 on success). | |||
==== | ==== HasAllContentsToDeliver ==== | ||
Takes an | Takes a type-0x5 input buffer containing an array of [[#ApplicationDeliveryInfo]], returns an output u8 bool. | ||
The array-count must match 1. After validating the [[#ApplicationDeliveryInfo]], the output bool is set to u32 [[#ApplicationDeliveryInfo]]+0x1C & 0x10000002 != 0x2, then this returns 0. | |||
==== CompareApplicationDeliveryInfo ==== | |||
Takes two type-0x5 input buffers containing an array of [[#ApplicationDeliveryInfo]], returns an output s32. | |||
The array-count for both buffers must be 1, otherwise an error is returned. | |||
[[ | Both [[#ApplicationDeliveryInfo]] are validated, then the application-version in the first/second buffer are compared. The output s32 is set to the comparison result: -1 for less than, 0 for equal, and 1 for higher than. | ||
==== CanDeliverApplication ==== | |||
Takes two type-0x5 input buffers containing an array of [[#ApplicationDeliveryInfo]], returns an output u8 bool. | |||
The | The array-count for the second buffer must be 1 and the array-count for the first buffer must be <=1, otherwise an error is returned. If the array-count for the first buffer is 0, this will return 0 with the output bool set to 0. | ||
==== ListContentMetaKeyToDeliverApplication ==== | |||
Takes a type-0x6 output buffer containing an array of [[NCM_services#ContentMetaKey|ContentMetaKey]], a type-0x5 input buffer containing an array of [[#ApplicationDeliveryInfo]], a s32, and returns an output s32 total_out. | |||
The array-count for ContentMetaKey must be at least 1, and for ApplicationDeliveryInfo it must match 1. | |||
This will only return 1 ContentMetaKey entry. This will not output the entry when the input s32 is larger than 0. This also does other validation, etc. | |||
==== NeedsSystemUpdateToDeliverApplication ==== | |||
Takes a type-0x15 input buffer containing a [[#SystemDeliveryInfo]], a type-0x5 input buffer containing an array of [[#ApplicationDeliveryInfo]], and returns an output u8 bool. | |||
The array-count must match 1. | |||
After validation etc, this sets the output bool by comparing system-version fields in the [[#SystemDeliveryInfo]]/[[#ApplicationDeliveryInfo]] and with a state field. | |||
==== | ==== EstimateRequiredSize ==== | ||
Takes a type- | Takes a type-0x5 input buffer containing an array of [[NCM_services#ContentMetaKey|ContentMetaKey]], returns an output s64. | ||
When the array-count is less than 1, this will return 0 with the s64 set to 0. | |||
==== | ==== RequestReceiveApplication ==== | ||
Takes a type-0x5 input buffer containing an array of [[# | Takes a type-0x5 input buffer containing an array of [[NCM_services#ContentMetaKey|ContentMetaKey]], a [[NCM_services#StorageId|StorageId]], an u16 port, an u32 Ipv4Address, an [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncResult]]. | ||
[[qlaunch]] uses value Any for the StorageId, and value 55556 for the port. | |||
An error is thrown if a state ref-count is zero. An error is thrown if [[NIM_services|nim]] ListApplicationApplyDeltaTask returns a task. | |||
This loops through the input [[NCM_services#ContentMetaKey|ContentMetaKey]] array, throwing an error if the [[NCM_services#ContentMetaType|ContentMetaType]] doesn't match Patch. The input array is copied into state which is used later by the thread for [[NIM_services|nim]] cmd53, max entries is 0x12. | |||
This does various setup then creates the [[#IAsyncResult]] + the async thread which handles the [[#IAsyncResult]] operation. Then the thread does: | |||
* Calls a func which does: | |||
** Throws an error if a state flag is set. | |||
** Uses [[NIM_services|nim]] cmd53, returning the Result on failure. | |||
** Uses [[NIM_services|nim]] cmd56, returning the Result on failure. Waits for the IAsyncResult operation from this to finish, then uses the Get cmd to get the output Result. | |||
** Handles cleanup and returns. | |||
* On success, this loads various data which is then used for saving a SystemPlayReport when the cached [[System_Settings|system-setting]] "systemreport!enabled" is set. | |||
** The EventId is "receive_app_contents" with ApplicationId <NS ProgramId>. | |||
==== | ==== CommitReceiveApplication ==== | ||
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output. | |||
[ | ==== GetReceiveApplicationProgress ==== | ||
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output [[#ReceiveApplicationProgress]]. | |||
An error is thrown if a state ref-count is zero. An error is thrown if [[NIM_services|nim]] ListApplicationApplyDeltaTask returns a task. | |||
Uses [[NIM_services|nim]] cmd67, throwing an error if no task is returned. Then [[NIM_services|nim]] cmd57 is used, returning the error from there on failure. Lastly, this writes the 0x10-bytes from output+8 from the latter cmd to the output [[#ReceiveApplicationProgress]], and returns 0. | |||
==== RequestSendApplication ==== | |||
Takes a type-0x5 input buffer containing an array of [[NCM_services#ContentMetaKey|ContentMetaKey]], an u16 port, an u32 Ipv4Address, an [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncResult]]. | |||
[[qlaunch]] uses value 55556 for the port. | |||
An error is thrown if a state ref-count is zero. An error is thrown if [[NIM_services|nim]] ListApplicationApplyDeltaTask returns a task. | |||
The [[NCM_services#ContentMetaType|ContentMetaType]] must match Patch. | |||
This does various setup and selects a ContentMetaKey to use from the input, then creates the [[#IAsyncResult]] + the async thread which handles the [[#IAsyncResult]] operation. Then the thread does: | |||
* Calls a func which does: | |||
** Throws an error if a state flag is set. | |||
** Uses [[NIM_services|nim]] cmd60, returning the Result on failure. | |||
** Uses [[NIM_services|nim]] cmd61, returning the Result on failure. Waits for the IAsyncResult operation from this to finish, then uses the Get cmd to get the output Result. | |||
** Handles cleanup and returns. | |||
* On success, this loads various data which is then used for saving a SystemPlayReport when the cached [[System_Settings|system-setting]] "systemreport!enabled" is set. | |||
** The EventId is "send_app_contents" with ApplicationId <NS ProgramId>. | |||
==== | ==== GetSendApplicationProgress ==== | ||
Takes | Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output [[#SendApplicationProgress]]. | ||
Same as [[#GetReceiveApplicationProgress]] except this is the Send version, and uses [[NIM_services|nim]] cmd68/cmd63 instead. | |||
==== | ==== CompareSystemDeliveryInfo ==== | ||
Takes two type-0x15 input buffers containing a [[#SystemDeliveryInfo]], returns an output s32. | |||
This is essentially the same as [[#CompareApplicationDeliveryInfo]], except this compares the [[#SystemDeliveryInfo]] SystemUpdate version. | |||
==== ListNotCommittedContentMeta ==== | |||
Takes a type-0x6 output buffer containing an array of [[NCM_services#ContentMetaKey|ContentMetaKey]], a s32, an [[NCM_services#ApplicationId|ApplicationId]], returns an output s32 total_out. | |||
==== | ==== RecoverDownloadTask ==== | ||
Takes an input | Takes a type-0x5 input buffer containing an array of {unknown} and an input u64, no output. | ||
==== | ==== GetApplicationDeliveryInfoHash ==== | ||
Takes | Takes a type-0x5 input buffer containing an array of [[#ApplicationDeliveryInfo]], returns an output 0x20-byte SHA256 hash. | ||
This extracts data from the input array for hashing with SHA256, with validation being done when handling each entry. | |||
[ | ==== GetApplicationRightsOnClient ==== | ||
Takes a type-0x6 output buffer containing an array of [[#ApplicationRightsOnClient]], an input u32 flags, an [[NCM_services#ApplicationId|ApplicationId]], an [[Account_services#Uid|Uid]], returns 4-bytes of output for total output entries. | |||
Official sw has at least two wrappers which use this cmd: one with an all-zero Uid, one with an user-specified Uid. With both of these, the passed flags are hard-coded to value 0x3. | |||
[ | For the output array count, [[qlaunch]] uses value 3. | ||
==== | ==== GetApplicationTerminateResult ==== | ||
Takes | Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output u32 Result. | ||
==== GetRightsEnvironmentHandleForApplication ==== | |||
No input, returns a total of 8-bytes of output. | |||
[9.0.0+] Now takes a total of 8-bytes of input, returns a total of 8-bytes of output. | |||
==== | ==== RequestNoDownloadRightsErrorResolution ==== | ||
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncValue]]. | |||
The data that can be read from the [[#IAsyncValue]] is [[#NoDownloadRightsErrorResolution]]. | |||
See [[#RequestApplicationUpdateInfo]] regarding nifm. | |||
==== RequestResolveNoDownloadRightsError ==== | |||
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncValue]]. | |||
The data that can be read from the [[#IAsyncValue]] is [[#NoDownloadRightsErrorResolution]]. | |||
See [[#RequestApplicationUpdateInfo]] regarding nifm. | |||
==== | ==== GetPromotionInfo ==== | ||
Takes a type-0x6 output buffer containing an array of [[#PromotionInfo]], a type-0x5 input buffer containing an array of u64 [[NCM_services#ApplicationId|ApplicationIds]], a type-0x5 input buffer containing an array of [[Account_services#Uid|Uids]], no output. | |||
Official sw uses hard-coded value 1 for the count with each of these arrays. | |||
==== | ==== ListPromotionInfo ==== | ||
[20.0.0+] The struct size for the output buffer array is now 0x28-bytes instead of 0x20-bytes. | |||
==== | ==== ImportPromotionJsonForDebug ==== | ||
Takes a type-0x5 input buffer, no output. | |||
The output from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned. | |||
==== | ==== ClearPromotionInfoForDebug ==== | ||
No input/output. | No input/output. | ||
The output from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned. | |||
This just clears 0xC-bytes in state. | |||
==== | ==== CreateApplicationResource ==== | ||
Takes an input [[#ApplicationResourceType]]. Returns an [[#IApplicationResource]]. | |||
==== | ==== GetApplicationResource ==== | ||
Takes an input u64 ProcessId and an input [[#ApplicationResourceType]]. Returns an [[#IApplicationResource]]. | |||
==== | ==== LaunchMicroApplication ==== | ||
[18.0.0+] Now takes a total of 0x50 bytes of input. | |||
[19.0.0+] Now takes a total of 0x80 bytes of input. | |||
=== | ==== CreateApplicationInstance ==== | ||
[18.0.0+] Now takes a total of 0x50 bytes of input. | |||
[19.0.0+] Now takes a total of 0x80 bytes of input. | |||
=== | ==== RegisterDeviceLockKey ==== | ||
Takes a type-0x5 input buffer containing an InArray of u8, no output. | |||
User-processes expose this with two funcs: one which uses an user-specified u8 array directly, while the other uses [[HID_services#NpadButtonSet|NpadButton]]. | |||
This does SHA256 hashing, etc. | |||
This | |||
==== UnregisterDeviceLockKey ==== | |||
No input/output. | |||
Runs code identical to [[#RegisterDeviceLockKey]], except the passed buffer/size are 0. | |||
==== VerifyDeviceLockKey ==== | |||
Takes a type-0x5 input buffer containing an InArray of u8, no output. | |||
User-processes expose this with two funcs: one which uses an user-specified u8 array directly, while the other uses [[HID_services#NpadButtonSet|NpadButton]]. | |||
This runs hashing similar to [[#RegisterDeviceLockKey]], with the calculated hash being verified with the one from state. | |||
==== HideApplicationIcon ==== | |||
No input/output. | |||
=== | ==== ShowApplicationIcon ==== | ||
No input/output. | |||
==== HideApplicationTitle ==== | |||
No input/output. | |||
=== | ==== ShowApplicationTitle ==== | ||
No input/output. | |||
This | ==== EnableGameCard ==== | ||
No input/output. | |||
==== DisableGameCard ==== | |||
No input/output. | |||
==== EnableLocalContentShare ==== | |||
No input/output. | |||
==== DisableLocalContentShare ==== | |||
No input/output. | |||
==== IsApplicationIconHidden ==== | |||
No input, returns an output bool. | |||
==== IsApplicationTitleHidden ==== | |||
No input, returns an output bool. | |||
==== IsGameCardEnabled ==== | |||
No input, returns an output bool. | |||
==== IsLocalContentShareEnabled ==== | |||
No input, returns an output bool. | |||
Various Deliver cmds now load the same flag used by this cmd (IsLocalContentShareEnabled), with an error being returned when it's not enabled. | |||
=== IGameCardStopper === | |||
This is "nn::ns::detail::IGameCardStopper". | |||
This interface has no commands. | |||
=== IRequestServerStopper === | |||
This is "nn::ns::detail::IRequestServerStopper". | |||
This interface has no commands. | |||
=== IProgressMonitorForDeleteUserSaveDataAll === | |||
This is "nn::ns::detail::IProgressMonitorForDeleteUserSaveDataAll". | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
| Line 1,787: | Line 1,918: | ||
! Cmd || Name | ! Cmd || Name | ||
|- | |- | ||
| 0 || | | 0 || GetSystemEvent | ||
|- | |- | ||
| 1 || | | 1 || IsFinished | ||
|- | |- | ||
| | | 2 || GetResult | ||
|- | |- | ||
| | | 10 || GetProgress | ||
|} | |} | ||
When closing the object, official sw uses IsFinished first, asserting when the output bool is false. | |||
No input, returns an output Event handle | |||
* GetSystemEvent: No input, returns an output Event handle. [[qlaunch]] doesn't use this. | |||
* IsFinished: No input, returns an output u8 bool. | |||
* GetResult: No input/output. | |||
* GetProgress: No input, returns an output [[#ProgressForDeleteUserSaveDataAll]]. Official sw writes this struct directly to object state. | |||
=== | === IProgressAsyncResult === | ||
This is "nn::ns::detail:: | This is "nn::ns::detail::IProgressAsyncResult". | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
| Line 1,826: | Line 1,944: | ||
! Cmd || Name | ! Cmd || Name | ||
|- | |- | ||
| | | 0 || Get | ||
|- | |- | ||
| | | 1 || Cancel | ||
|- | |- | ||
| | | 2 || GetProgress | ||
|- | |- | ||
| | | 3 || GetDetailResult | ||
|- | |- | ||
| | | 4 || [4.0.0+] GetErrorContext | ||
|} | |} | ||
=== | === IApplicationVersionInterface === | ||
This is "nn::ns::detail::IApplicationVersionInterface". | |||
This was added with [4.0.0+]. | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
| Line 1,865: | Line 1,964: | ||
! Cmd || Name | ! Cmd || Name | ||
|- | |- | ||
| | | 0 || GetLaunchRequiredVersion | ||
|- | |||
| 1 || UpgradeLaunchRequiredVersion | |||
|- | |- | ||
| | | 35 || UpdateVersionList | ||
|- | |- | ||
| | | 36 || PushLaunchVersion | ||
|- | |- | ||
| | | 37 || ListRequiredVersion | ||
|- | |||
| 800 || RequestVersionList | |||
|- | |||
| 801 || ListVersionList | |||
|- | |||
| 802 || [[#RequestVersionListData]] | |||
|- | |||
| 900 || [12.0.0+] ImportAutoUpdatePolicyJsonForDebug | |||
|- | |||
| 901 || [12.0.0+] ListDefaultAutoUpdatePolicy | |||
|- | |||
| 902 || [12.0.0+] ListAutoUpdatePolicyForSpecificApplication | |||
|- | |||
| 1000 || PerformAutoUpdate | |||
|- | |||
| 1001 || [11.0.0+] ListAutoUpdateSchedule | |||
|} | |} | ||
=== | ==== RequestVersionListData ==== | ||
This is "nn::ns::detail:: | No input, returns an output Event handle and an [[#IAsyncValue]]. | ||
The data that can be read from the [[#IAsyncValue]] is [[#VersionListData]]. | |||
=== IContentManagementInterface === | |||
This is "nn::ns::detail::IContentManagementInterface". | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
| Line 1,881: | Line 2,003: | ||
! Cmd || Name | ! Cmd || Name | ||
|- | |- | ||
| | | 11 || [[#CalculateApplicationOccupiedSize]] | ||
|- | |- | ||
| | | 43 || [[#CheckSdCardMountStatus]] | ||
|- | |- | ||
| | | 47 || [[#GetTotalSpaceSize]] | ||
|- | |- | ||
| | | 48 || [[#GetFreeSpaceSize]] | ||
|- | |- | ||
| | | 58 || [20.1.0+] | ||
|- | |- | ||
| | | 71 || [20.1.0+] | ||
|- | |- | ||
| | | 600 || [[#CountApplicationContentMeta]] | ||
|- | |- | ||
| | | 601 || [[#ListApplicationContentMetaStatus]] | ||
|- | |- | ||
| | | 605 || [[#ListApplicationContentMetaStatusWithRightsCheck]] | ||
|- | |||
| 607 || [[#IsAnyApplicationRunning]] | |||
|} | |} | ||
==== | ==== CalculateApplicationOccupiedSize ==== | ||
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output [[#ApplicationOccupiedSize]]. | |||
==== | ==== CheckSdCardMountStatus ==== | ||
No input/output. | No input/output. | ||
==== | ==== CountApplicationContentMeta ==== | ||
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output s32. | |||
==== | ==== ListApplicationContentMetaStatusWithRightsCheck ==== | ||
Same input/output as [[#ListApplicationContentMetaStatus]]. | |||
==== IsAnyApplicationRunning ==== | |||
No input, returns an output u8 bool. | |||
=== | === IDocumentInterface === | ||
This is "nn::ns::detail::IDocumentInterface". | |||
This is "nn::ns::detail:: | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
! Cmd || Name || | ! Cmd || Name | ||
|- | |||
| 21 || GetApplicationContentPath | |||
|- | |- | ||
| | | 23 || ResolveApplicationContentPath | ||
|- | |- | ||
| | | 92 || [5.0.0+] GetRunningApplicationProgramId | ||
|- | |- | ||
| | | 2524 || [19.0.0+] | ||
|} | |} | ||
=== | === IDownloadTaskInterface === | ||
This is "nn::ns::detail:: | This is "nn::ns::detail::IDownloadTaskInterface". | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
! Cmd || Name || | ! Cmd || Name | ||
|- | |||
| 701 || [[#ClearTaskStatusList]] | |||
|- | |||
| 702 || [[#RequestDownloadTaskList]] | |||
|- | |||
| 703 || [[#RequestEnsureDownloadTask]] | |||
|- | |- | ||
| | | 704 || [[#ListDownloadTaskStatus]] | ||
|- | |- | ||
| | | 705 || [[#RequestDownloadTaskListData]] | ||
|- | |- | ||
| | | 706 || [4.0.0+] [[#TryCommitCurrentApplicationDownloadTask]] | ||
|- | |- | ||
| | | 707 || [4.0.0+] [[#EnableAutoCommit]] | ||
|- | |- | ||
| | | 708 || [4.0.0+] [[#DisableAutoCommit]] | ||
|- | |- | ||
| | | 709 || [4.0.0+] [[#TriggerDynamicCommitEvent]] | ||
|- | |- | ||
| | | 710 || [20.0.0+] | ||
|} | |} | ||
=== | ==== ClearTaskStatusList ==== | ||
No input/output. | |||
This was added with [ | ==== RequestDownloadTaskList ==== | ||
No input/output. | |||
==== RequestEnsureDownloadTask ==== | |||
No input, returns an output Event handle and an [[#IAsyncResult]]. | |||
==== ListDownloadTaskStatus ==== | |||
Takes a type-0x6 output buffer containing an array of [[#DownloadTaskStatus]], returns an output s32 total_out. | |||
A maximum of 0x100 tasks can be stored in state. | |||
==== TryCommitCurrentApplicationDownloadTask ==== | |||
No input/output. | |||
==== EnableAutoCommit ==== | |||
No input/output. | |||
==== DisableAutoCommit ==== | |||
No input/output. | |||
==== TriggerDynamicCommitEvent ==== | |||
No input/output. | |||
=== IReadOnlyApplicationRecordInterface === | |||
This is "nn::ns::detail::IReadOnlyApplicationRecordInterface". | |||
This was added with [5.0.0+]. | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
! Cmd || Name | ! Cmd || Name || Notes | ||
|- | |- | ||
| 0 || [[# | | 0 || HasApplicationRecord || Same as [[#IApplicationManagerInterface]] cmd 910 | ||
|- | |- | ||
| 1 || [ | | 1 || [10.0.0+] NotifyApplicationFailure || | ||
|- | |- | ||
| | | 2 || [10.0.0+] IsDataCorruptedResult || | ||
|- | |- | ||
| | | 3 || [20.0.0+] || | ||
| | |} | ||
=== IReadOnlyApplicationControlDataInterface === | |||
This is "nn::ns::detail::IReadOnlyApplicationControlDataInterface". | |||
This was added with [5.1.0+]. | |||
{| class="wikitable" border="1" | |||
|- | |- | ||
| | ! Cmd || Name || Notes | ||
|- | |- | ||
| | | 0 || [[#GetApplicationControlData]] || Same as [[#IApplicationManagerInterface]] cmd 400 | ||
|- | |- | ||
| | | 1 || [[#GetApplicationDesiredLanguage]] || Same as [[#IApplicationManagerInterface]] cmd 55 | ||
|- | |- | ||
| | | 2 || ConvertApplicationLanguageToLanguageCode || Same as [[#IApplicationManagerInterface]] cmd 59 | ||
|- | |- | ||
| | | 3 || [[#ConvertLanguageCodeToApplicationLanguage]] || Same as [[#IApplicationManagerInterface]] cmd 60 | ||
|- | |- | ||
| | | 4 || [9.0.0+] SelectApplicationDesiredLanguage || | ||
|- | |- | ||
| | | 5 || [19.0.0+] || | ||
|- | |- | ||
| | | 6 || [19.0.0+] || | ||
| | |||
| | |||
|- | |- | ||
| | | 7 || [20.0.0+] || | ||
|- | |- | ||
| | | 8 || [20.0.0+] || | ||
|- | |- | ||
| | | 9 || [20.0.0+] || | ||
|- | |- | ||
| | | 10 || [20.0.0+] || | ||
|- | |- | ||
| | | 11 || [20.0.0+] || | ||
|- | |- | ||
| | | 12 || [20.0.0+] || | ||
|- | |- | ||
| | | 13 || [20.0.0+] || | ||
|- | |- | ||
| | | 14 || [20.0.0+] || | ||
|- | |- | ||
| | | 15 || [20.0.0+] || | ||
|- | |- | ||
| | | 16 || [20.0.0+] || | ||
|- | |- | ||
| | | 17 || [20.1.0+] || | ||
|} | |} | ||
=== | === IDynamicRightsInterface === | ||
This is "nn::ns::detail::IDynamicRightsInterface". | |||
This was added with [6.0.0+]. | |||
== | {| class="wikitable" border="1" | ||
|- | |||
! Cmd || Name | |||
|- | |||
| 0 || [[#RequestApplicationRightsOnServer]] | |||
|- | |||
| 1 || [[#RequestAssignRights]] | |||
|- | |||
| 4 || [[#DeprecatedRequestAssignRightsToResume]] | |||
|- | |||
| 5 || [[#VerifyActivatedRightsOwners]] | |||
|- | |||
| 6 || [[#DeprecatedGetApplicationRightsStatus]] | |||
|- | |||
| 7 || [[#RequestPrefetchForDynamicRights]] | |||
|- | |||
| 8 || [[#GetDynamicRightsState]] | |||
|- | |||
| 9 || [7.0.0+] [[#RequestApplicationRightsOnServerToResume]] | |||
|- | |- | ||
| 10 || [7.0.0+] [[#RequestAssignRightsToResume]] | |||
|- | |- | ||
| | | 11 || [7.0.0+] [[#GetActivatedRightsUsers]] | ||
|- | |- | ||
| | | 12 || [8.0.0+] [[#GetApplicationRightsStatus]] | ||
|- | |- | ||
| | | 13 || [8.0.0+] [[#GetRunningApplicationStatus]] | ||
|- | |- | ||
| | | 14 || [10.0.0-15.0.1] SelectApplicationLicense | ||
|- | |- | ||
| 15 || [12.0.0+] [[#RequestContentsAuthorizationToken]] | |||
|- | |||
| 16 || [13.0.0+] QualifyUser | |||
|- | |||
| 17 || [13.0.0+] QualifyUserWithProcessId | |||
|- | |||
| 18 || [13.0.0+] NotifyApplicationRightsCheckStart | |||
|- | |||
| 19 || [13.0.0+] UpdateUserList | |||
|- | |||
| 20 || [13.0.0+] IsRightsLostUser | |||
|- | |- | ||
| | | 21 || [13.1.0+] SetRequiredAddOnContentsOnContentsAvailabilityTransition | ||
|- | |- | ||
| | | 22 || [14.0.0+] GetLimitedApplicationLicense | ||
|- | |- | ||
| | | 23 || [14.0.0+] GetLimitedApplicationLicenseUpgradableEvent | ||
|- | |- | ||
| | | 24 || [14.0.0+] NotifyLimitedApplicationLicenseUpgradableEventForDebug | ||
|- | |- | ||
| | | 25 || [14.0.0+] RequestProceedDynamicRightsState | ||
|- | |- | ||
| | | 26 || [18.0.0+] HasAccountRestrictedRightsInRunningApplications | ||
|- | |- | ||
| | | 27 || [20.0.0+] | ||
|- | |- | ||
| | | 28 || [20.0.0+] | ||
|} | |} | ||
==== | ==== RequestApplicationRightsOnServer ==== | ||
Takes an input [[Account_services#Uid|Uid]] | Takes an input [[NCM_services#ApplicationId|ApplicationId]], an [[Account_services#Uid|Uid]] and an u32. Returns an output Event handle and an [[#IAsyncValue]]. | ||
==== RequestAssignRights ==== | |||
Takes a type-0x5 input buffer containing an array of "nn::ns::ApplicationRightsOnServer". Returns an output Event handle and an [[#IAsyncResult]]. | |||
==== | ==== DeprecatedRequestAssignRightsToResume ==== | ||
Takes an input u64 "nn::ns::RightsEnvironmentHandle" and an [[Account_services#Uid|Uid]]. Returns an output Event handle and an [[#IAsyncResult]]. | |||
==== | ==== VerifyActivatedRightsOwners ==== | ||
Takes an input | Takes an input u64 "nn::ns::RightsEnvironmentHandle". No output. | ||
==== | ==== DeprecatedGetApplicationRightsStatus ==== | ||
No input | Takes an input u64 "nn::ns::RightsEnvironmentHandle". Returns a bool "nn::ns::ApplicationRightsStatus". | ||
==== RequestPrefetchForDynamicRights ==== | |||
Takes an input [[Account_services#Uid|Uid]]. Returns an output Event handle and an [[#IAsyncResult]]. | |||
==== GetDynamicRightsState ==== | |||
No input. Returns a bool "nn::ns::DynamicRightsState". | |||
==== RequestApplicationRightsOnServerToResume ==== | |||
Takes an input u64 "nn::ns::RightsEnvironmentHandle". Returns an output Event handle and an [[#IAsyncValue]]. | |||
==== RequestAssignRightsToResume ==== | |||
Takes an input u64 "nn::ns::RightsEnvironmentHandle". Returns an output Event handle and an [[#IAsyncResult]]. | |||
==== GetActivatedRightsUsers ==== | |||
Takes an input u64 "nn::ns::RightsEnvironmentHandle". Returns a bool, an u32 and a type-0x6 output buffer containing an array of [[Account_services#Uid|Uid]]. | |||
==== | ==== GetApplicationRightsStatus ==== | ||
Takes an input | Takes an input "nn::ns::RightsEnvironmentHandle". Returns 2 bools "nn::ns::ApplicationRightsStatus" and "nn::ns::ApplicationLicenseType". | ||
==== GetRunningApplicationStatus ==== | |||
Takes an input u64 "nn::ns::RightsEnvironmentHandle". Returns an u32 "nn::ns::RunningApplicationStatus". | |||
==== | ==== RequestContentsAuthorizationToken ==== | ||
Takes an | Takes a total of 0x50-bytes of input, a type-0x5 input buffer. Returns an [[#IAsyncData_2|IAsyncData]] and an output handle. | ||
==== | ==== IAsyncData ==== | ||
This is "nn::ns::detail::IAsyncData". | |||
This was added with [12.0.0+]. | |||
This | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
| Line 2,141: | Line 2,285: | ||
! Cmd || Name | ! Cmd || Name | ||
|- | |- | ||
| | | 0 || GetSize | ||
|- | |- | ||
| | | 1 || Get | ||
|- | |||
| 2 || Cancel | |||
|- | |||
| 3 || GetErrorContext | |||
|} | |||
=== IECommerceInterface=== | |||
This is "nn::ns::detail::IECommerceInterface". | |||
This was added with [4.0.0+]. | |||
{| class="wikitable" border="1" | |||
|- | |||
! Cmd || Name | |||
|- | |||
| 0 || [[#RequestLinkDevice]] | |||
|- | |||
| 1 || [6.0.0+] [[#RequestCleanupAllPreInstalledApplications]] | |||
|- | |||
| 2 || [6.0.0+] [[#RequestCleanupPreInstalledApplication]] | |||
|- | |||
| 3 || [6.0.0+] [[#RequestSyncRights]] | |||
|- | |||
| 4 || [6.0.0+] [[#RequestUnlinkDevice]] | |||
|- | |||
| 5 || [6.1.0+] [[#RequestRevokeAllELicense]] | |||
|- | |||
| 6 || [9.0.0+] [[#RequestSyncRightsBasedOnAssignedELicenses]] | |||
|- | |||
| 7 || [14.0.0+] RequestOnlineSubscriptionFreeTrialAvailability | |||
|- | |||
| 8 || [20.0.0+] | |||
|- | |- | ||
| | | 9 || [20.0.0+] | ||
|- | |- | ||
| | | 10 || [20.0.0+] | ||
|- | |- | ||
| | | 11 || [20.0.0+] | ||
|- | |- | ||
| | | 12 || [20.0.0+] | ||
|- | |- | ||
| | | 13 || [20.0.0+] | ||
|} | |} | ||
==== | ==== RequestLinkDevice ==== | ||
Takes an input [[Account_services#Uid|Uid]], returns an output Event handle and an [[#IAsyncResult]]. | |||
See [[#RequestApplicationUpdateInfo]] regarding nifm. | |||
==== | ==== RequestCleanupAllPreInstalledApplications ==== | ||
No input | No input, returns an output Event handle and an [[#IAsyncResult]]. | ||
==== | ==== RequestCleanupPreInstalledApplication ==== | ||
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output Event handle and an [[#IAsyncResult]]. | |||
==== | ==== RequestSyncRights ==== | ||
No input | No input, returns an output Event handle and an [[#IAsyncResult]]. | ||
==== | ==== RequestUnlinkDevice ==== | ||
Takes an input [[Account_services#Uid|Uid]], returns an output Event handle and an [[#IAsyncResult]]. | |||
See [[#RequestApplicationUpdateInfo]] regarding nifm. | |||
==== RequestRevokeAllELicense ==== | |||
Takes an input [[Account_services#Uid|Uid]], returns an output Event handle and an [[#IAsyncResult]]. | |||
==== | ==== RequestSyncRightsBasedOnAssignedELicenses ==== | ||
No input, returns an output Event handle and an [[#IAsyncResult]]. | |||
=== IFactoryResetInterface === | |||
This is "nn::ns::detail::IFactoryResetInterface". | |||
This is "nn::ns::detail:: | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
| Line 2,192: | Line 2,364: | ||
! Cmd || Name | ! Cmd || Name | ||
|- | |- | ||
| | | 100 || [[#ResetToFactorySettings]] | ||
|- | |- | ||
| | | 101 || [[#ResetToFactorySettingsWithoutUserSaveData]] | ||
|- | |||
| 102 || [[#ResetToFactorySettingsForRefurbishment]] | |||
|- | |- | ||
| | | 103 || [9.1.0+] [[#ResetToFactorySettingsWithPlatformRegion]] | ||
|- | |- | ||
| | | 104 || [9.1.0+] [[#ResetToFactorySettingsWithPlatformRegionAuthentication]] | ||
|- | |- | ||
| | | 105 || [10.0.0+] [[#RequestResetToFactorySettingsSecurely]] | ||
|- | |- | ||
| 106 || [10.0.0+] [[#RequestResetToFactorySettingsWithPlatformRegionAuthenticationSecurely]] | |||
|- | |- | ||
| | | 107 || [20.0.0+] | ||
|- | |- | ||
| | | 108 || [20.0.0+] | ||
|} | |} | ||
= | ==== ResetToFactorySettings ==== | ||
No input/output. | |||
As of [9.1.0] this is the only [[#IFactoryResetInterface]] cmd used by [[qlaunch]]. | |||
==== ResetToFactorySettingsWithoutUserSaveData ==== | |||
No input/output. | |||
==== ResetToFactorySettingsForRefurbishment ==== | |||
No input/output. | |||
== | ==== ResetToFactorySettingsWithPlatformRegion ==== | ||
No input | No input/output. | ||
==== ResetToFactorySettingsWithPlatformRegionAuthentication ==== | |||
No input/output. | |||
== | ==== RequestResetToFactorySettingsSecurely ==== | ||
Takes an input [[ | Takes an input u64 tmem_size, a TransferMemory handle, returns an output [[#IAsyncValueAndProgress]] and an Event handle. | ||
The TransferMemory uses permissions=0. | |||
==== RequestResetToFactorySettingsWithPlatformRegionAuthenticationSecurely ==== | |||
Takes an input u32 "nn::ae::PlatformRegion", an u64 tmem_size, a TransferMemory handle, returns an output [[#IAsyncValueAndProgress]] and an Event handle. | |||
The TransferMemory uses permissions=0. | |||
== | ===== IAsyncValueAndProgress ===== | ||
This is "nn::ns::detail::IAsyncValueAndProgress". | |||
This was added with [10.0.0+]. | |||
This | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
| Line 2,261: | Line 2,419: | ||
! Cmd || Name | ! Cmd || Name | ||
|- | |- | ||
| 0 || | | 0 || GetSize | ||
|- | |- | ||
| 1 || | | 1 || Get | ||
|- | |- | ||
| 2 || | | 2 || Cancel | ||
|- | |- | ||
| 3 || | | 3 || GetErrorContext | ||
|- | |- | ||
| 4 || [ | | 4 || GetProgress | ||
|} | |||
=== IApplicationResource === | |||
This is "nn::ns::detail::IApplicationResource". | |||
This was added with [9.0.0+]. | |||
{| class="wikitable" border="1" | |||
|- | |- | ||
| | ! Cmd || Name | ||
|- | |- | ||
| | | 0 || Attach | ||
|- | |- | ||
| | | 1 || BoostSystemMemoryResourceLimit | ||
|} | |||
= ns:vm = | |||
This is "nn::ns::detail::IVulnerabilityManagerInterface". | |||
{| class="wikitable" border="1" | |||
|- | |- | ||
| | ! Cmd || Name | ||
|- | |- | ||
| | | 1200 || [3.0.0+] [[#NeedsUpdateVulnerability]] | ||
|- | |- | ||
| | | 1201 || [4.0.0+] [[#UpdateSafeSystemVersionForDebug]] | ||
|- | |- | ||
| | | 1202 || [4.0.0+] [[#GetSafeSystemVersion]] | ||
|- | |- | ||
| | | 3100 || [18.0.0+] | ||
|- | |- | ||
| | | 3101 || [18.0.0+] | ||
|- | |- | ||
| | | 3102 || [18.0.0+] | ||
| | |} | ||
== NeedsUpdateVulnerability == | |||
No input, returns an output u8 bool flag. | |||
Web-applets use this command to check if the system needs an update. | |||
== UpdateSafeSystemVersionForDebug == | |||
Takes an input [[NCM_services#ApplicationId|ApplicationId]] and an u32 '''version'''. | |||
This command is not available for retail units. On a debug unit, if the [[System_Settings|system setting]] <code>vulnerability!enable_debug</code> is set, this mounts the system savegame [[Flash_Filesystem#System_Savegames|0x8000000000000049]] as "ns_ssversion:/", opens the file "ns_ssversion:/entry" and writes the supplied [[NCM_services#ApplicationId|ApplicationId]] and '''version''' in it. | |||
Finally, it calls [[NCM_services#ncm|OpenContentMetaDatabase]] with [[NCM_services#StorageId|StorageId]] 3, then calls [[NCM_services#IContentMetaDatabase|GetLatestContentMetaKey]] with the supplied [[NCM_services#ApplicationId|ApplicationId]] and compares the version field from the returned [[CNMT#Content_Meta_Records|Content Meta Record]] with the supplied '''version'''. | |||
If the supplied '''version''' is higher than the one in NCM's database, the value returned by [[NS_Services#NeedsUpdateVulnerability|NeedsUpdateVulnerability]] is set to "true". | |||
== GetSafeSystemVersion == | |||
No input, returns an output [[NCM_services#ContentMetaKey|ContentMetaKey]] with the cached contents of "ns_ssversion:/entry" ([[NCM_services#ApplicationId|ApplicationId]], u32 '''version''' and u32 '''policy''' from <code>vulnerability!needs_update_vulnerability_policy</code>). | |||
= ns:su = | |||
This is "nn::ns::detail::ISystemUpdateInterface". | |||
== ClearExFatDriverStatusForDebug | {| class="wikitable" border="1" | ||
|- | |||
! Cmd || Name | |||
|- | |||
| 0 || [[#GetBackgroundNetworkUpdateState]] | |||
|- | |||
| 1 || [[#OpenSystemUpdateControl]] | |||
|- | |||
| 2 || [[#NotifyExFatDriverRequired]] | |||
|- | |||
| 3 || [[#ClearExFatDriverStatusForDebug]] | |||
|- | |||
| 4 || [[#RequestBackgroundNetworkUpdate]] | |||
|- | |||
| 5 || [[#NotifyBackgroundNetworkUpdate]] | |||
|- | |||
| 6 || [[#NotifyExFatDriverDownloadedForDebug]] | |||
|- | |||
| 9 || [[#GetSystemUpdateNotificationEventForContentDelivery]] | |||
|- | |||
| 10 || [[#NotifySystemUpdateForContentDelivery]] | |||
|- | |||
| 11 || [3.0.0+] [[#PrepareShutdown]] | |||
|- | |||
| 12 || [3.0.0-3.0.2] | |||
|- | |||
| 13 || [3.0.0-3.0.2] | |||
|- | |||
| 14 || [3.0.0-3.0.2] | |||
|- | |||
| 15 || [3.0.0-3.0.2] | |||
|- | |||
| 16 || [4.0.0+] [[#DestroySystemUpdateTask]] | |||
|- | |||
| 17 || [4.0.0+] [[#RequestSendSystemUpdate]] | |||
|- | |||
| 18 || [4.0.0+] [[#GetSendSystemUpdateProgress]] | |||
|} | |||
== GetBackgroundNetworkUpdateState == | |||
No input, returns an output [[#BackgroundNetworkUpdateState]]. | |||
This is similar to [[#HasDownloaded]], see [[#BackgroundNetworkUpdateState]]. | |||
This checks whether a sysupdate is needed with the input ContentMetaKey using [[NCM_services|NCM]] commands, if not this will just return 0. Otherwise, this will then run code which is identical to [[#RequestBackgroundNetworkUpdate]]. | == OpenSystemUpdateControl == | ||
No input, returns an [[#ISystemUpdateControl]]. | |||
== NotifyExFatDriverRequired == | |||
No input/output. | |||
Only usable when an [[#ISystemUpdateControl]] isn't open. | |||
This uses [[NIM_services|nim]] ListSystemUpdateTask, then when a task is returned uses it with DestroySystemUpdateTask. | |||
Then this runs ExFat handling, updates state, and sets the same state flag as [[#RequestBackgroundNetworkUpdate]]. | |||
== ClearExFatDriverStatusForDebug == | |||
No input/output. | |||
== RequestBackgroundNetworkUpdate == | |||
No input/output. | |||
Only usable when an [[#ISystemUpdateControl]] isn't open. | |||
This sets a state flag to value 1. | |||
== NotifyBackgroundNetworkUpdate == | |||
Takes an input [[NCM_services#ContentMetaKey|ContentMetaKey]], no output. | |||
This checks whether a sysupdate is needed with the input ContentMetaKey using [[NCM_services|NCM]] commands, if not this will just return 0. Otherwise, this will then run code which is identical to [[#RequestBackgroundNetworkUpdate]]. | |||
== NotifyExFatDriverDownloadedForDebug == | == NotifyExFatDriverDownloadedForDebug == | ||
| Line 2,659: | Line 2,886: | ||
| 7 || [1.0.0-9.2.0] [[#PrepareLaunchProgramFromHost]] | | 7 || [1.0.0-9.2.0] [[#PrepareLaunchProgramFromHost]] | ||
|- | |- | ||
| 8 || [10.0.0-17.0.1] [[#LaunchApplicationFromHost]] ([1.0.0-9.2.0] | | 8 || [10.0.0-17.0.1] [[#LaunchApplicationFromHost]] ([1.0.0-9.2.0] LaunchApplication) | ||
|- | |- | ||
| 9 || [1.0.0-17.0.1] [[# | | 9 || [1.0.0-17.0.1] [[#LaunchApplicationWithStorageId]] | ||
|- | |- | ||
| 10 || [6.0.0-8.1.0] [[#IsSystemMemoryResourceLimitBoosted]] | | 10 || [6.0.0-8.1.0] [[#IsSystemMemoryResourceLimitBoosted]] | ||
|- | |- | ||
| 11 || [6.0.0+] [[# | | 11 || [6.0.0+] [[#GetRunningApplicationProcessId]] | ||
|- | |- | ||
| 12 || [6.0.0+] [[# | | 12 || [6.0.0+] [[#SetCurrentApplicationRightsEnvironmentCanBeActive]] | ||
|- | |- | ||
| 13 || [9.0.0+] [[# | | 13 || [9.0.0+] [[#CreateApplicationResource]] | ||
|- | |- | ||
| 14 || [9.0.0+] [[# | | 14 || [9.0.0+] [[#IsPreomia]] | ||
|- | |- | ||
| 15 || [10.0.0-17.0.1] [[#GetApplicationProgramIdFromHost]] | | 15 || [10.0.0-17.0.1] [[#GetApplicationProgramIdFromHost]] | ||
| Line 2,687: | Line 2,914: | ||
| 21 || [18.0.0+] [[#PrepareLaunchApplication]] | | 21 || [18.0.0+] [[#PrepareLaunchApplication]] | ||
|- | |- | ||
| 22 || [18.0.0+] [[# | | 22 || [18.0.0+] [[#LaunchApplication]] | ||
|- | |- | ||
| 23 || [18.0.0+] [[#GetProgramIdByApplicationLaunchInfo]] | | 23 || [18.0.0+] [[#GetProgramIdByApplicationLaunchInfo]] | ||
| Line 2,716: | Line 2,943: | ||
Calls [[NCM_services#IPathResolverForStorage|IPathResolverForStorage]] Set...NcaPath functions. | Calls [[NCM_services#IPathResolverForStorage|IPathResolverForStorage]] Set...NcaPath functions. | ||
== LaunchApplicationFromHost == | == LaunchApplicationFromHost == | ||
Takes an input u32 [[Process_Manager_services#LaunchFlags|LaunchFlags]] and a type-0x5 input buffer containing the [[Filesystem_services#FspPath|FspPath]]. Returns an output u64 ProcessId. | Takes an input u32 [[Process_Manager_services#LaunchFlags|LaunchFlags]] and a type-0x5 input buffer containing the [[Filesystem_services#FspPath|FspPath]]. Returns an output u64 ProcessId. | ||
== | == LaunchApplicationWithStorageId == | ||
Takes 2 input u8 [[NCM_services#StorageId|StorageIds]], an u32 [[Process_Manager_services#LaunchFlags|LaunchFlags]], and an [[NCM_services#ApplicationId|ApplicationId]]. Returns an output u64 ProcessId. | Takes 2 input u8 [[NCM_services#StorageId|StorageIds]], an u32 [[Process_Manager_services#LaunchFlags|LaunchFlags]], and an [[NCM_services#ApplicationId|ApplicationId]]. Returns an output u64 ProcessId. | ||
| Line 2,733: | Line 2,955: | ||
No input. Returns a bool. | No input. Returns a bool. | ||
== | == GetRunningApplicationProcessId == | ||
Returns an output u64 ProcessId. | Returns an output u64 ProcessId. | ||
== | == SetCurrentApplicationRightsEnvironmentCanBeActive == | ||
Takes an input bool. No output. | Takes an input bool. No output. | ||
== | == CreateApplicationResource == | ||
Takes an input u32 (1 = Preomia/MicroApplication). Returns an [[#IApplicationResource]]. | Takes an input u32 (1 = Preomia/MicroApplication). Returns an [[#IApplicationResource]]. | ||
== | == IsPreomia == | ||
Takes an input u64 [[NCM_services#ProgramId|ProgramId]]. Returns a bool. | Takes an input u64 [[NCM_services#ProgramId|ProgramId]]. Returns a bool. | ||
| Line 2,768: | Line 2,990: | ||
[19.0.0+] Now returns a total of 0x80-bytes of output. | [19.0.0+] Now returns a total of 0x80-bytes of output. | ||
== | == LaunchApplication == | ||
Takes a total of 0x50-bytes of input. Returns a total of 8-bytes of output. | Takes a total of 0x50-bytes of input. Returns a total of 8-bytes of output. | ||
| Line 2,851: | Line 3,073: | ||
| 190 || [1.0.0-9.2.0] GetUserLastOpenedApplication || | | 190 || [1.0.0-9.2.0] GetUserLastOpenedApplication || | ||
|- | |- | ||
| 191 || [7.0.0 | | 191 || [7.0.0-19.0.1] UpdateNotificationReceiverInfo ([5.0.0-5.1.0] ActivateOpenContextHolder) || | ||
|- | |- | ||
| 200 || BeginUserRegistration || | | 200 || BeginUserRegistration || | ||
| Line 2,882: | Line 3,104: | ||
|- | |- | ||
| 250 || GetBaasAccountAdministrator || Returns an [[#IAdministrator]]. | | 250 || GetBaasAccountAdministrator || Returns an [[#IAdministrator]]. | ||
|- | |||
| 251 || [20.0.0+] SynchronizeNetworkServiceAccountsSnapshotAsync || | |||
|- | |- | ||
| 290 || ProxyProcedureForGuestLoginWithNintendoAccount || Returns an [[#IOAuthProcedureForExternalNsa]] (formerly [[#IOAuthProcedureForGuestLogin]] with [1.0.0-2.3.0]). | | 290 || ProxyProcedureForGuestLoginWithNintendoAccount || Returns an [[#IOAuthProcedureForExternalNsa]] (formerly [[#IOAuthProcedureForGuestLogin]] with [1.0.0-2.3.0]). | ||
|- | |- | ||
| 291 || [3.0.0+] ProxyProcedureForFloatingRegistrationWithNintendoAccount || Returns an [[#IOAuthProcedureForExternalNsa]]. | | 291 || [3.0.0+] ProxyProcedureForFloatingRegistrationWithNintendoAccount || Returns an [[#IOAuthProcedureForExternalNsa]]. | ||
|- | |||
| 292 || [20.0.0+] ProxyProcedureForDeviceMigrationAuthenticatingOperatingUser || | |||
|- | |||
| 293 || [20.0.0+] ProxyProcedureForDeviceMigrationDownload || | |||
|- | |- | ||
| 299 || SuspendBackgroundDaemon || Returns an [[#ISessionObject]]. | | 299 || SuspendBackgroundDaemon || Returns an [[#ISessionObject]]. | ||
|- | |||
| 350 || [20.0.0+] CreateDeviceMigrationUserExportRequest || | |||
|- | |||
| 351 || [20.0.0+] UploadNasCredential || | |||
|- | |||
| 352 || [20.0.0+] CreateDeviceMigrationUserImportRequest || | |||
|- | |||
| 353 || [20.0.0+] DeleteUserMigrationSaveData || | |||
|- | |- | ||
| 400 || [18.0.0+] SetPinCode || | | 400 || [18.0.0+] SetPinCode || | ||
| Line 2,893: | Line 3,129: | ||
| 401 || [18.0.0+] GetPinCodeLength || | | 401 || [18.0.0+] GetPinCodeLength || | ||
|- | |- | ||
| 402 || [18.0.0+] | | 402 || [18.0.0-19.0.1] GetPinCode || | ||
|- | |||
| 403 || [20.0.0+] GetPinCodeParity || | |||
|- | |||
| 404 || [20.0.0+] VerifyPinCode || | |||
|- | |||
| 405 || [20.0.0+] IsPinCodeVerificationForbidden || | |||
|- | |- | ||
| 410 || [18.0.0+] GetPinCodeErrorCount || | | 410 || [18.0.0+] GetPinCodeErrorCount || | ||
|- | |- | ||
| 411 || [18.0.0 | | 411 || [18.0.0-19.0.1] ResetPinCodeErrorCount || | ||
|- | |- | ||
| 412 || [18.0.0+] | | 412 || [18.0.0-19.0.1] IncrementPinCodeErrorCount || | ||
|- | |||
| 413 || [20.0.0+] SetPinCodeErrorCount || | |||
|- | |- | ||
| 420 || [19.0.0+] SetStartPenaltyTime || | | 420 || [19.0.0+] SetStartPenaltyTime || | ||
| Line 2,941: | Line 3,185: | ||
| 2 || EnsureIdTokenCacheAsync || Returns an [[#IAsyncContext]]. | | 2 || EnsureIdTokenCacheAsync || Returns an [[#IAsyncContext]]. | ||
|- | |- | ||
| 3 || LoadIdTokenCache || | | 3 || [19.0.0+] LoadIdTokenCacheDeprecated ([1.0.0-18.1.0] LoadIdTokenCache) || | ||
|- | |||
| 4 || [19.0.0+] LoadIdTokenCache || | |||
|- | |- | ||
| 100 || SetSystemProgramIdentification || | | 100 || SetSystemProgramIdentification || | ||
|- | |- | ||
| 101 || | | 101 || RefreshNotificationTokenAsync || | ||
|- | |- | ||
| 110 || | | 110 || GetServiceEntryRequirementCacheForLogin || | ||
|- | |- | ||
| 111 || | | 111 || InvalidateServiceEntryRequirementCache || | ||
|- | |- | ||
| 113 || GetServiceEntryRequirementCacheForOnlinePlay || Takes a total of 0x8-bytes of input, returns a total of 0x4-bytes of output. | |||
| 113 || | |||
|- | |- | ||
| 120 || GetNintendoAccountId || | | 120 || GetNintendoAccountId || | ||
|- | |- | ||
| 121 || | | 121 || CalculateNintendoAccountAuthenticationFingerprint || | ||
|- | |- | ||
| 130 || GetNintendoAccountUserResourceCache || | | 130 || GetNintendoAccountUserResourceCache || | ||
| Line 2,965: | Line 3,209: | ||
| 132 || RefreshNintendoAccountUserResourceCacheAsyncIfSecondsElapsed || Returns an [[#IAsyncContext]]. | | 132 || RefreshNintendoAccountUserResourceCacheAsyncIfSecondsElapsed || Returns an [[#IAsyncContext]]. | ||
|- | |- | ||
| 133 || | | 133 || GetNintendoAccountVerificationUrlCache || | ||
|- | |||
| 134 || RefreshNintendoAccountVerificationUrlCacheAsync || | |||
|- | |||
| 135 || RefreshNintendoAccountVerificationUrlCacheAsyncIfSecondsElapsed || | |||
|- | |- | ||
| | | 136 || [19.0.0+] GetNintendoAccountUserResourceCache || | ||
|- | |- | ||
| | | 140 || GetNetworkServiceLicenseCache || | ||
|- | |- | ||
| | | 141 || RefreshNetworkServiceLicenseCacheAsync || Returns an [[#IAsyncContext]]. | ||
|- | |- | ||
| | | 142 || RefreshNetworkServiceLicenseCacheAsyncIfSecondsElapsed || Returns an [[#IAsyncContext]]. | ||
|- | |- | ||
| | | 143 || [15.0.0+] GetNetworkServiceLicenseCacheEx || | ||
|- | |- | ||
| 150 || CreateAuthorizationRequest || Returns an [[#IAuthorizationRequest]]. | | 150 || CreateAuthorizationRequest || Returns an [[#IAuthorizationRequest]]. | ||
| Line 2,983: | Line 3,231: | ||
| 161 || [16.0.0+] RequireReauthenticationOfNetworkServiceAccount || | | 161 || [16.0.0+] RequireReauthenticationOfNetworkServiceAccount || | ||
|- | |- | ||
| | | 180 || [18.0.0-19.0.1] GetRequestForNintendoAccountReauthentication || | ||
|- | |- | ||
| | | 181 || [20.0.0+] CreateProcedureToReauthenticateNintendoAccount || | ||
|- | |||
| 182 || [20.0.0+] ResumeProcedureToReauthenticateNintendoAccount || | |||
|} | |} | ||
| Line 3,037: | Line 3,287: | ||
| 2 || EnsureIdTokenCacheAsync || Returns an [[#IAsyncContext]]. | | 2 || EnsureIdTokenCacheAsync || Returns an [[#IAsyncContext]]. | ||
|- | |- | ||
| 3 || LoadIdTokenCache || | | 3 || [19.0.0+] LoadIdTokenCacheDeprecated ([1.0.0-18.1.0] LoadIdTokenCache) || | ||
|- | |||
| 4 || [19.0.0+] LoadIdTokenCache || | |||
|- | |- | ||
| 100 || SetSystemProgramIdentification || | | 100 || SetSystemProgramIdentification || | ||
| Line 3,066: | Line 3,318: | ||
|- | |- | ||
| 135 || [9.0.0+] RefreshNintendoAccountVerificationUrlCacheAsyncIfSecondsElapsed || | | 135 || [9.0.0+] RefreshNintendoAccountVerificationUrlCacheAsyncIfSecondsElapsed || | ||
|- | |||
| 136 || [19.0.0+] GetNintendoAccountUserResourceCache || | |||
|- | |- | ||
| 140 || [5.0.0+] GetNetworkServiceLicenseCache || | | 140 || [5.0.0+] GetNetworkServiceLicenseCache || | ||
| Line 3,072: | Line 3,326: | ||
|- | |- | ||
| 142 || [5.0.0+] RefreshNetworkServiceLicenseCacheAsyncIfSecondsElapsed || | | 142 || [5.0.0+] RefreshNetworkServiceLicenseCacheAsyncIfSecondsElapsed || | ||
|- | |||
| 143 || [15.0.0+] GetNetworkServiceLicenseCacheEx || | |||
|- | |- | ||
| 150 || CreateAuthorizationRequest || Returns an [[#IAuthorizationRequest]]. | | 150 || CreateAuthorizationRequest || Returns an [[#IAuthorizationRequest]]. | ||
| Line 3,079: | Line 3,335: | ||
| 161 || [16.0.0+] RequireReauthenticationOfNetworkServiceAccount || | | 161 || [16.0.0+] RequireReauthenticationOfNetworkServiceAccount || | ||
|- | |- | ||
| | | 180 || [18.0.0-19.0.1] GetRequestForNintendoAccountReauthentication || | ||
|- | |- | ||
| | | 181 || [20.0.0+] CreateProcedureToReauthenticateNintendoAccount || | ||
|- | |||
| 182 || [20.0.0+] ResumeProcedureToReauthenticateNintendoAccount || | |||
|- | |- | ||
| 200 || IsRegistered || | | 200 || IsRegistered || | ||
| Line 3,090: | Line 3,348: | ||
|- | |- | ||
| 203 || DeleteRegistrationInfoLocally || | | 203 || DeleteRegistrationInfoLocally || | ||
|- | |||
| 204 || [19.0.0-19.0.1] UnregisterDeviceAsync || | |||
|- | |- | ||
| 220 || SynchronizeProfileAsync || Returns an [[#IAsyncContext]]. | | 220 || SynchronizeProfileAsync || Returns an [[#IAsyncContext]]. | ||
| Line 3,096: | Line 3,356: | ||
|- | |- | ||
| 222 || SynchronizeProfileAsyncIfSecondsElapsed || Returns an [[#IAsyncContext]]. | | 222 || SynchronizeProfileAsyncIfSecondsElapsed || Returns an [[#IAsyncContext]]. | ||
|- | |||
| 223 || [19.0.0+] DownloadProfileAsync || | |||
|- | |- | ||
| 250 || IsLinkedWithNintendoAccount || | | 250 || IsLinkedWithNintendoAccount || | ||
| Line 3,120: | Line 3,382: | ||
|- | |- | ||
| 401 || [6.1.0+] RefreshServiceEntryRequirementCacheForOnlinePlayAsync || Takes a total of 0x8-bytes of input, returns an [[#IAsyncContext]]. | | 401 || [6.1.0+] RefreshServiceEntryRequirementCacheForOnlinePlayAsync || Takes a total of 0x8-bytes of input, returns an [[#IAsyncContext]]. | ||
|- | |- | ||
| 900 || [9.0.0+] GetAuthenticationInfoForWin || | | 900 || [9.0.0+] GetAuthenticationInfoForWin || | ||
| Line 3,563: | Line 3,823: | ||
| 190 || [1.0.0-9.2.0] GetUserLastOpenedApplication || | | 190 || [1.0.0-9.2.0] GetUserLastOpenedApplication || | ||
|- | |- | ||
| 191 || [7.0.0 | | 191 || [7.0.0-19.0.1] UpdateNotificationReceiverInfo ([5.0.0-5.1.0] ActivateOpenContextHolder) || | ||
|- | |- | ||
| 401 || [18.0.0+] GetPinCodeLength || | | 401 || [18.0.0+] GetPinCodeLength || | ||
|- | |- | ||
| 402 || [18.0.0+] | | 402 || [18.0.0-19.0.1] GetPinCode || | ||
|- | |||
| 403 || [20.0.0+] GetPinCodeParity || | |||
|- | |||
| 404 || [20.0.0+] VerifyPinCode || | |||
|- | |||
| 405 || [20.0.0+] IsPinCodeVerificationForbidden || | |||
|- | |- | ||
| 997 || [3.0.0+] DebugInvalidateTokenCacheForUser || | | 997 || [3.0.0+] DebugInvalidateTokenCacheForUser || | ||
| Line 3,624: | Line 3,890: | ||
|} | |} | ||
= | = ApplicationRecord = | ||
This is "nn::ns:: | This is "nn::ns::ApplicationRecord". | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
! | ! Offset | ||
! Size | |||
! Description | ! Description | ||
|- | |- | ||
| | | 0x0 | ||
| 0x8 | |||
| [[NCM_services#ApplicationId|Id]] | |||
|- | |||
| 0x8 | |||
| 0x1 | |||
| [[#ApplicationEvent|LastEvent]] | |||
|- | |- | ||
| | | 0x9 | ||
| | | 0x1 | ||
| Attributes | |||
|- | |- | ||
| 0xA | |||
| 0x6 | |||
| Reserved | |||
|- | |- | ||
| | | 0x10 | ||
| 0x8 | |||
| LastUpdated | |||
|} | |} | ||
= | = ApplicationEvent = | ||
This is "nn::ns:: | This is "nn::ns::ApplicationEvent". | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
! | ! Value | ||
! Description | ! Description | ||
|- | |- | ||
| | | 0 || Launched | ||
|- | |||
| 1 || LocalInstalled | |||
|- | |- | ||
| | | 2 || DownloadStarted | ||
|- | |- | ||
| | | 3 || GameCardInserted | ||
|- | |- | ||
| | | 4 || Touched | ||
|- | |- | ||
| | | 5 || | ||
|- | |- | ||
| 6 || | |||
|- | |- | ||
| | | 7 || | ||
|- | |- | ||
| | | 8 || | ||
|- | |- | ||
| | | 9 || | ||
|- | |- | ||
| | | 10 || | ||
|- | |- | ||
| | | 11 || | ||
|- | |- | ||
| | | 12 || | ||
|- | |- | ||
| | | 13 || | ||
|- | |||
| 14 || | |||
|- | |||
| 15 || | |||
|- | |||
| 16 || | |||
|} | |} | ||
= | = ApplicationControlSource = | ||
This is "nn::ns:: | This is "nn::ns::ApplicationControlSource". | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
! | ! Value | ||
! Description | ! Description | ||
|- | |- | ||
| | | 0 | ||
| CacheOnly | |||
|- | |- | ||
| | | 1 | ||
| Storage | |||
|- | |- | ||
| | | 2 | ||
| | | StorageOnly | ||
|} | |} | ||
This is | = ApplicationContentMetaStatus = | ||
This is "nn::ns::ApplicationContentMetaStatus". | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
| Line 3,726: | Line 3,990: | ||
! Description | ! Description | ||
|- | |- | ||
| 0x0 || | | 0x0 | ||
| 0x1 | |||
| [[NCM_services#ContentMetaType|Type]] | |||
|- | |- | ||
| | | 0x1 | ||
| 0x1 | |||
| [[NCM_services#StorageId|InstalledStorage]] | |||
|- | |- | ||
| 0x2 | |||
| 0x1 | |||
| [[#ContentMetaRightsCheck|RightsCheck]] | |||
|- | |- | ||
| | | 0x3 | ||
| 0x1 | |||
| Reserved | |||
|- | |- | ||
| | | 0x4 | ||
| 0x4 | |||
| Version | |||
|- | |- | ||
| | | 0x8 | ||
| | | 0x8 | ||
| | | [[NCM_services#ApplicationId|Id]] | ||
|} | |} | ||
= | = ContentMetaRightsCheck = | ||
This is "nn::ns:: | This is "nn::ns::ContentMetaRightsCheck". | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
! | ! Value | ||
! Description | ! Description | ||
|- | |- | ||
| 0 | | 0 | ||
| | | NotChecked | ||
|- | |- | ||
| 1 | | 1 | ||
| | | NotNeeded | ||
|- | |- | ||
| 2 | | 2 | ||
| | | CommonRights | ||
|- | |- | ||
| 3 | | 3 | ||
| | | PersonalizedRights | ||
|- | |- | ||
| 4 | | 4 | ||
| | | NoRights | ||
|} | |||
= VersionListData = | |||
This is "nn::ns::VersionListData". | |||
= ApplicationUpdateInfo = | |||
This is "nn::ns::ApplicationUpdateInfo". | |||
{| class="wikitable" border="1" | |||
|- | |- | ||
! Value | |||
! Description | |||
|- | |- | ||
| | | 0 || UpToDate | ||
| | |||
|- | |- | ||
| | | 1 || Updatable | ||
| | |} | ||
= ApplicationOccupiedSize = | |||
This is "nn::ns::ApplicationOccupiedSize". This is a 0x80-byte struct. | |||
{| class="wikitable" border="1" | |||
|- | |- | ||
! Offset | |||
! Size | |||
! Description | |||
|- | |- | ||
| | | 0x0 || 0x20 * 4 || Array of [[#ApplicationOccupiedSizeEntity]] | ||
| | |||
| | |||
| | |||
| | |||
|} | |} | ||
= | = ApplicationOccupiedSizeEntity = | ||
This is "nn::ns:: | This is "nn::ns::ApplicationOccupiedSizeEntity". This is a 0x20-byte struct. | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
| Line 3,817: | Line 4,076: | ||
! Description | ! Description | ||
|- | |- | ||
| 0x0 || | | 0x0 || 0x1 || [[NCM_services#StorageId|StorageId]] | ||
|- | |- | ||
| | | 0x1 || 0x7 || Reserved | ||
|- | |- | ||
| | | 0x8 || 0x8 || AppSize | ||
|- | |- | ||
| | | 0x10 || 0x8 || PatchSize | ||
|- | |- | ||
| | | 0x18 || 0x8 || AocSize | ||
|} | |} | ||
= | = ProgressForDeleteUserSaveDataAll = | ||
This is "nn::ns:: | This is "nn::ns::detail::ProgressForDeleteUserSaveDataAll". This is a 0x28-byte struct. | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
| Line 3,837: | Line 4,096: | ||
! Description | ! Description | ||
|- | |- | ||
| 0x0 || 0x8 || | | 0x0 || 0x8 || StartedAt | ||
|- | |||
| 0x8 || 0x4 || Count | |||
|- | |||
| 0xC || 0x4 || Reserved | |||
|- | |- | ||
| | | 0x10 || 0x8 || SizeInBytes | ||
|- | |- | ||
| | | 0x18 || 0x1 || IsSystem | ||
|- | |- | ||
| | | 0x19 || 0x7 || Reserved | ||
|- | |- | ||
| | | 0x20 || 0x8 || ApplicationId | ||
|} | |} | ||
= | = ApplicationViewDeprecated = | ||
This is "nn::ns:: | This is "nn::ns::ApplicationViewDeprecated". This is a 0x40-byte struct. | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
! | ! Offset | ||
! Size | |||
! Description | ! Description | ||
|- | |- | ||
| | | 0x0 || 0x8 || [[NCM_services#ApplicationId|ApplicationId]] | ||
|- | |- | ||
| | | 0x8 || 0x4 || Version | ||
|- | |- | ||
| | | 0xC || 0x4 || [[#ApplicationViewFlag|Flag]] | ||
|- | |- | ||
| | | 0x10 || 0x18 || [[#ApplicationDownloadProgress|Progress]] | ||
|- | |- | ||
| | | 0x28 || 0x18 || [[#ApplicationApplyDeltaProgress|ApplyProgress]] | ||
|} | |} | ||
This is converted from [[#ApplicationView]] by [[#GetApplicationViewDeprecated]] on newer system-versions as follows: | |||
This is | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
! | ! Offset | ||
! Size | |||
! Description | ! Description | ||
|- | |- | ||
| | | 0x0 || 0x20 || Same as [[#ApplicationView]] +0x0. | ||
|- | |||
| 0x20 || 0x4 || Same as [[#ApplicationView]] +0x20. | |||
|- | |||
| 0x24 || 0x2 || Same as [[#ApplicationView]] +0x24. | |||
|- | |- | ||
| | | 0x26 || 0x2 || Cleared to 0. | ||
|- | |- | ||
| | | 0x28 || 0x10 || Same as [[#ApplicationView]] +0x30. | ||
|- | |- | ||
| | | 0x38 || 0x4 || Same as [[#ApplicationView]] +0x40. | ||
|- | |- | ||
| | | 0x3C || 0x1 || Same as [[#ApplicationView]] +0x44. | ||
|- | |- | ||
| | | 0x3D || 0x2 || Cleared to 0. | ||
|- | |- | ||
| | | 0x3F || 0x1 || Cleared to 0. | ||
|} | |} | ||
= | = ApplicationViewFlag = | ||
This is "nn::ns:: | This is "nn::ns::ApplicationViewFlag". This is a 32-bit flag. | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
! | ! Bit | ||
! Description | ! Description | ||
|- | |- | ||
| | | 0 | ||
| | |||
|- | |- | ||
| | | 1 | ||
| | |||
|- | |- | ||
| | | 2 | ||
| | |||
|- | |- | ||
| | | 3 | ||
| | |||
|- | |- | ||
| 4 | |||
| | |||
|- | |- | ||
| | | 5 | ||
| | |||
|- | |- | ||
| | | 6 | ||
| | |||
|- | |- | ||
| 7 | |||
| | |||
|- | |- | ||
| | | 8 | ||
| | |||
|- | |- | ||
| | | 9 | ||
| | |||
|- | |- | ||
| | | 10 | ||
| | |||
|- | |- | ||
| | | 11 | ||
| | |||
|- | |||
| 12 | |||
| | |||
|- | |||
| 13 | |||
| | |||
|- | |||
| 14 | |||
| | |||
|- | |||
| 15 | |||
| | |||
|- | |- | ||
| | | 16 | ||
| | |||
|- | |- | ||
| | | 17 | ||
| | |||
|} | |} | ||
= | = ApplicationDownloadProgress = | ||
This is "nn::ns:: | This is "nn::ns::ApplicationDownloadProgress". This is a 0x18-byte struct. | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
! | ! Offset | ||
! Size | |||
! Description | ! Description | ||
|- | |- | ||
| | | 0x0 || 0x8 || Downloaded | ||
|- | |||
| 0x8 || 0x8 || Total | |||
|- | |||
| 0x10 || 0x4 || LastResult | |||
|- | |||
| 0x14 || 0x1 || [[#ApplicationDownloadState|State]] | |||
|- | |- | ||
| | | 0x15 || 0x3 || Reserved | ||
|} | |} | ||
= | = ApplicationApplyDeltaProgress = | ||
This is "nn::ns:: | This is "nn::ns::ApplicationApplyDeltaProgress". This is a 0x18-byte struct. | ||
= | {| class="wikitable" border="1" | ||
|- | |||
! Offset | |||
! Size | |||
! Description | |||
|- | |||
| 0x0 || 0x8 || Applied | |||
|- | |||
| 0x8 || 0x8 || Total | |||
|- | |||
| 0x10 || 0x4 || LastResult | |||
|- | |||
| 0x14 || 0x1 || [[#ApplicationApplyDeltaState|State]] | |||
|- | |||
| 0x15 || 0x3 || Reserved | |||
|} | |||
= | = ApplicationDownloadState = | ||
This is "nn::ns:: | This is "nn::ns::ApplicationDownloadState". This is an u8. | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
| Line 3,971: | Line 4,269: | ||
! Description | ! Description | ||
|- | |- | ||
| 0 || | | 0 || Runnable | ||
|- | |||
| 1 || Suspended | |||
|- | |||
| 2 || NotEnoughSpace | |||
|- | |- | ||
| | | 3 || Fatal | ||
|- | |- | ||
| | | 4 || Finished | ||
|} | |} | ||
= ApplicationApplyDeltaState = | |||
This is "nn::ns::ApplicationApplyDeltaState". This is an u8. | |||
{| class="wikitable" border="1" | |||
|- | |||
= | ! Value | ||
This is "nn::ns:: | ! Description | ||
|- | |||
| 0 || Applying | |||
|- | |||
| 1 || Suspended | |||
|- | |||
| 2 || NotEnoughSpace | |||
|- | |||
| 3 || Fatal | |||
|- | |||
| 4 || NoTask | |||
|- | |||
| 5 || WaitApply | |||
|- | |||
| 6 || Applied | |||
|} | |||
= ApplicationView = | |||
This is "nn::ns::ApplicationView". This is a 0x50-byte struct. | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|- | |- | ||
! Offset | ! Offset | ||
! Size | ! Size | ||
! Description | ! Description | ||
|- | |- | ||
| 0x0 || 0x8 || Loaded (this value can be larger than total_size when the async operation is finishing and when total_size is <=0, this current_size field may contain a progress value for when the total_size is not yet determined) | | 0x0 || 0x8 || [[NCM_services#ApplicationId|ApplicationId]] | ||
|- | |- | ||
| 0x8 || 0x8 || Total (this field is only valid when >0) | | 0x8 || 0x4 || ? | ||
|} | |- | ||
| 0xC || 0x4 || Flags | |||
Commands which have this as output will return 0 with the output cleared, when no task is available. | |- | ||
| 0x10 || 0x40 || ? | |||
= EulaDataPath = | |} | ||
This is "nn::ns::detail::EulaDataPath". This is a 0x100-byte struct. | |||
= ApplicationViewWithPromotionInfo = | |||
This contains a file path. | This is a 0x70-byte struct. | ||
= SystemDeliveryInfo = | [20.0.0+] This is a 0x78-byte struct. | ||
This is "nn::ns::SystemDeliveryInfo". This is a 0x100-byte struct. | |||
{| class="wikitable" border="1" | |||
{| class="wikitable" border="1" | |- | ||
|- | ! Offset | ||
! Offset | ! Size | ||
! Size | ! Description | ||
! Description | |- | ||
|- | | 0x0 || 0x50 || [[#ApplicationView]] | ||
| 0x0 || 0x4 || SystemDeliveryProtocolVersion. Must be <= to and match [[System_Settings|system-setting]] <code>contents_delivery!system_delivery_protocol_version</code>. | |- | ||
|- | | 0x50 || 0x20 || [[#PromotionInfo]] | ||
| 0x4 || 0x4 || ApplicationDeliveryProtocolVersion. Loaded from [[System_Settings|system-setting]] <code>contents_delivery!application_delivery_protocol_version</code>. Unused by [[#RequestSendSystemUpdate]]/[[#RequestReceiveSystemUpdate]], besides HMAC validation. | |} | ||
|- | |||
| 0x8 || 0x1 || HasExFat. Unused by [[#RequestSendSystemUpdate]]/[[#RequestReceiveSystemUpdate]], besides HMAC validation. | = PromotionInfo = | ||
|- | This is a 0x20-byte struct. | ||
| 0x9 || 0x3 || Reserved. | |||
|- | {| class="wikitable" border="1" | ||
| 0xC || 0x4 || SystemUpdateMetaVersion. | |- | ||
|- | ! Offset | ||
| 0x10 || 0x8 || SystemUpdateMetaId. | ! Size | ||
|- | ! Description | ||
| 0x18 || 0x1 || FirmwareVariationId. Used by [[#RequestSendSystemUpdate]]. | |- | ||
| 0x0 || 0x8 || PosixTime start_timestamp. | |||
|- | |||
| 0x8 || 0x8 || PosixTime end_timestamp. | |||
|- | |||
| 0x10 || 0x8 || Remaining time until the promotion ends, in nanoseconds ({end_timestamp - current_time} converted to nanoseconds). | |||
|- | |||
| 0x18 || 0x4 || Not set, left at zero. | |||
|- | |||
| 0x1C || 0x1 || Flags. Bit0: whether the PromotionInfo is valid (including bit1). Bit1 clear: u64 +0x10 is set. | |||
|- | |||
| 0x1D || 0x3 || Padding | |||
|} | |||
= ApplicationResourceType = | |||
This is "nn::ns::ApplicationResourceType". This is an u8. | |||
{| class="wikitable" border="1" | |||
|- | |||
! Value | |||
! Description | |||
|- | |||
| 0 || ApplicationResource | |||
|- | |||
| 1 || MicroApplicationResource | |||
|} | |||
= ApplicationErrorCodeCategory = | |||
This is "nn::ns::ApplicationErrorCodeCategory". This is an u64. | |||
= NoDownloadRightsErrorResolution = | |||
This is "nn::ns::NoDownloadRightsErrorResolution". | |||
= BackgroundNetworkUpdateState = | |||
This is "nn::ns::BackgroundNetworkUpdateState". This is an u8. | |||
{| class="wikitable" border="1" | |||
|- | |||
! Value | |||
! Description | |||
|- | |||
| 0 || None | |||
|- | |||
| 1 || InProgress | |||
|- | |||
| 2 || Ready | |||
|} | |||
Similar to [[#HasDownloaded]], [[#GetBackgroundNetworkUpdateState]] uses [[NIM_services|nim]] ListSystemUpdateTask and [[NIM_services|nim]] GetSystemUpdateTaskInfo. When ListSystemUpdateTask successfully returns a task and GetSystemUpdateTaskInfo is successful, the output value is set to: <code>1 + *((u8*)(taskinfo+0) == 0x3</code>. Otherwise, value=0. | |||
[[#GetBackgroundNetworkUpdateState]] always returns Result 0, however this will assert if GetSystemUpdateTaskInfo fails with ret!=0x3C89. | |||
= SystemUpdateProgress = | |||
This is "nn::ns::SystemUpdateProgress". This is a 0x10-byte struct. | |||
{| class="wikitable" border="1" | |||
|- | |||
! Offset | |||
! Size | |||
! Description | |||
|- | |||
| 0x0 || 0x8 || Loaded (this value can be larger than total_size when the async operation is finishing and when total_size is <=0, this current_size field may contain a progress value for when the total_size is not yet determined) | |||
|- | |||
| 0x8 || 0x8 || Total (this field is only valid when >0) | |||
|} | |||
Commands which have this as output will return 0 with the output cleared, when no task is available. | |||
= EulaDataPath = | |||
This is "nn::ns::detail::EulaDataPath". This is a 0x100-byte struct. | |||
This contains a file path. | |||
= SystemDeliveryInfo = | |||
This is "nn::ns::SystemDeliveryInfo". This is a 0x100-byte struct. | |||
[20.0.0+] The used (New)SystemUpdateMetaId as selected by NewSystemUpdateMetaIdFlag must now match one of the Ids in [[System_Settings|system-setting]] <code>contents_delivery!acceptable_system_update_ids_string</code>. | |||
{| class="wikitable" border="1" | |||
|- | |||
! Offset | |||
! Size | |||
! Description | |||
|- | |||
| 0x0 || 0x4 || SystemDeliveryProtocolVersion. Must be <= to and match [[System_Settings|system-setting]] <code>contents_delivery!system_delivery_protocol_version</code>. | |||
|- | |||
| 0x4 || 0x4 || ApplicationDeliveryProtocolVersion. Loaded from [[System_Settings|system-setting]] <code>contents_delivery!application_delivery_protocol_version</code>. Unused by [[#RequestSendSystemUpdate]]/[[#RequestReceiveSystemUpdate]], besides HMAC validation. | |||
|- | |||
| 0x8 || 0x1 || HasExFat. Unused by [[#RequestSendSystemUpdate]]/[[#RequestReceiveSystemUpdate]], besides HMAC validation. | |||
|- | |||
| 0x9 || 0x3 || Reserved. | |||
|- | |||
| 0xC || 0x4 || SystemUpdateMetaVersion. | |||
|- | |||
| 0x10 || 0x8 || SystemUpdateMetaId. | |||
|- | |||
| 0x18 || 0x1 || FirmwareVariationId. Used by [[#RequestSendSystemUpdate]]. | |||
|- | |||
| 0x19 || 0x1 || UpdatableFirmwareGroupId. Unused by [[#RequestSendSystemUpdate]]/[[#RequestReceiveSystemUpdate]], besides HMAC validation. | |||
|- | |||
| 0x1A || 0x1 || PlatformRegion (0x00 = Unknown, 0x01 = Global, 0x02 = China). | |||
|- | |||
| 0x1B || 0x1 || [20.0.0+] SystemDeliveryInfoPlatform. Loaded from [[System_Settings|system-setting]] <code>ns.systemupdate!system_delivery_info_platform</code>. Elsewhere this is compared against the sys-setting, etc. | |||
|- | |||
| 0x1C || 0x1 || [20.0.0+] NewSystemUpdateMetaIdFlag. When non-zero, NewSystemUpdateMetaId is used instead of SystemUpdateMetaId. Always set to 0x1 by [[#GetSystemDeliveryInfo]] with [20.0.0+]. | |||
|- | |||
| 0x1D || 0x3 || Padding | |||
|- | |- | ||
| | | 0x20 || 0x8 || [20.0.0+] NewSystemUpdateMetaId. See above. With [20.0.0+] [[#GetSystemDeliveryInfo]] now writes the Id here instead of SystemUpdateMetaId. | ||
|- | |- | ||
| | | 0x28 || 0xB8 || Unused by [[#RequestSendSystemUpdate]]/[[#RequestReceiveSystemUpdate]], besides HMAC validation. | ||
|- | |- | ||
| 0xE0 || 0x20 || HMAC-SHA256 over the previous 0xE0-bytes. | | 0xE0 || 0x20 || HMAC-SHA256 over the previous 0xE0-bytes. | ||