mirror of
https://github.com/DarkMatterCore/nxdumptool.git
synced 2024-11-22 18:26:39 +00:00
b6759f764b
Keeps alive the current USB session by informing the host device that the user cancelled an ongoing USB transfer, instead of stalling the endpoints. Also updated the USB ABI specs once again.
160 lines
10 KiB
Text
160 lines
10 KiB
Text
USB command header:
|
|
|
|
*--------*--------*------------------------------*
|
|
| Offset | Size | Description |
|
|
*--------*--------*------------------------------*
|
|
| 0x00 | 0x04 | Magic word ("NXDT"). |
|
|
*--------*--------*------------------------------*
|
|
| 0x04 | 0x04 | Command ID (LE u32). |
|
|
*--------*--------*------------------------------*
|
|
| 0x08 | 0x04 | Command Block Size (LE u32). |
|
|
*--------*--------*------------------------------*
|
|
| 0x0C | 0x04 | Reserved. |
|
|
*--------*--------*------------------------------*
|
|
|
|
USB command IDs:
|
|
|
|
*--------*--------------------------------------*
|
|
| Value | Description |
|
|
*--------*--------------------------------------*
|
|
| 0 | StartSession. |
|
|
*--------*--------------------------------------*
|
|
| 1 | SendFileProperties. |
|
|
*--------*--------------------------------------*
|
|
| 2 | CancelFileTransfer. |
|
|
*--------*--------------------------------------*
|
|
| 3 | SendNspHeader. |
|
|
*--------*--------------------------------------*
|
|
| 4 | EndSession. |
|
|
*--------*--------------------------------------*
|
|
|
|
____________________________________________________________________________________________________________________________________
|
|
|
|
|
|
StartSession Command Block: 0x10 byte-long, set by nxdumptool as the value for the Command Block Size field in the command header (along with its matching command ID).
|
|
|
|
This is the first USB command issued by nxdumptool. If it succeeds, further USB commands may be sent.
|
|
|
|
*--------*--------*-----------------------------*
|
|
| Offset | Size | Description |
|
|
*--------*--------*-----------------------------*
|
|
| 0x00 | 0x01 | nxdumptool version (major). | \
|
|
*--------*--------*-----------------------------* \
|
|
| 0x01 | 0x01 | nxdumptool version (minor). | --|---> Version number, which can be displayed by the host application as: "{major}.{minor}.{micro}".
|
|
*--------*--------*-----------------------------* /
|
|
| 0x02 | 0x01 | nxdumptool version (micro). | /
|
|
*--------*--------*-----------------------------*
|
|
| 0x03 | 0x01 | nxdumptool USB ABI version. | ------> Currently, always v1.
|
|
*--------*--------*-----------------------------*
|
|
| 0x04 | 0x0C | Reserved. |
|
|
*--------*--------*-----------------------------*
|
|
|
|
____________________________________________________________________________________________________________________________________
|
|
|
|
|
|
SendFileProperties Command Block: 0x320 byte-long, set by nxdumptool as the value for the Command Block Size field in the command header (along with its matching command ID).
|
|
|
|
Sent right before starting a file transfer. If it succeeds, file data will be transferred in bulk mode using 0x800000-sized chunks (the last one is truncated if needed).
|
|
|
|
*--------*--------*-----------------------------*
|
|
| Offset | Size | Description |
|
|
*--------*--------*-----------------------------*
|
|
| 0x00 | 0x08 | File size (LE u64). |
|
|
*--------*--------*-----------------------------*
|
|
| 0x08 | 0x04 | Filename length (LE u32). |
|
|
*--------*--------*-----------------------------*
|
|
| 0x0C | 0x04 | NSP header size (LE u32). |
|
|
*--------*--------*-----------------------------*
|
|
| 0x10 | 0x301 | NULL terminated filename. | -> 0x301 is defined as FS_MAX_PATH in libnx. Always encoded using UTF-8.
|
|
*--------*--------*-----------------------------*
|
|
| 0x311 | 0x0F | Reserved. |
|
|
*--------*--------*-----------------------------*
|
|
|
|
____________________________________________________________________________________________________________________________________
|
|
|
|
|
|
CancelFileTransfer: holds no command block. Expects a USB status response, just like the rest of the commands.
|
|
|
|
This command can only be issued during the file transfer stage from a SendFileProperties command. It is used to gracefully cancel an ongoing file transfer while also keeping the USB session alive. It's up to the host application to decide what to do with the incomplete data.
|
|
|
|
The easiest way to detect this command during a file transfer is by checking the length of the last received block and then parse it to see if it matches a CancelFileTransfer command header.
|
|
|
|
____________________________________________________________________________________________________________________________________
|
|
|
|
|
|
SendNspHeader Command Block: variable length. The Command Block Size field in the command header holds the NSP header size. The NSP header data is placed after the command header.
|
|
|
|
____________________________________________________________________________________________________________________________________
|
|
|
|
|
|
EndSession: holds no command block. Expects a USB status response, just like the rest of the commands.
|
|
|
|
This command is only issued while exiting nxdumptool, as long as the console is connected to a host device and a USB session has been successfully established.
|
|
|
|
____________________________________________________________________________________________________________________________________
|
|
|
|
|
|
USB status block (returned by the client application):
|
|
|
|
*--------*--------*------------------------------------*
|
|
| Offset | Size | Description |
|
|
*--------*--------*------------------------------------*
|
|
| 0x00 | 0x04 | Magic word ("NXDT"). |
|
|
*--------*--------*------------------------------------*
|
|
| 0x04 | 0x04 | Status code (LE u32). |
|
|
*--------*--------*------------------------------------*
|
|
| 0x08 | 0x02 | Endpoint max packet size (LE u16). | -> Value used by the endpoint in the USB host device (I can't detect it using usb:ds calls on the Switch).
|
|
*--------*--------*------------------------------------*
|
|
| 0x0A | 0x06 | Reserved. |
|
|
*--------*--------*------------------------------------*
|
|
|
|
USB status codes:
|
|
|
|
*--------*-----------------------------------------*
|
|
| Value | Description |
|
|
*--------*-----------------------------------------*
|
|
| 0 | Success. |
|
|
*--------*-----------------------------------------*
|
|
| 1 | Reserved for internal nxdumptool usage. |
|
|
*--------*-----------------------------------------*
|
|
| 2 | Reserved for internal nxdumptool usage. |
|
|
*--------*-----------------------------------------*
|
|
| 3 | Reserved for internal nxdumptool usage. |
|
|
*--------*-----------------------------------------*
|
|
| 4 | Invalid magic word. |
|
|
*--------*-----------------------------------------*
|
|
| 5 | Unsupported command. |
|
|
*--------*-----------------------------------------*
|
|
| 6 | Unsupported USB ABI version. |
|
|
*--------*-----------------------------------------*
|
|
| 7 | Malformed command. |
|
|
*--------*-----------------------------------------*
|
|
| 8 | I/O error in USB host. |
|
|
*--------*-----------------------------------------*
|
|
|
|
____________________________________________________________________________________________________________________________________
|
|
|
|
|
|
Highlights:
|
|
|
|
* Vendor ID: 0x057e.
|
|
* Product ID: 0x3000.
|
|
* Device descriptor strings will always match "nxdumptool" (product) and "DarkMatterCore" (manufacturer).
|
|
* Multiple device descriptors are provided to support USB 1.1, USB 2.0 and USB 3.0, each one with slightly different properties.
|
|
* A single configuration descriptor is provided per each possible device descriptor.
|
|
* A single Binary Object Store (BOS) descriptor is also provided.
|
|
* All transfers are performed in USB bulk mode, using 5-second timeouts.
|
|
* While handling USB commands, nxdumptool first issues the USB command header (so the USB host device can parse how much data to read next), then sends the USB command block (if required by the command being handled), and finally expects the host device to send a USB status response.
|
|
* This includes the SendFileProperties command, which expects a USB status response from the host right before starting the file data transfer.
|
|
* A USB status response is expected by nxdumptool right after the last file data chunk has been sent.
|
|
* If, while transferring file data, the last data chunk is aligned to the endpoint max packet size used by the USB host, a Zero Length Termination (ZLT) packet will be issued after transferring the last chunk, in order to comply with the USB bulk transfer specs.
|
|
* In the case of extracted RomFS transfers, the filename field from the SendFileProperties block may actually contain a filepath - this will always start with a '/'. The client application is free to decide how to handle this (e.g. create full directory tree, etc.).
|
|
|
|
|
|
NSP transfer mode:
|
|
|
|
* If the NSP header size from a SendFileProperties block is greater than zero, the client should enter NSP transfer mode. The file size from this block represents, then, the full NSP size (including the NSP header).
|
|
* In this mode, the client should immediately create the output file, write "NSP header size" bytes of padding to it, reply with a USB status response and expect additional SendFileProperties commands. No data is transferred for this very first SendFileProperties block.
|
|
* Each further SendFileProperties block will hold the filename and size for a NSP file entry, and the NSP header size value will always be set to zero. The data received from each one of these file entries must be written to the output file created during the first SendFileProperties command. The sum of all file entry sizes should be equal to the full NSP size minus the NSP header size received during the first SendFileProperties command.
|
|
* Finally, the client will receive a SendNspHeader command with the NSP header data, which should be written at the start of the output file. The value from the Command Block Size in the command header from this block should match the NSP header size received in the first SendFileProperties command.
|
|
* If the NSP header size is aligned to the endpoint max packet size, the client should also expect a ZLT packet after receiving the NSP header data from the SendNspHeader command.
|