Manu services - Revision history

Hexkyz at 21:44, 24 August 2024

2024-08-24T19:44:22Z

← Older revision		Revision as of 23:44, 24 August 2024
Line 8:		Line 8:
	! Cmd \|\| Name		! Cmd \|\| Name
	\|-		\|-
	\| 0 \|\| [[#~~InitializeUsbTransferPipeFile~~\|~~InitializeUsbTransferPipeFile~~]]		\| 0 \|\| [[#InitializeForUfio\|InitializeForUfio]]
	\|-		\|-
	\| 1 \|\| [[#~~IsFileExist~~\|~~IsFileExist~~]]		\| 1 \|\| [[#GetFileSize\|GetFileSize]]
	\|-		\|-
	\| 2 \|\| [[#~~ReadFile~~\|~~ReadFile~~]]		\| 2 \|\| [[#ReadFromHost\|ReadFromHost]]
	\|-		\|-
	\| 3 \|\| [[#~~WriteFile~~\|~~WriteFile~~]]		\| 3 \|\| [[#WriteToHost\|WriteToHost]]
	\|-		\|-
	\| 4 \|\| [[#~~InitializeUsbTransferPipeRaw~~\|~~InitializeUsbTransferPipeRaw~~]]		\| 4 \|\| [[#InitializeForUsbTransfer\|InitializeForUsbTransfer]]
	\|-		\|-
	\| 5 \|\| [[#~~ReadRaw~~\|~~ReadRaw~~]]		\| 5 \|\| [[#UsbRead\|UsbRead]]
	\|-		\|-
	\| 6 \|\| [[#~~WriteRaw~~\|~~WriteRaw~~]]		\| 6 \|\| [[#UsbWrite\|UsbWrite]]
	\|-		\|-
	\| 7 \|\| [7.0.0+]		\| 7 \|\| [7.0.0+]
Line 43:		Line 43:
	SerialNumber: "SerialNumber"		SerialNumber: "SerialNumber"

	== ~~InitializeUsbTransferPipeFile~~ ==		== InitializeForUfio ==
	~~Unofficial name.~~

	Takes an input u32. No output.		Takes an input u32. No output.

	Configures a transfer pipe over [[USB_services\|usb:ds]] for file access mode.		Configures a transfer pipe over [[USB_services\|usb:ds]] for file access mode.

	== ~~IsFileExist~~ ==		== GetFileSize ==
	~~Unofficial name.~~

	Takes a type-0x9 input buffer containing a path string. Returns an output u64.		Takes a type-0x9 input buffer containing a path string. Returns an output u64.

	Checks whether the specified file exists.		Checks whether the specified file exists.

	~~This is "FsFile::Exists" in SystemInitializer.~~		== ReadFromHost ==

	== ~~ReadFile~~ ==
	~~Unofficial name.~~

	Takes a type-0x6 output buffer, a type-0x9 input buffer containing a path string and three u64s '''OutSize''', '''Offset''' and '''InSize'''. No output.		Takes a type-0x6 output buffer, a type-0x9 input buffer containing a path string and three u64s '''OutSize''', '''Offset''' and '''InSize'''. No output.

	Reads data from the specified file.		Reads data from the specified file.

	== ~~WriteFile~~ ==		== WriteToHost ==
	~~Unofficial name.~~		Takes a type-0x5 input buffer, a type-0x9 input buffer containing a path string and three u64s '''OutSize''', '''Offset''' and '''InSize'''. No output.

	Takes a type-0x5 ~~output~~ input, a type-0x9 input buffer containing a path string and three u64s '''OutSize''', '''Offset''' and '''InSize'''. No output.

	Writes data to the specified file.		Writes data to the specified file.

	~~SystemInitializer also uses this as "FsFile::Create" with all input u64s set to 0.~~		== InitializeForUsbTransfer ==

	== ~~InitializeUsbTransferPipeRaw~~ ==
	~~Unofficial name.~~

	Takes an input u32. No output.		Takes an input u32. No output.

	Configures a transfer pipe over [[USB_services\|usb:ds]] for raw access mode.		Configures a transfer pipe over [[USB_services\|usb:ds]] for raw access mode.

	== ~~ReadRaw~~ ==		== UsbRead ==
	~~Unofficial name.~~

	Takes a type-0x6 output buffer and two u64s '''Offset''' and '''Size'''. No output.		Takes a type-0x6 output buffer and two u64s '''Offset''' and '''Size'''. No output.

	Reads raw data from the device.		Reads raw data from the device.

	== ~~WriteRaw~~ ==		== UsbWrite ==
	~~Unofficial name.~~

	Takes a type-0x5 input buffer and two u64s '''Offset''' and '''Size'''. No output.		Takes a type-0x5 input buffer and two u64s '''Offset''' and '''Size'''. No output.

Line 103:		Line 85:

	= Protocol =		= Protocol =

	== CommandId ==		== CommandId ==
	{\| class="wikitable" border="1"		{\| class="wikitable" border="1"
Line 109:		Line 90:
	! Value \|\| Name		! Value \|\| Name
	\|-		\|-
	\| 1 \|\| [[#~~IsFileExist~~\|~~IsFileExist~~]]		\| 1 \|\| [[#GetFileSize\|GetFileSize]]
	\|-		\|-
	\| 2 \|\| [[#~~ReadFile~~\|~~ReadFile~~]]		\| 2 \|\| [[#ReadFromHost\|ReadFromHost]]
	\|-		\|-
	\| 3 \|\| [[#~~WriteFile~~\|~~WriteFile~~]]		\| 3 \|\| [[#WriteToHost\|WriteToHost]]
	\|-		\|-
	\| 4 \|\| [[#Cmd7]]		\| 4 \|\| [[#Cmd7]]

Yellows8: /* LaunchProgram */

2024-08-24T13:03:36Z

LaunchProgram

← Older revision		Revision as of 17:03, 24 August 2024
Line 141:		Line 141:

	=== LaunchProgram ===		=== LaunchProgram ===
	This essentially supports launching a specified ~~ProgramId with BuiltInSystem~~ ([[NS_services\|ns:dev]], [[PGL_services\|pgl]] in newer versions) with the input arguments passed to [[Loader_services\|ldr:shel]], etc.		This essentially supports launching a specified program ([[NS_services\|ns:dev]], [[PGL_services\|pgl]] in newer versions) with the input arguments passed to [[Loader_services\|ldr:shel]], etc.

			The u64 at [[#Command\|payload]]+0 is the ProgramId, while the rest of the data is passed as the ldr:shel arguments buffer (size is determined from the payload size).

			This first terminates the previously launched process, if the PID field is still set (TerminateProcess). Then the arguments are passed to ldr:shel (SetProgramArgument), if required FlushArguments is used then SetProgramArgument is used again. Then LaunchProgram is used with the input ProgramId and BuiltInSystem, launch_flags=0x1, and pgl_launch_flags=0x0. Then SetProgramArgument is used to clear the program arguments (empty string is passed).

			Then pgl IEventObserver is used to wait on process events. When events Exited/DebugRunning occur for the launched program, TerminateProcess is used with that PID with the stored PID being cleared, then the wait loop exits. Other events result in the wait loop continuing. Event-wait timeout will result in breaking from the loop, without process-termination. The timeout in nanoseconds is 10 days.

			Lastly cleanup is done, then the func returns.

	=== GetReports ===		=== GetReports ===

Yellows8: /* ServerCommandId */

2024-08-24T01:36:14Z

ServerCommandId

← Older revision		Revision as of 05:36, 24 August 2024
Line 131:		Line 131:
	\| 3 \|\| Reboot		\| 3 \|\| Reboot
	\|-		\|-
	\| 5 \|\|		\| 5 \|\| GetReports
	\|-
	\|}		\|}

Line 140:		Line 139:

	Shutdown/Reboot were added at some point after LaunchProgram, these are present in [9.1.0] (exact version which added these is unknown). These call the SystemApplet Main() func (also used by qlaunch) with a funcptr to call the relevant [[Applet_Manager_services\|am]] IGlobalStateController StartShutdownSequence/StartRebootSequence cmd.		Shutdown/Reboot were added at some point after LaunchProgram, these are present in [9.1.0] (exact version which added these is unknown). These call the SystemApplet Main() func (also used by qlaunch) with a funcptr to call the relevant [[Applet_Manager_services\|am]] IGlobalStateController StartShutdownSequence/StartRebootSequence cmd.

	Cmd5 was added at some point after Shutdown/Reboot, this is present in [14.0.0] (exact version which added this is unknown). The command payload data contains a s32 path_size, followed by a NUL-terminated string with that size. After loading the input string, a handler func is called with this string.

	=== LaunchProgram ===		=== LaunchProgram ===
	This essentially supports launching a specified ProgramId with BuiltInSystem ([[NS_services\|ns:dev]], [[PGL_services\|pgl]] in newer versions) with the input arguments passed to [[Loader_services\|ldr:shel]], etc.		This essentially supports launching a specified ProgramId with BuiltInSystem ([[NS_services\|ns:dev]], [[PGL_services\|pgl]] in newer versions) with the input arguments passed to [[Loader_services\|ldr:shel]], etc.

			=== GetReports ===
			This was added at some point after Shutdown/Reboot, this is present in [14.0.0] (exact version which added this is unknown). The command payload data contains a s32 path_size, followed by a NUL-terminated string with that size. After loading the input string, a handler func is called with this string.

			This essentially loads the error reports from [[Error_Report_services\|erpt:r]] (GetReportList and reads each report). Once finished it calls the IPC vfunc for [[#WriteFile\|WriteFile]] with the data buffer, and with the path from: <code>nn::util::SNPrintf(out, 0x100, "%s/%s", inarg_path, tmpstr);</code> Where tmpstr is from the following earlier: <code>nn::util::SNPrintf(tmpstr, 0x20, "%s%02d.txt", "_report", cur_report_index);</code>

	== Command ==		== Command ==

Yellows8: /* Protocol */

2024-08-23T16:20:42Z

Protocol

← Older revision		Revision as of 20:20, 23 August 2024
Line 142:		Line 142:

	Cmd5 was added at some point after Shutdown/Reboot, this is present in [14.0.0] (exact version which added this is unknown). The command payload data contains a s32 path_size, followed by a NUL-terminated string with that size. After loading the input string, a handler func is called with this string.		Cmd5 was added at some point after Shutdown/Reboot, this is present in [14.0.0] (exact version which added this is unknown). The command payload data contains a s32 path_size, followed by a NUL-terminated string with that size. After loading the input string, a handler func is called with this string.

			=== LaunchProgram ===
			This essentially supports launching a specified ProgramId with BuiltInSystem ([[NS_services\|ns:dev]], [[PGL_services\|pgl]] in newer versions) with the input arguments passed to [[Loader_services\|ldr:shel]], etc.

	== Command ==		== Command ==

Yellows8: /* Protocol */

2024-08-23T15:53:04Z

Protocol

@@ Line 124: / Line 124: @@
 |-
 ! Value || Name
 |-
 |}
 == Command ==

Yellows8 at 17:07, 23 August 2024

2024-08-23T15:07:37Z

← Older revision		Revision as of 19:07, 23 August 2024
Line 105:		Line 105:

	== CommandId ==		== CommandId ==
			{\| class="wikitable" border="1"
			\|-
			! Value \|\| Name
			\|-
			\| 1 \|\| [[#IsFileExist\|IsFileExist]]
			\|-
			\| 2 \|\| [[#ReadFile\|ReadFile]]
			\|-
			\| 3 \|\| [[#WriteFile\|WriteFile]]
			\|-
			\| 4 \|\| [[#Cmd7]]
			\|-
			\| 5 \|\| [[#Cmd8]]
			\|}

			== ServerCommandId ==
	{\| class="wikitable" border="1"		{\| class="wikitable" border="1"
	\|-		\|-
Line 118:		Line 134:
	\| 0x0 \|\| 0x8 \|\| Magicnum (0xDEADCAFEDEADCAFE)		\| 0x0 \|\| 0x8 \|\| Magicnum (0xDEADCAFEDEADCAFE)
	\|-		\|-
	\| 0x8 \|\| 0x4 \|\| [[#CommandId\|CommandId]]		\| 0x8 \|\| 0x4 \|\| [[#CommandId\|CommandId]] when sent to the remote device, [[#ServerCommandId\|ServerCommandId]] for received commands.
	\|-		\|-
	\| 0xC \|\| 0x4 \|\| Padding		\| 0xC \|\| 0x4 \|\| Padding
Line 162:		Line 178:
	\| 0x4 \|\| 0x4 \|\| Padding		\| 0x4 \|\| 0x4 \|\| Padding
	\|-		\|-
	\| 0x8 \|\| 0x4 \|\| Result from handling the [[#~~CommandId~~\|~~CommandId~~]].		\| 0x8 \|\| 0x4 \|\| Result from handling the [[#ServerCommandId\|ServerCommandId]].
	\|}		\|}

Yellows8 at 16:49, 23 August 2024

2024-08-23T14:49:28Z

← Older revision		Revision as of 18:49, 23 August 2024
Line 95:		Line 95:

	Writes raw data to the device.		Writes raw data to the device.

			== Cmd7 ==
			Takes a type-0x9 input buffer containing a path string. No output.

			== Cmd8 ==
			Takes a type-0x9 input buffer containing a path string. No output.

			= Protocol =

			== CommandId ==
			{\| class="wikitable" border="1"
			\|-
			! Value \|\| Name
			\|-
			\|}

			== Command ==
			{\| class="wikitable" border="1"
			\|-
			! Offset \|\| Size \|\| Description
			\|-
			\| 0x0 \|\| 0x8 \|\| Magicnum (0xDEADCAFEDEADCAFE)
			\|-
			\| 0x8 \|\| 0x4 \|\| [[#CommandId\|CommandId]]
			\|-
			\| 0xC \|\| 0x4 \|\| Padding
			\|-
			\| 0x10 \|\| 0x8 \|\| Payload size
			\|}

			The payload data with the above size follows.

			After [[#WriteFile\|WriteFile]] sends the file-data, it reads an additional [[#Response\|Response]].

			== Response ==
			{\| class="wikitable" border="1"
			\|-
			! Offset \|\| Size \|\| Description
			\|-
			\| 0x0 \|\| 0x8 \|\| Ignored by manu.
			\|-
			\| 0x8 \|\| 0x4 \|\| Status, non-zero indicates error.
			\|-
			\| 0xC \|\| 0x4 \|\| Padding
			\|-
			\| 0x10 \|\| 0x8 \|\| Output value if any. May be returned by the service commands.
			\|}

			[[#ReadFile\|ReadFile]] additionally returns the requested file-data, followed by another [[#Response\|Response]].

			== CommandServerStatus ==
			{\| class="wikitable" border="1"
			\|-
			! Offset \|\| Size \|\| Description
			\|-
			\| 0x0 \|\| 0x4 \|\| Status, non-zero indicates error.
			\|}

			== CommandServerResponse ==
			{\| class="wikitable" border="1"
			\|-
			! Offset \|\| Size \|\| Description
			\|-
			\| 0x0 \|\| 0x4 \|\| Status, non-zero indicates error.
			\|-
			\| 0x4 \|\| 0x4 \|\| Padding
			\|-
			\| 0x8 \|\| 0x4 \|\| Result from handling the [[#CommandId\|CommandId]].
			\|}

			= Notes =
			There's a total of 3 threads: 2 for the IPC handler threads (which send commands to the remote device and gets the response). And there's the separate nn::manu::CommandServer::RunThread, which receives commands from the remote device and sends replies. This latter thread runs regardless of any service commands being used.

	[[Category:Services]]		[[Category:Services]]

Hexkyz at 22:08, 7 August 2023

2023-08-07T20:08:24Z

← Older revision		Revision as of 00:08, 8 August 2023
Line 35:		Line 35:
	SerialNumber: "SerialNumber"		SerialNumber: "SerialNumber"

	[7.0.0+] ~~The requests are~~ now configured as:		[7.0.0+] USB is now configured as:
	VID: 0x057E (Nintendo Co., Ltd)		VID: 0x057E (Nintendo Co., Ltd)
	PID: 0x3003		PID: 0x3003

Hexkyz at 22:07, 7 August 2023

2023-08-07T20:07:53Z

← Older revision		Revision as of 00:07, 8 August 2023
Line 8:		Line 8:
	! Cmd \|\| Name		! Cmd \|\| Name
	\|-		\|-
	\| 0 \|\| [[#~~InitUsbTransferPipeFsFile~~\|~~InitUsbTransferPipeFsFile~~]]		\| 0 \|\| [[#InitializeUsbTransferPipeFile\|InitializeUsbTransferPipeFile]]
	\|-		\|-
	\| 1 \|\| [[#~~FsFile_Exists~~\|~~FsFile_Exists~~]]		\| 1 \|\| [[#IsFileExist\|IsFileExist]]
	\|-		\|-
	\| 2 \|\| [[#~~FsFile_Read~~\|~~FsFile_Read~~]]		\| 2 \|\| [[#ReadFile\|ReadFile]]
	\|-		\|-
	\| 3 \|\| [[#~~FsFile_Write~~\|~~FsFile_Write~~]]		\| 3 \|\| [[#WriteFile\|WriteFile]]
	\|-		\|-
	\| 4 \|\| [[#~~InitUsbTransferPipeRaw~~\|~~InitUsbTransferPipeRaw~~]]		\| 4 \|\| [[#InitializeUsbTransferPipeRaw\|InitializeUsbTransferPipeRaw]]
	\|-		\|-
	\| 5 \|\| [[#~~Raw_Read~~\|~~Raw_Read~~]]		\| 5 \|\| [[#ReadRaw\|ReadRaw]]
	\|-		\|-
	\| 6 \|\| [[#~~Raw_Write~~\|~~Raw_Write~~]]		\| 6 \|\| [[#WriteRaw\|WriteRaw]]
	\|-		\|-
	\| 7 \|\| [7.0.0+]		\| 7 \|\| [7.0.0+]
	\|-		\|-
	\| 8 \|\| [7.0.0+]		\| 8 \|\| [14.0.0+]
	\|}		\|}

Line 35:		Line 35:
	SerialNumber: "SerialNumber"		SerialNumber: "SerialNumber"

	[~~[SystemInitializer]~~] ~~only uses cmd1.~~.~~cmd3~~.		[7.0.0+] The requests are now configured as:
			VID: 0x057E (Nintendo Co., Ltd)
			PID: 0x3003
			bcdDevice: 0x0100 (1.00)
			Manufacturer: "Nintendo"
			Product: "NintendoSdkManufacturing"
			SerialNumber: "SerialNumber"

	== ~~InitUsbTransferPipeFsFile~~ ==		== InitializeUsbTransferPipeFile ==
	~~Takes an unknown u32 (ID?) and configures a transfer pipe over [[USB_services\|usb:ds]] for file access mode~~.		Unofficial name.

	== ~~FsFile_Exists~~ ==		Takes an input u32. No output.
	Takes ~~an input path string (~~type-0x9 buffer~~), returns 8-bytes for the~~ output ~~u8 flag~~.
			Configures a transfer pipe over [[USB_services\|usb:ds]] for file access mode.

			== IsFileExist ==
			Unofficial name.

			Takes a type-0x9 input buffer containing a path string. Returns an output u64.

	Checks whether the specified file exists.		Checks whether the specified file exists.
Line 47:		Line 59:
	This is "FsFile::Exists" in SystemInitializer.		This is "FsFile::Exists" in SystemInitializer.

	== ~~FsFile_Read~~ ==		== ReadFile ==
	Takes a type-0x6 output buffer ~~and~~ a type-0x9 input string ~~path buffer,~~ and 3 u64s~~: <same size value from databuf>~~, ~~unk, <same size value from databuf>~~. ~~Where unk is probably offset?~~		Unofficial name.

			Takes a type-0x6 output buffer, a type-0x9 input buffer containing a path string and three u64s '''OutSize''', '''Offset''' and '''InSize'''. No output.

	Reads data from the specified file.		Reads data from the specified file.

	== ~~FsFile_Write~~ ==		== WriteFile ==
	~~Same as FsFile_Read except the databuf is~~ a type-0x5 input buffer.		Unofficial name.

			Takes a type-0x5 output input, a type-0x9 input buffer containing a path string and three u64s '''OutSize''', '''Offset''' and '''InSize'''. No output.

	Writes data to the specified file.		Writes data to the specified file.
Line 59:		Line 75:
	SystemInitializer also uses this as "FsFile::Create" with all input u64s set to 0.		SystemInitializer also uses this as "FsFile::Create" with all input u64s set to 0.

	== ~~InitUsbTransferPipeRaw~~ ==		== InitializeUsbTransferPipeRaw ==
	Takes an ~~unknown~~ u32 ~~(ID?) and configures~~ a transfer pipe over [[USB_services\|usb:ds]] for raw access mode.		Unofficial name.

			Takes an input u32. No output.

			Configures a transfer pipe over [[USB_services\|usb:ds]] for raw access mode.

	== ~~Raw_Read~~ ==		== ReadRaw ==
	Takes a type-0x6 output buffer and 2 u64s: '''~~offset~~''' and '''~~size~~'''.		Unofficial name.

			Takes a type-0x6 output buffer and two u64s '''Offset''' and '''Size'''. No output.

	Reads raw data from the device.		Reads raw data from the device.

	== ~~Raw_Write~~ ==		== WriteRaw ==
	Takes a type-0x5 input buffer and 2 u64s: '''~~offset~~''' and '''~~size~~'''.		Unofficial name.

			Takes a type-0x5 input buffer and two u64s '''Offset''' and '''Size'''. No output.

	Writes raw data to the device.		Writes raw data to the device.

	[[Category:Services]]		[[Category:Services]]

Hexkyz at 22:09, 5 August 2023

2023-08-05T20:09:08Z

← Older revision		Revision as of 00:09, 6 August 2023
Line 2:		Line 2:

	= manu =		= manu =
			This is "nn::manu::IManu".

	{\| class="wikitable" border="1"		{\| class="wikitable" border="1"
	\|-		\|-
	! Cmd \|\| Name ~~\|\| Notes~~		! Cmd \|\| Name
	\|-		\|-
	\| 0 \|\| InitUsbTransferPipeFsFile \|~~\| Takes 4 bytes of input, and produces 0 bytes output.~~		\| 0 \|\| [[#InitUsbTransferPipeFsFile\|InitUsbTransferPipeFsFile]]
	\|-		\|-
	\| 1 \|\| FsFile_Exists \|~~\| Takes an X descriptor, and produces, 8 bytes output.~~		\| 1 \|\| [[#FsFile_Exists\|FsFile_Exists]]
	\|-		\|-
	\| 2 \|\| FsFile_Read \|~~\| Takes 0x18 bytes of input, a B descriptor, and an X descriptor, and produces 0 bytes of output.~~		\| 2 \|\| [[#FsFile_Read\|FsFile_Read]]
	\|-		\|-
	\| 3 \|\| FsFile_Write \|~~\| Takes 0x18 bytes of input, an A descriptor, and an X descriptor, and produces 0 bytes of output.~~		\| 3 \|\| [[#FsFile_Write\|FsFile_Write]]
	\|-		\|-
	\| 4 \|\| InitUsbTransferPipeRaw \|~~\| Takes 4 bytes of input, and produces 0 bytes of output.~~		\| 4 \|\| [[#InitUsbTransferPipeRaw\|InitUsbTransferPipeRaw]]
	\|-		\|-
	\| 5 \|\| Raw_Read \|~~\| Takes 0x10 bytes of input and a B descriptor, and produces 8 bytes of output.~~		\| 5 \|\| [[#Raw_Read\|Raw_Read]]
	\|-		\|-
	\| 6 \|\| Raw_Write \|~~\| Takes 0x10 bytes of input and an A descriptor, and produces 8 bytes of output.~~		\| 6 \|\| [[#Raw_Write\|Raw_Write]]
	\|-		\|-
			\| 7 \|\| [7.0.0+]
			\|-
			\| 8 \|\| [7.0.0+]
	\|}		\|}