NIM services: Difference between revisions
No edit summary |
No edit summary |
||
| Line 290: | Line 290: | ||
[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+] Cmd92 now returns an [[#IAsyncData]] instead of [[#IAsyncValue]]. | [12.0.0+] Cmd92 now returns an [[#IAsyncData]] instead of [[#IAsyncValue]]. | ||
| Line 413: | Line 411: | ||
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 == | ||
| Line 422: | Line 420: | ||
== 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 854: | Line 854: | ||
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. | * 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 863: | Line 863: | ||
** 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: | ||
| Line 881: | Line 881: | ||
* 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} | ||
| Line 927: | Line 927: | ||
| 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 [[#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]]. | ||