NIM services: Difference between revisions
No edit summary |
|||
(24 intermediate revisions by 2 users not shown) | |||
Line 18: | Line 18: | ||
| 5 || [[#CommitSystemUpdateTask]] | | 5 || [[#CommitSystemUpdateTask]] | ||
|- | |- | ||
| 6 || | | 6 || CreateNetworkInstallTaskDeprecated | ||
|- | |- | ||
| 7 || DestroyNetworkInstallTask | | 7 || DestroyNetworkInstallTask | ||
Line 66: | Line 66: | ||
| 30 || [2.0.0+] RequestVersionList | | 30 || [2.0.0+] RequestVersionList | ||
|- | |- | ||
| 31 || [2.0.0+] CreateApplyDeltaTask | | 31 || [2.0.0+] [[#CreateApplyDeltaTask]] | ||
|- | |- | ||
| 32 || [2.0.0+] DestroyApplyDeltaTask | | 32 || [2.0.0+] DestroyApplyDeltaTask | ||
Line 172: | Line 172: | ||
| 83 || [4.0.0+] CalculateApplyDeltaTaskOccupiedSize | | 83 || [4.0.0+] CalculateApplyDeltaTaskOccupiedSize | ||
|- | |- | ||
| 84 || [5.0.0+] | | 84 || [5.0.0+] ReloadErrorSimulation | ||
|- | |- | ||
| 85 || [5.0.0+] ListNetworkInstallTaskContentMetaFromInstallMeta | | 85 || [5.0.0+] ListNetworkInstallTaskContentMetaFromInstallMeta | ||
Line 178: | Line 178: | ||
| 86 || [5.0.0+] ListNetworkInstallTaskOccupiedSize | | 86 || [5.0.0+] ListNetworkInstallTaskOccupiedSize | ||
|- | |- | ||
| 87 || [6.0.0+] | | 87 || [6.0.0+] RequestQueryAvailableELicenses | ||
|- | |- | ||
| 88 || [6.0.0+] | | 88 || [6.0.0+] RequestAssignELicenses | ||
|- | |- | ||
| 89 || [6.0.0+] | | 89 || [6.0.0+] RequestExtendELicenses | ||
|- | |- | ||
| 90 || [6.0.0+] | | 90 || [6.0.0+] RequestSyncELicenses | ||
|- | |- | ||
| 91 || [6.0.0 | | 91 || [6.0.0-14.1.2] | ||
|- | |- | ||
| 92 || [6.0.0 | | 92 || [6.0.0-19.0.1] RequestQueryRevokeReason | ||
|- | |- | ||
| 93 || [6.0.0+] | | 93 || [6.0.0+] RequestReportActiveELicenses | ||
|- | |- | ||
| 94 || [6.0.0+] | | 94 || [6.0.0+] RequestReportActiveELicensesPassively | ||
|- | |- | ||
| 95 || [6.0.0+] | | 95 || [6.0.0+] RequestRegisterDynamicRightsNotificationToken | ||
|- | |- | ||
| 96 || [6.0.0+] | | 96 || [6.0.0+] RequestAssignAllDeviceLinkedELicenses | ||
|- | |- | ||
| 97 || [6.0.0+] | | 97 || [6.0.0+] RequestRevokeAllELicenses | ||
|- | |- | ||
| 98 || [6.0.0+] | | 98 || [6.0.0+] RequestPrefetchForDynamicRights | ||
|- | |- | ||
| 99 || [7.0.0+] | | 99 || [7.0.0+] CreateNetworkInstallTask | ||
|- | |- | ||
| 100 || [9.0.0+] | | 100 || [9.0.0+] ListNetworkInstallTaskRightsIds | ||
|- | |- | ||
| 101 || [9.0.0+] | | 101 || [9.0.0+] RequestDownloadETickets | ||
|- | |- | ||
| 102 || [9.0.0+] | | 102 || [9.0.0+] RequestQueryDownloadableContents | ||
|- | |- | ||
| 103 || [9.0.0+] | | 103 || [9.0.0+] DeleteNetworkInstallTaskContentMeta | ||
|- | |- | ||
| 104 || [9.0.0+] | | 104 || [9.0.0+] RequestIssueEdgeTokenForDebug | ||
|- | |- | ||
| 105 || [9.0.0+] | | 105 || [9.0.0+] RequestQueryAvailableELicenses2 | ||
|- | |- | ||
| 106 || [9.0.0+] | | 106 || [9.0.0+] RequestAssignELicenses2 | ||
|- | |- | ||
| 107 || [10.0.0+] | | 107 || [10.0.0+] GetNetworkInstallTaskStateCounter | ||
|- | |- | ||
| 108 || [10.0.0+] | | 108 || [10.0.0+] InvalidateDynamicRightsNaIdTokenCacheForDebug | ||
|- | |- | ||
| 109 || [10.0.0+] | | 109 || [10.0.0+] ListNetworkInstallTaskPartialInstallContentMeta | ||
|- | |- | ||
| 110 || [10.0.0+] | | 110 || [10.0.0+] ListNetworkInstallTaskRightsIdsFromIndex | ||
|- | |- | ||
| 111 || [10.0.0+] | | 111 || [10.0.0+] AddNetworkInstallTaskContentMetaForUser | ||
|- | |- | ||
| 112 || [10.0.0+] | | 112 || [10.0.0+] RequestAssignELicensesAndDownloadETickets | ||
|- | |- | ||
| 113 || [10.0.0+] | | 113 || [10.0.0+] RequestQueryAvailableCommonELicenses | ||
|- | |- | ||
| 114 || [10.0.0+] | | 114 || [10.0.0+] SetNetworkInstallTaskExtendedAttribute | ||
|- | |- | ||
| 115 || [10.0.0+] | | 115 || [10.0.0+] GetNetworkInstallTaskExtendedAttribute | ||
|- | |- | ||
| 116 || [10.0.0+] | | 116 || [10.0.0+] GetAllocatorInfo | ||
|- | |- | ||
| 117 || [11.0.0+] | | 117 || [11.0.0+] RequestQueryDownloadableContentsByApplicationId | ||
|- | |- | ||
| 118 || [10.0.0+] | | 118 || [10.0.0+] MarkNoDownloadRightsErrorResolved | ||
|- | |- | ||
| 119 || [11.0.0+] | | 119 || [11.0.0+] [[#GetApplyDeltaTaskAllAppliedContentMeta]] | ||
|- | |- | ||
| 120 || [11.0.0+] | | 120 || [11.0.0+] PrioritizeNetworkInstallTask | ||
|- | |- | ||
| 121 || [10.1.0+] | | 121 || [10.1.0+] RequestQueryAvailableCommonELicenses2 | ||
|- | |- | ||
| 122 || [10.1.0+] | | 122 || [10.1.0+] RequestAssignCommonELicenses | ||
|- | |- | ||
| 123 || [10.1.0+] | | 123 || [10.1.0+] RequestAssignCommonELicenses2 | ||
|- | |- | ||
| 124 || [11.0.0+] | | 124 || [11.0.0+] IsNetworkInstallTaskFrontOfQueue | ||
|- | |- | ||
| 125 || [11.0.0+] | | 125 || [11.0.0+] PrioritizeApplyDeltaTask | ||
|- | |- | ||
| 126 || [12.0.0+] | | 126 || [12.0.0+] RerouteDownloadingPatch | ||
|- | |- | ||
| 127 || [12.0.0+] | | 127 || [12.0.0+] UnmarkNoDownloadRightsErrorResolved | ||
|- | |- | ||
| 128 || [12.0.0+] | | 128 || [12.0.0+] RequestContentsSize | ||
|- | |- | ||
| 129 || [12.0.0+] | | 129 || [12.0.0+] RequestContentsAuthorizationToken | ||
|- | |- | ||
| 130 || [13.0.0+] | | 130 || [13.0.0+] RequestCdnVendorDiscovery | ||
|- | |- | ||
| 131 || [13.0.0+] | | 131 || [13.0.0+] RefreshDebugAvailability | ||
|- | |- | ||
| 132 || [13.0.0+] | | 132 || [13.0.0+] ClearResponseSimulationEntry | ||
|- | |- | ||
| 133 || [13.0.0+] | | 133 || [13.0.0+] RegisterResponseSimulationEntry | ||
|- | |- | ||
| 134 || [13.0.0+] | | 134 || [13.0.0+] GetProcessedCdnVendors | ||
|- | |||
| 135 || [14.0.0+] RefreshRuntimeBehaviorsForDebug | |||
|- | |||
| 136 || [14.0.0+] RequestOnlineSubscriptionFreeTrialAvailability | |||
|- | |||
| 137 || [14.0.0+] GetNetworkInstallTaskContentMetaCount | |||
|- | |||
| 138 || [15.0.0+] RequestRevokeELicenses | |||
|- | |||
| 139 || [15.0.0+] EnableNetworkConnectionToUseApplicationCore | |||
|- | |||
| 140 || [15.0.0+] DisableNetworkConnectionToUseApplicationCore | |||
|- | |||
| 141 || [15.0.0+] IsNetworkConnectionEnabledToUseApplicationCore | |||
|- | |||
| 142 || [17.0.0+] RequestCheckSafeSystemVersion | |||
|- | |||
| 143 || [17.0.0+] [[#RequestApplicationIcon]] | |||
|- | |||
| 144 || [17.0.0+] RequestDownloadIdbeIconFile | |||
|- | |||
| 147 || [18.0.0+] | |||
|- | |||
| 148 || [18.0.0+] | |||
|- | |||
| 150 || [19.0.0+] | |||
|- | |||
| 151 || [20.0.0+] | |||
|- | |||
| 152 || [20.0.0+] | |||
|- | |||
| 153 || [20.0.0+] | |||
|- | |||
| 154 || [20.0.0+] | |||
|- | |||
| 155 || [20.0.0+] | |||
|- | |||
| 156 || [20.0.0+] | |||
|- | |||
| 157 || [20.0.0+] | |||
|- | |||
| 158 || [20.0.0+] | |||
|- | |||
| 159 || [20.0.0+] | |||
|- | |||
| 160 || [20.0.0+] | |||
|- | |||
| 161 || [20.0.0+] | |||
|- | |||
| 162 || [20.0.0+] | |||
|- | |||
| 163 || [20.0.0+] | |||
|- | |||
| 164 || [20.0.0+] | |||
|- | |||
| 165 || [20.0.0+] | |||
|- | |||
| 166 || [20.0.0+] | |||
|- | |||
| 167 || [20.0.0+] | |||
|- | |||
| 168 || [20.0.0+] | |||
|- | |||
| 169 || [20.0.0+] | |||
|- | |||
| 170 || [20.0.0+] | |||
|- | |||
| 171 || [20.0.0+] | |||
|- | |||
| 172 || [20.0.0+] | |||
|- | |||
| 173 || [20.1.0+] | |||
|- | |||
| 2000 || [20.0.0+] | |||
|- | |||
| 2001 || [20.0.0+] | |||
|- | |||
| 2002 || [20.0.0+] | |||
|- | |||
| 2003 || [20.0.0+] | |||
|- | |||
| 2004 || [20.0.0+] | |||
|- | |||
| 2007 || [20.0.0+] | |||
|- | |||
| 2011 || [20.0.0+] | |||
|- | |||
| 2012 || [20.0.0+] | |||
|- | |||
| 2013 || [20.0.0+] | |||
|- | |||
| 2014 || [20.0.0+] | |||
|- | |||
| 2015 || [20.0.0+] | |||
|- | |||
| 2016 || [20.0.0+] | |||
|- | |||
| 2017 || [20.0.0+] | |||
|- | |||
| 2018 || [20.0.0+] | |||
|- | |||
| 2019 || [20.0.0+] | |||
|- | |||
| 2020 || [20.0.0+] | |||
|- | |||
| 2021 || [20.0.0+] | |||
|- | |||
| 2022 || [20.0.0+] | |||
|- | |||
| 2023 || [20.0.0+] | |||
|- | |||
| 2024 || [20.0.0+] | |||
|- | |||
| 2025 || [20.0.0+] | |||
|- | |||
| 2026 || [20.0.0+] | |||
|- | |||
| 2027 || [20.0.0+] | |||
|- | |||
| 2028 || [20.0.0+] | |||
|- | |||
| 2029 || [20.0.0+] | |||
|- | |||
| 2030 || [20.0.0+] | |||
|- | |||
| 2031 || [20.0.0+] | |||
|- | |||
| 2032 || [20.0.0+] | |||
|- | |||
| 2033 || [20.0.0+] | |||
|- | |||
| 2034 || [20.0.0+] | |||
|- | |||
| 2035 || [20.0.0+] | |||
|- | |||
| 2036 || [20.0.0+] | |||
|- | |||
| 2037 || [20.0.0+] | |||
|- | |||
| 2038 || [20.0.0+] | |||
|- | |||
| 2039 || [20.0.0+] | |||
|- | |||
| 2040 || [20.0.0+] | |||
|- | |||
| 2041 || [20.0.0+] | |||
|- | |||
| 2042 || [20.0.0+] | |||
|- | |||
| 2043 || [20.0.0+] | |||
|- | |||
| 2044 || [20.0.0+] | |||
|- | |||
| 2045 || [20.0.0+] | |||
|- | |||
| 2046 || [20.0.0+] | |||
|- | |||
| 2047 || [20.0.0+] | |||
|- | |||
| 2048 || [20.0.0+] | |||
|- | |||
| 2049 || [20.0.0+] | |||
|- | |||
| 2050 || [20.0.0+] | |||
|- | |||
| 2051 || [20.0.0+] | |||
|- | |||
| 3000 || [17.0.0+] RequestLatestApplicationIcon | |||
|- | |||
| 3001 || [17.0.0+] RequestDownloadIdbeLatestIconFile | |||
|} | |} | ||
[5.0.0+] RequestGameCardRegistrationStatus/RequestRegisterGameCard removed 8-bytes of input, and now takes an additional type-0x5 input buffer. | [5.0.0+] RequestGameCardRegistrationStatus/RequestRegisterGameCard removed 8-bytes of input, and now takes an additional type-0x5 input buffer. | ||
[ | [12.0.0+] RequestQueryRevokeReason now returns an [[#IAsyncData]] instead of [[#IAsyncValue]]. | ||
== CreateSystemUpdateTask == | |||
Takes an input u32 firmware_variation, a [[NCM_services#ContentMetaKey|ContentMetaKey]], returns an output [[#SystemUpdateTaskId]]. | |||
[8.0.0+] Takes an input u32 firmware_variation, an u32 '''unk''', a [[NCM_services#ContentMetaKey|ContentMetaKey]], returns an output [[#SystemUpdateTaskId]]. | |||
Takes an input u32 firmware_variation, an u32 '''unk''', a [[NCM_services#ContentMetaKey|ContentMetaKey]], returns an output [[#SystemUpdateTaskId]]. | |||
Official sw sets '''unk''' to: <code>unk = inflag & 1 ? 0xC : 0x4</code>. | Official sw sets '''unk''' to: <code>unk = inflag & 1 ? 0xC : 0x4</code>. | ||
Line 304: | Line 474: | ||
== GetNetworkInstallTaskInfo == | == GetNetworkInstallTaskInfo == | ||
Takes an input [[# | Takes an input [[#NetworkInstallTaskId]], returns an output [[#NetworkInstallTaskInfo]]. | ||
== GetDownloadedSystemDataPath == | == GetDownloadedSystemDataPath == | ||
Takes an input u64 titleID, a [[#SystemUpdateTaskId]], and an type-0x16 output buffer containing the [[Filesystem_services| | Takes an input u64 titleID, a [[#SystemUpdateTaskId]], and an type-0x16 output buffer containing the [[Filesystem_services#FspPath|FspPath]]. | ||
Gets the FS | Gets the FS FspPath for the specified task and title. | ||
== IsExFatDriverIncluded == | == IsExFatDriverIncluded == | ||
Takes an input [[#SystemUpdateTaskId]], returns an output u8 bool flag. | Takes an input [[#SystemUpdateTaskId]], returns an output u8 bool flag. | ||
== CreateApplyDeltaTask == | |||
[20.0.0+] The type-0x5 input buffer is now 0x18-bytes instead of 0x10-bytes. | |||
== GetApplyDeltaTaskInfo == | == GetApplyDeltaTaskInfo == | ||
Takes an input [[# | Takes an input [[#ApplyDeltaTaskId]], returns an output [[#ApplyDeltaTaskInfo]]. | ||
== CreateLocalCommunicationReceiveApplicationTask == | == CreateLocalCommunicationReceiveApplicationTask == | ||
Takes an input [[NCM_services#StorageId|StorageId]], an u16 port, an u32 Ipv4Address, an u32 '''unk''', an u64 <code>nn::ncm::ApplicationId</code>, a type-0x5 input buffer containing an array of [[NCM_services#ContentMetaKey|ContentMetaKey]], returns an output [[# | Takes an input [[NCM_services#StorageId|StorageId]], an u16 port, an u32 Ipv4Address, an u32 '''unk''', an u64 <code>nn::ncm::ApplicationId</code>, a type-0x5 input buffer containing an array of [[NCM_services#ContentMetaKey|ContentMetaKey]], returns an output [[#LocalCommunicationReceiveApplicationTaskId]]. | ||
This is the ReceiveApplication version of [[#CreateLocalCommunicationReceiveSystemUpdateTask]]. | This is the ReceiveApplication version of [[#CreateLocalCommunicationReceiveSystemUpdateTask]]. | ||
Line 327: | Line 498: | ||
== RequestLocalCommunicationReceiveApplicationTaskRun == | == RequestLocalCommunicationReceiveApplicationTaskRun == | ||
Takes an input [[# | Takes an input [[#LocalCommunicationReceiveApplicationTaskId]], returns an output Event and an [[#IAsyncResult]]. | ||
This is the ReceiveApplication version of [[#RequestLocalCommunicationReceiveSystemUpdateTaskRun]]. | This is the ReceiveApplication version of [[#RequestLocalCommunicationReceiveSystemUpdateTaskRun]]. | ||
== GetLocalCommunicationReceiveApplicationTaskInfo == | == GetLocalCommunicationReceiveApplicationTaskInfo == | ||
Takes an input [[# | Takes an input [[#LocalCommunicationReceiveApplicationTaskId]], returns an output [[#LocalCommunicationReceiveApplicationTaskInfo]]. | ||
This is the ReceiveApplication version of [[# | This is the ReceiveApplication version of [[#GetLocalCommunicationReceiveSystemUpdateTaskInfo]]. | ||
== CreateLocalCommunicationSendApplicationTask == | == CreateLocalCommunicationSendApplicationTask == | ||
Takes an input u16 port, an u32 Ipv4Address, an u64 <code>nn::ncm::ApplicationId</code>, a type-0x5 input buffer containing an array of { | Takes an input u16 port, an u32 Ipv4Address, an u64 <code>nn::ncm::ApplicationId</code>, a type-0x5 input buffer containing an array of {0x18-byte struct}, returns an output [[#LocalCommunicationSendApplicationTaskId]]. | ||
This is the SendApplication version of [[# | This is the SendApplication version of [[#CreateLocalCommunicationSendSystemUpdateTask]]. | ||
== RequestLocalCommunicationSendApplicationTaskRun == | == RequestLocalCommunicationSendApplicationTaskRun == | ||
Takes an input [[# | Takes an input [[#LocalCommunicationSendApplicationTaskId]], returns an output Event and an [[#IAsyncResult]]. | ||
This is the | This is the SendApplication version of [[#RequestLocalCommunicationSendSystemUpdateTaskRun]]. | ||
== GetLocalCommunicationSendApplicationTaskInfo == | == GetLocalCommunicationSendApplicationTaskInfo == | ||
Takes an input [[# | Takes an input [[#LocalCommunicationSendApplicationTaskId]], returns an output [[#LocalCommunicationSendApplicationTaskInfo]]. | ||
This is the SendApplication version of [[# | This is the SendApplication version of [[#GetLocalCommunicationSendSystemUpdateTaskInfo]]. | ||
== ListApplicationLocalCommunicationReceiveApplicationTask == | == ListApplicationLocalCommunicationReceiveApplicationTask == | ||
Takes a type-0x6 output buffer containing an array of [[# | Takes a type-0x6 output buffer containing an array of [[#LocalCommunicationReceiveApplicationTaskId]] and an input u64 <code>nn::ncm::ApplicationId</code>. Returns a s32 for total output entries. | ||
This is the ReceiveApplication version of [[#ListLocalCommunicationReceiveSystemUpdateTask]]. | This is the ReceiveApplication version of [[#ListLocalCommunicationReceiveSystemUpdateTask]]. | ||
== ListApplicationLocalCommunicationSendApplicationTask == | == ListApplicationLocalCommunicationSendApplicationTask == | ||
Takes a type-0x6 output buffer containing an array of [[# | Takes a type-0x6 output buffer containing an array of [[#LocalCommunicationSendApplicationTaskId]] and an input u64 <code>nn::ncm::ApplicationId</code>. Returns a s32 for total output entries. | ||
This is the SendApplication version of [[# | This is the SendApplication version of [[#ListLocalCommunicationSendSystemUpdateTask]]. | ||
== CreateLocalCommunicationReceiveSystemUpdateTask == | == CreateLocalCommunicationReceiveSystemUpdateTask == | ||
Takes an input u16 port, an u32 Ipv4Address, an u32 firmware_variation, an u32 '''unk''', a [[NCM_services#ContentMetaKey|ContentMetaKey]], returns an output [[# | Takes an input u16 port, an u32 Ipv4Address, an u32 firmware_variation, a [[NCM_services#ContentMetaKey|ContentMetaKey]], returns an output [[#LocalCommunicationReceiveSystemUpdateTaskId]]. | ||
[8.0.0+] Takes an input u16 port, an u32 Ipv4Address, an u32 firmware_variation, an u32 '''unk''', a [[NCM_services#ContentMetaKey|ContentMetaKey]], returns an output [[#LocalCommunicationReceiveSystemUpdateTaskId]]. | |||
Official sw sets '''unk''' to: <code>unk = stateflag==0 ? 0x4 : 0xC</code>. The port/Ipv4Address params originate from the [[NS_Services#RequestReceiveSystemUpdate|RequestReceiveSystemUpdate]] params. | Official sw sets '''unk''' to: <code>unk = stateflag==0 ? 0x4 : 0xC</code>. The port/Ipv4Address params originate from the [[NS_Services#RequestReceiveSystemUpdate|RequestReceiveSystemUpdate]] params. | ||
Line 390: | Line 563: | ||
== ListLocalCommunicationReceiveSystemUpdateTask == | == ListLocalCommunicationReceiveSystemUpdateTask == | ||
Takes a type-0x6 output buffer, for an array of [[# | Takes a type-0x6 output buffer, for an array of [[#LocalCommunicationReceiveSystemUpdateTaskId]]. Returns a s32 for total output entries. | ||
This is the ReceiveSystemUpdate version of [[#ListSystemUpdateTask]]. | This is the ReceiveSystemUpdate version of [[#ListSystemUpdateTask]]. | ||
== RequestLocalCommunicationReceiveSystemUpdateTaskRun == | == RequestLocalCommunicationReceiveSystemUpdateTaskRun == | ||
Takes an input [[# | Takes an input [[#LocalCommunicationReceiveSystemUpdateTaskId]], returns an output Event and an [[#IAsyncResult]]. | ||
This is the ReceiveSystemUpdate version of RequestSystemUpdateTaskRun. | This is the ReceiveSystemUpdate version of RequestSystemUpdateTaskRun. | ||
This creates the [[#IAsyncResult]] object + the async [[#Contents_Delivery|thread]] which handles the [[#IAsyncResult]] operation, which uses the state previously setup by [[# | This creates the [[#IAsyncResult]] object + the async [[#Contents_Delivery|thread]] which handles the [[#IAsyncResult]] operation, which uses the state previously setup by [[#CreateLocalCommunicationReceiveSystemUpdateTask]]. This throws an error if the object was already created. | ||
== GetLocalCommunicationReceiveSystemUpdateTaskInfo == | == GetLocalCommunicationReceiveSystemUpdateTaskInfo == | ||
Takes an input [[# | Takes an input [[#LocalCommunicationReceiveSystemUpdateTaskId]], returns an output [[#LocalCommunicationReceiveSystemUpdateTaskInfo]]. | ||
This is the ReceiveSystemUpdate version of [[#GetSystemUpdateTaskInfo]]. | This is the ReceiveSystemUpdate version of [[#GetSystemUpdateTaskInfo]]. | ||
== CreateLocalCommunicationSendSystemUpdateTask == | == CreateLocalCommunicationSendSystemUpdateTask == | ||
Takes an input u16 port, an u32 Ipv4Address, an u32 firmware_variation, and a [[NCM_services#ContentMetaKey|ContentMetaKey]], returns an output [[# | Takes an input u16 port, an u32 Ipv4Address, and a [[NCM_services#ContentMetaKey|ContentMetaKey]], returns an output [[#LocalCommunicationSendSystemUpdateTaskId]]. | ||
[8.0.0+] Takes an input u16 port, an u32 Ipv4Address, an u32 firmware_variation, and a [[NCM_services#ContentMetaKey|ContentMetaKey]], returns an output [[#LocalCommunicationSendSystemUpdateTaskId]]. | |||
The port/Ipv4Address params originate from the [[NS_Services#RequestSendSystemUpdate|RequestSendSystemUpdate]] params. | The port/Ipv4Address params originate from the [[NS_Services#RequestSendSystemUpdate|RequestSendSystemUpdate]] params. | ||
Line 424: | Line 599: | ||
* u64 tmpval=1; setsockopt(sockfd, SOL_SOCKET, SO_VENDOR + 0x1, &tmpval, sizeof(tmpval)); {handle error on fail} | * u64 tmpval=1; setsockopt(sockfd, SOL_SOCKET, SO_VENDOR + 0x1, &tmpval, sizeof(tmpval)); {handle error on fail} | ||
* u32 tmpval2=1; setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR, &tmpval2, sizeof(tmpval2)); {handle error on fail} | * u32 tmpval2=1; setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR, &tmpval2, sizeof(tmpval2)); {handle error on fail} | ||
* Initializes sockaddr_in: sin_addr = htonl( | * Initializes sockaddr_in: sin_addr = htonl(INADDR_ANY), sin_port = htons({input port}), and sin_family = AF_INET (sin_len is left at 0). | ||
* bind(sockfd, sockaddr_in, sizeof(sockaddr_in)); {handle error on fail} | * bind(sockfd, sockaddr_in, sizeof(sockaddr_in)); {handle error on fail} | ||
* listen(sockfd, 1); {handle error on fail} | * listen(sockfd, 1); {handle error on fail} | ||
Line 431: | Line 606: | ||
== RequestLocalCommunicationSendSystemUpdateTaskRun == | == RequestLocalCommunicationSendSystemUpdateTaskRun == | ||
Takes an input [[# | Takes an input [[#LocalCommunicationSendSystemUpdateTaskId]], returns an output Event and an [[#IAsyncResult]]. | ||
This is the Send version of [[#RequestLocalCommunicationReceiveSystemUpdateTaskRun]]. | This is the Send version of [[#RequestLocalCommunicationReceiveSystemUpdateTaskRun]]. | ||
Line 438: | Line 613: | ||
== GetLocalCommunicationSendSystemUpdateTaskInfo == | == GetLocalCommunicationSendSystemUpdateTaskInfo == | ||
Takes an input [[# | Takes an input [[#LocalCommunicationSendSystemUpdateTaskId]], returns an output [[#LocalCommunicationSendSystemUpdateTaskInfo]]. | ||
This is the Send version of [[#GetLocalCommunicationReceiveSystemUpdateTaskInfo]]. | This is the Send version of [[#GetLocalCommunicationReceiveSystemUpdateTaskInfo]]. | ||
== ListLocalCommunicationSendSystemUpdateTask == | == ListLocalCommunicationSendSystemUpdateTask == | ||
Takes a type-0x6 output buffer, for an array of [[# | Takes a type-0x6 output buffer, for an array of [[#LocalCommunicationSendSystemUpdateTaskId]]. Returns a s32 for total output entries. | ||
This is the Send version of [[#ListLocalCommunicationReceiveSystemUpdateTask]]. | This is the Send version of [[#ListLocalCommunicationReceiveSystemUpdateTask]]. | ||
== | == GetApplyDeltaTaskAllAppliedContentMeta == | ||
[20.0.0+] Now takes a 0x18-bytes type-0x6 output buffer and returns 4-bytes of output instead of 0x18-bytes. | |||
== | == RequestApplicationIcon == | ||
[20.0.0+] Now takes 0x20-bytes of input instead of 0x18-bytes. | |||
= nim:shp = | = nim:shp = | ||
This is "nn::nim::detail::IShopServiceManager". | This is "nn::nim::detail::IShopServiceManager". | ||
This is only available when [[Process_Manager_services|pm:bm]] GetBootMode returns output 0 (Normal). | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
Line 584: | Line 649: | ||
| 101 || RequestUnregisterDeviceAccount | | 101 || RequestUnregisterDeviceAccount | ||
|- | |- | ||
| 102 || RequestDeviceAccountStatus | | 102 || [1.0.0-14.1.2] RequestDeviceAccountStatus | ||
|- | |- | ||
| 103 || GetDeviceAccountInfo | | 103 || [1.0.0-14.1.2] GetDeviceAccountInfo | ||
|- | |- | ||
| 104 || RequestDeviceRegistrationInfo | | 104 || [1.0.0-14.1.2] RequestDeviceRegistrationInfo | ||
|- | |- | ||
| 105 || RequestTransferDeviceAccount | | 105 || [1.0.0-14.1.2] RequestTransferDeviceAccount | ||
|- | |- | ||
| 106 || [3.0.0 | | 106 || [3.0.0-14.1.2] RequestSyncRegistration | ||
|- | |- | ||
| 107 || [3.0.0+] IsOwnDeviceId | | 107 || [3.0.0+] IsOwnDeviceId | ||
|- | |||
| 108 || [14.0.0+] RevertSystemSaveDataOfDeviceAccountForDebug | |||
|- | |- | ||
| 200 || RequestRegisterNotificationToken | | 200 || RequestRegisterNotificationToken | ||
Line 604: | Line 671: | ||
| 302 || RequestLinkDevice | | 302 || RequestLinkDevice | ||
|- | |- | ||
| 303 || HasDeviceLink | | 303 || [1.0.0-13.2.1] HasDeviceLink | ||
|- | |- | ||
| 304 || [4.0.0+] RequestUnlinkDeviceAll | | 304 || [4.0.0+] RequestUnlinkDeviceAll | ||
|- | |- | ||
| 305 || [4.0.0 | | 305 || [4.0.0-13.2.1] RequestCreateVirtualAccount | ||
|- | |- | ||
| 306 || [4.0.0+] RequestDeviceLinkStatus | | 306 || [4.0.0+] RequestDeviceLinkStatus | ||
|- | |- | ||
| 400 || GetAccountByVirtualAccount | | 400 || [1.0.0-13.2.1] GetAccountByVirtualAccount | ||
|- | |- | ||
| 401 || [6.0.0 | | 401 || [6.0.0-13.2.1] GetVirtualAccount | ||
|- | |- | ||
| 500 || RequestSyncTicketLegacy ([1.0.0-8.1.0] RequestSyncTicket) | | 500 || RequestSyncTicketLegacy ([1.0.0-8.1.0] RequestSyncTicket) | ||
|- | |- | ||
| 501 || RequestDownloadTicket | | 501 || [1.0.0-14.1.2] RequestDownloadTicket | ||
|- | |- | ||
| 502 || [4.0.0+] [[#RequestDownloadTicketForPrepurchasedContents]] | | 502 || [4.0.0+] [[#RequestDownloadTicketForPrepurchasedContents]] | ||
Line 625: | Line 692: | ||
|- | |- | ||
| 504 || [9.0.0+] RequestDownloadTicketForPrepurchasedContents2 | | 504 || [9.0.0+] RequestDownloadTicketForPrepurchasedContents2 | ||
|- | |||
| 505 || [13.1.0+] RequestDownloadTicketForPrepurchasedContentsForAccount | |||
|- | |||
| 600 || [14.0.0+] IsInitialLaunchFinished | |||
|- | |||
| 601 || [14.0.0+] NotifyFinishInitialLaunch | |||
|} | |} | ||
Line 634: | Line 707: | ||
This was added with [5.0.0+]. | This was added with [5.0.0+]. | ||
This is only available when [[Process_Manager_services|pm:bm]] GetBootMode returns output 0 (Normal). | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
Line 648: | Line 723: | ||
|- | |- | ||
| 4 || [10.0.0+] IsLargeResourceAvailable | | 4 || [10.0.0+] IsLargeResourceAvailable | ||
|- | |||
| 5 || [17.0.0+] CreateServerInterface2 | |||
|} | |} | ||
Line 700: | Line 777: | ||
This was added with [7.0.0+]. | This was added with [7.0.0+]. | ||
This is only available when [[Process_Manager_services|pm:bm]] GetBootMode returns output 0 (Normal). | |||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
Line 744: | Line 823: | ||
|- | |- | ||
| 5 || [3.0.0+] GetServerTime | | 5 || [3.0.0+] GetServerTime | ||
|} | |||
= SystemUpdateTaskId = | |||
This is "nn::nim::SystemUpdateTaskId". This is an 0x10 byte struct containing an nn::util::Uuid. | |||
= SystemUpdateTaskInfo = | |||
This is "nn::nim::SystemUpdateTaskInfo". This is a 0x28-byte struct. | |||
[3.0.0+] This is a 0x38-byte struct. | |||
[5.0.0+] This is a 0x40-byte struct. | |||
{| class="wikitable" border="1" | |||
|- | |||
! Offset | |||
! Size | |||
! Description | |||
|- | |||
| 0x0 || 0x1 || InstallProgressState | |||
|- | |||
| 0x4 || 0x4 || LastResult | |||
|- | |||
| 0x8 || 0x8 || InstalledSize | |||
|- | |||
| 0x10 || 0x8 || TotalSize | |||
|- | |||
| 0x18 || 0x8 || [[NCM_services#ContentMetaKey|ContentMetaKey]] | |||
|- | |||
| 0x28 || 0x8 || BytesInstalled | |||
|- | |||
| 0x30 || 0x8 || ElapsedTimeNs | |||
|- | |||
| 0x38 || 0x1 || SystemUpdateTaskApplyInfo | |||
|} | |||
The first 0x18-bytes are obtained from [[NCM_services#GetProgress]] and the 0x10-bytes at +0x8 are returned by [[NS_Services#GetDownloadProgress]]. | |||
The two u64s at +0x28/+0x30 are obtained from [[NCM_services#GetThroughput]] and used by [[NS_Services|NS]] to calculate "ThroughputKBps" for a SystemPlayReport. | |||
The byte at +0x38 is obtained from [[NCM_services#GetSystemUpdateTaskApplyInfo]]. | |||
= NetworkInstallTaskId = | |||
This is "nn::nim::NetworkInstallTaskId". This is a 0x10-byte struct. | |||
= NetworkInstallTaskInfo = | |||
This is "nn::nim::NetworkInstallTaskInfo". This is a 0x28-byte struct. | |||
[3.0.0+] This is a 0x40-byte struct. | |||
[10.0.0+] This is a 0x48-byte struct. | |||
[14.0.0+] This is a 0x58-byte struct. | |||
[16.0.0+] This is a 0x60-byte struct. | |||
= ApplyDeltaTaskId = | |||
This is "nn::nim::ApplyDeltaTaskId". This is a 0x10-byte struct. | |||
= ApplyDeltaTaskInfo = | |||
This is "nn::nim::ApplyDeltaTaskInfo". This is a 0x20-byte struct. | |||
[3.0.0+] This is a 0x30-byte struct. | |||
= ReceiveSystemUpdateTask = | |||
This is "nn::nim::LocalCommunicationReceiveSystemUpdateTaskId". This is a 0x10-byte struct. | |||
= ReceiveSystemUpdateTaskInfo = | |||
This is "nn::nim::LocalCommunicationReceiveSystemUpdateTaskInfo". This is a 0x38-byte struct. | |||
= SendSystemUpdateTask = | |||
This is "nn::nim::LocalCommunicationSendSystemUpdateTaskId". This is a 0x10-byte struct. | |||
= SendSystemUpdateTaskInfo = | |||
This is "nn::nim::LocalCommunicationSendSystemUpdateTaskInfo". This is a 0x20-byte struct. | |||
{| class="wikitable" border="1" | |||
|- | |||
! Offset | |||
! Size | |||
! Description | |||
|- | |||
| 0x0 || 0x1 || Status | |||
|- | |||
| 0x1 || 0x7 || ? | |||
|- | |||
| 0x8 || 0x10 || [[NS_Services#SystemUpdateProgress|SystemUpdateProgress]] | |||
|- | |||
| 0x18 || 0x1 || Unknown | |||
|- | |||
| 0x19 || 0x7 || Padding | |||
|} | |||
= LocalCommunicationReceiveApplicationTaskId = | |||
This is "nn::nim::LocalCommunicationReceiveApplicationTaskId". This is a 0x10-byte struct. | |||
= LocalCommunicationReceiveApplicationTaskInfo = | |||
This is "nn::nim::LocalCommunicationReceiveApplicationTaskInfo". This is a 0x38-byte struct. | |||
{| class="wikitable" border="1" | |||
|- | |||
! Offset | |||
! Size | |||
! Description | |||
|- | |||
| 0x0 || 0x1 || Status | |||
|- | |||
| 0x1 || 0x7 || ? | |||
|- | |||
| 0x8 || 0x10 || [[NS_Services#ReceiveApplicationProgress|ReceiveApplicationProgress]] | |||
|- | |||
| 0x18 || 0x20 || Unknown | |||
|} | |||
= LocalCommunicationSendApplicationTaskId = | |||
This is "nn::nim::LocalCommunicationSendApplicationTaskId". This is a 0x10-byte struct. | |||
= LocalCommunicationSendApplicationTaskInfo = | |||
This is "nn::nim::LocalCommunicationSendApplicationTaskInfo". This is a 0x20-byte struct. | |||
{| class="wikitable" border="1" | |||
|- | |||
! Offset | |||
! Size | |||
! Description | |||
|- | |||
| 0x0 || 0x1 || Status | |||
|- | |||
| 0x1 || 0x7 || ? | |||
|- | |||
| 0x8 || 0x10 || [[NS_Services#SendApplicationProgress|SendApplicationProgress]] | |||
|- | |||
| 0x18 || 0x8 || Unknown | |||
|} | |} | ||
Line 812: | Line 1,023: | ||
|} | |} | ||
= Contents Delivery = | = Notes = | ||
nnMain calls two funcs only when when [[Process_Manager_services|pm:bm]] GetBootMode output is 0 or 1 (Normal/Maintenance), which are: [[ETicket_services|es]] service init, and [[Account_services|acc:e:u1]] service init. | |||
nnMain only handles [[PSC_services|ovln:snd]] initialization/deinit when the output from [[Process_Manager_services|pm:bm]] GetBootMode is 0 (Normal). | |||
When initializing [[SSL_services|ssl]], when the input flag is 0 it uses SslVersion = {ApiVersion | Auto}, while when flag is set it uses {ApiVersion | <each flag bit for TLS 1.0-1.2>}. The input flag is set when [[Process_Manager_services|pm:bm]] GetBootMode output is 1 or 2 (Maintenance/SafeMode), otherwise it's 0. | |||
nnMain calls a savedata init func with an input flag determined with the output from [[Process_Manager_services|pm:bm]] GetBootMode. flag=0 for BootMode Normal, flag=1 for BootMode non-Normal. When flag is set, it deletes the savedata for savedata [[Flash_Filesystem|nim_sys]], returning the error on failure. Regardless of flag, it then calls a func which handles mounting savedata nim_sys (and creating it if needed). After checking error and calling another func (with error check), if flag is clear it proceeds with handling other savedata etc, otherwise it calls a func (also called with flag=0 once finished) then returns. | |||
Various hosted services require BootMode Normal, see above. | |||
== Contents Delivery == | |||
Content can be transferred with a custom protocol over the network. This is intended for use with local [[LDN_services|ldn]] networks, however the used IP addresses can be arbitrary. This can be used for SystemUpdates via the above Send/Receive commands (which are then used via [[NS_Services#ns:su|ns:su]]). Application Patch content can also be transferred with this. | Content can be transferred with a custom protocol over the network. This is intended for use with local [[LDN_services|ldn]] networks, however the used IP addresses can be arbitrary. This can be used for SystemUpdates via the above Send/Receive commands (which are then used via [[NS_Services#ns:su|ns:su]]). Application Patch content can also be transferred with this. | ||
See [[# | See [[#CreateLocalCommunicationReceiveSystemUpdateTask]]/[[#CreateLocalCommunicationSendSystemUpdateTask]] for the socket setup during Receive/Send task creation. Receive system = client, while Send system = server. | ||
The Receive async [[# | The Receive async [[#RequestLocalCommunicationReceiveSystemUpdateTaskRun|thread]] does the following: | ||
* Sets the <code>nn::fs::PriorityRaw</code> using a value loaded from state. | * [5.0.0+] Sets the <code>nn::fs::PriorityRaw</code> using a value loaded from state. | ||
* Calls a func, and writes the returned Result into state. | * Calls a func, and writes the returned Result into state. | ||
* Signals the async Event and returns. | * Signals the async Event and returns. | ||
Line 824: | Line 1,046: | ||
** This handles installation, with messages being used via vtable funcptrs. | ** This handles installation, with messages being used via vtable funcptrs. | ||
The Send async [[# | The Send async [[#RequestLocalCommunicationSendSystemUpdateTaskRun|thread]] does the following (the SendApplication [[#RequestLocalCommunicationSendApplicationTaskRun|thread]] is identical except it uses different previously setup state): | ||
* This is identical to the Receive thread except the called func is different. | * This is identical to the Receive thread except the called func is different. | ||
** That func does: | ** That func does: | ||
** Gets [[System_Settings|system-setting]] <code>nim.errorsimulate!error_localcommunication_result</code>, returning that as an error if set + non-zero. | ** [5.0.0+] Gets [[System_Settings|system-setting]] <code>nim.errorsimulate!error_localcommunication_result</code>, returning that as an error if set + non-zero. | ||
** Does socket setup: | ** Does socket setup: | ||
** Calls a func. | ** Calls a func. | ||
Line 842: | Line 1,064: | ||
* Enters a loop which repeatedly calls a func. If that func fails, this will immediately return. | * Enters a loop which repeatedly calls a func. If that func fails, this will immediately return. | ||
* Within that loop the following is done: | * Within that loop the following is done: | ||
** sockfd = accept(listen_sockfd, &sockaddr_in, &addrlen); {handle error on fail - listen_sockfd is the saved sockfd from [[# | ** sockfd = accept(listen_sockfd, &sockaddr_in, &addrlen); {handle error on fail - listen_sockfd is the saved sockfd from [[#CreateLocalCommunicationSendSystemUpdateTask]]} | ||
** Exits the loop when the ipaddr within sockaddr_in matches the saved ipaddr in state from [[# | ** Exits the loop when the ipaddr within sockaddr_in matches the saved ipaddr in state from [[#CreateLocalCommunicationSendSystemUpdateTask]] (originally from the cmd input param). Otherwise, close sockfd and continue the loop (with the above func being called again). | ||
* The following is done after the loop: | * The following is done after the loop: | ||
* u64 tmpval=1; setsockopt(sockfd, SOL_SOCKET, SO_VENDOR + 0x1, &tmpval, sizeof(tmpval)); {handle error on fail} | * u64 tmpval=1; setsockopt(sockfd, SOL_SOCKET, SO_VENDOR + 0x1, &tmpval, sizeof(tmpval)); {handle error on fail} | ||
* Uses [[Network_Interface_services|nifm]] GetInternetConnectionStatus, returning an error | * [4.0.0-16.1.0] Uses [[Network_Interface_services|nifm]] GetInternetConnectionStatus, returning an error when the Result is 0xD46E ([6.0.0+] error is thrown when successful). Hence, the output from this is ignored. | ||
* Uses fcntl with F_GETFL/F_SETFL to clear O_NONBLOCK with sockfd, handling error on fail. | * Uses fcntl with F_GETFL/F_SETFL to clear O_NONBLOCK with sockfd, handling error on fail. | ||
* u32 tmpval2=0x4000; | * [4.0.0-10.2.0] u32 tmpval2=0x4000; u32 tmpval3=0x20000; | ||
* [4.0.0-10.2.0] setsockopt(sockfd, SOL_SOCKET, SO_RCVBUF, &tmpval2, sizeof(tmpval2)); {error is ignored} | |||
* setsockopt(sockfd, SOL_SOCKET, SO_RCVBUF, &tmpval2, sizeof(tmpval2)); {error is ignored} | * [4.0.0-10.2.0] setsockopt(sockfd, SOL_SOCKET, SO_SNDBUF, &tmpval3, sizeof(tmpval3)); {error is ignored} | ||
* setsockopt(sockfd, SOL_SOCKET, SO_SNDBUF, &tmpval3, sizeof(tmpval3)); {error is ignored} | |||
* Writes sockfd to the output state sockfd and returns 0. | * Writes sockfd to the output state sockfd and returns 0. | ||
** The func used with the above loop does the following: | ** The func used with the above loop does the following: | ||
Line 888: | Line 1,109: | ||
| 0x0 || 0x0 || 0x0 || Tells the server to exit. When handling this the handler func will immediately return 0, without sending a reply. | | 0x0 || 0x0 || 0x0 || Tells the server to exit. When handling this the handler func will immediately return 0, without sending a reply. | ||
|- | |- | ||
| 0x1 || [[NCM_services#ContentMetaKey|ContentMetaKey]] || [[CNMT#Content_Records|PackagedContentInfo]] || Gets the PackagedContentInfo with type==Meta for the specified ContentMetaKey. The SystemUpdate client uses the ContentMetaKey from [[# | | 0x1 || [[NCM_services#ContentMetaKey|ContentMetaKey]] || [[CNMT#Content_Records|PackagedContentInfo]] || Gets the PackagedContentInfo with type==Meta for the specified ContentMetaKey. The SystemUpdate client uses the ContentMetaKey from [[#CreateLocalCommunicationReceiveSystemUpdateTask]]. | ||
|- | |- | ||
| 0x2 || 0x18-bytes: [[NCM_services#ContentId|ContentId]], u8 flag, u8 pad[7]. When flag is 0, during the transfer [[# | | 0x2 || 0x18-bytes: [[NCM_services#ContentId|ContentId]], u8 flag, u8 pad[7]. When flag is 0, during the transfer [[#LocalCommunicationSendSystemUpdateTaskInfo]] [[NS_Services#SystemUpdateProgress|SystemUpdateProgress]] current_size is increased using the size of the current chunk. Once the transfer is finished, the end result is that it would be increased by the total content-size. The only time the nim client sets this flag to 1 with SystemUpdate is with the SystemUpdate Meta content. || Size from [[NCM_services#GetSizeFromContentId|GetSizeFromContentId]] with data from [[NCM_services#ReadContentIdFile|ReadContentIdFile]]. || Gets the entire content data for the specified ContentId. The client uses each received chunk of data during the transfer with [[NCM_services|WritePlaceHolder]]. | ||
|- | |- | ||
| 0x3 || 0x10-byte input for [[ETicket_services|es]] GetCommonTicketAndCertificateSize/GetCommonTicketAndCertificateData. || 0x8-bytes: two size u32s. Then two blocks of data with the sizes specified by the u32s. The server loads the sizes and data from [[ETicket_services|es]] GetCommonTicketAndCertificateSize/GetCommonTicketAndCertificateData. || The two blocks of data are used as the buffers for [[ETicket_services|es]] ImportTicket by the client. This is used for transferring the specified Application Patch CommonTicket. | | 0x3 || 0x10-byte input for [[ETicket_services|es]] GetCommonTicketAndCertificateSize/GetCommonTicketAndCertificateData ([10.1.0+] also GetTicketInfo). || 0x8-bytes: two size u32s. Then two blocks of data with the sizes specified by the u32s. The server loads the sizes and data from [[ETicket_services|es]] GetCommonTicketAndCertificateSize/GetCommonTicketAndCertificateData. || The two blocks of data are used as the buffers for [[ETicket_services|es]] ImportTicket by the client. This is used for transferring the specified Application Patch CommonTicket. | ||
[10.1.0+] Prior to using GetCommonTicketAndCertificate*, additional functionality with [[ETicket_services|es]] GetTicketInfo was added. This loops through the output array to locate an entry with u64 +0 == 0x0, throwing an error if not found. Then in the located entry, u16 +0x32 bit4 must be clear otherwise an error is thrown. | |||
|- | |- | ||
| 0x4 || s64 total_size || 0x0 || The input data is copied into the server state, for [[# | | 0x4 || s64 total_size || 0x0 || The input data is copied into the server state, for [[#LocalCommunicationSendSystemUpdateTaskInfo]] [[NS_Services#SystemUpdateProgress|SystemUpdateProgress]] total_size. | ||
|} | |} | ||
[[Category:Services]] | [[Category:Services]] |