Difference between revisions of "NS and APT Services"

From 3dbrew
Jump to navigation Jump to search
(92 intermediate revisions by 16 users not shown)
Line 1: Line 1:
 
[[Category:Services]]
 
[[Category:Services]]
−
The NS ('''N'''intendo User Interface '''S'''hell) system module is the first module launched from a CTR-NAND title after the [[FIRM]] processes are loaded. This module is launched by the pm process, with the titleID loaded from NS state(hard-coded TID initialized during applet TID-array initialization). NS first launches [[ErrDisp]], then the menu. On retail the menu TID is loaded from NS state, while on dev/debug the menu TID is loaded from [[Config_Savegame|config]]. On dev-units if the menu TID block doesn't exist in [[Config_Savegame|config]], NS will attempt to launch the alternate menu instead. The TID of the launched menu is then written to [[Configuration Memory|ACTIVEMENUTID]]. NS uses [[PMApp:LaunchTitle|pm:app]] to launch titles.
+
The NS ('''N'''intendo User Interface '''S'''hell) system module is the first module launched from a CTR-NAND title after the [[FIRM]] processes are loaded (also see [[Bootloader]]). This module is launched by the pm process, with the titleID loaded from NS state(hard-coded TID initialized during applet TID-array initialization). NS first launches [[ErrDisp]], then the menu. On retail the menu TID is loaded from NS state, while on dev/debug the menu TID is loaded from [[Config_Savegame|config]]. On dev-units if the menu TID block doesn't exist in [[Config_Savegame|config]], NS will attempt to launch the alternate menu instead. The TID of the launched menu is then written to [[Configuration Memory|ACTIVEMENUTID]]. NS uses [[PMApp:LaunchTitle|pm:app]] to launch titles.
  
 
NS will not trigger the [[ErrDisp|fatal-error]] screen when launching the regular/alternate menu fails.
 
NS will not trigger the [[ErrDisp|fatal-error]] screen when launching the regular/alternate menu fails.
Line 7: Line 7:
  
 
= Alternate menu =
 
= Alternate menu =
−
When launching the regular menu fails, NS will then attempt to launch the alternate menu. This title could be used as a recovery process, however it's normally not used after the factory. This title is used at the factory for installing system titles, this title seems to be installed from a factory gamecard. This installer title likely deletes itself from NAND once it's finished installing titles.
+
When launching the regular menu fails, NS will then attempt to launch the alternate menu. This title could be used as a recovery process, however it's normally not used after the factory.
  
−
On development Units, this is the [[3DS Development Unit GUI#Test Menu|Test Menu]], and isn't deleted after being setup at factory.
+
At the factory for all 3DS systems, [[3DS Development Unit GUI#Test Menu|Test Menu]] is installed with this TID. On retail this title is eventually deleted during [[Factory Setup]].
  
 
= Auto-boot =
 
= Auto-boot =
Line 19: Line 19:
 
A "ns_workaround" was [[5.1.0-11|added]] in NS to workaround the flaw added with [[5.0.0-11]]. When NS is loading before launching any ARM11 processes and certain [[Configuration Memory]] fields are set, NS will launch [[Application_Manager_Services|AM]] then use command [[AM:InstallNATIVEFIRM]]. NS will then execute the code called by [[APT:StartNewestHomeMenu]], the code related to APT:PrepareToStartNewestHomeMenu is not executed here.
 
A "ns_workaround" was [[5.1.0-11|added]] in NS to workaround the flaw added with [[5.0.0-11]]. When NS is loading before launching any ARM11 processes and certain [[Configuration Memory]] fields are set, NS will launch [[Application_Manager_Services|AM]] then use command [[AM:InstallNATIVEFIRM]]. NS will then execute the code called by [[APT:StartNewestHomeMenu]], the code related to APT:PrepareToStartNewestHomeMenu is not executed here.
  
−
NS will only execute this code-path when [[Configuration Memory|0x1FF80016]] is value zero, when KERNEL_VERSIONMAJOR is value 2, and when KERNEL_VERSIONMINOR is less than 35. Therefore, this code-path is only executed when the running NATIVE_FIFM version is prior to [[5.0.0-11]].
+
NS will only execute this code-path when [[Configuration Memory|0x1FF80016]] is value zero, when KERNEL_VERSIONMAJOR is value 2, and when KERNEL_VERSIONMINOR is less than 35. Therefore, this code-path is only executed when the running NATIVE_FIRM version is prior to [[5.0.0-11]].
  
 
= NS Service "ns:s" =
 
= NS Service "ns:s" =
Line 28: Line 28:
 
!  Description
 
!  Description
 
|-
 
|-
−
| 0x0001....
+
| 0x000100C0
 
| [[1.0.0-0]] - [[2.0.0-2]]
 
| [[1.0.0-0]] - [[2.0.0-2]]
 
| [[NSS:LaunchFIRM|LaunchFIRM]]
 
| [[NSS:LaunchFIRM|LaunchFIRM]]
Line 36: Line 36:
 
| [[NSS:LaunchTitle|LaunchTitle]]
 
| [[NSS:LaunchTitle|LaunchTitle]]
 
|-
 
|-
−
| 0x0003....
+
| 0x00030000
 
| [[1.0.0-0]] - [[2.0.0-2]]
 
| [[1.0.0-0]] - [[2.0.0-2]]
−
| Wrapper for [[Process_Manager_Services|PMApp]] command 0x00030080.
+
| [[NSS:TerminateApplication|TerminateApplication]]
 
|-
 
|-
−
| 0x0004....
+
| 0x00040040
 
| [[1.0.0-0]] - [[2.0.0-2]]
 
| [[1.0.0-0]] - [[2.0.0-2]]
−
| Wrapper for [[Process_Manager_Services|PMApp]] command 0x000500C0.
+
| [[NSS:TerminateProcess|TerminateProcess]]
 
|-
 
|-
 
| 0x000500C0
 
| 0x000500C0
Line 50: Line 50:
 
| 0x00060042
 
| 0x00060042
 
| [[1.0.0-0]] - [[2.0.0-2]]
 
| [[1.0.0-0]] - [[2.0.0-2]]
−
| [[NSS:SetFIRMParams4A0|SetFIRMParams4A0]]
+
| [[NSS:SetWirelessRebootInfo|SetWirelessRebootInfo]]
 
|-
 
|-
 
| 0x00070042
 
| 0x00070042
 
| [[1.0.0-0]] - [[2.0.0-2]]
 
| [[1.0.0-0]] - [[2.0.0-2]]
−
| This does initialization for the gamecard [[System_Update_CFA|system update]]. Then this checks whether this gamecard system-update needs to be installed, by comparing the title-version of the [[CVer]] [[CIA]] stored in the system-update CFA with the title-version of the CVer title already installed in NAND.
+
| [[NSS:CardUpdateInitialize|CardUpdateInitialize]]
 
|-
 
|-
 
| 0x00080000
 
| 0x00080000
 
| [[1.0.0-0]] - [[2.0.0-2]]
 
| [[1.0.0-0]] - [[2.0.0-2]]
−
| This shuts down the gamecard system update interface: the shared memory is unmapped, the CFA archive is closed, state is cleared, etc.
+
| [[NSS:CardUpdateShutdown|CardUpdateShutdown]]
 
|-
 
|-
−
| 0x0009....
+
| 0x00090000
 
| [[1.0.0-0]] - [[2.0.0-2]]
 
| [[1.0.0-0]] - [[2.0.0-2]]
 
| Gamecard system update related.
 
| Gamecard system update related.
 
|-
 
|-
−
| 0x000A....
+
| 0x000A0000
 
| [[1.0.0-0]] - [[2.0.0-2]]
 
| [[1.0.0-0]] - [[2.0.0-2]]
 
| Gamecard system update related.
 
| Gamecard system update related.
 
|-
 
|-
−
| 0x000B....
+
| 0x000B0000
 
| [[1.0.0-0]] - [[2.0.0-2]]
 
| [[1.0.0-0]] - [[2.0.0-2]]
 
| Gamecard system update related.
 
| Gamecard system update related.
 
|-
 
|-
−
| 0x000C....
+
| 0x000C0000
 
| [[1.0.0-0]] - [[2.0.0-2]]
 
| [[1.0.0-0]] - [[2.0.0-2]]
 
| Gamecard system update related.
 
| Gamecard system update related.
 
|-
 
|-
−
| 0x000D....
+
| 0x000D0140
 
| [[1.0.0-0]] - [[2.0.0-2]]
 
| [[1.0.0-0]] - [[2.0.0-2]]
−
| [[NSS:SetFIRMParams4B0|SetFIRMParams4B0]]
+
| [[NSS:SetTWLBannerHMAC|SetTWLBannerHMAC]]
 
|-
 
|-
−
| 0x000E....
+
| 0x000E0000
 
| [[1.0.0-0]] - [[2.0.0-2]]
 
| [[1.0.0-0]] - [[2.0.0-2]]
−
| Wrapper for "ptm:sysm" service command 0x040700C0.
+
| [[NSS:ShutdownAsync|ShutdownAsync]]
 
|-
 
|-
−
| 0x000F....
+
| 0x000F0000
 
| [[1.0.0-0]] - [[2.0.0-2]]
 
| [[1.0.0-0]] - [[2.0.0-2]]
−
| ?
+
| This calls [[APT:AppletUtility]] with fixed input params.
 
|-
 
|-
 
| 0x00100180
 
| 0x00100180
Line 92: Line 92:
 
| [[NSS:RebootSystem|RebootSystem]]
 
| [[NSS:RebootSystem|RebootSystem]]
 
|-
 
|-
−
| 0x0011....
+
| 0x00110100
 
| [[1.0.0-0]] - [[2.0.0-2]]
 
| [[1.0.0-0]] - [[2.0.0-2]]
−
| [[NSS:TerminateProcessTID|TerminateProcessTID]]
+
| [[NSS:TerminateTitle|TerminateTitle]]
 
|-
 
|-
−
| 0x0012....
+
| 0x001200C0
−
| ?
 
 
| ?
 
| ?
 +
| [[NSS:SetApplicationCpuTimeLimit|SetApplicationCpuTimeLimit]]
 
|-
 
|-
−
| 0x0013....
+
| 0x00130000
 
| ?
 
| ?
 
| ?
 
| ?
 
|-
 
|-
−
| 0x0014....
+
| 0x00140042
 
| ?
 
| ?
 
| ?
 
| ?
 
|-
 
|-
−
| 0x0015....
+
| 0x00150140
−
| ?
 
 
| ?
 
| ?
 +
| [[NSS:LaunchApplication|LaunchApplication]]
 +
|-
 +
| 0x00160000
 +
| [[8.0.0-18]]
 +
| [[NSS:RebootSystemClean|RebootSystemClean]]
 
|}
 
|}
  
 
The maximum sessions that can be used with this service is two, therefore only two processes can use this service at the same time.
 
The maximum sessions that can be used with this service is two, therefore only two processes can use this service at the same time.
  
 +
=NS Power Service "ns:p"=
 +
{| class="wikitable" border="1"
 +
|-
 +
!  Command Header
 +
!  Description
 +
|-
 +
| 0x00010040
 +
| [[NSP:RebootSystem|RebootSystem]]
 +
|-
 +
| 0x00020000
 +
| [[NSS:ShutdownAsync|ShutdownAsync]]
 +
|}
  
−
=NS Service "ns:p"=
+
This was added with [[3.0.0-5]]. The PTM sysmodule connects to this service, and syncs whenever [[PTM|ptm:s GetShellState()]] changes.
−
This was added with [[3.0.0-5]], it's unknown what this is used for.
 
  
 
=NS Service "ns:c"=
 
=NS Service "ns:c"=
−
This was added with [[5.0.0-11]], it's unknown what this is used for.
+
{| class="wikitable" border="1"
 +
|-
 +
!  Command Header
 +
!  Description
 +
|-
 +
| 0x00010100
 +
| [[NSC:LockSpecialContent|LockSpecialContent]]
 +
|-
 +
| 0x00020100
 +
| [[NSC:UnlockSpecialContent|UnlockSpecialContent]]
 +
|}
 +
 
 +
This was added with [[5.0.0-11]]. It is used by the Instruction Manual applet, and is likely related to triggering SD/Game Card removal errors when ejecting the media the manual is stored on.
  
 
=APT Services=
 
=APT Services=
Line 128: Line 155:
 
!  Available since system version
 
!  Available since system version
 
!  Accessible with APT:U
 
!  Accessible with APT:U
 +
!  Accessible with APT:A
 
!  Description
 
!  Description
 
|-
 
|-
Line 133: Line 161:
 
|  
 
|  
 
| Yes
 
| Yes
−
| GetLockHandle
+
| Yes
 +
| [[APT:GetLockHandle|GetLockHandle]]
 
|-
 
|-
 
| 0x00020080
 
| 0x00020080
 
|  
 
|  
−
| See [[APTU:Initialize|here]].
+
| See [[APT:Initialize|here]].
−
| [[APTU:Initialize|Initialize]]
+
| See [[APT:Initialize|here]].
 +
| [[APT:Initialize|Initialize]]
 
|-
 
|-
 
| 0x00030040
 
| 0x00030040
 
|  
 
|  
 
| Yes
 
| Yes
−
| Enable
+
| Yes
 +
| [[APT:Enable|Enable]]
 
|-
 
|-
 
| 0x00040040
 
| 0x00040040
 
|  
 
|  
 
| Yes
 
| Yes
−
| Finalize
+
| Yes
 +
| [[APT:Finalize|Finalize]]
 
|-
 
|-
 
| 0x00050040
 
| 0x00050040
 
|  
 
|  
 +
| Yes
 
| Yes
 
| Yes
 
| [[APT:GetAppletManInfo|GetAppletManInfo]]
 
| [[APT:GetAppletManInfo|GetAppletManInfo]]
Line 157: Line 190:
 
| 0x00060040
 
| 0x00060040
 
|  
 
|  
 +
| Yes (AppID != 0x300)
 
| Yes
 
| Yes
−
| GetAppletInfo
+
| [[APT:GetAppletInfo|GetAppletInfo]]
 
|-
 
|-
 
| 0x00070000
 
| 0x00070000
 
|  
 
|  
 
| Yes
 
| Yes
−
| GetLastSignaledAppletId
+
| Yes
 +
| [[APT:GetLastSignaledAppletId|GetLastSignaledAppletId]]
 
|-
 
|-
 
| 0x00080000
 
| 0x00080000
 
|  
 
|  
 
| Yes
 
| Yes
−
| CountRegisteredApplet
+
| Yes
 +
| [[APT:CountRegisteredApplet|CountRegisteredApplet]]
 
|-
 
|-
 
| 0x00090040
 
| 0x00090040
 
|  
 
|  
 +
| Yes
 
| Yes
 
| Yes
 
| [[APT:IsRegistered|IsRegistered]]
 
| [[APT:IsRegistered|IsRegistered]]
Line 178: Line 215:
 
|  
 
|  
 
| Yes
 
| Yes
−
| GetAttribute
+
| Yes
 +
| [[APT:GetAttribute|GetAttribute]]
 
|-
 
|-
 
| 0x000B0040
 
| 0x000B0040
 
|  
 
|  
 
| Yes
 
| Yes
−
| [[APTU:GetSignalType|InquireNotification]]
+
| Yes
 +
| [[APT:InquireNotification|InquireNotification]]
 
|-
 
|-
 
| 0x000C0104
 
| 0x000C0104
 
|  
 
|  
 +
| Yes
 
| Yes
 
| Yes
 
| [[APT:SendParameter|SendParameter]]
 
| [[APT:SendParameter|SendParameter]]
Line 192: Line 232:
 
| 0x000D0080
 
| 0x000D0080
 
|  
 
|  
 +
| Yes
 
| Yes
 
| Yes
 
| [[APT:ReceiveParameter|ReceiveParameter]]
 
| [[APT:ReceiveParameter|ReceiveParameter]]
Line 197: Line 238:
 
| 0x000E0080
 
| 0x000E0080
 
|  
 
|  
 +
| Yes
 
| Yes
 
| Yes
 
| [[APT:GlanceParameter|GlanceParameter]]
 
| [[APT:GlanceParameter|GlanceParameter]]
Line 202: Line 244:
 
| 0x000F0100
 
| 0x000F0100
 
|  
 
|  
 +
| Yes
 
| Yes
 
| Yes
 
| [[APT:CancelParameter|CancelParameter]]
 
| [[APT:CancelParameter|CancelParameter]]
Line 208: Line 251:
 
|  
 
|  
 
| Yes
 
| Yes
−
| DebugFunc
+
| Yes
 +
| [[APT:DebugFunc|DebugFunc]]
 
|-
 
|-
 
| 0x001100C0
 
| 0x001100C0
 
|  
 
|  
 +
| Yes
 
| Yes
 
| Yes
 
| [[APT:MapProgramIdForDebug|MapProgramIdForDebug]]
 
| [[APT:MapProgramIdForDebug|MapProgramIdForDebug]]
Line 218: Line 263:
 
|  
 
|  
 
| Yes
 
| Yes
−
| SetHomeMenuAppletIdForDebug
+
| Yes
 +
| [[APT:SetHomeMenuAppletIdForDebug|SetHomeMenuAppletIdForDebug]]
 
|-
 
|-
 
| 0x00130000
 
| 0x00130000
 
|  
 
|  
 
| Yes
 
| Yes
−
| GetPreparationState
+
| Yes
 +
| [[APT:GetPreparationState|GetPreparationState]]
 
|-
 
|-
 
| 0x00140040
 
| 0x00140040
 
|  
 
|  
 
| Yes
 
| Yes
−
| SetPreparationState
+
| Yes
 +
| [[APT:SetPreparationState|SetPreparationState]]
 
|-
 
|-
 
| 0x00150140
 
| 0x00150140
 
|  
 
|  
 +
| No
 
| No
 
| No
 
| [[APT:PrepareToStartApplication|PrepareToStartApplication]]
 
| [[APT:PrepareToStartApplication|PrepareToStartApplication]]
Line 238: Line 287:
 
|  
 
|  
 
| Yes
 
| Yes
−
| PreloadLibraryApplet
+
| Yes
 +
| [[APT:PreloadLibraryApplet|PreloadLibraryApplet]]
 
|-
 
|-
 
| 0x00170040
 
| 0x00170040
 
|  
 
|  
 
| Yes
 
| Yes
−
| FinishPreloadingLibraryApplet
+
| Yes
 +
| [[APT:FinishPreloadingLibraryApplet|FinishPreloadingLibraryApplet]]
 
|-
 
|-
 
| 0x00180040
 
| 0x00180040
 
|  
 
|  
 
| Yes
 
| Yes
−
| PrepareToStartLibraryApplet
+
| Yes
 +
| [[APT:PrepareToStartLibraryApplet|PrepareToStartLibraryApplet]]
 
|-
 
|-
 
| 0x00190040
 
| 0x00190040
 
|  
 
|  
 +
| Yes
 
| Yes
 
| Yes
 
| [[APT:PrepareToStartSystemApplet|PrepareToStartSystemApplet]]
 
| [[APT:PrepareToStartSystemApplet|PrepareToStartSystemApplet]]
Line 258: Line 311:
 
|  
 
|  
 
| Yes
 
| Yes
−
| PrepareToStartNewestHomeMenu
+
| Yes
 +
| [[APT:PrepareToStartNewestHomeMenu|PrepareToStartNewestHomeMenu]]
 
|-
 
|-
 
| 0x001B00C4
 
| 0x001B00C4
 
|  
 
|  
 +
| Yes
 
| Yes
 
| Yes
 
| [[APT:StartApplication|StartApplication]]
 
| [[APT:StartApplication|StartApplication]]
Line 268: Line 323:
 
|  
 
|  
 
| Yes
 
| Yes
−
| WakeupApplication
+
| Yes
 +
| [[APT:WakeupApplication|WakeupApplication]]
 
|-
 
|-
 
| 0x001D0000
 
| 0x001D0000
 
|  
 
|  
 
| Yes
 
| Yes
−
| CancelApplication
+
| Yes
 +
| [[APT:CancelApplication|CancelApplication]]
 
|-
 
|-
 
| 0x001E0084
 
| 0x001E0084
 
|  
 
|  
 
| Yes
 
| Yes
−
| StartLibraryApplet
+
| Yes
 +
| [[APT:StartLibraryApplet|StartLibraryApplet]]
 
|-
 
|-
 
| 0x001F0084
 
| 0x001F0084
 
|  
 
|  
 +
| Yes
 
| Yes
 
| Yes
 
| [[APT:StartSystemApplet|StartSystemApplet]]
 
| [[APT:StartSystemApplet|StartSystemApplet]]
Line 287: Line 346:
 
| 0x00200044
 
| 0x00200044
 
|  
 
|  
 +
| Yes
 
| Yes
 
| Yes
 
| [[APT:StartNewestHomeMenu|StartNewestHomeMenu]]
 
| [[APT:StartNewestHomeMenu|StartNewestHomeMenu]]
Line 293: Line 353:
 
|  
 
|  
 
| No
 
| No
−
| OrderToCloseApplication
+
| No
 +
| [[APT:OrderToCloseApplication|OrderToCloseApplication]]
 
|-
 
|-
 
| 0x00220040
 
| 0x00220040
 
|  
 
|  
 
| Yes
 
| Yes
−
| PrepareToCloseApplication
+
| Yes
 +
| [[APT:PrepareToCloseApplication|PrepareToCloseApplication]]
 
|-
 
|-
 
| 0x00230040
 
| 0x00230040
 
|  
 
|  
 
| Yes
 
| Yes
−
| PrepareToJumpToApplication
+
| Yes
 +
| [[APT:PrepareToJumpToApplication|PrepareToJumpToApplication]]
 
|-
 
|-
 
| 0x00240044
 
| 0x00240044
 
|  
 
|  
 
| Yes
 
| Yes
−
| JumpToApplication
+
| Yes
 +
| [[APT:JumpToApplication|JumpToApplication]]
 
|-
 
|-
 
| 0x002500C0
 
| 0x002500C0
 
|  
 
|  
 
| Yes
 
| Yes
−
| PrepareToCloseLibraryApplet
+
| Yes
 +
| [[APT:PrepareToCloseLibraryApplet|PrepareToCloseLibraryApplet]]
 
|-
 
|-
 
| 0x00260000
 
| 0x00260000
 
|  
 
|  
 
| Yes
 
| Yes
−
| PrepareToCloseSystemApplet
+
| Yes
 +
| [[APT:PrepareToCloseSystemApplet|PrepareToCloseSystemApplet]]
 
|-
 
|-
 
| 0x00270044
 
| 0x00270044
 
|  
 
|  
 
| Yes
 
| Yes
−
| CloseApplication
+
| Yes
 +
| [[APT:CloseApplication|CloseApplication]]
 
|-
 
|-
 
| 0x00280044
 
| 0x00280044
 
|  
 
|  
 
| Yes
 
| Yes
−
| CloseLibraryApplet
+
| Yes
 +
| [[APT:CloseLibraryApplet|CloseLibraryApplet]]
 
|-
 
|-
 
| 0x00290044
 
| 0x00290044
 
|  
 
|  
 
| Yes
 
| Yes
−
| CloseSystemApplet
+
| Yes
 +
| [[APT:CloseSystemApplet|CloseSystemApplet]]
 
|-
 
|-
 
| 0x002A0000
 
| 0x002A0000
 
|  
 
|  
 
| Yes
 
| Yes
−
| OrderToCloseSystemApplet
+
| Yes
 +
| [[APT:OrderToCloseSystemApplet|OrderToCloseSystemApplet]]
 
|-
 
|-
 
| 0x002B0000
 
| 0x002B0000
 
|  
 
|  
 
| Yes
 
| Yes
−
| PrepareToJumpToHomeMenu
+
| Yes
 +
| [[APT:PrepareToJumpToHomeMenu|PrepareToJumpToHomeMenu]]
 
|-
 
|-
 
| 0x002C0044
 
| 0x002C0044
 
|  
 
|  
 
| Yes
 
| Yes
−
| JumpToHomeMenu
+
| Yes
 +
| [[APT:JumpToHomeMenu|JumpToHomeMenu]]
 
|-
 
|-
 
| 0x002D0000
 
| 0x002D0000
 
|  
 
|  
 
| Yes
 
| Yes
−
| PrepareToLeaveHomeMenu
+
| Yes
 +
| [[APT:PrepareToLeaveHomeMenu|PrepareToLeaveHomeMenu]]
 
|-
 
|-
 
| 0x002E0044
 
| 0x002E0044
 
|  
 
|  
 
| Yes
 
| Yes
−
| LeaveHomeMenu
+
| Yes
 +
| [[APT:LeaveHomeMenu|LeaveHomeMenu]]
 
|-
 
|-
 
| 0x002F0040
 
| 0x002F0040
 
|  
 
|  
 
| Yes
 
| Yes
−
| PrepareToLeaveResidentApplet
+
| Yes
 +
| [[APT:PrepareToLeaveResidentApplet|PrepareToLeaveResidentApplet]]
 
|-
 
|-
 
| 0x00300044
 
| 0x00300044
 
|  
 
|  
 
| Yes
 
| Yes
−
| LeaveResidentApplet
+
| Yes
 +
| [[APT:LeaveResidentApplet|LeaveResidentApplet]]
 
|-
 
|-
 
| 0x00310100
 
| 0x00310100
 
|  
 
|  
 +
| Yes
 
| Yes
 
| Yes
 
| [[APT:PrepareToDoApplicationJump|PrepareToDoApplicationJump]]
 
| [[APT:PrepareToDoApplicationJump|PrepareToDoApplicationJump]]
Line 377: Line 454:
 
| 0x00320084
 
| 0x00320084
 
|  
 
|  
 +
| Yes
 
| Yes
 
| Yes
 
| [[APT:DoApplicationJump|DoApplicationJump]]
 
| [[APT:DoApplicationJump|DoApplicationJump]]
Line 383: Line 461:
 
|  
 
|  
 
| Yes
 
| Yes
−
| GetProgramIdOnApplicationJump
+
| Yes
 +
| [[APT:GetProgramIdOnApplicationJump|GetProgramIdOnApplicationJump]]
 
|-
 
|-
 
| 0x00340084
 
| 0x00340084
 
|  
 
|  
 +
| Yes
 
| Yes
 
| Yes
 
| [[APT:SendDeliverArg|SendDeliverArg]]
 
| [[APT:SendDeliverArg|SendDeliverArg]]
Line 393: Line 473:
 
|  
 
|  
 
| Yes
 
| Yes
−
| ReceiveDeliverArg
+
| Yes
 +
| [[APT:ReceiveDeliverArg|ReceiveDeliverArg]]
 
|-
 
|-
 
| 0x00360040
 
| 0x00360040
 
|  
 
|  
 
| Yes
 
| Yes
−
| LoadSysMenuArg
+
| Yes
 +
| [[APT:LoadSysMenuArg|LoadSysMenuArg]]
 
|-
 
|-
 
| 0x00370042
 
| 0x00370042
 
|  
 
|  
 
| Yes
 
| Yes
−
| StoreSysMenuArg
+
| Yes
 +
| [[APT:StoreSysMenuArg|StoreSysMenuArg]]
 
|-
 
|-
 
| 0x00380040
 
| 0x00380040
 
|  
 
|  
 
| Yes
 
| Yes
−
| PreloadResidentApplet
+
| Yes
 +
| [[APT:PreloadResidentApplet|PreloadResidentApplet]]
 
|-
 
|-
 
| 0x00390040
 
| 0x00390040
 
|  
 
|  
 
| Yes
 
| Yes
−
| PrepareToStartResidentApplet
+
| Yes
 +
| [[APT:PrepareToStartResidentApplet|PrepareToStartResidentApplet]]
 
|-
 
|-
 
| 0x003A0044
 
| 0x003A0044
 
|  
 
|  
 
| Yes
 
| Yes
−
| StartResidentApplet
+
| Yes
 +
| [[APT:StartResidentApplet|StartResidentApplet]]
 
|-
 
|-
 
| 0x003B0040
 
| 0x003B0040
 
|  
 
|  
 
| Yes
 
| Yes
−
| CancelLibraryApplet
+
| Yes
 +
| [[APT:CancelLibraryApplet|CancelLibraryApplet]]
 
|-
 
|-
 
| 0x003C0042
 
| 0x003C0042
 
|  
 
|  
 
| Yes
 
| Yes
−
| SendDspSleep
+
| Yes
 +
| [[APT:SendDspSleep|SendDspSleep]]
 
|-
 
|-
 
| 0x003D0042
 
| 0x003D0042
 
|  
 
|  
 
| Yes
 
| Yes
−
| SendDspWakeUp
+
| Yes
 +
| [[APT:SendDspWakeUp|SendDspWakeUp]]
 
|-
 
|-
 
| 0x003E0080
 
| 0x003E0080
 
|  
 
|  
 
| Yes
 
| Yes
−
| ReplySleepQuery
+
| Yes
 +
| [[APT:ReplySleepQuery|ReplySleepQuery]]
 
|-
 
|-
 
| 0x003F0040
 
| 0x003F0040
 
|  
 
|  
 
| Yes
 
| Yes
−
| ReplySleepNotificationComplete
+
| Yes
 +
| [[APT:ReplySleepNotificationComplete|ReplySleepNotificationComplete]]
 
|-
 
|-
 
| 0x00400042
 
| 0x00400042
 
|  
 
|  
 +
| Yes
 
| Yes
 
| Yes
 
| [[APT:SendCaptureBufferInfo|SendCaptureBufferInfo]]
 
| [[APT:SendCaptureBufferInfo|SendCaptureBufferInfo]]
Line 452: Line 544:
 
| 0x00410040
 
| 0x00410040
 
|  
 
|  
 +
| Yes
 
| Yes
 
| Yes
 
| [[APT:ReceiveCaptureBufferInfo|ReceiveCaptureBufferInfo]]
 
| [[APT:ReceiveCaptureBufferInfo|ReceiveCaptureBufferInfo]]
Line 458: Line 551:
 
|  
 
|  
 
| Yes
 
| Yes
−
| SleepSystem
+
| Yes
 +
| [[APT:SleepSystem|SleepSystem]]
 
|-
 
|-
 
| 0x00430040
 
| 0x00430040
 
|  
 
|  
 
| Yes
 
| Yes
−
| NotifyToWait
+
| Yes
 +
| [[APT:NotifyToWait|NotifyToWait]]
 
|-
 
|-
 
| 0x00440000
 
| 0x00440000
 
|  
 
|  
 
| Yes
 
| Yes
−
| GetSharedFont
+
| Yes
 +
| [[APT:GetSharedFont|GetSharedFont]]
 
|-
 
|-
 
| 0x00450040
 
| 0x00450040
 
|  
 
|  
 
| Yes
 
| Yes
−
| GetWirelessRebootInfo
+
| Yes
 +
| [[APT:GetWirelessRebootInfo|GetWirelessRebootInfo]]
 
|-
 
|-
 
| 0x00460104
 
| 0x00460104
 
|  
 
|  
 +
| Yes
 
| Yes
 
| Yes
 
| [[APT:Wrap|Wrap]]
 
| [[APT:Wrap|Wrap]]
Line 482: Line 580:
 
| 0x00470104
 
| 0x00470104
 
|  
 
|  
 +
| Yes
 
| Yes
 
| Yes
 
| [[APT:Unwrap|Unwrap]]
 
| [[APT:Unwrap|Unwrap]]
Line 487: Line 586:
 
| 0x00480100
 
| 0x00480100
 
|  
 
|  
 +
| No
 
| No
 
| No
 
| [[APT:GetProgramInfo|GetProgramInfo]]
 
| [[APT:GetProgramInfo|GetProgramInfo]]
Line 492: Line 592:
 
| 0x00490180
 
| 0x00490180
 
|  
 
|  
 +
| No
 
| No
 
| No
 
| [[APT:Reboot|Reboot]]
 
| [[APT:Reboot|Reboot]]
Line 497: Line 598:
 
| 0x004A0040
 
| 0x004A0040
 
|  
 
|  
 +
| Yes
 
| Yes
 
| Yes
 
| [[APT:GetCaptureInfo|GetCaptureInfo]]
 
| [[APT:GetCaptureInfo|GetCaptureInfo]]
Line 502: Line 604:
 
| 0x004B00C2
 
| 0x004B00C2
 
|  
 
|  
 +
| Yes
 
| Yes
 
| Yes
 
| [[APT:AppletUtility|AppletUtility]]
 
| [[APT:AppletUtility|AppletUtility]]
Line 508: Line 611:
 
|  
 
|  
 
| Yes
 
| Yes
−
| SetFatalErrDispMode
+
| Yes
 +
| [[APT:SetFatalErrDispMode|SetFatalErrDispMode]]
 
|-
 
|-
 
| 0x004D0080
 
| 0x004D0080
 
|  
 
|  
 +
| Yes
 
| Yes
 
| Yes
 
| [[APT:GetAppletProgramInfo|GetAppletProgramInfo]]
 
| [[APT:GetAppletProgramInfo|GetAppletProgramInfo]]
Line 518: Line 623:
 
|  
 
|  
 
| Yes
 
| Yes
−
| HardwareResetAsync
+
| Yes
 +
| [[APT:HardwareResetAsync|HardwareResetAsync]]
 
|-
 
|-
−
| 0x004F....
+
| 0x004F0080
−
| ?
+
| [[2.2.0-X]]
−
| ?
+
| Yes
−
| ?
+
| Yes
 +
| [[APT:SetApplicationCpuTimeLimit|SetApplicationCpuTimeLimit]]
 
|-
 
|-
−
| 0x0050....
+
| 0x00500040
−
| ?
+
| [[2.2.0-X]]
−
| ?
+
| Yes
−
| ?
+
| Yes
 +
| [[APT:GetApplicationCpuTimeLimit|GetApplicationCpuTimeLimit]]
 
|-
 
|-
−
| 0x0051....
+
| 0x00510080
−
| ?
+
| [[3.0.0-5]]
−
| ?
+
| Yes
−
| ?
+
| Yes
 +
| [[APT:GetStartupArgument|GetStartupArgument]]
 
|-
 
|-
−
| 0x0052....
+
| 0x00520104
−
| ?
+
| [[4.0.0-7]]
−
| ?
+
| Yes
−
| ?
+
| Yes
 +
| [[APT:Wrap1|Wrap1]]
 
|-
 
|-
−
| 0x0053....
+
| 0x00530104
−
| ?
+
| [[4.0.0-7]]
−
| ?
+
| Yes
−
| ?
+
| Yes
 +
| [[APT:Unwrap1|Unwrap1]]
 
|-
 
|-
 
| 0x00540040
 
| 0x00540040
 
| [[5.0.0-11]]
 
| [[5.0.0-11]]
−
| ?
+
| Yes
−
| ?
+
| Yes
 +
| Takes an unknown parameter, outputs a result code and media type.
 
|-
 
|-
 
| 0x00550040
 
| 0x00550040
 
| [[7.0.0-13]]
 
| [[7.0.0-13]]
 
| Yes
 
| Yes
−
| This writes the input u8 to a NS state field.
+
| Yes
 +
| [[APT:SetScreenCapturePostPermission|SetScreenCapturePostPermission]]
 
|-
 
|-
 
| 0x00560000
 
| 0x00560000
 
| [[7.0.0-13]]
 
| [[7.0.0-13]]
−
| ?
+
| Yes
−
| ?
+
| Yes
 +
| [[APT:GetScreenCapturePostPermission|GetScreenCapturePostPermission]]
 
|-
 
|-
 
| 0x00570044
 
| 0x00570044
 
| [[7.0.0-13]]
 
| [[7.0.0-13]]
−
| ?
+
| Yes
−
| ?
+
| Yes
 +
| [[APT:WakeupApplication2|WakeupApplication2]]
 
|-
 
|-
 
| 0x00580002
 
| 0x00580002
 
| [[7.0.0-13]]
 
| [[7.0.0-13]]
−
| ?
+
| Yes
−
| ?
+
| Yes
 +
| [[APT:GetProgramID|GetProgramID]]
 +
|-
 +
| 0x01010000
 +
| [[8.0.0-18]]
 +
| Yes
 +
| Yes
 +
| [[APT:GetTargetPlatform|GetTargetPlatform]]
 +
|-
 +
| 0x01020000
 +
| [[8.0.0-18]]
 +
| Yes
 +
| Yes
 +
| [[APT:CheckNew3DS|CheckNew3DS]]
 +
|-
 +
| 0x01030000
 +
| [[8.0.0-18]]
 +
| Yes
 +
| Yes
 +
| [[APT:GetApplicationRunningMode|GetApplicationRunningMode]]
 +
|-
 +
| 0x01040000
 +
| [[8.0.0-18]]
 +
| Yes
 +
| Yes
 +
| [[APT:IsStandardMemoryLayout|IsStandardMemoryLayout]]
 +
|-
 +
| 0x01050100
 +
| [[10.4.0-29]]
 +
| Yes
 +
| Yes
 +
| [[APT:IsTitleAllowed|IsTitleAllowed]]
 
|}
 
|}
  
Line 578: Line 724:
  
 
APT:PrepareToDoApplicationJump and APT:DoApplicationJump are used by applications, for launching native/<non-NATIVE_FIRM> applications. These commands notify Home Menu that title launching needs done, Home Menu does the actual title launching via NS commands.
 
APT:PrepareToDoApplicationJump and APT:DoApplicationJump are used by applications, for launching native/<non-NATIVE_FIRM> applications. These commands notify Home Menu that title launching needs done, Home Menu does the actual title launching via NS commands.
 +
 +
== AppletAttr ==
 +
{| class="wikitable" border="1"
 +
|-
 +
!  Bits
 +
!  Description
 +
|-
 +
| 0-2
 +
| [[NS_and_APT_Services#AppletPos|AppletPos]]
 +
|-
 +
| 3
 +
| Manually Acquire/Release GPU Rights
 +
|-
 +
| 4
 +
| Manually Acquire/Release DSP Rights
 +
|-
 +
| 5
 +
| ?
 +
|}
 +
 +
== DisplayBufferMode ==
 +
{| class="wikitable" border="1"
 +
|-
 +
!  Value
 +
!  Description
 +
|-
 +
| 0
 +
| FORMAT_R8G8B8A8
 +
|-
 +
| 1
 +
| FORMAT_R8G8B8
 +
|-
 +
| 2
 +
| FORMAT_R5G6B5
 +
|-
 +
| 3
 +
| FORMAT_R5G5B5A1
 +
|-
 +
| 4
 +
| FORMAT_R4G4B4A4
 +
|-
 +
| 0xFFFFFFFF
 +
| FORMAT_UNIMPORTABLE
 +
|}
 +
 +
This is the same mapping as used for the [[GPU/External_Registers#Framebuffer_color_formats|GPU framebuffer color formats]].
 +
 +
== AppletPos ==
 +
{| class="wikitable" border="1"
 +
|-
 +
!  Value
 +
!  Description
 +
|-
 +
| -1
 +
| POS_NONE
 +
|-
 +
| 0
 +
| POS_APP
 +
|-
 +
| 1
 +
| POS_APPLIB
 +
|-
 +
| 2
 +
| POS_SYS
 +
|-
 +
| 3
 +
| POS_SYSLIB
 +
|-
 +
| 4
 +
| POS_RESIDENT
 +
|}
 +
 +
== QueryReply ==
 +
{| class="wikitable" border="1"
 +
|-
 +
!  Value
 +
!  Description
 +
|-
 +
| 0
 +
| REPLY_REJECT
 +
|-
 +
| 1
 +
| REPLY_ACCEPT
 +
|-
 +
| 2
 +
| REPLY_LATER
 +
|}
 +
 +
== Notification ==
 +
{| class="wikitable" border="1"
 +
|-
 +
!  Value
 +
!  Description
 +
|-
 +
| 0
 +
| NOTIFICATION_NONE
 +
|-
 +
| 1
 +
| NOTIFICATION_HOME_BUTTON_1
 +
|-
 +
| 2
 +
| NOTIFICATION_HOME_BUTTON_2
 +
|-
 +
| 3
 +
| NOTIFICATION_SLEEP_QUERY
 +
|-
 +
| 4
 +
| NOTIFICATION_SLEEP_CANCELED_BY_OPEN
 +
|-
 +
| 5
 +
| NOTIFICATION_SLEEP_ACCEPTED
 +
|-
 +
| 6
 +
| NOTIFICATION_SLEEP_AWAKE
 +
|-
 +
| 7
 +
| NOTIFICATION_SHUTDOWN
 +
|-
 +
| 8
 +
| NOTIFICATION_POWER_BUTTON_CLICK
 +
|-
 +
| 9
 +
| NOTIFICATION_POWER_BUTTON_CLEAR
 +
|-
 +
| 10
 +
| NOTIFICATION_TRY_SLEEP
 +
|-
 +
| 11
 +
| NOTIFICATION_ORDER_TO_CLOSE
 +
|}
 +
 +
== Command ==
 +
{| class="wikitable" border="1"
 +
|-
 +
!  Value
 +
!  Description
 +
|-
 +
| 0
 +
| COMMAND_NONE
 +
|-
 +
| 1
 +
| COMMAND_WAKEUP
 +
|-
 +
| 2
 +
| COMMAND_REQUEST
 +
|-
 +
| 3
 +
| COMMAND_RESPONSE
 +
|-
 +
| 4
 +
| COMMAND_EXIT
 +
|-
 +
| 5
 +
| COMMAND_MESSAGE
 +
|-
 +
| 6
 +
| COMMAND_HOME_BUTTON_SINGLE
 +
|-
 +
| 7
 +
| COMMAND_HOME_BUTTON_DOUBLE
 +
|-
 +
| 8
 +
| COMMAND_DSP_SLEEP
 +
|-
 +
| 9
 +
| COMMAND_DSP_WAKEUP
 +
|-
 +
| 10
 +
| COMMAND_WAKEUP_BY_EXIT
 +
|-
 +
| 11
 +
| COMMAND_WAKEUP_BY_PAUSE
 +
|-
 +
| 12
 +
| COMMAND_WAKEUP_BY_CANCEL
 +
|-
 +
| 13
 +
| COMMAND_WAKEUP_BY_CANCELALL
 +
|-
 +
| 14
 +
| COMMAND_WAKEUP_BY_POWER_BUTTON_CLICK
 +
|-
 +
| 15
 +
| COMMAND_WAKEUP_TO_JUMP_HOME
 +
|-
 +
| 16
 +
| COMMAND_REQUEST_FOR_SYS_APPLET
 +
|-
 +
| 17
 +
| COMMAND_WAKEUP_TO_LAUNCH_APPLICATION
 +
|-
 +
| 0x41
 +
| Unknown. [[APT:ReceiveParameter|Received]] by Home Menu during boot when the Home Menu process doesn't terminate properly(svcExitProcess/crash).
 +
|}
 +
 +
== AppletPreparationState ==
 +
{| class="wikitable" border="1"
 +
|-
 +
!  Value
 +
!  Description
 +
|-
 +
| 0
 +
| NO_PREPARATION
 +
|-
 +
| 1
 +
| PREPARED_TO_LAUNCH_APP
 +
|-
 +
| 2
 +
| PREPARED_TO_CLOSE_APP
 +
|-
 +
| 3
 +
| PREPARED_TO_FORCE_TO_CLOSE_APP
 +
|-
 +
| 4
 +
| PREPARED_TO_PRELOAD_APPLIB
 +
|-
 +
| 5
 +
| PREPARED_TO_LAUNCH_APPLIB
 +
|-
 +
| 6
 +
| PREPARED_TO_CLOSE_APPLIB
 +
|-
 +
| 7
 +
| PREPARED_TO_LAUNCH_SYS
 +
|-
 +
| 8
 +
| PREPARED_TO_CLOSE_SYS
 +
|-
 +
| 9
 +
| PREPARED_TO_PRELOAD_SYSLIB
 +
|-
 +
| 10
 +
| PREPARED_TO_LAUNCH_SYSLIB
 +
|-
 +
| 11
 +
| PREPARED_TO_CLOSE_SYSLIB
 +
|-
 +
| 12
 +
| PREPARED_TO_LAUNCH_RESIDENT
 +
|-
 +
| 13
 +
| PREPARED_TO_LEAVE_RESIDENT
 +
|-
 +
| 14
 +
| PREPARED_TO_DO_HOMEMENU
 +
|-
 +
| 15
 +
| PREPARED_TO_LEAVE_HOMEMENU
 +
|-
 +
| 16
 +
| PREPARED_TO_START_RESIDENT
 +
|-
 +
| 17
 +
| PREPARED_TO_DO_APP_JUMP
 +
|-
 +
| 18
 +
| PREPARED_TO_FORCE_TO_CLOSE_SYS
 +
|-
 +
| 19
 +
| PREPARED_TO_LAUNCH_OTHER_SYS
 +
|-
 +
| 20
 +
| PREPARED_TO_JUMP_TO_APP
 +
|}
 +
 +
== StartupArgumentType ==
 +
{| class="wikitable" border="1"
 +
|-
 +
!  Value
 +
!  Description
 +
|-
 +
| 0
 +
| STARTUP_ARGUMENT_TYPE_OTHER_APP
 +
|-
 +
| 1
 +
| STARTUP_ARGUMENT_TYPE_RESTART
 +
|-
 +
| 2
 +
| STARTUP_ARGUMENT_TYPE_OTHER_MEDIA
 +
|}
 +
 +
== CaptureBufferInfo ==
 +
{| class="wikitable" border="1"
 +
|-
 +
!  Offset
 +
!  Size
 +
!  Description
 +
|-
 +
| 0x0
 +
| 0x4
 +
| u32, Size
 +
|-
 +
| 0x4
 +
| 0x1
 +
| u8, 3D (0 = not 3D, 1 = 3D)
 +
|-
 +
| 0x5
 +
| 0x3
 +
| Reserved
 +
|-
 +
| 0x8
 +
| 0x4
 +
| Main Screen Left Offset
 +
|-
 +
| 0xC
 +
| 0x4
 +
| Main Screen Right Offset
 +
|-
 +
| 0x10
 +
| 0x4
 +
| Main Screen [[NS_and_APT_Services#DisplayBufferMode|DisplayBufferMode]]
 +
|-
 +
| 0x14
 +
| 0x4
 +
| Sub Screen Left Offset
 +
|-
 +
| 0x18
 +
| 0x4
 +
| Sub Screen Right Offset
 +
|-
 +
| 0x1C
 +
| 0x4
 +
| Sub Screen [[NS_and_APT_Services#DisplayBufferMode|DisplayBufferMode]]
 +
|}
 +
 +
==WirelessRebootInfo==
 +
{| class="wikitable" border="1"
 +
|-
 +
!  Offset
 +
!  Size
 +
!  Description
 +
|-
 +
| 0x0
 +
| 0x6
 +
| Host MAC address.
 +
|-
 +
| 0x6
 +
| 0x9
 +
| WirelessRebootPassphrase
 +
|-
 +
| 0xF
 +
| 0x1
 +
| Uninitialized
 +
|}
 +
 +
This is [[NSS:SetWirelessRebootInfo|setup]] by the dlplay system-application, before launching the DLP-child which can then use [[APT:GetWirelessRebootInfo]]. The MAC address and passphrase is used for connecting to the host by the DLP-child. See also [[DLP_Services|here]].
  
 
="APT:A" Service=
 
="APT:A" Service=
−
This was added with [[7.0.0-13]], it's unknown what this is used for.
+
This was added with [[7.0.0-13|7.0.0-X]]. Official apps built with the CTRSDK for system-version >=[[7.0.0-13|7.0.0-X]] normally use the "APT:A" service instead of "APT:U". Those processes also have "APT:A" instead of "APT:U" in the service-access-control. Unlike APT:U, APT:A can call [[APT:GetAppletInfo]] with applet ID 0x300.
 +
 
 +
=Applets=
 +
NS module does not verify that the input appID for the APT service cmds are correct for that type of command. For example, a process-launch of a SystemApplet via LibraryApplet commands works fine(minus the launched-process side of APT probably).
 +
 
 +
==System Applets==
 +
On Old3DS there could only be one applet here(Home Menu, Internet Browser, Friend-List, etc) with programID-high 00040030 running at a time. On Old3DS when directly launching one of these 00040030 applets with Home Menu, the Home Menu process will terminate once the process is launched. On Old3DS when returning to Home Menu from that launched process, the Home Menu process is launched again.
 +
 
 +
On New3DS the Home Menu process is still running/in-memory, while another system-applet is running. On New3DS it appears that the Home Menu process is terminated+relaunched, when another system-applet terminated without exiting with APT properly.
 +
 
 +
==Library Applets==
 +
Library applets can be launched by applications and regular applets. These library applets render to the screen(s) when running, etc. For example, this includes swkbd for text input. See the below appIDs in the 0x2XX range, the actual appID used is 0x4XX however.
 +
 
 +
Input data can be sent to the library applet via the NS [[APT:SendParameter|parameter]] buffer, and/or with shared-memory with a shared-mem handle sent to the library applet. Output data from the library applet can be received by [[APT:ReceiveParameter]], the library applet can also use the specified shared-mem for output too.
  
 
=AppIDs=
 
=AppIDs=
Line 589: Line 1,094:
 
|-
 
|-
 
| 0x101
 
| 0x101
−
| Home Menu
+
| [[Home Menu]] (menu)
 
|-
 
|-
 
| 0x103
 
| 0x103
Line 595: Line 1,100:
 
|-
 
|-
 
| 0x110
 
| 0x110
−
| Camera applet
+
| Camera applet ([[Camera Applet|CtrApp]])
 
|-
 
|-
 
| 0x112
 
| 0x112
−
| Friends List applet
+
| Friends List applet ([[Friend List|friend]])
 
|-
 
|-
 
| 0x113
 
| 0x113
−
| Game Notes applet
+
| Game Notes applet (Cherry)
 
|-
 
|-
 
| 0x114
 
| 0x114
−
| [[Internet Browser]]
+
| [[Internet Browser]] (spider/SKATER)
 
|-
 
|-
 
| 0x115
 
| 0x115
Line 610: Line 1,115:
 
|-
 
|-
 
| 0x116
 
| 0x116
−
| Notifications applet
+
| [[Notifications]] applet (newslist)
 
|-
 
|-
 
| 0x117
 
| 0x117
−
| Miiverse("olv") applet
+
| Miiverse applet (olv)
 +
|-
 +
| 0x118
 +
| [[Miiverse]] posting applet (solv3)
 +
|-
 +
| 0x119
 +
| Amiibo settings (cabinet)
 
|-
 
|-
 
| 0x201
 
| 0x201
−
| Software Keyboard (swkbd)
+
| Software Keyboard (swkbd) (?)
 
|-
 
|-
 
| 0x202
 
| 0x202
−
| appletEd
+
| [[Mii Selector]] (appletEd) (?)
 
|-
 
|-
 
| 0x204
 
| 0x204
−
| PNOTE_AP
+
| Photo Selector (PNOTE_AP) (?)
 
|-
 
|-
 
| 0x205
 
| 0x205
−
| SNOTE_AP
+
| Sound Selector (SNOTE_AP) (?)
 
|-
 
|-
 
| 0x206
 
| 0x206
−
| error
+
| Error Display ([[ErrDisp|error]]) (?)
 
|-
 
|-
 
| 0x207
 
| 0x207
−
| mint
+
| eShop applet ([[EShop#NS_eShop_application_parameters|mint]]) (?)
 
|-
 
|-
 
| 0x208
 
| 0x208
−
| extrapad
+
| Circle Pad Pro Calibrator ([[Extrapad_Applet|extrapad]]) (?)
 
|-
 
|-
 
| 0x209
 
| 0x209
−
| memolib
+
| Notepad (memolib) (?)
 
|-
 
|-
 
| 0x300
 
| 0x300
 
| Application
 
| Application
 +
|-
 +
| 0x301
 +
| eShop (tiger)
 +
|-
 +
| 0x401
 +
| Software Keyboard (swkbd)
 +
|-
 +
| 0x402
 +
| Mii Selector (appletEd)
 +
|-
 +
| 0x404
 +
| Photo Selector (PNOTE_AP)
 +
|-
 +
| 0x405
 +
| Sound Selector (SNOTE_AP)
 +
|-
 +
| 0x406
 +
| Error Display (error)
 +
|-
 +
| 0x407
 +
| eShop applet (mint)
 +
|-
 +
| 0x408
 +
| Circle Pad Pro Calibrator ([[Extrapad_Applet|extrapad]])
 +
|-
 +
| 0x409
 +
| Notepad (memolib)
 
|-
 
|-
 
| 0xF10
 
| 0xF10

Revision as of 23:37, 23 July 2023

The NS (Nintendo User Interface Shell) system module is the first module launched from a CTR-NAND title after the FIRM processes are loaded (also see Bootloader). This module is launched by the pm process, with the titleID loaded from NS state(hard-coded TID initialized during applet TID-array initialization). NS first launches ErrDisp, then the menu. On retail the menu TID is loaded from NS state, while on dev/debug the menu TID is loaded from config. On dev-units if the menu TID block doesn't exist in config, NS will attempt to launch the alternate menu instead. The TID of the launched menu is then written to ACTIVEMENUTID. NS uses pm:app to launch titles.

NS will not trigger the fatal-error screen when launching the regular/alternate menu fails.

Like home menu NS is constantly running while the system is in 3DS-mode. When attempting to return to home-menu when the home-menu process isn't running(like when the process terminated/crashed), NS will trigger a fatal error.

Alternate menu

When launching the regular menu fails, NS will then attempt to launch the alternate menu. This title could be used as a recovery process, however it's normally not used after the factory.

At the factory for all 3DS systems, Test Menu is installed with this TID. On retail this title is eventually deleted during Factory Setup.

Auto-boot

After loading FIRM params and prior to launching ErrDisp/Home Menu, NS handles auto-booting titles. The same code called by APT:Reboot is used for launching FIRM here. When the UPDATEFLAG is set, NS will launch SAFE_MODE_FIRM with the application titleID set to the System Updater titleID for this region. When the UPDATEFLAG is not set, NS can auto-boot the following titles as well if 0x1FF80016 bit0 is set.

When bit1 and bit2 are value zero in 0x1FF80016, NS will launch the title specified by the FIRM parameters if the title-info is set. This FIRM launch is done after launching ErrDisp and Home Menu. Otherwise when 0x1FF80016 is value 2 and the output u8 from PTMSYSM command 0x08140000 is value 0, NS will boot the title specified from the TWL TLNC block from FIRMparams+0x300. This is the same TLNC block which DSi titles wrote to RAM+0x300 for launching other titles via the launcher title. When handling the TLNC block, NS will boot the 3DS System Settings title when the TLNC titleID is the DSi System Settings titleID(the region field in the TLNC TID is not checked/used). When the TLNC titleID is not System Settings, NS will convert the input DSi titleID-high to the 3DS TWL titleID-high(tidhigh = (TLNCtidhigh & 0x7FFF) | 0x48000), then launch TWL_FIRM to run the title. NS does not support launching from gamecard via TLNC.

NS Workaround

A "ns_workaround" was added in NS to workaround the flaw added with 5.0.0-11. When NS is loading before launching any ARM11 processes and certain Configuration Memory fields are set, NS will launch AM then use command AM:InstallNATIVEFIRM. NS will then execute the code called by APT:StartNewestHomeMenu, the code related to APT:PrepareToStartNewestHomeMenu is not executed here.

NS will only execute this code-path when 0x1FF80016 is value zero, when KERNEL_VERSIONMAJOR is value 2, and when KERNEL_VERSIONMINOR is less than 35. Therefore, this code-path is only executed when the running NATIVE_FIRM version is prior to 5.0.0-11.

NS Service "ns:s"

Command Header Available since system version Description
0x000100C0 1.0.0-0 - 2.0.0-2 LaunchFIRM
0x000200C0 1.0.0-0 - 2.0.0-2 LaunchTitle
0x00030000 1.0.0-0 - 2.0.0-2 TerminateApplication
0x00040040 1.0.0-0 - 2.0.0-2 TerminateProcess
0x000500C0 1.0.0-0 - 2.0.0-2 LaunchApplicationFIRM
0x00060042 1.0.0-0 - 2.0.0-2 SetWirelessRebootInfo
0x00070042 1.0.0-0 - 2.0.0-2 CardUpdateInitialize
0x00080000 1.0.0-0 - 2.0.0-2 CardUpdateShutdown
0x00090000 1.0.0-0 - 2.0.0-2 Gamecard system update related.
0x000A0000 1.0.0-0 - 2.0.0-2 Gamecard system update related.
0x000B0000 1.0.0-0 - 2.0.0-2 Gamecard system update related.
0x000C0000 1.0.0-0 - 2.0.0-2 Gamecard system update related.
0x000D0140 1.0.0-0 - 2.0.0-2 SetTWLBannerHMAC
0x000E0000 1.0.0-0 - 2.0.0-2 ShutdownAsync
0x000F0000 1.0.0-0 - 2.0.0-2 This calls APT:AppletUtility with fixed input params.
0x00100180 1.0.0-0 - 2.0.0-2 RebootSystem
0x00110100 1.0.0-0 - 2.0.0-2 TerminateTitle
0x001200C0 ? SetApplicationCpuTimeLimit
0x00130000 ? ?
0x00140042 ? ?
0x00150140 ? LaunchApplication
0x00160000 8.0.0-18 RebootSystemClean

The maximum sessions that can be used with this service is two, therefore only two processes can use this service at the same time.

NS Power Service "ns:p"

Command Header Description
0x00010040 RebootSystem
0x00020000 ShutdownAsync

This was added with 3.0.0-5. The PTM sysmodule connects to this service, and syncs whenever ptm:s GetShellState() changes.

NS Service "ns:c"

Command Header Description
0x00010100 LockSpecialContent
0x00020100 UnlockSpecialContent

This was added with 5.0.0-11. It is used by the Instruction Manual applet, and is likely related to triggering SD/Game Card removal errors when ejecting the media the manual is stored on.

APT Services

Command Header Available since system version Accessible with APT:U Accessible with APT:A Description
0x00010040 Yes Yes GetLockHandle
0x00020080 See here. See here. Initialize
0x00030040 Yes Yes Enable
0x00040040 Yes Yes Finalize
0x00050040 Yes Yes GetAppletManInfo
0x00060040 Yes (AppID != 0x300) Yes GetAppletInfo
0x00070000 Yes Yes GetLastSignaledAppletId
0x00080000 Yes Yes CountRegisteredApplet
0x00090040 Yes Yes IsRegistered
0x000A0040 Yes Yes GetAttribute
0x000B0040 Yes Yes InquireNotification
0x000C0104 Yes Yes SendParameter
0x000D0080 Yes Yes ReceiveParameter
0x000E0080 Yes Yes GlanceParameter
0x000F0100 Yes Yes CancelParameter
0x001000C2 Yes Yes DebugFunc
0x001100C0 Yes Yes MapProgramIdForDebug
0x00120040 Yes Yes SetHomeMenuAppletIdForDebug
0x00130000 Yes Yes GetPreparationState
0x00140040 Yes Yes SetPreparationState
0x00150140 No No PrepareToStartApplication
0x00160040 Yes Yes PreloadLibraryApplet
0x00170040 Yes Yes FinishPreloadingLibraryApplet
0x00180040 Yes Yes PrepareToStartLibraryApplet
0x00190040 Yes Yes PrepareToStartSystemApplet
0x001A0000 Yes Yes PrepareToStartNewestHomeMenu
0x001B00C4 Yes Yes StartApplication
0x001C0000 Yes Yes WakeupApplication
0x001D0000 Yes Yes CancelApplication
0x001E0084 Yes Yes StartLibraryApplet
0x001F0084 Yes Yes StartSystemApplet
0x00200044 Yes Yes StartNewestHomeMenu
0x00210000 No No OrderToCloseApplication
0x00220040 Yes Yes PrepareToCloseApplication
0x00230040 Yes Yes PrepareToJumpToApplication
0x00240044 Yes Yes JumpToApplication
0x002500C0 Yes Yes PrepareToCloseLibraryApplet
0x00260000 Yes Yes PrepareToCloseSystemApplet
0x00270044 Yes Yes CloseApplication
0x00280044 Yes Yes CloseLibraryApplet
0x00290044 Yes Yes CloseSystemApplet
0x002A0000 Yes Yes OrderToCloseSystemApplet
0x002B0000 Yes Yes PrepareToJumpToHomeMenu
0x002C0044 Yes Yes JumpToHomeMenu
0x002D0000 Yes Yes PrepareToLeaveHomeMenu
0x002E0044 Yes Yes LeaveHomeMenu
0x002F0040 Yes Yes PrepareToLeaveResidentApplet
0x00300044 Yes Yes LeaveResidentApplet
0x00310100 Yes Yes PrepareToDoApplicationJump
0x00320084 Yes Yes DoApplicationJump
0x00330000 Yes Yes GetProgramIdOnApplicationJump
0x00340084 Yes Yes SendDeliverArg
0x00350080 Yes Yes ReceiveDeliverArg
0x00360040 Yes Yes LoadSysMenuArg
0x00370042 Yes Yes StoreSysMenuArg
0x00380040 Yes Yes PreloadResidentApplet
0x00390040 Yes Yes PrepareToStartResidentApplet
0x003A0044 Yes Yes StartResidentApplet
0x003B0040 Yes Yes CancelLibraryApplet
0x003C0042 Yes Yes SendDspSleep
0x003D0042 Yes Yes SendDspWakeUp
0x003E0080 Yes Yes ReplySleepQuery
0x003F0040 Yes Yes ReplySleepNotificationComplete
0x00400042 Yes Yes SendCaptureBufferInfo
0x00410040 Yes Yes ReceiveCaptureBufferInfo
0x00420080 Yes Yes SleepSystem
0x00430040 Yes Yes NotifyToWait
0x00440000 Yes Yes GetSharedFont
0x00450040 Yes Yes GetWirelessRebootInfo
0x00460104 Yes Yes Wrap
0x00470104 Yes Yes Unwrap
0x00480100 No No GetProgramInfo
0x00490180 No No Reboot
0x004A0040 Yes Yes GetCaptureInfo
0x004B00C2 Yes Yes AppletUtility
0x004C0000 Yes Yes SetFatalErrDispMode
0x004D0080 Yes Yes GetAppletProgramInfo
0x004E0000 Yes Yes HardwareResetAsync
0x004F0080 2.2.0-X Yes Yes SetApplicationCpuTimeLimit
0x00500040 2.2.0-X Yes Yes GetApplicationCpuTimeLimit
0x00510080 3.0.0-5 Yes Yes GetStartupArgument
0x00520104 4.0.0-7 Yes Yes Wrap1
0x00530104 4.0.0-7 Yes Yes Unwrap1
0x00540040 5.0.0-11 Yes Yes Takes an unknown parameter, outputs a result code and media type.
0x00550040 7.0.0-13 Yes Yes SetScreenCapturePostPermission
0x00560000 7.0.0-13 Yes Yes GetScreenCapturePostPermission
0x00570044 7.0.0-13 Yes Yes WakeupApplication2
0x00580002 7.0.0-13 Yes Yes GetProgramID
0x01010000 8.0.0-18 Yes Yes GetTargetPlatform
0x01020000 8.0.0-18 Yes Yes CheckNew3DS
0x01030000 8.0.0-18 Yes Yes GetApplicationRunningMode
0x01040000 8.0.0-18 Yes Yes IsStandardMemoryLayout
0x01050100 10.4.0-29 Yes Yes IsTitleAllowed

These "APT:U" and "APT:S" NS services can handle launching titles/"applets", these services handle signaling for home/power button as well. Only one session for either APT service can be open at a time, normally processes close the service handle immediately once finished using the service. The commands for APT:U and APT:S are exactly the same, however certain commands are only accessible with APT:S(NS module will call svcBreak when the command isn't accessible).

Applets returning to home-menu first use commands APT:PrepareToJumpToHomeMenu and APT:JumpToHomeMenu, followed by these commands to launch home-menu: APT:PrepareToStartSystemApplet and APT:StartSystemApplet. APT:PrepareToStartSystemApplet and APT:StartSystemApplet are also used for launching the Internet Browser, the camera applet, etc.

Processes launch applications via home-menu, not directly with APT:PrepareToStartApplication and APT:StartApplication. Regular applications can't directly launch applications since APT:StartApplication launches the process without terminating the currently running application.

APT:PrepareToDoApplicationJump and APT:DoApplicationJump are used by applications, for launching native/<non-NATIVE_FIRM> applications. These commands notify Home Menu that title launching needs done, Home Menu does the actual title launching via NS commands.

AppletAttr

Bits Description
0-2 AppletPos
3 Manually Acquire/Release GPU Rights
4 Manually Acquire/Release DSP Rights
5 ?

DisplayBufferMode

Value Description
0 FORMAT_R8G8B8A8
1 FORMAT_R8G8B8
2 FORMAT_R5G6B5
3 FORMAT_R5G5B5A1
4 FORMAT_R4G4B4A4
0xFFFFFFFF FORMAT_UNIMPORTABLE

This is the same mapping as used for the GPU framebuffer color formats.

AppletPos

Value Description
-1 POS_NONE
0 POS_APP
1 POS_APPLIB
2 POS_SYS
3 POS_SYSLIB
4 POS_RESIDENT

QueryReply

Value Description
0 REPLY_REJECT
1 REPLY_ACCEPT
2 REPLY_LATER

Notification

Value Description
0 NOTIFICATION_NONE
1 NOTIFICATION_HOME_BUTTON_1
2 NOTIFICATION_HOME_BUTTON_2
3 NOTIFICATION_SLEEP_QUERY
4 NOTIFICATION_SLEEP_CANCELED_BY_OPEN
5 NOTIFICATION_SLEEP_ACCEPTED
6 NOTIFICATION_SLEEP_AWAKE
7 NOTIFICATION_SHUTDOWN
8 NOTIFICATION_POWER_BUTTON_CLICK
9 NOTIFICATION_POWER_BUTTON_CLEAR
10 NOTIFICATION_TRY_SLEEP
11 NOTIFICATION_ORDER_TO_CLOSE

Command

Value Description
0 COMMAND_NONE
1 COMMAND_WAKEUP
2 COMMAND_REQUEST
3 COMMAND_RESPONSE
4 COMMAND_EXIT
5 COMMAND_MESSAGE
6 COMMAND_HOME_BUTTON_SINGLE
7 COMMAND_HOME_BUTTON_DOUBLE
8 COMMAND_DSP_SLEEP
9 COMMAND_DSP_WAKEUP
10 COMMAND_WAKEUP_BY_EXIT
11 COMMAND_WAKEUP_BY_PAUSE
12 COMMAND_WAKEUP_BY_CANCEL
13 COMMAND_WAKEUP_BY_CANCELALL
14 COMMAND_WAKEUP_BY_POWER_BUTTON_CLICK
15 COMMAND_WAKEUP_TO_JUMP_HOME
16 COMMAND_REQUEST_FOR_SYS_APPLET
17 COMMAND_WAKEUP_TO_LAUNCH_APPLICATION
0x41 Unknown. Received by Home Menu during boot when the Home Menu process doesn't terminate properly(svcExitProcess/crash).

AppletPreparationState

Value Description
0 NO_PREPARATION
1 PREPARED_TO_LAUNCH_APP
2 PREPARED_TO_CLOSE_APP
3 PREPARED_TO_FORCE_TO_CLOSE_APP
4 PREPARED_TO_PRELOAD_APPLIB
5 PREPARED_TO_LAUNCH_APPLIB
6 PREPARED_TO_CLOSE_APPLIB
7 PREPARED_TO_LAUNCH_SYS
8 PREPARED_TO_CLOSE_SYS
9 PREPARED_TO_PRELOAD_SYSLIB
10 PREPARED_TO_LAUNCH_SYSLIB
11 PREPARED_TO_CLOSE_SYSLIB
12 PREPARED_TO_LAUNCH_RESIDENT
13 PREPARED_TO_LEAVE_RESIDENT
14 PREPARED_TO_DO_HOMEMENU
15 PREPARED_TO_LEAVE_HOMEMENU
16 PREPARED_TO_START_RESIDENT
17 PREPARED_TO_DO_APP_JUMP
18 PREPARED_TO_FORCE_TO_CLOSE_SYS
19 PREPARED_TO_LAUNCH_OTHER_SYS
20 PREPARED_TO_JUMP_TO_APP

StartupArgumentType

Value Description
0 STARTUP_ARGUMENT_TYPE_OTHER_APP
1 STARTUP_ARGUMENT_TYPE_RESTART
2 STARTUP_ARGUMENT_TYPE_OTHER_MEDIA

CaptureBufferInfo

Offset Size Description
0x0 0x4 u32, Size
0x4 0x1 u8, 3D (0 = not 3D, 1 = 3D)
0x5 0x3 Reserved
0x8 0x4 Main Screen Left Offset
0xC 0x4 Main Screen Right Offset
0x10 0x4 Main Screen DisplayBufferMode
0x14 0x4 Sub Screen Left Offset
0x18 0x4 Sub Screen Right Offset
0x1C 0x4 Sub Screen DisplayBufferMode

WirelessRebootInfo

Offset Size Description
0x0 0x6 Host MAC address.
0x6 0x9 WirelessRebootPassphrase
0xF 0x1 Uninitialized

This is setup by the dlplay system-application, before launching the DLP-child which can then use APT:GetWirelessRebootInfo. The MAC address and passphrase is used for connecting to the host by the DLP-child. See also here.

"APT:A" Service

This was added with 7.0.0-X. Official apps built with the CTRSDK for system-version >=7.0.0-X normally use the "APT:A" service instead of "APT:U". Those processes also have "APT:A" instead of "APT:U" in the service-access-control. Unlike APT:U, APT:A can call APT:GetAppletInfo with applet ID 0x300.

Applets

NS module does not verify that the input appID for the APT service cmds are correct for that type of command. For example, a process-launch of a SystemApplet via LibraryApplet commands works fine(minus the launched-process side of APT probably).

System Applets

On Old3DS there could only be one applet here(Home Menu, Internet Browser, Friend-List, etc) with programID-high 00040030 running at a time. On Old3DS when directly launching one of these 00040030 applets with Home Menu, the Home Menu process will terminate once the process is launched. On Old3DS when returning to Home Menu from that launched process, the Home Menu process is launched again.

On New3DS the Home Menu process is still running/in-memory, while another system-applet is running. On New3DS it appears that the Home Menu process is terminated+relaunched, when another system-applet terminated without exiting with APT properly.

Library Applets

Library applets can be launched by applications and regular applets. These library applets render to the screen(s) when running, etc. For example, this includes swkbd for text input. See the below appIDs in the 0x2XX range, the actual appID used is 0x4XX however.

Input data can be sent to the library applet via the NS parameter buffer, and/or with shared-memory with a shared-mem handle sent to the library applet. Output data from the library applet can be received by APT:ReceiveParameter, the library applet can also use the specified shared-mem for output too.

AppIDs

AppID Description
0x101 Home Menu (menu)
0x103 Alternate Menu
0x110 Camera applet (CtrApp)
0x112 Friends List applet (friend)
0x113 Game Notes applet (Cherry)
0x114 Internet Browser (spider/SKATER)
0x115 Instruction Manual applet
0x116 Notifications applet (newslist)
0x117 Miiverse applet (olv)
0x118 Miiverse posting applet (solv3)
0x119 Amiibo settings (cabinet)
0x201 Software Keyboard (swkbd) (?)
0x202 Mii Selector (appletEd) (?)
0x204 Photo Selector (PNOTE_AP) (?)
0x205 Sound Selector (SNOTE_AP) (?)
0x206 Error Display (error) (?)
0x207 eShop applet (mint) (?)
0x208 Circle Pad Pro Calibrator (extrapad) (?)
0x209 Notepad (memolib) (?)
0x300 Application
0x301 eShop (tiger)
0x401 Software Keyboard (swkbd)
0x402 Mii Selector (appletEd)
0x404 Photo Selector (PNOTE_AP)
0x405 Sound Selector (SNOTE_AP)
0x406 Error Display (error)
0x407 eShop applet (mint)
0x408 Circle Pad Pro Calibrator (extrapad)
0x409 Notepad (memolib)
0xF10 ProgramID: 0004003000008900.
0xF11 ProgramID: 000400000FFFFD00.
0xF12 ProgramID: 000400000FFFFC00.
0xF13 ProgramID: 000400000FFFFB00.
0xF14 ProgramID: 000400000FFFF900.
0xF15 ProgramID: 000400000FFFF800.
0xF16 ProgramID: 000400000FFFF700.
0xF17 ProgramID: 000400000FFFF600.
0xF18 ProgramID: 000400000FFFF500.

These AppIDs are all for NAND titles, except for 0x300. AppIDs in the 0x1XX range are applets(programID-high 00040030), and the AppIDs in the 0x2XX range are "system libraries"(programID-high 00040030). The 0xFXX AppID range is for development NAND applications, these are not available for retail.

Note that at some point the total AppID entry count was changed from 28 to 27.

Retrieved from "https://www.3dbrew.org/w/index.php?title=NS_and_APT_Services&oldid=22286"