Line 24: |
Line 24: |
| | 8 || ListNetworkInstallTask | | | 8 || ListNetworkInstallTask |
| |- | | |- |
− | | 9 || RequestNetworkInstallTaskRun | + | | 9 || [[#RequestNetworkInstallTaskRun]] |
| |- | | |- |
| | 10 || [[#GetNetworkInstallTaskInfo]] | | | 10 || [[#GetNetworkInstallTaskInfo]] |
Line 186: |
Line 186: |
| | 90 || [6.0.0+] | | | 90 || [6.0.0+] |
| |- | | |- |
− | | 91 || [6.0.0+] | + | | 91 || [6.0.0-14.1.2] |
| |- | | |- |
| | 92 || [6.0.0+] | | | 92 || [6.0.0+] |
Line 237: |
Line 237: |
| |- | | |- |
| | 116 || [10.0.0+] | | | 116 || [10.0.0+] |
| + | |- |
| + | | 117 || [11.0.0+] |
| |- | | |- |
| | 118 || [10.0.0+] | | | 118 || [10.0.0+] |
| + | |- |
| + | | 119 || [11.0.0+] |
| + | |- |
| + | | 120 || [11.0.0+] |
| |- | | |- |
| | 121 || [10.1.0+] | | | 121 || [10.1.0+] |
Line 245: |
Line 251: |
| |- | | |- |
| | 123 || [10.1.0+] | | | 123 || [10.1.0+] |
| + | |- |
| + | | 124 || [11.0.0+] |
| + | |- |
| + | | 125 || [11.0.0+] |
| + | |- |
| + | | 126 || [12.0.0+] |
| + | |- |
| + | | 127 || [12.0.0+] |
| + | |- |
| + | | 128 || [12.0.0+] |
| + | |- |
| + | | 129 || [12.0.0+] |
| + | |- |
| + | | 130 || [13.0.0+] |
| + | |- |
| + | | 131 || [13.0.0+] |
| + | |- |
| + | | 132 || [13.0.0+] |
| + | |- |
| + | | 133 || [13.0.0+] |
| + | |- |
| + | | 134 || [13.0.0+] |
| + | |- |
| + | | 135 || [14.0.0+] |
| + | |- |
| + | | 136 || [14.0.0+] |
| + | |- |
| + | | 137 || [14.0.0+] |
| + | |- |
| + | | 138 || [15.0.0+] |
| + | |- |
| + | | 139 || [15.0.0+] |
| + | |- |
| + | | 140 || [15.0.0+] |
| + | |- |
| + | | 141 || [15.0.0+] |
| + | |- |
| + | | 142 || [17.0.0+] |
| + | |- |
| + | | 143 || [17.0.0+] |
| + | |- |
| + | | 144 || [17.0.0+] |
| + | |- |
| + | | 147 || [18.0.0+] |
| + | |- |
| + | | 148 || [18.0.0+] |
| + | |- |
| + | | 3000 || [17.0.0+] |
| + | |- |
| + | | 3001 || [17.0.0+] |
| |} | | |} |
| | | |
| [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. |
| | | |
− | [8.0.0+] [[#CreateLocalCommunicationSendSystemUpdateTask]] now takes an additional 0x8-bytes of input. | + | [12.0.0+] Cmd92 now returns an [[#IAsyncData]] instead of [[#IAsyncValue]]. |
| | | |
| == CreateSystemUpdateTask == | | == CreateSystemUpdateTask == |
Line 267: |
Line 323: |
| == CommitSystemUpdateTask == | | == CommitSystemUpdateTask == |
| Takes an input [[#SystemUpdateTaskId]], no output. | | Takes an input [[#SystemUpdateTaskId]], no output. |
| + | |
| + | == RequestNetworkInstallTaskRun == |
| + | Takes a total of 0x10-bytes of input, returns an output [[#IAsyncResult]] and handle. |
| + | |
| + | [13.0.0+] Now takes an additional 1-byte of input. |
| | | |
| == GetNetworkInstallTaskInfo == | | == GetNetworkInstallTaskInfo == |
Line 274: |
Line 335: |
| | | |
| == GetDownloadedSystemDataPath == | | == GetDownloadedSystemDataPath == |
− | Takes an input u64 titleID, a [[#SystemUpdateTaskId]], and an type-0x16 output buffer containing the [[Filesystem_services|ContentPath]]. | + | Takes an input u64 titleID, a [[#SystemUpdateTaskId]], and an type-0x16 output buffer containing the [[Filesystem_services#FspPath|FspPath]]. |
| | | |
− | Gets the FS ContentPath for the specified task and title. | + | Gets the FS FspPath for the specified task and title. |
| | | |
| == IsExFatDriverIncluded == | | == IsExFatDriverIncluded == |
Line 364: |
Line 425: |
| 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 [[#Cmd69]]. This throws an error if the object was already created. | + | 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 == |
Line 373: |
Line 434: |
| == CreateLocalCommunicationSendSystemUpdateTask == | | == CreateLocalCommunicationSendSystemUpdateTask == |
| Takes an input u16 port, an u32 Ipv4Address, an u32 firmware_variation, and a [[NCM_services#ContentMetaKey|ContentMetaKey]], returns an output [[#SendSystemUpdateTask]]. | | Takes an input u16 port, an u32 Ipv4Address, an u32 firmware_variation, and a [[NCM_services#ContentMetaKey|ContentMetaKey]], returns an output [[#SendSystemUpdateTask]]. |
| + | |
| + | [8.0.0+] This now takes an additional 0x8-bytes of input. |
| | | |
| 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 532: |
Line 595: |
| = 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 549: |
Line 614: |
| | 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+] RequestSyncRegistration | + | | 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 569: |
Line 636: |
| | 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+] RequestCreateVirtualAccount | + | | 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+] GetVirtualAccount | + | | 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 590: |
Line 657: |
| |- | | |- |
| | 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 599: |
Line 672: |
| | | |
| 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 613: |
Line 688: |
| |- | | |- |
| | 4 || [10.0.0+] IsLargeResourceAvailable | | | 4 || [10.0.0+] IsLargeResourceAvailable |
| + | |- |
| + | | 5 || [17.0.0+] CreateServerInterface2 |
| |} | | |} |
| | | |
Line 665: |
Line 742: |
| | | |
| 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 777: |
Line 856: |
| |} | | |} |
| | | |
− | = 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 [[#Cmd69]]/[[#Cmd76]] for the socket setup during Receive/Send task creation. Receive system = client, while Send system = server. | + | See [[#CreateLocalCommunicationReceiveSystemUpdateTask]]/[[#CreateLocalCommunicationSendSystemUpdateTask]] for the socket setup during Receive/Send task creation. Receive system = client, while Send system = server. |
| | | |
− | The Receive async [[#Cmd72|thread]] does the following: | + | The Receive async [[#RequestLocalCommunicationReceiveSystemUpdateTaskRun|thread]] does the following: |
| * Sets the <code>nn::fs::PriorityRaw</code> using a value loaded from state. | | * 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. |
Line 789: |
Line 879: |
| ** This handles installation, with messages being used via vtable funcptrs. | | ** This handles installation, with messages being used via vtable funcptrs. |
| | | |
− | The Send async [[#Cmd77|thread]] does the following (the SendApplication [[#Cmd61|thread]] is identical except it uses different previously setup state): | + | 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: |
Line 807: |
Line 897: |
| * 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 [[#Cmd76]]} | + | ** 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 [[#Cmd76]] (originally from the cmd input param). Otherwise, close sockfd and continue the loop (with the above func being called again). | + | ** 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} |
Line 853: |
Line 943: |
| | 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 [[#Cmd69]]. | + | | 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 [[#SendSystemUpdateTaskInfo]] [[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]]. | | | 0x2 || 0x18-bytes: [[NCM_services#ContentId|ContentId]], u8 flag, u8 pad[7]. When flag is 0, during the transfer [[#SendSystemUpdateTaskInfo]] [[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]]. |