Nintendo Switch Brew - User contributions [en]

Applet Manager services

2024-01-06T23:25:21Z

Liamwhite: Fixup

AM (Applet Manager) provides services for interacting with system applets while abstracting several aspects of power and operation management.

Contains multiple raw images, with at least the following: "NN_OMM_CHARGING_BIN_{begin|end}"(charging icon), low-battery icon, and the Nintendo Switch logo displayed during system boot.

= appletAE =
This is "nn::am::service::IAllSystemAppletProxiesService".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 100 || OpenSystemAppletProxy || Returns an [[#ISystemAppletProxy]].
|-
| 200 || OpenLibraryAppletProxyOld ([1.0.0-2.3.0] OpenLibraryAppletProxy) || Returns an [[#ILibraryAppletProxy]].
|-
| 201 || [3.0.0+] [[#OpenLibraryAppletProxy]] || Returns an [[#ILibraryAppletProxy]].
|-
| 300 || OpenOverlayAppletProxy || Returns an [[#IOverlayAppletProxy]].
|-
| 350 || OpenSystemApplicationProxy || Returns an [[#IApplicationProxy]].
|-
| 400 || [[#CreateSelfLibraryAppletCreatorForDevelop]] ||
|-
| 410 || [6.0.0+] [[#GetSystemAppletControllerForDebug]] ||
|-
| 1000 || [6.0.0+] [[#GetDebugFunctions]] ||
|}

All of these Open*Proxy commands except [[#OpenLibraryAppletProxy]] take the same input as [[#OpenApplicationProxy]], with the same user-process retry-loop as [[#OpenApplicationProxy]]. These Open*Proxy commands (including appletOE) doesn't seem to usable from processes which aren't actual applets (such as sysmodules), at least for applet-types which aren't already in use.

OpenLibraryAppletProxyOld eventually calls the same func as [[#OpenLibraryAppletProxy]], except that the [[#AppletAttribute]] is all-zero.

This service is used by all system non-regular-applications.

The 01000000000010XX system [[Title_list|titles]] use the following applet types(above Open{type}Proxy commands):
* "qlaunch": SystemApplet
* "overlay": OverlayApplet
* "starter": SystemApplication
* "maintenance": SystemApplet
* All others: LibraryApplet

== OpenLibraryAppletProxy ==
Returns an [[#ILibraryAppletProxy]].

Takes a [[IPC_Marshalling|reserved]] input u64(official user-processes use hard-coded value 0), a PID,a process copy-handle(cur-proc handle alias), and a type-0x15 input buffer containing an [[#AppletAttribute]].

Official user-processes use the same retry loop with this as the other Open*Proxy commands.

== CreateSelfLibraryAppletCreatorForDevelop ==
Takes a PID and an input u64 pid_placeholder, returns an [[#ILibraryAppletCreator]].

The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.

The cached value loaded from [[System_Settings|system-setting]] <code>am.debug!dev_function</code> must be set to 0x1 with size 0x1, otherwise an error is returned.

== GetSystemAppletControllerForDebug ==
No input, returns an [[#ISystemAppletControllerForDebug]].

The cached value loaded from [[System_Settings|system-setting]] <code>am.debug!dev_function</code> must be set to 0x1 with size 0x1, and various state checks must pass, otherwise 0 is returned with no output interface.

== GetDebugFunctions ==
No input, returns an [[#IDebugFunctions]].

The cached value loaded from [[System_Settings|system-setting]] <code>am.debug!dev_function</code> must be set to 0x1 with size 0x1, otherwise 0 is returned with no output interface.

== ISystemAppletProxy ==
This is "nn::am::service::ISystemAppletProxy".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || GetCommonStateGetter || Returns an [[#ICommonStateGetter]].
|-
| 1 || GetSelfController || Returns an [[#ISelfController]].
|-
| 2 || GetWindowController || Returns an [[#IWindowController]].
|-
| 3 || GetAudioController || Returns an [[#IAudioController]].
|-
| 4 || GetDisplayController || Returns an [[#IDisplayController]].
|-
| 10 || GetProcessWindingController || Returns an [[#IProcessWindingController]].
|-
| 11 || GetLibraryAppletCreator || Returns an [[#ILibraryAppletCreator]].
|-
| 20 || GetHomeMenuFunctions || Returns an [[#IHomeMenuFunctions]].
|-
| 21 || GetGlobalStateController || Returns an [[#IGlobalStateController]].
|-
| 22 || GetApplicationCreator || Returns an [[#IApplicationCreator]].
|-
| 23 || [7.0.0+] GetAppletCommonFunctions || Returns an [[#IAppletCommonFunctions]].
|-
| 1000 || GetDebugFunctions || Returns an [[#IDebugFunctions]].
|}

=== IHomeMenuFunctions ===
This is "nn::am::service::IHomeMenuFunctions".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 10 || [[#RequestToGetForeground]]
|-
| 11 || [[#LockForeground]]
|-
| 12 || [[#UnlockForeground]]
|-
| 20 || [[#PopFromGeneralChannel]]
|-
| 21 || [[#GetPopFromGeneralChannelEvent]]
|-
| 30 || [[#GetHomeButtonWriterLockAccessor]]
|-
| 31 || [2.0.0+] [[#GetWriterLockAccessorEx]]
|-
| 40 || [11.0.0+] [[#IsSleepEnabled]]
|-
| 41 || [12.0.0+] [[#IsRebootEnabled]]
|-
| 50 || [16.0.0+] [[#LaunchSystemApplet]]
|-
| 51 || [16.0.0+] [[#LaunchStarter]]
|-
| 100 || [6.0.0+] [[#PopRequestLaunchApplicationForDebug]]
|-
| 110 || [9.0.0+] [[#IsForceTerminateApplicationDisabledForDebug]]
|-
| 200 || [8.0.0+] [[#LaunchDevMenu]]
|-
| 1000 || [11.0.0+] [[#SetLastApplicationExitReason]]
|}

==== RequestToGetForeground ====
No input/output.

==== LockForeground ====
No input/output.

==== UnlockForeground ====
No input/output.

==== PopFromGeneralChannel ====
No input, returns an output [[#IStorage]].

==== GetPopFromGeneralChannelEvent ====
No input, returns an output Event handle with autoclear=false.

==== GetHomeButtonWriterLockAccessor ====
No input, returns an output [[#ILockAccessor]].

Similar to using [[#GetWriterLockAccessorEx]] with inval=0.

==== GetWriterLockAccessorEx ====
Takes an input u32, returns an output [[#ILockAccessor]].

The input value must be 0-3. 0 = HomeButton.

==== IsSleepEnabled ====
No input, returns an output bool.

==== IsRebootEnabled ====
No input, returns an output bool.

==== LaunchSystemApplet ====
No input/output.

This wraps [[NS_Services|ns]] LaunchSystemApplet, ignoring the u64 returned by that cmd (and other functionality).

==== LaunchStarter ====
No input/output.

This is similar to [[#LaunchSystemApplet]], except this uses [[NS_Services|ns]] LaunchLibraryApplet with a ProgramId from global state.

The global state field is initialized elsewhere with the value of [[System_Settings|system-setting]] <code>am.debug!starter_id</code>, defaulting to ProgramId 0100000000001012 ([[Title_list|starter]]) if not available.

==== PopRequestLaunchApplicationForDebug ====
Takes a type-0x6 output buffer containing an array of u128 userIDs, returns an output [[NCM_services#ApplicationId|ApplicationId]] and an output s32 '''total_userIDs'''.

The total entries in the userID buffer must be >= {total userIDs in state}.

==== IsForceTerminateApplicationDisabledForDebug ====
No input, returns an output u8 bool.

When the cached value loaded from [[Settings_services#GetDebugModeFlag]] is 0 this will just set the bool to 0. Otherwise, the bool is loaded using data from [[System_Settings|system-setting]] <code>am.debug!disable_force_terminate_application</code>.

==== LaunchDevMenu ====
No input/output.

The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.

Uses [[NS_Services|ns]] LaunchDevMenu.

This is used by [[qlaunch]]. On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.

==== SetLastApplicationExitReason ====
Takes an input s32, no output.

==== ILockAccessor ====
This is "nn::am::service::ILockAccessor".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 1 || [[#TryLock]]
|-
| 2 || [[#Unlock]]
|-
| 3 || [[#GetEvent]]
|-
| 4 || [10.0.0+] [[#IsLocked]]
|}

===== TryLock =====
Takes an input u8 bool flag, returns an output u8 bool flag and a handle.

Official sw waits on the previously loaded event from [[#GetEvent]]. The output flag indicates whether locking was successful, the user-process can try using this cmd again when flag=false.

Official sw only uses inflag=false. Official sw just closes the output handle. The input flag controls whether this returns the output handle.

===== Unlock =====
No input/output.

===== GetEvent =====
No input, returns an output Event handle with autoclear=false.

==== IsLocked ====
No input, returns an output u8 bool.

=== IGlobalStateController ===
This is "nn::am::service::IGlobalStateController".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#RequestToEnterSleep]]
|-
| 1 || [[#EnterSleep]]
|-
| 2 || [[#StartSleepSequence]]
|-
| 3 || [[#StartShutdownSequence]]
|-
| 4 || [[#StartRebootSequence]]
|-
| 9 || [7.0.0+] [[#IsAutoPowerDownRequested]]
|-
| 10 || [[#LoadAndApplyIdlePolicySettings]]
|-
| 11 || [2.0.0+] [[#NotifyCecSettingsChanged]]
|-
| 12 || [3.0.0+] [[#SetDefaultHomeButtonLongPressTime]]
|-
| 13 || [3.0.0+] [[#UpdateDefaultDisplayResolution]]
|-
| 14 || [3.0.0+] [[#ShouldSleepOnBoot]]
|-
| 15 || [4.0.0+] [[#GetHdcpAuthenticationFailedEvent]]
|-
| 30 || [12.0.0+] [[#OpenCradleFirmwareUpdater]]
|}

==== RequestToEnterSleep ====
No input/output.

Stubbed, just returns an error.

==== EnterSleep ====
No input/output.

Stubbed, just returns an error.

==== StartSleepSequence ====
Takes an input u8 bool, no output.

Official sw uses hard-coded input value = 1.

==== StartShutdownSequence ====
No input/output.

==== StartRebootSequence ====
No input/output.

==== IsAutoPowerDownRequested ====
No input, returns an output u8 bool.

Uses [[#idle:sys]] cmd1.

==== LoadAndApplyIdlePolicySettings ====
No input/output.

Uses [[#idle:sys]] cmd LoadAndApplySettings.

==== NotifyCecSettingsChanged ====
No input/output.

Uses [[#omm]] cmd NotifyCecSettingsChanged.

==== SetDefaultHomeButtonLongPressTime ====
Takes an input s64, no output.

==== UpdateDefaultDisplayResolution ====
No input/output.

Uses [[#omm]] cmd UpdateDefaultDisplayResolution.

==== ShouldSleepOnBoot ====
No input, returns an output u8 bool.

Uses [[#omm]] cmd ShouldSleepOnBoot.

==== GetHdcpAuthenticationFailedEvent ====
No input, returns an output Event handle with autoclear=false.

Uses [[#omm]] cmd GetHdcpAuthenticationFailedEvent.

==== OpenCradleFirmwareUpdater ====
No input, returns an [[#ICradleFirmwareUpdater]].

=== ICradleFirmwareUpdater ===
This is "nn::am::service::ICradleFirmwareUpdater".

This was added with [12.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || StartUpdate
|-
| 1 || FinishUpdate
|-
| 2 || [[#GetCradleDeviceInfo]]
|-
| 3 || GetCradleDeviceInfoChangeEvent
|-
| 4 || GetUpdateProgressInfo
|-
| 5 || GetLastInternalResult
|}

==== GetCradleDeviceInfo ====
No input, returns a 8-byte CradleDeviceInfo.

[13.0.0+] Now returns a total of 0xC-bytes.

=== IApplicationCreator ===
This is "nn::am::service::IApplicationCreator".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#CreateApplication]]
|-
| 1 || [[#PopLaunchRequestedApplication]]
|-
| 10 || [[#CreateSystemApplication]]
|-
| 100 || [[#PopFloatingApplicationForDevelopment]]
|}

[[#CreateApplication]]/[[#CreateSystemApplication]] eventually call the same internal func. With [[#CreateApplication]], two ptrs passed to the internal func are NULL, while with [[#CreateSystemApplication]] these are loaded from state. The initial content of [[#ApplicationLaunchRequestInfo]] is all-zero with [[#CreateSystemApplication]], while with [[#CreateApplication]] the first two u32s are value 0x3 with the rest all-zero. The [[#AppletId]] is set to 0x01 with [[#CreateApplication]], while with [[#CreateSystemApplication]] it's 0x04.

==== CreateApplication ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an [[#IApplicationAccessor]].

==== PopLaunchRequestedApplication ====
No input, returns an [[#IApplicationAccessor]].

==== CreateSystemApplication ====
Takes an input [[NCM_services#ApplicationId|SystemApplicationId]], returns an [[#IApplicationAccessor]].

[[qlaunch]] only uses this with a hard-coded id for the "starter" title.

==== PopFloatingApplicationForDevelopment ====
No input, returns an [[#IApplicationAccessor]].

Should not be used if no FloatingApplication is available (svcBreak).

==== IApplicationAccessor ====
This is "nn::am::service::IApplicationAccessor".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#GetAppletStateChangedEvent]] ||
|-
| 1 || [[#IsCompleted]] ||
|-
| 10 || [[#Start]] ||
|-
| 20 || [[#RequestExit]] ||
|-
| 25 || [[#Terminate]] ||
|-
| 30 || [[#GetResult]] ||
|-
| 101 || [[#RequestForApplicationToGetForeground]] ||
|-
| 110 || [[#TerminateAllLibraryApplets]] ||
|-
| 111 || [[#AreAnyLibraryAppletsLeft]] ||
|-
| 112 || [[#GetCurrentLibraryApplet]] ||
|-
| 120 || [[#GetApplicationId]] ||
|-
| 121 || [[#PushLaunchParameter]] ||
|-
| 122 || [[#GetApplicationControlProperty]] ||
|-
| 123 || [2.0.0+] [[#GetApplicationLaunchProperty]] ||
|-
| 124 || [6.0.0+] [[#GetApplicationLaunchRequestInfo]] ||
|-
| 130 || [6.0.0+] [[#SetUsers]] ||
|-
| 131 || [6.0.0+] [[#CheckRightsEnvironmentAvailable]] ||
|-
| 132 || [6.0.0+] [[#GetNsRightsEnvironmentHandle]] ||
|-
| 140 || [6.0.0+] [[#GetDesirableUids]] ||
|-
| 150 || [6.0.0+] [[#ReportApplicationExitTimeout]] ||
|-
| 160 || [8.0.0+] [[#SetApplicationAttribute]] ||
|-
| 170 || [8.0.0+] [[#HasSaveDataAccessPermission]] ||
|-
| 180 || [9.0.0+] [[#PushToFriendInvitationStorageChannel]] ||
|-
| 190 || [9.0.0+] [[#PushToNotificationStorageChannel]] ||
|-
| 200 || [10.0.0+] [[#RequestApplicationSoftReset]] ||
|-
| 201 || [10.0.0+] [[#RestartApplicationTimer]] ||
|}

Commands <=30 are inherited from [[#IAppletAccessor]].

===== RequestForApplicationToGetForeground =====
No input/output.

===== GetCurrentLibraryApplet =====
No input, returns an output [[#IAppletAccessor]].

===== GetApplicationId =====
No input, returns an output [[NCM_services#ApplicationId|ApplicationId]].

===== PushLaunchParameter =====
Takes an input u32 [[#LaunchParameterKind]] and an input [[#IStorage]], no output.

===== GetApplicationControlProperty =====
No input, takes a type-0x6 output buffer.

The output buffer must be at least 0x4000-bytes. Returns an error when the [[#AppletId]] is 0x04, aka when the IApplicationAccessor is for a SystemApplication.

This gets the application [[NACP_Format|control.nacp]].

===== GetApplicationLaunchProperty =====
Takes a type-0x6 output buffer.

The output buffer size must be at least 0x10-bytes. Returns an error when the [[#AppletId]] is 0x04, aka when the IApplicationAccessor is for a SystemApplication.

This gets the [[#ApplicationLaunchProperty]].

===== GetApplicationLaunchRequestInfo =====
No input, returns an output 0x10-byte struct.

This gets the [[#ApplicationLaunchRequestInfo]] from state. The output struct is "nn::applet::ApplicationLaunchRequestInfo".

===== SetUsers =====
Takes an input u8 bool flag and a type-0x5 input buffer containing an array of u128 userIDs.

The total entries for the userIDs must be <=8.

When the input flag is true, this just clears the '''users_available''' state flag to 0 and returns.

===== CheckRightsEnvironmentAvailable =====
No input, returns an output u8 bool.

===== GetNsRightsEnvironmentHandle =====
No input, returns an output u64.

===== GetDesirableUids =====
Takes a type-0x6 output buffer containing an array of u128 userIDs, returns an output s32 '''total_entries'''.

Gets a userID listing, this is unrelated to [[#SetUsers]]. [[qlaunch]] only uses 1 userID with this.

The stored entry-count in state must be <= <size of output buffer in entries>.

===== ReportApplicationExitTimeout =====
No input/output.

===== SetApplicationAttribute =====
Takes a type-0x15 input buffer containing an [[#ApplicationAttribute]], no output.

===== HasSaveDataAccessPermission =====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output u8 bool flag.

Gets whether the savedata specified by the input ApplicationId is accessible. The output flag indicates whether it's accessible.

If the ApplicationId matches the current application, this immediately returns success with flag=1.

===== PushToFriendInvitationStorageChannel =====
Takes an input [[#IStorage]], no output.

Clears the FriendInvitation StorageChannel, then pushes the input storage there.

===== PushToNotificationStorageChannel =====
Takes an input [[#IStorage]], no output.

Clears the Notification StorageChannel, then pushes the input storage there.

[[qlaunch]] will only push data for this when launching the Application when the Alarm was triggered, where the system was previously in sleep-mode. This data is the [[Glue_services|Notification]] ApplicationParameter.

===== RequestApplicationSoftReset =====
No input/output.

===== RestartApplicationTimer =====
No input/output.

===== IAppletAccessor =====
This is "nn::am::service::IAppletAccessor".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#GetAppletStateChangedEvent]]
|-
| 1 || [[#IsCompleted]]
|-
| 10 || [[#Start]]
|-
| 20 || [[#RequestExit]]
|-
| 25 || [[#Terminate]]
|-
| 30 || [[#GetResult]]
|}

==== GetAppletStateChangedEvent ====
No input, returns an output event handle with autoclear=false.

==== IsCompleted ====
No input, returns an output u8 bool.

==== Start ====
No input/output.

==== RequestExit ====
No input/output.

==== Terminate ====
No input/output.

==== GetResult====
No input/output.

== IAppletCommonFunctions ==
This is "nn::am::service::IAppletCommonFunctions".

This was added with [7.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [9.0.0+] [[#SetTerminateResult]]
|-
| 10 || [[#ReadThemeStorage]]
|-
| 11 || [[#WriteThemeStorage]]
|-
| 20 || [9.0.0+] [[#PushToAppletBoundChannel]]
|-
| 21 || [9.0.0+] [[#TryPopFromAppletBoundChannel]]
|-
| 40 || [8.0.0+] [[#GetDisplayLogicalResolution]]
|-
| 42 || [8.0.0+] [[#SetDisplayMagnification]]
|-
| 50 || [8.0.0+] [[#SetHomeButtonDoubleClickEnabled]]
|-
| 51 || [8.0.0+] [[#GetHomeButtonDoubleClickEnabled]]
|-
| 52 || [10.0.0+] [[#IsHomeButtonShortPressedBlocked]]
|-
| 60 || [11.0.0+] [[#IsVrModeCurtainRequired]]
|-
| 61 || [12.0.0+] IsSleepRequiredByHighTemperature
|-
| 62 || [12.0.0+] IsSleepRequiredByLowBattery
|-
| 70 || [11.0.0+] [[#SetCpuBoostRequestPriority]]
|-
| 80 || [14.0.0+] SetHandlingCaptureButtonShortPressedMessageEnabledForApplet
|-
| 81 || [14.0.0+] SetHandlingCaptureButtonLongPressedMessageEnabledForApplet
|-
| 90 || [15.0.0+] OpenNamedChannelAsParent
|-
| 91 || [15.0.0+] OpenNamedChannelAsChild
|-
| 100 || [15.0.0+] SetApplicationCoreUsageMode
|-
| 300 || [17.0.0+]
|}

ReadThemeStorage/WriteThemeStorage: these commands copy data from/to a state buffer and the user specified buffer. The size of the state buffer is 0x400-bytes. The default content of the ThemeStorage prior to using the WriteThemeStorage cmd, is: <code>memset(statebuf, 0xAA, 0x400);</code>

=== ReadThemeStorage ===
Takes an input u64 '''offset''' and a type-0x22 output buffer, returns an output u64 '''actual_transfer_size'''.

=== WriteThemeStorage ===
Takes an input u64 '''offset''' and a type-0x21 input buffer, no output.

=== PushToAppletBoundChannel ===
Takes an input [[#IStorage]], no output.

This is similar to [[#PushToAppletBoundChannelForDebug]] (no DebugMode check), except the used s32 is loaded from elsewhere and must be in the range 31-32.

=== TryPopFromAppletBoundChannel ===
No input, returns an output [[#IStorage]].

This is similar to [[#TryPopFromAppletBoundChannelForDebug]] (no DebugMode check), except the used s32 is loaded from elsewhere and must be in the range 31-32.

=== GetDisplayLogicalResolution ===
No input, returns an output s32 '''width''' and s32 '''height'''.

=== SetDisplayMagnification ===
Takes an input float '''x''', float '''y''', float '''width''', and float '''height''', no output.

Sets the DisplayMagnification. This is essentially layer image crop, for everything non-Overlay.

'''x''' and '''width''' are multiplied with the same width value returned by [[#GetDisplayLogicalResolution]], so these should be in the range 0.0f-1.0f. Likewise for y and height, except these are multipled with the height value.

=== SetHomeButtonDoubleClickEnabled ===
Takes an input u8 bool, no output.

=== GetHomeButtonDoubleClickEnabled ===
No input, returns an output u8 bool.

=== IsHomeButtonShortPressedBlocked ===
No input, returns an output u8 bool.

=== IsVrModeCurtainRequired ===
No input, returns an output bool.

=== SetCpuBoostRequestPriority ===
Takes an input s32, no output.

== ILibraryAppletProxy ==
This is "nn::am::service::ILibraryAppletProxy".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || GetCommonStateGetter || Returns an [[#ICommonStateGetter]].
|-
| 1 || GetSelfController || Returns an [[#ISelfController]].
|-
| 2 || GetWindowController || Returns an [[#IWindowController]].
|-
| 3 || GetAudioController || Returns an [[#IAudioController]].
|-
| 4 || GetDisplayController || Returns an [[#IDisplayController]].
|-
| 10 || GetProcessWindingController || Returns an [[#IProcessWindingController]].
|-
| 11 || GetLibraryAppletCreator || Returns an [[#ILibraryAppletCreator]].
|-
| 20 || OpenLibraryAppletSelfAccessor || Returns an [[#ILibraryAppletSelfAccessor]].
|-
| 21 || [7.0.0+] GetAppletCommonFunctions || No input, returns an [[#IAppletCommonFunctions]].
|-
| 22 || [15.0.0+] GetHomeMenuFunctions || No input, returns an [[#IHomeMenuFunctions]].
|-
| 23 || [15.0.0+] GetGlobalStateController || No input, returns an [[#IGlobalStateController]].
|-
| 1000 || GetDebugFunctions || Returns an [[#IDebugFunctions]].
|}

=== ILibraryAppletSelfAccessor ===
This is "nn::am::service::ILibraryAppletSelfAccessor".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#PopInData]] ||
|-
| 1 || [[#PushOutData]] ||
|-
| 2 || [[#PopInteractiveInData]] ||
|-
| 3 || [[#PushInteractiveOutData]] ||
|-
| 5 || [[#GetPopInDataEvent]] ||
|-
| 6 || [[#GetPopInteractiveInDataEvent]] ||
|-
| 10 || [[#ExitProcessAndReturn]] ||
|-
| 11 || [[#GetLibraryAppletInfo]] ||
|-
| 12 || [[#GetMainAppletIdentityInfo]] ||
|-
| 13 || [[#CanUseApplicationCore]] ||
|-
| 14 || [[#GetCallerAppletIdentityInfo]] ||
|-
| 15 || [2.0.0+] [[#GetMainAppletApplicationControlProperty]] ||
|-
| 16 || [2.0.0+] [[#GetMainAppletStorageId]] ||
|-
| 17 || [3.0.0+] [[#GetCallerAppletIdentityInfoStack]] ||
|-
| 18 || [4.0.0+] [[#GetNextReturnDestinationAppletIdentityInfo]] ||
|-
| 19 || [4.0.0+] [[#GetDesirableKeyboardLayout]] ||
|-
| 20 || [[#PopExtraStorage]] ||
|-
| 25 || [[#GetPopExtraStorageEvent]] ||
|-
| 30 || [[#UnpopInData]] ||
|-
| 31 || [[#UnpopExtraStorage]] ||
|-
| 40 || [2.0.0+] [[#GetIndirectLayerProducerHandle]] ||
|-
| 50 || [3.0.0+] [[#ReportVisibleError]] ||
|-
| 51 || [4.0.0+] [[#ReportVisibleErrorWithErrorContext]] ||
|-
| 60 || [4.0.0+] [[#GetMainAppletApplicationDesiredLanguage]] ||
|-
| 70 || [8.0.0+] [[#GetCurrentApplicationId]] ||
|-
| 80 || [6.0.0+] [[#RequestExitToSelf]] ||
|-
| 90 || [5.0.0+] [[#CreateApplicationAndPushAndRequestToLaunch]] ||
|-
| 100 || [4.0.0+] [[#CreateGameMovieTrimmer]] ||
|-
| 101 || [5.0.0+] [[#ReserveResourceForMovieOperation]] ||
|-
| 102 || [5.0.0+] [[#UnreserveResourceForMovieOperation]] ||
|-
| 110 || [6.0.0+] [[#GetMainAppletAvailableUsers]] ||
|-
| 120 || [9.0.0+] [[#GetLaunchStorageInfoForDebug]] ||
|-
| 130 || [9.0.0+] [[#GetGpuErrorDetectedSystemEvent]] ||
|-
| 140 || [10.0.0+] [[#SetApplicationMemoryReservation]] ||
|-
| 150 || [10.0.0+] [[#ShouldSetGpuTimeSliceManually]] ||
|-
| 160 || [17.0.0+] [[#Cmd160]] ||
|}

==== PopInData ====
No input, returns an output [[#IStorage]].

==== PushOutData ====
Takes an input [[#IStorage]], no output.

==== PopInteractiveInData ====
No input, returns an output [[#IStorage]].

==== PushInteractiveOutData ====
Takes an input [[#IStorage]], no output.

==== GetPopInDataEvent ====
No input, returns an output Event handle with autoclear=false.

==== GetPopInteractiveInDataEvent ====
No input, returns an output Event handle with autoclear=false.

==== ExitProcessAndReturn ====
No input/output.

Exits the LibraryApplet and returns to running the title which launched this LibraryApplet ([[qlaunch]] for example).

On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.

==== GetLibraryAppletInfo ====
No input, returns an output [[#LibraryAppletInfo]].

==== GetMainAppletIdentityInfo ====
No input, returns an output [[#AppletIdentityInfo]].

==== CanUseApplicationCore ====
No input, returns an output u8 bool.

==== GetCallerAppletIdentityInfo ====
No input, returns an output [[#AppletIdentityInfo]].

==== GetMainAppletApplicationControlProperty ====
No input, takes a type-0x16 output buffer.

This gets the [[NACP_Format|control.nacp]].

==== GetMainAppletStorageId ====
No input, returns an output u8 storageId.

==== GetCallerAppletIdentityInfoStack ====
Takes a type-0x6 output buffer containing an array of [[#AppletIdentityInfo]], and returns an output s32 total_entries.

==== GetNextReturnDestinationAppletIdentityInfo ====
No input, returns an output [[#AppletIdentityInfo]].

==== GetDesirableKeyboardLayout ====
No input, returns an output u32.

The output u32 is "nn::settings::KeyboardLayout".

This gets the value previously set by [[#SetDesirableKeyboardLayout]]. An error is returned if it's not set.

==== PopExtraStorage ====
No input, returns an output [[#IStorage]].

==== GetPopExtraStorageEvent ====
No input, returns an output Event handle with autoclear=false.

==== UnpopInData ====
Takes an input [[#IStorage]], no output.

==== UnpopExtraStorage ====
Takes an input [[#IStorage]], no output.

==== GetIndirectLayerProducerHandle ====
No input, returns an output u64.

==== ReportVisibleError ====
Takes an input [[Error_Applet#ErrorCode|ErrorCode]], no output.

==== ReportVisibleErrorWithErrorContext ====
Takes an input [[Error_Applet#ErrorCode|ErrorCode]] and a type-0x15 input buffer containing an [[Error_Applet#ErrorContext|ErrorContext]], no output.

==== GetMainAppletApplicationDesiredLanguage ====
No input, returns an output [[Settings_services#LanguageCode|LanguageCode]].

==== GetCurrentApplicationId ====
No input, returns an output [[NCM_services#ApplicationId|ApplicationId]].

Gets the [[NCM_services#ApplicationId|ApplicationId]] for the currently running Application. ApplicationId=0 when no Application is running.

==== RequestExitToSelf ====
No input/output.

Same as [[#RequestExit]] except this is for the current applet.

==== CreateApplicationAndPushAndRequestToLaunch ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]] and an input #IStorage, no output.

This is is similar to [[#CreateApplicationAndPushAndRequestToStart]].

==== CreateGameMovieTrimmer ====
Takes an input u64 size and a TransferMemory handle, returns a GRC [[GRC_services#IGameMovieTrimmer|IGameMovieTrimmer]].

This is a wrapper for GRC [[GRC_services#OpenGameMovieTrimmer|OpenGameMovieTrimmer]].

Official sw uses an user-buffer for the tmem, with permissions=0.

==== ReserveResourceForMovieOperation ====
No input/output.

Updates state fields. This must be used before [[#CreateGameMovieTrimmer]].

==== UnreserveResourceForMovieOperation ====
No input/output.

Updates state fields. This must be used once finished with [[GRC_services#IGameMovieTrimmer|IGameMovieTrimmer]].

==== GetMainAppletAvailableUsers ====
Takes a type-0x6 output buffer containing an array of u128 userIDs, returns an output u8 bool and a s32 '''total_entries'''.

This gets the userIDs previously set by [[#SetUsers]].

The size of the output buffer in entries must be at least 8.

Normally the output bool is set to 0, however when no users are available it's set to 1 with '''total_entries''' = -1.

==== SetApplicationMemoryReservation ====
Takes an input u64, no output.

An Application must be currently running. The input u64 must be 0x1000-byte aligned.

==== ShouldSetGpuTimeSliceManually ====
No input, returns an output u8 bool.

==== Cmd160 ====
No input, returns an output u64. Currently always returns 0.

== IOverlayAppletProxy ==
This is "nn::am::service::IOverlayAppletProxy".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || GetCommonStateGetter || Returns an [[#ICommonStateGetter]].
|-
| 1 || GetSelfController || Returns an [[#ISelfController]].
|-
| 2 || GetWindowController || Returns an [[#IWindowController]].
|-
| 3 || GetAudioController || Returns an [[#IAudioController]].
|-
| 4 || GetDisplayController || Returns an [[#IDisplayController]].
|-
| 10 || GetProcessWindingController || Returns an [[#IProcessWindingController]].
|-
| 11 || GetLibraryAppletCreator || Returns an [[#ILibraryAppletCreator]].
|-
| 20 || GetOverlayFunctions || Returns an [[#IOverlayFunctions]].
|-
| 21 || [7.0.0+] GetAppletCommonFunctions || No input, returns an [[#IAppletCommonFunctions]].
|-
| 23 || [15.0.0+] GetGlobalStateController || No input, returns an [[#IGlobalStateController]].
|-
| 1000 || GetDebugFunctions || Returns an [[#IDebugFunctions]].
|}

=== IOverlayFunctions ===
This is "nn::am::service::IOverlayFunctions".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#BeginToWatchShortHomeButtonMessage]]
|-
| 1 || [[#EndToWatchShortHomeButtonMessage]]
|-
| 2 || [[#GetApplicationIdForLogo]]
|-
| 3 || [[#SetGpuTimeSliceBoost]]
|-
| 4 || [2.0.0+] [[#SetAutoSleepTimeAndDimmingTimeEnabled]]
|-
| 5 || [2.0.0+] [[#TerminateApplicationAndSetReason]]
|-
| 6 || [3.0.0+] [[#SetScreenShotPermissionGlobally]]
|-
| 10 || [6.0.0+] [[#StartShutdownSequenceForOverlay]]
|-
| 11 || [6.0.0+] [[#StartRebootSequenceForOverlay]]
|-
| 20 || [8.0.0+] [[#SetHandlingHomeButtonShortPressedEnabled]]
|-
| 21 || [14.0.0+] SetHandlingTouchScreenInputEnabled
|-
| 30 || [9.0.0+] [[#SetHealthWarningShowingState]]
|-
| 31 || [10.0.0+] [[#IsHealthWarningRequired]]
|-
| 90 || [7.0.0+] [[#SetRequiresGpuResourceUse]]
|-
| 101 || [5.0.0+] [[#BeginToObserveHidInputForDevelop]]
|}

==== BeginToWatchShortHomeButtonMessage ====
No input/output.

==== EndToWatchShortHomeButtonMessage ====
No input/output.

==== GetApplicationIdForLogo ====
No input, returns an output [[NCM_services#ApplicationId|ApplicationId]].

Gets the ApplicationId for displaying the logo screen during application launch.

When no application is running, this returns success with ApplicationId=0.

==== SetGpuTimeSliceBoost ====
Takes an input u64, no output.

==== SetAutoSleepTimeAndDimmingTimeEnabled ====
Takes an input u8 bool, no output.

==== TerminateApplicationAndSetReason ====
Takes an input u32 Result, no output.

==== SetScreenShotPermissionGlobally ====
Takes an input u8 bool, no output.

==== StartShutdownSequenceForOverlay ====
No input/output.

On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.

==== StartRebootSequenceForOverlay ====
No input/output.

On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.

==== SetHandlingHomeButtonShortPressedEnabled ====
Takes an input u8 bool, no output.

==== SetHealthWarningShowingState ====
Takes an input u8 bool, no output.

This writes the input bool into state, signals an Event, and returns 0.

==== IsHealthWarningRequired ====
No input, returns an output u8 bool.

==== SetRequiresGpuResourceUse ====
Takes an input u8 bool, no output.

Just returns 0.

==== BeginToObserveHidInputForDevelop ====
No input/output.

Sets various state fields and signals an userspace-event.

Enables HID input for the OverlayApplet, without disabling input for the foreground applet.

== IApplicationProxy ==
This is "nn::am::service::IApplicationProxy".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || GetCommonStateGetter || Returns an [[#ICommonStateGetter]].
|-
| 1 || GetSelfController || Returns an [[#ISelfController]].
|-
| 2 || GetWindowController || Returns an [[#IWindowController]].
|-
| 3 || GetAudioController || Returns an [[#IAudioController]].
|-
| 4 || GetDisplayController || Returns an [[#IDisplayController]].
|-
| 10 || GetProcessWindingController || Returns an [[#IProcessWindingController]].
|-
| 11 || GetLibraryAppletCreator || Returns an [[#ILibraryAppletCreator]].
|-
| 20 || GetApplicationFunctions || Returns an [[#IApplicationFunctions]].
|-
| 1000 || GetDebugFunctions || Returns an [[#IDebugFunctions]].
|}

=== IApplicationFunctions ===
This is "nn::am::service::IApplicationFunctions".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 1 || [[#PopLaunchParameter]]
|-
| 10 || [[#CreateApplicationAndPushAndRequestToStart]]
|-
| 11 || [3.0.0+] [[#CreateApplicationAndPushAndRequestToStartForQuest]]
|-
| 12 || [4.0.0+] [[#CreateApplicationAndRequestToStart]]
|-
| 13 || [4.0.0+] [[#CreateApplicationAndRequestToStartForQuest]]
|-
| 14 || [7.0.0+] [[#CreateApplicationWithAttributeAndPushAndRequestToStartForQuest]]
|-
| 15 || [7.0.0+] [[#CreateApplicationWithAttributeAndRequestToStartForQuest]]
|-
| 20 || [[#EnsureSaveData]]
|-
| 21 || [[#GetDesiredLanguage]]
|-
| 22 || [[#SetTerminateResult]]
|-
| 23 || [[#GetDisplayVersion]]
|-
| 24 || [2.0.0+] [[#GetLaunchStorageInfoForDebug]]
|-
| 25 || [3.0.0+] ExtendSaveData
|-
| 26 || [3.0.0+] GetSaveDataSize
|-
| 27 || [5.0.0+] CreateCacheStorage
|-
| 28 || [11.0.0+] [[#GetSaveDataSizeMax]]
|-
| 29 || [11.0.0+] [[#GetCacheStorageMax]]
|-
| 30 || [[#BeginBlockingHomeButtonShortAndLongPressed]]
|-
| 31 || [[#EndBlockingHomeButtonShortAndLongPressed]]
|-
| 32 || [[#BeginBlockingHomeButton]]
|-
| 33 || [[#EndBlockingHomeButton]]
|-
| 34 || [10.0.0-15.0.1] [[#SelectApplicationLicense]]
|-
| 35 || [11.0.0+] [[#GetDeviceSaveDataSizeMax]]
|-
| 36 || [14.0.0+] GetLimitedApplicationLicense
|-
| 37 || [14.0.0+] GetLimitedApplicationLicenseUpgradableEvent
|-
| 40 || [[#NotifyRunning]]
|-
| 50 || [2.0.0+] [[#GetPseudoDeviceId]]
|-
| 60 || [2.0.0+] [[#SetMediaPlaybackStateForApplication]]
|-
| 65 || [3.0.0+] [[#IsGamePlayRecordingSupported]]
|-
| 66 || [3.0.0+] [[#InitializeGamePlayRecording]]
|-
| 67 || [3.0.0+] [[#SetGamePlayRecordingState]]
|-
| 68 || [4.0.0+] [[#RequestFlushGamePlayingMovieForDebug]]
|-
| 70 || [3.0.0+] [[#RequestToShutdown]]
|-
| 71 || [3.0.0+] [[#RequestToReboot]]
|-
| 72 || [10.0.0+] [[#RequestToSleep]]
|-
| 80 || [4.0.0+] [[#ExitAndRequestToShowThanksMessage]]
|-
| 90 || [4.0.0+] [[#EnableApplicationCrashReport]]
|-
| 100 || [5.0.0+] [[#InitializeApplicationCopyrightFrameBuffer]]
|-
| 101 || [5.0.0+] [[#SetApplicationCopyrightImage]]
|-
| 102 || [5.0.0+] [[#SetApplicationCopyrightVisibility]]
|-
| 110 || [5.0.0+] [[#QueryApplicationPlayStatistics]]
|-
| 111 || [6.0.0+] [[#QueryApplicationPlayStatisticsByUid]]
|-
| 120 || [5.0.0+] [[#ExecuteProgram]]
|-
| 121 || [5.0.0+] [[#ClearUserChannel]]
|-
| 122 || [5.0.0+] [[#UnpopToUserChannel]]
|-
| 123 || [5.0.0+] [[#GetPreviousProgramIndex]]
|-
| 124 || [6.0.0+] [[#EnableApplicationAllThreadDumpOnCrash]]
|-
| 130 || [8.0.0+] [[#GetGpuErrorDetectedSystemEvent]]
|-
| 131 || [11.0.0+] [[#SetDelayTimeToAbortOnGpuError]]
|-
| 140 || [9.0.0+] [[#GetFriendInvitationStorageChannelEvent]]
|-
| 141 || [9.0.0+] [[#TryPopFromFriendInvitationStorageChannel]]
|-
| 150 || [9.0.0+] [[#GetNotificationStorageChannelEvent]]
|-
| 151 || [9.0.0+] [[#TryPopFromNotificationStorageChannel]]
|-
| 160 || [9.0.0+] [[#GetHealthWarningDisappearedSystemEvent]]
|-
| 170 || [9.0.0+] [[#SetHdcpAuthenticationActivated]]
|-
| 180 || [10.1.0+] [[#GetLaunchRequiredVersion]]
|-
| 181 || [10.1.0+] [[#UpgradeLaunchRequiredVersion]]
|-
| 190 || [11.0.0+] [[#SendServerMaintenanceOverlayNotification]]
|-
| 200 || [11.0.0+] [[#GetLastApplicationExitReason]]
|-
| 500 || [5.0.0+] [[#StartContinuousRecordingFlushForDebug]]
|-
| 1000 || [5.0.0+] [[#CreateMovieMaker]]
|-
| 1001 || [5.0.0+] [[#PrepareForJit]]
|}

The BOTW game uses this GamePlayRecording functionality from the main-nso "nninitStartup" function, with size 0x6000000(96MiB). The official GamePlayRecording-enable code does the following(this will panic on any failure):
* [[SVC|Creates]] TransferMemory using the input buffer and size, with permissions=0.
* Uses [[#InitializeGamePlayRecording]] with the TransferMemory.
* Closes the TransferMemory handle, + TransferMemory cleanup.
* Uses [[#SetGamePlayRecordingState]] with value 0x1.
This GamePlayRecording functionality presumably enables the video-recording usable starting with [[4.0.0]].

==== PopLaunchParameter ====
Takes an input u32 [[#LaunchParameterKind]], returns an output [[#IStorage]].

Pops a LaunchParameter [[#IStorage]], the storage will be removed from sysmodule state during this.

==== CreateApplicationAndPushAndRequestToStart ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]] and an input [[#IStorage]], no output. ApplicationId=0 can be used to relaunch the current application.

==== CreateApplicationAndPushAndRequestToStartForQuest ====
Takes 2 input u32s (loaded from struct [[#ApplicationAttributeForQuest]]), an input [[NCM_services#ApplicationId|ApplicationId]], and an input [[#IStorage]], no output.

==== CreateApplicationAndRequestToStart ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output.

Same as [[#CreateApplicationAndPushAndRequestToStart]] except without the input storage, official sw uses this when no input storage is specified.

==== CreateApplicationAndRequestToStartForQuest ====
Takes 2 input u32s (loaded from struct [[#ApplicationAttributeForQuest]]) and an input [[NCM_services#ApplicationId|ApplicationId]], no output.

Same as [[#CreateApplicationAndPushAndRequestToStartForQuest]] except without the input storage, official sw uses this when no input storage is specified.

==== CreateApplicationWithAttributeAndPushAndRequestToStartForQuest ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], a type-0x15 input buffer containing an [[#ApplicationAttribute]], an input [[#IStorage]], no output.

Same as [[#CreateApplicationAndPushAndRequestToStartForQuest]] except the entire attributes structure is directly specified via the input buffer. This command replaces [[#CreateApplicationAndPushAndRequestToStartForQuest]], official user-processes no longer use [[#CreateApplicationAndPushAndRequestToStartForQuest]].

==== CreateApplicationWithAttributeAndRequestToStartForQuest ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]] and a type-0x15 input buffer containing an [[#ApplicationAttribute]], no output.

Same as [[#CreateApplicationAndRequestToStartForQuest]] except the entire attributes structure is directly specified via the input buffer. This command replaces [[#CreateApplicationAndRequestToStartForQuest]], official user-processes no longer use [[#CreateApplicationAndPushAndRequestToStartForQuest]].

==== EnsureSaveData ====
Takes an input u128 userID, returns an output u64 size.

Calls sdk func <code>nn::fs::EnsureApplicationSaveData</code>. [[qlaunch]] also calls this same sdk func directly.

Creates the various savedata as specified by the application [[NACP_Format|control.nacp]] when the savedata doesn't exist.

Official user-processes launch the dataErase LibraryApplet depending on the Result, the above output size is used with this.

==== GetDesiredLanguage ====
No input, returns an output [[Settings_services#LanguageCode|LanguageCode]].

==== SetTerminateResult ====
Takes an input u32 '''Result''', no output.

For example, in some cases official apps use this with [[Error_codes|error]] 0x2A2 then uses svcBreak.

==== GetDisplayVersion ====
No input, returns an output 0x10-byte struct.

The output struct is "nn::oe::DisplayVersion". This the DisplayVersion string copied from the application [[NACP_Format|control.nacp]], this is always NUL-terminated.

==== GetLaunchStorageInfoForDebug ====
No input, returns an output u8 [[Filesystem_services#StorageId|StorageId]] and u8 [[Filesystem_services#StorageId|StorageId]].

This returns two u8s loaded from state, these are the same StorageIds from [[#ApplicationLaunchProperty]].

==== GetSaveDataSizeMax ====
No input, returns two ouput s64s.

==== GetCacheStorageMax ====
No input, returns an output s32 and s64.

==== BeginBlockingHomeButtonShortAndLongPressed ====
Takes an input s64, no output.

Official user-processes use hard-coded value 0 for the s64.

Starts blocking the Home button.

==== EndBlockingHomeButtonShortAndLongPressed ====
No input/output.

Ends the blocking started by [[#BeginBlockingHomeButtonShortAndLongPressed]].

==== BeginBlockingHomeButton ====
Takes an input s64 nanoseconds, no output. The input nanoseconds can be zero.

==== EndBlockingHomeButton ====
No input/output.

==== SelectApplicationLicense ====
Takes an input array of [[#ApplicationLicenseType]], returns an output [[#ApplicationLicenseType]].

==== GetDeviceSaveDataSizeMax ====
No input, returns two output s64s.

==== NotifyRunning ====
Takes no input. Returns an output u8 bool, which is ignored by official user-processes.

==== GetPseudoDeviceId ====
No input, returns an output 0x10-byte "nn::util::Uuid" struct.

The 0x20-byte output data from [[NS_Services|GetSystemSeedForPseudoDeviceId]] followed by the 8-byte [[NACP_Format|SeedForPseudoDeviceId]] from the current control.nacp, is hashed with SHA1. Then "nn::util::GenerateUuidVersion5" is called with the final hash, the output from this is then returned for the Uuid.

==== SetMediaPlaybackStateForApplication ====
Takes an input u8 bool, no output.

==== IsGamePlayRecordingSupported ====
No input, returns an output u8 bool.

==== InitializeGamePlayRecording ====
Takes a TransferMemory handle and an u64 for the size of the TransferMemory. The size must match 0x6000000 otherwise an error is returned.

==== SetGamePlayRecordingState ====
Takes an input u32. 0 = disable/pause, 1 = enable/restart.

==== RequestFlushGamePlayingMovieForDebug ====
No input/output.

Requests to save the video recording, as if the Capture-button was held.

==== RequestToShutdown ====
No input/output.

On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.

==== RequestToReboot ====
No input/output.

On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.

==== RequestToSleep ====
No input/output.

==== ExitAndRequestToShowThanksMessage ====
No input/output.

Used to exit the application and return to the kiosk menu. Official sw uses [[#UnlockExit]] immediately before this if needed.

On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.

This throws an error when the cached [[Settings_services#GetQuestFlag]] value is 0.

==== EnableApplicationCrashReport ====
Takes an input u8 bool, no output.

==== InitializeApplicationCopyrightFrameBuffer ====
Takes an input TransferMemory handle, an s32 '''width''', an s32 '''height''', an u64 tmem_size, and no output.

tmem_size must be 0x40000-byte aligned. '''width''' must be 1-1280, and '''height''' must be 1-720.

User-processes create the tmem with an user-specified buffer with permissions=0. '''width''' = 1280 and '''height''' = 720.

After the validation checks pass the input is passed to [[OMM_services|ommdisp]] cmd500.

This is used as an overlay for screenshots.

==== SetApplicationCopyrightImage ====
Takes a type-0x45 input buffer, an s32 '''x''', an s32 '''y''', an s32 '''width''', an s32 '''height''', an s32 [[#WindowOriginMode]], and no output.

'''x''' and '''y''' must not have the negative bit set. '''width''' and '''height''' must not be <1.

Sets the RGBA8 image for use with [[#InitializeApplicationCopyrightFrameBuffer]]. Overrides the current image, if this was already used previously.

==== SetApplicationCopyrightVisibility ====
Takes an input u8 bool, no output.

Sets the visibility for the image set by [[#SetApplicationCopyrightImage]], in screenshots. By default it's visible.

==== QueryApplicationPlayStatistics ====
Takes a type-0x6 output buffer containing an array of [[Shared_Database_services|ApplicationPlayStatistics]] and a type-0x5 input buffer containing an array of [[NCM_services#ApplicationId|ApplicationId]]. Returns an output s32 for actual total output entries.

The number of entries in each array is the same.

See also [[NACP_Format#PlayLogQueryCapability|PlayLogQueryCapability]].

This uses [[Shared_Database_services|pdm:qry]] QueryApplicationPlayStatisticsForSystem.

==== QueryApplicationPlayStatisticsByUid ====
Takes a u128 userID, a type-0x6 output buffer containing an array of [[Shared_Database_services|ApplicationPlayStatistics]] and a type-0x5 input buffer containing an array of [[NCM_services#ApplicationId|ApplicationId]]. Returns an output s32 for actual total output entries.

Same as [[#QueryApplicationPlayStatistics]] except this uses [[Shared_Database_services|pdm:qry]] cmd16, to get playstats specific to userIDs.

==== ExecuteProgram ====
Takes an input u32 [[#ProgramSpecifyKind]] and an input u64, no output.

==== ClearUserChannel ====
No input/output.

Clears the UserChannel used by [[#UnpopToUserChannel]].

==== UnpopToUserChannel ====
Takes an input [[#IStorage]], no output.

The input storage is pushed to the UserChannel. This is the same channel used by [[#LaunchParameterKind]] value 1.

User-processes create a storage using data specified by the user (written to offset=0 size=inputsize), with max size 0x1000. This storage is then used with this cmd.

==== GetPreviousProgramIndex ====
No input, returns an output s32.

Gets the ProgramIndex of the Application which launched this title. The output ProgramIndex is -1 when there was no previous title.

==== EnableApplicationAllThreadDumpOnCrash ====
Takes an input u8 bool, no output.

==== GetGpuErrorDetectedSystemEvent ====
No input, returns an output Event handle with autoclear=false.

This is used by sdknso during applet-application initialization. A separate thread is setup where event-waiting is handled. When the Event is signaled, official sw will Abort.

==== SetDelayTimeToAbortOnGpuError ====
Takes an input s64 "nn::TimeSpan", no output.

==== GetFriendInvitationStorageChannelEvent ====
No input, returns an output Event handle with EventClearMode=0.

This is exposed by sdknso under <code>nn::friends::</code>. This returns a ptr to the cached Event in global state, with the Event being loaded if not previously initialized.

==== TryPopFromFriendInvitationStorageChannel ====
No input, returns an output [[#IStorage]].

This uses the same StorageChannel as [[#PushToFriendInvitationStorageChannel]].

This is exposed by sdknso under <code>nn::friends::</code>. When the storage_size is <0x10, this returns false. <code>data_size = storage_size-0x10;</code> Then the first 0x10-bytes from storage are read to stack, which is later copied to the output Uid on success prior to returning. Then the storage is read into the specified output buffer with storage-offset 0x10, where the size is <code>size = data_size > buf_size ? buf_size : data_size</code>. Reading is skipped if size is zero. Afterwards the used size is written to an output param. On success, true is returned.

==== GetNotificationStorageChannelEvent ====
No input, returns an output Event handle with EventClearMode=0.

This is exposed by sdknso under <code>nn::notification::</code>. This returns a ptr to the cached Event in global state, with the Event being loaded if not previously initialized.

==== TryPopFromNotificationStorageChannel ====
No input, returns an output [[#IStorage]].

This uses the same StorageChannel as [[#PushToNotificationStorageChannel]].

This is exposed by sdknso under <code>nn::notification::</code>. The storage is read into the specified output buffer, where the size is <code>size = storage_size > buf_size ? buf_size : storage_size</code>. Reading is skipped if size is zero. Afterwards the used size is written to an output param.

==== GetHealthWarningDisappearedSystemEvent ====
No input, returns an output Event with EventClearMode=0.

==== SetHdcpAuthenticationActivated ====
Takes an input u8 bool, no output.

==== GetLaunchRequiredVersion ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], an u64, returns an output [[#LaunchRequiredVersion]].

sdknso passes hard-coded value 0 for the u64.

==== UpgradeLaunchRequiredVersion ====
Takes an input [[#LaunchRequiredVersion]], an [[NCM_services#ApplicationId|ApplicationId]], an u64, no output.

sdknso passes hard-coded value 0 for the u64.

==== SendServerMaintenanceOverlayNotification ====
Takes two input [[PCV_services#PosixTime|PosixTime]], no output.

The second input value can optionally be 0.

==== GetLastApplicationExitReason ====
No input, returns an output s32.

==== StartContinuousRecordingFlushForDebug ====
Takes an input s64 nanoseconds-value, returns an output Event handle with autoclear=false.

The cached value loaded from [[System_Settings|system-setting]] <code>am.debug!dev_function</code> must be set to 0x1 with size 0x1, otherwise an error is returned.

==== CreateMovieMaker ====
Takes an input u64 size and a TransferMemory handle, returns an [[#IMovieMaker]].

Official sw retries using the cmd in a loop on error 0x8D4 with svcSleepThread(100000000) being used first.

Official sw uses permissions=None for the TransferMemory, with an user-specified buffer. The size of the buffer used by official sw is 0x6000000.

==== PrepareForJit ====
Takes no input. Launches the [[JIT_services|jit-sysmodule]] via [[NS_Services|ns]] LaunchLibraryApplet if it has not already been launched for the current application, storing a std::shared_ptr<> for jit-sysmodule process tracking object as an IApplicationFunctions member.

~IApplicationFunctions() includes:

if (this->jit_process) {
Terminate(this->jit_process);
this->jit_process = nullptr;
}

Thus the lifetime of the jit sysmodule is tied to the application which uses it, and each application gets its own fresh copy of the jit sysmodule.

AM can also optionally launch jit-sysmodule automatically if the [[NACP]] enables it.

=== IMovieMaker ===
This is "nn::am::service::IMovieMaker".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#GetGrcMovieMaker]]
|-
| 1 || [[#GetLayerHandle]]
|}

==== GetGrcMovieMaker ====
No input, returns a GRC [[GRC_services|IMovieMaker]].

==== GetLayerHandle ====
No input, returns an output u64.

== ILibraryAppletCreator ==
This is "nn::am::service::ILibraryAppletCreator".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#CreateLibraryApplet]] ||
|-
| 1 || [[#TerminateAllLibraryApplets]] ||
|-
| 2 || [[#AreAnyLibraryAppletsLeft]] ||
|-
| 10 || [[#CreateStorage]] ||
|-
| 11 || [[#CreateTransferMemoryStorage]] ||
|-
| 12 || [2.0.0+] [[#CreateHandleStorage]] ||
|}

=== CreateLibraryApplet ===
Takes 2 input u32s [[#AppletId]] and [[#LibraryAppletMode]], returns an [[#ILibraryAppletAccessor]].

=== TerminateAllLibraryApplets ===
No input/output.

Stubbed with an ILibraryAppletCreator from [[#CreateSelfLibraryAppletCreatorForDevelop]], just returns an error.

Terminates all LibraryApplets which were created by the current applet (or by the Application when used from the [[#IApplicationAccessor]] cmd).

=== AreAnyLibraryAppletsLeft ===
No input, returns an output u8 bool.

Stubbed with an ILibraryAppletCreator from [[#CreateSelfLibraryAppletCreatorForDevelop]], just returns an error.

Gets whether any LibraryApplets ([[#ILibraryAppletAccessor]]) which were created by the current applet are still open (or by the Application when used from the [[#IApplicationAccessor]] cmd).

=== CreateStorage ===
Takes an input s64 for the storage size, returns an [[#IStorage]].

This allocates a buffer with the specified size which can then be accessed via [[#IStorageAccessor]].

=== CreateTransferMemoryStorage ===
Takes an input TransferMemory copy-handle, an input u8 bool, and an s64 size, returns an [[#IStorage]].

The user-process creates the TransferMemory with permissions=0.

The TransferMemory is mapped, which can then be accessed via [[#IStorageAccessor]]. The input bool controls whether writing to the storage is allowed: [[#Write]] will throw an error if this flag is not set.

=== CreateHandleStorage ===
Takes an input copy-handle and an input s64, returns an [[#IStorage]]. In some cases the s64 must not have the negative bit set.

The input can be arbitrary, however official sw is only (?) known to use this for TransferMemory (with s64=size).

=== ILibraryAppletAccessor ===
This is "nn::am::service::ILibraryAppletAccessor".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#GetAppletStateChangedEvent]] ||
|-
| 1 || [[#IsCompleted]] ||
|-
| 10 || [[#Start]] ||
|-
| 20 || [[#RequestExit]] ||
|-
| 25 || [[#Terminate]] ||
|-
| 30 || [[#GetResult]] ||
|-
| 50 || [[#SetOutOfFocusApplicationSuspendingEnabled]] ||
|-
| 60 || [10.0.0+] [[#PresetLibraryAppletGpuTimeSliceZero]] ||
|-
| 100 || [[#PushInData]] ||
|-
| 101 || [[#PopOutData]] ||
|-
| 102 || [[#PushExtraStorage]] ||
|-
| 103 || [[#PushInteractiveInData]] ||
|-
| 104 || [[#PopInteractiveOutData]] ||
|-
| 105 || [[#GetPopOutDataEvent]] ||
|-
| 106 || [[#GetPopInteractiveOutDataEvent]] ||
|-
| 110 || [[#NeedsToExitProcess]] ||
|-
| 120 || [[#GetLibraryAppletInfo]] ||
|-
| 150 || [[#RequestForAppletToGetForeground]] ||
|-
| 160 || [2.0.0+] [[#GetIndirectLayerConsumerHandle]] ||
|}

Commands <=30 are inherited from [[#IAppletAccessor]]. GetLibraryAppletInfo is identical to the [[#ILibraryAppletSelfAccessor]] cmd.

==== SetOutOfFocusApplicationSuspendingEnabled ====
Takes an input u8 bool, no output.

Official sw will assert prior to using this if applet-service was not initialized as *Application.

==== PresetLibraryAppletGpuTimeSliceZero ====
No input/output.

sdknso only uses with with [[Software_Keyboard|swkbd-inline]], immediately after creating the LibraryApplet.

==== PushInData ====
Takes an input [[#IStorage]], no output.

==== PopOutData ====
No input, returns an output [[#IStorage]].

==== PushExtraStorage ====
Takes an input [[#IStorage]], no output.

==== PushInteractiveInData ====
Takes an input [[#IStorage]], no output.

==== PopInteractiveOutData ====
No input, returns an output [[#IStorage]].

==== GetPopOutDataEvent ====
No input, returns an output handle with autoclear=false.

==== GetPopInteractiveOutDataEvent ====
No input, returns an output event handle with autoclear=false.

==== NeedsToExitProcess ====
No input, returns an output u8 bool.

Stubbed, just returns an error.

==== RequestForAppletToGetForeground ====
No input/output.

Stubbed, just returns an error.

==== GetIndirectLayerConsumerHandle ====
Takes an input PID and an input u64 AppletResourceUserId, returns an output u64 IndirectLayerConsumerHandle.

Official sw uses this during LibraryApplet creation when [[#LibraryAppletMode]] is 0x3.

== ICommonStateGetter ==
This is "nn::am::service::ICommonStateGetter".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#GetEventHandle]]
|-
| 1 || [[#ReceiveMessage]]
|-
| 2 || [[#GetThisAppletKind]]
|-
| 3 || [[#AllowToEnterSleep]]
|-
| 4 || [[#DisallowToEnterSleep]]
|-
| 5 || [[#GetOperationMode]]
|-
| 6 || [[#GetPerformanceMode]]
|-
| 7 || [[#GetCradleStatus]]
|-
| 8 || [[#GetBootMode]]
|-
| 9 || [[#GetCurrentFocusState]]
|-
| 10 || [[#RequestToAcquireSleepLock]]
|-
| 11 || [[#ReleaseSleepLock]]
|-
| 12 || [[#ReleaseSleepLockTransiently]]
|-
| 13 || [[#GetAcquiredSleepLockEvent]]
|-
| 14 || [11.0.0+] [[#GetWakeupCount]]
|-
| 20 || [[#PushToGeneralChannel]]
|-
| 30 || [[#GetHomeButtonReaderLockAccessor]]
|-
| 31 || [2.0.0+] [[#GetReaderLockAccessorEx]]
|-
| 32 || [7.0.0+] [[#GetWriterLockAccessorEx]]
|-
| 40 || [2.0.0+] [[#GetCradleFwVersion]]
|-
| 50 || [3.0.0+] [[#IsVrModeEnabled]]
|-
| 51 || [3.0.0+] [[#SetVrModeEnabled]]
|-
| 52 || [4.0.0+] [[#SetLcdBacklighOffEnabled]]
|-
| 53 || [7.0.0+] [[#BeginVrModeEx]]
|-
| 54 || [7.0.0+] [[#EndVrModeEx]]
|-
| 55 || [3.0.0+] [[#IsInControllerFirmwareUpdateSection]]
|-
| 59 || [11.0.0+] [[#SetVrPositionForDebug]]
|-
| 60 || [3.0.0+] [[#GetDefaultDisplayResolution]]
|-
| 61 || [3.0.0+] [[#GetDefaultDisplayResolutionChangeEvent]]
|-
| 62 || [4.0.0+] [[#GetHdcpAuthenticationState]]
|-
| 63 || [4.0.0+] [[#GetHdcpAuthenticationStateChangeEvent]]
|-
| 64 || [5.0.0+] [[#SetTvPowerStateMatchingMode]]
|-
| 65 || [5.1.0+] [[#GetApplicationIdByContentActionName]]
|-
| 66 || [6.0.0+] [[#SetCpuBoostMode]]
|-
| 67 || [10.0.0+] [[#CancelCpuBoostMode]]
|-
| 68 || [11.0.0+] [[#GetBuiltInDisplayType]]
|-
| 80 || [6.0.0+] [[#PerformSystemButtonPressingIfInFocus]]
|-
| 90 || [7.0.0+] [[#SetPerformanceConfigurationChangedNotification]]
|-
| 91 || [7.0.0+] [[#GetCurrentPerformanceConfiguration]]
|-
| 100 || [9.1.0+] [[#SetHandlingHomeButtonShortPressedEnabled]]
|-
| 110 || [11.0.0+] [[#OpenMyGpuErrorHandler]]
|-
| 120 || [13.0.0+] GetAppletLaunchedHistory
|-
| 200 || [7.0.0+] [[#GetOperationModeSystemInfo]]
|-
| 300 || [9.0.0+] [[#GetSettingsPlatformRegion]]
|-
| 400 || [10.0.0+] [[#ActivateMigrationService]]
|-
| 401 || [10.0.0+] [[#DeactivateMigrationService]]
|-
| 500 || [11.0.0+] [[#DisableSleepTillShutdown]]
|-
| 501 || [11.0.0+] [[#SuppressDisablingSleepTemporarily]]
|-
| 502 || [12.0.0+] IsSleepEnabled
|-
| 503 || [12.0.0+] IsDisablingSleepSuppressed
|-
| 600 || [17.0.0+] OpenNamedChannelAsChild
|-
| 900 || [11.0.0+] [[#SetRequestExitToLibraryAppletAtExecuteNextProgramEnabled]]
|-
| 910 || [17.0.0+] GetLaunchRequiredTick
|}

Officially notification messages are handled by the application itself, not sdk-nso in ExeFS. Official apps call code in sdk-nso which basically uses svcWaitSynchronization with the event from [[#GetEventHandle]] to check whether a message is available, then if so it uses [[#ReceiveMessage]]. The actual handling for message IDs is done in the app itself(see [[#AppletMessage]]).

[7.0.0+] User-processes now use BeginVrModeEx/EndVrModeEx instead of [[#SetVrModeEnabled]]. Prior to using using BeginVrModeEx, [[Parental_Control_services|pctl]] IsStereoVisionPermitted is used and error 0xD08E is thrown if not allowed by pctl.

=== GetEventHandle ===
No input. Returns an output event handle. This is signalled when a message is available with [[#ReceiveMessage]].

=== ReceiveMessage ===
No input. Returns an output [[#AppletMessage]]. Error 0x680 indicates no message is available.

=== GetThisAppletKind ===
No input, returns an output [[#AppletKind]].

Stubbed, just returns an error.

=== AllowToEnterSleep ===
No input/output.

Stubbed, just returns an error.

=== DisallowToEnterSleep ===
No input/output.

Stubbed, just returns an error.

=== GetOperationMode ===
No input. Returns an output u8 for the current [[#OperationMode]].

=== GetPerformanceMode ===
No input. Returns an output u32 for the current [[#PerformanceMode]].

=== GetCradleStatus ===
No input, returns an output u8.

This uses [[#omm]] GetCradleStatus.

=== GetBootMode ===
No input, returns an output u8.

Returns the value from [[Process_Manager_services|pm:bm]] GetBootMode.

=== GetCurrentFocusState ===
No input. Returns an output u8 [[#FocusState]].

=== RequestToAcquireSleepLock ===
No input/output.

=== ReleaseSleepLock ===
No input/output.

=== ReleaseSleepLockTransiently ===
No input/output.

=== GetAcquiredSleepLockEvent ===
No input, returns an output Event handle with autoclear=false.

=== GetWakeupCount ===
No input, returns an output u64.

=== PushToGeneralChannel ===
Takes an input [[#IStorage]], no output.

This is not usable under an Application, however it is usable under a LibraryApplet.

Used for sending requests to [[qlaunch]]. sdk-nso creates a 0x10-byte storage which is sent to this. The following are the functions which use this, with the data written to the storage:
* <code>RequestHomeMenu</code> <code>5341 4d53 0100 0000 0200 0000 0100 0000</code> Returns to the main Home Menu, equivalent to pressing the HOME button.
* <code>RequestJumpToSystemUpdate</code> <code>5341 4d53 0100 0000 0b00 0000 0100 0000</code> Equivalent to entering "System Update" under System Settings. When leaving this, it returns to the main Home Menu.

=== GetHomeButtonReaderLockAccessor ===
No input, returns an output [[#ILockAccessor]].

Similar to using [[#GetReaderLockAccessorEx]] with inval=0.

=== GetReaderLockAccessorEx ===
Takes an input u32, returns an output [[#ILockAccessor]].

The input value must be 0-3. 0 = HomeButton.

=== GetWriterLockAccessorEx ===
Takes an input u32, returns an output [[#ILockAccessor]].

The input value must be 0-3. 0 = HomeButton.

=== GetCradleFwVersion ===
No input, returns 4 output u32s.

This uses [[#omm]] GetCradleFwVersion.

=== IsVrModeEnabled ===
No input, returns an output u8 bool.

=== SetVrModeEnabled ===
Takes an input u8 bool flag. No output.

Updates internal AM state fields. If the new state doesn't match the previous state, this uses the [[Backlight_services]] {Disable/Enable}VrMode command depending on whether flag={disable/enable}.

When the VrMode is set to true, the console shows a screen rendered like vr asking the user to move his face away and hit the 'close' button. When this button is pressed, the console resets the vrMode to false.

=== SetLcdBacklighOffEnabled ===
Takes an input u8 bool, no output.

Sets whether the LCD screen blacklight is turned off.

=== BeginVrModeEx ===
No input/output.

Identical to [[#SetVrModeEnabled]] except with hard-coded flag=1.

=== EndVrModeEx ===
No input/output.

Identical to [[#SetVrModeEnabled]] except with hard-coded flag=0.

=== IsInControllerFirmwareUpdateSection ===
No input, returns an output u8 bool.

=== SetVrPositionForDebug ===
Takes 4 input s32s, no output.

The s32s are: x, y, width, height.

The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.

width must be 1-1280, height must be 1-720.

x and y must not be negative. x+width must be <=1280. y+height must be <=720.

=== GetDefaultDisplayResolution ===
No input, returns two output s32s '''width''' and '''height'''.

=== GetDefaultDisplayResolutionChangeEvent ===
No input, returns an output Event handle with autoclear=true.

=== GetHdcpAuthenticationState ===
No input, returns an output s32.

=== GetHdcpAuthenticationStateChangeEvent ===
No input, returns an output Event handle with autoclear=true.

=== SetTvPowerStateMatchingMode ===
Takes an input s32 [[#TvPowerStateMatchingMode]], no output.

=== GetApplicationIdByContentActionName ===
Takes a type-0x5 input buffer containing a string, returns an output [[NCM_services#ApplicationId|ApplicationId]].

Gets the ApplicationId for the specified ContentActionName string. Returns an error when the current [[#AppletId]] isn't 0x04 (when the current applet isn't a SystemApplication).

=== SetCpuBoostMode ===
Takes an input u32 [[#CpuBoostMode]] and passes it to [[PPC_services#apm:sys|SetCpuBoostMode]].

=== CancelCpuBoostMode ===
No input/output.

=== GetBuiltInDisplayType ===
No input, returns an output s32.

This is not exposed by sdknso.

This loads a s32 index from global state (originates from [[SPL_services#GetConfig|GetConfig]] [[SMC#HardwareType|HardwareType]]), Aborts if it's out-of-bounds, then the following is returned for the output s32: global_array[loaded_index].

=== PerformSystemButtonPressingIfInFocus ===
Takes an input [[#SystemButtonType]], no output.

Just returns 0 when a state field is not value 1. Verifies that the input button is allowed, then calls the same func as [[#PerformSystemButtonPressing]] internally.

=== SetPerformanceConfigurationChangedNotification ===
Takes an input u8 bool, no output.

=== GetCurrentPerformanceConfiguration ===
No input, returns the result of calling [[PPC_services#apm:sys|GetCurrentPerformanceConfiguration]].

=== OpenMyGpuErrorHandler ===
No input, returns an [[#IGpuErrorHandler]].

The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.

=== GetOperationModeSystemInfo ===
No input, returns an output u32.

This returns the output from [[#GetOperationModeSystemInfo_2|omm GetOperationModeSystemInfo]].

=== GetSettingsPlatformRegion ===
No input, returns an output u8.

This just returns the output from [[Settings_services#GetPlatformRegion|setsys GetPlatformRegion]].

=== ActivateMigrationService ===
No input/output.

Besides various other functionality, if required this eventually uses [[NS_Services|ns]] LaunchLibraryApplet to launch [[Migration_services|migration]].

=== DeactivateMigrationService ===
No input/output.

=== DisableSleepTillShutdown ===
No input/output.

=== SuppressDisablingSleepTemporarily ===
Takes an input u64 "nn::TimeSpanType", no output.

=== SetRequestExitToLibraryAppletAtExecuteNextProgramEnabled ===
No input/output.

=== IGpuErrorHandler ===
This is "nn::am::service::IGpuErrorHandler".

This was added with [11.0.0+].

This uses various [[NV_services#nvgem:cd|nvgem:cd]] commands.

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 100 || [[#GetManualGpuErrorInfoSize]]
|-
| 101 || [[#GetManualGpuErrorInfo]]
|-
| 102 || [[#GetManualGpuErrorDetectionSystemEvent]]
|-
| 103 || [[#FinishManualGpuErrorHandling]]
|}

==== GetManualGpuErrorInfoSize ====
No input, returns an output u64.

==== GetManualGpuErrorInfo ====
Takes a type-0x6 output buffer, returns an output u64.

The OutBuffer_size must be >= the output size from [[#GetManualGpuErrorInfoSize]].

sdknso exposes the buffer as <code>void*</code>.

==== GetManualGpuErrorDetectionSystemEvent ====
No input, returns an output Event handle with EventClearMode=0.

==== FinishManualGpuErrorHandling ====
No input/output.

== ISelfController ==
This is "nn::am::service::ISelfController".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#Exit]]
|-
| 1 || [[#LockExit]]
|-
| 2 || [[#UnlockExit]]
|-
| 3 || [2.0.0+] [[#EnterFatalSection]]
|-
| 4 || [2.0.0+] [[#LeaveFatalSection]]
|-
| 9 || [[#GetLibraryAppletLaunchableEvent]]
|-
| 10 || [[#SetScreenShotPermission]]
|-
| 11 || [[#SetOperationModeChangedNotification]]
|-
| 12 || [[#SetPerformanceModeChangedNotification]]
|-
| 13 || [[#SetFocusHandlingMode]]
|-
| 14 || [[#SetRestartMessageEnabled]]
|-
| 15 || [2.0.0+] [[#SetScreenShotAppletIdentityInfo]]
|-
| 16 || [2.0.0+] [[#SetOutOfFocusSuspendingEnabled]]
|-
| 17 || [3.0.0+] [[#SetControllerFirmwareUpdateSection]]
|-
| 18 || [3.0.0+] [[#SetRequiresCaptureButtonShortPressedMessage]]
|-
| 19 || [3.0.0+] [[#SetAlbumImageOrientation]]
|-
| 20 || [4.0.0+] [[#SetDesirableKeyboardLayout]]
|-
| 21 || [13.0.0+] GetScreenShotProgramId
|-
| 40 || [[#CreateManagedDisplayLayer]]
|-
| 41 || [4.0.0+] [[#IsSystemBufferSharingEnabled]]
|-
| 42 || [4.0.0+] [[#GetSystemSharedLayerHandle]]
|-
| 43 || [5.0.0+] [[#GetSystemSharedBufferHandle]]
|-
| 44 || [10.0.0+] [[#CreateManagedDisplaySeparableLayer]]
|-
| 45 || [10.0.0+] [[#SetManagedDisplayLayerSeparationMode]]
|-
| 46 || [13.0.0+] [[#SetRecordingLayerCompositionEnabled]]
|-
| 50 || [[#SetHandlesRequestToDisplay]]
|-
| 51 || [[#ApproveToDisplay]]
|-
| 60 || [[#OverrideAutoSleepTimeAndDimmingTime]]
|-
| 61 || [[#SetMediaPlaybackState]]
|-
| 62 || [[#SetIdleTimeDetectionExtension]]
|-
| 63 || [[#GetIdleTimeDetectionExtension]]
|-
| 64 || [[#SetInputDetectionSourceSet]]
|-
| 65 || [2.0.0+] [[#ReportUserIsActive]]
|-
| 66 || [3.0.0+] [[#GetCurrentIlluminance]]
|-
| 67 || [3.0.0+] [[#IsIlluminanceAvailable]]
|-
| 68 || [5.0.0+] [[#SetAutoSleepDisabled]]
|-
| 69 || [5.0.0+] [[#IsAutoSleepDisabled]]
|-
| 70 || [4.0.0+] [[#ReportMultimediaError]]
|-
| 71 || [5.0.0+] [[#GetCurrentIlluminanceEx]]
|-
| 72 || [9.0.0+] [[#SetInputDetectionPolicy]]
|-
| 80 || [4.0.0+] [[#SetWirelessPriorityMode]]
|-
| 90 || [6.0.0+] [[#GetAccumulatedSuspendedTickValue]]
|-
| 91 || [6.0.0+] [[#GetAccumulatedSuspendedTickChangedEvent]]
|-
| 100 || [7.0.0+] [[#SetAlbumImageTakenNotificationEnabled]]
|-
| 110 || [8.0.0+] [[#SetApplicationAlbumUserData]]
|-
| 120 || [11.0.0+] [[#SaveCurrentScreenshot]]
|-
| 130 || [13.0.0+] [[#SetRecordVolumeMuted]]
|-
| 1000 || [7.0.0+] [[#GetDebugStorageChannel]]
|}

=== Exit ===
No input/output.

Exits the current applet. On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.

=== LockExit ===
No input/output.

Locks exit process of pressing X to close in HOME Menu for an application or HOME button for an applet. When locked, it will show the "waiting for software to be closed dialog" until UnlockExit is called or a 15 seconds timeout (when the latter occurs, the process is force-terminated).

=== UnlockExit ===
No input/output.

Unlocks exit process, if LockExit was previously used.

=== EnterFatalSection ===
No input/output.

=== LeaveFatalSection ===
No input/output.

[[#EnterFatalSection]] must be executed at least once before executing this command, otherwise error code 0x40080 will be returned. EnterFatalSection and LeaveFatalSection work in pairs, that is, N calls to EnterFatalSection must be performed first in order to perform N executions of LeaveFatalSection. Essentially, these two functions operate like how one would lock and unlock a recursive mutex.

=== GetLibraryAppletLaunchableEvent ===
No input, returns an output event handle with autoclear=false.

=== SetScreenShotPermission ===
Takes an input s32. No output.

Controls whether screenshot-capture is allowed.

{| class="wikitable" border="1"
|-
! Value || Description
|-
| 0 || Inherit from parent applet
|-
| 1 || Enable
|-
| 2 || Disable
|-
|}

=== SetOperationModeChangedNotification ===
Takes an input u8 bool flag. No output.

=== SetPerformanceModeChangedNotification ===
Takes an input u8 bool flag. No output.

=== SetFocusHandlingMode ===
Takes 3 input u8s with each field located immediately after the previous u8, these are bool flags. No output.

=== SetRestartMessageEnabled ===
Takes an input u8 bool flag, no output.

See [[#AppletMessage]].

=== SetScreenShotAppletIdentityInfo ===
Takes an input [[#AppletIdentityInfo]], no output.

=== SetOutOfFocusSuspendingEnabled ===
Takes an input u8 bool flag. No output.

=== SetControllerFirmwareUpdateSection ===
Takes an input u8 bool flag, no output.

This throws error 0x40280 when the internal state flag already matches the input value.

=== SetRequiresCaptureButtonShortPressedMessage ===
Takes an input u8 bool flag, no output.

See [[#AppletMessage]].

When enabled with a non-Overlay applet, Overlay applet will not be notified of capture button short-presses for screenshots.

=== SetAlbumImageOrientation ===
Takes an input u32 "nn::album::ImageOrientation". No output.

The input value must not be >3.

=== SetDesirableKeyboardLayout ===
Takes an input u32, no output.

The input u32 is "nn::settings::KeyboardLayout".

=== CreateManagedDisplayLayer ===
Returns an output u64 LayerId which is then used by the user-process with [[Display_services#OpenLayer]].

=== IsSystemBufferSharingEnabled ===
No input/output.

Not available when the current applet is an Application ([[#AppletId]] == 0x01).

Checks whether SystemBufferSharing is enabled, throwing an error otherwise.

=== GetSystemSharedLayerHandle ===
No input, returns two output u64s "nn::vi::fbshare::SharedBufferHandle" and "nn::vi::fbshare::SharedLayerHandle".

Runs code similar to [[#IsSystemBufferSharingEnabled]] first.

=== GetSystemSharedBufferHandle ===
No input, returns an output u64 "nn::vi::fbshare::SharedBufferHandle".

Runs code similar to [[#IsSystemBufferSharingEnabled]] first.

Same as [[#GetSystemSharedLayerHandle]] except this just gets the SharedBufferHandle.

=== CreateManagedDisplaySeparableLayer ===
No input, returns two output u64 LayerIds.

sdknso now uses this instead of [[#CreateManagedDisplayLayer]]. sdknso caches the output from the cmd so that it's only used once. The first u64 is used the same as the original LayerId from [[#CreateManagedDisplayLayer]]. <code>nn::vi::CreateRecordingLayer</code> uses the second LayerId, the layer creation is identical besides which LayerId is used.

=== SetManagedDisplayLayerSeparationMode ===
Takes an input u32, no output.

sdknso exposes this as <code>nn::vi::SetRecordingLayerEnabled(bool)</code>.

The input u32 must be 0-1.

=== SetRecordingLayerCompositionEnabled ===
Takes an input bool, no output.

=== SetHandlesRequestToDisplay ===
Takes an input u8 bool, no output.

Sets an internal state flag. When the input flag is 0, this will in additional run the same code as [[#ApproveToDisplay]].

See [[#AppletMessage]].

=== ApproveToDisplay ===
No input/output.

Used to handle the notification enabled by [[#SetHandlesRequestToDisplay]].

=== OverrideAutoSleepTimeAndDimmingTime ===
Takes 4 input s32s, no output.

=== SetMediaPlaybackState ===
Takes an input u8 bool, no output.

=== SetIdleTimeDetectionExtension ===
Takes an input u32, no output.

The input value must be 0-2: 0 = disabled, 1 = Extended, and 2 = ExtendedUnsafe.

=== GetIdleTimeDetectionExtension ===
No input, returns an output u32.

Returns the value set by [[#SetIdleTimeDetectionExtension]].

=== SetInputDetectionSourceSet ===
Takes an input u32, no output.

=== ReportUserIsActive ===
No input/output.

Uses idle:sys ReportUserIsActive.

Reports that the user is active, for idle detection (screen dimming / auto-sleep). This is equivalent to when the user uses HID input.

=== GetCurrentIlluminance ===
No input, returns an output float.

Uses [[Backlight_services|lbl]] command GetAmbientLightSensorValue, where only the output float is used.

=== IsIlluminanceAvailable ===
No input, returns an output u8 bool.

Uses [[Backlight_services|lbl]] command IsAmbientLightSensorAvailable.

User-processes can use this to determine whether to continue with using GetCurrentIlluminance(Ex).

=== SetAutoSleepDisabled ===
Takes an input u8 bool, no output.

=== IsAutoSleepDisabled ===
No input, returns an output u8 bool.

=== ReportMultimediaError ===
Takes an input Result and a type-0x5 input buffer, no output.

The buffer contains a 0x138-byte "movie::MultimediaTelemetryReport" struct.

=== GetCurrentIlluminanceEx ===
No input, returns an output u8 bool and float.

Uses [[Backlight_services|lbl]] command GetAmbientLightSensorValue.

=== SetInputDetectionPolicy ===
Takes an input [[#InputDetectionPolicy]], no output.

=== SetWirelessPriorityMode ===
Takes an input s32 [[#WirelessPriorityMode]], no output.

=== GetAccumulatedSuspendedTickValue ===
No input, returns an output u64 tick value.

Gets the total time in ticks that the process was suspended, relative to when the applet-service was last initialized.

=== GetAccumulatedSuspendedTickChangedEvent ===
No input, returns an output Event handle with autoclear=true.

This is signaled when the output from [[#GetAccumulatedSuspendedTickValue]] is updated.

=== SetAlbumImageTakenNotificationEnabled ===
Takes an input u8 bool, no output.

See [[#AppletMessage]].

=== SetApplicationAlbumUserData ===
Takes a type-0x21 input buffer, no output.

The buffer contains arbitrary UserData.

The size must be <=0x400. The input buffer is copied to a buffer loaded from a state ptr (throwing an error when the state ptr is not set), with the u32 size being written to statebuf+0x400 afterwards.

=== SaveCurrentScreenshot ===
Takes an input s32 [[Capture_services#AlbumReportOption|AlbumReportOption]], no output.

sdknso exposes this under "nn::album::".

=== SetRecordVolumeMuted ===
Takes an input bool, no output.

=== GetDebugStorageChannel ===
No input, returns an output [[#IStorageChannel]].

The cached value loaded from [[System_Settings|system-setting]] <code>am.debug!dev_function</code> must be set to 0x1 with size 0x1, otherwise an error is returned.

== IStorageChannel ==
This is "nn::am::service::IStorageChannel".

This was added with [7.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || Push || No input, returns an output [[#IStorage]].
|-
| 1 || Unpop || No input, returns an output [[#IStorage]].
|-
| 2 || Pop || No input, returns an output [[#IStorage]].
|-
| 3 || GetPopEventHandle || No input, returns an output handle.
|-
| 4 || Clear || No input/output.
|}

== IWindowController ==
This is "nn::am::service::IWindowController".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#CreateWindow]] ||
|-
| 1 || [[#GetAppletResourceUserId]] ||
|-
| 2 || [6.0.0+] [[#GetAppletResourceUserIdOfCallerApplet]] ||
|-
| 10 || [[#AcquireForegroundRights]] ||
|-
| 11 || [[#ReleaseForegroundRights]] ||
|-
| 12 || [[#RejectToChangeIntoBackground]] ||
|-
| 20 || [7.0.0+] [[#SetAppletWindowVisibility]] ||
|-
| 21 || [7.0.0+] [[#SetAppletGpuTimeSlice]] ||
|}

=== CreateWindow ===
Takes an input u32, returns an output [[#IWindow]].

Stubbed, just returns an error.

=== GetAppletResourceUserId ===
No input, returns an output u64 [[#AppletResourceUserId]].

=== GetAppletResourceUserIdOfCallerApplet ===
No input, returns an output u64 [[#AppletResourceUserId]].

=== AcquireForegroundRights ===
No input/output.

Just returns 0.

=== ReleaseForegroundRights ===
No input/output.

Just returns 0.

=== RejectToChangeIntoBackground ===
No input/output.

Just returns 0.

=== SetAppletWindowVisibility ===
Takes an input u8 bool, no output.

=== SetAppletGpuTimeSlice ===
Takes an input s64, no output.

The input s64 must not be negative.

== IAudioController ==
This is "nn::am::service::IAudioController".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#SetExpectedMasterVolume]]
|-
| 1 || [[#GetMainAppletExpectedMasterVolume]]
|-
| 2 || [[#GetLibraryAppletExpectedMasterVolume]]
|-
| 3 || [[#ChangeMainAppletMasterVolume]]
|-
| 4 || [[#SetTransparentVolumeRate]]
|}

GetMainAppletExpectedMasterVolume/SetExpectedMasterVolume are used for saving/restoring state for LibraryApplet launching, with SetExpectedMasterVolume being used with new state prior to launching a LibraryApplet. With official sw these applet funcs are used directly in the main-codebin.

=== SetExpectedMasterVolume ===
Takes two input floats, no output.

Writes the input floats to state: first one is used by [[#GetMainAppletExpectedMasterVolume]], second one is used by [[#GetLibraryAppletExpectedMasterVolume]].

=== GetMainAppletExpectedMasterVolume ===
No input, returns an output float.

=== GetLibraryAppletExpectedMasterVolume ===
No input, returns an output float.

=== ChangeMainAppletMasterVolume ===
Takes an input float and an input u64, no output.

=== SetTransparentVolumeRate ===
Takes an input float, no output.

== IDisplayController ==
This is "nn::am::service::IDisplayController".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#GetLastForegroundCaptureImage]]
|-
| 1 || [[#UpdateLastForegroundCaptureImage]]
|-
| 2 || [[#GetLastApplicationCaptureImage]]
|-
| 3 || [[#GetCallerAppletCaptureImage]]
|-
| 4 || [[#UpdateCallerAppletCaptureImage]]
|-
| 5 || [[#GetLastForegroundCaptureImageEx]]
|-
| 6 || [[#GetLastApplicationCaptureImageEx]]
|-
| 7 || [[#GetCallerAppletCaptureImageEx]]
|-
| 8 || [2.0.0+] [[#TakeScreenShotOfOwnLayer]]
|-
| 9 || [5.0.0+] [[#CopyBetweenCaptureBuffers]]
|-
| 10 || [[#AcquireLastApplicationCaptureBuffer]]
|-
| 11 || [[#ReleaseLastApplicationCaptureBuffer]]
|-
| 12 || [[#AcquireLastForegroundCaptureBuffer]]
|-
| 13 || [[#ReleaseLastForegroundCaptureBuffer]]
|-
| 14 || [[#AcquireCallerAppletCaptureBuffer]]
|-
| 15 || [[#ReleaseCallerAppletCaptureBuffer]]
|-
| 16 || [[#AcquireLastApplicationCaptureBufferEx]]
|-
| 17 || [[#AcquireLastForegroundCaptureBufferEx]]
|-
| 18 || [[#AcquireCallerAppletCaptureBufferEx]]
|-
| 20 || [3.0.0+] [[#ClearCaptureBuffer]]
|-
| 21 || [3.0.0+] [[#ClearAppletTransitionBuffer]]
|-
| 22 || [4.0.0+] [[#AcquireLastApplicationCaptureSharedBuffer]]
|-
| 23 || [4.0.0+] [[#ReleaseLastApplicationCaptureSharedBuffer]]
|-
| 24 || [4.0.0+] [[#AcquireLastForegroundCaptureSharedBuffer]]
|-
| 25 || [4.0.0+] [[#ReleaseLastForegroundCaptureSharedBuffer]]
|-
| 26 || [4.0.0+] [[#AcquireCallerAppletCaptureSharedBuffer]]
|-
| 27 || [4.0.0+] [[#ReleaseCallerAppletCaptureSharedBuffer]]
|-
| 28 || [6.0.0+] [[#TakeScreenShotOfOwnLayerEx]]
|}

=== GetLastForegroundCaptureImage ===
Takes a type-0x6 output buffer.

Stubbed, just returns an error.

=== UpdateLastForegroundCaptureImage ===
No input/output.

=== GetLastApplicationCaptureImage ===
Takes a type-0x6 output buffer.

Stubbed, just returns an error.

=== GetCallerAppletCaptureImage ===
Takes a type-0x6 output buffer.

Stubbed, just returns an error.

=== UpdateCallerAppletCaptureImage ===
No input/output.

Calls the same func internally as [[#UpdateLastForegroundCaptureImage]], except this passes param value 2 instead of 1.

=== GetLastForegroundCaptureImageEx ===
Takes a type-0x6 output buffer, returns an output u8 bool.

The buffer size must match 0x384000.

=== GetLastApplicationCaptureImageEx ===
Takes a type-0x6 output buffer, returns an output u8 bool.

The buffer size must match 0x384000.

Calls the same internal func as [[#GetLastForegroundCaptureImageEx]], except that the last param is set to value 0 instead of 1.

=== GetCallerAppletCaptureImageEx ===
Takes a type-0x6 output buffer, returns an output u8 bool.

The buffer size must match 0x384000.

Calls the same internal func as [[#GetLastForegroundCaptureImageEx]], except that the last param is set to value 2 instead of 1.

=== TakeScreenShotOfOwnLayer ===
Takes an input u8 bool and a s32, no output.

=== CopyBetweenCaptureBuffers ===
Takes two input s32s, no output.

=== AcquireLastApplicationCaptureBuffer ===
No input, returns an output handle.

Stubbed, just returns an error.

=== ReleaseLastApplicationCaptureBuffer ===
No input/output.

Clears a state field if it's not already 0, returning an error otherwise. On newer sysvers: then a func is called which just returns 0, then this cmd returns 0.

=== AcquireLastForegroundCaptureBuffer ===
No input, returns an output handle.

Stubbed, just returns an error.

=== ReleaseLastForegroundCaptureBuffer ===
No input/output.

Same as [[#ReleaseLastApplicationCaptureBuffer]] except with a different state field + different input param for the called func.

=== AcquireCallerAppletCaptureBuffer ===
No input, returns an output handle.

Stubbed, just returns an error.

=== ReleaseCallerAppletCaptureBuffer ===
No input/output.

Same as [[#ReleaseLastApplicationCaptureBuffer]] except with a different state field + different input param for the called func.

=== AcquireLastApplicationCaptureBufferEx ===
No input, returns an output TransferMemory handle and an output u8 bool.

The state field used by [[#ReleaseLastApplicationCaptureBuffer]] must be 0. Calls a func which just returns an error (this is only the case on newer sysvers), hence this cmd will just return that error. If that func would have returned successfully, the state field would be set to 1 and the cmd would return 0.

On old sysvers, the output TransferMemory is size 0x384000 with permissions=RW.

=== AcquireLastForegroundCaptureBufferEx ===
No input, returns an output TransferMemory handle and an output u8 bool.

Same as [[#AcquireLastApplicationCaptureBufferEx]] except this uses the [[#ReleaseLastForegroundCaptureBuffer]] state field, and uses a different input param value for the called func.

=== AcquireCallerAppletCaptureBufferEx ===
No input, returns an output TransferMemory handle and an output u8 bool.

Same as [[#AcquireLastApplicationCaptureBufferEx]] except this uses the [[#ReleaseCallerAppletCaptureBuffer]] state field, and uses a different input param value for the called func.

=== ClearCaptureBuffer ===
Takes an input u8 bool, a s32 CaptureSharedBuffer, and an u32 color, returns no output.

Clear the input CaptureSharedBuffer with the specified RGBA8 color.

=== ClearAppletTransitionBuffer ===
Takes an input u32, no output.

Clear the AppletTransitionBuffer with the specified RGBA8 color.

=== AcquireLastApplicationCaptureSharedBuffer ===
No input, returns an output u8 bool and an s32.

This loads data from state.

=== ReleaseLastApplicationCaptureSharedBuffer ===
No input/output.

Depending on whether a state field is 0, this just returns an error or returns 0.

=== AcquireLastForegroundCaptureSharedBuffer ===
No input, returns an output u8 bool and an s32.

Calls the same func internally as [[#AcquireLastApplicationCaptureSharedBuffer]], except this passes value 1 for the last param instead of 0.

=== ReleaseLastForegroundCaptureSharedBuffer ===
No input/output.

Calls the same func internally as [[#ReleaseLastApplicationCaptureSharedBuffer]], except this passes value 1 for the last param instead of 0.

=== AcquireCallerAppletCaptureSharedBuffer ===
No input, returns an output u8 bool and an s32.

Calls the same func internally as [[#AcquireLastApplicationCaptureSharedBuffer]], except this passes value 2 for the last param instead of 0.

=== ReleaseCallerAppletCaptureSharedBuffer ===
No input/output.

Calls the same func internally as [[#ReleaseLastApplicationCaptureSharedBuffer]], except this passes value 2 for the last param instead of 0.

=== TakeScreenShotOfOwnLayerEx ===
Takes two input u8 bools and a s32, no output.

Calls the same func internally as [[#TakeScreenShotOfOwnLayer]], except the last bool param is the last cmd param bool instead of hard-coded 0. This flag indicates whether the screenshot should be taken Immediately.

== ISystemAppletControllerForDebug ==
This is "nn::am::service::ISystemAppletControllerForDebug".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 1 || RequestLaunchApplicationForDebug
|-
| 2 || [7.0.0+] [[#GetDebugStorageChannel]]
|-
| 3 || [7.0.0+] [[#CreateStorageForDebug]]
|-
| 4 || [12.0.0+] [[#CreateCradleFirmwareUpdaterForDebug]]
|}

=== GetDebugStorageChannel ===
No input. Returns an output [[#IStorageChannel]].

=== CreateStorageForDebug ===
Takes a total of 8-bytes of input. Returns an [[#IStorage]].

=== CreateCradleFirmwareUpdaterForDebug ===
No input. Returns an [[#ICradleFirmwareUpdater]].

== IProcessWindingController ==
This is "nn::am::service::IProcessWindingController".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#GetLaunchReason]] ||
|-
| 11 || [[#OpenCallingLibraryApplet]] ||
|-
| 21 || [[#PushContext]] ||
|-
| 22 || [[#PopContext]] ||
|-
| 23 || [[#CancelWindingReservation]] ||
|-
| 30 || [[#WindAndDoReserved]] ||
|-
| 40 || [[#ReserveToStartAndWaitAndUnwindThis]] ||
|-
| 41 || [4.0.0+] [[#ReserveToStartAndWait]] ||
|}

=== GetLaunchReason ===
No input, returns an output [[#AppletProcessLaunchReason]].

Used by LibraryApplets.

=== OpenCallingLibraryApplet ===
No input, returns an output [[#ILibraryAppletAccessor]].

The objptr from state is cleared during this, an error is thrown if it's already 0.

=== PushContext ===
Takes an input [[#IStorage]], no output.

=== PopContext ===
No input, returns an output [[#IStorage]].

=== CancelWindingReservation ===
No input/output.

=== WindAndDoReserved ===
No input/output.

=== ReserveToStartAndWaitAndUnwindThis ===
Takes an input [[#ILibraryAppletAccessor]], no output.

=== ReserveToStartAndWait ===
Takes an input [[#ILibraryAppletAccessor]], no output.

== IDebugFunctions ==
This is "nn::am::service::IDebugFunctions".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#NotifyMessageToHomeMenuForDebug]]
|-
| 1 || [1.0.0-9.2.0] [[#OpenMainApplication]]
|-
| 10 || [[#PerformSystemButtonPressing]]
|-
| 20 || [[#InvalidateTransitionLayer]]
|-
| 30 || [6.0.0+] [[#RequestLaunchApplicationWithUserAndArgumentForDebug]]
|-
| 31 || [12.0.0+] RequestLaunchApplicationByApplicationLaunchInfoForDebug
|-
| 40 || [6.0.0+] [[#GetAppletResourceUsageInfo]]
|-
| 50 || [15.0.0+] AddSystemProgramIdAndAppletIdForDebug
|-
| 51 || [16.0.0+] AddOperationConfirmedLibraryAppletIdForDebug
|-
| 52 || [17.0.0+] GetProgramIdFromAppletIdForDebug
|-
| 100 || [7.0.0+] [[#SetCpuBoostModeForApplet]]
|-
| 101 || [10.0.0+] [[#CancelCpuBoostModeForApplet]]
|-
| 110 || [9.0.0+] [[#PushToAppletBoundChannelForDebug]]
|-
| 111 || [9.0.0+] [[#TryPopFromAppletBoundChannelForDebug]]
|-
| 120 || [9.0.0+] [[#AlarmSettingNotificationEnableAppEventReserve]]
|-
| 121 || [9.0.0+] [[#AlarmSettingNotificationDisableAppEventReserve]]
|-
| 122 || [9.0.0+] [[#AlarmSettingNotificationPushAppEventNotify]]
|-
| 130 || [9.0.0+] [[#FriendInvitationSetApplicationParameter]]
|-
| 131 || [9.0.0+] [[#FriendInvitationClearApplicationParameter]]
|-
| 132 || [9.0.0+] [[#FriendInvitationPushApplicationParameter]]
|-
| 140 || [14.0.0+] RestrictPowerOperationForSecureLaunchModeForDebug
|-
| 200 || [15.0.0+] CreateFloatingLibraryAppletAccepterForDebug
|-
| 300 || [16.0.0+] TerminateAllRunningApplicationsForDebug
|-
| 900 || [12.0.0+] GetGrcProcessLaunchedSystemEvent
|}

=== NotifyMessageToHomeMenuForDebug ===
Takes an input [[#AppletMessage]], no output.

Stubbed, just returns an error.

=== OpenMainApplication ===
No input, returns an output [[#IApplicationAccessor]].

Should not be used when no Application is running (svcBreak).

=== PerformSystemButtonPressing ===
Takes an input [[#SystemButtonType]], no output.

=== InvalidateTransitionLayer ===
No input/output.

=== RequestLaunchApplicationWithUserAndArgumentForDebug ===
Takes an input u8 bool flag, an [[NCM_services#ApplicationId|ApplicationId]], a type-0x5 input buffer containing an array of u128 userIDs, and a type-0x5 input buffer, no output.

Requests to launch the specified Application, with the specified users. When the bool flag is true, the content of the second input buffer is used to create a storage which is pushed to the UserChannel for this Application (see [[#LaunchParameterKind]]).

=== GetAppletResourceUsageInfo ===
No input, returns an output [[#AppletResourceUsageInfo]].

=== SetCpuBoostModeForApplet ===
Takes an input u32 [[#CpuBoostMode]] and passes it to [[PPC_services#apm:sys|SetCpuBoostMode]].

The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.

=== CancelCpuBoostModeForApplet ===
No input/output.

=== PushToAppletBoundChannelForDebug ===
Takes an input [[#IStorage]] and a s32, no output.

The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.

The s32 must match the value already stored in state when the state value is non-zero, otherwise an error is returned. When the state value is 0, the s32 is written into state. Then the input storage is pushed to the StorageChannel.

=== TryPopFromAppletBoundChannelForDebug ===
Takes an input s32, returns an output [[#IStorage]].

The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.

The s32 must not be 0 and must match the value previously saved by [[#PushToAppletBoundChannelForDebug]], otherwise errors are returned. Then the output storage is popped from the StorageChannel.

=== AlarmSettingNotificationEnableAppEventReserve ===
Takes an input [[#IStorage]] and an [[NCM_services#ApplicationId|ApplicationId]], no output.

Clears a StorageChannel, pushes the input storage there, and writes the ApplicationId into state.

=== AlarmSettingNotificationDisableAppEventReserve ===
No input/output.

Clears the StorageChannel/saved-ApplicationId used by [[#AlarmSettingNotificationEnableAppEventReserve]].

=== AlarmSettingNotificationPushAppEventNotify ===
Takes an input [[#IStorage]], no output.

Same as [[#PushToNotificationStorageChannel]] except this uses the MainApplication.

=== FriendInvitationSetApplicationParameter ===
Takes an input [[#IStorage]] and an [[NCM_services#ApplicationId|ApplicationId]], no output.

Clears a StorageChannel, pushes the input storage there, and writes the ApplicationId into state.

=== FriendInvitationClearApplicationParameter ===
No input/output.

Clears the StorageChannel/saved-ApplicationId used by [[#FriendInvitationSetApplicationParameter]].

=== FriendInvitationPushApplicationParameter ===
Takes an input [[#IStorage]], no output.

Same as [[#PushToFriendInvitationStorageChannel]] except this uses the MainApplication.

== IStorage ==
This is "nn::am::service::IStorage".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || Open || No input. Returns an [[#IStorageAccessor]].
|-
| 1 || [2.0.0+] OpenTransferStorage || No input. Returns an [[#ITransferStorageAccessor]].
|}

Open can only be used when the IStorage was created by [[#CreateStorage]] or [[#CreateTransferMemoryStorage]]. OpenTransferStorage can only be used when the IStorage was created by [[#CreateHandleStorage]].

Only 1 *Accessor session can be open for each IStorage at a time.

== IStorageAccessor ==
This is "nn::am::service::IStorageAccessor".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || GetSize || No input. Returns an s64.
|-
| 10 || Write || Takes an input s64 and a type-0x21 input buffer.
|-
| 11 || Read || Takes an input s64 and a type-0x22 output buffer.
|}

== ITransferStorageAccessor ==
This is "nn::am::service::ITransferStorageAccessor".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || GetSize || No input. Returns an output s64.
|-
| 1 || GetHandle || No input. Returns an output s64 and handle.
|}

These commands return the data originally from [[#CreateHandleStorage]] input, both return the same s64.

= appletOE =
This is "nn::am::service::IApplicationProxyService".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#OpenApplicationProxy]] ||
|}

This is used by all regular-applications, including [[flog]] and "Retail Interactive Display Menu". Only one session can be open for this service at a time.

== OpenApplicationProxy ==
Returns an [[#IApplicationProxy]]. See [[#appletAE]].

Takes a [[IPC_Marshalling|reserved]] input u64 (official user-processes use hard-coded value 0), a PID, and a process copy-handle (cur-proc handle alias).

On failure, official user-processes will retry using this command in a loop while the retval is 0x19280, with svcSleepThread(10000000) being called first.

= idle:sys =
This is "nn::idle::detail::IPolicyManagerSystem"

This was moved to [[OMM_services|omm]] with [14.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetAutoPowerDownEvent
|-
| 1 || [7.0.0+] IsAutoPowerDownRequested ([1.0.0-3.0.2] )
|-
| 2 || [1.0.0-3.0.2]
|-
| 3 || [[#SetHandlingContext]]
|-
| 4 || LoadAndApplySettings
|-
| 5 || ReportUserIsActive
|}

== SetHandlingContext ==
[3.0.0+] Now takes an additional 0x10-bytes of input.

[13.0.0+] Total input size is now 0x30 instead of 0x38.

= omm =
This is "nn::omm::detail::IOperationModeManager"

Operation Mode Manager (OMM) is a service responsible for arbitrating the operation changes between docked and handheld modes.
Besides [[PTM_services|PTM]], this is the only service that interacts with the [[Dock]] through [[USB_services|usb:pd*]].

This was moved to [[OMM_services|omm]] with [14.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetOperationMode
|-
| 1 || GetOperationModeChangeEvent
|-
| 2 || EnableAudioVisual
|-
| 3 || DisableAudioVisual
|-
| 4 || EnterSleepAndWait
|-
| 5 || GetCradleStatus
|-
| 6 || FadeInDisplay
|-
| 7 || FadeOutDisplay
|-
| 8 || [2.0.0+] GetCradleFwVersion
|-
| 9 || [2.0.0+] NotifyCecSettingsChanged
|-
| 10 || [3.0.0+] SetOperationModePolicy
|-
| 11 || [3.0.0+] GetDefaultDisplayResolution
|-
| 12 || [3.0.0+] GetDefaultDisplayResolutionChangeEvent
|-
| 13 || [3.0.0+] UpdateDefaultDisplayResolution
|-
| 14 || [3.0.0+] ShouldSleepOnBoot
|-
| 15 || [4.0.0+] NotifyHdcpApplicationExecutionStarted
|-
| 16 || [4.0.0+] NotifyHdcpApplicationExecutionFinished
|-
| 17 || [4.0.0+] NotifyHdcpApplicationDrawingStarted
|-
| 18 || [4.0.0+] NotifyHdcpApplicationDrawingFinished
|-
| 19 || [4.0.0+] GetHdcpAuthenticationFailedEvent
|-
| 20 || [4.0.0+] GetHdcpAuthenticationFailedEmulationEnabled
|-
| 21 || [4.0.0+] SetHdcpAuthenticationFailedEmulation
|-
| 22 || [4.0.0+] GetHdcpStateChangeEvent
|-
| 23 || [4.0.0+] GetHdcpState
|-
| 24 || [5.0.0+] ShowCardUpdateProcessing
|-
| 25 || [5.0.0+] SetApplicationCecSettingsAndNotifyChanged
|-
| 26 || [7.0.0+] [[#GetOperationModeSystemInfo]]
|-
| 27 || [9.0.0+] GetAppletFullAwakingSystemEvent
|-
| 28 || [12.0.0+] [[#CreateCradleFirmwareUpdater]]
|}

== GetOperationModeSystemInfo ==
No input, returns an output u32.

This is used by [[#GetOperationModeSystemInfo|ICommonStateGetter GetOperationModeSystemInfo]].

== CreateCradleFirmwareUpdater ==
No input. Returns an [[#ICradleFirmwareUpdater]].

== ICradleFirmwareUpdater ==
This is "nn::am::service::ICradleFirmwareUpdater".

This was added with [12.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || Start
|-
| 1 || Finish
|-
| 2 || GetUpdateDeviceStatus
|-
| 3 || GetUpdateProgress
|-
| 4 || GetUpdateDeviceStatusChangeEvent
|-
| 5 || GetUpdateProgress2
|}

= spsm =
This is "nn::spsm::detail::IPowerStateInterface".

This was moved to [[OMM_services|omm]] with [14.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetCurrentState
|-
| 1 || EnterSleep
|-
| 2 || GetLastWakeReason
|-
| 3 || Shutdown
|-
| 4 || GetNotificationMessageEventHandle
|-
| 5 || ReceiveNotificationMessage
|-
| 6 || AnalyzeLogForLastSleepWakeSequence
|-
| 7 || ResetEventLog
|-
| 8 || AnalyzePerformanceLogForLastSleepWakeSequence
|-
| 9 || ChangeHomeButtonLongPressingTime
|-
| 10 || PutErrorState
|-
| 11 || [1.0.0-3.0.2] InvalidateCurrentHomeButtonPressing
|}

[3.0.0+] Cmd11 now takes a total of 8-bytes of input.

= tcap =
This is "nn::tcap::server::IManager".

This was removed with [11.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetContinuousHighSkinTemperatureEvent
|-
| 1 || SetOperationMode
|-
| 2 || LoadAndApplySettings
|}

= caps:su =
This is "nn::capsrv::sf::IScreenShotApplicationService".

This was added with [6.0.0+].

This can be used by applications to save screenshots.

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 32 || [7.0.0+] SetShimLibraryVersion || Takes a total of 0x10-bytes of input and a PID, no output.
|-
| 201 || SaveScreenShot ||
|-
| 203 || SaveScreenShotEx0 ||
|-
| 205 || [8.0.0+] SaveScreenShotEx1 ||
|-
| 210 || SaveScreenShotEx2 || Takes a total of 0x50-bytes of input, a type-0x15 input buffer, and a type-0x45 input buffer. Returns a total of 0x20-bytes of output.
|}

'''SetShimLibraryVersion''' is a wrapper for [[Capture_services|caps:c]] cmd33. Commands '''SaveScreenShot''', '''SaveScreenShotEx0''', '''SaveScreenShotEx1''' and '''SaveScreenShotEx2''' are wrappers for [[Display_services|caps:sc]] cmd210.

== SaveScreenShot ==
Takes two input u32s, an u64 AppletResourceUserId, a PID, and a type-0x45 input buffer containing image data. Returns an [[Capture_services|ApplicationAlbumEntry]].

Official user-processes doesn't use this, instead [[#SaveScreenShotEx0]] is used: ScreenShotAttributeEx0 is all-zero, except +4 is set to an input u32 and u32 +0xC = 0x1.

This cmd internally uses an all-zero ScreenShotAttributeEx0, with u32 +0 = input u32 and u32 +0x8 = 0x3.

== SaveScreenShotEx0 ==
Takes an input 0x40-byte struct '''ScreenShotAttributeEx0''', an input u32, an input u64 AppletResourceUserId, a PID, and a type-0x45 input buffer containing image data. Returns an [[Capture_services|ApplicationAlbumEntry]].

== SaveScreenShotEx1 ==
Takes an input 0x40-byte struct '''ScreenShotAttributeEx0''', an input u32, an input u64 AppletResourceUserId, a PID, a type-0x15 input buffer containing an [[Capture_services|ApplicationData]], and a type-0x45 input buffer containing image data. Returns an [[Capture_services|ApplicationAlbumEntry]].

== SaveScreenShotEx2 ==
Takes an input 0x40-byte struct '''ScreenShotAttributeEx0''', an input u32, an input u64 AppletResourceUserId, a type-0x15 input buffer containing an [[Capture_services|UserIdList]], and a type-0x45 input buffer containing image data. Returns an [[Capture_services|ApplicationAlbumEntry]].

= apm =
This is "nn::am::service::IApmManager".

This was added with [8.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#OpenSession]]
|-
| 1 || GetPerformanceMode
|-
| 6 || [7.0.0+] [[#IsCpuOverclockEnabled]]
|}

== OpenSession ==
Returns an [[#ISession]].

== IsCpuOverclockEnabled ==
No input, returns an output u8 bool.

== ISession ==
This is "nn::am::service::IApmSession".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || SetPerformanceConfiguration
|-
| 1 || GetPerformanceConfiguration
|-
| 2 || [8.0.0+] SetCpuOverclockEnabled
|}

= Library Applets =
This section documents library applet launching.

Before starting the applet, [[#IStorage]]s are [[#ILibraryAppletCreator|created]] and written, then passed to [[#ILibraryAppletAccessor]] PushInData. The [[#IStorage]] session is closed afterwards. The first [[#IStorage]] is [[#CommonArguments]], followed by any applet-specific [[#IStorage]]s.

Once the applet finishes running successfully, [[#ILibraryAppletAccessor]] PopOutData can be used to get the applet-specific [[#IStorage]] containing the applet output data.

== CommonArguments ==
The first [[#CreateStorage|IStorage]] passed to applets should contain the common library applet arguments. This is populated by <code>nn::la::CommonArgumentsWriter</code> and has the following format.

This struct is 0x20-bytes.

Official sw handles the first 8-bytes separately, which is a header. With CommonArguments version 0x0, the header is 4-bytes, while starting with version 0x1 it's 8-bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Typical Value || Notes
|-
| 0x0 || 4 || 1 || Common Arguments version
|-
| 0x4 || 4 || 0x20 || Common Arguments size
|-
| 0x8 || 4 || || Library applet version (API version)
|-
| 0xC || 4 || 0 || Theme color
|-
| 0x10 || 1 || 0 || Play startup sound
|-
| 0x18 || 8 || N/A || System tick (see [[SVC#svcGetSystemTick|svcGetSystemTick]])
|-
|}

= AppletId =
This is "nn::applet::AppletId". See also [[:Category:Library Applets]].

{| class="wikitable" border="1"
|-
! Value
! ProgramId
! Description
|-
| 0x00
|
| None
|-
| 0x01
|
| Application (not valid for use with LibraryApplets)
|-
| 0x02
| 010000000000100C
| OverlayApplet (overlayDisp)
|-
| 0x03
| 0100000000001000
| SystemAppletMenu (qlaunch)
|-
| 0x04
| 0100000000001012
| SystemApplication (starter)
|-
| 0x0A
| 0100000000001001
| [[Auth_Applet|LibraryAppletAuth (auth)]]
|-
| 0x0B
| 0100000000001002
| [[Cabinet_Applet|LibraryAppletCabinet (cabinet)]]
|-
| 0x0C
| 0100000000001003
| [[Controller_Applet|LibraryAppletController (controller)]]
|-
| 0x0D
| 0100000000001004
| LibraryAppletDataErase (dataErase)
|-
| 0x0E
| 0100000000001005
| [[Error_Applet|LibraryAppletError (error)]]
|-
| 0x0F
| 0100000000001006
| LibraryAppletNetConnect (netConnect)
|-
| 0x10
| 0100000000001007
| [[Profile_Selector|LibraryAppletPlayerSelect (playerSelect)]]
|-
| 0x11
| 0100000000001008
| [[Software_Keyboard|LibraryAppletSwkbd (swkbd)]]
|-
| 0x12
| 0100000000001009
| [[MiiEdit_Applet|LibraryAppletMiiEdit (miiEdit)]]
|-
| 0x13
| 010000000000100A
| [[Internet_Browser#010000000000100A|LibraryAppletWeb (web)]]
|-
| 0x14
| 010000000000100B
| [[Internet_Browser#ShopN|LibraryAppletShop (shop)]]
|-
| 0x15
| 010000000000100D
| [[Album_Applet|LibraryAppletPhotoViewer (photoViewer)]]
|-
| 0x16
| 010000000000100E
| LibraryAppletSet (set)
|-
| 0x17
| 010000000000100F
| [[Internet_Browser#Offline_Applet|LibraryAppletOfflineWeb (offlineWeb)]]
|-
| 0x18
| 0100000000001010
| [[Internet_Browser#Whitelisted_Applets|LibraryAppletLoginShare (loginShare)]]
|-
| 0x19
| 0100000000001011
| [[Internet_Browser#WifiWebAuthApplet|LibraryAppletWifiWebAuth (wifiWebAuth)]]
|-
| 0x1A
| 0100000000001013
| [[MyPage_Applet|LibraryAppletMyPage (myPage)]]
|-
| 0x1B
| 010000000000101A
| LibraryAppletGift (gift)
|-
| 0x1C
| 010000000000101C
| LibraryAppletUserMigration (userMigration)
|-
| 0x1D
| 010000000000101D
| [9.0.0+] LibraryAppletPreomiaSys (EncounterSys)
|-
| 0x1E
| 0100000000001020
| [9.0.0+] LibraryAppletStory (story)
|-
| 0x1F
| 010070000E3C0000
| [9.0.0+] LibraryAppletPreomiaUsr (EncounterUsr)
|-
| 0x20
| 010086000E49C000
| [9.0.0+] LibraryAppletPreomiaUsrDummy (EncounterUsrDummy)
|-
| 0x21
| 0100000000001038
| [10.0.0+] LibraryAppletSample (sample)
|-
| 0x22
| 0100000000001007
| [13.0.0+] LibraryAppletPromoteQualification (playerSelect)
|-
| 0x32
| 010000000000100F
| [17.0.0+] [[Internet_Browser#Offline_Applet|LibraryAppletOfflineWeb (offlineWeb)]]
|-
| 0x33
| 010000000000100F
| [17.0.0+] [[Internet_Browser#Offline_Applet|LibraryAppletOfflineWeb (offlineWeb)]]
|-
| 0x35
| [17.0.0+] 0100000000001010 ([16.0.0-16.1.0] 0100000000001042)
| [17.0.0+] [[Internet_Browser#Whitelisted_Applets|LibraryAppletLoginShare (loginShare)]] ([16.0.0-16.1.0] )
|-
| 0x36
| [17.0.0+] 0100000000001010 ([16.0.0-16.1.0] 0100000000001042)
| [17.0.0+] [[Internet_Browser#Whitelisted_Applets|LibraryAppletLoginShare (loginShare)]] ([16.0.0-16.1.0] )
|-
| 0x37
| [17.0.0+] 0100000000001010 ([16.0.0-16.1.0] 0100000000001042)
| [17.0.0+] [[Internet_Browser#Whitelisted_Applets|LibraryAppletLoginShare (loginShare)]] ([16.0.0-16.1.0] )
|-
| 0x38
| 0100000000001043
| [16.0.0-16.1.0]
|-
| 0x3E8
|
| [10.0.0-16.1.0] DevlopmentTool
|-
| 0x3F1
| 010000000000D619
| [10.0.0-16.1.0] CombinationLA
|-
| 0x3F2
| 010000000000D610
| [10.0.0-16.1.0] AeSystemApplet
|-
| 0x3F3
| 010000000000D611
| [10.0.0-16.1.0] AeOverlayApplet
|-
| 0x3F4
| 010000000000D612
| [10.0.0-16.1.0] AeStarter
|-
| 0x3F5
| 010000000000D613
| [10.0.0-16.1.0] AeLibraryAppletAlone
|-
| 0x3F6
| 010000000000D614
| [10.0.0-16.1.0] AeLibraryApplet1
|-
| 0x3F7
| 010000000000D615
| [10.0.0-16.1.0] AeLibraryApplet2
|-
| 0x3F8
| 010000000000D616
| [10.0.0-16.1.0] AeLibraryApplet3
|-
| 0x3F9
| 010000000000D617
| [10.0.0-16.1.0] AeLibraryApplet4
|-
| 0x3FA
| 010000000000D60A
| [10.0.0-16.1.0] AppletISA
|-
| 0x3FB
| 010000000000D60B
| [10.0.0-16.1.0] AppletIOA
|-
| 0x3FC
| 010000000000D60C
| [10.0.0-16.1.0] AppletISTA
|-
| 0x3FD
| 010000000000D60D
| [10.0.0-16.1.0] AppletILA1
|-
| 0x3FE
| 010000000000D60E
| [10.0.0-16.1.0] AppletILA2
|-
| 0x700000DC
| 010000000000D619
| [17.0.0+] CombinationLA
|-
| 0x700000E6
| 010000000000D610
| [17.0.0+] AeSystemApplet
|-
| 0x700000E7
| 010000000000D611
| [17.0.0+] AeOverlayApplet
|-
| 0x700000E8
| 010000000000D612
| [17.0.0+] AeStarter
|-
| 0x700000E9
| 010000000000D613
| [17.0.0+] AeLibraryAppletAlone
|-
| 0x700000EA
| 010000000000D614
| [17.0.0+] AeLibraryApplet1
|-
| 0x700000EB
| 010000000000D615
| [17.0.0+] AeLibraryApplet2
|-
| 0x700000EC
| 010000000000D616
| [17.0.0+] AeLibraryApplet3
|-
| 0x700000ED
| 010000000000D617
| [17.0.0+] AeLibraryApplet4
|-
| 0x700000F0
| 010000000000D60A
| [17.0.0+] AppletISA
|-
| 0x700000F1
| 010000000000D60B
| [17.0.0+] AppletIOA
|-
| 0x700000F2
| 010000000000D60C
| [17.0.0+] AppletISTA
|-
| 0x700000F3
| 010000000000D60D
| [17.0.0+] AppletILA1
|-
| 0x700000F4
| 010000000000D60E
| [17.0.0+] AppletILA2
|}

= LibraryAppletMode =
This is "nn::applet::LibraryAppletMode".

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0x0
| AllForeground
|-
| 0x1
| PartialForeground
|-
| 0x2
| NoUi
|-
| 0x3
| PartialForegroundWithIndirectDisplay (see also [[#GetIndirectLayerConsumerHandle]], only used by swkbd [[Software_Keyboard|InlineKeyboard]])
|-
| 0x4
| AllForegroundInitiallyHidden (can be used by [7.0.0+] [[Internet_Browser|WebSession]])
|}

= AppletMessage =
This is "nn::am::AppletMessage".

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || None
|-
| 1 || ChangeIntoForeground
|-
| 2 || ChangeIntoBackground
|-
| 4 || Exit
|-
| 6 || ApplicationExited
|-
| 15 || [[#FocusState|FocusStateChanged]]
|-
| 16 || [[#SetRestartMessageEnabled|Resume]]
|-
| 20 || DetectShortPressingHomeButton
|-
| 21 || DetectLongPressingHomeButton
|-
| 22 || DetectShortPressingPowerButton
|-
| 23 || DetectMiddlePressingPowerButton
|-
| 24 || DetectLongPressingPowerButton
|-
| 25 || RequestToPrepareSleep
|-
| 26 || FinishedSleepSequence
|-
| 27 || SleepRequiredByHighTemperature
|-
| 28 || SleepRequiredByLowBattery
|-
| 29 || AutoPowerDown
|-
| 30 || [[#OperationMode|OperationModeChanged]]
|-
| 31 || [[#PerformanceMode|PerformanceModeChanged]]
|-
| 32 || DetectReceivingCecSystemStandby
|-
| 33 || SdCardRemoved
|-
| 50 || LaunchApplicationRequested
|-
| 51 || [[#SetHandlesRequestToDisplay|RequestToDisplay]]
|-
| 55 || ShowApplicationLogo
|-
| 56 || HideApplicationLogo
|-
| 57 || ForceHideApplicationLogo
|-
| 60 || FloatingApplicationDetected
|-
| 90 || [[#SetRequiresCaptureButtonShortPressedMessage|DetectShortPressingCaptureButton]]
|-
| 92 || [[#SetAlbumImageTakenNotificationEnabled|AlbumScreenShotTaken]]
|-
| 93 || AlbumRecordingSaved
|}

= OperationMode =
This is "nn::oe::OperationMode".

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || Handheld
|-
| 1 || Console
|}

= PerformanceMode =
This is "nn::oe::PerformanceMode".

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| -1 || Invalid
|-
| 0 || Normal
|-
| 1 || Boost
|}

= FocusState =
This is "nn::oe::FocusState".

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 1 || InFocus
|-
| 2 || OutOfFocus
|-
| 3 || Background
|}

= CpuBoostMode =
This is "nn::oe::CpuBoostMode".

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || Normal
|-
| 1 || FastLoad
|}

= WindowOriginMode =
This is "nn::oe::WindowOriginMode".

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || LowerLeft
|-
| 1 || UpperLeft
|}

= WirelessPriorityMode =
This is "nn::oe::WirelessPriorityMode".

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || Default
|-
| 1 || OptimizedForWlan
|}

= TvPowerStateMatchingMode =
This is "nn::oe::TvPowerStateMatchingMode". This is used with [[#SetTvPowerStateMatchingMode]].

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || Unknown
|-
| 1 || Unknown
|}

= SystemButtonType =
This is "nn::am::service::SystemButtonType". This is used with [[#PerformSystemButtonPressingIfInFocus]]/[[#PerformSystemButtonPressing]].

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 1 || PerformHomeButtonShortPressing
|-
| 2 || PerformHomeButtonLongPressing
|-
| 3 || Short-pressing with the Power-button. Only available with [[#PerformSystemButtonPressing]].
|-
| 4 || Long-pressing with the Power-button. Only available with [[#PerformSystemButtonPressing]].
|-
| 5 || Shutdown the system. Only available with [[#PerformSystemButtonPressing]].
|-
| 6 || PerformCaptureButtonShortPressing
|-
| 7 || PerformCaptureButtonLongPressing
|}

= LaunchParameterKind =
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 1 || UserChannel. Application-specific LaunchParameter.
|-
| 2 || account PreselectedUser
|-
| 3 || Unknown if used by anything?
|}

= LibraryAppletExitReason =
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || Normal
|-
| 1 || Canceled
|-
| 2 || Abnormal
|-
| 10 || Unexpected
|}

= ProgramSpecifyKind =
This is "nn::am::service::ProgramSpecifyKind". This controls the type of the u64 passed to [[#ExecuteProgram]].

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || u8 ProgramIndex. "ExecuteProgram". [[NS_Services|NS]] handles ProgramIndex by launching ApplicationId+ProgramIndex. After using [[#ExecuteProgram]] with this successfully, official user-processes will enter an infinite loop with sleep-thread value 86400000000000.
|-
| 1 || [[NCM_services#ApplicationId|ApplicationId]]. "JumpToSubApplicationProgramForDevelopment". Only available when [[Settings_services#GetDebugModeFlag|DebugMode]] is 1.
|-
| 2 || u64 = value 0. "RestartProgram"
|}

ProgramIndex values where the title is not installed should not be used: [[qlaunch]] will display an error message and the current title will become "corrupted", however Home Menu will have an option to repair it.

= InputDetectionPolicy =
This is u32 enum "nn::applet::InputDetectionPolicy".

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || Unknown
|-
| 1 || Unknown
|}

= AppletResourceUserId =
This is "nn::applet::AppletResourceUserId". Used by a number of non-AM services.

= AppletAttribute =
This is "nn::am::AppletAttribute". This struct is 0x80 bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x1 || Flag. When non-zero, two state fields are set to 1.
|-
| 0x1 || 0x7F || Unused
|}

This is used by [[#OpenLibraryAppletProxy]].

= AppletProcessLaunchReason =
This is "nn::am::service::AppletProcessLaunchReason". This struct is 0x4-bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x1 || Flag. When non-zero, LibraryApplets then use [[#OpenCallingLibraryApplet]].
|-
| 0x1 || 0x2 || Always 0.
|-
| 0x3 || 0x1 || Always 0.
|}

= LibraryAppletInfo =
This is "nn::am::service::LibraryAppletInfo". This struct is 0x8-bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || [[#AppletId]]
|-
| 0x4 || 0x4 || [[#LibraryAppletMode]]
|}

= AppletKind =
This is "nn::am::service::AppletKind". This is 8-bytes.

= AppletIdentityInfo =
This struct is "nn::am::service::AppletIdentityInfo". This struct is 0x10-bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || [[#AppletId]]
|-
| 0x4 || 0x4 || Padding
|-
| 0x8 || 0x8 || [[NCM_services#ApplicationId|ApplicationId]]
|}

= ApplicationAttributeForQuest =
This struct is "nn::applet::ApplicationAttributeForQuest".

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || See [[#ApplicationAttribute]].
|-
| 0x4 || 0x4 || See [[#ApplicationAttribute]].
|-
| 0x8 || 0x4 || [7.0.0+] See [[#ApplicationAttribute]].
|}

User-processes copy the first 0x8-bytes (0xC-bytes with [[#CreateApplicationWithAttributeAndPushAndRequestToStartForQuest]]/[[#CreateApplicationWithAttributeAndRequestToStartForQuest]]) to a [[#ApplicationAttribute]] with the rest of the struct being cleared, which is then passed to the actual cmd (CreateApplication*ToStartForQuest).

= ApplicationAttribute =
This struct is "nn::am::ApplicationAttribute". This struct is 0x20-bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || Default is 0 for non-Quest. Only used when non-zero: unknown value in seconds.
|-
| 0x4 || 0x4 || Default is 0 for non-Quest. Only used when non-zero: unknown value in seconds.
|-
| 0x8 || 0x4 || float audio volume. Must be in the range of 0.0f-1.0f. The default is 1.0f.
|-
| 0xC || 0x14 || Unused. Default is 0.
|}

Internally AM only uses the first 0xC-bytes from ApplicationAttribute, regardless of the cmd.

= ApplicationLaunchProperty =
This struct is 0x10-bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || [[NCM_services#ApplicationId|ApplicationId]]
|-
| 0x8 || 0x4 || Application title-version.
|-
| 0xC || 0x1 || [[Filesystem_services#StorageId|StorageId]] for the Application base title.
|-
| 0xD || 0x1 || [[Filesystem_services#StorageId|StorageId]] for the Application update title.
|-
| 0xE || 0x1 || Unknown.
|-
| 0xF || 0x1 || Padding.
|}

= ApplicationLaunchRequestInfo =
This is "nn::applet::ApplicationLaunchRequestInfo". This struct is 0x10-bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || Unknown. The default is 0x0 with [[#CreateSystemApplication]], 0x3 with [[#CreateApplication]].
|-
| 0x4 || 0x4 || Unknown. The default is 0x0 with [[#CreateSystemApplication]], 0x3 with [[#CreateApplication]].
|-
| 0x8 || 0x8 || Unknown. The default is 0x0.
|}

= AppletResourceUsageInfo =
This is "nn::am::service::AppletResourceUsageInfo". This struct is 0x20-bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || Unknown counter.
|-
| 0x4 || 0x4 || Unknown counter.
|-
| 0x8 || 0x4 || Output from [[NS_Services|NS GetRightsEnvironmentCountForDebug]].
|-
| 0xC || 0x14 || Always zero.
|}

= ApplicationLicenseType =
This is "nn::oe::ApplicationLicenseType". This is 1-byte.

= LaunchRequiredVersion =
This is "nn::oe::LaunchRequiredVersion". This is a 0x40-byte struct with 1-byte alignment.

= ServerEnvironmentType =
This is "nn::oe::ServerEnvironmentType".

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || dd
|-
| 1 || lp
|-
| 2 || sd
|-
| 3 || sp
|-
| 4 || dp
|}

= Notes =
AM-sysmodule will only initialize [[Shared_Database_services|pdm:ntfy]] / use pdm:ntfy service commands when the value from [[Process_Manager_services|pm:bm]] GetBootMode is not 0x1 (Maintenance).

An object constructor also writes the output from [[Process_Manager_services|pm:bm]] GetBootMode into the created object. A vfunc for this object checks whether this field is Maintenance: if so, it calls a vfunc then a func and returns. Otherwise after calling various (v)funcs, if required this eventually uses [[OMM_services|ommdisp]] cmd600.

[[Category:Services]]

Applet Manager services

2024-01-06T23:17:58Z

Liamwhite: ILibraryAppletSelfAccessor 160

AM (Applet Manager) provides services for interacting with system applets while abstracting several aspects of power and operation management.

Contains multiple raw images, with at least the following: "NN_OMM_CHARGING_BIN_{begin|end}"(charging icon), low-battery icon, and the Nintendo Switch logo displayed during system boot.

= appletAE =
This is "nn::am::service::IAllSystemAppletProxiesService".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 100 || OpenSystemAppletProxy || Returns an [[#ISystemAppletProxy]].
|-
| 200 || OpenLibraryAppletProxyOld ([1.0.0-2.3.0] OpenLibraryAppletProxy) || Returns an [[#ILibraryAppletProxy]].
|-
| 201 || [3.0.0+] [[#OpenLibraryAppletProxy]] || Returns an [[#ILibraryAppletProxy]].
|-
| 300 || OpenOverlayAppletProxy || Returns an [[#IOverlayAppletProxy]].
|-
| 350 || OpenSystemApplicationProxy || Returns an [[#IApplicationProxy]].
|-
| 400 || [[#CreateSelfLibraryAppletCreatorForDevelop]] ||
|-
| 410 || [6.0.0+] [[#GetSystemAppletControllerForDebug]] ||
|-
| 1000 || [6.0.0+] [[#GetDebugFunctions]] ||
|}

All of these Open*Proxy commands except [[#OpenLibraryAppletProxy]] take the same input as [[#OpenApplicationProxy]], with the same user-process retry-loop as [[#OpenApplicationProxy]]. These Open*Proxy commands (including appletOE) doesn't seem to usable from processes which aren't actual applets (such as sysmodules), at least for applet-types which aren't already in use.

OpenLibraryAppletProxyOld eventually calls the same func as [[#OpenLibraryAppletProxy]], except that the [[#AppletAttribute]] is all-zero.

This service is used by all system non-regular-applications.

The 01000000000010XX system [[Title_list|titles]] use the following applet types(above Open{type}Proxy commands):
* "qlaunch": SystemApplet
* "overlay": OverlayApplet
* "starter": SystemApplication
* "maintenance": SystemApplet
* All others: LibraryApplet

== OpenLibraryAppletProxy ==
Returns an [[#ILibraryAppletProxy]].

Takes a [[IPC_Marshalling|reserved]] input u64(official user-processes use hard-coded value 0), a PID,a process copy-handle(cur-proc handle alias), and a type-0x15 input buffer containing an [[#AppletAttribute]].

Official user-processes use the same retry loop with this as the other Open*Proxy commands.

== CreateSelfLibraryAppletCreatorForDevelop ==
Takes a PID and an input u64 pid_placeholder, returns an [[#ILibraryAppletCreator]].

The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.

The cached value loaded from [[System_Settings|system-setting]] <code>am.debug!dev_function</code> must be set to 0x1 with size 0x1, otherwise an error is returned.

== GetSystemAppletControllerForDebug ==
No input, returns an [[#ISystemAppletControllerForDebug]].

The cached value loaded from [[System_Settings|system-setting]] <code>am.debug!dev_function</code> must be set to 0x1 with size 0x1, and various state checks must pass, otherwise 0 is returned with no output interface.

== GetDebugFunctions ==
No input, returns an [[#IDebugFunctions]].

The cached value loaded from [[System_Settings|system-setting]] <code>am.debug!dev_function</code> must be set to 0x1 with size 0x1, otherwise 0 is returned with no output interface.

== ISystemAppletProxy ==
This is "nn::am::service::ISystemAppletProxy".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || GetCommonStateGetter || Returns an [[#ICommonStateGetter]].
|-
| 1 || GetSelfController || Returns an [[#ISelfController]].
|-
| 2 || GetWindowController || Returns an [[#IWindowController]].
|-
| 3 || GetAudioController || Returns an [[#IAudioController]].
|-
| 4 || GetDisplayController || Returns an [[#IDisplayController]].
|-
| 10 || GetProcessWindingController || Returns an [[#IProcessWindingController]].
|-
| 11 || GetLibraryAppletCreator || Returns an [[#ILibraryAppletCreator]].
|-
| 20 || GetHomeMenuFunctions || Returns an [[#IHomeMenuFunctions]].
|-
| 21 || GetGlobalStateController || Returns an [[#IGlobalStateController]].
|-
| 22 || GetApplicationCreator || Returns an [[#IApplicationCreator]].
|-
| 23 || [7.0.0+] GetAppletCommonFunctions || Returns an [[#IAppletCommonFunctions]].
|-
| 1000 || GetDebugFunctions || Returns an [[#IDebugFunctions]].
|}

=== IHomeMenuFunctions ===
This is "nn::am::service::IHomeMenuFunctions".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 10 || [[#RequestToGetForeground]]
|-
| 11 || [[#LockForeground]]
|-
| 12 || [[#UnlockForeground]]
|-
| 20 || [[#PopFromGeneralChannel]]
|-
| 21 || [[#GetPopFromGeneralChannelEvent]]
|-
| 30 || [[#GetHomeButtonWriterLockAccessor]]
|-
| 31 || [2.0.0+] [[#GetWriterLockAccessorEx]]
|-
| 40 || [11.0.0+] [[#IsSleepEnabled]]
|-
| 41 || [12.0.0+] [[#IsRebootEnabled]]
|-
| 50 || [16.0.0+] [[#LaunchSystemApplet]]
|-
| 51 || [16.0.0+] [[#LaunchStarter]]
|-
| 100 || [6.0.0+] [[#PopRequestLaunchApplicationForDebug]]
|-
| 110 || [9.0.0+] [[#IsForceTerminateApplicationDisabledForDebug]]
|-
| 200 || [8.0.0+] [[#LaunchDevMenu]]
|-
| 1000 || [11.0.0+] [[#SetLastApplicationExitReason]]
|}

==== RequestToGetForeground ====
No input/output.

==== LockForeground ====
No input/output.

==== UnlockForeground ====
No input/output.

==== PopFromGeneralChannel ====
No input, returns an output [[#IStorage]].

==== GetPopFromGeneralChannelEvent ====
No input, returns an output Event handle with autoclear=false.

==== GetHomeButtonWriterLockAccessor ====
No input, returns an output [[#ILockAccessor]].

Similar to using [[#GetWriterLockAccessorEx]] with inval=0.

==== GetWriterLockAccessorEx ====
Takes an input u32, returns an output [[#ILockAccessor]].

The input value must be 0-3. 0 = HomeButton.

==== IsSleepEnabled ====
No input, returns an output bool.

==== IsRebootEnabled ====
No input, returns an output bool.

==== LaunchSystemApplet ====
No input/output.

This wraps [[NS_Services|ns]] LaunchSystemApplet, ignoring the u64 returned by that cmd (and other functionality).

==== LaunchStarter ====
No input/output.

This is similar to [[#LaunchSystemApplet]], except this uses [[NS_Services|ns]] LaunchLibraryApplet with a ProgramId from global state.

The global state field is initialized elsewhere with the value of [[System_Settings|system-setting]] <code>am.debug!starter_id</code>, defaulting to ProgramId 0100000000001012 ([[Title_list|starter]]) if not available.

==== PopRequestLaunchApplicationForDebug ====
Takes a type-0x6 output buffer containing an array of u128 userIDs, returns an output [[NCM_services#ApplicationId|ApplicationId]] and an output s32 '''total_userIDs'''.

The total entries in the userID buffer must be >= {total userIDs in state}.

==== IsForceTerminateApplicationDisabledForDebug ====
No input, returns an output u8 bool.

When the cached value loaded from [[Settings_services#GetDebugModeFlag]] is 0 this will just set the bool to 0. Otherwise, the bool is loaded using data from [[System_Settings|system-setting]] <code>am.debug!disable_force_terminate_application</code>.

==== LaunchDevMenu ====
No input/output.

The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.

Uses [[NS_Services|ns]] LaunchDevMenu.

This is used by [[qlaunch]]. On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.

==== SetLastApplicationExitReason ====
Takes an input s32, no output.

==== ILockAccessor ====
This is "nn::am::service::ILockAccessor".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 1 || [[#TryLock]]
|-
| 2 || [[#Unlock]]
|-
| 3 || [[#GetEvent]]
|-
| 4 || [10.0.0+] [[#IsLocked]]
|}

===== TryLock =====
Takes an input u8 bool flag, returns an output u8 bool flag and a handle.

Official sw waits on the previously loaded event from [[#GetEvent]]. The output flag indicates whether locking was successful, the user-process can try using this cmd again when flag=false.

Official sw only uses inflag=false. Official sw just closes the output handle. The input flag controls whether this returns the output handle.

===== Unlock =====
No input/output.

===== GetEvent =====
No input, returns an output Event handle with autoclear=false.

==== IsLocked ====
No input, returns an output u8 bool.

=== IGlobalStateController ===
This is "nn::am::service::IGlobalStateController".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#RequestToEnterSleep]]
|-
| 1 || [[#EnterSleep]]
|-
| 2 || [[#StartSleepSequence]]
|-
| 3 || [[#StartShutdownSequence]]
|-
| 4 || [[#StartRebootSequence]]
|-
| 9 || [7.0.0+] [[#IsAutoPowerDownRequested]]
|-
| 10 || [[#LoadAndApplyIdlePolicySettings]]
|-
| 11 || [2.0.0+] [[#NotifyCecSettingsChanged]]
|-
| 12 || [3.0.0+] [[#SetDefaultHomeButtonLongPressTime]]
|-
| 13 || [3.0.0+] [[#UpdateDefaultDisplayResolution]]
|-
| 14 || [3.0.0+] [[#ShouldSleepOnBoot]]
|-
| 15 || [4.0.0+] [[#GetHdcpAuthenticationFailedEvent]]
|-
| 30 || [12.0.0+] [[#OpenCradleFirmwareUpdater]]
|}

==== RequestToEnterSleep ====
No input/output.

Stubbed, just returns an error.

==== EnterSleep ====
No input/output.

Stubbed, just returns an error.

==== StartSleepSequence ====
Takes an input u8 bool, no output.

Official sw uses hard-coded input value = 1.

==== StartShutdownSequence ====
No input/output.

==== StartRebootSequence ====
No input/output.

==== IsAutoPowerDownRequested ====
No input, returns an output u8 bool.

Uses [[#idle:sys]] cmd1.

==== LoadAndApplyIdlePolicySettings ====
No input/output.

Uses [[#idle:sys]] cmd LoadAndApplySettings.

==== NotifyCecSettingsChanged ====
No input/output.

Uses [[#omm]] cmd NotifyCecSettingsChanged.

==== SetDefaultHomeButtonLongPressTime ====
Takes an input s64, no output.

==== UpdateDefaultDisplayResolution ====
No input/output.

Uses [[#omm]] cmd UpdateDefaultDisplayResolution.

==== ShouldSleepOnBoot ====
No input, returns an output u8 bool.

Uses [[#omm]] cmd ShouldSleepOnBoot.

==== GetHdcpAuthenticationFailedEvent ====
No input, returns an output Event handle with autoclear=false.

Uses [[#omm]] cmd GetHdcpAuthenticationFailedEvent.

==== OpenCradleFirmwareUpdater ====
No input, returns an [[#ICradleFirmwareUpdater]].

=== ICradleFirmwareUpdater ===
This is "nn::am::service::ICradleFirmwareUpdater".

This was added with [12.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || StartUpdate
|-
| 1 || FinishUpdate
|-
| 2 || [[#GetCradleDeviceInfo]]
|-
| 3 || GetCradleDeviceInfoChangeEvent
|-
| 4 || GetUpdateProgressInfo
|-
| 5 || GetLastInternalResult
|}

==== GetCradleDeviceInfo ====
No input, returns a 8-byte CradleDeviceInfo.

[13.0.0+] Now returns a total of 0xC-bytes.

=== IApplicationCreator ===
This is "nn::am::service::IApplicationCreator".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#CreateApplication]]
|-
| 1 || [[#PopLaunchRequestedApplication]]
|-
| 10 || [[#CreateSystemApplication]]
|-
| 100 || [[#PopFloatingApplicationForDevelopment]]
|}

[[#CreateApplication]]/[[#CreateSystemApplication]] eventually call the same internal func. With [[#CreateApplication]], two ptrs passed to the internal func are NULL, while with [[#CreateSystemApplication]] these are loaded from state. The initial content of [[#ApplicationLaunchRequestInfo]] is all-zero with [[#CreateSystemApplication]], while with [[#CreateApplication]] the first two u32s are value 0x3 with the rest all-zero. The [[#AppletId]] is set to 0x01 with [[#CreateApplication]], while with [[#CreateSystemApplication]] it's 0x04.

==== CreateApplication ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an [[#IApplicationAccessor]].

==== PopLaunchRequestedApplication ====
No input, returns an [[#IApplicationAccessor]].

==== CreateSystemApplication ====
Takes an input [[NCM_services#ApplicationId|SystemApplicationId]], returns an [[#IApplicationAccessor]].

[[qlaunch]] only uses this with a hard-coded id for the "starter" title.

==== PopFloatingApplicationForDevelopment ====
No input, returns an [[#IApplicationAccessor]].

Should not be used if no FloatingApplication is available (svcBreak).

==== IApplicationAccessor ====
This is "nn::am::service::IApplicationAccessor".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#GetAppletStateChangedEvent]] ||
|-
| 1 || [[#IsCompleted]] ||
|-
| 10 || [[#Start]] ||
|-
| 20 || [[#RequestExit]] ||
|-
| 25 || [[#Terminate]] ||
|-
| 30 || [[#GetResult]] ||
|-
| 101 || [[#RequestForApplicationToGetForeground]] ||
|-
| 110 || [[#TerminateAllLibraryApplets]] ||
|-
| 111 || [[#AreAnyLibraryAppletsLeft]] ||
|-
| 112 || [[#GetCurrentLibraryApplet]] ||
|-
| 120 || [[#GetApplicationId]] ||
|-
| 121 || [[#PushLaunchParameter]] ||
|-
| 122 || [[#GetApplicationControlProperty]] ||
|-
| 123 || [2.0.0+] [[#GetApplicationLaunchProperty]] ||
|-
| 124 || [6.0.0+] [[#GetApplicationLaunchRequestInfo]] ||
|-
| 130 || [6.0.0+] [[#SetUsers]] ||
|-
| 131 || [6.0.0+] [[#CheckRightsEnvironmentAvailable]] ||
|-
| 132 || [6.0.0+] [[#GetNsRightsEnvironmentHandle]] ||
|-
| 140 || [6.0.0+] [[#GetDesirableUids]] ||
|-
| 150 || [6.0.0+] [[#ReportApplicationExitTimeout]] ||
|-
| 160 || [8.0.0+] [[#SetApplicationAttribute]] ||
|-
| 170 || [8.0.0+] [[#HasSaveDataAccessPermission]] ||
|-
| 180 || [9.0.0+] [[#PushToFriendInvitationStorageChannel]] ||
|-
| 190 || [9.0.0+] [[#PushToNotificationStorageChannel]] ||
|-
| 200 || [10.0.0+] [[#RequestApplicationSoftReset]] ||
|-
| 201 || [10.0.0+] [[#RestartApplicationTimer]] ||
|}

Commands <=30 are inherited from [[#IAppletAccessor]].

===== RequestForApplicationToGetForeground =====
No input/output.

===== GetCurrentLibraryApplet =====
No input, returns an output [[#IAppletAccessor]].

===== GetApplicationId =====
No input, returns an output [[NCM_services#ApplicationId|ApplicationId]].

===== PushLaunchParameter =====
Takes an input u32 [[#LaunchParameterKind]] and an input [[#IStorage]], no output.

===== GetApplicationControlProperty =====
No input, takes a type-0x6 output buffer.

The output buffer must be at least 0x4000-bytes. Returns an error when the [[#AppletId]] is 0x04, aka when the IApplicationAccessor is for a SystemApplication.

This gets the application [[NACP_Format|control.nacp]].

===== GetApplicationLaunchProperty =====
Takes a type-0x6 output buffer.

The output buffer size must be at least 0x10-bytes. Returns an error when the [[#AppletId]] is 0x04, aka when the IApplicationAccessor is for a SystemApplication.

This gets the [[#ApplicationLaunchProperty]].

===== GetApplicationLaunchRequestInfo =====
No input, returns an output 0x10-byte struct.

This gets the [[#ApplicationLaunchRequestInfo]] from state. The output struct is "nn::applet::ApplicationLaunchRequestInfo".

===== SetUsers =====
Takes an input u8 bool flag and a type-0x5 input buffer containing an array of u128 userIDs.

The total entries for the userIDs must be <=8.

When the input flag is true, this just clears the '''users_available''' state flag to 0 and returns.

===== CheckRightsEnvironmentAvailable =====
No input, returns an output u8 bool.

===== GetNsRightsEnvironmentHandle =====
No input, returns an output u64.

===== GetDesirableUids =====
Takes a type-0x6 output buffer containing an array of u128 userIDs, returns an output s32 '''total_entries'''.

Gets a userID listing, this is unrelated to [[#SetUsers]]. [[qlaunch]] only uses 1 userID with this.

The stored entry-count in state must be <= <size of output buffer in entries>.

===== ReportApplicationExitTimeout =====
No input/output.

===== SetApplicationAttribute =====
Takes a type-0x15 input buffer containing an [[#ApplicationAttribute]], no output.

===== HasSaveDataAccessPermission =====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output u8 bool flag.

Gets whether the savedata specified by the input ApplicationId is accessible. The output flag indicates whether it's accessible.

If the ApplicationId matches the current application, this immediately returns success with flag=1.

===== PushToFriendInvitationStorageChannel =====
Takes an input [[#IStorage]], no output.

Clears the FriendInvitation StorageChannel, then pushes the input storage there.

===== PushToNotificationStorageChannel =====
Takes an input [[#IStorage]], no output.

Clears the Notification StorageChannel, then pushes the input storage there.

[[qlaunch]] will only push data for this when launching the Application when the Alarm was triggered, where the system was previously in sleep-mode. This data is the [[Glue_services|Notification]] ApplicationParameter.

===== RequestApplicationSoftReset =====
No input/output.

===== RestartApplicationTimer =====
No input/output.

===== IAppletAccessor =====
This is "nn::am::service::IAppletAccessor".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#GetAppletStateChangedEvent]]
|-
| 1 || [[#IsCompleted]]
|-
| 10 || [[#Start]]
|-
| 20 || [[#RequestExit]]
|-
| 25 || [[#Terminate]]
|-
| 30 || [[#GetResult]]
|}

==== GetAppletStateChangedEvent ====
No input, returns an output event handle with autoclear=false.

==== IsCompleted ====
No input, returns an output u8 bool.

==== Start ====
No input/output.

==== RequestExit ====
No input/output.

==== Terminate ====
No input/output.

==== GetResult====
No input/output.

== IAppletCommonFunctions ==
This is "nn::am::service::IAppletCommonFunctions".

This was added with [7.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [9.0.0+] [[#SetTerminateResult]]
|-
| 10 || [[#ReadThemeStorage]]
|-
| 11 || [[#WriteThemeStorage]]
|-
| 20 || [9.0.0+] [[#PushToAppletBoundChannel]]
|-
| 21 || [9.0.0+] [[#TryPopFromAppletBoundChannel]]
|-
| 40 || [8.0.0+] [[#GetDisplayLogicalResolution]]
|-
| 42 || [8.0.0+] [[#SetDisplayMagnification]]
|-
| 50 || [8.0.0+] [[#SetHomeButtonDoubleClickEnabled]]
|-
| 51 || [8.0.0+] [[#GetHomeButtonDoubleClickEnabled]]
|-
| 52 || [10.0.0+] [[#IsHomeButtonShortPressedBlocked]]
|-
| 60 || [11.0.0+] [[#IsVrModeCurtainRequired]]
|-
| 61 || [12.0.0+] IsSleepRequiredByHighTemperature
|-
| 62 || [12.0.0+] IsSleepRequiredByLowBattery
|-
| 70 || [11.0.0+] [[#SetCpuBoostRequestPriority]]
|-
| 80 || [14.0.0+] SetHandlingCaptureButtonShortPressedMessageEnabledForApplet
|-
| 81 || [14.0.0+] SetHandlingCaptureButtonLongPressedMessageEnabledForApplet
|-
| 90 || [15.0.0+] OpenNamedChannelAsParent
|-
| 91 || [15.0.0+] OpenNamedChannelAsChild
|-
| 100 || [15.0.0+] SetApplicationCoreUsageMode
|-
| 300 || [17.0.0+]
|}

ReadThemeStorage/WriteThemeStorage: these commands copy data from/to a state buffer and the user specified buffer. The size of the state buffer is 0x400-bytes. The default content of the ThemeStorage prior to using the WriteThemeStorage cmd, is: <code>memset(statebuf, 0xAA, 0x400);</code>

=== ReadThemeStorage ===
Takes an input u64 '''offset''' and a type-0x22 output buffer, returns an output u64 '''actual_transfer_size'''.

=== WriteThemeStorage ===
Takes an input u64 '''offset''' and a type-0x21 input buffer, no output.

=== PushToAppletBoundChannel ===
Takes an input [[#IStorage]], no output.

This is similar to [[#PushToAppletBoundChannelForDebug]] (no DebugMode check), except the used s32 is loaded from elsewhere and must be in the range 31-32.

=== TryPopFromAppletBoundChannel ===
No input, returns an output [[#IStorage]].

This is similar to [[#TryPopFromAppletBoundChannelForDebug]] (no DebugMode check), except the used s32 is loaded from elsewhere and must be in the range 31-32.

=== GetDisplayLogicalResolution ===
No input, returns an output s32 '''width''' and s32 '''height'''.

=== SetDisplayMagnification ===
Takes an input float '''x''', float '''y''', float '''width''', and float '''height''', no output.

Sets the DisplayMagnification. This is essentially layer image crop, for everything non-Overlay.

'''x''' and '''width''' are multiplied with the same width value returned by [[#GetDisplayLogicalResolution]], so these should be in the range 0.0f-1.0f. Likewise for y and height, except these are multipled with the height value.

=== SetHomeButtonDoubleClickEnabled ===
Takes an input u8 bool, no output.

=== GetHomeButtonDoubleClickEnabled ===
No input, returns an output u8 bool.

=== IsHomeButtonShortPressedBlocked ===
No input, returns an output u8 bool.

=== IsVrModeCurtainRequired ===
No input, returns an output bool.

=== SetCpuBoostRequestPriority ===
Takes an input s32, no output.

== ILibraryAppletProxy ==
This is "nn::am::service::ILibraryAppletProxy".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || GetCommonStateGetter || Returns an [[#ICommonStateGetter]].
|-
| 1 || GetSelfController || Returns an [[#ISelfController]].
|-
| 2 || GetWindowController || Returns an [[#IWindowController]].
|-
| 3 || GetAudioController || Returns an [[#IAudioController]].
|-
| 4 || GetDisplayController || Returns an [[#IDisplayController]].
|-
| 10 || GetProcessWindingController || Returns an [[#IProcessWindingController]].
|-
| 11 || GetLibraryAppletCreator || Returns an [[#ILibraryAppletCreator]].
|-
| 20 || OpenLibraryAppletSelfAccessor || Returns an [[#ILibraryAppletSelfAccessor]].
|-
| 21 || [7.0.0+] GetAppletCommonFunctions || No input, returns an [[#IAppletCommonFunctions]].
|-
| 22 || [15.0.0+] GetHomeMenuFunctions || No input, returns an [[#IHomeMenuFunctions]].
|-
| 23 || [15.0.0+] GetGlobalStateController || No input, returns an [[#IGlobalStateController]].
|-
| 1000 || GetDebugFunctions || Returns an [[#IDebugFunctions]].
|}

=== ILibraryAppletSelfAccessor ===
This is "nn::am::service::ILibraryAppletSelfAccessor".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#PopInData]] ||
|-
| 1 || [[#PushOutData]] ||
|-
| 2 || [[#PopInteractiveInData]] ||
|-
| 3 || [[#PushInteractiveOutData]] ||
|-
| 5 || [[#GetPopInDataEvent]] ||
|-
| 6 || [[#GetPopInteractiveInDataEvent]] ||
|-
| 10 || [[#ExitProcessAndReturn]] ||
|-
| 11 || [[#GetLibraryAppletInfo]] ||
|-
| 12 || [[#GetMainAppletIdentityInfo]] ||
|-
| 13 || [[#CanUseApplicationCore]] ||
|-
| 14 || [[#GetCallerAppletIdentityInfo]] ||
|-
| 15 || [2.0.0+] [[#GetMainAppletApplicationControlProperty]] ||
|-
| 16 || [2.0.0+] [[#GetMainAppletStorageId]] ||
|-
| 17 || [3.0.0+] [[#GetCallerAppletIdentityInfoStack]] ||
|-
| 18 || [4.0.0+] [[#GetNextReturnDestinationAppletIdentityInfo]] ||
|-
| 19 || [4.0.0+] [[#GetDesirableKeyboardLayout]] ||
|-
| 20 || [[#PopExtraStorage]] ||
|-
| 25 || [[#GetPopExtraStorageEvent]] ||
|-
| 30 || [[#UnpopInData]] ||
|-
| 31 || [[#UnpopExtraStorage]] ||
|-
| 40 || [2.0.0+] [[#GetIndirectLayerProducerHandle]] ||
|-
| 50 || [3.0.0+] [[#ReportVisibleError]] ||
|-
| 51 || [4.0.0+] [[#ReportVisibleErrorWithErrorContext]] ||
|-
| 60 || [4.0.0+] [[#GetMainAppletApplicationDesiredLanguage]] ||
|-
| 70 || [8.0.0+] [[#GetCurrentApplicationId]] ||
|-
| 80 || [6.0.0+] [[#RequestExitToSelf]] ||
|-
| 90 || [5.0.0+] [[#CreateApplicationAndPushAndRequestToLaunch]] ||
|-
| 100 || [4.0.0+] [[#CreateGameMovieTrimmer]] ||
|-
| 101 || [5.0.0+] [[#ReserveResourceForMovieOperation]] ||
|-
| 102 || [5.0.0+] [[#UnreserveResourceForMovieOperation]] ||
|-
| 110 || [6.0.0+] [[#GetMainAppletAvailableUsers]] ||
|-
| 120 || [9.0.0+] [[#GetLaunchStorageInfoForDebug]] ||
|-
| 130 || [9.0.0+] [[#GetGpuErrorDetectedSystemEvent]] ||
|-
| 140 || [10.0.0+] [[#SetApplicationMemoryReservation]] ||
|-
| 150 || [10.0.0+] [[#ShouldSetGpuTimeSliceManually]] ||
|-
| 160 || [17.0.0+] || [[#Cmd160]]
|}

==== PopInData ====
No input, returns an output [[#IStorage]].

==== PushOutData ====
Takes an input [[#IStorage]], no output.

==== PopInteractiveInData ====
No input, returns an output [[#IStorage]].

==== PushInteractiveOutData ====
Takes an input [[#IStorage]], no output.

==== GetPopInDataEvent ====
No input, returns an output Event handle with autoclear=false.

==== GetPopInteractiveInDataEvent ====
No input, returns an output Event handle with autoclear=false.

==== ExitProcessAndReturn ====
No input/output.

Exits the LibraryApplet and returns to running the title which launched this LibraryApplet ([[qlaunch]] for example).

On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.

==== GetLibraryAppletInfo ====
No input, returns an output [[#LibraryAppletInfo]].

==== GetMainAppletIdentityInfo ====
No input, returns an output [[#AppletIdentityInfo]].

==== CanUseApplicationCore ====
No input, returns an output u8 bool.

==== GetCallerAppletIdentityInfo ====
No input, returns an output [[#AppletIdentityInfo]].

==== GetMainAppletApplicationControlProperty ====
No input, takes a type-0x16 output buffer.

This gets the [[NACP_Format|control.nacp]].

==== GetMainAppletStorageId ====
No input, returns an output u8 storageId.

==== GetCallerAppletIdentityInfoStack ====
Takes a type-0x6 output buffer containing an array of [[#AppletIdentityInfo]], and returns an output s32 total_entries.

==== GetNextReturnDestinationAppletIdentityInfo ====
No input, returns an output [[#AppletIdentityInfo]].

==== GetDesirableKeyboardLayout ====
No input, returns an output u32.

The output u32 is "nn::settings::KeyboardLayout".

This gets the value previously set by [[#SetDesirableKeyboardLayout]]. An error is returned if it's not set.

==== PopExtraStorage ====
No input, returns an output [[#IStorage]].

==== GetPopExtraStorageEvent ====
No input, returns an output Event handle with autoclear=false.

==== UnpopInData ====
Takes an input [[#IStorage]], no output.

==== UnpopExtraStorage ====
Takes an input [[#IStorage]], no output.

==== GetIndirectLayerProducerHandle ====
No input, returns an output u64.

==== ReportVisibleError ====
Takes an input [[Error_Applet#ErrorCode|ErrorCode]], no output.

==== ReportVisibleErrorWithErrorContext ====
Takes an input [[Error_Applet#ErrorCode|ErrorCode]] and a type-0x15 input buffer containing an [[Error_Applet#ErrorContext|ErrorContext]], no output.

==== GetMainAppletApplicationDesiredLanguage ====
No input, returns an output [[Settings_services#LanguageCode|LanguageCode]].

==== GetCurrentApplicationId ====
No input, returns an output [[NCM_services#ApplicationId|ApplicationId]].

Gets the [[NCM_services#ApplicationId|ApplicationId]] for the currently running Application. ApplicationId=0 when no Application is running.

==== RequestExitToSelf ====
No input/output.

Same as [[#RequestExit]] except this is for the current applet.

==== CreateApplicationAndPushAndRequestToLaunch ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]] and an input #IStorage, no output.

This is is similar to [[#CreateApplicationAndPushAndRequestToStart]].

==== CreateGameMovieTrimmer ====
Takes an input u64 size and a TransferMemory handle, returns a GRC [[GRC_services#IGameMovieTrimmer|IGameMovieTrimmer]].

This is a wrapper for GRC [[GRC_services#OpenGameMovieTrimmer|OpenGameMovieTrimmer]].

Official sw uses an user-buffer for the tmem, with permissions=0.

==== ReserveResourceForMovieOperation ====
No input/output.

Updates state fields. This must be used before [[#CreateGameMovieTrimmer]].

==== UnreserveResourceForMovieOperation ====
No input/output.

Updates state fields. This must be used once finished with [[GRC_services#IGameMovieTrimmer|IGameMovieTrimmer]].

==== GetMainAppletAvailableUsers ====
Takes a type-0x6 output buffer containing an array of u128 userIDs, returns an output u8 bool and a s32 '''total_entries'''.

This gets the userIDs previously set by [[#SetUsers]].

The size of the output buffer in entries must be at least 8.

Normally the output bool is set to 0, however when no users are available it's set to 1 with '''total_entries''' = -1.

==== SetApplicationMemoryReservation ====
Takes an input u64, no output.

An Application must be currently running. The input u64 must be 0x1000-byte aligned.

==== ShouldSetGpuTimeSliceManually ====
No input, returns an output u8 bool.

==== Cmd160 ====
No input, returns an output u64. Currently always returns 0.

== IOverlayAppletProxy ==
This is "nn::am::service::IOverlayAppletProxy".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || GetCommonStateGetter || Returns an [[#ICommonStateGetter]].
|-
| 1 || GetSelfController || Returns an [[#ISelfController]].
|-
| 2 || GetWindowController || Returns an [[#IWindowController]].
|-
| 3 || GetAudioController || Returns an [[#IAudioController]].
|-
| 4 || GetDisplayController || Returns an [[#IDisplayController]].
|-
| 10 || GetProcessWindingController || Returns an [[#IProcessWindingController]].
|-
| 11 || GetLibraryAppletCreator || Returns an [[#ILibraryAppletCreator]].
|-
| 20 || GetOverlayFunctions || Returns an [[#IOverlayFunctions]].
|-
| 21 || [7.0.0+] GetAppletCommonFunctions || No input, returns an [[#IAppletCommonFunctions]].
|-
| 23 || [15.0.0+] GetGlobalStateController || No input, returns an [[#IGlobalStateController]].
|-
| 1000 || GetDebugFunctions || Returns an [[#IDebugFunctions]].
|}

=== IOverlayFunctions ===
This is "nn::am::service::IOverlayFunctions".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#BeginToWatchShortHomeButtonMessage]]
|-
| 1 || [[#EndToWatchShortHomeButtonMessage]]
|-
| 2 || [[#GetApplicationIdForLogo]]
|-
| 3 || [[#SetGpuTimeSliceBoost]]
|-
| 4 || [2.0.0+] [[#SetAutoSleepTimeAndDimmingTimeEnabled]]
|-
| 5 || [2.0.0+] [[#TerminateApplicationAndSetReason]]
|-
| 6 || [3.0.0+] [[#SetScreenShotPermissionGlobally]]
|-
| 10 || [6.0.0+] [[#StartShutdownSequenceForOverlay]]
|-
| 11 || [6.0.0+] [[#StartRebootSequenceForOverlay]]
|-
| 20 || [8.0.0+] [[#SetHandlingHomeButtonShortPressedEnabled]]
|-
| 21 || [14.0.0+] SetHandlingTouchScreenInputEnabled
|-
| 30 || [9.0.0+] [[#SetHealthWarningShowingState]]
|-
| 31 || [10.0.0+] [[#IsHealthWarningRequired]]
|-
| 90 || [7.0.0+] [[#SetRequiresGpuResourceUse]]
|-
| 101 || [5.0.0+] [[#BeginToObserveHidInputForDevelop]]
|}

==== BeginToWatchShortHomeButtonMessage ====
No input/output.

==== EndToWatchShortHomeButtonMessage ====
No input/output.

==== GetApplicationIdForLogo ====
No input, returns an output [[NCM_services#ApplicationId|ApplicationId]].

Gets the ApplicationId for displaying the logo screen during application launch.

When no application is running, this returns success with ApplicationId=0.

==== SetGpuTimeSliceBoost ====
Takes an input u64, no output.

==== SetAutoSleepTimeAndDimmingTimeEnabled ====
Takes an input u8 bool, no output.

==== TerminateApplicationAndSetReason ====
Takes an input u32 Result, no output.

==== SetScreenShotPermissionGlobally ====
Takes an input u8 bool, no output.

==== StartShutdownSequenceForOverlay ====
No input/output.

On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.

==== StartRebootSequenceForOverlay ====
No input/output.

On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.

==== SetHandlingHomeButtonShortPressedEnabled ====
Takes an input u8 bool, no output.

==== SetHealthWarningShowingState ====
Takes an input u8 bool, no output.

This writes the input bool into state, signals an Event, and returns 0.

==== IsHealthWarningRequired ====
No input, returns an output u8 bool.

==== SetRequiresGpuResourceUse ====
Takes an input u8 bool, no output.

Just returns 0.

==== BeginToObserveHidInputForDevelop ====
No input/output.

Sets various state fields and signals an userspace-event.

Enables HID input for the OverlayApplet, without disabling input for the foreground applet.

== IApplicationProxy ==
This is "nn::am::service::IApplicationProxy".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || GetCommonStateGetter || Returns an [[#ICommonStateGetter]].
|-
| 1 || GetSelfController || Returns an [[#ISelfController]].
|-
| 2 || GetWindowController || Returns an [[#IWindowController]].
|-
| 3 || GetAudioController || Returns an [[#IAudioController]].
|-
| 4 || GetDisplayController || Returns an [[#IDisplayController]].
|-
| 10 || GetProcessWindingController || Returns an [[#IProcessWindingController]].
|-
| 11 || GetLibraryAppletCreator || Returns an [[#ILibraryAppletCreator]].
|-
| 20 || GetApplicationFunctions || Returns an [[#IApplicationFunctions]].
|-
| 1000 || GetDebugFunctions || Returns an [[#IDebugFunctions]].
|}

=== IApplicationFunctions ===
This is "nn::am::service::IApplicationFunctions".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 1 || [[#PopLaunchParameter]]
|-
| 10 || [[#CreateApplicationAndPushAndRequestToStart]]
|-
| 11 || [3.0.0+] [[#CreateApplicationAndPushAndRequestToStartForQuest]]
|-
| 12 || [4.0.0+] [[#CreateApplicationAndRequestToStart]]
|-
| 13 || [4.0.0+] [[#CreateApplicationAndRequestToStartForQuest]]
|-
| 14 || [7.0.0+] [[#CreateApplicationWithAttributeAndPushAndRequestToStartForQuest]]
|-
| 15 || [7.0.0+] [[#CreateApplicationWithAttributeAndRequestToStartForQuest]]
|-
| 20 || [[#EnsureSaveData]]
|-
| 21 || [[#GetDesiredLanguage]]
|-
| 22 || [[#SetTerminateResult]]
|-
| 23 || [[#GetDisplayVersion]]
|-
| 24 || [2.0.0+] [[#GetLaunchStorageInfoForDebug]]
|-
| 25 || [3.0.0+] ExtendSaveData
|-
| 26 || [3.0.0+] GetSaveDataSize
|-
| 27 || [5.0.0+] CreateCacheStorage
|-
| 28 || [11.0.0+] [[#GetSaveDataSizeMax]]
|-
| 29 || [11.0.0+] [[#GetCacheStorageMax]]
|-
| 30 || [[#BeginBlockingHomeButtonShortAndLongPressed]]
|-
| 31 || [[#EndBlockingHomeButtonShortAndLongPressed]]
|-
| 32 || [[#BeginBlockingHomeButton]]
|-
| 33 || [[#EndBlockingHomeButton]]
|-
| 34 || [10.0.0-15.0.1] [[#SelectApplicationLicense]]
|-
| 35 || [11.0.0+] [[#GetDeviceSaveDataSizeMax]]
|-
| 36 || [14.0.0+] GetLimitedApplicationLicense
|-
| 37 || [14.0.0+] GetLimitedApplicationLicenseUpgradableEvent
|-
| 40 || [[#NotifyRunning]]
|-
| 50 || [2.0.0+] [[#GetPseudoDeviceId]]
|-
| 60 || [2.0.0+] [[#SetMediaPlaybackStateForApplication]]
|-
| 65 || [3.0.0+] [[#IsGamePlayRecordingSupported]]
|-
| 66 || [3.0.0+] [[#InitializeGamePlayRecording]]
|-
| 67 || [3.0.0+] [[#SetGamePlayRecordingState]]
|-
| 68 || [4.0.0+] [[#RequestFlushGamePlayingMovieForDebug]]
|-
| 70 || [3.0.0+] [[#RequestToShutdown]]
|-
| 71 || [3.0.0+] [[#RequestToReboot]]
|-
| 72 || [10.0.0+] [[#RequestToSleep]]
|-
| 80 || [4.0.0+] [[#ExitAndRequestToShowThanksMessage]]
|-
| 90 || [4.0.0+] [[#EnableApplicationCrashReport]]
|-
| 100 || [5.0.0+] [[#InitializeApplicationCopyrightFrameBuffer]]
|-
| 101 || [5.0.0+] [[#SetApplicationCopyrightImage]]
|-
| 102 || [5.0.0+] [[#SetApplicationCopyrightVisibility]]
|-
| 110 || [5.0.0+] [[#QueryApplicationPlayStatistics]]
|-
| 111 || [6.0.0+] [[#QueryApplicationPlayStatisticsByUid]]
|-
| 120 || [5.0.0+] [[#ExecuteProgram]]
|-
| 121 || [5.0.0+] [[#ClearUserChannel]]
|-
| 122 || [5.0.0+] [[#UnpopToUserChannel]]
|-
| 123 || [5.0.0+] [[#GetPreviousProgramIndex]]
|-
| 124 || [6.0.0+] [[#EnableApplicationAllThreadDumpOnCrash]]
|-
| 130 || [8.0.0+] [[#GetGpuErrorDetectedSystemEvent]]
|-
| 131 || [11.0.0+] [[#SetDelayTimeToAbortOnGpuError]]
|-
| 140 || [9.0.0+] [[#GetFriendInvitationStorageChannelEvent]]
|-
| 141 || [9.0.0+] [[#TryPopFromFriendInvitationStorageChannel]]
|-
| 150 || [9.0.0+] [[#GetNotificationStorageChannelEvent]]
|-
| 151 || [9.0.0+] [[#TryPopFromNotificationStorageChannel]]
|-
| 160 || [9.0.0+] [[#GetHealthWarningDisappearedSystemEvent]]
|-
| 170 || [9.0.0+] [[#SetHdcpAuthenticationActivated]]
|-
| 180 || [10.1.0+] [[#GetLaunchRequiredVersion]]
|-
| 181 || [10.1.0+] [[#UpgradeLaunchRequiredVersion]]
|-
| 190 || [11.0.0+] [[#SendServerMaintenanceOverlayNotification]]
|-
| 200 || [11.0.0+] [[#GetLastApplicationExitReason]]
|-
| 500 || [5.0.0+] [[#StartContinuousRecordingFlushForDebug]]
|-
| 1000 || [5.0.0+] [[#CreateMovieMaker]]
|-
| 1001 || [5.0.0+] [[#PrepareForJit]]
|}

The BOTW game uses this GamePlayRecording functionality from the main-nso "nninitStartup" function, with size 0x6000000(96MiB). The official GamePlayRecording-enable code does the following(this will panic on any failure):
* [[SVC|Creates]] TransferMemory using the input buffer and size, with permissions=0.
* Uses [[#InitializeGamePlayRecording]] with the TransferMemory.
* Closes the TransferMemory handle, + TransferMemory cleanup.
* Uses [[#SetGamePlayRecordingState]] with value 0x1.
This GamePlayRecording functionality presumably enables the video-recording usable starting with [[4.0.0]].

==== PopLaunchParameter ====
Takes an input u32 [[#LaunchParameterKind]], returns an output [[#IStorage]].

Pops a LaunchParameter [[#IStorage]], the storage will be removed from sysmodule state during this.

==== CreateApplicationAndPushAndRequestToStart ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]] and an input [[#IStorage]], no output. ApplicationId=0 can be used to relaunch the current application.

==== CreateApplicationAndPushAndRequestToStartForQuest ====
Takes 2 input u32s (loaded from struct [[#ApplicationAttributeForQuest]]), an input [[NCM_services#ApplicationId|ApplicationId]], and an input [[#IStorage]], no output.

==== CreateApplicationAndRequestToStart ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output.

Same as [[#CreateApplicationAndPushAndRequestToStart]] except without the input storage, official sw uses this when no input storage is specified.

==== CreateApplicationAndRequestToStartForQuest ====
Takes 2 input u32s (loaded from struct [[#ApplicationAttributeForQuest]]) and an input [[NCM_services#ApplicationId|ApplicationId]], no output.

Same as [[#CreateApplicationAndPushAndRequestToStartForQuest]] except without the input storage, official sw uses this when no input storage is specified.

==== CreateApplicationWithAttributeAndPushAndRequestToStartForQuest ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], a type-0x15 input buffer containing an [[#ApplicationAttribute]], an input [[#IStorage]], no output.

Same as [[#CreateApplicationAndPushAndRequestToStartForQuest]] except the entire attributes structure is directly specified via the input buffer. This command replaces [[#CreateApplicationAndPushAndRequestToStartForQuest]], official user-processes no longer use [[#CreateApplicationAndPushAndRequestToStartForQuest]].

==== CreateApplicationWithAttributeAndRequestToStartForQuest ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]] and a type-0x15 input buffer containing an [[#ApplicationAttribute]], no output.

Same as [[#CreateApplicationAndRequestToStartForQuest]] except the entire attributes structure is directly specified via the input buffer. This command replaces [[#CreateApplicationAndRequestToStartForQuest]], official user-processes no longer use [[#CreateApplicationAndPushAndRequestToStartForQuest]].

==== EnsureSaveData ====
Takes an input u128 userID, returns an output u64 size.

Calls sdk func <code>nn::fs::EnsureApplicationSaveData</code>. [[qlaunch]] also calls this same sdk func directly.

Creates the various savedata as specified by the application [[NACP_Format|control.nacp]] when the savedata doesn't exist.

Official user-processes launch the dataErase LibraryApplet depending on the Result, the above output size is used with this.

==== GetDesiredLanguage ====
No input, returns an output [[Settings_services#LanguageCode|LanguageCode]].

==== SetTerminateResult ====
Takes an input u32 '''Result''', no output.

For example, in some cases official apps use this with [[Error_codes|error]] 0x2A2 then uses svcBreak.

==== GetDisplayVersion ====
No input, returns an output 0x10-byte struct.

The output struct is "nn::oe::DisplayVersion". This the DisplayVersion string copied from the application [[NACP_Format|control.nacp]], this is always NUL-terminated.

==== GetLaunchStorageInfoForDebug ====
No input, returns an output u8 [[Filesystem_services#StorageId|StorageId]] and u8 [[Filesystem_services#StorageId|StorageId]].

This returns two u8s loaded from state, these are the same StorageIds from [[#ApplicationLaunchProperty]].

==== GetSaveDataSizeMax ====
No input, returns two ouput s64s.

==== GetCacheStorageMax ====
No input, returns an output s32 and s64.

==== BeginBlockingHomeButtonShortAndLongPressed ====
Takes an input s64, no output.

Official user-processes use hard-coded value 0 for the s64.

Starts blocking the Home button.

==== EndBlockingHomeButtonShortAndLongPressed ====
No input/output.

Ends the blocking started by [[#BeginBlockingHomeButtonShortAndLongPressed]].

==== BeginBlockingHomeButton ====
Takes an input s64 nanoseconds, no output. The input nanoseconds can be zero.

==== EndBlockingHomeButton ====
No input/output.

==== SelectApplicationLicense ====
Takes an input array of [[#ApplicationLicenseType]], returns an output [[#ApplicationLicenseType]].

==== GetDeviceSaveDataSizeMax ====
No input, returns two output s64s.

==== NotifyRunning ====
Takes no input. Returns an output u8 bool, which is ignored by official user-processes.

==== GetPseudoDeviceId ====
No input, returns an output 0x10-byte "nn::util::Uuid" struct.

The 0x20-byte output data from [[NS_Services|GetSystemSeedForPseudoDeviceId]] followed by the 8-byte [[NACP_Format|SeedForPseudoDeviceId]] from the current control.nacp, is hashed with SHA1. Then "nn::util::GenerateUuidVersion5" is called with the final hash, the output from this is then returned for the Uuid.

==== SetMediaPlaybackStateForApplication ====
Takes an input u8 bool, no output.

==== IsGamePlayRecordingSupported ====
No input, returns an output u8 bool.

==== InitializeGamePlayRecording ====
Takes a TransferMemory handle and an u64 for the size of the TransferMemory. The size must match 0x6000000 otherwise an error is returned.

==== SetGamePlayRecordingState ====
Takes an input u32. 0 = disable/pause, 1 = enable/restart.

==== RequestFlushGamePlayingMovieForDebug ====
No input/output.

Requests to save the video recording, as if the Capture-button was held.

==== RequestToShutdown ====
No input/output.

On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.

==== RequestToReboot ====
No input/output.

On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.

==== RequestToSleep ====
No input/output.

==== ExitAndRequestToShowThanksMessage ====
No input/output.

Used to exit the application and return to the kiosk menu. Official sw uses [[#UnlockExit]] immediately before this if needed.

On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.

This throws an error when the cached [[Settings_services#GetQuestFlag]] value is 0.

==== EnableApplicationCrashReport ====
Takes an input u8 bool, no output.

==== InitializeApplicationCopyrightFrameBuffer ====
Takes an input TransferMemory handle, an s32 '''width''', an s32 '''height''', an u64 tmem_size, and no output.

tmem_size must be 0x40000-byte aligned. '''width''' must be 1-1280, and '''height''' must be 1-720.

User-processes create the tmem with an user-specified buffer with permissions=0. '''width''' = 1280 and '''height''' = 720.

After the validation checks pass the input is passed to [[OMM_services|ommdisp]] cmd500.

This is used as an overlay for screenshots.

==== SetApplicationCopyrightImage ====
Takes a type-0x45 input buffer, an s32 '''x''', an s32 '''y''', an s32 '''width''', an s32 '''height''', an s32 [[#WindowOriginMode]], and no output.

'''x''' and '''y''' must not have the negative bit set. '''width''' and '''height''' must not be <1.

Sets the RGBA8 image for use with [[#InitializeApplicationCopyrightFrameBuffer]]. Overrides the current image, if this was already used previously.

==== SetApplicationCopyrightVisibility ====
Takes an input u8 bool, no output.

Sets the visibility for the image set by [[#SetApplicationCopyrightImage]], in screenshots. By default it's visible.

==== QueryApplicationPlayStatistics ====
Takes a type-0x6 output buffer containing an array of [[Shared_Database_services|ApplicationPlayStatistics]] and a type-0x5 input buffer containing an array of [[NCM_services#ApplicationId|ApplicationId]]. Returns an output s32 for actual total output entries.

The number of entries in each array is the same.

See also [[NACP_Format#PlayLogQueryCapability|PlayLogQueryCapability]].

This uses [[Shared_Database_services|pdm:qry]] QueryApplicationPlayStatisticsForSystem.

==== QueryApplicationPlayStatisticsByUid ====
Takes a u128 userID, a type-0x6 output buffer containing an array of [[Shared_Database_services|ApplicationPlayStatistics]] and a type-0x5 input buffer containing an array of [[NCM_services#ApplicationId|ApplicationId]]. Returns an output s32 for actual total output entries.

Same as [[#QueryApplicationPlayStatistics]] except this uses [[Shared_Database_services|pdm:qry]] cmd16, to get playstats specific to userIDs.

==== ExecuteProgram ====
Takes an input u32 [[#ProgramSpecifyKind]] and an input u64, no output.

==== ClearUserChannel ====
No input/output.

Clears the UserChannel used by [[#UnpopToUserChannel]].

==== UnpopToUserChannel ====
Takes an input [[#IStorage]], no output.

The input storage is pushed to the UserChannel. This is the same channel used by [[#LaunchParameterKind]] value 1.

User-processes create a storage using data specified by the user (written to offset=0 size=inputsize), with max size 0x1000. This storage is then used with this cmd.

==== GetPreviousProgramIndex ====
No input, returns an output s32.

Gets the ProgramIndex of the Application which launched this title. The output ProgramIndex is -1 when there was no previous title.

==== EnableApplicationAllThreadDumpOnCrash ====
Takes an input u8 bool, no output.

==== GetGpuErrorDetectedSystemEvent ====
No input, returns an output Event handle with autoclear=false.

This is used by sdknso during applet-application initialization. A separate thread is setup where event-waiting is handled. When the Event is signaled, official sw will Abort.

==== SetDelayTimeToAbortOnGpuError ====
Takes an input s64 "nn::TimeSpan", no output.

==== GetFriendInvitationStorageChannelEvent ====
No input, returns an output Event handle with EventClearMode=0.

This is exposed by sdknso under <code>nn::friends::</code>. This returns a ptr to the cached Event in global state, with the Event being loaded if not previously initialized.

==== TryPopFromFriendInvitationStorageChannel ====
No input, returns an output [[#IStorage]].

This uses the same StorageChannel as [[#PushToFriendInvitationStorageChannel]].

This is exposed by sdknso under <code>nn::friends::</code>. When the storage_size is <0x10, this returns false. <code>data_size = storage_size-0x10;</code> Then the first 0x10-bytes from storage are read to stack, which is later copied to the output Uid on success prior to returning. Then the storage is read into the specified output buffer with storage-offset 0x10, where the size is <code>size = data_size > buf_size ? buf_size : data_size</code>. Reading is skipped if size is zero. Afterwards the used size is written to an output param. On success, true is returned.

==== GetNotificationStorageChannelEvent ====
No input, returns an output Event handle with EventClearMode=0.

This is exposed by sdknso under <code>nn::notification::</code>. This returns a ptr to the cached Event in global state, with the Event being loaded if not previously initialized.

==== TryPopFromNotificationStorageChannel ====
No input, returns an output [[#IStorage]].

This uses the same StorageChannel as [[#PushToNotificationStorageChannel]].

This is exposed by sdknso under <code>nn::notification::</code>. The storage is read into the specified output buffer, where the size is <code>size = storage_size > buf_size ? buf_size : storage_size</code>. Reading is skipped if size is zero. Afterwards the used size is written to an output param.

==== GetHealthWarningDisappearedSystemEvent ====
No input, returns an output Event with EventClearMode=0.

==== SetHdcpAuthenticationActivated ====
Takes an input u8 bool, no output.

==== GetLaunchRequiredVersion ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], an u64, returns an output [[#LaunchRequiredVersion]].

sdknso passes hard-coded value 0 for the u64.

==== UpgradeLaunchRequiredVersion ====
Takes an input [[#LaunchRequiredVersion]], an [[NCM_services#ApplicationId|ApplicationId]], an u64, no output.

sdknso passes hard-coded value 0 for the u64.

==== SendServerMaintenanceOverlayNotification ====
Takes two input [[PCV_services#PosixTime|PosixTime]], no output.

The second input value can optionally be 0.

==== GetLastApplicationExitReason ====
No input, returns an output s32.

==== StartContinuousRecordingFlushForDebug ====
Takes an input s64 nanoseconds-value, returns an output Event handle with autoclear=false.

The cached value loaded from [[System_Settings|system-setting]] <code>am.debug!dev_function</code> must be set to 0x1 with size 0x1, otherwise an error is returned.

==== CreateMovieMaker ====
Takes an input u64 size and a TransferMemory handle, returns an [[#IMovieMaker]].

Official sw retries using the cmd in a loop on error 0x8D4 with svcSleepThread(100000000) being used first.

Official sw uses permissions=None for the TransferMemory, with an user-specified buffer. The size of the buffer used by official sw is 0x6000000.

==== PrepareForJit ====
Takes no input. Launches the [[JIT_services|jit-sysmodule]] via [[NS_Services|ns]] LaunchLibraryApplet if it has not already been launched for the current application, storing a std::shared_ptr<> for jit-sysmodule process tracking object as an IApplicationFunctions member.

~IApplicationFunctions() includes:

if (this->jit_process) {
Terminate(this->jit_process);
this->jit_process = nullptr;
}

Thus the lifetime of the jit sysmodule is tied to the application which uses it, and each application gets its own fresh copy of the jit sysmodule.

AM can also optionally launch jit-sysmodule automatically if the [[NACP]] enables it.

=== IMovieMaker ===
This is "nn::am::service::IMovieMaker".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#GetGrcMovieMaker]]
|-
| 1 || [[#GetLayerHandle]]
|}

==== GetGrcMovieMaker ====
No input, returns a GRC [[GRC_services|IMovieMaker]].

==== GetLayerHandle ====
No input, returns an output u64.

== ILibraryAppletCreator ==
This is "nn::am::service::ILibraryAppletCreator".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#CreateLibraryApplet]] ||
|-
| 1 || [[#TerminateAllLibraryApplets]] ||
|-
| 2 || [[#AreAnyLibraryAppletsLeft]] ||
|-
| 10 || [[#CreateStorage]] ||
|-
| 11 || [[#CreateTransferMemoryStorage]] ||
|-
| 12 || [2.0.0+] [[#CreateHandleStorage]] ||
|}

=== CreateLibraryApplet ===
Takes 2 input u32s [[#AppletId]] and [[#LibraryAppletMode]], returns an [[#ILibraryAppletAccessor]].

=== TerminateAllLibraryApplets ===
No input/output.

Stubbed with an ILibraryAppletCreator from [[#CreateSelfLibraryAppletCreatorForDevelop]], just returns an error.

Terminates all LibraryApplets which were created by the current applet (or by the Application when used from the [[#IApplicationAccessor]] cmd).

=== AreAnyLibraryAppletsLeft ===
No input, returns an output u8 bool.

Stubbed with an ILibraryAppletCreator from [[#CreateSelfLibraryAppletCreatorForDevelop]], just returns an error.

Gets whether any LibraryApplets ([[#ILibraryAppletAccessor]]) which were created by the current applet are still open (or by the Application when used from the [[#IApplicationAccessor]] cmd).

=== CreateStorage ===
Takes an input s64 for the storage size, returns an [[#IStorage]].

This allocates a buffer with the specified size which can then be accessed via [[#IStorageAccessor]].

=== CreateTransferMemoryStorage ===
Takes an input TransferMemory copy-handle, an input u8 bool, and an s64 size, returns an [[#IStorage]].

The user-process creates the TransferMemory with permissions=0.

The TransferMemory is mapped, which can then be accessed via [[#IStorageAccessor]]. The input bool controls whether writing to the storage is allowed: [[#Write]] will throw an error if this flag is not set.

=== CreateHandleStorage ===
Takes an input copy-handle and an input s64, returns an [[#IStorage]]. In some cases the s64 must not have the negative bit set.

The input can be arbitrary, however official sw is only (?) known to use this for TransferMemory (with s64=size).

=== ILibraryAppletAccessor ===
This is "nn::am::service::ILibraryAppletAccessor".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#GetAppletStateChangedEvent]] ||
|-
| 1 || [[#IsCompleted]] ||
|-
| 10 || [[#Start]] ||
|-
| 20 || [[#RequestExit]] ||
|-
| 25 || [[#Terminate]] ||
|-
| 30 || [[#GetResult]] ||
|-
| 50 || [[#SetOutOfFocusApplicationSuspendingEnabled]] ||
|-
| 60 || [10.0.0+] [[#PresetLibraryAppletGpuTimeSliceZero]] ||
|-
| 100 || [[#PushInData]] ||
|-
| 101 || [[#PopOutData]] ||
|-
| 102 || [[#PushExtraStorage]] ||
|-
| 103 || [[#PushInteractiveInData]] ||
|-
| 104 || [[#PopInteractiveOutData]] ||
|-
| 105 || [[#GetPopOutDataEvent]] ||
|-
| 106 || [[#GetPopInteractiveOutDataEvent]] ||
|-
| 110 || [[#NeedsToExitProcess]] ||
|-
| 120 || [[#GetLibraryAppletInfo]] ||
|-
| 150 || [[#RequestForAppletToGetForeground]] ||
|-
| 160 || [2.0.0+] [[#GetIndirectLayerConsumerHandle]] ||
|}

Commands <=30 are inherited from [[#IAppletAccessor]]. GetLibraryAppletInfo is identical to the [[#ILibraryAppletSelfAccessor]] cmd.

==== SetOutOfFocusApplicationSuspendingEnabled ====
Takes an input u8 bool, no output.

Official sw will assert prior to using this if applet-service was not initialized as *Application.

==== PresetLibraryAppletGpuTimeSliceZero ====
No input/output.

sdknso only uses with with [[Software_Keyboard|swkbd-inline]], immediately after creating the LibraryApplet.

==== PushInData ====
Takes an input [[#IStorage]], no output.

==== PopOutData ====
No input, returns an output [[#IStorage]].

==== PushExtraStorage ====
Takes an input [[#IStorage]], no output.

==== PushInteractiveInData ====
Takes an input [[#IStorage]], no output.

==== PopInteractiveOutData ====
No input, returns an output [[#IStorage]].

==== GetPopOutDataEvent ====
No input, returns an output handle with autoclear=false.

==== GetPopInteractiveOutDataEvent ====
No input, returns an output event handle with autoclear=false.

==== NeedsToExitProcess ====
No input, returns an output u8 bool.

Stubbed, just returns an error.

==== RequestForAppletToGetForeground ====
No input/output.

Stubbed, just returns an error.

==== GetIndirectLayerConsumerHandle ====
Takes an input PID and an input u64 AppletResourceUserId, returns an output u64 IndirectLayerConsumerHandle.

Official sw uses this during LibraryApplet creation when [[#LibraryAppletMode]] is 0x3.

== ICommonStateGetter ==
This is "nn::am::service::ICommonStateGetter".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#GetEventHandle]]
|-
| 1 || [[#ReceiveMessage]]
|-
| 2 || [[#GetThisAppletKind]]
|-
| 3 || [[#AllowToEnterSleep]]
|-
| 4 || [[#DisallowToEnterSleep]]
|-
| 5 || [[#GetOperationMode]]
|-
| 6 || [[#GetPerformanceMode]]
|-
| 7 || [[#GetCradleStatus]]
|-
| 8 || [[#GetBootMode]]
|-
| 9 || [[#GetCurrentFocusState]]
|-
| 10 || [[#RequestToAcquireSleepLock]]
|-
| 11 || [[#ReleaseSleepLock]]
|-
| 12 || [[#ReleaseSleepLockTransiently]]
|-
| 13 || [[#GetAcquiredSleepLockEvent]]
|-
| 14 || [11.0.0+] [[#GetWakeupCount]]
|-
| 20 || [[#PushToGeneralChannel]]
|-
| 30 || [[#GetHomeButtonReaderLockAccessor]]
|-
| 31 || [2.0.0+] [[#GetReaderLockAccessorEx]]
|-
| 32 || [7.0.0+] [[#GetWriterLockAccessorEx]]
|-
| 40 || [2.0.0+] [[#GetCradleFwVersion]]
|-
| 50 || [3.0.0+] [[#IsVrModeEnabled]]
|-
| 51 || [3.0.0+] [[#SetVrModeEnabled]]
|-
| 52 || [4.0.0+] [[#SetLcdBacklighOffEnabled]]
|-
| 53 || [7.0.0+] [[#BeginVrModeEx]]
|-
| 54 || [7.0.0+] [[#EndVrModeEx]]
|-
| 55 || [3.0.0+] [[#IsInControllerFirmwareUpdateSection]]
|-
| 59 || [11.0.0+] [[#SetVrPositionForDebug]]
|-
| 60 || [3.0.0+] [[#GetDefaultDisplayResolution]]
|-
| 61 || [3.0.0+] [[#GetDefaultDisplayResolutionChangeEvent]]
|-
| 62 || [4.0.0+] [[#GetHdcpAuthenticationState]]
|-
| 63 || [4.0.0+] [[#GetHdcpAuthenticationStateChangeEvent]]
|-
| 64 || [5.0.0+] [[#SetTvPowerStateMatchingMode]]
|-
| 65 || [5.1.0+] [[#GetApplicationIdByContentActionName]]
|-
| 66 || [6.0.0+] [[#SetCpuBoostMode]]
|-
| 67 || [10.0.0+] [[#CancelCpuBoostMode]]
|-
| 68 || [11.0.0+] [[#GetBuiltInDisplayType]]
|-
| 80 || [6.0.0+] [[#PerformSystemButtonPressingIfInFocus]]
|-
| 90 || [7.0.0+] [[#SetPerformanceConfigurationChangedNotification]]
|-
| 91 || [7.0.0+] [[#GetCurrentPerformanceConfiguration]]
|-
| 100 || [9.1.0+] [[#SetHandlingHomeButtonShortPressedEnabled]]
|-
| 110 || [11.0.0+] [[#OpenMyGpuErrorHandler]]
|-
| 120 || [13.0.0+] GetAppletLaunchedHistory
|-
| 200 || [7.0.0+] [[#GetOperationModeSystemInfo]]
|-
| 300 || [9.0.0+] [[#GetSettingsPlatformRegion]]
|-
| 400 || [10.0.0+] [[#ActivateMigrationService]]
|-
| 401 || [10.0.0+] [[#DeactivateMigrationService]]
|-
| 500 || [11.0.0+] [[#DisableSleepTillShutdown]]
|-
| 501 || [11.0.0+] [[#SuppressDisablingSleepTemporarily]]
|-
| 502 || [12.0.0+] IsSleepEnabled
|-
| 503 || [12.0.0+] IsDisablingSleepSuppressed
|-
| 600 || [17.0.0+] OpenNamedChannelAsChild
|-
| 900 || [11.0.0+] [[#SetRequestExitToLibraryAppletAtExecuteNextProgramEnabled]]
|-
| 910 || [17.0.0+] GetLaunchRequiredTick
|}

Officially notification messages are handled by the application itself, not sdk-nso in ExeFS. Official apps call code in sdk-nso which basically uses svcWaitSynchronization with the event from [[#GetEventHandle]] to check whether a message is available, then if so it uses [[#ReceiveMessage]]. The actual handling for message IDs is done in the app itself(see [[#AppletMessage]]).

[7.0.0+] User-processes now use BeginVrModeEx/EndVrModeEx instead of [[#SetVrModeEnabled]]. Prior to using using BeginVrModeEx, [[Parental_Control_services|pctl]] IsStereoVisionPermitted is used and error 0xD08E is thrown if not allowed by pctl.

=== GetEventHandle ===
No input. Returns an output event handle. This is signalled when a message is available with [[#ReceiveMessage]].

=== ReceiveMessage ===
No input. Returns an output [[#AppletMessage]]. Error 0x680 indicates no message is available.

=== GetThisAppletKind ===
No input, returns an output [[#AppletKind]].

Stubbed, just returns an error.

=== AllowToEnterSleep ===
No input/output.

Stubbed, just returns an error.

=== DisallowToEnterSleep ===
No input/output.

Stubbed, just returns an error.

=== GetOperationMode ===
No input. Returns an output u8 for the current [[#OperationMode]].

=== GetPerformanceMode ===
No input. Returns an output u32 for the current [[#PerformanceMode]].

=== GetCradleStatus ===
No input, returns an output u8.

This uses [[#omm]] GetCradleStatus.

=== GetBootMode ===
No input, returns an output u8.

Returns the value from [[Process_Manager_services|pm:bm]] GetBootMode.

=== GetCurrentFocusState ===
No input. Returns an output u8 [[#FocusState]].

=== RequestToAcquireSleepLock ===
No input/output.

=== ReleaseSleepLock ===
No input/output.

=== ReleaseSleepLockTransiently ===
No input/output.

=== GetAcquiredSleepLockEvent ===
No input, returns an output Event handle with autoclear=false.

=== GetWakeupCount ===
No input, returns an output u64.

=== PushToGeneralChannel ===
Takes an input [[#IStorage]], no output.

This is not usable under an Application, however it is usable under a LibraryApplet.

Used for sending requests to [[qlaunch]]. sdk-nso creates a 0x10-byte storage which is sent to this. The following are the functions which use this, with the data written to the storage:
* <code>RequestHomeMenu</code> <code>5341 4d53 0100 0000 0200 0000 0100 0000</code> Returns to the main Home Menu, equivalent to pressing the HOME button.
* <code>RequestJumpToSystemUpdate</code> <code>5341 4d53 0100 0000 0b00 0000 0100 0000</code> Equivalent to entering "System Update" under System Settings. When leaving this, it returns to the main Home Menu.

=== GetHomeButtonReaderLockAccessor ===
No input, returns an output [[#ILockAccessor]].

Similar to using [[#GetReaderLockAccessorEx]] with inval=0.

=== GetReaderLockAccessorEx ===
Takes an input u32, returns an output [[#ILockAccessor]].

The input value must be 0-3. 0 = HomeButton.

=== GetWriterLockAccessorEx ===
Takes an input u32, returns an output [[#ILockAccessor]].

The input value must be 0-3. 0 = HomeButton.

=== GetCradleFwVersion ===
No input, returns 4 output u32s.

This uses [[#omm]] GetCradleFwVersion.

=== IsVrModeEnabled ===
No input, returns an output u8 bool.

=== SetVrModeEnabled ===
Takes an input u8 bool flag. No output.

Updates internal AM state fields. If the new state doesn't match the previous state, this uses the [[Backlight_services]] {Disable/Enable}VrMode command depending on whether flag={disable/enable}.

When the VrMode is set to true, the console shows a screen rendered like vr asking the user to move his face away and hit the 'close' button. When this button is pressed, the console resets the vrMode to false.

=== SetLcdBacklighOffEnabled ===
Takes an input u8 bool, no output.

Sets whether the LCD screen blacklight is turned off.

=== BeginVrModeEx ===
No input/output.

Identical to [[#SetVrModeEnabled]] except with hard-coded flag=1.

=== EndVrModeEx ===
No input/output.

Identical to [[#SetVrModeEnabled]] except with hard-coded flag=0.

=== IsInControllerFirmwareUpdateSection ===
No input, returns an output u8 bool.

=== SetVrPositionForDebug ===
Takes 4 input s32s, no output.

The s32s are: x, y, width, height.

The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.

width must be 1-1280, height must be 1-720.

x and y must not be negative. x+width must be <=1280. y+height must be <=720.

=== GetDefaultDisplayResolution ===
No input, returns two output s32s '''width''' and '''height'''.

=== GetDefaultDisplayResolutionChangeEvent ===
No input, returns an output Event handle with autoclear=true.

=== GetHdcpAuthenticationState ===
No input, returns an output s32.

=== GetHdcpAuthenticationStateChangeEvent ===
No input, returns an output Event handle with autoclear=true.

=== SetTvPowerStateMatchingMode ===
Takes an input s32 [[#TvPowerStateMatchingMode]], no output.

=== GetApplicationIdByContentActionName ===
Takes a type-0x5 input buffer containing a string, returns an output [[NCM_services#ApplicationId|ApplicationId]].

Gets the ApplicationId for the specified ContentActionName string. Returns an error when the current [[#AppletId]] isn't 0x04 (when the current applet isn't a SystemApplication).

=== SetCpuBoostMode ===
Takes an input u32 [[#CpuBoostMode]] and passes it to [[PPC_services#apm:sys|SetCpuBoostMode]].

=== CancelCpuBoostMode ===
No input/output.

=== GetBuiltInDisplayType ===
No input, returns an output s32.

This is not exposed by sdknso.

This loads a s32 index from global state (originates from [[SPL_services#GetConfig|GetConfig]] [[SMC#HardwareType|HardwareType]]), Aborts if it's out-of-bounds, then the following is returned for the output s32: global_array[loaded_index].

=== PerformSystemButtonPressingIfInFocus ===
Takes an input [[#SystemButtonType]], no output.

Just returns 0 when a state field is not value 1. Verifies that the input button is allowed, then calls the same func as [[#PerformSystemButtonPressing]] internally.

=== SetPerformanceConfigurationChangedNotification ===
Takes an input u8 bool, no output.

=== GetCurrentPerformanceConfiguration ===
No input, returns the result of calling [[PPC_services#apm:sys|GetCurrentPerformanceConfiguration]].

=== OpenMyGpuErrorHandler ===
No input, returns an [[#IGpuErrorHandler]].

The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.

=== GetOperationModeSystemInfo ===
No input, returns an output u32.

This returns the output from [[#GetOperationModeSystemInfo_2|omm GetOperationModeSystemInfo]].

=== GetSettingsPlatformRegion ===
No input, returns an output u8.

This just returns the output from [[Settings_services#GetPlatformRegion|setsys GetPlatformRegion]].

=== ActivateMigrationService ===
No input/output.

Besides various other functionality, if required this eventually uses [[NS_Services|ns]] LaunchLibraryApplet to launch [[Migration_services|migration]].

=== DeactivateMigrationService ===
No input/output.

=== DisableSleepTillShutdown ===
No input/output.

=== SuppressDisablingSleepTemporarily ===
Takes an input u64 "nn::TimeSpanType", no output.

=== SetRequestExitToLibraryAppletAtExecuteNextProgramEnabled ===
No input/output.

=== IGpuErrorHandler ===
This is "nn::am::service::IGpuErrorHandler".

This was added with [11.0.0+].

This uses various [[NV_services#nvgem:cd|nvgem:cd]] commands.

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 100 || [[#GetManualGpuErrorInfoSize]]
|-
| 101 || [[#GetManualGpuErrorInfo]]
|-
| 102 || [[#GetManualGpuErrorDetectionSystemEvent]]
|-
| 103 || [[#FinishManualGpuErrorHandling]]
|}

==== GetManualGpuErrorInfoSize ====
No input, returns an output u64.

==== GetManualGpuErrorInfo ====
Takes a type-0x6 output buffer, returns an output u64.

The OutBuffer_size must be >= the output size from [[#GetManualGpuErrorInfoSize]].

sdknso exposes the buffer as <code>void*</code>.

==== GetManualGpuErrorDetectionSystemEvent ====
No input, returns an output Event handle with EventClearMode=0.

==== FinishManualGpuErrorHandling ====
No input/output.

== ISelfController ==
This is "nn::am::service::ISelfController".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#Exit]]
|-
| 1 || [[#LockExit]]
|-
| 2 || [[#UnlockExit]]
|-
| 3 || [2.0.0+] [[#EnterFatalSection]]
|-
| 4 || [2.0.0+] [[#LeaveFatalSection]]
|-
| 9 || [[#GetLibraryAppletLaunchableEvent]]
|-
| 10 || [[#SetScreenShotPermission]]
|-
| 11 || [[#SetOperationModeChangedNotification]]
|-
| 12 || [[#SetPerformanceModeChangedNotification]]
|-
| 13 || [[#SetFocusHandlingMode]]
|-
| 14 || [[#SetRestartMessageEnabled]]
|-
| 15 || [2.0.0+] [[#SetScreenShotAppletIdentityInfo]]
|-
| 16 || [2.0.0+] [[#SetOutOfFocusSuspendingEnabled]]
|-
| 17 || [3.0.0+] [[#SetControllerFirmwareUpdateSection]]
|-
| 18 || [3.0.0+] [[#SetRequiresCaptureButtonShortPressedMessage]]
|-
| 19 || [3.0.0+] [[#SetAlbumImageOrientation]]
|-
| 20 || [4.0.0+] [[#SetDesirableKeyboardLayout]]
|-
| 21 || [13.0.0+] GetScreenShotProgramId
|-
| 40 || [[#CreateManagedDisplayLayer]]
|-
| 41 || [4.0.0+] [[#IsSystemBufferSharingEnabled]]
|-
| 42 || [4.0.0+] [[#GetSystemSharedLayerHandle]]
|-
| 43 || [5.0.0+] [[#GetSystemSharedBufferHandle]]
|-
| 44 || [10.0.0+] [[#CreateManagedDisplaySeparableLayer]]
|-
| 45 || [10.0.0+] [[#SetManagedDisplayLayerSeparationMode]]
|-
| 46 || [13.0.0+] [[#SetRecordingLayerCompositionEnabled]]
|-
| 50 || [[#SetHandlesRequestToDisplay]]
|-
| 51 || [[#ApproveToDisplay]]
|-
| 60 || [[#OverrideAutoSleepTimeAndDimmingTime]]
|-
| 61 || [[#SetMediaPlaybackState]]
|-
| 62 || [[#SetIdleTimeDetectionExtension]]
|-
| 63 || [[#GetIdleTimeDetectionExtension]]
|-
| 64 || [[#SetInputDetectionSourceSet]]
|-
| 65 || [2.0.0+] [[#ReportUserIsActive]]
|-
| 66 || [3.0.0+] [[#GetCurrentIlluminance]]
|-
| 67 || [3.0.0+] [[#IsIlluminanceAvailable]]
|-
| 68 || [5.0.0+] [[#SetAutoSleepDisabled]]
|-
| 69 || [5.0.0+] [[#IsAutoSleepDisabled]]
|-
| 70 || [4.0.0+] [[#ReportMultimediaError]]
|-
| 71 || [5.0.0+] [[#GetCurrentIlluminanceEx]]
|-
| 72 || [9.0.0+] [[#SetInputDetectionPolicy]]
|-
| 80 || [4.0.0+] [[#SetWirelessPriorityMode]]
|-
| 90 || [6.0.0+] [[#GetAccumulatedSuspendedTickValue]]
|-
| 91 || [6.0.0+] [[#GetAccumulatedSuspendedTickChangedEvent]]
|-
| 100 || [7.0.0+] [[#SetAlbumImageTakenNotificationEnabled]]
|-
| 110 || [8.0.0+] [[#SetApplicationAlbumUserData]]
|-
| 120 || [11.0.0+] [[#SaveCurrentScreenshot]]
|-
| 130 || [13.0.0+] [[#SetRecordVolumeMuted]]
|-
| 1000 || [7.0.0+] [[#GetDebugStorageChannel]]
|}

=== Exit ===
No input/output.

Exits the current applet. On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.

=== LockExit ===
No input/output.

Locks exit process of pressing X to close in HOME Menu for an application or HOME button for an applet. When locked, it will show the "waiting for software to be closed dialog" until UnlockExit is called or a 15 seconds timeout (when the latter occurs, the process is force-terminated).

=== UnlockExit ===
No input/output.

Unlocks exit process, if LockExit was previously used.

=== EnterFatalSection ===
No input/output.

=== LeaveFatalSection ===
No input/output.

[[#EnterFatalSection]] must be executed at least once before executing this command, otherwise error code 0x40080 will be returned. EnterFatalSection and LeaveFatalSection work in pairs, that is, N calls to EnterFatalSection must be performed first in order to perform N executions of LeaveFatalSection. Essentially, these two functions operate like how one would lock and unlock a recursive mutex.

=== GetLibraryAppletLaunchableEvent ===
No input, returns an output event handle with autoclear=false.

=== SetScreenShotPermission ===
Takes an input s32. No output.

Controls whether screenshot-capture is allowed.

{| class="wikitable" border="1"
|-
! Value || Description
|-
| 0 || Inherit from parent applet
|-
| 1 || Enable
|-
| 2 || Disable
|-
|}

=== SetOperationModeChangedNotification ===
Takes an input u8 bool flag. No output.

=== SetPerformanceModeChangedNotification ===
Takes an input u8 bool flag. No output.

=== SetFocusHandlingMode ===
Takes 3 input u8s with each field located immediately after the previous u8, these are bool flags. No output.

=== SetRestartMessageEnabled ===
Takes an input u8 bool flag, no output.

See [[#AppletMessage]].

=== SetScreenShotAppletIdentityInfo ===
Takes an input [[#AppletIdentityInfo]], no output.

=== SetOutOfFocusSuspendingEnabled ===
Takes an input u8 bool flag. No output.

=== SetControllerFirmwareUpdateSection ===
Takes an input u8 bool flag, no output.

This throws error 0x40280 when the internal state flag already matches the input value.

=== SetRequiresCaptureButtonShortPressedMessage ===
Takes an input u8 bool flag, no output.

See [[#AppletMessage]].

When enabled with a non-Overlay applet, Overlay applet will not be notified of capture button short-presses for screenshots.

=== SetAlbumImageOrientation ===
Takes an input u32 "nn::album::ImageOrientation". No output.

The input value must not be >3.

=== SetDesirableKeyboardLayout ===
Takes an input u32, no output.

The input u32 is "nn::settings::KeyboardLayout".

=== CreateManagedDisplayLayer ===
Returns an output u64 LayerId which is then used by the user-process with [[Display_services#OpenLayer]].

=== IsSystemBufferSharingEnabled ===
No input/output.

Not available when the current applet is an Application ([[#AppletId]] == 0x01).

Checks whether SystemBufferSharing is enabled, throwing an error otherwise.

=== GetSystemSharedLayerHandle ===
No input, returns two output u64s "nn::vi::fbshare::SharedBufferHandle" and "nn::vi::fbshare::SharedLayerHandle".

Runs code similar to [[#IsSystemBufferSharingEnabled]] first.

=== GetSystemSharedBufferHandle ===
No input, returns an output u64 "nn::vi::fbshare::SharedBufferHandle".

Runs code similar to [[#IsSystemBufferSharingEnabled]] first.

Same as [[#GetSystemSharedLayerHandle]] except this just gets the SharedBufferHandle.

=== CreateManagedDisplaySeparableLayer ===
No input, returns two output u64 LayerIds.

sdknso now uses this instead of [[#CreateManagedDisplayLayer]]. sdknso caches the output from the cmd so that it's only used once. The first u64 is used the same as the original LayerId from [[#CreateManagedDisplayLayer]]. <code>nn::vi::CreateRecordingLayer</code> uses the second LayerId, the layer creation is identical besides which LayerId is used.

=== SetManagedDisplayLayerSeparationMode ===
Takes an input u32, no output.

sdknso exposes this as <code>nn::vi::SetRecordingLayerEnabled(bool)</code>.

The input u32 must be 0-1.

=== SetRecordingLayerCompositionEnabled ===
Takes an input bool, no output.

=== SetHandlesRequestToDisplay ===
Takes an input u8 bool, no output.

Sets an internal state flag. When the input flag is 0, this will in additional run the same code as [[#ApproveToDisplay]].

See [[#AppletMessage]].

=== ApproveToDisplay ===
No input/output.

Used to handle the notification enabled by [[#SetHandlesRequestToDisplay]].

=== OverrideAutoSleepTimeAndDimmingTime ===
Takes 4 input s32s, no output.

=== SetMediaPlaybackState ===
Takes an input u8 bool, no output.

=== SetIdleTimeDetectionExtension ===
Takes an input u32, no output.

The input value must be 0-2: 0 = disabled, 1 = Extended, and 2 = ExtendedUnsafe.

=== GetIdleTimeDetectionExtension ===
No input, returns an output u32.

Returns the value set by [[#SetIdleTimeDetectionExtension]].

=== SetInputDetectionSourceSet ===
Takes an input u32, no output.

=== ReportUserIsActive ===
No input/output.

Uses idle:sys ReportUserIsActive.

Reports that the user is active, for idle detection (screen dimming / auto-sleep). This is equivalent to when the user uses HID input.

=== GetCurrentIlluminance ===
No input, returns an output float.

Uses [[Backlight_services|lbl]] command GetAmbientLightSensorValue, where only the output float is used.

=== IsIlluminanceAvailable ===
No input, returns an output u8 bool.

Uses [[Backlight_services|lbl]] command IsAmbientLightSensorAvailable.

User-processes can use this to determine whether to continue with using GetCurrentIlluminance(Ex).

=== SetAutoSleepDisabled ===
Takes an input u8 bool, no output.

=== IsAutoSleepDisabled ===
No input, returns an output u8 bool.

=== ReportMultimediaError ===
Takes an input Result and a type-0x5 input buffer, no output.

The buffer contains a 0x138-byte "movie::MultimediaTelemetryReport" struct.

=== GetCurrentIlluminanceEx ===
No input, returns an output u8 bool and float.

Uses [[Backlight_services|lbl]] command GetAmbientLightSensorValue.

=== SetInputDetectionPolicy ===
Takes an input [[#InputDetectionPolicy]], no output.

=== SetWirelessPriorityMode ===
Takes an input s32 [[#WirelessPriorityMode]], no output.

=== GetAccumulatedSuspendedTickValue ===
No input, returns an output u64 tick value.

Gets the total time in ticks that the process was suspended, relative to when the applet-service was last initialized.

=== GetAccumulatedSuspendedTickChangedEvent ===
No input, returns an output Event handle with autoclear=true.

This is signaled when the output from [[#GetAccumulatedSuspendedTickValue]] is updated.

=== SetAlbumImageTakenNotificationEnabled ===
Takes an input u8 bool, no output.

See [[#AppletMessage]].

=== SetApplicationAlbumUserData ===
Takes a type-0x21 input buffer, no output.

The buffer contains arbitrary UserData.

The size must be <=0x400. The input buffer is copied to a buffer loaded from a state ptr (throwing an error when the state ptr is not set), with the u32 size being written to statebuf+0x400 afterwards.

=== SaveCurrentScreenshot ===
Takes an input s32 [[Capture_services#AlbumReportOption|AlbumReportOption]], no output.

sdknso exposes this under "nn::album::".

=== SetRecordVolumeMuted ===
Takes an input bool, no output.

=== GetDebugStorageChannel ===
No input, returns an output [[#IStorageChannel]].

The cached value loaded from [[System_Settings|system-setting]] <code>am.debug!dev_function</code> must be set to 0x1 with size 0x1, otherwise an error is returned.

== IStorageChannel ==
This is "nn::am::service::IStorageChannel".

This was added with [7.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || Push || No input, returns an output [[#IStorage]].
|-
| 1 || Unpop || No input, returns an output [[#IStorage]].
|-
| 2 || Pop || No input, returns an output [[#IStorage]].
|-
| 3 || GetPopEventHandle || No input, returns an output handle.
|-
| 4 || Clear || No input/output.
|}

== IWindowController ==
This is "nn::am::service::IWindowController".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#CreateWindow]] ||
|-
| 1 || [[#GetAppletResourceUserId]] ||
|-
| 2 || [6.0.0+] [[#GetAppletResourceUserIdOfCallerApplet]] ||
|-
| 10 || [[#AcquireForegroundRights]] ||
|-
| 11 || [[#ReleaseForegroundRights]] ||
|-
| 12 || [[#RejectToChangeIntoBackground]] ||
|-
| 20 || [7.0.0+] [[#SetAppletWindowVisibility]] ||
|-
| 21 || [7.0.0+] [[#SetAppletGpuTimeSlice]] ||
|}

=== CreateWindow ===
Takes an input u32, returns an output [[#IWindow]].

Stubbed, just returns an error.

=== GetAppletResourceUserId ===
No input, returns an output u64 [[#AppletResourceUserId]].

=== GetAppletResourceUserIdOfCallerApplet ===
No input, returns an output u64 [[#AppletResourceUserId]].

=== AcquireForegroundRights ===
No input/output.

Just returns 0.

=== ReleaseForegroundRights ===
No input/output.

Just returns 0.

=== RejectToChangeIntoBackground ===
No input/output.

Just returns 0.

=== SetAppletWindowVisibility ===
Takes an input u8 bool, no output.

=== SetAppletGpuTimeSlice ===
Takes an input s64, no output.

The input s64 must not be negative.

== IAudioController ==
This is "nn::am::service::IAudioController".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#SetExpectedMasterVolume]]
|-
| 1 || [[#GetMainAppletExpectedMasterVolume]]
|-
| 2 || [[#GetLibraryAppletExpectedMasterVolume]]
|-
| 3 || [[#ChangeMainAppletMasterVolume]]
|-
| 4 || [[#SetTransparentVolumeRate]]
|}

GetMainAppletExpectedMasterVolume/SetExpectedMasterVolume are used for saving/restoring state for LibraryApplet launching, with SetExpectedMasterVolume being used with new state prior to launching a LibraryApplet. With official sw these applet funcs are used directly in the main-codebin.

=== SetExpectedMasterVolume ===
Takes two input floats, no output.

Writes the input floats to state: first one is used by [[#GetMainAppletExpectedMasterVolume]], second one is used by [[#GetLibraryAppletExpectedMasterVolume]].

=== GetMainAppletExpectedMasterVolume ===
No input, returns an output float.

=== GetLibraryAppletExpectedMasterVolume ===
No input, returns an output float.

=== ChangeMainAppletMasterVolume ===
Takes an input float and an input u64, no output.

=== SetTransparentVolumeRate ===
Takes an input float, no output.

== IDisplayController ==
This is "nn::am::service::IDisplayController".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#GetLastForegroundCaptureImage]]
|-
| 1 || [[#UpdateLastForegroundCaptureImage]]
|-
| 2 || [[#GetLastApplicationCaptureImage]]
|-
| 3 || [[#GetCallerAppletCaptureImage]]
|-
| 4 || [[#UpdateCallerAppletCaptureImage]]
|-
| 5 || [[#GetLastForegroundCaptureImageEx]]
|-
| 6 || [[#GetLastApplicationCaptureImageEx]]
|-
| 7 || [[#GetCallerAppletCaptureImageEx]]
|-
| 8 || [2.0.0+] [[#TakeScreenShotOfOwnLayer]]
|-
| 9 || [5.0.0+] [[#CopyBetweenCaptureBuffers]]
|-
| 10 || [[#AcquireLastApplicationCaptureBuffer]]
|-
| 11 || [[#ReleaseLastApplicationCaptureBuffer]]
|-
| 12 || [[#AcquireLastForegroundCaptureBuffer]]
|-
| 13 || [[#ReleaseLastForegroundCaptureBuffer]]
|-
| 14 || [[#AcquireCallerAppletCaptureBuffer]]
|-
| 15 || [[#ReleaseCallerAppletCaptureBuffer]]
|-
| 16 || [[#AcquireLastApplicationCaptureBufferEx]]
|-
| 17 || [[#AcquireLastForegroundCaptureBufferEx]]
|-
| 18 || [[#AcquireCallerAppletCaptureBufferEx]]
|-
| 20 || [3.0.0+] [[#ClearCaptureBuffer]]
|-
| 21 || [3.0.0+] [[#ClearAppletTransitionBuffer]]
|-
| 22 || [4.0.0+] [[#AcquireLastApplicationCaptureSharedBuffer]]
|-
| 23 || [4.0.0+] [[#ReleaseLastApplicationCaptureSharedBuffer]]
|-
| 24 || [4.0.0+] [[#AcquireLastForegroundCaptureSharedBuffer]]
|-
| 25 || [4.0.0+] [[#ReleaseLastForegroundCaptureSharedBuffer]]
|-
| 26 || [4.0.0+] [[#AcquireCallerAppletCaptureSharedBuffer]]
|-
| 27 || [4.0.0+] [[#ReleaseCallerAppletCaptureSharedBuffer]]
|-
| 28 || [6.0.0+] [[#TakeScreenShotOfOwnLayerEx]]
|}

=== GetLastForegroundCaptureImage ===
Takes a type-0x6 output buffer.

Stubbed, just returns an error.

=== UpdateLastForegroundCaptureImage ===
No input/output.

=== GetLastApplicationCaptureImage ===
Takes a type-0x6 output buffer.

Stubbed, just returns an error.

=== GetCallerAppletCaptureImage ===
Takes a type-0x6 output buffer.

Stubbed, just returns an error.

=== UpdateCallerAppletCaptureImage ===
No input/output.

Calls the same func internally as [[#UpdateLastForegroundCaptureImage]], except this passes param value 2 instead of 1.

=== GetLastForegroundCaptureImageEx ===
Takes a type-0x6 output buffer, returns an output u8 bool.

The buffer size must match 0x384000.

=== GetLastApplicationCaptureImageEx ===
Takes a type-0x6 output buffer, returns an output u8 bool.

The buffer size must match 0x384000.

Calls the same internal func as [[#GetLastForegroundCaptureImageEx]], except that the last param is set to value 0 instead of 1.

=== GetCallerAppletCaptureImageEx ===
Takes a type-0x6 output buffer, returns an output u8 bool.

The buffer size must match 0x384000.

Calls the same internal func as [[#GetLastForegroundCaptureImageEx]], except that the last param is set to value 2 instead of 1.

=== TakeScreenShotOfOwnLayer ===
Takes an input u8 bool and a s32, no output.

=== CopyBetweenCaptureBuffers ===
Takes two input s32s, no output.

=== AcquireLastApplicationCaptureBuffer ===
No input, returns an output handle.

Stubbed, just returns an error.

=== ReleaseLastApplicationCaptureBuffer ===
No input/output.

Clears a state field if it's not already 0, returning an error otherwise. On newer sysvers: then a func is called which just returns 0, then this cmd returns 0.

=== AcquireLastForegroundCaptureBuffer ===
No input, returns an output handle.

Stubbed, just returns an error.

=== ReleaseLastForegroundCaptureBuffer ===
No input/output.

Same as [[#ReleaseLastApplicationCaptureBuffer]] except with a different state field + different input param for the called func.

=== AcquireCallerAppletCaptureBuffer ===
No input, returns an output handle.

Stubbed, just returns an error.

=== ReleaseCallerAppletCaptureBuffer ===
No input/output.

Same as [[#ReleaseLastApplicationCaptureBuffer]] except with a different state field + different input param for the called func.

=== AcquireLastApplicationCaptureBufferEx ===
No input, returns an output TransferMemory handle and an output u8 bool.

The state field used by [[#ReleaseLastApplicationCaptureBuffer]] must be 0. Calls a func which just returns an error (this is only the case on newer sysvers), hence this cmd will just return that error. If that func would have returned successfully, the state field would be set to 1 and the cmd would return 0.

On old sysvers, the output TransferMemory is size 0x384000 with permissions=RW.

=== AcquireLastForegroundCaptureBufferEx ===
No input, returns an output TransferMemory handle and an output u8 bool.

Same as [[#AcquireLastApplicationCaptureBufferEx]] except this uses the [[#ReleaseLastForegroundCaptureBuffer]] state field, and uses a different input param value for the called func.

=== AcquireCallerAppletCaptureBufferEx ===
No input, returns an output TransferMemory handle and an output u8 bool.

Same as [[#AcquireLastApplicationCaptureBufferEx]] except this uses the [[#ReleaseCallerAppletCaptureBuffer]] state field, and uses a different input param value for the called func.

=== ClearCaptureBuffer ===
Takes an input u8 bool, a s32 CaptureSharedBuffer, and an u32 color, returns no output.

Clear the input CaptureSharedBuffer with the specified RGBA8 color.

=== ClearAppletTransitionBuffer ===
Takes an input u32, no output.

Clear the AppletTransitionBuffer with the specified RGBA8 color.

=== AcquireLastApplicationCaptureSharedBuffer ===
No input, returns an output u8 bool and an s32.

This loads data from state.

=== ReleaseLastApplicationCaptureSharedBuffer ===
No input/output.

Depending on whether a state field is 0, this just returns an error or returns 0.

=== AcquireLastForegroundCaptureSharedBuffer ===
No input, returns an output u8 bool and an s32.

Calls the same func internally as [[#AcquireLastApplicationCaptureSharedBuffer]], except this passes value 1 for the last param instead of 0.

=== ReleaseLastForegroundCaptureSharedBuffer ===
No input/output.

Calls the same func internally as [[#ReleaseLastApplicationCaptureSharedBuffer]], except this passes value 1 for the last param instead of 0.

=== AcquireCallerAppletCaptureSharedBuffer ===
No input, returns an output u8 bool and an s32.

Calls the same func internally as [[#AcquireLastApplicationCaptureSharedBuffer]], except this passes value 2 for the last param instead of 0.

=== ReleaseCallerAppletCaptureSharedBuffer ===
No input/output.

Calls the same func internally as [[#ReleaseLastApplicationCaptureSharedBuffer]], except this passes value 2 for the last param instead of 0.

=== TakeScreenShotOfOwnLayerEx ===
Takes two input u8 bools and a s32, no output.

Calls the same func internally as [[#TakeScreenShotOfOwnLayer]], except the last bool param is the last cmd param bool instead of hard-coded 0. This flag indicates whether the screenshot should be taken Immediately.

== ISystemAppletControllerForDebug ==
This is "nn::am::service::ISystemAppletControllerForDebug".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 1 || RequestLaunchApplicationForDebug
|-
| 2 || [7.0.0+] [[#GetDebugStorageChannel]]
|-
| 3 || [7.0.0+] [[#CreateStorageForDebug]]
|-
| 4 || [12.0.0+] [[#CreateCradleFirmwareUpdaterForDebug]]
|}

=== GetDebugStorageChannel ===
No input. Returns an output [[#IStorageChannel]].

=== CreateStorageForDebug ===
Takes a total of 8-bytes of input. Returns an [[#IStorage]].

=== CreateCradleFirmwareUpdaterForDebug ===
No input. Returns an [[#ICradleFirmwareUpdater]].

== IProcessWindingController ==
This is "nn::am::service::IProcessWindingController".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#GetLaunchReason]] ||
|-
| 11 || [[#OpenCallingLibraryApplet]] ||
|-
| 21 || [[#PushContext]] ||
|-
| 22 || [[#PopContext]] ||
|-
| 23 || [[#CancelWindingReservation]] ||
|-
| 30 || [[#WindAndDoReserved]] ||
|-
| 40 || [[#ReserveToStartAndWaitAndUnwindThis]] ||
|-
| 41 || [4.0.0+] [[#ReserveToStartAndWait]] ||
|}

=== GetLaunchReason ===
No input, returns an output [[#AppletProcessLaunchReason]].

Used by LibraryApplets.

=== OpenCallingLibraryApplet ===
No input, returns an output [[#ILibraryAppletAccessor]].

The objptr from state is cleared during this, an error is thrown if it's already 0.

=== PushContext ===
Takes an input [[#IStorage]], no output.

=== PopContext ===
No input, returns an output [[#IStorage]].

=== CancelWindingReservation ===
No input/output.

=== WindAndDoReserved ===
No input/output.

=== ReserveToStartAndWaitAndUnwindThis ===
Takes an input [[#ILibraryAppletAccessor]], no output.

=== ReserveToStartAndWait ===
Takes an input [[#ILibraryAppletAccessor]], no output.

== IDebugFunctions ==
This is "nn::am::service::IDebugFunctions".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#NotifyMessageToHomeMenuForDebug]]
|-
| 1 || [1.0.0-9.2.0] [[#OpenMainApplication]]
|-
| 10 || [[#PerformSystemButtonPressing]]
|-
| 20 || [[#InvalidateTransitionLayer]]
|-
| 30 || [6.0.0+] [[#RequestLaunchApplicationWithUserAndArgumentForDebug]]
|-
| 31 || [12.0.0+] RequestLaunchApplicationByApplicationLaunchInfoForDebug
|-
| 40 || [6.0.0+] [[#GetAppletResourceUsageInfo]]
|-
| 50 || [15.0.0+] AddSystemProgramIdAndAppletIdForDebug
|-
| 51 || [16.0.0+] AddOperationConfirmedLibraryAppletIdForDebug
|-
| 52 || [17.0.0+] GetProgramIdFromAppletIdForDebug
|-
| 100 || [7.0.0+] [[#SetCpuBoostModeForApplet]]
|-
| 101 || [10.0.0+] [[#CancelCpuBoostModeForApplet]]
|-
| 110 || [9.0.0+] [[#PushToAppletBoundChannelForDebug]]
|-
| 111 || [9.0.0+] [[#TryPopFromAppletBoundChannelForDebug]]
|-
| 120 || [9.0.0+] [[#AlarmSettingNotificationEnableAppEventReserve]]
|-
| 121 || [9.0.0+] [[#AlarmSettingNotificationDisableAppEventReserve]]
|-
| 122 || [9.0.0+] [[#AlarmSettingNotificationPushAppEventNotify]]
|-
| 130 || [9.0.0+] [[#FriendInvitationSetApplicationParameter]]
|-
| 131 || [9.0.0+] [[#FriendInvitationClearApplicationParameter]]
|-
| 132 || [9.0.0+] [[#FriendInvitationPushApplicationParameter]]
|-
| 140 || [14.0.0+] RestrictPowerOperationForSecureLaunchModeForDebug
|-
| 200 || [15.0.0+] CreateFloatingLibraryAppletAccepterForDebug
|-
| 300 || [16.0.0+] TerminateAllRunningApplicationsForDebug
|-
| 900 || [12.0.0+] GetGrcProcessLaunchedSystemEvent
|}

=== NotifyMessageToHomeMenuForDebug ===
Takes an input [[#AppletMessage]], no output.

Stubbed, just returns an error.

=== OpenMainApplication ===
No input, returns an output [[#IApplicationAccessor]].

Should not be used when no Application is running (svcBreak).

=== PerformSystemButtonPressing ===
Takes an input [[#SystemButtonType]], no output.

=== InvalidateTransitionLayer ===
No input/output.

=== RequestLaunchApplicationWithUserAndArgumentForDebug ===
Takes an input u8 bool flag, an [[NCM_services#ApplicationId|ApplicationId]], a type-0x5 input buffer containing an array of u128 userIDs, and a type-0x5 input buffer, no output.

Requests to launch the specified Application, with the specified users. When the bool flag is true, the content of the second input buffer is used to create a storage which is pushed to the UserChannel for this Application (see [[#LaunchParameterKind]]).

=== GetAppletResourceUsageInfo ===
No input, returns an output [[#AppletResourceUsageInfo]].

=== SetCpuBoostModeForApplet ===
Takes an input u32 [[#CpuBoostMode]] and passes it to [[PPC_services#apm:sys|SetCpuBoostMode]].

The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.

=== CancelCpuBoostModeForApplet ===
No input/output.

=== PushToAppletBoundChannelForDebug ===
Takes an input [[#IStorage]] and a s32, no output.

The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.

The s32 must match the value already stored in state when the state value is non-zero, otherwise an error is returned. When the state value is 0, the s32 is written into state. Then the input storage is pushed to the StorageChannel.

=== TryPopFromAppletBoundChannelForDebug ===
Takes an input s32, returns an output [[#IStorage]].

The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.

The s32 must not be 0 and must match the value previously saved by [[#PushToAppletBoundChannelForDebug]], otherwise errors are returned. Then the output storage is popped from the StorageChannel.

=== AlarmSettingNotificationEnableAppEventReserve ===
Takes an input [[#IStorage]] and an [[NCM_services#ApplicationId|ApplicationId]], no output.

Clears a StorageChannel, pushes the input storage there, and writes the ApplicationId into state.

=== AlarmSettingNotificationDisableAppEventReserve ===
No input/output.

Clears the StorageChannel/saved-ApplicationId used by [[#AlarmSettingNotificationEnableAppEventReserve]].

=== AlarmSettingNotificationPushAppEventNotify ===
Takes an input [[#IStorage]], no output.

Same as [[#PushToNotificationStorageChannel]] except this uses the MainApplication.

=== FriendInvitationSetApplicationParameter ===
Takes an input [[#IStorage]] and an [[NCM_services#ApplicationId|ApplicationId]], no output.

Clears a StorageChannel, pushes the input storage there, and writes the ApplicationId into state.

=== FriendInvitationClearApplicationParameter ===
No input/output.

Clears the StorageChannel/saved-ApplicationId used by [[#FriendInvitationSetApplicationParameter]].

=== FriendInvitationPushApplicationParameter ===
Takes an input [[#IStorage]], no output.

Same as [[#PushToFriendInvitationStorageChannel]] except this uses the MainApplication.

== IStorage ==
This is "nn::am::service::IStorage".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || Open || No input. Returns an [[#IStorageAccessor]].
|-
| 1 || [2.0.0+] OpenTransferStorage || No input. Returns an [[#ITransferStorageAccessor]].
|}

Open can only be used when the IStorage was created by [[#CreateStorage]] or [[#CreateTransferMemoryStorage]]. OpenTransferStorage can only be used when the IStorage was created by [[#CreateHandleStorage]].

Only 1 *Accessor session can be open for each IStorage at a time.

== IStorageAccessor ==
This is "nn::am::service::IStorageAccessor".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || GetSize || No input. Returns an s64.
|-
| 10 || Write || Takes an input s64 and a type-0x21 input buffer.
|-
| 11 || Read || Takes an input s64 and a type-0x22 output buffer.
|}

== ITransferStorageAccessor ==
This is "nn::am::service::ITransferStorageAccessor".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || GetSize || No input. Returns an output s64.
|-
| 1 || GetHandle || No input. Returns an output s64 and handle.
|}

These commands return the data originally from [[#CreateHandleStorage]] input, both return the same s64.

= appletOE =
This is "nn::am::service::IApplicationProxyService".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#OpenApplicationProxy]] ||
|}

This is used by all regular-applications, including [[flog]] and "Retail Interactive Display Menu". Only one session can be open for this service at a time.

== OpenApplicationProxy ==
Returns an [[#IApplicationProxy]]. See [[#appletAE]].

Takes a [[IPC_Marshalling|reserved]] input u64 (official user-processes use hard-coded value 0), a PID, and a process copy-handle (cur-proc handle alias).

On failure, official user-processes will retry using this command in a loop while the retval is 0x19280, with svcSleepThread(10000000) being called first.

= idle:sys =
This is "nn::idle::detail::IPolicyManagerSystem"

This was moved to [[OMM_services|omm]] with [14.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetAutoPowerDownEvent
|-
| 1 || [7.0.0+] IsAutoPowerDownRequested ([1.0.0-3.0.2] )
|-
| 2 || [1.0.0-3.0.2]
|-
| 3 || [[#SetHandlingContext]]
|-
| 4 || LoadAndApplySettings
|-
| 5 || ReportUserIsActive
|}

== SetHandlingContext ==
[3.0.0+] Now takes an additional 0x10-bytes of input.

[13.0.0+] Total input size is now 0x30 instead of 0x38.

= omm =
This is "nn::omm::detail::IOperationModeManager"

Operation Mode Manager (OMM) is a service responsible for arbitrating the operation changes between docked and handheld modes.
Besides [[PTM_services|PTM]], this is the only service that interacts with the [[Dock]] through [[USB_services|usb:pd*]].

This was moved to [[OMM_services|omm]] with [14.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetOperationMode
|-
| 1 || GetOperationModeChangeEvent
|-
| 2 || EnableAudioVisual
|-
| 3 || DisableAudioVisual
|-
| 4 || EnterSleepAndWait
|-
| 5 || GetCradleStatus
|-
| 6 || FadeInDisplay
|-
| 7 || FadeOutDisplay
|-
| 8 || [2.0.0+] GetCradleFwVersion
|-
| 9 || [2.0.0+] NotifyCecSettingsChanged
|-
| 10 || [3.0.0+] SetOperationModePolicy
|-
| 11 || [3.0.0+] GetDefaultDisplayResolution
|-
| 12 || [3.0.0+] GetDefaultDisplayResolutionChangeEvent
|-
| 13 || [3.0.0+] UpdateDefaultDisplayResolution
|-
| 14 || [3.0.0+] ShouldSleepOnBoot
|-
| 15 || [4.0.0+] NotifyHdcpApplicationExecutionStarted
|-
| 16 || [4.0.0+] NotifyHdcpApplicationExecutionFinished
|-
| 17 || [4.0.0+] NotifyHdcpApplicationDrawingStarted
|-
| 18 || [4.0.0+] NotifyHdcpApplicationDrawingFinished
|-
| 19 || [4.0.0+] GetHdcpAuthenticationFailedEvent
|-
| 20 || [4.0.0+] GetHdcpAuthenticationFailedEmulationEnabled
|-
| 21 || [4.0.0+] SetHdcpAuthenticationFailedEmulation
|-
| 22 || [4.0.0+] GetHdcpStateChangeEvent
|-
| 23 || [4.0.0+] GetHdcpState
|-
| 24 || [5.0.0+] ShowCardUpdateProcessing
|-
| 25 || [5.0.0+] SetApplicationCecSettingsAndNotifyChanged
|-
| 26 || [7.0.0+] [[#GetOperationModeSystemInfo]]
|-
| 27 || [9.0.0+] GetAppletFullAwakingSystemEvent
|-
| 28 || [12.0.0+] [[#CreateCradleFirmwareUpdater]]
|}

== GetOperationModeSystemInfo ==
No input, returns an output u32.

This is used by [[#GetOperationModeSystemInfo|ICommonStateGetter GetOperationModeSystemInfo]].

== CreateCradleFirmwareUpdater ==
No input. Returns an [[#ICradleFirmwareUpdater]].

== ICradleFirmwareUpdater ==
This is "nn::am::service::ICradleFirmwareUpdater".

This was added with [12.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || Start
|-
| 1 || Finish
|-
| 2 || GetUpdateDeviceStatus
|-
| 3 || GetUpdateProgress
|-
| 4 || GetUpdateDeviceStatusChangeEvent
|-
| 5 || GetUpdateProgress2
|}

= spsm =
This is "nn::spsm::detail::IPowerStateInterface".

This was moved to [[OMM_services|omm]] with [14.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetCurrentState
|-
| 1 || EnterSleep
|-
| 2 || GetLastWakeReason
|-
| 3 || Shutdown
|-
| 4 || GetNotificationMessageEventHandle
|-
| 5 || ReceiveNotificationMessage
|-
| 6 || AnalyzeLogForLastSleepWakeSequence
|-
| 7 || ResetEventLog
|-
| 8 || AnalyzePerformanceLogForLastSleepWakeSequence
|-
| 9 || ChangeHomeButtonLongPressingTime
|-
| 10 || PutErrorState
|-
| 11 || [1.0.0-3.0.2] InvalidateCurrentHomeButtonPressing
|}

[3.0.0+] Cmd11 now takes a total of 8-bytes of input.

= tcap =
This is "nn::tcap::server::IManager".

This was removed with [11.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetContinuousHighSkinTemperatureEvent
|-
| 1 || SetOperationMode
|-
| 2 || LoadAndApplySettings
|}

= caps:su =
This is "nn::capsrv::sf::IScreenShotApplicationService".

This was added with [6.0.0+].

This can be used by applications to save screenshots.

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 32 || [7.0.0+] SetShimLibraryVersion || Takes a total of 0x10-bytes of input and a PID, no output.
|-
| 201 || SaveScreenShot ||
|-
| 203 || SaveScreenShotEx0 ||
|-
| 205 || [8.0.0+] SaveScreenShotEx1 ||
|-
| 210 || SaveScreenShotEx2 || Takes a total of 0x50-bytes of input, a type-0x15 input buffer, and a type-0x45 input buffer. Returns a total of 0x20-bytes of output.
|}

'''SetShimLibraryVersion''' is a wrapper for [[Capture_services|caps:c]] cmd33. Commands '''SaveScreenShot''', '''SaveScreenShotEx0''', '''SaveScreenShotEx1''' and '''SaveScreenShotEx2''' are wrappers for [[Display_services|caps:sc]] cmd210.

== SaveScreenShot ==
Takes two input u32s, an u64 AppletResourceUserId, a PID, and a type-0x45 input buffer containing image data. Returns an [[Capture_services|ApplicationAlbumEntry]].

Official user-processes doesn't use this, instead [[#SaveScreenShotEx0]] is used: ScreenShotAttributeEx0 is all-zero, except +4 is set to an input u32 and u32 +0xC = 0x1.

This cmd internally uses an all-zero ScreenShotAttributeEx0, with u32 +0 = input u32 and u32 +0x8 = 0x3.

== SaveScreenShotEx0 ==
Takes an input 0x40-byte struct '''ScreenShotAttributeEx0''', an input u32, an input u64 AppletResourceUserId, a PID, and a type-0x45 input buffer containing image data. Returns an [[Capture_services|ApplicationAlbumEntry]].

== SaveScreenShotEx1 ==
Takes an input 0x40-byte struct '''ScreenShotAttributeEx0''', an input u32, an input u64 AppletResourceUserId, a PID, a type-0x15 input buffer containing an [[Capture_services|ApplicationData]], and a type-0x45 input buffer containing image data. Returns an [[Capture_services|ApplicationAlbumEntry]].

== SaveScreenShotEx2 ==
Takes an input 0x40-byte struct '''ScreenShotAttributeEx0''', an input u32, an input u64 AppletResourceUserId, a type-0x15 input buffer containing an [[Capture_services|UserIdList]], and a type-0x45 input buffer containing image data. Returns an [[Capture_services|ApplicationAlbumEntry]].

= apm =
This is "nn::am::service::IApmManager".

This was added with [8.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#OpenSession]]
|-
| 1 || GetPerformanceMode
|-
| 6 || [7.0.0+] [[#IsCpuOverclockEnabled]]
|}

== OpenSession ==
Returns an [[#ISession]].

== IsCpuOverclockEnabled ==
No input, returns an output u8 bool.

== ISession ==
This is "nn::am::service::IApmSession".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || SetPerformanceConfiguration
|-
| 1 || GetPerformanceConfiguration
|-
| 2 || [8.0.0+] SetCpuOverclockEnabled
|}

= Library Applets =
This section documents library applet launching.

Before starting the applet, [[#IStorage]]s are [[#ILibraryAppletCreator|created]] and written, then passed to [[#ILibraryAppletAccessor]] PushInData. The [[#IStorage]] session is closed afterwards. The first [[#IStorage]] is [[#CommonArguments]], followed by any applet-specific [[#IStorage]]s.

Once the applet finishes running successfully, [[#ILibraryAppletAccessor]] PopOutData can be used to get the applet-specific [[#IStorage]] containing the applet output data.

== CommonArguments ==
The first [[#CreateStorage|IStorage]] passed to applets should contain the common library applet arguments. This is populated by <code>nn::la::CommonArgumentsWriter</code> and has the following format.

This struct is 0x20-bytes.

Official sw handles the first 8-bytes separately, which is a header. With CommonArguments version 0x0, the header is 4-bytes, while starting with version 0x1 it's 8-bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Typical Value || Notes
|-
| 0x0 || 4 || 1 || Common Arguments version
|-
| 0x4 || 4 || 0x20 || Common Arguments size
|-
| 0x8 || 4 || || Library applet version (API version)
|-
| 0xC || 4 || 0 || Theme color
|-
| 0x10 || 1 || 0 || Play startup sound
|-
| 0x18 || 8 || N/A || System tick (see [[SVC#svcGetSystemTick|svcGetSystemTick]])
|-
|}

= AppletId =
This is "nn::applet::AppletId". See also [[:Category:Library Applets]].

{| class="wikitable" border="1"
|-
! Value
! ProgramId
! Description
|-
| 0x00
|
| None
|-
| 0x01
|
| Application (not valid for use with LibraryApplets)
|-
| 0x02
| 010000000000100C
| OverlayApplet (overlayDisp)
|-
| 0x03
| 0100000000001000
| SystemAppletMenu (qlaunch)
|-
| 0x04
| 0100000000001012
| SystemApplication (starter)
|-
| 0x0A
| 0100000000001001
| [[Auth_Applet|LibraryAppletAuth (auth)]]
|-
| 0x0B
| 0100000000001002
| [[Cabinet_Applet|LibraryAppletCabinet (cabinet)]]
|-
| 0x0C
| 0100000000001003
| [[Controller_Applet|LibraryAppletController (controller)]]
|-
| 0x0D
| 0100000000001004
| LibraryAppletDataErase (dataErase)
|-
| 0x0E
| 0100000000001005
| [[Error_Applet|LibraryAppletError (error)]]
|-
| 0x0F
| 0100000000001006
| LibraryAppletNetConnect (netConnect)
|-
| 0x10
| 0100000000001007
| [[Profile_Selector|LibraryAppletPlayerSelect (playerSelect)]]
|-
| 0x11
| 0100000000001008
| [[Software_Keyboard|LibraryAppletSwkbd (swkbd)]]
|-
| 0x12
| 0100000000001009
| [[MiiEdit_Applet|LibraryAppletMiiEdit (miiEdit)]]
|-
| 0x13
| 010000000000100A
| [[Internet_Browser#010000000000100A|LibraryAppletWeb (web)]]
|-
| 0x14
| 010000000000100B
| [[Internet_Browser#ShopN|LibraryAppletShop (shop)]]
|-
| 0x15
| 010000000000100D
| [[Album_Applet|LibraryAppletPhotoViewer (photoViewer)]]
|-
| 0x16
| 010000000000100E
| LibraryAppletSet (set)
|-
| 0x17
| 010000000000100F
| [[Internet_Browser#Offline_Applet|LibraryAppletOfflineWeb (offlineWeb)]]
|-
| 0x18
| 0100000000001010
| [[Internet_Browser#Whitelisted_Applets|LibraryAppletLoginShare (loginShare)]]
|-
| 0x19
| 0100000000001011
| [[Internet_Browser#WifiWebAuthApplet|LibraryAppletWifiWebAuth (wifiWebAuth)]]
|-
| 0x1A
| 0100000000001013
| [[MyPage_Applet|LibraryAppletMyPage (myPage)]]
|-
| 0x1B
| 010000000000101A
| LibraryAppletGift (gift)
|-
| 0x1C
| 010000000000101C
| LibraryAppletUserMigration (userMigration)
|-
| 0x1D
| 010000000000101D
| [9.0.0+] LibraryAppletPreomiaSys (EncounterSys)
|-
| 0x1E
| 0100000000001020
| [9.0.0+] LibraryAppletStory (story)
|-
| 0x1F
| 010070000E3C0000
| [9.0.0+] LibraryAppletPreomiaUsr (EncounterUsr)
|-
| 0x20
| 010086000E49C000
| [9.0.0+] LibraryAppletPreomiaUsrDummy (EncounterUsrDummy)
|-
| 0x21
| 0100000000001038
| [10.0.0+] LibraryAppletSample (sample)
|-
| 0x22
| 0100000000001007
| [13.0.0+] LibraryAppletPromoteQualification (playerSelect)
|-
| 0x32
| 010000000000100F
| [17.0.0+] [[Internet_Browser#Offline_Applet|LibraryAppletOfflineWeb (offlineWeb)]]
|-
| 0x33
| 010000000000100F
| [17.0.0+] [[Internet_Browser#Offline_Applet|LibraryAppletOfflineWeb (offlineWeb)]]
|-
| 0x35
| [17.0.0+] 0100000000001010 ([16.0.0-16.1.0] 0100000000001042)
| [17.0.0+] [[Internet_Browser#Whitelisted_Applets|LibraryAppletLoginShare (loginShare)]] ([16.0.0-16.1.0] )
|-
| 0x36
| [17.0.0+] 0100000000001010 ([16.0.0-16.1.0] 0100000000001042)
| [17.0.0+] [[Internet_Browser#Whitelisted_Applets|LibraryAppletLoginShare (loginShare)]] ([16.0.0-16.1.0] )
|-
| 0x37
| [17.0.0+] 0100000000001010 ([16.0.0-16.1.0] 0100000000001042)
| [17.0.0+] [[Internet_Browser#Whitelisted_Applets|LibraryAppletLoginShare (loginShare)]] ([16.0.0-16.1.0] )
|-
| 0x38
| 0100000000001043
| [16.0.0-16.1.0]
|-
| 0x3E8
|
| [10.0.0-16.1.0] DevlopmentTool
|-
| 0x3F1
| 010000000000D619
| [10.0.0-16.1.0] CombinationLA
|-
| 0x3F2
| 010000000000D610
| [10.0.0-16.1.0] AeSystemApplet
|-
| 0x3F3
| 010000000000D611
| [10.0.0-16.1.0] AeOverlayApplet
|-
| 0x3F4
| 010000000000D612
| [10.0.0-16.1.0] AeStarter
|-
| 0x3F5
| 010000000000D613
| [10.0.0-16.1.0] AeLibraryAppletAlone
|-
| 0x3F6
| 010000000000D614
| [10.0.0-16.1.0] AeLibraryApplet1
|-
| 0x3F7
| 010000000000D615
| [10.0.0-16.1.0] AeLibraryApplet2
|-
| 0x3F8
| 010000000000D616
| [10.0.0-16.1.0] AeLibraryApplet3
|-
| 0x3F9
| 010000000000D617
| [10.0.0-16.1.0] AeLibraryApplet4
|-
| 0x3FA
| 010000000000D60A
| [10.0.0-16.1.0] AppletISA
|-
| 0x3FB
| 010000000000D60B
| [10.0.0-16.1.0] AppletIOA
|-
| 0x3FC
| 010000000000D60C
| [10.0.0-16.1.0] AppletISTA
|-
| 0x3FD
| 010000000000D60D
| [10.0.0-16.1.0] AppletILA1
|-
| 0x3FE
| 010000000000D60E
| [10.0.0-16.1.0] AppletILA2
|-
| 0x700000DC
| 010000000000D619
| [17.0.0+] CombinationLA
|-
| 0x700000E6
| 010000000000D610
| [17.0.0+] AeSystemApplet
|-
| 0x700000E7
| 010000000000D611
| [17.0.0+] AeOverlayApplet
|-
| 0x700000E8
| 010000000000D612
| [17.0.0+] AeStarter
|-
| 0x700000E9
| 010000000000D613
| [17.0.0+] AeLibraryAppletAlone
|-
| 0x700000EA
| 010000000000D614
| [17.0.0+] AeLibraryApplet1
|-
| 0x700000EB
| 010000000000D615
| [17.0.0+] AeLibraryApplet2
|-
| 0x700000EC
| 010000000000D616
| [17.0.0+] AeLibraryApplet3
|-
| 0x700000ED
| 010000000000D617
| [17.0.0+] AeLibraryApplet4
|-
| 0x700000F0
| 010000000000D60A
| [17.0.0+] AppletISA
|-
| 0x700000F1
| 010000000000D60B
| [17.0.0+] AppletIOA
|-
| 0x700000F2
| 010000000000D60C
| [17.0.0+] AppletISTA
|-
| 0x700000F3
| 010000000000D60D
| [17.0.0+] AppletILA1
|-
| 0x700000F4
| 010000000000D60E
| [17.0.0+] AppletILA2
|}

= LibraryAppletMode =
This is "nn::applet::LibraryAppletMode".

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0x0
| AllForeground
|-
| 0x1
| PartialForeground
|-
| 0x2
| NoUi
|-
| 0x3
| PartialForegroundWithIndirectDisplay (see also [[#GetIndirectLayerConsumerHandle]], only used by swkbd [[Software_Keyboard|InlineKeyboard]])
|-
| 0x4
| AllForegroundInitiallyHidden (can be used by [7.0.0+] [[Internet_Browser|WebSession]])
|}

= AppletMessage =
This is "nn::am::AppletMessage".

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || None
|-
| 1 || ChangeIntoForeground
|-
| 2 || ChangeIntoBackground
|-
| 4 || Exit
|-
| 6 || ApplicationExited
|-
| 15 || [[#FocusState|FocusStateChanged]]
|-
| 16 || [[#SetRestartMessageEnabled|Resume]]
|-
| 20 || DetectShortPressingHomeButton
|-
| 21 || DetectLongPressingHomeButton
|-
| 22 || DetectShortPressingPowerButton
|-
| 23 || DetectMiddlePressingPowerButton
|-
| 24 || DetectLongPressingPowerButton
|-
| 25 || RequestToPrepareSleep
|-
| 26 || FinishedSleepSequence
|-
| 27 || SleepRequiredByHighTemperature
|-
| 28 || SleepRequiredByLowBattery
|-
| 29 || AutoPowerDown
|-
| 30 || [[#OperationMode|OperationModeChanged]]
|-
| 31 || [[#PerformanceMode|PerformanceModeChanged]]
|-
| 32 || DetectReceivingCecSystemStandby
|-
| 33 || SdCardRemoved
|-
| 50 || LaunchApplicationRequested
|-
| 51 || [[#SetHandlesRequestToDisplay|RequestToDisplay]]
|-
| 55 || ShowApplicationLogo
|-
| 56 || HideApplicationLogo
|-
| 57 || ForceHideApplicationLogo
|-
| 60 || FloatingApplicationDetected
|-
| 90 || [[#SetRequiresCaptureButtonShortPressedMessage|DetectShortPressingCaptureButton]]
|-
| 92 || [[#SetAlbumImageTakenNotificationEnabled|AlbumScreenShotTaken]]
|-
| 93 || AlbumRecordingSaved
|}

= OperationMode =
This is "nn::oe::OperationMode".

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || Handheld
|-
| 1 || Console
|}

= PerformanceMode =
This is "nn::oe::PerformanceMode".

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| -1 || Invalid
|-
| 0 || Normal
|-
| 1 || Boost
|}

= FocusState =
This is "nn::oe::FocusState".

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 1 || InFocus
|-
| 2 || OutOfFocus
|-
| 3 || Background
|}

= CpuBoostMode =
This is "nn::oe::CpuBoostMode".

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || Normal
|-
| 1 || FastLoad
|}

= WindowOriginMode =
This is "nn::oe::WindowOriginMode".

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || LowerLeft
|-
| 1 || UpperLeft
|}

= WirelessPriorityMode =
This is "nn::oe::WirelessPriorityMode".

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || Default
|-
| 1 || OptimizedForWlan
|}

= TvPowerStateMatchingMode =
This is "nn::oe::TvPowerStateMatchingMode". This is used with [[#SetTvPowerStateMatchingMode]].

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || Unknown
|-
| 1 || Unknown
|}

= SystemButtonType =
This is "nn::am::service::SystemButtonType". This is used with [[#PerformSystemButtonPressingIfInFocus]]/[[#PerformSystemButtonPressing]].

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 1 || PerformHomeButtonShortPressing
|-
| 2 || PerformHomeButtonLongPressing
|-
| 3 || Short-pressing with the Power-button. Only available with [[#PerformSystemButtonPressing]].
|-
| 4 || Long-pressing with the Power-button. Only available with [[#PerformSystemButtonPressing]].
|-
| 5 || Shutdown the system. Only available with [[#PerformSystemButtonPressing]].
|-
| 6 || PerformCaptureButtonShortPressing
|-
| 7 || PerformCaptureButtonLongPressing
|}

= LaunchParameterKind =
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 1 || UserChannel. Application-specific LaunchParameter.
|-
| 2 || account PreselectedUser
|-
| 3 || Unknown if used by anything?
|}

= LibraryAppletExitReason =
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || Normal
|-
| 1 || Canceled
|-
| 2 || Abnormal
|-
| 10 || Unexpected
|}

= ProgramSpecifyKind =
This is "nn::am::service::ProgramSpecifyKind". This controls the type of the u64 passed to [[#ExecuteProgram]].

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || u8 ProgramIndex. "ExecuteProgram". [[NS_Services|NS]] handles ProgramIndex by launching ApplicationId+ProgramIndex. After using [[#ExecuteProgram]] with this successfully, official user-processes will enter an infinite loop with sleep-thread value 86400000000000.
|-
| 1 || [[NCM_services#ApplicationId|ApplicationId]]. "JumpToSubApplicationProgramForDevelopment". Only available when [[Settings_services#GetDebugModeFlag|DebugMode]] is 1.
|-
| 2 || u64 = value 0. "RestartProgram"
|}

ProgramIndex values where the title is not installed should not be used: [[qlaunch]] will display an error message and the current title will become "corrupted", however Home Menu will have an option to repair it.

= InputDetectionPolicy =
This is u32 enum "nn::applet::InputDetectionPolicy".

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || Unknown
|-
| 1 || Unknown
|}

= AppletResourceUserId =
This is "nn::applet::AppletResourceUserId". Used by a number of non-AM services.

= AppletAttribute =
This is "nn::am::AppletAttribute". This struct is 0x80 bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x1 || Flag. When non-zero, two state fields are set to 1.
|-
| 0x1 || 0x7F || Unused
|}

This is used by [[#OpenLibraryAppletProxy]].

= AppletProcessLaunchReason =
This is "nn::am::service::AppletProcessLaunchReason". This struct is 0x4-bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x1 || Flag. When non-zero, LibraryApplets then use [[#OpenCallingLibraryApplet]].
|-
| 0x1 || 0x2 || Always 0.
|-
| 0x3 || 0x1 || Always 0.
|}

= LibraryAppletInfo =
This is "nn::am::service::LibraryAppletInfo". This struct is 0x8-bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || [[#AppletId]]
|-
| 0x4 || 0x4 || [[#LibraryAppletMode]]
|}

= AppletKind =
This is "nn::am::service::AppletKind". This is 8-bytes.

= AppletIdentityInfo =
This struct is "nn::am::service::AppletIdentityInfo". This struct is 0x10-bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || [[#AppletId]]
|-
| 0x4 || 0x4 || Padding
|-
| 0x8 || 0x8 || [[NCM_services#ApplicationId|ApplicationId]]
|}

= ApplicationAttributeForQuest =
This struct is "nn::applet::ApplicationAttributeForQuest".

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || See [[#ApplicationAttribute]].
|-
| 0x4 || 0x4 || See [[#ApplicationAttribute]].
|-
| 0x8 || 0x4 || [7.0.0+] See [[#ApplicationAttribute]].
|}

User-processes copy the first 0x8-bytes (0xC-bytes with [[#CreateApplicationWithAttributeAndPushAndRequestToStartForQuest]]/[[#CreateApplicationWithAttributeAndRequestToStartForQuest]]) to a [[#ApplicationAttribute]] with the rest of the struct being cleared, which is then passed to the actual cmd (CreateApplication*ToStartForQuest).

= ApplicationAttribute =
This struct is "nn::am::ApplicationAttribute". This struct is 0x20-bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || Default is 0 for non-Quest. Only used when non-zero: unknown value in seconds.
|-
| 0x4 || 0x4 || Default is 0 for non-Quest. Only used when non-zero: unknown value in seconds.
|-
| 0x8 || 0x4 || float audio volume. Must be in the range of 0.0f-1.0f. The default is 1.0f.
|-
| 0xC || 0x14 || Unused. Default is 0.
|}

Internally AM only uses the first 0xC-bytes from ApplicationAttribute, regardless of the cmd.

= ApplicationLaunchProperty =
This struct is 0x10-bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || [[NCM_services#ApplicationId|ApplicationId]]
|-
| 0x8 || 0x4 || Application title-version.
|-
| 0xC || 0x1 || [[Filesystem_services#StorageId|StorageId]] for the Application base title.
|-
| 0xD || 0x1 || [[Filesystem_services#StorageId|StorageId]] for the Application update title.
|-
| 0xE || 0x1 || Unknown.
|-
| 0xF || 0x1 || Padding.
|}

= ApplicationLaunchRequestInfo =
This is "nn::applet::ApplicationLaunchRequestInfo". This struct is 0x10-bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || Unknown. The default is 0x0 with [[#CreateSystemApplication]], 0x3 with [[#CreateApplication]].
|-
| 0x4 || 0x4 || Unknown. The default is 0x0 with [[#CreateSystemApplication]], 0x3 with [[#CreateApplication]].
|-
| 0x8 || 0x8 || Unknown. The default is 0x0.
|}

= AppletResourceUsageInfo =
This is "nn::am::service::AppletResourceUsageInfo". This struct is 0x20-bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || Unknown counter.
|-
| 0x4 || 0x4 || Unknown counter.
|-
| 0x8 || 0x4 || Output from [[NS_Services|NS GetRightsEnvironmentCountForDebug]].
|-
| 0xC || 0x14 || Always zero.
|}

= ApplicationLicenseType =
This is "nn::oe::ApplicationLicenseType". This is 1-byte.

= LaunchRequiredVersion =
This is "nn::oe::LaunchRequiredVersion". This is a 0x40-byte struct with 1-byte alignment.

= ServerEnvironmentType =
This is "nn::oe::ServerEnvironmentType".

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || dd
|-
| 1 || lp
|-
| 2 || sd
|-
| 3 || sp
|-
| 4 || dp
|}

= Notes =
AM-sysmodule will only initialize [[Shared_Database_services|pdm:ntfy]] / use pdm:ntfy service commands when the value from [[Process_Manager_services|pm:bm]] GetBootMode is not 0x1 (Maintenance).

An object constructor also writes the output from [[Process_Manager_services|pm:bm]] GetBootMode into the created object. A vfunc for this object checks whether this field is Maintenance: if so, it calls a vfunc then a func and returns. Otherwise after calling various (v)funcs, if required this eventually uses [[OMM_services|ommdisp]] cmd600.

[[Category:Services]]

Applet Manager services

2023-09-23T17:28:26Z

Liamwhite: /* AppletAttribute */

AM (Applet Manager) provides services for interacting with system applets while abstracting several aspects of power and operation management.

Contains multiple raw images, with at least the following: "NN_OMM_CHARGING_BIN_{begin|end}"(charging icon), low-battery icon, and the Nintendo Switch logo displayed during system boot.

= appletAE =
This is "nn::am::service::IAllSystemAppletProxiesService".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 100 || OpenSystemAppletProxy || Returns an [[#ISystemAppletProxy]].
|-
| 200 || OpenLibraryAppletProxyOld ([1.0.0-2.3.0] OpenLibraryAppletProxy) || Returns an [[#ILibraryAppletProxy]].
|-
| 201 || [3.0.0+] [[#OpenLibraryAppletProxy]] || Returns an [[#ILibraryAppletProxy]].
|-
| 300 || OpenOverlayAppletProxy || Returns an [[#IOverlayAppletProxy]].
|-
| 350 || OpenSystemApplicationProxy || Returns an [[#IApplicationProxy]].
|-
| 400 || [[#CreateSelfLibraryAppletCreatorForDevelop]] ||
|-
| 410 || [6.0.0+] [[#GetSystemAppletControllerForDebug]] ||
|-
| 1000 || [6.0.0+] [[#GetDebugFunctions]] ||
|}

All of these Open*Proxy commands except [[#OpenLibraryAppletProxy]] take the same input as [[#OpenApplicationProxy]], with the same user-process retry-loop as [[#OpenApplicationProxy]]. These Open*Proxy commands (including appletOE) doesn't seem to usable from processes which aren't actual applets (such as sysmodules), at least for applet-types which aren't already in use.

OpenLibraryAppletProxyOld eventually calls the same func as [[#OpenLibraryAppletProxy]], except that the [[#AppletAttribute]] is all-zero.

This service is used by all system non-regular-applications.

The 01000000000010XX system [[Title_list|titles]] use the following applet types(above Open{type}Proxy commands):
* "qlaunch": SystemApplet
* "overlay": OverlayApplet
* "starter": SystemApplication
* "maintenance": SystemApplet
* All others: LibraryApplet

== OpenLibraryAppletProxy ==
Returns an [[#ILibraryAppletProxy]].

Takes a [[IPC_Marshalling|reserved]] input u64(official user-processes use hard-coded value 0), a PID,a process copy-handle(cur-proc handle alias), and a type-0x15 input buffer containing an [[#AppletAttribute]].

Official user-processes use the same retry loop with this as the other Open*Proxy commands.

== CreateSelfLibraryAppletCreatorForDevelop ==
Takes a PID and an input u64 pid_placeholder, returns an [[#ILibraryAppletCreator]].

The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.

The cached value loaded from [[System_Settings|system-setting]] <code>am.debug!dev_function</code> must be set to 0x1 with size 0x1, otherwise an error is returned.

== GetSystemAppletControllerForDebug ==
No input, returns an [[#ISystemAppletControllerForDebug]].

The cached value loaded from [[System_Settings|system-setting]] <code>am.debug!dev_function</code> must be set to 0x1 with size 0x1, and various state checks must pass, otherwise 0 is returned with no output interface.

== GetDebugFunctions ==
No input, returns an [[#IDebugFunctions]].

The cached value loaded from [[System_Settings|system-setting]] <code>am.debug!dev_function</code> must be set to 0x1 with size 0x1, otherwise 0 is returned with no output interface.

== ISystemAppletProxy ==
This is "nn::am::service::ISystemAppletProxy".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || GetCommonStateGetter || Returns an [[#ICommonStateGetter]].
|-
| 1 || GetSelfController || Returns an [[#ISelfController]].
|-
| 2 || GetWindowController || Returns an [[#IWindowController]].
|-
| 3 || GetAudioController || Returns an [[#IAudioController]].
|-
| 4 || GetDisplayController || Returns an [[#IDisplayController]].
|-
| 10 || GetProcessWindingController || Returns an [[#IProcessWindingController]].
|-
| 11 || GetLibraryAppletCreator || Returns an [[#ILibraryAppletCreator]].
|-
| 20 || GetHomeMenuFunctions || Returns an [[#IHomeMenuFunctions]].
|-
| 21 || GetGlobalStateController || Returns an [[#IGlobalStateController]].
|-
| 22 || GetApplicationCreator || Returns an [[#IApplicationCreator]].
|-
| 23 || [7.0.0+] GetAppletCommonFunctions || Returns an [[#IAppletCommonFunctions]].
|-
| 1000 || GetDebugFunctions || Returns an [[#IDebugFunctions]].
|}

=== IHomeMenuFunctions ===
This is "nn::am::service::IHomeMenuFunctions".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 10 || [[#RequestToGetForeground]]
|-
| 11 || [[#LockForeground]]
|-
| 12 || [[#UnlockForeground]]
|-
| 20 || [[#PopFromGeneralChannel]]
|-
| 21 || [[#GetPopFromGeneralChannelEvent]]
|-
| 30 || [[#GetHomeButtonWriterLockAccessor]]
|-
| 31 || [2.0.0+] [[#GetWriterLockAccessorEx]]
|-
| 40 || [11.0.0+] [[#IsSleepEnabled]]
|-
| 41 || [12.0.0+] [[#IsRebootEnabled]]
|-
| 50 || [16.0.0+] [[#LaunchSystemApplet]]
|-
| 51 || [16.0.0+] [[#LaunchStarter]]
|-
| 100 || [6.0.0+] [[#PopRequestLaunchApplicationForDebug]]
|-
| 110 || [9.0.0+] [[#IsForceTerminateApplicationDisabledForDebug]]
|-
| 200 || [8.0.0+] [[#LaunchDevMenu]]
|-
| 1000 || [11.0.0+] [[#SetLastApplicationExitReason]]
|}

==== RequestToGetForeground ====
No input/output.

==== LockForeground ====
No input/output.

==== UnlockForeground ====
No input/output.

==== PopFromGeneralChannel ====
No input, returns an output [[#IStorage]].

==== GetPopFromGeneralChannelEvent ====
No input, returns an output Event handle with autoclear=false.

==== GetHomeButtonWriterLockAccessor ====
No input, returns an output [[#ILockAccessor]].

Similar to using [[#GetWriterLockAccessorEx]] with inval=0.

==== GetWriterLockAccessorEx ====
Takes an input u32, returns an output [[#ILockAccessor]].

The input value must be 0-3. 0 = HomeButton.

==== IsSleepEnabled ====
No input, returns an output bool.

==== IsRebootEnabled ====
No input, returns an output bool.

==== LaunchSystemApplet ====
No input/output.

This wraps [[NS_Services|ns]] LaunchSystemApplet, ignoring the u64 returned by that cmd (and other functionality).

==== LaunchStarter ====
No input/output.

This is similar to [[#LaunchSystemApplet]], except this uses [[NS_Services|ns]] LaunchLibraryApplet with a ProgramId from global state.

The global state field is initialized elsewhere with the value of [[System_Settings|system-setting]] <code>am.debug!starter_id</code>, defaulting to ProgramId 0100000000001012 ([[Title_list|starter]]) if not available.

==== PopRequestLaunchApplicationForDebug ====
Takes a type-0x6 output buffer containing an array of u128 userIDs, returns an output [[NCM_services#ApplicationId|ApplicationId]] and an output s32 '''total_userIDs'''.

The total entries in the userID buffer must be >= {total userIDs in state}.

==== IsForceTerminateApplicationDisabledForDebug ====
No input, returns an output u8 bool.

When the cached value loaded from [[Settings_services#GetDebugModeFlag]] is 0 this will just set the bool to 0. Otherwise, the bool is loaded using data from [[System_Settings|system-setting]] <code>am.debug!disable_force_terminate_application</code>.

==== LaunchDevMenu ====
No input/output.

The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.

Uses [[NS_Services|ns]] LaunchDevMenu.

This is used by [[qlaunch]]. On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.

==== SetLastApplicationExitReason ====
Takes an input s32, no output.

==== ILockAccessor ====
This is "nn::am::service::ILockAccessor".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 1 || [[#TryLock]]
|-
| 2 || [[#Unlock]]
|-
| 3 || [[#GetEvent]]
|-
| 4 || [10.0.0+] [[#IsLocked]]
|}

===== TryLock =====
Takes an input u8 bool flag, returns an output u8 bool flag and a handle.

Official sw waits on the previously loaded event from [[#GetEvent]]. The output flag indicates whether locking was successful, the user-process can try using this cmd again when flag=false.

Official sw only uses inflag=false. Official sw just closes the output handle. The input flag controls whether this returns the output handle.

===== Unlock =====
No input/output.

===== GetEvent =====
No input, returns an output Event handle with autoclear=false.

==== IsLocked ====
No input, returns an output u8 bool.

=== IGlobalStateController ===
This is "nn::am::service::IGlobalStateController".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#RequestToEnterSleep]]
|-
| 1 || [[#EnterSleep]]
|-
| 2 || [[#StartSleepSequence]]
|-
| 3 || [[#StartShutdownSequence]]
|-
| 4 || [[#StartRebootSequence]]
|-
| 9 || [7.0.0+] [[#IsAutoPowerDownRequested]]
|-
| 10 || [[#LoadAndApplyIdlePolicySettings]]
|-
| 11 || [2.0.0+] [[#NotifyCecSettingsChanged]]
|-
| 12 || [3.0.0+] [[#SetDefaultHomeButtonLongPressTime]]
|-
| 13 || [3.0.0+] [[#UpdateDefaultDisplayResolution]]
|-
| 14 || [3.0.0+] [[#ShouldSleepOnBoot]]
|-
| 15 || [4.0.0+] [[#GetHdcpAuthenticationFailedEvent]]
|-
| 30 || [12.0.0+] [[#OpenCradleFirmwareUpdater]]
|}

==== RequestToEnterSleep ====
No input/output.

Stubbed, just returns an error.

==== EnterSleep ====
No input/output.

Stubbed, just returns an error.

==== StartSleepSequence ====
Takes an input u8 bool, no output.

Official sw uses hard-coded input value = 1.

==== StartShutdownSequence ====
No input/output.

==== StartRebootSequence ====
No input/output.

==== IsAutoPowerDownRequested ====
No input, returns an output u8 bool.

Uses [[#idle:sys]] cmd1.

==== LoadAndApplyIdlePolicySettings ====
No input/output.

Uses [[#idle:sys]] cmd LoadAndApplySettings.

==== NotifyCecSettingsChanged ====
No input/output.

Uses [[#omm]] cmd NotifyCecSettingsChanged.

==== SetDefaultHomeButtonLongPressTime ====
Takes an input s64, no output.

==== UpdateDefaultDisplayResolution ====
No input/output.

Uses [[#omm]] cmd UpdateDefaultDisplayResolution.

==== ShouldSleepOnBoot ====
No input, returns an output u8 bool.

Uses [[#omm]] cmd ShouldSleepOnBoot.

==== GetHdcpAuthenticationFailedEvent ====
No input, returns an output Event handle with autoclear=false.

Uses [[#omm]] cmd GetHdcpAuthenticationFailedEvent.

==== OpenCradleFirmwareUpdater ====
No input, returns an [[#ICradleFirmwareUpdater]].

=== ICradleFirmwareUpdater ===
This is "nn::am::service::ICradleFirmwareUpdater".

This was added with [12.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || StartUpdate
|-
| 1 || FinishUpdate
|-
| 2 || [[#GetCradleDeviceInfo]]
|-
| 3 || GetCradleDeviceInfoChangeEvent
|-
| 4 || GetUpdateProgressInfo
|-
| 5 || GetLastInternalResult
|}

==== GetCradleDeviceInfo ====
No input, returns a 8-byte CradleDeviceInfo.

[13.0.0+] Now returns a total of 0xC-bytes.

=== IApplicationCreator ===
This is "nn::am::service::IApplicationCreator".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#CreateApplication]]
|-
| 1 || [[#PopLaunchRequestedApplication]]
|-
| 10 || [[#CreateSystemApplication]]
|-
| 100 || [[#PopFloatingApplicationForDevelopment]]
|}

[[#CreateApplication]]/[[#CreateSystemApplication]] eventually call the same internal func. With [[#CreateApplication]], two ptrs passed to the internal func are NULL, while with [[#CreateSystemApplication]] these are loaded from state. The initial content of [[#ApplicationLaunchRequestInfo]] is all-zero with [[#CreateSystemApplication]], while with [[#CreateApplication]] the first two u32s are value 0x3 with the rest all-zero. The [[#AppletId]] is set to 0x01 with [[#CreateApplication]], while with [[#CreateSystemApplication]] it's 0x04.

==== CreateApplication ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an [[#IApplicationAccessor]].

==== PopLaunchRequestedApplication ====
No input, returns an [[#IApplicationAccessor]].

==== CreateSystemApplication ====
Takes an input [[NCM_services#ApplicationId|SystemApplicationId]], returns an [[#IApplicationAccessor]].

[[qlaunch]] only uses this with a hard-coded id for the "starter" title.

==== PopFloatingApplicationForDevelopment ====
No input, returns an [[#IApplicationAccessor]].

Should not be used if no FloatingApplication is available (svcBreak).

==== IApplicationAccessor ====
This is "nn::am::service::IApplicationAccessor".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#GetAppletStateChangedEvent]] ||
|-
| 1 || [[#IsCompleted]] ||
|-
| 10 || [[#Start]] ||
|-
| 20 || [[#RequestExit]] ||
|-
| 25 || [[#Terminate]] ||
|-
| 30 || [[#GetResult]] ||
|-
| 101 || [[#RequestForApplicationToGetForeground]] ||
|-
| 110 || [[#TerminateAllLibraryApplets]] ||
|-
| 111 || [[#AreAnyLibraryAppletsLeft]] ||
|-
| 112 || [[#GetCurrentLibraryApplet]] ||
|-
| 120 || [[#GetApplicationId]] ||
|-
| 121 || [[#PushLaunchParameter]] ||
|-
| 122 || [[#GetApplicationControlProperty]] ||
|-
| 123 || [2.0.0+] [[#GetApplicationLaunchProperty]] ||
|-
| 124 || [6.0.0+] [[#GetApplicationLaunchRequestInfo]] ||
|-
| 130 || [6.0.0+] [[#SetUsers]] ||
|-
| 131 || [6.0.0+] [[#CheckRightsEnvironmentAvailable]] ||
|-
| 132 || [6.0.0+] [[#GetNsRightsEnvironmentHandle]] ||
|-
| 140 || [6.0.0+] [[#GetDesirableUids]] ||
|-
| 150 || [6.0.0+] [[#ReportApplicationExitTimeout]] ||
|-
| 160 || [8.0.0+] [[#SetApplicationAttribute]] ||
|-
| 170 || [8.0.0+] [[#HasSaveDataAccessPermission]] ||
|-
| 180 || [9.0.0+] [[#PushToFriendInvitationStorageChannel]] ||
|-
| 190 || [9.0.0+] [[#PushToNotificationStorageChannel]] ||
|-
| 200 || [10.0.0+] [[#RequestApplicationSoftReset]] ||
|-
| 201 || [10.0.0+] [[#RestartApplicationTimer]] ||
|}

Commands <=30 are inherited from [[#IAppletAccessor]].

===== RequestForApplicationToGetForeground =====
No input/output.

===== GetCurrentLibraryApplet =====
No input, returns an output [[#IAppletAccessor]].

===== GetApplicationId =====
No input, returns an output [[NCM_services#ApplicationId|ApplicationId]].

===== PushLaunchParameter =====
Takes an input u32 [[#LaunchParameterKind]] and an input [[#IStorage]], no output.

===== GetApplicationControlProperty =====
No input, takes a type-0x6 output buffer.

The output buffer must be at least 0x4000-bytes. Returns an error when the [[#AppletId]] is 0x04, aka when the IApplicationAccessor is for a SystemApplication.

This gets the application [[NACP_Format|control.nacp]].

===== GetApplicationLaunchProperty =====
Takes a type-0x6 output buffer.

The output buffer size must be at least 0x10-bytes. Returns an error when the [[#AppletId]] is 0x04, aka when the IApplicationAccessor is for a SystemApplication.

This gets the [[#ApplicationLaunchProperty]].

===== GetApplicationLaunchRequestInfo =====
No input, returns an output 0x10-byte struct.

This gets the [[#ApplicationLaunchRequestInfo]] from state. The output struct is "nn::applet::ApplicationLaunchRequestInfo".

===== SetUsers =====
Takes an input u8 bool flag and a type-0x5 input buffer containing an array of u128 userIDs.

The total entries for the userIDs must be <=8.

When the input flag is true, this just clears the '''users_available''' state flag to 0 and returns.

===== CheckRightsEnvironmentAvailable =====
No input, returns an output u8 bool.

===== GetNsRightsEnvironmentHandle =====
No input, returns an output u64.

===== GetDesirableUids =====
Takes a type-0x6 output buffer containing an array of u128 userIDs, returns an output s32 '''total_entries'''.

Gets a userID listing, this is unrelated to [[#SetUsers]]. [[qlaunch]] only uses 1 userID with this.

The stored entry-count in state must be <= <size of output buffer in entries>.

===== ReportApplicationExitTimeout =====
No input/output.

===== SetApplicationAttribute =====
Takes a type-0x15 input buffer containing an [[#ApplicationAttribute]], no output.

===== HasSaveDataAccessPermission =====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], returns an output u8 bool flag.

Gets whether the savedata specified by the input ApplicationId is accessible. The output flag indicates whether it's accessible.

If the ApplicationId matches the current application, this immediately returns success with flag=1.

===== PushToFriendInvitationStorageChannel =====
Takes an input [[#IStorage]], no output.

Clears the FriendInvitation StorageChannel, then pushes the input storage there.

===== PushToNotificationStorageChannel =====
Takes an input [[#IStorage]], no output.

Clears the Notification StorageChannel, then pushes the input storage there.

[[qlaunch]] will only push data for this when launching the Application when the Alarm was triggered, where the system was previously in sleep-mode. This data is the [[Glue_services|Notification]] ApplicationParameter.

===== RequestApplicationSoftReset =====
No input/output.

===== RestartApplicationTimer =====
No input/output.

===== IAppletAccessor =====
This is "nn::am::service::IAppletAccessor".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#GetAppletStateChangedEvent]]
|-
| 1 || [[#IsCompleted]]
|-
| 10 || [[#Start]]
|-
| 20 || [[#RequestExit]]
|-
| 25 || [[#Terminate]]
|-
| 30 || [[#GetResult]]
|}

==== GetAppletStateChangedEvent ====
No input, returns an output event handle with autoclear=false.

==== IsCompleted ====
No input, returns an output u8 bool.

==== Start ====
No input/output.

==== RequestExit ====
No input/output.

==== Terminate ====
No input/output.

==== GetResult====
No input/output.

== IAppletCommonFunctions ==
This is "nn::am::service::IAppletCommonFunctions".

This was added with [7.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [9.0.0+] [[#SetTerminateResult]]
|-
| 10 || [[#ReadThemeStorage]]
|-
| 11 || [[#WriteThemeStorage]]
|-
| 20 || [9.0.0+] [[#PushToAppletBoundChannel]]
|-
| 21 || [9.0.0+] [[#TryPopFromAppletBoundChannel]]
|-
| 40 || [8.0.0+] [[#GetDisplayLogicalResolution]]
|-
| 42 || [8.0.0+] [[#SetDisplayMagnification]]
|-
| 50 || [8.0.0+] [[#SetHomeButtonDoubleClickEnabled]]
|-
| 51 || [8.0.0+] [[#GetHomeButtonDoubleClickEnabled]]
|-
| 52 || [10.0.0+] [[#IsHomeButtonShortPressedBlocked]]
|-
| 60 || [11.0.0+] [[#IsVrModeCurtainRequired]]
|-
| 61 || [12.0.0+] IsSleepRequiredByHighTemperature
|-
| 62 || [12.0.0+] IsSleepRequiredByLowBattery
|-
| 70 || [11.0.0+] [[#SetCpuBoostRequestPriority]]
|-
| 80 || [14.0.0+] SetHandlingCaptureButtonShortPressedMessageEnabledForApplet
|-
| 81 || [14.0.0+] SetHandlingCaptureButtonLongPressedMessageEnabledForApplet
|-
| 90 || [15.0.0+] OpenNamedChannelAsParent
|-
| 91 || [15.0.0+] OpenNamedChannelAsChild
|-
| 100 || [15.0.0+] SetApplicationCoreUsageMode
|}

ReadThemeStorage/WriteThemeStorage: these commands copy data from/to a state buffer and the user specified buffer. The size of the state buffer is 0x400-bytes. The default content of the ThemeStorage prior to using the WriteThemeStorage cmd, is: <code>memset(statebuf, 0xAA, 0x400);</code>

=== ReadThemeStorage ===
Takes an input u64 '''offset''' and a type-0x22 output buffer, returns an output u64 '''actual_transfer_size'''.

=== WriteThemeStorage ===
Takes an input u64 '''offset''' and a type-0x21 input buffer, no output.

=== PushToAppletBoundChannel ===
Takes an input [[#IStorage]], no output.

This is similar to [[#PushToAppletBoundChannelForDebug]] (no DebugMode check), except the used s32 is loaded from elsewhere and must be in the range 31-32.

=== TryPopFromAppletBoundChannel ===
No input, returns an output [[#IStorage]].

This is similar to [[#TryPopFromAppletBoundChannelForDebug]] (no DebugMode check), except the used s32 is loaded from elsewhere and must be in the range 31-32.

=== GetDisplayLogicalResolution ===
No input, returns an output s32 '''width''' and s32 '''height'''.

=== SetDisplayMagnification ===
Takes an input float '''x''', float '''y''', float '''width''', and float '''height''', no output.

Sets the DisplayMagnification. This is essentially layer image crop, for everything non-Overlay.

'''x''' and '''width''' are multiplied with the same width value returned by [[#GetDisplayLogicalResolution]], so these should be in the range 0.0f-1.0f. Likewise for y and height, except these are multipled with the height value.

=== SetHomeButtonDoubleClickEnabled ===
Takes an input u8 bool, no output.

=== GetHomeButtonDoubleClickEnabled ===
No input, returns an output u8 bool.

=== IsHomeButtonShortPressedBlocked ===
No input, returns an output u8 bool.

=== IsVrModeCurtainRequired ===
No input, returns an output bool.

=== SetCpuBoostRequestPriority ===
Takes an input s32, no output.

== ILibraryAppletProxy ==
This is "nn::am::service::ILibraryAppletProxy".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || GetCommonStateGetter || Returns an [[#ICommonStateGetter]].
|-
| 1 || GetSelfController || Returns an [[#ISelfController]].
|-
| 2 || GetWindowController || Returns an [[#IWindowController]].
|-
| 3 || GetAudioController || Returns an [[#IAudioController]].
|-
| 4 || GetDisplayController || Returns an [[#IDisplayController]].
|-
| 10 || GetProcessWindingController || Returns an [[#IProcessWindingController]].
|-
| 11 || GetLibraryAppletCreator || Returns an [[#ILibraryAppletCreator]].
|-
| 20 || OpenLibraryAppletSelfAccessor || Returns an [[#ILibraryAppletSelfAccessor]].
|-
| 21 || [7.0.0+] GetAppletCommonFunctions || No input, returns an [[#IAppletCommonFunctions]].
|-
| 22 || [15.0.0+] GetHomeMenuFunctions || No input, returns an [[#IHomeMenuFunctions]].
|-
| 23 || [15.0.0+] GetGlobalStateController || No input, returns an [[#IGlobalStateController]].
|-
| 1000 || GetDebugFunctions || Returns an [[#IDebugFunctions]].
|}

=== ILibraryAppletSelfAccessor ===
This is "nn::am::service::ILibraryAppletSelfAccessor".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#PopInData]] ||
|-
| 1 || [[#PushOutData]] ||
|-
| 2 || [[#PopInteractiveInData]] ||
|-
| 3 || [[#PushInteractiveOutData]] ||
|-
| 5 || [[#GetPopInDataEvent]] ||
|-
| 6 || [[#GetPopInteractiveInDataEvent]] ||
|-
| 10 || [[#ExitProcessAndReturn]] ||
|-
| 11 || [[#GetLibraryAppletInfo]] ||
|-
| 12 || [[#GetMainAppletIdentityInfo]] ||
|-
| 13 || [[#CanUseApplicationCore]] ||
|-
| 14 || [[#GetCallerAppletIdentityInfo]] ||
|-
| 15 || [2.0.0+] [[#GetMainAppletApplicationControlProperty]] ||
|-
| 16 || [2.0.0+] [[#GetMainAppletStorageId]] ||
|-
| 17 || [3.0.0+] [[#GetCallerAppletIdentityInfoStack]] ||
|-
| 18 || [4.0.0+] [[#GetNextReturnDestinationAppletIdentityInfo]] ||
|-
| 19 || [4.0.0+] [[#GetDesirableKeyboardLayout]] ||
|-
| 20 || [[#PopExtraStorage]] ||
|-
| 25 || [[#GetPopExtraStorageEvent]] ||
|-
| 30 || [[#UnpopInData]] ||
|-
| 31 || [[#UnpopExtraStorage]] ||
|-
| 40 || [2.0.0+] [[#GetIndirectLayerProducerHandle]] ||
|-
| 50 || [3.0.0+] [[#ReportVisibleError]] ||
|-
| 51 || [4.0.0+] [[#ReportVisibleErrorWithErrorContext]] ||
|-
| 60 || [4.0.0+] [[#GetMainAppletApplicationDesiredLanguage]] ||
|-
| 70 || [8.0.0+] [[#GetCurrentApplicationId]] ||
|-
| 80 || [6.0.0+] [[#RequestExitToSelf]] ||
|-
| 90 || [5.0.0+] [[#CreateApplicationAndPushAndRequestToLaunch]] ||
|-
| 100 || [4.0.0+] [[#CreateGameMovieTrimmer]] ||
|-
| 101 || [5.0.0+] [[#ReserveResourceForMovieOperation]] ||
|-
| 102 || [5.0.0+] [[#UnreserveResourceForMovieOperation]] ||
|-
| 110 || [6.0.0+] [[#GetMainAppletAvailableUsers]] ||
|-
| 120 || [9.0.0+] [[#GetLaunchStorageInfoForDebug]] ||
|-
| 130 || [9.0.0+] [[#GetGpuErrorDetectedSystemEvent]] ||
|-
| 140 || [10.0.0+] [[#SetApplicationMemoryReservation]] ||
|-
| 150 || [10.0.0+] [[#ShouldSetGpuTimeSliceManually]] ||
|}

==== PopInData ====
No input, returns an output [[#IStorage]].

==== PushOutData ====
Takes an input [[#IStorage]], no output.

==== PopInteractiveInData ====
No input, returns an output [[#IStorage]].

==== PushInteractiveOutData ====
Takes an input [[#IStorage]], no output.

==== GetPopInDataEvent ====
No input, returns an output Event handle with autoclear=false.

==== GetPopInteractiveInDataEvent ====
No input, returns an output Event handle with autoclear=false.

==== ExitProcessAndReturn ====
No input/output.

Exits the LibraryApplet and returns to running the title which launched this LibraryApplet ([[qlaunch]] for example).

On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.

==== GetLibraryAppletInfo ====
No input, returns an output [[#LibraryAppletInfo]].

==== GetMainAppletIdentityInfo ====
No input, returns an output [[#AppletIdentityInfo]].

==== CanUseApplicationCore ====
No input, returns an output u8 bool.

==== GetCallerAppletIdentityInfo ====
No input, returns an output [[#AppletIdentityInfo]].

==== GetMainAppletApplicationControlProperty ====
No input, takes a type-0x16 output buffer.

This gets the [[NACP_Format|control.nacp]].

==== GetMainAppletStorageId ====
No input, returns an output u8 storageId.

==== GetCallerAppletIdentityInfoStack ====
Takes a type-0x6 output buffer containing an array of [[#AppletIdentityInfo]], and returns an output s32 total_entries.

==== GetNextReturnDestinationAppletIdentityInfo ====
No input, returns an output [[#AppletIdentityInfo]].

==== GetDesirableKeyboardLayout ====
No input, returns an output u32.

The output u32 is "nn::settings::KeyboardLayout".

This gets the value previously set by [[#SetDesirableKeyboardLayout]]. An error is returned if it's not set.

==== PopExtraStorage ====
No input, returns an output [[#IStorage]].

==== GetPopExtraStorageEvent ====
No input, returns an output Event handle with autoclear=false.

==== UnpopInData ====
Takes an input [[#IStorage]], no output.

==== UnpopExtraStorage ====
Takes an input [[#IStorage]], no output.

==== GetIndirectLayerProducerHandle ====
No input, returns an output u64.

==== ReportVisibleError ====
Takes an input [[Error_Applet#ErrorCode|ErrorCode]], no output.

==== ReportVisibleErrorWithErrorContext ====
Takes an input [[Error_Applet#ErrorCode|ErrorCode]] and a type-0x15 input buffer containing an [[Error_Applet#ErrorContext|ErrorContext]], no output.

==== GetMainAppletApplicationDesiredLanguage ====
No input, returns an output [[Settings_services#LanguageCode|LanguageCode]].

==== GetCurrentApplicationId ====
No input, returns an output [[NCM_services#ApplicationId|ApplicationId]].

Gets the [[NCM_services#ApplicationId|ApplicationId]] for the currently running Application. ApplicationId=0 when no Application is running.

==== RequestExitToSelf ====
No input/output.

Same as [[#RequestExit]] except this is for the current applet.

==== CreateApplicationAndPushAndRequestToLaunch ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]] and an input #IStorage, no output.

This is is similar to [[#CreateApplicationAndPushAndRequestToStart]].

==== CreateGameMovieTrimmer ====
Takes an input u64 size and a TransferMemory handle, returns a GRC [[GRC_services#IGameMovieTrimmer|IGameMovieTrimmer]].

This is a wrapper for GRC [[GRC_services#OpenGameMovieTrimmer|OpenGameMovieTrimmer]].

Official sw uses an user-buffer for the tmem, with permissions=0.

==== ReserveResourceForMovieOperation ====
No input/output.

Updates state fields. This must be used before [[#CreateGameMovieTrimmer]].

==== UnreserveResourceForMovieOperation ====
No input/output.

Updates state fields. This must be used once finished with [[GRC_services#IGameMovieTrimmer|IGameMovieTrimmer]].

==== GetMainAppletAvailableUsers ====
Takes a type-0x6 output buffer containing an array of u128 userIDs, returns an output u8 bool and a s32 '''total_entries'''.

This gets the userIDs previously set by [[#SetUsers]].

The size of the output buffer in entries must be at least 8.

Normally the output bool is set to 0, however when no users are available it's set to 1 with '''total_entries''' = -1.

==== SetApplicationMemoryReservation ====
Takes an input u64, no output.

An Application must be currently running. The input u64 must be 0x1000-byte aligned.

==== ShouldSetGpuTimeSliceManually ====
No input, returns an output u8 bool.

== IOverlayAppletProxy ==
This is "nn::am::service::IOverlayAppletProxy".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || GetCommonStateGetter || Returns an [[#ICommonStateGetter]].
|-
| 1 || GetSelfController || Returns an [[#ISelfController]].
|-
| 2 || GetWindowController || Returns an [[#IWindowController]].
|-
| 3 || GetAudioController || Returns an [[#IAudioController]].
|-
| 4 || GetDisplayController || Returns an [[#IDisplayController]].
|-
| 10 || GetProcessWindingController || Returns an [[#IProcessWindingController]].
|-
| 11 || GetLibraryAppletCreator || Returns an [[#ILibraryAppletCreator]].
|-
| 20 || GetOverlayFunctions || Returns an [[#IOverlayFunctions]].
|-
| 21 || [7.0.0+] GetAppletCommonFunctions || No input, returns an [[#IAppletCommonFunctions]].
|-
| 23 || [15.0.0+] GetGlobalStateController || No input, returns an [[#IGlobalStateController]].
|-
| 1000 || GetDebugFunctions || Returns an [[#IDebugFunctions]].
|}

=== IOverlayFunctions ===
This is "nn::am::service::IOverlayFunctions".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#BeginToWatchShortHomeButtonMessage]]
|-
| 1 || [[#EndToWatchShortHomeButtonMessage]]
|-
| 2 || [[#GetApplicationIdForLogo]]
|-
| 3 || [[#SetGpuTimeSliceBoost]]
|-
| 4 || [2.0.0+] [[#SetAutoSleepTimeAndDimmingTimeEnabled]]
|-
| 5 || [2.0.0+] [[#TerminateApplicationAndSetReason]]
|-
| 6 || [3.0.0+] [[#SetScreenShotPermissionGlobally]]
|-
| 10 || [6.0.0+] [[#StartShutdownSequenceForOverlay]]
|-
| 11 || [6.0.0+] [[#StartRebootSequenceForOverlay]]
|-
| 20 || [8.0.0+] [[#SetHandlingHomeButtonShortPressedEnabled]]
|-
| 21 || [14.0.0+] SetHandlingTouchScreenInputEnabled
|-
| 30 || [9.0.0+] [[#SetHealthWarningShowingState]]
|-
| 31 || [10.0.0+] [[#IsHealthWarningRequired]]
|-
| 90 || [7.0.0+] [[#SetRequiresGpuResourceUse]]
|-
| 101 || [5.0.0+] [[#BeginToObserveHidInputForDevelop]]
|}

==== BeginToWatchShortHomeButtonMessage ====
No input/output.

==== EndToWatchShortHomeButtonMessage ====
No input/output.

==== GetApplicationIdForLogo ====
No input, returns an output [[NCM_services#ApplicationId|ApplicationId]].

Gets the ApplicationId for displaying the logo screen during application launch.

When no application is running, this returns success with ApplicationId=0.

==== SetGpuTimeSliceBoost ====
Takes an input u64, no output.

==== SetAutoSleepTimeAndDimmingTimeEnabled ====
Takes an input u8 bool, no output.

==== TerminateApplicationAndSetReason ====
Takes an input u32 Result, no output.

==== SetScreenShotPermissionGlobally ====
Takes an input u8 bool, no output.

==== StartShutdownSequenceForOverlay ====
No input/output.

On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.

==== StartRebootSequenceForOverlay ====
No input/output.

On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.

==== SetHandlingHomeButtonShortPressedEnabled ====
Takes an input u8 bool, no output.

==== SetHealthWarningShowingState ====
Takes an input u8 bool, no output.

This writes the input bool into state, signals an Event, and returns 0.

==== IsHealthWarningRequired ====
No input, returns an output u8 bool.

==== SetRequiresGpuResourceUse ====
Takes an input u8 bool, no output.

Just returns 0.

==== BeginToObserveHidInputForDevelop ====
No input/output.

Sets various state fields and signals an userspace-event.

Enables HID input for the OverlayApplet, without disabling input for the foreground applet.

== IApplicationProxy ==
This is "nn::am::service::IApplicationProxy".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || GetCommonStateGetter || Returns an [[#ICommonStateGetter]].
|-
| 1 || GetSelfController || Returns an [[#ISelfController]].
|-
| 2 || GetWindowController || Returns an [[#IWindowController]].
|-
| 3 || GetAudioController || Returns an [[#IAudioController]].
|-
| 4 || GetDisplayController || Returns an [[#IDisplayController]].
|-
| 10 || GetProcessWindingController || Returns an [[#IProcessWindingController]].
|-
| 11 || GetLibraryAppletCreator || Returns an [[#ILibraryAppletCreator]].
|-
| 20 || GetApplicationFunctions || Returns an [[#IApplicationFunctions]].
|-
| 1000 || GetDebugFunctions || Returns an [[#IDebugFunctions]].
|}

=== IApplicationFunctions ===
This is "nn::am::service::IApplicationFunctions".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 1 || [[#PopLaunchParameter]]
|-
| 10 || [[#CreateApplicationAndPushAndRequestToStart]]
|-
| 11 || [3.0.0+] [[#CreateApplicationAndPushAndRequestToStartForQuest]]
|-
| 12 || [4.0.0+] [[#CreateApplicationAndRequestToStart]]
|-
| 13 || [4.0.0+] [[#CreateApplicationAndRequestToStartForQuest]]
|-
| 14 || [7.0.0+] [[#CreateApplicationWithAttributeAndPushAndRequestToStartForQuest]]
|-
| 15 || [7.0.0+] [[#CreateApplicationWithAttributeAndRequestToStartForQuest]]
|-
| 20 || [[#EnsureSaveData]]
|-
| 21 || [[#GetDesiredLanguage]]
|-
| 22 || [[#SetTerminateResult]]
|-
| 23 || [[#GetDisplayVersion]]
|-
| 24 || [2.0.0+] [[#GetLaunchStorageInfoForDebug]]
|-
| 25 || [3.0.0+] ExtendSaveData
|-
| 26 || [3.0.0+] GetSaveDataSize
|-
| 27 || [5.0.0+] CreateCacheStorage
|-
| 28 || [11.0.0+] [[#GetSaveDataSizeMax]]
|-
| 29 || [11.0.0+] [[#GetCacheStorageMax]]
|-
| 30 || [[#BeginBlockingHomeButtonShortAndLongPressed]]
|-
| 31 || [[#EndBlockingHomeButtonShortAndLongPressed]]
|-
| 32 || [[#BeginBlockingHomeButton]]
|-
| 33 || [[#EndBlockingHomeButton]]
|-
| 34 || [10.0.0-15.0.1] [[#SelectApplicationLicense]]
|-
| 35 || [11.0.0+] [[#GetDeviceSaveDataSizeMax]]
|-
| 36 || [14.0.0+] GetLimitedApplicationLicense
|-
| 37 || [14.0.0+] GetLimitedApplicationLicenseUpgradableEvent
|-
| 40 || [[#NotifyRunning]]
|-
| 50 || [2.0.0+] [[#GetPseudoDeviceId]]
|-
| 60 || [2.0.0+] [[#SetMediaPlaybackStateForApplication]]
|-
| 65 || [3.0.0+] [[#IsGamePlayRecordingSupported]]
|-
| 66 || [3.0.0+] [[#InitializeGamePlayRecording]]
|-
| 67 || [3.0.0+] [[#SetGamePlayRecordingState]]
|-
| 68 || [4.0.0+] [[#RequestFlushGamePlayingMovieForDebug]]
|-
| 70 || [3.0.0+] [[#RequestToShutdown]]
|-
| 71 || [3.0.0+] [[#RequestToReboot]]
|-
| 72 || [10.0.0+] [[#RequestToSleep]]
|-
| 80 || [4.0.0+] [[#ExitAndRequestToShowThanksMessage]]
|-
| 90 || [4.0.0+] [[#EnableApplicationCrashReport]]
|-
| 100 || [5.0.0+] [[#InitializeApplicationCopyrightFrameBuffer]]
|-
| 101 || [5.0.0+] [[#SetApplicationCopyrightImage]]
|-
| 102 || [5.0.0+] [[#SetApplicationCopyrightVisibility]]
|-
| 110 || [5.0.0+] [[#QueryApplicationPlayStatistics]]
|-
| 111 || [6.0.0+] [[#QueryApplicationPlayStatisticsByUid]]
|-
| 120 || [5.0.0+] [[#ExecuteProgram]]
|-
| 121 || [5.0.0+] [[#ClearUserChannel]]
|-
| 122 || [5.0.0+] [[#UnpopToUserChannel]]
|-
| 123 || [5.0.0+] [[#GetPreviousProgramIndex]]
|-
| 124 || [6.0.0+] [[#EnableApplicationAllThreadDumpOnCrash]]
|-
| 130 || [8.0.0+] [[#GetGpuErrorDetectedSystemEvent]]
|-
| 131 || [11.0.0+] [[#SetDelayTimeToAbortOnGpuError]]
|-
| 140 || [9.0.0+] [[#GetFriendInvitationStorageChannelEvent]]
|-
| 141 || [9.0.0+] [[#TryPopFromFriendInvitationStorageChannel]]
|-
| 150 || [9.0.0+] [[#GetNotificationStorageChannelEvent]]
|-
| 151 || [9.0.0+] [[#TryPopFromNotificationStorageChannel]]
|-
| 160 || [9.0.0+] [[#GetHealthWarningDisappearedSystemEvent]]
|-
| 170 || [9.0.0+] [[#SetHdcpAuthenticationActivated]]
|-
| 180 || [10.1.0+] [[#GetLaunchRequiredVersion]]
|-
| 181 || [10.1.0+] [[#UpgradeLaunchRequiredVersion]]
|-
| 190 || [11.0.0+] [[#SendServerMaintenanceOverlayNotification]]
|-
| 200 || [11.0.0+] [[#GetLastApplicationExitReason]]
|-
| 500 || [5.0.0+] [[#StartContinuousRecordingFlushForDebug]]
|-
| 1000 || [5.0.0+] [[#CreateMovieMaker]]
|-
| 1001 || [5.0.0+] [[#PrepareForJit]]
|}

The BOTW game uses this GamePlayRecording functionality from the main-nso "nninitStartup" function, with size 0x6000000(96MiB). The official GamePlayRecording-enable code does the following(this will panic on any failure):
* [[SVC|Creates]] TransferMemory using the input buffer and size, with permissions=0.
* Uses [[#InitializeGamePlayRecording]] with the TransferMemory.
* Closes the TransferMemory handle, + TransferMemory cleanup.
* Uses [[#SetGamePlayRecordingState]] with value 0x1.
This GamePlayRecording functionality presumably enables the video-recording usable starting with [[4.0.0]].

==== PopLaunchParameter ====
Takes an input u32 [[#LaunchParameterKind]], returns an output [[#IStorage]].

Pops a LaunchParameter [[#IStorage]], the storage will be removed from sysmodule state during this.

==== CreateApplicationAndPushAndRequestToStart ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]] and an input [[#IStorage]], no output. ApplicationId=0 can be used to relaunch the current application.

==== CreateApplicationAndPushAndRequestToStartForQuest ====
Takes 2 input u32s (loaded from struct [[#ApplicationAttributeForQuest]]), an input [[NCM_services#ApplicationId|ApplicationId]], and an input [[#IStorage]], no output.

==== CreateApplicationAndRequestToStart ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], no output.

Same as [[#CreateApplicationAndPushAndRequestToStart]] except without the input storage, official sw uses this when no input storage is specified.

==== CreateApplicationAndRequestToStartForQuest ====
Takes 2 input u32s (loaded from struct [[#ApplicationAttributeForQuest]]) and an input [[NCM_services#ApplicationId|ApplicationId]], no output.

Same as [[#CreateApplicationAndPushAndRequestToStartForQuest]] except without the input storage, official sw uses this when no input storage is specified.

==== CreateApplicationWithAttributeAndPushAndRequestToStartForQuest ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], a type-0x15 input buffer containing an [[#ApplicationAttribute]], an input [[#IStorage]], no output.

Same as [[#CreateApplicationAndPushAndRequestToStartForQuest]] except the entire attributes structure is directly specified via the input buffer. This command replaces [[#CreateApplicationAndPushAndRequestToStartForQuest]], official user-processes no longer use [[#CreateApplicationAndPushAndRequestToStartForQuest]].

==== CreateApplicationWithAttributeAndRequestToStartForQuest ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]] and a type-0x15 input buffer containing an [[#ApplicationAttribute]], no output.

Same as [[#CreateApplicationAndRequestToStartForQuest]] except the entire attributes structure is directly specified via the input buffer. This command replaces [[#CreateApplicationAndRequestToStartForQuest]], official user-processes no longer use [[#CreateApplicationAndPushAndRequestToStartForQuest]].

==== EnsureSaveData ====
Takes an input u128 userID, returns an output u64 size.

Calls sdk func <code>nn::fs::EnsureApplicationSaveData</code>. [[qlaunch]] also calls this same sdk func directly.

Creates the various savedata as specified by the application [[NACP_Format|control.nacp]] when the savedata doesn't exist.

Official user-processes launch the dataErase LibraryApplet depending on the Result, the above output size is used with this.

==== GetDesiredLanguage ====
No input, returns an output [[Settings_services#LanguageCode|LanguageCode]].

==== SetTerminateResult ====
Takes an input u32 '''Result''', no output.

For example, in some cases official apps use this with [[Error_codes|error]] 0x2A2 then uses svcBreak.

==== GetDisplayVersion ====
No input, returns an output 0x10-byte struct.

The output struct is "nn::oe::DisplayVersion". This the DisplayVersion string copied from the application [[NACP_Format|control.nacp]], this is always NUL-terminated.

==== GetLaunchStorageInfoForDebug ====
No input, returns an output u8 [[Filesystem_services#StorageId|StorageId]] and u8 [[Filesystem_services#StorageId|StorageId]].

This returns two u8s loaded from state, these are the same StorageIds from [[#ApplicationLaunchProperty]].

==== GetSaveDataSizeMax ====
No input, returns two ouput s64s.

==== GetCacheStorageMax ====
No input, returns an output s32 and s64.

==== BeginBlockingHomeButtonShortAndLongPressed ====
Takes an input s64, no output.

Official user-processes use hard-coded value 0 for the s64.

Starts blocking the Home button.

==== EndBlockingHomeButtonShortAndLongPressed ====
No input/output.

Ends the blocking started by [[#BeginBlockingHomeButtonShortAndLongPressed]].

==== BeginBlockingHomeButton ====
Takes an input s64 nanoseconds, no output. The input nanoseconds can be zero.

==== EndBlockingHomeButton ====
No input/output.

==== SelectApplicationLicense ====
Takes an input array of [[#ApplicationLicenseType]], returns an output [[#ApplicationLicenseType]].

==== GetDeviceSaveDataSizeMax ====
No input, returns two output s64s.

==== NotifyRunning ====
Takes no input. Returns an output u8 bool, which is ignored by official user-processes.

==== GetPseudoDeviceId ====
No input, returns an output 0x10-byte "nn::util::Uuid" struct.

The 0x20-byte output data from [[NS_Services|GetSystemSeedForPseudoDeviceId]] followed by the 8-byte [[NACP_Format|SeedForPseudoDeviceId]] from the current control.nacp, is hashed with SHA1. Then "nn::util::GenerateUuidVersion5" is called with the final hash, the output from this is then returned for the Uuid.

==== SetMediaPlaybackStateForApplication ====
Takes an input u8 bool, no output.

==== IsGamePlayRecordingSupported ====
No input, returns an output u8 bool.

==== InitializeGamePlayRecording ====
Takes a TransferMemory handle and an u64 for the size of the TransferMemory. The size must match 0x6000000 otherwise an error is returned.

==== SetGamePlayRecordingState ====
Takes an input u32. 0 = disable/pause, 1 = enable/restart.

==== RequestFlushGamePlayingMovieForDebug ====
No input/output.

Requests to save the video recording, as if the Capture-button was held.

==== RequestToShutdown ====
No input/output.

On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.

==== RequestToReboot ====
No input/output.

On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.

==== RequestToSleep ====
No input/output.

==== ExitAndRequestToShowThanksMessage ====
No input/output.

Used to exit the application and return to the kiosk menu. Official sw uses [[#UnlockExit]] immediately before this if needed.

On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.

This throws an error when the cached [[Settings_services#GetQuestFlag]] value is 0.

==== EnableApplicationCrashReport ====
Takes an input u8 bool, no output.

==== InitializeApplicationCopyrightFrameBuffer ====
Takes an input TransferMemory handle, an s32 '''width''', an s32 '''height''', an u64 tmem_size, and no output.

tmem_size must be 0x40000-byte aligned. '''width''' must be 1-1280, and '''height''' must be 1-720.

User-processes create the tmem with an user-specified buffer with permissions=0. '''width''' = 1280 and '''height''' = 720.

After the validation checks pass the input is passed to [[OMM_services|ommdisp]] cmd500.

This is used as an overlay for screenshots.

==== SetApplicationCopyrightImage ====
Takes a type-0x45 input buffer, an s32 '''x''', an s32 '''y''', an s32 '''width''', an s32 '''height''', an s32 [[#WindowOriginMode]], and no output.

'''x''' and '''y''' must not have the negative bit set. '''width''' and '''height''' must not be <1.

Sets the RGBA8 image for use with [[#InitializeApplicationCopyrightFrameBuffer]]. Overrides the current image, if this was already used previously.

==== SetApplicationCopyrightVisibility ====
Takes an input u8 bool, no output.

Sets the visibility for the image set by [[#SetApplicationCopyrightImage]], in screenshots. By default it's visible.

==== QueryApplicationPlayStatistics ====
Takes a type-0x6 output buffer containing an array of [[Shared_Database_services|ApplicationPlayStatistics]] and a type-0x5 input buffer containing an array of [[NCM_services#ApplicationId|ApplicationId]]. Returns an output s32 for actual total output entries.

The number of entries in each array is the same.

See also [[NACP_Format#PlayLogQueryCapability|PlayLogQueryCapability]].

This uses [[Shared_Database_services|pdm:qry]] QueryApplicationPlayStatisticsForSystem.

==== QueryApplicationPlayStatisticsByUid ====
Takes a u128 userID, a type-0x6 output buffer containing an array of [[Shared_Database_services|ApplicationPlayStatistics]] and a type-0x5 input buffer containing an array of [[NCM_services#ApplicationId|ApplicationId]]. Returns an output s32 for actual total output entries.

Same as [[#QueryApplicationPlayStatistics]] except this uses [[Shared_Database_services|pdm:qry]] cmd16, to get playstats specific to userIDs.

==== ExecuteProgram ====
Takes an input u32 [[#ProgramSpecifyKind]] and an input u64, no output.

==== ClearUserChannel ====
No input/output.

Clears the UserChannel used by [[#UnpopToUserChannel]].

==== UnpopToUserChannel ====
Takes an input [[#IStorage]], no output.

The input storage is pushed to the UserChannel. This is the same channel used by [[#LaunchParameterKind]] value 1.

User-processes create a storage using data specified by the user (written to offset=0 size=inputsize), with max size 0x1000. This storage is then used with this cmd.

==== GetPreviousProgramIndex ====
No input, returns an output s32.

Gets the ProgramIndex of the Application which launched this title. The output ProgramIndex is -1 when there was no previous title.

==== EnableApplicationAllThreadDumpOnCrash ====
Takes an input u8 bool, no output.

==== GetGpuErrorDetectedSystemEvent ====
No input, returns an output Event handle with autoclear=false.

This is used by sdknso during applet-application initialization. A separate thread is setup where event-waiting is handled. When the Event is signaled, official sw will Abort.

==== SetDelayTimeToAbortOnGpuError ====
Takes an input s64 "nn::TimeSpan", no output.

==== GetFriendInvitationStorageChannelEvent ====
No input, returns an output Event handle with EventClearMode=0.

This is exposed by sdknso under <code>nn::friends::</code>. This returns a ptr to the cached Event in global state, with the Event being loaded if not previously initialized.

==== TryPopFromFriendInvitationStorageChannel ====
No input, returns an output [[#IStorage]].

This uses the same StorageChannel as [[#PushToFriendInvitationStorageChannel]].

This is exposed by sdknso under <code>nn::friends::</code>. When the storage_size is <0x10, this returns false. <code>data_size = storage_size-0x10;</code> Then the first 0x10-bytes from storage are read to stack, which is later copied to the output Uid on success prior to returning. Then the storage is read into the specified output buffer with storage-offset 0x10, where the size is <code>size = data_size > buf_size ? buf_size : data_size</code>. Reading is skipped if size is zero. Afterwards the used size is written to an output param. On success, true is returned.

==== GetNotificationStorageChannelEvent ====
No input, returns an output Event handle with EventClearMode=0.

This is exposed by sdknso under <code>nn::notification::</code>. This returns a ptr to the cached Event in global state, with the Event being loaded if not previously initialized.

==== TryPopFromNotificationStorageChannel ====
No input, returns an output [[#IStorage]].

This uses the same StorageChannel as [[#PushToNotificationStorageChannel]].

This is exposed by sdknso under <code>nn::notification::</code>. The storage is read into the specified output buffer, where the size is <code>size = storage_size > buf_size ? buf_size : storage_size</code>. Reading is skipped if size is zero. Afterwards the used size is written to an output param.

==== GetHealthWarningDisappearedSystemEvent ====
No input, returns an output Event with EventClearMode=0.

==== SetHdcpAuthenticationActivated ====
Takes an input u8 bool, no output.

==== GetLaunchRequiredVersion ====
Takes an input [[NCM_services#ApplicationId|ApplicationId]], an u64, returns an output [[#LaunchRequiredVersion]].

sdknso passes hard-coded value 0 for the u64.

==== UpgradeLaunchRequiredVersion ====
Takes an input [[#LaunchRequiredVersion]], an [[NCM_services#ApplicationId|ApplicationId]], an u64, no output.

sdknso passes hard-coded value 0 for the u64.

==== SendServerMaintenanceOverlayNotification ====
Takes two input [[PCV_services#PosixTime|PosixTime]], no output.

The second input value can optionally be 0.

==== GetLastApplicationExitReason ====
No input, returns an output s32.

==== StartContinuousRecordingFlushForDebug ====
Takes an input s64 nanoseconds-value, returns an output Event handle with autoclear=false.

The cached value loaded from [[System_Settings|system-setting]] <code>am.debug!dev_function</code> must be set to 0x1 with size 0x1, otherwise an error is returned.

==== CreateMovieMaker ====
Takes an input u64 size and a TransferMemory handle, returns an [[#IMovieMaker]].

Official sw retries using the cmd in a loop on error 0x8D4 with svcSleepThread(100000000) being used first.

Official sw uses permissions=None for the TransferMemory, with an user-specified buffer. The size of the buffer used by official sw is 0x6000000.

==== PrepareForJit ====
Takes no input. Launches the [[JIT_services|jit-sysmodule]] via [[NS_Services|ns]] LaunchLibraryApplet if it has not already been launched for the current application, storing a std::shared_ptr<> for jit-sysmodule process tracking object as an IApplicationFunctions member.

~IApplicationFunctions() includes:

if (this->jit_process) {
Terminate(this->jit_process);
this->jit_process = nullptr;
}

Thus the lifetime of the jit sysmodule is tied to the application which uses it, and each application gets its own fresh copy of the jit sysmodule.

AM can also optionally launch jit-sysmodule automatically if the [[NACP]] enables it.

=== IMovieMaker ===
This is "nn::am::service::IMovieMaker".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#GetGrcMovieMaker]]
|-
| 1 || [[#GetLayerHandle]]
|}

==== GetGrcMovieMaker ====
No input, returns a GRC [[GRC_services|IMovieMaker]].

==== GetLayerHandle ====
No input, returns an output u64.

== ILibraryAppletCreator ==
This is "nn::am::service::ILibraryAppletCreator".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#CreateLibraryApplet]] ||
|-
| 1 || [[#TerminateAllLibraryApplets]] ||
|-
| 2 || [[#AreAnyLibraryAppletsLeft]] ||
|-
| 10 || [[#CreateStorage]] ||
|-
| 11 || [[#CreateTransferMemoryStorage]] ||
|-
| 12 || [2.0.0+] [[#CreateHandleStorage]] ||
|}

=== CreateLibraryApplet ===
Takes 2 input u32s [[#AppletId]] and [[#LibraryAppletMode]], returns an [[#ILibraryAppletAccessor]].

=== TerminateAllLibraryApplets ===
No input/output.

Stubbed with an ILibraryAppletCreator from [[#CreateSelfLibraryAppletCreatorForDevelop]], just returns an error.

Terminates all LibraryApplets which were created by the current applet (or by the Application when used from the [[#IApplicationAccessor]] cmd).

=== AreAnyLibraryAppletsLeft ===
No input, returns an output u8 bool.

Stubbed with an ILibraryAppletCreator from [[#CreateSelfLibraryAppletCreatorForDevelop]], just returns an error.

Gets whether any LibraryApplets ([[#ILibraryAppletAccessor]]) which were created by the current applet are still open (or by the Application when used from the [[#IApplicationAccessor]] cmd).

=== CreateStorage ===
Takes an input s64 for the storage size, returns an [[#IStorage]].

This allocates a buffer with the specified size which can then be accessed via [[#IStorageAccessor]].

=== CreateTransferMemoryStorage ===
Takes an input TransferMemory copy-handle, an input u8 bool, and an s64 size, returns an [[#IStorage]].

The user-process creates the TransferMemory with permissions=0.

The TransferMemory is mapped, which can then be accessed via [[#IStorageAccessor]]. The input bool controls whether writing to the storage is allowed: [[#Write]] will throw an error if this flag is not set.

=== CreateHandleStorage ===
Takes an input copy-handle and an input s64, returns an [[#IStorage]]. In some cases the s64 must not have the negative bit set.

The input can be arbitrary, however official sw is only (?) known to use this for TransferMemory (with s64=size).

=== ILibraryAppletAccessor ===
This is "nn::am::service::ILibraryAppletAccessor".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#GetAppletStateChangedEvent]] ||
|-
| 1 || [[#IsCompleted]] ||
|-
| 10 || [[#Start]] ||
|-
| 20 || [[#RequestExit]] ||
|-
| 25 || [[#Terminate]] ||
|-
| 30 || [[#GetResult]] ||
|-
| 50 || [[#SetOutOfFocusApplicationSuspendingEnabled]] ||
|-
| 60 || [10.0.0+] [[#PresetLibraryAppletGpuTimeSliceZero]] ||
|-
| 100 || [[#PushInData]] ||
|-
| 101 || [[#PopOutData]] ||
|-
| 102 || [[#PushExtraStorage]] ||
|-
| 103 || [[#PushInteractiveInData]] ||
|-
| 104 || [[#PopInteractiveOutData]] ||
|-
| 105 || [[#GetPopOutDataEvent]] ||
|-
| 106 || [[#GetPopInteractiveOutDataEvent]] ||
|-
| 110 || [[#NeedsToExitProcess]] ||
|-
| 120 || [[#GetLibraryAppletInfo]] ||
|-
| 150 || [[#RequestForAppletToGetForeground]] ||
|-
| 160 || [2.0.0+] [[#GetIndirectLayerConsumerHandle]] ||
|}

Commands <=30 are inherited from [[#IAppletAccessor]]. GetLibraryAppletInfo is identical to the [[#ILibraryAppletSelfAccessor]] cmd.

==== SetOutOfFocusApplicationSuspendingEnabled ====
Takes an input u8 bool, no output.

Official sw will assert prior to using this if applet-service was not initialized as *Application.

==== PresetLibraryAppletGpuTimeSliceZero ====
No input/output.

sdknso only uses with with [[Software_Keyboard|swkbd-inline]], immediately after creating the LibraryApplet.

==== PushInData ====
Takes an input [[#IStorage]], no output.

==== PopOutData ====
No input, returns an output [[#IStorage]].

==== PushExtraStorage ====
Takes an input [[#IStorage]], no output.

==== PushInteractiveInData ====
Takes an input [[#IStorage]], no output.

==== PopInteractiveOutData ====
No input, returns an output [[#IStorage]].

==== GetPopOutDataEvent ====
No input, returns an output handle with autoclear=false.

==== GetPopInteractiveOutDataEvent ====
No input, returns an output event handle with autoclear=false.

==== NeedsToExitProcess ====
No input, returns an output u8 bool.

Stubbed, just returns an error.

==== RequestForAppletToGetForeground ====
No input/output.

Stubbed, just returns an error.

==== GetIndirectLayerConsumerHandle ====
Takes an input PID and an input u64 AppletResourceUserId, returns an output u64 IndirectLayerConsumerHandle.

Official sw uses this during LibraryApplet creation when [[#LibraryAppletMode]] is 0x3.

== ICommonStateGetter ==
This is "nn::am::service::ICommonStateGetter".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#GetEventHandle]]
|-
| 1 || [[#ReceiveMessage]]
|-
| 2 || [[#GetThisAppletKind]]
|-
| 3 || [[#AllowToEnterSleep]]
|-
| 4 || [[#DisallowToEnterSleep]]
|-
| 5 || [[#GetOperationMode]]
|-
| 6 || [[#GetPerformanceMode]]
|-
| 7 || [[#GetCradleStatus]]
|-
| 8 || [[#GetBootMode]]
|-
| 9 || [[#GetCurrentFocusState]]
|-
| 10 || [[#RequestToAcquireSleepLock]]
|-
| 11 || [[#ReleaseSleepLock]]
|-
| 12 || [[#ReleaseSleepLockTransiently]]
|-
| 13 || [[#GetAcquiredSleepLockEvent]]
|-
| 14 || [11.0.0+] [[#GetWakeupCount]]
|-
| 20 || [[#PushToGeneralChannel]]
|-
| 30 || [[#GetHomeButtonReaderLockAccessor]]
|-
| 31 || [2.0.0+] [[#GetReaderLockAccessorEx]]
|-
| 32 || [7.0.0+] [[#GetWriterLockAccessorEx]]
|-
| 40 || [2.0.0+] [[#GetCradleFwVersion]]
|-
| 50 || [3.0.0+] [[#IsVrModeEnabled]]
|-
| 51 || [3.0.0+] [[#SetVrModeEnabled]]
|-
| 52 || [4.0.0+] [[#SetLcdBacklighOffEnabled]]
|-
| 53 || [7.0.0+] [[#BeginVrModeEx]]
|-
| 54 || [7.0.0+] [[#EndVrModeEx]]
|-
| 55 || [3.0.0+] [[#IsInControllerFirmwareUpdateSection]]
|-
| 59 || [11.0.0+] [[#SetVrPositionForDebug]]
|-
| 60 || [3.0.0+] [[#GetDefaultDisplayResolution]]
|-
| 61 || [3.0.0+] [[#GetDefaultDisplayResolutionChangeEvent]]
|-
| 62 || [4.0.0+] [[#GetHdcpAuthenticationState]]
|-
| 63 || [4.0.0+] [[#GetHdcpAuthenticationStateChangeEvent]]
|-
| 64 || [5.0.0+] [[#SetTvPowerStateMatchingMode]]
|-
| 65 || [5.1.0+] [[#GetApplicationIdByContentActionName]]
|-
| 66 || [6.0.0+] [[#SetCpuBoostMode]]
|-
| 67 || [10.0.0+] [[#CancelCpuBoostMode]]
|-
| 68 || [11.0.0+] [[#GetBuiltInDisplayType]]
|-
| 80 || [6.0.0+] [[#PerformSystemButtonPressingIfInFocus]]
|-
| 90 || [7.0.0+] [[#SetPerformanceConfigurationChangedNotification]]
|-
| 91 || [7.0.0+] [[#GetCurrentPerformanceConfiguration]]
|-
| 100 || [9.1.0+] [[#SetHandlingHomeButtonShortPressedEnabled]]
|-
| 110 || [11.0.0+] [[#OpenMyGpuErrorHandler]]
|-
| 120 || [13.0.0+] GetAppletLaunchedHistory
|-
| 200 || [7.0.0+] [[#GetOperationModeSystemInfo]]
|-
| 300 || [9.0.0+] [[#GetSettingsPlatformRegion]]
|-
| 400 || [10.0.0+] [[#ActivateMigrationService]]
|-
| 401 || [10.0.0+] [[#DeactivateMigrationService]]
|-
| 500 || [11.0.0+] [[#DisableSleepTillShutdown]]
|-
| 501 || [11.0.0+] [[#SuppressDisablingSleepTemporarily]]
|-
| 502 || [12.0.0+] IsSleepEnabled
|-
| 503 || [12.0.0+] IsDisablingSleepSuppressed
|-
| 900 || [11.0.0+] [[#SetRequestExitToLibraryAppletAtExecuteNextProgramEnabled]]
|}

Officially notification messages are handled by the application itself, not sdk-nso in ExeFS. Official apps call code in sdk-nso which basically uses svcWaitSynchronization with the event from [[#GetEventHandle]] to check whether a message is available, then if so it uses [[#ReceiveMessage]]. The actual handling for message IDs is done in the app itself(see [[#AppletMessage]]).

[7.0.0+] User-processes now use BeginVrModeEx/EndVrModeEx instead of [[#SetVrModeEnabled]]. Prior to using using BeginVrModeEx, [[Parental_Control_services|pctl]] IsStereoVisionPermitted is used and error 0xD08E is thrown if not allowed by pctl.

=== GetEventHandle ===
No input. Returns an output event handle. This is signalled when a message is available with [[#ReceiveMessage]].

=== ReceiveMessage ===
No input. Returns an output [[#AppletMessage]]. Error 0x680 indicates no message is available.

=== GetThisAppletKind ===
No input, returns an output [[#AppletKind]].

Stubbed, just returns an error.

=== AllowToEnterSleep ===
No input/output.

Stubbed, just returns an error.

=== DisallowToEnterSleep ===
No input/output.

Stubbed, just returns an error.

=== GetOperationMode ===
No input. Returns an output u8 for the current [[#OperationMode]].

=== GetPerformanceMode ===
No input. Returns an output u32 for the current [[#PerformanceMode]].

=== GetCradleStatus ===
No input, returns an output u8.

This uses [[#omm]] GetCradleStatus.

=== GetBootMode ===
No input, returns an output u8.

Returns the value from [[Process_Manager_services|pm:bm]] GetBootMode.

=== GetCurrentFocusState ===
No input. Returns an output u8 [[#FocusState]].

=== RequestToAcquireSleepLock ===
No input/output.

=== ReleaseSleepLock ===
No input/output.

=== ReleaseSleepLockTransiently ===
No input/output.

=== GetAcquiredSleepLockEvent ===
No input, returns an output Event handle with autoclear=false.

=== GetWakeupCount ===
No input, returns an output u64.

=== PushToGeneralChannel ===
Takes an input [[#IStorage]], no output.

This is not usable under an Application, however it is usable under a LibraryApplet.

Used for sending requests to [[qlaunch]]. sdk-nso creates a 0x10-byte storage which is sent to this. The following are the functions which use this, with the data written to the storage:
* <code>RequestHomeMenu</code> <code>5341 4d53 0100 0000 0200 0000 0100 0000</code> Returns to the main Home Menu, equivalent to pressing the HOME button.
* <code>RequestJumpToSystemUpdate</code> <code>5341 4d53 0100 0000 0b00 0000 0100 0000</code> Equivalent to entering "System Update" under System Settings. When leaving this, it returns to the main Home Menu.

=== GetHomeButtonReaderLockAccessor ===
No input, returns an output [[#ILockAccessor]].

Similar to using [[#GetReaderLockAccessorEx]] with inval=0.

=== GetReaderLockAccessorEx ===
Takes an input u32, returns an output [[#ILockAccessor]].

The input value must be 0-3. 0 = HomeButton.

=== GetWriterLockAccessorEx ===
Takes an input u32, returns an output [[#ILockAccessor]].

The input value must be 0-3. 0 = HomeButton.

=== GetCradleFwVersion ===
No input, returns 4 output u32s.

This uses [[#omm]] GetCradleFwVersion.

=== IsVrModeEnabled ===
No input, returns an output u8 bool.

=== SetVrModeEnabled ===
Takes an input u8 bool flag. No output.

Updates internal AM state fields. If the new state doesn't match the previous state, this uses the [[Backlight_services]] {Disable/Enable}VrMode command depending on whether flag={disable/enable}.

When the VrMode is set to true, the console shows a screen rendered like vr asking the user to move his face away and hit the 'close' button. When this button is pressed, the console resets the vrMode to false.

=== SetLcdBacklighOffEnabled ===
Takes an input u8 bool, no output.

Sets whether the LCD screen blacklight is turned off.

=== BeginVrModeEx ===
No input/output.

Identical to [[#SetVrModeEnabled]] except with hard-coded flag=1.

=== EndVrModeEx ===
No input/output.

Identical to [[#SetVrModeEnabled]] except with hard-coded flag=0.

=== IsInControllerFirmwareUpdateSection ===
No input, returns an output u8 bool.

=== SetVrPositionForDebug ===
Takes 4 input s32s, no output.

The s32s are: x, y, width, height.

The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.

width must be 1-1280, height must be 1-720.

x and y must not be negative. x+width must be <=1280. y+height must be <=720.

=== GetDefaultDisplayResolution ===
No input, returns two output s32s '''width''' and '''height'''.

=== GetDefaultDisplayResolutionChangeEvent ===
No input, returns an output Event handle with autoclear=true.

=== GetHdcpAuthenticationState ===
No input, returns an output s32.

=== GetHdcpAuthenticationStateChangeEvent ===
No input, returns an output Event handle with autoclear=true.

=== SetTvPowerStateMatchingMode ===
Takes an input s32 [[#TvPowerStateMatchingMode]], no output.

=== GetApplicationIdByContentActionName ===
Takes a type-0x5 input buffer containing a string, returns an output [[NCM_services#ApplicationId|ApplicationId]].

Gets the ApplicationId for the specified ContentActionName string. Returns an error when the current [[#AppletId]] isn't 0x04 (when the current applet isn't a SystemApplication).

=== SetCpuBoostMode ===
Takes an input u32 [[#CpuBoostMode]] and passes it to [[PPC_services#apm:sys|SetCpuBoostMode]].

=== CancelCpuBoostMode ===
No input/output.

=== GetBuiltInDisplayType ===
No input, returns an output s32.

This is not exposed by sdknso.

This loads a s32 index from global state (originates from [[SPL_services#GetConfig|GetConfig]] [[SMC#HardwareType|HardwareType]]), Aborts if it's out-of-bounds, then the following is returned for the output s32: global_array[loaded_index].

=== PerformSystemButtonPressingIfInFocus ===
Takes an input [[#SystemButtonType]], no output.

Just returns 0 when a state field is not value 1. Verifies that the input button is allowed, then calls the same func as [[#PerformSystemButtonPressing]] internally.

=== SetPerformanceConfigurationChangedNotification ===
Takes an input u8 bool, no output.

=== GetCurrentPerformanceConfiguration ===
No input, returns the result of calling [[PPC_services#apm:sys|GetCurrentPerformanceConfiguration]].

=== OpenMyGpuErrorHandler ===
No input, returns an [[#IGpuErrorHandler]].

The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.

=== GetOperationModeSystemInfo ===
No input, returns an output u32.

This returns the output from [[#GetOperationModeSystemInfo_2|omm GetOperationModeSystemInfo]].

=== GetSettingsPlatformRegion ===
No input, returns an output u8.

This just returns the output from [[Settings_services#GetPlatformRegion|setsys GetPlatformRegion]].

=== ActivateMigrationService ===
No input/output.

Besides various other functionality, if required this eventually uses [[NS_Services|ns]] LaunchLibraryApplet to launch [[Migration_services|migration]].

=== DeactivateMigrationService ===
No input/output.

=== DisableSleepTillShutdown ===
No input/output.

=== SuppressDisablingSleepTemporarily ===
Takes an input u64 "nn::TimeSpanType", no output.

=== SetRequestExitToLibraryAppletAtExecuteNextProgramEnabled ===
No input/output.

=== IGpuErrorHandler ===
This is "nn::am::service::IGpuErrorHandler".

This was added with [11.0.0+].

This uses various [[NV_services#nvgem:cd|nvgem:cd]] commands.

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 100 || [[#GetManualGpuErrorInfoSize]]
|-
| 101 || [[#GetManualGpuErrorInfo]]
|-
| 102 || [[#GetManualGpuErrorDetectionSystemEvent]]
|-
| 103 || [[#FinishManualGpuErrorHandling]]
|}

==== GetManualGpuErrorInfoSize ====
No input, returns an output u64.

==== GetManualGpuErrorInfo ====
Takes a type-0x6 output buffer, returns an output u64.

The OutBuffer_size must be >= the output size from [[#GetManualGpuErrorInfoSize]].

sdknso exposes the buffer as <code>void*</code>.

==== GetManualGpuErrorDetectionSystemEvent ====
No input, returns an output Event handle with EventClearMode=0.

==== FinishManualGpuErrorHandling ====
No input/output.

== ISelfController ==
This is "nn::am::service::ISelfController".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#Exit]]
|-
| 1 || [[#LockExit]]
|-
| 2 || [[#UnlockExit]]
|-
| 3 || [2.0.0+] [[#EnterFatalSection]]
|-
| 4 || [2.0.0+] [[#LeaveFatalSection]]
|-
| 9 || [[#GetLibraryAppletLaunchableEvent]]
|-
| 10 || [[#SetScreenShotPermission]]
|-
| 11 || [[#SetOperationModeChangedNotification]]
|-
| 12 || [[#SetPerformanceModeChangedNotification]]
|-
| 13 || [[#SetFocusHandlingMode]]
|-
| 14 || [[#SetRestartMessageEnabled]]
|-
| 15 || [2.0.0+] [[#SetScreenShotAppletIdentityInfo]]
|-
| 16 || [2.0.0+] [[#SetOutOfFocusSuspendingEnabled]]
|-
| 17 || [3.0.0+] [[#SetControllerFirmwareUpdateSection]]
|-
| 18 || [3.0.0+] [[#SetRequiresCaptureButtonShortPressedMessage]]
|-
| 19 || [3.0.0+] [[#SetAlbumImageOrientation]]
|-
| 20 || [4.0.0+] [[#SetDesirableKeyboardLayout]]
|-
| 21 || [13.0.0+] GetScreenShotProgramId
|-
| 40 || [[#CreateManagedDisplayLayer]]
|-
| 41 || [4.0.0+] [[#IsSystemBufferSharingEnabled]]
|-
| 42 || [4.0.0+] [[#GetSystemSharedLayerHandle]]
|-
| 43 || [5.0.0+] [[#GetSystemSharedBufferHandle]]
|-
| 44 || [10.0.0+] [[#CreateManagedDisplaySeparableLayer]]
|-
| 45 || [10.0.0+] [[#SetManagedDisplayLayerSeparationMode]]
|-
| 46 || [13.0.0+] [[#SetRecordingLayerCompositionEnabled]]
|-
| 50 || [[#SetHandlesRequestToDisplay]]
|-
| 51 || [[#ApproveToDisplay]]
|-
| 60 || [[#OverrideAutoSleepTimeAndDimmingTime]]
|-
| 61 || [[#SetMediaPlaybackState]]
|-
| 62 || [[#SetIdleTimeDetectionExtension]]
|-
| 63 || [[#GetIdleTimeDetectionExtension]]
|-
| 64 || [[#SetInputDetectionSourceSet]]
|-
| 65 || [2.0.0+] [[#ReportUserIsActive]]
|-
| 66 || [3.0.0+] [[#GetCurrentIlluminance]]
|-
| 67 || [3.0.0+] [[#IsIlluminanceAvailable]]
|-
| 68 || [5.0.0+] [[#SetAutoSleepDisabled]]
|-
| 69 || [5.0.0+] [[#IsAutoSleepDisabled]]
|-
| 70 || [4.0.0+] [[#ReportMultimediaError]]
|-
| 71 || [5.0.0+] [[#GetCurrentIlluminanceEx]]
|-
| 72 || [9.0.0+] [[#SetInputDetectionPolicy]]
|-
| 80 || [4.0.0+] [[#SetWirelessPriorityMode]]
|-
| 90 || [6.0.0+] [[#GetAccumulatedSuspendedTickValue]]
|-
| 91 || [6.0.0+] [[#GetAccumulatedSuspendedTickChangedEvent]]
|-
| 100 || [7.0.0+] [[#SetAlbumImageTakenNotificationEnabled]]
|-
| 110 || [8.0.0+] [[#SetApplicationAlbumUserData]]
|-
| 120 || [11.0.0+] [[#SaveCurrentScreenshot]]
|-
| 130 || [13.0.0+] [[#SetRecordVolumeMuted]]
|-
| 1000 || [7.0.0+] [[#GetDebugStorageChannel]]
|}

=== Exit ===
No input/output.

Exits the current applet. On success, official sw will enter an infinite loop with sleep-thread value 86400000000000.

=== LockExit ===
No input/output.

Locks exit process of pressing X to close in HOME Menu for an application or HOME button for an applet. When locked, it will show the "waiting for software to be closed dialog" until UnlockExit is called or a 15 seconds timeout (when the latter occurs, the process is force-terminated).

=== UnlockExit ===
No input/output.

Unlocks exit process, if LockExit was previously used.

=== EnterFatalSection ===
No input/output.

=== LeaveFatalSection ===
No input/output.

[[#EnterFatalSection]] must be executed at least once before executing this command, otherwise error code 0x40080 will be returned. EnterFatalSection and LeaveFatalSection work in pairs, that is, N calls to EnterFatalSection must be performed first in order to perform N executions of LeaveFatalSection. Essentially, these two functions operate like how one would lock and unlock a recursive mutex.

=== GetLibraryAppletLaunchableEvent ===
No input, returns an output event handle with autoclear=false.

=== SetScreenShotPermission ===
Takes an input s32. No output.

Controls whether screenshot-capture is allowed.

{| class="wikitable" border="1"
|-
! Value || Description
|-
| 0 || Inherit from parent applet
|-
| 1 || Enable
|-
| 2 || Disable
|-
|}

=== SetOperationModeChangedNotification ===
Takes an input u8 bool flag. No output.

=== SetPerformanceModeChangedNotification ===
Takes an input u8 bool flag. No output.

=== SetFocusHandlingMode ===
Takes 3 input u8s with each field located immediately after the previous u8, these are bool flags. No output.

=== SetRestartMessageEnabled ===
Takes an input u8 bool flag, no output.

See [[#AppletMessage]].

=== SetScreenShotAppletIdentityInfo ===
Takes an input [[#AppletIdentityInfo]], no output.

=== SetOutOfFocusSuspendingEnabled ===
Takes an input u8 bool flag. No output.

=== SetControllerFirmwareUpdateSection ===
Takes an input u8 bool flag, no output.

This throws error 0x40280 when the internal state flag already matches the input value.

=== SetRequiresCaptureButtonShortPressedMessage ===
Takes an input u8 bool flag, no output.

See [[#AppletMessage]].

When enabled with a non-Overlay applet, Overlay applet will not be notified of capture button short-presses for screenshots.

=== SetAlbumImageOrientation ===
Takes an input u32 "nn::album::ImageOrientation". No output.

The input value must not be >3.

=== SetDesirableKeyboardLayout ===
Takes an input u32, no output.

The input u32 is "nn::settings::KeyboardLayout".

=== CreateManagedDisplayLayer ===
Returns an output u64 LayerId which is then used by the user-process with [[Display_services#OpenLayer]].

=== IsSystemBufferSharingEnabled ===
No input/output.

Not available when the current applet is an Application ([[#AppletId]] == 0x01).

Checks whether SystemBufferSharing is enabled, throwing an error otherwise.

=== GetSystemSharedLayerHandle ===
No input, returns two output u64s "nn::vi::fbshare::SharedBufferHandle" and "nn::vi::fbshare::SharedLayerHandle".

Runs code similar to [[#IsSystemBufferSharingEnabled]] first.

=== GetSystemSharedBufferHandle ===
No input, returns an output u64 "nn::vi::fbshare::SharedBufferHandle".

Runs code similar to [[#IsSystemBufferSharingEnabled]] first.

Same as [[#GetSystemSharedLayerHandle]] except this just gets the SharedBufferHandle.

=== CreateManagedDisplaySeparableLayer ===
No input, returns two output u64 LayerIds.

sdknso now uses this instead of [[#CreateManagedDisplayLayer]]. sdknso caches the output from the cmd so that it's only used once. The first u64 is used the same as the original LayerId from [[#CreateManagedDisplayLayer]]. <code>nn::vi::CreateRecordingLayer</code> uses the second LayerId, the layer creation is identical besides which LayerId is used.

=== SetManagedDisplayLayerSeparationMode ===
Takes an input u32, no output.

sdknso exposes this as <code>nn::vi::SetRecordingLayerEnabled(bool)</code>.

The input u32 must be 0-1.

=== SetRecordingLayerCompositionEnabled ===
Takes an input bool, no output.

=== SetHandlesRequestToDisplay ===
Takes an input u8 bool, no output.

Sets an internal state flag. When the input flag is 0, this will in additional run the same code as [[#ApproveToDisplay]].

See [[#AppletMessage]].

=== ApproveToDisplay ===
No input/output.

Used to handle the notification enabled by [[#SetHandlesRequestToDisplay]].

=== OverrideAutoSleepTimeAndDimmingTime ===
Takes 4 input s32s, no output.

=== SetMediaPlaybackState ===
Takes an input u8 bool, no output.

=== SetIdleTimeDetectionExtension ===
Takes an input u32, no output.

The input value must be 0-2: 0 = disabled, 1 = Extended, and 2 = ExtendedUnsafe.

=== GetIdleTimeDetectionExtension ===
No input, returns an output u32.

Returns the value set by [[#SetIdleTimeDetectionExtension]].

=== SetInputDetectionSourceSet ===
Takes an input u32, no output.

=== ReportUserIsActive ===
No input/output.

Uses idle:sys ReportUserIsActive.

Reports that the user is active, for idle detection (screen dimming / auto-sleep). This is equivalent to when the user uses HID input.

=== GetCurrentIlluminance ===
No input, returns an output float.

Uses [[Backlight_services|lbl]] command GetAmbientLightSensorValue, where only the output float is used.

=== IsIlluminanceAvailable ===
No input, returns an output u8 bool.

Uses [[Backlight_services|lbl]] command IsAmbientLightSensorAvailable.

User-processes can use this to determine whether to continue with using GetCurrentIlluminance(Ex).

=== SetAutoSleepDisabled ===
Takes an input u8 bool, no output.

=== IsAutoSleepDisabled ===
No input, returns an output u8 bool.

=== ReportMultimediaError ===
Takes an input Result and a type-0x5 input buffer, no output.

The buffer contains a 0x138-byte "movie::MultimediaTelemetryReport" struct.

=== GetCurrentIlluminanceEx ===
No input, returns an output u8 bool and float.

Uses [[Backlight_services|lbl]] command GetAmbientLightSensorValue.

=== SetInputDetectionPolicy ===
Takes an input [[#InputDetectionPolicy]], no output.

=== SetWirelessPriorityMode ===
Takes an input s32 [[#WirelessPriorityMode]], no output.

=== GetAccumulatedSuspendedTickValue ===
No input, returns an output u64 tick value.

Gets the total time in ticks that the process was suspended, relative to when the applet-service was last initialized.

=== GetAccumulatedSuspendedTickChangedEvent ===
No input, returns an output Event handle with autoclear=true.

This is signaled when the output from [[#GetAccumulatedSuspendedTickValue]] is updated.

=== SetAlbumImageTakenNotificationEnabled ===
Takes an input u8 bool, no output.

See [[#AppletMessage]].

=== SetApplicationAlbumUserData ===
Takes a type-0x21 input buffer, no output.

The buffer contains arbitrary UserData.

The size must be <=0x400. The input buffer is copied to a buffer loaded from a state ptr (throwing an error when the state ptr is not set), with the u32 size being written to statebuf+0x400 afterwards.

=== SaveCurrentScreenshot ===
Takes an input s32 [[Capture_services#AlbumReportOption|AlbumReportOption]], no output.

sdknso exposes this under "nn::album::".

=== SetRecordVolumeMuted ===
Takes an input bool, no output.

=== GetDebugStorageChannel ===
No input, returns an output [[#IStorageChannel]].

The cached value loaded from [[System_Settings|system-setting]] <code>am.debug!dev_function</code> must be set to 0x1 with size 0x1, otherwise an error is returned.

== IStorageChannel ==
This is "nn::am::service::IStorageChannel".

This was added with [7.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || Push || No input, returns an output [[#IStorage]].
|-
| 1 || Unpop || No input, returns an output [[#IStorage]].
|-
| 2 || Pop || No input, returns an output [[#IStorage]].
|-
| 3 || GetPopEventHandle || No input, returns an output handle.
|-
| 4 || Clear || No input/output.
|}

== IWindowController ==
This is "nn::am::service::IWindowController".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#CreateWindow]] ||
|-
| 1 || [[#GetAppletResourceUserId]] ||
|-
| 2 || [6.0.0+] [[#GetAppletResourceUserIdOfCallerApplet]] ||
|-
| 10 || [[#AcquireForegroundRights]] ||
|-
| 11 || [[#ReleaseForegroundRights]] ||
|-
| 12 || [[#RejectToChangeIntoBackground]] ||
|-
| 20 || [7.0.0+] [[#SetAppletWindowVisibility]] ||
|-
| 21 || [7.0.0+] [[#SetAppletGpuTimeSlice]] ||
|}

=== CreateWindow ===
Takes an input u32, returns an output [[#IWindow]].

Stubbed, just returns an error.

=== GetAppletResourceUserId ===
No input, returns an output u64 [[#AppletResourceUserId]].

=== GetAppletResourceUserIdOfCallerApplet ===
No input, returns an output u64 [[#AppletResourceUserId]].

=== AcquireForegroundRights ===
No input/output.

Just returns 0.

=== ReleaseForegroundRights ===
No input/output.

Just returns 0.

=== RejectToChangeIntoBackground ===
No input/output.

Just returns 0.

=== SetAppletWindowVisibility ===
Takes an input u8 bool, no output.

=== SetAppletGpuTimeSlice ===
Takes an input s64, no output.

The input s64 must not be negative.

== IAudioController ==
This is "nn::am::service::IAudioController".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#SetExpectedMasterVolume]]
|-
| 1 || [[#GetMainAppletExpectedMasterVolume]]
|-
| 2 || [[#GetLibraryAppletExpectedMasterVolume]]
|-
| 3 || [[#ChangeMainAppletMasterVolume]]
|-
| 4 || [[#SetTransparentVolumeRate]]
|}

GetMainAppletExpectedMasterVolume/SetExpectedMasterVolume are used for saving/restoring state for LibraryApplet launching, with SetExpectedMasterVolume being used with new state prior to launching a LibraryApplet. With official sw these applet funcs are used directly in the main-codebin.

=== SetExpectedMasterVolume ===
Takes two input floats, no output.

Writes the input floats to state: first one is used by [[#GetMainAppletExpectedMasterVolume]], second one is used by [[#GetLibraryAppletExpectedMasterVolume]].

=== GetMainAppletExpectedMasterVolume ===
No input, returns an output float.

=== GetLibraryAppletExpectedMasterVolume ===
No input, returns an output float.

=== ChangeMainAppletMasterVolume ===
Takes an input float and an input u64, no output.

=== SetTransparentVolumeRate ===
Takes an input float, no output.

== IDisplayController ==
This is "nn::am::service::IDisplayController".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#GetLastForegroundCaptureImage]]
|-
| 1 || [[#UpdateLastForegroundCaptureImage]]
|-
| 2 || [[#GetLastApplicationCaptureImage]]
|-
| 3 || [[#GetCallerAppletCaptureImage]]
|-
| 4 || [[#UpdateCallerAppletCaptureImage]]
|-
| 5 || [[#GetLastForegroundCaptureImageEx]]
|-
| 6 || [[#GetLastApplicationCaptureImageEx]]
|-
| 7 || [[#GetCallerAppletCaptureImageEx]]
|-
| 8 || [2.0.0+] [[#TakeScreenShotOfOwnLayer]]
|-
| 9 || [5.0.0+] [[#CopyBetweenCaptureBuffers]]
|-
| 10 || [[#AcquireLastApplicationCaptureBuffer]]
|-
| 11 || [[#ReleaseLastApplicationCaptureBuffer]]
|-
| 12 || [[#AcquireLastForegroundCaptureBuffer]]
|-
| 13 || [[#ReleaseLastForegroundCaptureBuffer]]
|-
| 14 || [[#AcquireCallerAppletCaptureBuffer]]
|-
| 15 || [[#ReleaseCallerAppletCaptureBuffer]]
|-
| 16 || [[#AcquireLastApplicationCaptureBufferEx]]
|-
| 17 || [[#AcquireLastForegroundCaptureBufferEx]]
|-
| 18 || [[#AcquireCallerAppletCaptureBufferEx]]
|-
| 20 || [3.0.0+] [[#ClearCaptureBuffer]]
|-
| 21 || [3.0.0+] [[#ClearAppletTransitionBuffer]]
|-
| 22 || [4.0.0+] [[#AcquireLastApplicationCaptureSharedBuffer]]
|-
| 23 || [4.0.0+] [[#ReleaseLastApplicationCaptureSharedBuffer]]
|-
| 24 || [4.0.0+] [[#AcquireLastForegroundCaptureSharedBuffer]]
|-
| 25 || [4.0.0+] [[#ReleaseLastForegroundCaptureSharedBuffer]]
|-
| 26 || [4.0.0+] [[#AcquireCallerAppletCaptureSharedBuffer]]
|-
| 27 || [4.0.0+] [[#ReleaseCallerAppletCaptureSharedBuffer]]
|-
| 28 || [6.0.0+] [[#TakeScreenShotOfOwnLayerEx]]
|}

=== GetLastForegroundCaptureImage ===
Takes a type-0x6 output buffer.

Stubbed, just returns an error.

=== UpdateLastForegroundCaptureImage ===
No input/output.

=== GetLastApplicationCaptureImage ===
Takes a type-0x6 output buffer.

Stubbed, just returns an error.

=== GetCallerAppletCaptureImage ===
Takes a type-0x6 output buffer.

Stubbed, just returns an error.

=== UpdateCallerAppletCaptureImage ===
No input/output.

Calls the same func internally as [[#UpdateLastForegroundCaptureImage]], except this passes param value 2 instead of 1.

=== GetLastForegroundCaptureImageEx ===
Takes a type-0x6 output buffer, returns an output u8 bool.

The buffer size must match 0x384000.

=== GetLastApplicationCaptureImageEx ===
Takes a type-0x6 output buffer, returns an output u8 bool.

The buffer size must match 0x384000.

Calls the same internal func as [[#GetLastForegroundCaptureImageEx]], except that the last param is set to value 0 instead of 1.

=== GetCallerAppletCaptureImageEx ===
Takes a type-0x6 output buffer, returns an output u8 bool.

The buffer size must match 0x384000.

Calls the same internal func as [[#GetLastForegroundCaptureImageEx]], except that the last param is set to value 2 instead of 1.

=== TakeScreenShotOfOwnLayer ===
Takes an input u8 bool and a s32, no output.

=== CopyBetweenCaptureBuffers ===
Takes two input s32s, no output.

=== AcquireLastApplicationCaptureBuffer ===
No input, returns an output handle.

Stubbed, just returns an error.

=== ReleaseLastApplicationCaptureBuffer ===
No input/output.

Clears a state field if it's not already 0, returning an error otherwise. On newer sysvers: then a func is called which just returns 0, then this cmd returns 0.

=== AcquireLastForegroundCaptureBuffer ===
No input, returns an output handle.

Stubbed, just returns an error.

=== ReleaseLastForegroundCaptureBuffer ===
No input/output.

Same as [[#ReleaseLastApplicationCaptureBuffer]] except with a different state field + different input param for the called func.

=== AcquireCallerAppletCaptureBuffer ===
No input, returns an output handle.

Stubbed, just returns an error.

=== ReleaseCallerAppletCaptureBuffer ===
No input/output.

Same as [[#ReleaseLastApplicationCaptureBuffer]] except with a different state field + different input param for the called func.

=== AcquireLastApplicationCaptureBufferEx ===
No input, returns an output TransferMemory handle and an output u8 bool.

The state field used by [[#ReleaseLastApplicationCaptureBuffer]] must be 0. Calls a func which just returns an error (this is only the case on newer sysvers), hence this cmd will just return that error. If that func would have returned successfully, the state field would be set to 1 and the cmd would return 0.

On old sysvers, the output TransferMemory is size 0x384000 with permissions=RW.

=== AcquireLastForegroundCaptureBufferEx ===
No input, returns an output TransferMemory handle and an output u8 bool.

Same as [[#AcquireLastApplicationCaptureBufferEx]] except this uses the [[#ReleaseLastForegroundCaptureBuffer]] state field, and uses a different input param value for the called func.

=== AcquireCallerAppletCaptureBufferEx ===
No input, returns an output TransferMemory handle and an output u8 bool.

Same as [[#AcquireLastApplicationCaptureBufferEx]] except this uses the [[#ReleaseCallerAppletCaptureBuffer]] state field, and uses a different input param value for the called func.

=== ClearCaptureBuffer ===
Takes an input u8 bool, a s32 CaptureSharedBuffer, and an u32 color, returns no output.

Clear the input CaptureSharedBuffer with the specified RGBA8 color.

=== ClearAppletTransitionBuffer ===
Takes an input u32, no output.

Clear the AppletTransitionBuffer with the specified RGBA8 color.

=== AcquireLastApplicationCaptureSharedBuffer ===
No input, returns an output u8 bool and an s32.

This loads data from state.

=== ReleaseLastApplicationCaptureSharedBuffer ===
No input/output.

Depending on whether a state field is 0, this just returns an error or returns 0.

=== AcquireLastForegroundCaptureSharedBuffer ===
No input, returns an output u8 bool and an s32.

Calls the same func internally as [[#AcquireLastApplicationCaptureSharedBuffer]], except this passes value 1 for the last param instead of 0.

=== ReleaseLastForegroundCaptureSharedBuffer ===
No input/output.

Calls the same func internally as [[#ReleaseLastApplicationCaptureSharedBuffer]], except this passes value 1 for the last param instead of 0.

=== AcquireCallerAppletCaptureSharedBuffer ===
No input, returns an output u8 bool and an s32.

Calls the same func internally as [[#AcquireLastApplicationCaptureSharedBuffer]], except this passes value 2 for the last param instead of 0.

=== ReleaseCallerAppletCaptureSharedBuffer ===
No input/output.

Calls the same func internally as [[#ReleaseLastApplicationCaptureSharedBuffer]], except this passes value 2 for the last param instead of 0.

=== TakeScreenShotOfOwnLayerEx ===
Takes two input u8 bools and a s32, no output.

Calls the same func internally as [[#TakeScreenShotOfOwnLayer]], except the last bool param is the last cmd param bool instead of hard-coded 0. This flag indicates whether the screenshot should be taken Immediately.

== ISystemAppletControllerForDebug ==
This is "nn::am::service::ISystemAppletControllerForDebug".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 1 || RequestLaunchApplicationForDebug
|-
| 2 || [7.0.0+] [[#GetDebugStorageChannel]]
|-
| 3 || [7.0.0+] [[#CreateStorageForDebug]]
|-
| 4 || [12.0.0+] [[#CreateCradleFirmwareUpdaterForDebug]]
|}

=== GetDebugStorageChannel ===
No input. Returns an output [[#IStorageChannel]].

=== CreateStorageForDebug ===
Takes a total of 8-bytes of input. Returns an [[#IStorage]].

=== CreateCradleFirmwareUpdaterForDebug ===
No input. Returns an [[#ICradleFirmwareUpdater]].

== IProcessWindingController ==
This is "nn::am::service::IProcessWindingController".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#GetLaunchReason]] ||
|-
| 11 || [[#OpenCallingLibraryApplet]] ||
|-
| 21 || [[#PushContext]] ||
|-
| 22 || [[#PopContext]] ||
|-
| 23 || [[#CancelWindingReservation]] ||
|-
| 30 || [[#WindAndDoReserved]] ||
|-
| 40 || [[#ReserveToStartAndWaitAndUnwindThis]] ||
|-
| 41 || [4.0.0+] [[#ReserveToStartAndWait]] ||
|}

=== GetLaunchReason ===
No input, returns an output [[#AppletProcessLaunchReason]].

Used by LibraryApplets.

=== OpenCallingLibraryApplet ===
No input, returns an output [[#ILibraryAppletAccessor]].

The objptr from state is cleared during this, an error is thrown if it's already 0.

=== PushContext ===
Takes an input [[#IStorage]], no output.

=== PopContext ===
No input, returns an output [[#IStorage]].

=== CancelWindingReservation ===
No input/output.

=== WindAndDoReserved ===
No input/output.

=== ReserveToStartAndWaitAndUnwindThis ===
Takes an input [[#ILibraryAppletAccessor]], no output.

=== ReserveToStartAndWait ===
Takes an input [[#ILibraryAppletAccessor]], no output.

== IDebugFunctions ==
This is "nn::am::service::IDebugFunctions".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#NotifyMessageToHomeMenuForDebug]]
|-
| 1 || [1.0.0-9.2.0] [[#OpenMainApplication]]
|-
| 10 || [[#PerformSystemButtonPressing]]
|-
| 20 || [[#InvalidateTransitionLayer]]
|-
| 30 || [6.0.0+] [[#RequestLaunchApplicationWithUserAndArgumentForDebug]]
|-
| 31 || [12.0.0+] RequestLaunchApplicationByApplicationLaunchInfoForDebug
|-
| 40 || [6.0.0+] [[#GetAppletResourceUsageInfo]]
|-
| 50 || [15.0.0+] AddSystemProgramIdAndAppletIdForDebug
|-
| 51 || [16.0.0+] AddOperationConfirmedLibraryAppletIdForDebug
|-
| 100 || [7.0.0+] [[#SetCpuBoostModeForApplet]]
|-
| 101 || [10.0.0+] [[#CancelCpuBoostModeForApplet]]
|-
| 110 || [9.0.0+] [[#PushToAppletBoundChannelForDebug]]
|-
| 111 || [9.0.0+] [[#TryPopFromAppletBoundChannelForDebug]]
|-
| 120 || [9.0.0+] [[#AlarmSettingNotificationEnableAppEventReserve]]
|-
| 121 || [9.0.0+] [[#AlarmSettingNotificationDisableAppEventReserve]]
|-
| 122 || [9.0.0+] [[#AlarmSettingNotificationPushAppEventNotify]]
|-
| 130 || [9.0.0+] [[#FriendInvitationSetApplicationParameter]]
|-
| 131 || [9.0.0+] [[#FriendInvitationClearApplicationParameter]]
|-
| 132 || [9.0.0+] [[#FriendInvitationPushApplicationParameter]]
|-
| 140 || [14.0.0+] RestrictPowerOperationForSecureLaunchModeForDebug
|-
| 200 || [15.0.0+] CreateFloatingLibraryAppletAccepterForDebug
|-
| 300 || [16.0.0+] TerminateAllRunningApplicationsForDebug
|-
| 900 || [12.0.0+] GetGrcProcessLaunchedSystemEvent
|}

=== NotifyMessageToHomeMenuForDebug ===
Takes an input [[#AppletMessage]], no output.

Stubbed, just returns an error.

=== OpenMainApplication ===
No input, returns an output [[#IApplicationAccessor]].

Should not be used when no Application is running (svcBreak).

=== PerformSystemButtonPressing ===
Takes an input [[#SystemButtonType]], no output.

=== InvalidateTransitionLayer ===
No input/output.

=== RequestLaunchApplicationWithUserAndArgumentForDebug ===
Takes an input u8 bool flag, an [[NCM_services#ApplicationId|ApplicationId]], a type-0x5 input buffer containing an array of u128 userIDs, and a type-0x5 input buffer, no output.

Requests to launch the specified Application, with the specified users. When the bool flag is true, the content of the second input buffer is used to create a storage which is pushed to the UserChannel for this Application (see [[#LaunchParameterKind]]).

=== GetAppletResourceUsageInfo ===
No input, returns an output [[#AppletResourceUsageInfo]].

=== SetCpuBoostModeForApplet ===
Takes an input u32 [[#CpuBoostMode]] and passes it to [[PPC_services#apm:sys|SetCpuBoostMode]].

The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.

=== CancelCpuBoostModeForApplet ===
No input/output.

=== PushToAppletBoundChannelForDebug ===
Takes an input [[#IStorage]] and a s32, no output.

The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.

The s32 must match the value already stored in state when the state value is non-zero, otherwise an error is returned. When the state value is 0, the s32 is written into state. Then the input storage is pushed to the StorageChannel.

=== TryPopFromAppletBoundChannelForDebug ===
Takes an input s32, returns an output [[#IStorage]].

The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.

The s32 must not be 0 and must match the value previously saved by [[#PushToAppletBoundChannelForDebug]], otherwise errors are returned. Then the output storage is popped from the StorageChannel.

=== AlarmSettingNotificationEnableAppEventReserve ===
Takes an input [[#IStorage]] and an [[NCM_services#ApplicationId|ApplicationId]], no output.

Clears a StorageChannel, pushes the input storage there, and writes the ApplicationId into state.

=== AlarmSettingNotificationDisableAppEventReserve ===
No input/output.

Clears the StorageChannel/saved-ApplicationId used by [[#AlarmSettingNotificationEnableAppEventReserve]].

=== AlarmSettingNotificationPushAppEventNotify ===
Takes an input [[#IStorage]], no output.

Same as [[#PushToNotificationStorageChannel]] except this uses the MainApplication.

=== FriendInvitationSetApplicationParameter ===
Takes an input [[#IStorage]] and an [[NCM_services#ApplicationId|ApplicationId]], no output.

Clears a StorageChannel, pushes the input storage there, and writes the ApplicationId into state.

=== FriendInvitationClearApplicationParameter ===
No input/output.

Clears the StorageChannel/saved-ApplicationId used by [[#FriendInvitationSetApplicationParameter]].

=== FriendInvitationPushApplicationParameter ===
Takes an input [[#IStorage]], no output.

Same as [[#PushToFriendInvitationStorageChannel]] except this uses the MainApplication.

== IStorage ==
This is "nn::am::service::IStorage".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || Open || No input. Returns an [[#IStorageAccessor]].
|-
| 1 || [2.0.0+] OpenTransferStorage || No input. Returns an [[#ITransferStorageAccessor]].
|}

Open can only be used when the IStorage was created by [[#CreateStorage]] or [[#CreateTransferMemoryStorage]]. OpenTransferStorage can only be used when the IStorage was created by [[#CreateHandleStorage]].

Only 1 *Accessor session can be open for each IStorage at a time.

== IStorageAccessor ==
This is "nn::am::service::IStorageAccessor".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || GetSize || No input. Returns an s64.
|-
| 10 || Write || Takes an input s64 and a type-0x21 input buffer.
|-
| 11 || Read || Takes an input s64 and a type-0x22 output buffer.
|}

== ITransferStorageAccessor ==
This is "nn::am::service::ITransferStorageAccessor".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || GetSize || No input. Returns an output s64.
|-
| 1 || GetHandle || No input. Returns an output s64 and handle.
|}

These commands return the data originally from [[#CreateHandleStorage]] input, both return the same s64.

= appletOE =
This is "nn::am::service::IApplicationProxyService".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#OpenApplicationProxy]] ||
|}

This is used by all regular-applications, including [[flog]] and "Retail Interactive Display Menu". Only one session can be open for this service at a time.

== OpenApplicationProxy ==
Returns an [[#IApplicationProxy]]. See [[#appletAE]].

Takes a [[IPC_Marshalling|reserved]] input u64 (official user-processes use hard-coded value 0), a PID, and a process copy-handle (cur-proc handle alias).

On failure, official user-processes will retry using this command in a loop while the retval is 0x19280, with svcSleepThread(10000000) being called first.

= idle:sys =
This is "nn::idle::detail::IPolicyManagerSystem"

This was moved to [[OMM_services|omm]] with [14.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetAutoPowerDownEvent
|-
| 1 || [7.0.0+] IsAutoPowerDownRequested ([1.0.0-3.0.2] )
|-
| 2 || [1.0.0-3.0.2]
|-
| 3 || [[#SetHandlingContext]]
|-
| 4 || LoadAndApplySettings
|-
| 5 || ReportUserIsActive
|}

== SetHandlingContext ==
[3.0.0+] Now takes an additional 0x10-bytes of input.

[13.0.0+] Total input size is now 0x30 instead of 0x38.

= omm =
This is "nn::omm::detail::IOperationModeManager"

Operation Mode Manager (OMM) is a service responsible for arbitrating the operation changes between docked and handheld modes.
Besides [[PTM_services|PTM]], this is the only service that interacts with the [[Dock]] through [[USB_services|usb:pd*]].

This was moved to [[OMM_services|omm]] with [14.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetOperationMode
|-
| 1 || GetOperationModeChangeEvent
|-
| 2 || EnableAudioVisual
|-
| 3 || DisableAudioVisual
|-
| 4 || EnterSleepAndWait
|-
| 5 || GetCradleStatus
|-
| 6 || FadeInDisplay
|-
| 7 || FadeOutDisplay
|-
| 8 || [2.0.0+] GetCradleFwVersion
|-
| 9 || [2.0.0+] NotifyCecSettingsChanged
|-
| 10 || [3.0.0+] SetOperationModePolicy
|-
| 11 || [3.0.0+] GetDefaultDisplayResolution
|-
| 12 || [3.0.0+] GetDefaultDisplayResolutionChangeEvent
|-
| 13 || [3.0.0+] UpdateDefaultDisplayResolution
|-
| 14 || [3.0.0+] ShouldSleepOnBoot
|-
| 15 || [4.0.0+] NotifyHdcpApplicationExecutionStarted
|-
| 16 || [4.0.0+] NotifyHdcpApplicationExecutionFinished
|-
| 17 || [4.0.0+] NotifyHdcpApplicationDrawingStarted
|-
| 18 || [4.0.0+] NotifyHdcpApplicationDrawingFinished
|-
| 19 || [4.0.0+] GetHdcpAuthenticationFailedEvent
|-
| 20 || [4.0.0+] GetHdcpAuthenticationFailedEmulationEnabled
|-
| 21 || [4.0.0+] SetHdcpAuthenticationFailedEmulation
|-
| 22 || [4.0.0+] GetHdcpStateChangeEvent
|-
| 23 || [4.0.0+] GetHdcpState
|-
| 24 || [5.0.0+] ShowCardUpdateProcessing
|-
| 25 || [5.0.0+] SetApplicationCecSettingsAndNotifyChanged
|-
| 26 || [7.0.0+] [[#GetOperationModeSystemInfo]]
|-
| 27 || [9.0.0+] GetAppletFullAwakingSystemEvent
|-
| 28 || [12.0.0+] [[#CreateCradleFirmwareUpdater]]
|}

== GetOperationModeSystemInfo ==
No input, returns an output u32.

This is used by [[#GetOperationModeSystemInfo|ICommonStateGetter GetOperationModeSystemInfo]].

== CreateCradleFirmwareUpdater ==
No input. Returns an [[#ICradleFirmwareUpdater]].

== ICradleFirmwareUpdater ==
This is "nn::am::service::ICradleFirmwareUpdater".

This was added with [12.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || Start
|-
| 1 || Finish
|-
| 2 || GetUpdateDeviceStatus
|-
| 3 || GetUpdateProgress
|-
| 4 || GetUpdateDeviceStatusChangeEvent
|-
| 5 || GetUpdateProgress2
|}

= spsm =
This is "nn::spsm::detail::IPowerStateInterface".

This was moved to [[OMM_services|omm]] with [14.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetCurrentState
|-
| 1 || EnterSleep
|-
| 2 || GetLastWakeReason
|-
| 3 || Shutdown
|-
| 4 || GetNotificationMessageEventHandle
|-
| 5 || ReceiveNotificationMessage
|-
| 6 || AnalyzeLogForLastSleepWakeSequence
|-
| 7 || ResetEventLog
|-
| 8 || AnalyzePerformanceLogForLastSleepWakeSequence
|-
| 9 || ChangeHomeButtonLongPressingTime
|-
| 10 || PutErrorState
|-
| 11 || [1.0.0-3.0.2] InvalidateCurrentHomeButtonPressing
|}

[3.0.0+] Cmd11 now takes a total of 8-bytes of input.

= tcap =
This is "nn::tcap::server::IManager".

This was removed with [11.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetContinuousHighSkinTemperatureEvent
|-
| 1 || SetOperationMode
|-
| 2 || LoadAndApplySettings
|}

= caps:su =
This is "nn::capsrv::sf::IScreenShotApplicationService".

This was added with [6.0.0+].

This can be used by applications to save screenshots.

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 32 || [7.0.0+] SetShimLibraryVersion || Takes a total of 0x10-bytes of input and a PID, no output.
|-
| 201 || SaveScreenShot ||
|-
| 203 || SaveScreenShotEx0 ||
|-
| 205 || [8.0.0+] SaveScreenShotEx1 ||
|-
| 210 || SaveScreenShotEx2 || Takes a total of 0x50-bytes of input, a type-0x15 input buffer, and a type-0x45 input buffer. Returns a total of 0x20-bytes of output.
|}

'''SetShimLibraryVersion''' is a wrapper for [[Capture_services|caps:c]] cmd33. Commands '''SaveScreenShot''', '''SaveScreenShotEx0''', '''SaveScreenShotEx1''' and '''SaveScreenShotEx2''' are wrappers for [[Display_services|caps:sc]] cmd210.

== SaveScreenShot ==
Takes two input u32s, an u64 AppletResourceUserId, a PID, and a type-0x45 input buffer containing image data. Returns an [[Capture_services|ApplicationAlbumEntry]].

Official user-processes doesn't use this, instead [[#SaveScreenShotEx0]] is used: ScreenShotAttributeEx0 is all-zero, except +4 is set to an input u32 and u32 +0xC = 0x1.

This cmd internally uses an all-zero ScreenShotAttributeEx0, with u32 +0 = input u32 and u32 +0x8 = 0x3.

== SaveScreenShotEx0 ==
Takes an input 0x40-byte struct '''ScreenShotAttributeEx0''', an input u32, an input u64 AppletResourceUserId, a PID, and a type-0x45 input buffer containing image data. Returns an [[Capture_services|ApplicationAlbumEntry]].

== SaveScreenShotEx1 ==
Takes an input 0x40-byte struct '''ScreenShotAttributeEx0''', an input u32, an input u64 AppletResourceUserId, a PID, a type-0x15 input buffer containing an [[Capture_services|ApplicationData]], and a type-0x45 input buffer containing image data. Returns an [[Capture_services|ApplicationAlbumEntry]].

== SaveScreenShotEx2 ==
Takes an input 0x40-byte struct '''ScreenShotAttributeEx0''', an input u32, an input u64 AppletResourceUserId, a type-0x15 input buffer containing an [[Capture_services|UserIdList]], and a type-0x45 input buffer containing image data. Returns an [[Capture_services|ApplicationAlbumEntry]].

= apm =
This is "nn::am::service::IApmManager".

This was added with [8.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#OpenSession]]
|-
| 1 || GetPerformanceMode
|-
| 6 || [7.0.0+] [[#IsCpuOverclockEnabled]]
|}

== OpenSession ==
Returns an [[#ISession]].

== IsCpuOverclockEnabled ==
No input, returns an output u8 bool.

== ISession ==
This is "nn::am::service::IApmSession".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || SetPerformanceConfiguration
|-
| 1 || GetPerformanceConfiguration
|-
| 2 || [8.0.0+] SetCpuOverclockEnabled
|}

= Library Applets =
This section documents library applet launching.

Before starting the applet, [[#IStorage]]s are [[#ILibraryAppletCreator|created]] and written, then passed to [[#ILibraryAppletAccessor]] PushInData. The [[#IStorage]] session is closed afterwards. The first [[#IStorage]] is [[#CommonArguments]], followed by any applet-specific [[#IStorage]]s.

Once the applet finishes running successfully, [[#ILibraryAppletAccessor]] PopOutData can be used to get the applet-specific [[#IStorage]] containing the applet output data.

== CommonArguments ==
The first [[#CreateStorage|IStorage]] passed to applets should contain the common library applet arguments. This is populated by <code>nn::la::CommonArgumentsWriter</code> and has the following format.

This struct is 0x20-bytes.

Official sw handles the first 8-bytes separately, which is a header. With CommonArguments version 0x0, the header is 4-bytes, while starting with version 0x1 it's 8-bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Typical Value || Notes
|-
| 0x0 || 4 || 1 || Common Arguments version
|-
| 0x4 || 4 || 0x20 || Common Arguments size
|-
| 0x8 || 4 || || Library applet version (API version)
|-
| 0xC || 4 || 0 || Theme color
|-
| 0x10 || 1 || 0 || Play startup sound
|-
| 0x18 || 8 || N/A || System tick (see [[SVC#svcGetSystemTick|svcGetSystemTick]])
|-
|}

= AppletId =
This is "nn::applet::AppletId". See also [[:Category:Library Applets]].

{| class="wikitable" border="1"
|-
! Value
! ProgramId
! Description
|-
| 0x00
|
| None
|-
| 0x01
|
| Application (not valid for use with LibraryApplets)
|-
| 0x02
| 010000000000100C
| OverlayApplet (overlayDisp)
|-
| 0x03
| 0100000000001000
| SystemAppletMenu (qlaunch)
|-
| 0x04
| 0100000000001012
| SystemApplication (starter)
|-
| 0x0A
| 0100000000001001
| [[Auth_Applet|LibraryAppletAuth (auth)]]
|-
| 0x0B
| 0100000000001002
| [[Cabinet_Applet|LibraryAppletCabinet (cabinet)]]
|-
| 0x0C
| 0100000000001003
| [[Controller_Applet|LibraryAppletController (controller)]]
|-
| 0x0D
| 0100000000001004
| LibraryAppletDataErase (dataErase)
|-
| 0x0E
| 0100000000001005
| [[Error_Applet|LibraryAppletError (error)]]
|-
| 0x0F
| 0100000000001006
| LibraryAppletNetConnect (netConnect)
|-
| 0x10
| 0100000000001007
| [[Profile_Selector|LibraryAppletPlayerSelect (playerSelect)]]
|-
| 0x11
| 0100000000001008
| [[Software_Keyboard|LibraryAppletSwkbd (swkbd)]]
|-
| 0x12
| 0100000000001009
| [[MiiEdit_Applet|LibraryAppletMiiEdit (miiEdit)]]
|-
| 0x13
| 010000000000100A
| [[Internet_Browser#010000000000100A|LibraryAppletWeb (web)]]
|-
| 0x14
| 010000000000100B
| [[Internet_Browser#ShopN|LibraryAppletShop (shop)]]
|-
| 0x15
| 010000000000100D
| [[Album_Applet|LibraryAppletPhotoViewer (photoViewer)]]
|-
| 0x16
| 010000000000100E
| LibraryAppletSet (set)
|-
| 0x17
| 010000000000100F
| [[Internet_Browser#Offline_Applet|LibraryAppletOfflineWeb (offlineWeb)]]
|-
| 0x18
| 0100000000001010
| [[Internet_Browser#Whitelisted_Applets|LibraryAppletLoginShare (loginShare)]]
|-
| 0x19
| 0100000000001011
| [[Internet_Browser#WifiWebAuthApplet|LibraryAppletWifiWebAuth (wifiWebAuth)]]
|-
| 0x1A
| 0100000000001013
| [[MyPage_Applet|LibraryAppletMyPage (myPage)]]
|-
| 0x1B
| 010000000000101A
| LibraryAppletGift (gift)
|-
| 0x1C
| 010000000000101C
| LibraryAppletUserMigration (userMigration)
|-
| 0x1D
| 010000000000101D
| [9.0.0+] LibraryAppletPreomiaSys (EncounterSys)
|-
| 0x1E
| 0100000000001020
| [9.0.0+] LibraryAppletStory (story)
|-
| 0x1F
| 010070000E3C0000
| [9.0.0+] LibraryAppletPreomiaUsr (EncounterUsr)
|-
| 0x20
| 010086000E49C000
| [9.0.0+] LibraryAppletPreomiaUsrDummy (EncounterUsrDummy)
|-
| 0x21
| 0100000000001038
| [10.0.0+] LibraryAppletSample (sample)
|-
| 0x22
| 0100000000001007
| [13.0.0+] LibraryAppletPromoteQualification (playerSelect)
|-
| 0x35
| 0100000000001042
| [16.0.0+]
|-
| 0x36
| 0100000000001042
| [16.0.0+]
|-
| 0x37
| 0100000000001042
| [16.0.0+]
|-
| 0x38
| 0100000000001043
| [16.0.0+]
|-
| 0x3E8
|
| [10.0.0+] DevlopmentTool
|-
| 0x3F1
| 010000000000D619
| [10.0.0+] CombinationLA
|-
| 0x3F2
| 010000000000D610
| [10.0.0+] AeSystemApplet
|-
| 0x3F3
| 010000000000D611
| [10.0.0+] AeOverlayApplet
|-
| 0x3F4
| 010000000000D612
| [10.0.0+] AeStarter
|-
| 0x3F5
| 010000000000D613
| [10.0.0+] AeLibraryAppletAlone
|-
| 0x3F6
| 010000000000D614
| [10.0.0+] AeLibraryApplet1
|-
| 0x3F7
| 010000000000D615
| [10.0.0+] AeLibraryApplet2
|-
| 0x3F8
| 010000000000D616
| [10.0.0+] AeLibraryApplet3
|-
| 0x3F9
| 010000000000D617
| [10.0.0+] AeLibraryApplet4
|-
| 0x3FA
| 010000000000D60A
| [10.0.0+] AppletISA
|-
| 0x3FB
| 010000000000D60B
| [10.0.0+] AppletIOA
|-
| 0x3FC
| 010000000000D60C
| [10.0.0+] AppletISTA
|-
| 0x3FD
| 010000000000D60D
| [10.0.0+] AppletILA1
|-
| 0x3FE
| 010000000000D60E
| [10.0.0+] AppletILA2
|}

= LibraryAppletMode =
This is "nn::applet::LibraryAppletMode".

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0x0
| AllForeground
|-
| 0x1
| PartialForeground
|-
| 0x2
| NoUi
|-
| 0x3
| PartialForegroundWithIndirectDisplay (see also [[#GetIndirectLayerConsumerHandle]], only used by swkbd [[Software_Keyboard|InlineKeyboard]])
|-
| 0x4
| AllForegroundInitiallyHidden (can be used by [7.0.0+] [[Internet_Browser|WebSession]])
|}

= AppletMessage =
This is "nn::am::AppletMessage".

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || None
|-
| 1 || ChangeIntoForeground
|-
| 2 || ChangeIntoBackground
|-
| 4 || Exit
|-
| 6 || ApplicationExited
|-
| 15 || [[#FocusState|FocusStateChanged]]
|-
| 16 || [[#SetRestartMessageEnabled|Resume]]
|-
| 20 || DetectShortPressingHomeButton
|-
| 21 || DetectLongPressingHomeButton
|-
| 22 || DetectShortPressingPowerButton
|-
| 23 || DetectMiddlePressingPowerButton
|-
| 24 || DetectLongPressingPowerButton
|-
| 25 || RequestToPrepareSleep
|-
| 26 || FinishedSleepSequence
|-
| 27 || SleepRequiredByHighTemperature
|-
| 28 || SleepRequiredByLowBattery
|-
| 29 || AutoPowerDown
|-
| 30 || [[#OperationMode|OperationModeChanged]]
|-
| 31 || [[#PerformanceMode|PerformanceModeChanged]]
|-
| 32 || DetectReceivingCecSystemStandby
|-
| 33 || SdCardRemoved
|-
| 50 || LaunchApplicationRequested
|-
| 51 || [[#SetHandlesRequestToDisplay|RequestToDisplay]]
|-
| 55 || ShowApplicationLogo
|-
| 56 || HideApplicationLogo
|-
| 57 || ForceHideApplicationLogo
|-
| 60 || FloatingApplicationDetected
|-
| 90 || [[#SetRequiresCaptureButtonShortPressedMessage|DetectShortPressingCaptureButton]]
|-
| 92 || [[#SetAlbumImageTakenNotificationEnabled|AlbumScreenShotTaken]]
|-
| 93 || AlbumRecordingSaved
|}

= OperationMode =
This is "nn::oe::OperationMode".

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || Handheld
|-
| 1 || Console
|}

= PerformanceMode =
This is "nn::oe::PerformanceMode".

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| -1 || Invalid
|-
| 0 || Normal
|-
| 1 || Boost
|}

= FocusState =
This is "nn::oe::FocusState".

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 1 || InFocus
|-
| 2 || OutOfFocus
|-
| 3 || Background
|}

= CpuBoostMode =
This is "nn::oe::CpuBoostMode".

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || Normal
|-
| 1 || FastLoad
|}

= WindowOriginMode =
This is "nn::oe::WindowOriginMode".

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || LowerLeft
|-
| 1 || UpperLeft
|}

= WirelessPriorityMode =
This is "nn::oe::WirelessPriorityMode".

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || Default
|-
| 1 || OptimizedForWlan
|}

= TvPowerStateMatchingMode =
This is "nn::oe::TvPowerStateMatchingMode". This is used with [[#SetTvPowerStateMatchingMode]].

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || Unknown
|-
| 1 || Unknown
|}

= SystemButtonType =
This is "nn::am::service::SystemButtonType". This is used with [[#PerformSystemButtonPressingIfInFocus]]/[[#PerformSystemButtonPressing]].

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 1 || PerformHomeButtonShortPressing
|-
| 2 || PerformHomeButtonLongPressing
|-
| 3 || Short-pressing with the Power-button. Only available with [[#PerformSystemButtonPressing]].
|-
| 4 || Long-pressing with the Power-button. Only available with [[#PerformSystemButtonPressing]].
|-
| 5 || Shutdown the system. Only available with [[#PerformSystemButtonPressing]].
|-
| 6 || PerformCaptureButtonShortPressing
|-
| 7 || PerformCaptureButtonLongPressing
|}

= LaunchParameterKind =
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 1 || UserChannel. Application-specific LaunchParameter.
|-
| 2 || account PreselectedUser
|-
| 3 || Unknown if used by anything?
|}

= LibraryAppletExitReason =
{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || Normal
|-
| 1 || Canceled
|-
| 2 || Abnormal
|-
| 10 || Unexpected
|}

= ProgramSpecifyKind =
This is "nn::am::service::ProgramSpecifyKind". This controls the type of the u64 passed to [[#ExecuteProgram]].

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || u8 ProgramIndex. "ExecuteProgram". [[NS_Services|NS]] handles ProgramIndex by launching ApplicationId+ProgramIndex. After using [[#ExecuteProgram]] with this successfully, official user-processes will enter an infinite loop with sleep-thread value 86400000000000.
|-
| 1 || [[NCM_services#ApplicationId|ApplicationId]]. "JumpToSubApplicationProgramForDevelopment". Only available when [[Settings_services#GetDebugModeFlag|DebugMode]] is 1.
|-
| 2 || u64 = value 0. "RestartProgram"
|}

ProgramIndex values where the title is not installed should not be used: [[qlaunch]] will display an error message and the current title will become "corrupted", however Home Menu will have an option to repair it.

= InputDetectionPolicy =
This is u32 enum "nn::applet::InputDetectionPolicy".

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || Unknown
|-
| 1 || Unknown
|}

= AppletResourceUserId =
This is "nn::applet::AppletResourceUserId". Used by a number of non-AM services.

= AppletAttribute =
This is "nn::am::AppletAttribute". This struct is 0x80 bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x1 || Flag. When non-zero, two state fields are set to 1.
|-
| 0x1 || 0x7F || Unused
|}

This is used by [[#OpenLibraryAppletProxy]].

= AppletProcessLaunchReason =
This is "nn::am::service::AppletProcessLaunchReason". This struct is 0x4-bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x1 || Flag. When non-zero, LibraryApplets then use [[#OpenCallingLibraryApplet]].
|-
| 0x1 || 0x2 || Always 0.
|-
| 0x3 || 0x1 || Always 0.
|}

= LibraryAppletInfo =
This is "nn::am::service::LibraryAppletInfo". This struct is 0x8-bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || [[#AppletId]]
|-
| 0x4 || 0x4 || [[#LibraryAppletMode]]
|}

= AppletKind =
This is "nn::am::service::AppletKind". This is 8-bytes.

= AppletIdentityInfo =
This struct is "nn::am::service::AppletIdentityInfo". This struct is 0x10-bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || [[#AppletId]]
|-
| 0x4 || 0x4 || Padding
|-
| 0x8 || 0x8 || [[NCM_services#ApplicationId|ApplicationId]]
|}

= ApplicationAttributeForQuest =
This struct is "nn::applet::ApplicationAttributeForQuest".

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || See [[#ApplicationAttribute]].
|-
| 0x4 || 0x4 || See [[#ApplicationAttribute]].
|-
| 0x8 || 0x4 || [7.0.0+] See [[#ApplicationAttribute]].
|}

User-processes copy the first 0x8-bytes (0xC-bytes with [[#CreateApplicationWithAttributeAndPushAndRequestToStartForQuest]]/[[#CreateApplicationWithAttributeAndRequestToStartForQuest]]) to a [[#ApplicationAttribute]] with the rest of the struct being cleared, which is then passed to the actual cmd (CreateApplication*ToStartForQuest).

= ApplicationAttribute =
This struct is "nn::am::ApplicationAttribute". This struct is 0x20-bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || Default is 0 for non-Quest. Only used when non-zero: unknown value in seconds.
|-
| 0x4 || 0x4 || Default is 0 for non-Quest. Only used when non-zero: unknown value in seconds.
|-
| 0x8 || 0x4 || float audio volume. Must be in the range of 0.0f-1.0f. The default is 1.0f.
|-
| 0xC || 0x14 || Unused. Default is 0.
|}

Internally AM only uses the first 0xC-bytes from ApplicationAttribute, regardless of the cmd.

= ApplicationLaunchProperty =
This struct is 0x10-bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || [[NCM_services#ApplicationId|ApplicationId]]
|-
| 0x8 || 0x4 || Application title-version.
|-
| 0xC || 0x1 || [[Filesystem_services#StorageId|StorageId]] for the Application base title.
|-
| 0xD || 0x1 || [[Filesystem_services#StorageId|StorageId]] for the Application update title.
|-
| 0xE || 0x1 || Unknown.
|-
| 0xF || 0x1 || Padding.
|}

= ApplicationLaunchRequestInfo =
This is "nn::applet::ApplicationLaunchRequestInfo". This struct is 0x10-bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || Unknown. The default is 0x0 with [[#CreateSystemApplication]], 0x3 with [[#CreateApplication]].
|-
| 0x4 || 0x4 || Unknown. The default is 0x0 with [[#CreateSystemApplication]], 0x3 with [[#CreateApplication]].
|-
| 0x8 || 0x8 || Unknown. The default is 0x0.
|}

= AppletResourceUsageInfo =
This is "nn::am::service::AppletResourceUsageInfo". This struct is 0x20-bytes.

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || Unknown counter.
|-
| 0x4 || 0x4 || Unknown counter.
|-
| 0x8 || 0x4 || Output from [[NS_Services|NS GetRightsEnvironmentCountForDebug]].
|-
| 0xC || 0x14 || Always zero.
|}

= ApplicationLicenseType =
This is "nn::oe::ApplicationLicenseType". This is 1-byte.

= LaunchRequiredVersion =
This is "nn::oe::LaunchRequiredVersion". This is a 0x40-byte struct with 1-byte alignment.

= ServerEnvironmentType =
This is "nn::oe::ServerEnvironmentType".

{| class="wikitable" border="1"
|-
! Value
! Description
|-
| 0 || dd
|-
| 1 || lp
|-
| 2 || sd
|-
| 3 || sp
|-
| 4 || dp
|}

= Notes =
AM-sysmodule will only initialize [[Shared_Database_services|pdm:ntfy]] / use pdm:ntfy service commands when the value from [[Process_Manager_services|pm:bm]] GetBootMode is not 0x1 (Maintenance).

An object constructor also writes the output from [[Process_Manager_services|pm:bm]] GetBootMode into the created object. A vfunc for this object checks whether this field is Maintenance: if so, it calls a vfunc then a func and returns. Otherwise after calling various (v)funcs, if required this eventually uses [[OMM_services|ommdisp]] cmd600.

[[Category:Services]]

Thread Local Region

2023-09-11T15:49:51Z

Liamwhite:

This is the 0x200-byte thread local region. Its base address is loaded via ARM threadid register tpidrro_el0. TLR for multiple threads are stored in the same page, with the first TLR normally located at page+0x200, because the first TLR spot is reserved for usermode exception handling. In threads created by sdk, tpidr_el0 is assigned to the ThreadPointer object from the thread local region.

= Structure =
This is "nn::svc::ThreadLocalRegion".

{| class="wikitable" border="1"
|-
! Offset
! Size
! Name
! Description
|-
| 0x0
| 0x100
| MessageBuffer
| [[IPC_Marshalling|IPC]] command buffer.
|-
| [8.0.0+] 0x100
| 0x2
| DisableCounter
| If userland sets this to non-zero, kernel will pin the thread and disallow calls to almost all SVCs.
|-
| [8.0.0+] 0x102
| 0x2
| InterruptFlag
| If a context switch would have occurred when user disable count was non-zero, kernel will set this to 1. This signifies that the user must call [[SVC#SynchronizePreemptionState|SynchronizePreemptionState]] to unpin itself and regain access other SVCs.
|-
| 0x104
| 0x4
| Reserved
|
|-
| 0x108
| 0x78
| Reserved
|
|-
| 0x180
| 0x50
| Tls
|
|-
| 0x1D0
| 0x8
| LocalePtr
|
|-
| 0x1D8
| 0x8
| ErrnoVal
|
|-
| 0x1E0
| 0x8
| ThreadData
|
|-
| 0x1E8
| 0x8
| EhGlobals
|
|-
| 0x1F0
| 0x8
| ThreadPointer
|
|-
| 0x1F8
| 0x8
| ThreadType
| Pointer to [[Thread_Local_Region#ThreadType|thread type]].
|}

= Userland context =
== OsBootParamter ==
This is "nn::os::detail::g_OsBootParamter".

{| class="wikitable" border="1"
|-
! Offset
! Size
! Name
! Description
|-
| 0x00
| 0x04
|
| Main thread handle.
|-
| 0x04
| 0x04
|
| Always 0.
|-
| 0x08
| 0x30
|
| Empty.
|}

== OsResourceManagerStorage ==
This is "nn::os::detail::g_OsResourceManagerStorage".

{| class="wikitable" border="1"
|-
! Offset
! Size
! Name
! Description
|-
| 0x00
| 0x04
|
| Always 0.
|-
| 0x04
| 0x10
|
| Process PRNG.
|-
| 0x14
| 0x04
|
| Padding.
|-
| 0x18
| 0x08
|
| Always set to 0.
|-
| 0x20
| 0x08
|
| [[SVC#GetInfo|AddressSpaceStart]] right shifted by 0x0C.
|-
| 0x28
| 0x08
|
| AddressSpaceEnd ([[SVC#GetInfo|AddressSpaceStart]] + [[SVC#GetInfo|AddressSpaceSize]]) right shifted by 0x0C and aligned to AddressSpaceAlign.
|-
| 0x30
| 0x08
|
| AddressSpaceAlign right shifted by 0x0C.
|-
| 0x38
| 0x08
|
| Always 0.
|-
| 0x40
| 0x08
|
| Always set to 0.
|-
| 0x48
| 0x08
|
| [[SVC#GetInfo|MapRegionBased]] right shifted by 0x0C.
|-
| 0x50
| 0x08
|
| MapRegionEnd ([[SVC#GetInfo|MapRegionBased]] + [[SVC#GetInfo|MapRegionSize]]) right shifted by 0x0C and aligned to MapRegionAlign.
|-
| 0x58
| 0x08
|
| MapRegionAlign right shifted by 0x0C.
|-
| 0x60
| 0x08
|
| Always 0.
|-
| 0x68
| 0x08
|
| Always 0.
|-
| 0x70
| 0x1D0
|
| Main [[Thread_Local_Region#ThreadType|thread type]].
|-
| 0x240
| 0x08
|
| Pointer to main [[Thread_Local_Region#ThreadType|thread type]].
|-
| 0x248
| 0x08
|
| Unknown.
|-
| 0x250
| 0x08
|
| Unknown.
|-
| 0x258
| 0x130
|
| Always empty?
|-
| 0x388
| 0x08
|
| Pointer to [[Thread_Local_Region#OsResourceManagerStorage|resource manager storage]] + 0x388.
|-
| 0x390
| 0x08
|
| Pointer to [[Thread_Local_Region#OsResourceManagerStorage|resource manager storage]] + 0x388.
|-
| 0x398
| 0x08
|
| Always 0.
|-
| 0x3A0
| 0x08
|
| Always 0.
|}

== ThreadType ==
This is "nn::os::ThreadType".

{| class="wikitable" border="1"
|-
! Offset
! Size
! Name
! Description
|-
| 0x00
| 0x10
| AllThreadsListNode
|
|-
| 0x10
| 0x10
| MultiWaitObjectList
|
|-
| 0x20
| 0x20
| Reserved
|
|-
| 0x40
| 0x01
| State
| Thread status.
|-
| 0x41
| 0x01
| StackIsAliased
|
|-
| 0x42
| 0x01
| AutoRegistered
|
|-
| 0x43
| 0x01
| SuspendCount
|
|-
| 0x44
| 0x02
| BasePriority
| Thread priority minus 0x1C.
|-
| 0x46
| 0x02
| Version
|
|-
| 0x48
| 0x08
| OriginalStack
| Thread stack base address.
|-
| 0x50
| 0x08
| Stack
| Thread stack base address mirror.
|-
| 0x58
| 0x08
| StackSize
| Thread stack size.
|-
| 0x60
| 0x08
| Argument
|
|-
| 0x68
| 0x08
| ThreadFunction
|
|-
| 0x70
| 0x08
| CurrentFiber
|
|-
| 0x78
| 0x08
| InitialFiber
|
|-
| 0x80
| 0x100
| TlsValueArray
| TLS slots.
|-
| 0x180
| 0x20
| ThreadNameBuffer
| Thread name.
|-
| 0x1A0
| 0x08
| NamePointer
| Thread name address.
|-
| 0x1A8
| 0x04
| CsThread
| Critical Section Storage.
|-
| 0x1AC
| 0x04
| CvThread
| Conditional Variable Storage.
|-
| 0x1B0
| 0x04
| Handle
| Thread handle.
|-
| 0x1B4
| 0x04
| LockHistory
|
|-
| 0x1B8
| 0x08
| ThreadId
|
|}

SVC

2023-02-18T18:32:19Z

Liamwhite: ResetSignal returns ResultInvalidState if the event is not signaled

__NOTOC__

= System calls =
{| class=wikitable
! ID || Return Type || Name || Arguments
|-
| 0x01 || Result || [[#SetHeapSize|SetHeapSize]] || uintptr_t *out_address, size_t size
|-
| 0x02 || Result || [[#SetMemoryPermission|SetMemoryPermission]] || uintptr_t address, size_t size, MemoryPermission perm
|-
| 0x03 || Result || [[#SetMemoryAttribute|SetMemoryAttribute]] || uintptr_t address, size_t size, uint32_t mask, uint32_t attr
|-
| 0x04 || Result || [[#MapMemory|MapMemory]] || uintptr_t dst_address, uintptr_t src_address, size_t size
|-
| 0x05 || Result || [[#UnmapMemory|UnmapMemory]] || uintptr_t dst_address, uintptr_t src_address, size_t size
|-
| 0x06 || Result || [[#QueryMemory|QueryMemory]] || arch::MemoryInfo *out_memory_info, PageInfo *out_page_info, uintptr_t address
|-
| 0x07 || void || [[#ExitProcess|ExitProcess]] ||
|-
| 0x08 || Result || [[#CreateThread|CreateThread]] || Handle *out_handle, ThreadFunc func, uintptr_t arg, uintptr_t stack_bottom, int32_t priority, int32_t core_id
|-
| 0x09 || Result || [[#StartThread|StartThread]] || Handle thread_handle
|-
| 0x0A || void || [[#ExitThread|ExitThread]] ||
|-
| 0x0B || void || [[#SleepThread|SleepThread]] || int64_t ns
|-
| 0x0C || Result || [[#GetThreadPriority|GetThreadPriority]] || int32_t *out_priority, Handle thread_handle
|-
| 0x0D || Result || [[#SetThreadPriority|SetThreadPriority]] || Handle thread_handle, int32_t priority
|-
| 0x0E || Result || [[#GetThreadCoreMask|GetThreadCoreMask]] || int32_t *out_core_id, uint64_t *out_affinity_mask, Handle thread_handle
|-
| 0x0F || Result || [[#SetThreadCoreMask|SetThreadCoreMask]] || Handle thread_handle, int32_t core_id, uint64_t affinity_mask
|-
| 0x10 || int32_t || [[#GetCurrentProcessorNumber|GetCurrentProcessorNumber]] ||
|-
| 0x11 || Result || [[#SignalEvent|SignalEvent]] || Handle event_handle
|-
| 0x12 || Result || [[#ClearEvent|ClearEvent]] || Handle event_handle
|-
| 0x13 || Result || [[#MapSharedMemory|MapSharedMemory]] || Handle shmem_handle, uintptr_t address, size_t size, MemoryPermission map_perm
|-
| 0x14 || Result || [[#UnmapSharedMemory|UnmapSharedMemory]] || Handle shmem_handle, uintptr_t address, size_t size
|-
| 0x15 || Result || [[#CreateTransferMemory|CreateTransferMemory]] || Handle *out_handle, uintptr_t address, size_t size, MemoryPermission map_perm
|-
| 0x16 || Result || [[#CloseHandle|CloseHandle]] || Handle handle
|-
| 0x17 || Result || [[#ResetSignal|ResetSignal]] || Handle handle
|-
| 0x18 || Result || [[#WaitSynchronization|WaitSynchronization]] || int32_t *out_index, const Handle *handles, int32_t numHandles, int64_t timeout_ns
|-
| 0x19 || Result || [[#CancelSynchronization|CancelSynchronization]] || Handle handle
|-
| 0x1A || Result || [[#ArbitrateLock|ArbitrateLock]] || Handle thread_handle, uintptr_t address, uint32_t tag
|-
| 0x1B || Result || [[#ArbitrateUnlock|ArbitrateUnlock]] || uintptr_t address
|-
| 0x1C || Result || [[#WaitProcessWideKeyAtomic|WaitProcessWideKeyAtomic]] || uintptr_t address, uintptr_t cv_key, uint32_t tag, int64_t timeout_ns
|-
| 0x1D || void || [[#SignalProcessWideKey|SignalProcessWideKey]] || uintptr_t cv_key, int32_t count
|-
| 0x1E || int64_t || [[#GetSystemTick|GetSystemTick]] ||
|-
| 0x1F || Result || [[#ConnectToNamedPort|ConnectToNamedPort]] || Handle *out_handle, const char *name
|-
| 0x20 || Result || [[#SendSyncRequestLight|SendSyncRequestLight]] || Handle session_handle
|-
| 0x21 || Result || [[#SendSyncRequest|SendSyncRequest]] || Handle session_handle
|-
| 0x22 || Result || [[#SendSyncRequestWithUserBuffer|SendSyncRequestWithUserBuffer]] || uintptr_t message_buffer, size_t message_buffer_size, Handle session_handle
|-
| 0x23 || Result || [[#SendAsyncRequestWithUserBuffer|SendAsyncRequestWithUserBuffer]] || Handle *out_event_handle, uintptr_t message_buffer, size_t message_buffer_size, Handle session_handle
|-
| 0x24 || Result || [[#GetProcessId|GetProcessId]] || uint64_t *out_process_id, Handle process_handle
|-
| 0x25 || Result || [[#GetThreadId|GetThreadId]] || uint64_t *out_thread_id, Handle thread_handle
|-
| 0x26 || void || [[#Break|Break]] || BreakReason break_reason, uintptr_t arg, size_t size
|-
| 0x27 || Result || [[#OutputDebugString|OutputDebugString]] || const char *debug_str, size_t len
|-
| 0x28 || void || [[#ReturnFromException|ReturnFromException]] || Result result
|-
| 0x29 || Result || [[#GetInfo|GetInfo]] || uint64_t *out, InfoType info_type, Handle handle, uint64_t info_subtype
|-
| 0x2A || void || [[#FlushEntireDataCache|FlushEntireDataCache]] ||
|-
| 0x2B || Result || [[#FlushDataCache|FlushDataCache]] || uintptr_t address, size_t size
|-
| [3.0.0+] 0x2C || Result || [[#MapPhysicalMemory|MapPhysicalMemory]] || uintptr_t address, size_t size
|-
| [3.0.0+] 0x2D || Result || [[#UnmapPhysicalMemory|UnmapPhysicalMemory]] || uintptr_t address, size_t size
|-
| [5.0.0-5.1.0] 0x2E || Result || GetFutureThreadInfo || arch::LastThreadContext *out_context, uintptr_t *out_tls_address, uint32_t *out_flags, int64_t ns
|-
| [6.0.0+] 0x2E || Result || [[#GetDebugFutureThreadInfo|GetDebugFutureThreadInfo]] || arch::LastThreadContext *out_context, uint64_t *thread_id, Handle debug_handle, int64_t ns
|-
| 0x2F || Result || [[#GetLastThreadInfo|GetLastThreadInfo]] || arch::LastThreadContext *out_context, uintptr_t *out_tls_address, uint32_t *out_flags
|-
| 0x30 || Result || [[#GetResourceLimitLimitValue|GetResourceLimitLimitValue]] || int64_t *out_limit_value, Handle resource_limit_handle, LimitableResource which
|-
| 0x31 || Result || [[#GetResourceLimitCurrentValue|GetResourceLimitCurrentValue]] || int64_t *out_current_value, Handle resource_limit_handle, LimitableResource which
|-
| 0x32 || Result || [[#SetThreadActivity|SetThreadActivity]] || Handle thread_handle, ThreadActivity thread_activity
|-
| 0x33 || Result || [[#GetThreadContext3|GetThreadContext3]] || ThreadContext *out_context, Handle thread_handle
|-
| [4.0.0+] 0x34 || Result || [[#WaitForAddress|WaitForAddress]] || uintptr_t address, ArbitrationType arb_type, int32_t value, int64_t timeout_ns
|-
| [4.0.0+] 0x35 || Result || [[#SignalToAddress|SignalToAddress]] || uintptr_t address, SignalType signal_type, int32_t value, int32_t count
|-
| [8.0.0+] 0x36 || void || [[#SynchronizePreemptionState|SynchronizePreemptionState]] ||
|-
| [11.0.0+] 0x37 || Result || [[#GetResourceLimitPeakValue|GetResourceLimitPeakValue]] || int64_t *out_peak_value, Handle resource_limit_handle, LimitableResource which
|- style="border-top: double"
| [13.0.0+] 0x39 || Result || CreateIoPool || Handle *out_handle, IoPoolType which_pool
|-
| [13.0.0+] 0x3A || Result || CreateIoRegion || Handle *out_handle, Handle io_pool, PhysicalAddress physical_address, size_t size, MemoryMapping mapping, MemoryPermission perm
|- style="border-top: double"
| [1.0.0-3.0.2] 0x3C || void || [[#DumpInfo|DumpInfo]] || DumpInfoType dump_info_type, uint64_t arg
|-
| [4.0.0+] 0x3C || void || [[#KernelDebug|KernelDebug]] || KernelDebugType kern_debug_type, uint64_t arg0, uint64_t arg1, uint64_t arg2
|-
| [4.0.0+] 0x3D || void || [[#ChangeKernelTraceState|ChangeKernelTraceState]] || KernelTraceState kern_trace_state
|- style="border-top: double"
| 0x40 || Result || [[#CreateSession|CreateSession]] || Handle *out_server_session_handle, Handle *out_client_session_handle, bool is_light, uintptr_t name
|-
| 0x41 || Result || [[#AcceptSession|AcceptSession]] || Handle *out_handle, Handle port
|-
| 0x42 || Result || [[#ReplyAndReceiveLight|ReplyAndReceiveLight]] || Handle handle
|-
| 0x43 || Result || [[#ReplyAndReceive|ReplyAndReceive]] || int32_t *out_index, const Handle *handles, int32_t num_handles, Handle reply_target, int64_t timeout_ns
|-
| 0x44 || Result || [[#ReplyAndReceiveWithUserBuffer|ReplyAndReceiveWithUserBuffer]] || int32_t *out_index, uintptr_t message_buffer, size_t message_buffer_size, const Handle *handles, int32_t num_handles, Handle reply_target, int64_t timeout_ns
|-
| 0x45 || Result || [[#CreateEvent|CreateEvent]] || Handle *out_write_handle, Handle *out_read_handle
|-
| [13.0.0+] 0x46 || Result || MapIoRegion || Handle io_region, uintptr_t address, size_t size, MemoryPermission perm
|-
| [13.0.0+] 0x47 || Result || UnmapIoRegion || Handle io_region, uintptr_t address, size_t size
|-
| [5.0.0+] 0x48 || Result || [[#MapPhysicalMemoryUnsafe|MapPhysicalMemoryUnsafe]] || uintptr_t address, size_t size
|-
| [5.0.0+] 0x49 || Result || [[#UnmapPhysicalMemoryUnsafe|UnmapPhysicalMemoryUnsafe]] || uintptr_t address, size_t size
|-
| [5.0.0+] 0x4A || Result || [[#SetUnsafeLimit|SetUnsafeLimit]] || size_t limit
|-
| [4.0.0+] 0x4B || Result || [[#CreateCodeMemory|CreateCodeMemory]] || Handle *out_handle, uintptr_t address, size_t size
|-
| [4.0.0+] 0x4C || Result || [[#ControlCodeMemory|ControlCodeMemory]] || Handle code_memory_handle, CodeMemoryOperation operation, uint64_t address, uint64_t size, MemoryPermission perm
|-
| 0x4D || void || [[#SleepSystem|SleepSystem]] ||
|-
| 0x4E || Result || [[#ReadWriteRegister|ReadWriteRegister]] || uint32_t *out_value, PhysicalAddress address, uint32_t mask, uint32_t value
|-
| 0x4F || Result || [[#SetProcessActivity|SetProcessActivity]] || Handle process_handle, ProcessActivity process_activity
|-
| 0x50 || Result || [[#CreateSharedMemory|CreateSharedMemory]] || Handle *out_handle, size_t size, MemoryPermission owner_perm, MemoryPermission remote_perm
|-
| 0x51 || Result || [[#MapTransferMemory|MapTransferMemory]] || Handle trmem_handle, uintptr_t address, size_t size, MemoryPermission owner_perm
|-
| 0x52 || Result || [[#UnmapTransferMemory|UnmapTransferMemory]] || Handle trmem_handle, uintptr_t address, size_t size
|-
| 0x53 || Result || [[#CreateInterruptEvent|CreateInterruptEvent]] || Handle *out_read_handle, int32_t interrupt_id, InterruptType interrupt_type
|-
| 0x54 || Result || [[#QueryPhysicalAddress|QueryPhysicalAddress]] || arch::PhysicalMemoryInfo *out_info, uintptr_t address
|-
| 0x55 || Result || [[#QueryIoMapping|QueryIoMapping]] || uintptr_t *out_address, [10.0.0+] size_t *out_size, PhysicalAddress physical_address, size_t size
|-
| 0x56 || Result || [[#CreateDeviceAddressSpace|CreateDeviceAddressSpace]] || Handle *out_handle, uint64_t das_address, uint64_t das_size
|-
| 0x57 || Result || [[#AttachDeviceAddressSpace|AttachDeviceAddressSpace]] || DeviceName device_name, Handle das_handle
|-
| 0x58 || Result || [[#DetachDeviceAddressSpace|DetachDeviceAddressSpace]] || DeviceName device_name, Handle das_handle
|-
| 0x59 || Result || [[#MapDeviceAddressSpaceByForce|MapDeviceAddressSpaceByForce]] || Handle das_handle, Handle process_handle, uint64_t process_address, size_t size, uint64_t device_address, uint32_t option
|-
| 0x5A || Result || [[#MapDeviceAddressSpaceAligned|MapDeviceAddressSpaceAligned]] || Handle das_handle, Handle process_handle, uint64_t process_address, size_t size, uint64_t device_address, uint32_t option
|-
| [1.0.0-12.1.0] 0x5B || Result || [[#MapDeviceAddressSpace|MapDeviceAddressSpace]] || size_t *out_mapped_size, Handle das_handle, Handle process_handle, uint64_t process_address, size_t size, uint64_t device_address, MemoryPermission device_perm
|-
| 0x5C || Result || [[#UnmapDeviceAddressSpace|UnmapDeviceAddressSpace]] || Handle das_handle, Handle process_handle, uint64_t process_address, size_t size, uint64_t device_address
|-
| 0x5D || Result || [[#InvalidateProcessDataCache|InvalidateProcessDataCache]] || Handle process_handle, uint64_t address, uint64_t size
|-
| 0x5E || Result || [[#StoreProcessDataCache|StoreProcessDataCache]] || Handle process_handle, uint64_t address, uint64_t size
|-
| 0x5F || Result || [[#FlushProcessDataCache|FlushProcessDataCache]] || Handle process_handle, uint64_t address, uint64_t size
|-
| 0x60 || Result || [[#DebugActiveProcess|DebugActiveProcess]] || Handle *out_handle, uint64_t process_id
|-
| 0x61 || Result || [[#BreakDebugProcess|BreakDebugProcess]] || Handle debug_handle
|-
| 0x62 || Result || [[#TerminateDebugProcess|TerminateDebugProcess]] || Handle debug_handle
|-
| 0x63 || Result || [[#GetDebugEvent|GetDebugEvent]] || arch::DebugEventInfo *out_info, Handle debug_handle
|-
| 0x64 || Result || [[#ContinueDebugEvent|ContinueDebugEvent]] || Handle debug_handle, uint32_t flags, const uint64_t *thread_ids, int32_t num_thread_ids
|-
| 0x65 || Result || [[#GetProcessList|GetProcessList]] || int32_t *out_num_processes, uint64_t *out_process_ids, int32_t max_out_count
|-
| 0x66 || Result || [[#GetThreadList|GetThreadList]] || int32_t *out_num_threads, uint64_t *out_thread_ids, int32_t max_out_count, Handle debug_handle
|-
| 0x67 || Result || [[#GetDebugThreadContext|GetDebugThreadContext]] || ThreadContext *out_context, Handle debug_handle, uint64_t thread_id, uint32_t context_flags
|-
| 0x68 || Result || [[#SetDebugThreadContext|SetDebugThreadContext]] || Handle debug_handle, uint64_t thread_id, const ThreadContext *context, uint32_t context_flags
|-
| 0x69 || Result || [[#QueryDebugProcessMemory|QueryDebugProcessMemory]] || arch::MemoryInfo *out_memory_info, PageInfo *out_page_info, Handle process_handle, uintptr_t address
|-
| 0x6A || Result || [[#ReadDebugProcessMemory|ReadDebugProcessMemory]] || uintptr_t buffer, Handle debug_handle, uintptr_t address, size_t size
|-
| 0x6B || Result || [[#WriteDebugProcessMemory|WriteDebugProcessMemory]] || Handle debug_handle, uintptr_t buffer, uintptr_t address, size_t size
|-
| 0x6C || Result || [[#SetHardwareBreakPoint|SetHardwareBreakPoint]] || HardwareBreakPointRegisterName name, uint64_t flags, uint64_t value
|-
| 0x6D || Result || [[#GetDebugThreadParam|GetDebugThreadParam]] || uint64_t *out_64, uint32_t *out_32, Handle debug_handle, uint64_t thread_id, DebugThreadParam param
|- style="border-top: double"
| [5.0.0+] 0x6F || Result || [[#GetSystemInfo|GetSystemInfo]] || uint64_t *out, SystemInfoType info_type, Handle handle, uint64_t info_subtype
|-
| 0x70 || Result || [[#CreatePort|CreatePort]] || Handle *out_server_handle, Handle *out_client_handle, int32_t max_sessions, bool is_light, uintptr_t name
|-
| 0x71 || Result || [[#ManageNamedPort|ManageNamedPort]] || Handle *out_server_handle, const char *name, int32_t max_sessions
|-
| 0x72 || Result || [[#ConnectToPort|ConnectToPort]] || Handle *out_handle, Handle port
|-
| 0x73 || Result || [[#SetProcessMemoryPermission|SetProcessMemoryPermission]] || Handle process_handle, uint64_t address, uint64_t size, MemoryPermission perm
|-
| 0x74 || Result || [[#MapProcessMemory|MapProcessMemory]] || uintptr_t dst_address, Handle process_handle, uint64_t src_address, size_t size
|-
| 0x75 || Result || [[#UnmapProcessMemory|UnmapProcessMemory]] || uintptr_t dst_address, Handle process_handle, uint64_t src_address, size_t size
|-
| 0x76 || Result || [[#QueryProcessMemory|QueryProcessMemory]] || arch::MemoryInfo *out_memory_info, PageInfo *out_page_info, Handle process_handle, uint64_t address
|-
| 0x77 || Result || [[#MapProcessCodeMemory|MapProcessCodeMemory]] || Handle process_handle, uint64_t dst_address, uint64_t src_address, uint64_t size
|-
| 0x78 || Result || [[#UnmapProcessCodeMemory|UnmapProcessCodeMemory]] || Handle process_handle, uint64_t dst_address, uint64_t src_address, uint64_t size
|-
| 0x79 || Result || [[#CreateProcess|CreateProcess]] || Handle *out_handle, const arch::CreateProcessParameter *parameters, const uint32_t *caps, int32_t num_caps
|-
| 0x7A || Result || [[#StartProcess|StartProcess]] || Handle process_handle, int32_t priority, int32_t core_id, uint64_t main_thread_stack_size
|-
| 0x7B || Result || [[#TerminateProcess|TerminateProcess]] || Handle process_handle
|-
| 0x7C || Result || [[#GetProcessInfo|GetProcessInfo]] || int64_t *out_info, Handle process_handle, ProcessInfoType info_type
|-
| 0x7D || Result || [[#CreateResourceLimit|CreateResourceLimit]] || Handle *out_handle
|-
| 0x7E || Result || [[#SetResourceLimitLimitValue|SetResourceLimitLimitValue]] || Handle resource_limit_handle, LimitableResource which, int64_t limit_value
|-
| 0x7F || void || [[#CallSecureMonitor|CallSecureMonitor]] || SecureMonitorArguments *args
|- style="border-top: double"
| [15.0.0+] 0x90 || Result || MapInsecureMemory || uintptr_t address, size_t size
|-
| [15.0.0+] 0x91 || Result || UnmapInsecureMemory || uintptr_t address, size_t size
|-
|}

== SetHeapSize ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X1 || uint64_t || Size
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) X1 || void* || HeapAddress
|}
</div>

Sets the process heap to a given Size. It can both extend and shrink the heap.

Size must be a multiple of 0x200000 (2MB).

On success, the heap base-address (which is fixed by kernel, aslr'd, and always in the Heap memory region) is written to HeapAddress.

Uses current process pool partition. The memory allocated counts towards the caller's process Memory ResourceLimit.

[2.0.0+] Size must be less than or equal to 4GB.

=== Result codes ===
'''0x0:''' Success.

'''0xCA01:''' Invalid size passed. It's either bigger than 4GB, or misaligned.

'''0xD001:''' Size is bigger than the Heap Region size.

'''0xCE01:''' KMemoryBlockAllocator slab allocator exhausted.

'''0xD401:''' The memory region is in an invalid state. Likely because a mapping was made in the heap region.

'''0x10801:''' Memory resource limit reached.

== SetMemoryPermission ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || void* || Address
|-
| (In) X1 || uint64_t || Size
|-
| (In) W2 || [[#MemoryPermission]] || MemoryPermission
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

Changes permission of page-aligned memory region.

Bit2 of permission (exec) is not allowed. Setting write-only is not allowed either (bit1).

This can be used to move back and forth between ---, r-- and rw-.

=== Result codes ===
'''0x0:''' Success. The memory region was reprotected.

'''0xCC01:''' Unaligned address specified.

'''0xCA01:''' Unaligned or zero size specified.

'''0xD401:''' The provided memory region does not fall within the userland address space.

'''0xD801:''' Invalid permission specified. Valid permissions are ---, r-- and rw-.

'''0xD401:''' The provided memory region was in an invalid state. The region must have the [[#MemoryState|FlagCanReprotect]] state, and must not have the [[#MemoryAttribute|Locked]] or [[#MemoryAttribute|Uncached]] attributes.

'''0xCE01:''' Kernel resource exhausted.

== SetMemoryAttribute ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || void* || Address
|-
| (In) X1 || uint64_t || Size
|-
| (In) W2 || uint32_t || Mask
|-
| (In) W3 || uint32_t || Value
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

Changes attribute of page-aligned memory region. The only allowed combination of Value and Mask is 0x8, which means only bit3 in [[#MemoryAttribute]] can be set or cleared.

This is used to turn on/off caching for a given memory area. Useful when talking to devices such as the GPU.

What happens "under the hood" is the "Memory Attribute Indirection Register" index is changed from 2 to 3 in the MMU descriptor.

== MapMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || void* || DstAddress
|-
| (In) X1 || void* || SrcAddress
|-
| (In) X2 || uint64_t || Size
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

Maps a memory range into a different range.

Mainly used for adding guard pages around stack.

Source range gets reprotected to --- (it can no longer be accessed), and bit0 is set in the source [[#MemoryAttribute]].

[1.0.0] This could be used to map into either the Alias Region or the Stack region.

[2.0.0+] This can only be used to map into the Stack region.

Code can get the range of the Alias region from [[#GetInfo]] id0=2,3, and on 2.0.0+ the range of the Stack region via [[#GetInfo]] id0=14, 15 (on 1.0.0, the Stack region had hardcoded limits).

When mapped into the Alias region, the mapped memory will have state 0x482907.

When mapped into the Stack region, the mapped memory will have state 0x5C3C0B.

== UnmapMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || void* || DstAddress
|-
| (In) X1 || void* || SrcAddress
|-
| (In) X2 || uint64_t || Size
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

Unmaps a region that was previously mapped with [[#MapMemory]].

It's possible to unmap ranges partially, you don't need to unmap the entire range "in one go".

The srcaddr/dstaddr must match what was given when the pages were originally mapped.

== QueryMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || [[#MemoryInfo]]* || MemoryInfo
|-
| (In) X2 || void* || Address
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) W1 || [[#PageInfo]] || PageInfo
|}
</div>

Queries information about an address. Will always fetch the lowest page-aligned mapping that contains the provided address.

Outputs a [[#MemoryInfo]] struct.

== ExitProcess ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) None || ||
|-
| (Out) None || ||
|}
</div>

Exits the current process.

== CreateThread ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X1 || R1 || void(*)(void*) || Entry
|-
| (In) X2 || R2 || void* || ThreadContext
|-
| (In) X3 || R3 || void* || StackTop
|-
| (In) W4 || R0 || int32_t || Priority
|-
| (In) W5 || R4 || int32_t || ProcessorId
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) W1 || R1 || Handle<Thread> || ThreadHandle
|}
</div>

Creates a thread in the current process.

ProcessorId must be 0,1,2,3 or -2, where -2 uses the default CpuId for process.

== StartThread ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<Thread> || ThreadHandle
|-
| (Out) None || ||
|}
</div>

Starts the thread for the provided handle.

== ExitThread ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) None || ||
|-
| (Out) None || ||
|}
</div>

Exits the current thread.

== SleepThread ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X0 || R0, R1 || uint64_t || Nanoseconds
|}
</div>

Sleeps for a specified amount of time, or yields the thread.

Setting nanoseconds to 0, -1, or -2 indicates a yielding type.

<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Value || Type
|-
| 0 || Yielding without core migration
|-
| -1 || Yielding with core migration
|-
| -2 || Yielding to any other thread
|}
</div>

== GetThreadPriority ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W1|| Handle<Thread> || ThreadHandle
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) W1 || int32_t || Priority
|}
</div>

Gets the priority of provided thread handle.

== SetThreadPriority ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0|| Handle<Thread> || ThreadHandle
|-
| (In) W1|| int32_t || Priority
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

Sets the priority of provided thread handle.

Priority is a number 0-0x3F. Lower value means higher priority.

== GetThreadCoreMask ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W2 || R2 || Handle<Thread> || ThreadHandle
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) W1 || R1 || int32_t || CoreMask0
|-
| (Out) X2 || R2, R3 || uint64_t || CoreMask1
|}
</div>

Gets the affinity mask of provided thread handle.

== SetThreadCoreMask ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R0 || Handle<Thread> || ThreadHandle
|-
| (In) W1 || R1 || int32_t || CoreMask0
|-
| (In) X2 || R2, R3 || uint64_t || CoreMask1
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

Sets the affinity mask of provided thread handle.

== GetCurrentProcessorNumber ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) None || ||
|-
| (Out) W0 || uint32_t || CpuId
|}
</div>

Gets which cpu is executing the current thread.

CpuId is an integer in the range 0-3.

== SignalEvent ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<WritableEvent> || EventHandle
|-
| (Out) X0 || [[#Result]] || Result
|}
</div>

Puts the given event in the signaled state.

Will wake up any thread currently waiting on this event. Can potentially trigger a reschedule.

Any calls to [[#WaitSynchronization]] on this handle will return immediately, until the event's signaled state is reset.

=== Result codes ===
'''0x0:''' Success. Event is now in signaled state.

'''0xE401:''' Invalid handle. The handle either does not exist, or is not a WritableEvent.

== ClearEvent ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<WritableEvent> or Handle<ReadableEvent> || EventHandle
|-
| (Out) X0 || [[#Result]] || Result
|}
</div>

Takes the given event out of the signaled state, if it is signaled.

=== Result codes ===
'''0x0:''' Success, the event is now in the not-signaled state.

'''0xE401:''' Invalid handle. The handle either does not exist, or is not a ReadableEvent nor a WritableEvent.

== MapSharedMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<SharedMemory> || SharedMemoryHandle
|-
| (In) X1 || void* || Address
|-
| (In) X2 || uint64_t || Size
|-
| (In) W3 || [[#MemoryPermission]] || MemoryPermission
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

Maps the block supplied by the handle. The required permissions are different for the process that created the handle and all other processes.

Increases reference count for the KSharedMemory object. Thus in order to release the memory associated with the object, all handles to it must be closed and all mappings must be unmapped.

== UnmapSharedMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<SharedMemory> || SharedMemoryHandle
|-
| (In) X1 || void* || Address
|-
| (In) X2 || uint64_t || Size
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== CreateTransferMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X1 || void* || Address
|-
| (In) X2 || uint64_t || Size
|-
| (In) W3 || [[#MemoryPermission]] || MemoryPermission
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) W1 || Handle<TransferMemory> || TransferMemoryHandle
|}
</div>

This one reprotects the src block with perms you give it. It also sets bit0 into [[#MemoryAttribute]].

Executable bit perm not allowed.

Closing all handles automatically causes the bit0 in [[#MemoryAttribute]] to clear, and the permission to reset.

== CloseHandle ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle || Handle
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== ResetSignal ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<ReadableEvent> or Handle<Process> || Handle
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

Resets the signal on the given handle, ensuring future calls to [[#WaitSynchronization]] on this handle will sleep until the handle is signaled again. If the handle is a ReadableEvent, this returns ResultInvalidState if the event is not signaled.

If the handle is a Process, it will clear the signaled state (which is set when the process changes [[#ProcessState]]. Once the process enters the Exited state, calling ResetSignal on the process will no longer have an effect (the process is permanently signaled), and the syscall will return 0xFA01.

=== Result codes ===
'''0x0:''' Success. The signal was reset.

'''0xE401:''' The handle is invalid or of the wrong type.

'''0xFA01:''' The handle was not signaled, or the process is in exited state, causing it to be permanently signaled.

== WaitSynchronization ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X1 || R1 || Handle* || HandlesPtr
|-
| (In) W2 || R2 || int32_t || HandlesNum
|-
| (In) X3 || R0, R3 || int64_t || Timeout
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) W1 || R1 || uint64_t || HandleIndex
|}
</div>

Works with HandlesNum <= 0x40.

When zero handles are passed, this will wait forever until either timeout or cancellation occurs.

Does not accept 0xFFFF8001 or 0xFFFF8000 as handles.

=== Object types ===
'''KDebug:''' signals when there is a new [[#DebugEventInfo|DebugEvent]] (retrievable via [[#GetDebugEvent]]).

'''KClientPort:''' signals when the number of sessions is less than the maximum allowed.

'''KProcess:''' signals when the process undergoes a state change (retrievable via [[#GetProcessInfo]]).

'''KReadableEvent:''' signals when the event's corresponding KWritableEvent has been signaled via [[#SignalEvent]].

'''KServerPort:''' signals when there is an incoming connection waiting to be [[#AcceptSession|accepted]].

'''KServerSession:''' signals when there is an incoming message waiting to be [[#ReplyAndReceive|received]] or the pipe is closed.

'''KThread:''' signals when the thread has exited.

=== Result codes ===
'''0x0:''' Success. One of the objects was signaled before the timeout expired, or one of the objects is a Session with a closed remote. Handle index is updated to indicate which object signaled.

'''0x7601:''' Thread termination requested. Handle index is not updated.

'''0xe401:''' Invalid handle. Returned when one of the handles passed is invalid. Handle index is not updated.

'''0xe601:''' Invalid address. Returned when the handles pointer is not a readable address. Handle index is not updated.

'''0xea01:''' Timeout. Returned when no objects have been signaled within the timeout. Handle index is not updated.

'''0xec01:''' Interrupted. Returned when another thread uses [[#CancelSynchronization]] to cancel this thread. Handle index is not updated.

'''0xee01:''' Too many handles. Returned when the number of handles passed is > 0x40.

== CancelSynchronization ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<Thread> || ThreadHandle
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

If the referenced thread is currently in a synchronization call ([[#WaitSynchronization]], [[#ReplyAndReceive]] or [[#ReplyAndReceiveLight]]), that call will be interrupted and return 0xec01.
If that thread is not currently executing such a synchronization call, the next call to a synchronization call will return 0xec01.

This doesn't take force-pause (activity/debug pause) into account.

=== Result codes ===
'''0x0:''' Success. The thread was either interrupted or has had its flag set.

'''0xe401:''' Invalid handle. The handle given was either invalid or not a thread handle.

== ArbitrateLock ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<Thread> || ThreadHandle
|-
| (In) X1 || void* || Address
|-
| (In) W2 || uint32_t || Tag
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== ArbitrateUnlock ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || void* || Address
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== WaitProcessWideKeyAtomic ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X0 || R0 || void* || KeyAddress
|-
| (In) X1 || R1 || void* || TagAddress
|-
| (In) W2 || R2 || uint32_t || Tag
|-
| (In) X3 || R3, R4 || int64_t || Timeout
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

== SignalProcessWideKey ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || void* || Address
|-
| (In) W1 || int32_t || Value
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== GetSystemTick ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (Out) X0 || R0, R1 || uint64_t || Ticks
|}
</div>

Returns the value of cntpct_el0.

The frequency is 19200000 Hz (constant from official sw).

Official sw reads cntpct_el0 directly from usermode without using this SVC. [[ExeFS|sdk-nso]] has this SVC, but it's not known to be called anywhere.

== ConnectToNamedPort ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X1 || char* || PortName
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) W1 || Handle<Session> || SessionHandle
|}
</div>

== SendSyncRequestLight ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<Session> || SessionHandle
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== SendSyncRequest ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<Session> || SessionHandle
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== SendSyncRequestWithUserBuffer ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || void* || Address
|-
| (In) X1 || uint64_t || Size
|-
| (In) W2 || Handle<Session> || SessionHandle
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

Size and Address must be 0x1000-aligned.

=== Result codes ===
'''0x0:''' Success.

'''0xcc01:''' Address is not 0x1000-aligned.

'''0xca01:''' Size is not 0x1000-aligned.

'''0xce01:''' KSessionRequest allocation failed (unlikely) or pointer buffer size exceeded.

'''0xe401:''' Handles does not exist, or handle is not an instance of KClientSession.

== SendAsyncRequestWithUserBuffer ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X1 || void* || Address
|-
| (In) X2 || uint64_t || Size
|-
| (In) W3 || Handle<Session> || SessionHandle
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) W1 || Handle<ReadableEvent> || EventHandle
|}
</div>

Size and Address must be 0x1000-aligned.

== GetProcessId ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W1 || R1 || Handle<Process> || ProcessHandle
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) X1 || R1, R2 || uint64_t || ProcessId
|}
</div>

== GetThreadId ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W1 || R1 || Handle<Thread> || ThreadHandle
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) X1 || R1, R2 || uint64_t || ThreadId
|}
</div>

== Break ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || [[#BreakReason]] || BreakReason
|-
| (In) X1 || uint64_t ||
|-
| (In) X2 || uint64_t || Info
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

If the process is attached, report the Break event. Then, if [[#ContinueDebugEvent]] didn't apply IgnoreException on the thread: if TPIDR_EL0 is 0, adjust ELR_EL1 to retry to svc instruction (and set TPIDR_EL0 to 1).

Otherwise, if bit31 in reason isn't set, perform crash reporting (see Exception Handling section below), if it doesn't terminate the process adjust ELR_EL1 as well.

Otherwise just return 0.

== OutputDebugString ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || char* || String
|-
| (In) X1 || uint64_t || Size
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== ReturnFromException ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || [[#Result]] || Result
|}
</div>

== GetInfo ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W1 || R1 || [[#InfoType]] || InfoType
|-
| (In) W2 || R2 || Handle || Handle
|-
| (In) X3 || R0, R3 || uint64_t || InfoSubType
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) X1 || R1, R2 || uint64_t || Info
|}
</div>

== FlushEntireDataCache ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) None || ||
|-
| (Out) None || ||
|}
</div>

== FlushDataCache ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || void* || Address
|-
| (In) X1 || uint64_t || Size
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== MapPhysicalMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || void* || Address
|-
| (In) X1 || uint64_t || Size
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

Acts like [[#SetHeapSize]] except you can allocate heap at any address you'd like.

Uses current process pool partition.

=== Result codes ===
'''0x0:''' Success.

'''0xCA01:''' Invalid size passed. It's either zero or not 4k-aligned

'''0xCC01:''' Invalid address. (not 4k-aligned)

'''0xDC01:''' Invalid memory range. It's either causes overflow, or does not fall into "reserved" address range (aka Alias). See AliasRegionAddress at [[#InfoType]]

'''0xFA01:''' Invalid state. (not enough SystemResource (see [[NPDM#SystemResourceSize]]))

== UnmapPhysicalMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || void* || Address
|-
| (In) X1 || uint64_t || Size
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== GetDebugFutureThreadInfo ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X3 || R0, R1 || uint64_t || Timeout
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) X1 || uint64_t || LastThreadContextParam0
|-
| (Out) X2 || uint64_t || LastThreadContextParam1
|-
| (Out) X3 || uint64_t || LastThreadContextParam2
|-
| (Out) X4 || uint64_t || LastThreadContextParam3
|-
| (Out) X5 || uint64_t ||
|-
| (Out) W6 || uint32_t ||
|}
</div>

== GetLastThreadInfo ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) None || ||
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) X1 || uint64_t || LastThreadContextParam0
|-
| (Out) X2 || uint64_t || LastThreadContextParam1
|-
| (Out) X3 || uint64_t || LastThreadContextParam2
|-
| (Out) X4 || uint64_t || LastThreadContextParam3
|-
| (Out) X5 || uint64_t ||
|-
| (Out) W6 || uint32_t ||
|}
</div>

== GetResourceLimitLimitValue ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W1 || R1 || Handle<ResourceLimit> || ResourceLimitHandle
|-
| (In) W2 || R2 || [[#LimitableResource]] || LimitableResource
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) X1 || R1, R2 || int64_t || LimitValue
|}
</div>

== GetResourceLimitCurrentValue ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W1 || R1 || Handle<ResourceLimit> || ResourceLimitHandle
|-
| (In) W2 || R2 || [[#LimitableResource]] || LimitableResource
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) X1 || R1, R2 || int64_t || CurrentValue
|}
</div>

== SetThreadActivity ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<Thread> || ThreadHandle
|-
| (In) W1 || [[#ThreadActivity]] || ThreadActivity
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== GetThreadContext3 ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || [[#ThreadContext]]* || ThreadContext
|-
| (In) W1 || Handle<Thread> || ThreadHandle
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== WaitForAddress ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X0 || R0 || void* || Address
|-
| (In) W1 || R1 || [[#ArbitrationType]] || ArbitrationType
|-
| (In) W2 || R2 || uint32_t || Value
|-
| (In) X3 || R3, R4 || uint64_t || Timeout
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

== SignalToAddress ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X0 || R0 || void* || Address
|-
| (In) W1 || R1 || [[#SignalType]] || SignalType
|-
| (In) W2 || R2 || uint32_t || Value
|-
| (In) W3 || R3 || uint32_t || NumToSignal
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

== SynchronizePreemptionState ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) None || ||
|-
| (Out) None || ||
|}
</div>

== GetResourceLimitPeakValue ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W1 || R1 || Handle<ResourceLimit> || ResourceLimitHandle
|-
| (In) W2 || R2 || [[#LimitableResource]] || LimitableResource
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) X1 || R1, R2 || int64_t || PeakValue
|}
</div>

== DumpInfo ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || [[#DumpInfoType]] || DumpInfoType
|-
| (In) X1 || uint64_t || DumpInfoSubType
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

Stubbed in retail kernel.

[4.0.0+] This function was removed and replaced by [[#KernelDebug]].

== KernelDebug ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || [[#KernelDebugType]] || KernelDebugType
|-
| (In) X1 || uint64_t ||
|-
| (In) X2 || uint64_t ||
|-
| (In) X3 || uint64_t ||
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

Stubbed in retail kernel.

== ChangeKernelTraceState ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || [[#KernelTraceState]] || KernelTraceState
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

Stubbed in retail kernel.

== CreateSession ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W2 || bool || IsLight
|-
| (In) X3 || uint64_t || Name
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) W1 || Handle<ServerSession> || ServerSessionHandle
|-
| (Out) W2 || Handle<ClientSession> || ClientSessionHandle
|}
</div>

== AcceptSession ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W1 || Handle<Port> || PortHandle
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) W1 || Handle<ServerSession> || ServerSessionHandle
|}
</div>

=== Result codes ===
'''0xf201:''' No session waiting to be accepted

== ReplyAndReceiveLight ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<Port> or Handle<ServerSession> || Handle
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== ReplyAndReceive ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X1 || R1 || Handle<Port>* or Handle<ServerSession>* || Handles
|-
| (In) W2 || R2 || uint32_t || NumHandles
|-
| (In) W3 || R3 || Handle<ServerSession> || ReplyTargetSessionHandle
|-
| (In) X4 || R0, R4 || uint64_t || Timeout
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) W1 || R1 || uint32_t || HandleIndex
|}
</div>

If ReplyTargetSessionHandle is not zero, a reply from the TLS will be sent to that session.
Then it will wait until either of the passed sessions has an incoming message, is closed, a passed port has an incoming connection, or the timeout expires.
If there is an incoming message, it is copied to the TLS.

If ReplyTargetSessionHandle is zero, the TLS should contain a blank message. If this message has a C descriptor, the buffer it points to will be used as the pointer buffer. See [[IPC_Marshalling#IPC_buffers]]. Note that a pointer buffer cannot be specified if ReplyTargetSessionHandle is not zero.

After being validated, passed handles will be enumerated in order; even if a session has been closed, if one that appears earlier in the list has an incoming message, it will take priority and a result code of 0x0 will be returned.

=== Result codes ===
'''0x0:''' Success. Either a session has an incoming message or a port has an incoming connection. HandleIndex is set appropriately.

'''0xea01:''' Timeout. No handles were signalled before the timeout expired. HandleIndex is not updated.

'''0xf601:''' Port remote dead. One of the sessions has been closed. HandleIndex is set appropriately.

== ReplyAndReceiveWithUserBuffer ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X1 || R1 || void* || Address
|-
| (In) X2 || R2 || uint64_t || Size
|-
| (In) X3 || R3 || Handle<Port>* or Handle<ServerSession>* || Handles
|-
| (In) W4 || R0 || uint32_t || NumHandles
|-
| (In) W5 || R4 || Handle<ServerSession> || ReplyTargetSessionHandle
|-
| (In) X6 || R5, R6 || uint64_t || Timeout
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) W1 || R1 || uint32_t || HandleIndex
|}
</div>

== CreateEvent ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) None || ||
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) W1 || Handle<WritableEvent> || WritableEventHandle
|-
| (Out) W2 || Handle<ReadableEvent> || ReadableEventHandle
|}
</div>

== MapPhysicalMemoryUnsafe ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || void* || Address
|-
| (In) X1 || uint64_t || Size
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

Same as [[#MapPhysicalMemory]] except it always uses pool partition 0.

== UnmapPhysicalMemoryUnsafe ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || void* || Address
|-
| (In) X1 || uint64_t || Size
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== SetUnsafeLimit ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || uint64_t || Limit
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== CreateCodeMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X1 || void* || Address
|-
| (In) X2 || uint64_t || Size
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) W1 || Handle<CodeMemory> || CodeMemoryHandle
|}
</div>

Takes an address range with backing memory to create the code memory object.

The memory is initially memset to 0xFF after being locked.

== ControlCodeMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R0 || Handle<CodeMemory> || CodeMemoryHandle
|-
| (In) W1 || R1 || [[#CodeMemoryOperation]] || CodeMemoryOperation
|-
| (In) X2 || R2, R3 || void* || Address
|-
| (In) X3 || R4, R5 || uint64_t || Size
|-
| (In) W4 || R6 || [[#MemoryPermission]] || MemoryPermission
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

Maps the backing memory for a CodeMemory object into the current process.

For [[#CodeMemoryOperation|MapOwner]], memory permission must be RW-.

For [[#CodeMemoryOperation|MapSlave]], memory permission must be R-- or R-X.

Operations [[#CodeMemoryOperation|UnmapOwner/UnmapSlave]] unmap memory that was previously mapped this way.

This allows one "secure JIT" process to map the code memory as RW-, and the other "slave" process to map it R-X.

[5.0.0+] Error 0xE401 is now returned when the process owner of the Code memory object is the same as the current process.

== SleepSystem ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) None || ||
|-
| (Out) None || ||
|}
</div>

== ReadWriteRegister ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X1 || R2, R3 || uint64_t || RegisterAddress
|-
| (In) W2 || R0 || uint32_t || RwMask
|-
| (In) W3 || R1 || uint32_t || InValue
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) W1 || R1 || uint32_t || OutValue
|}
</div>

Read/write IO registers with a hardcoded whitelist. Input address is physical-address and must be aligned to 4.

rw_mask is 0 for reading and 0xffffffff for writing. You can also write individual bits by using a mask value.

You can only write to registers inside physical pages 0x70019000 (MC), 0x7001C000 (MC0), 0x7001D000 (MC1), and they all share the same whitelist.

The whitelist is same for writing as for reading.

The whitelist is:

0x054, 0x090, 0x094, 0x098, 0x09c, 0x0a0, 0x0a4, 0x0a8, 0x0ac, 0x0b0, 0x0b4, 0x0b8, 0x0bc, 0x0c0, 0x0c4, 0x0c8, 0x0d0, 0x0d4, 0x0d8, 0x0dc, 0x0e0, 0x100, 0x108, 0x10c, 0x118, 0x11c, 0x124, 0x128, 0x12c, 0x130, 0x134, 0x138, 0x13c, 0x158, 0x15c, 0x164, 0x168, 0x16c, 0x170, 0x174, 0x178, 0x17c, 0x200, 0x204, 0x2e4, 0x2e8, 0x2ec, 0x2f4, 0x2f8, 0x310, 0x314, 0x320, 0x328, 0x344, 0x348, 0x370, 0x374, 0x37c, 0x380, 0x390, 0x394, 0x398, 0x3ac, 0x3b8, 0x3bc, 0x3c0, 0x3c4, 0x3d8, 0x3e8, 0x41c, 0x420, 0x424, 0x428, 0x42c, 0x430, 0x44c, 0x47c, 0x480, 0x484, 0x50c, 0x554, 0x558, 0x55c, 0x670, 0x674, 0x690, 0x694, 0x698, 0x69c, 0x6a0, 0x6a4, 0x6c0, 0x6c4, 0x6f0, 0x6f4, 0x960, 0x970, 0x974, 0xa20, 0xa24, 0xb88, 0xb8c, 0xbc4, 0xbc8, 0xbcc, 0xbd0, 0xbd4, 0xbd8, 0xbdc, 0xbe0, 0xbe4, 0xbe8, 0xbec, 0xc00, 0xc5c, 0xcac

[2.0.0+] Whitelist was extended with 0x4c4, 0x4c8, 0x4cc, 0x584, 0x588, 0x58c.

[2.0.0+] The IO registers in range 0x7000E400 (PMC) size 0xC00 skip the whitelist, and do a TrustZone call using [[SMC#ReadWriteRegister|ReadWriteRegister]].

[4.0.0+] Access to the Memory Controller (0x70019000) also uses smcReadWriteRegister.

Here is the whitelist imposed by that SMC, relative to the start of the PMC registers:

0x000, 0x00c, 0x010, 0x014, 0x01c, 0x020, 0x02c, 0x030, 0x034, 0x038, 0x03c, 0x040, 0x044, 0x048, 0x0dc, 0x0e0, 0x0e4, 0x160, 0x164, 0x168, 0x170, 0x1a8, 0x1b8, 0x1bc, 0x1c0, 0x1c4, 0x1c8, 0x2b4, 0x2d4, 0x440, 0x4d8

Here is the whitelist imposed by the SMC [[SMC#ReadWriteRegister|ReadWriteRegister]] (checked in addition to the whitelist in the ReadWriteRegister SVC), relative to the start of the MC registers:

0x000, 0x004, 0x008, 0x00C, 0x010, 0x01C, 0x020, 0x030, 0x034, 0x050, 0x054, 0x090, 0x094, 0x098, 0x09C, 0x0A0, 0x0A4, 0x0A8, 0x0AC, 0x0B0, 0x0B4, 0x0B8, 0x0BC, 0x0C0, 0x0C4, 0x0C8, 0x0D0, 0x0D4, 0x0D8, 0x0DC, 0x0E0, 0x100, 0x108, 0x10C, 0x118, 0x11C, 0x124, 0x128, 0x12C, 0x130, 0x134, 0x138, 0x13C, 0x158, 0x15C, 0x164, 0x168, 0x16C, 0x170, 0x174, 0x178, 0x17C, 0x200, 0x204, 0x238, 0x240, 0x244, 0x250, 0x254, 0x258, 0x264, 0x268, 0x26C, 0x270, 0x274, 0x280, 0x284, 0x288, 0x28C, 0x294, 0x2E4, 0x2E8, 0x2EC, 0x2F4, 0x2F8, 0x310, 0x314, 0x320, 0x328, 0x344, 0x348, 0x370, 0x374, 0x37C, 0x380, 0x390, 0x394, 0x398, 0x3AC, 0x3B8, 0x3BC, 0x3C0, 0x3C4, 0x3D8, 0x3E8, 0x41C, 0x420, 0x424, 0x428, 0x42C, 0x430, 0x44C, 0x47C, 0x480, 0x484, 0x4C4, 0x4C8, 0x4CC, 0x50C, 0x554, 0x558, 0x55C, 0x584, 0x588, 0x58C, 0x670, 0x674, 0x690, 0x694, 0x698, 0x69C, 0x6A0, 0x6A4, 0x6C0, 0x6C4, 0x6F0, 0x6F4, 0x960, 0x970, 0x974, 0x9B8, 0xA20, 0xA24, 0xA88, 0xA94, 0xA98, 0xA9C, 0xAA0, 0xAA4, 0xAA8, 0xAAC, 0xAB0, 0xAB4, 0xAB8, 0xABC, 0xAC0, 0xAC4, 0xAC8, 0xACC, 0xAD0, 0xAD4, 0xAD8, 0xADC, 0xAE0, 0xB88, 0xB8C, 0xBC4, 0xBC8, 0xBCC, 0xBD0, 0xBD4, 0xBD8, 0xBDC, 0xBE0, 0xBE4, 0xBE8, 0xBEC, 0xC00, 0xC5C, 0xCAC

== SetProcessActivity ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<Process> || ProcessHandle
|-
| (In) W1 || [[#ProcessActivity]] || ProcessActivity
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== CreateSharedMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W1 || uint64_t || Size
|-
| (In) W2 || [[#MemoryPermission]] || LocalMemoryPermission
|-
| (In) W3 || [[#MemoryPermission]] || RemoteMemoryPermission
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) W1 || Handle<SharedMemory> || SharedMemoryHandle
|}
</div>

Other perm can be used to enforce permission 1, 3, or 0x10000000 if don't care.

Allocates memory from the current process' pool partition.

== MapTransferMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || Handle<TransferMemory> || TransferMemoryHandle
|-
| (In) X1 || void* || Address
|-
| (In) X2 || uint64_t || Size
|-
| (In) W3 || [[#MemoryPermission]] || MemoryPermission
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

You must pass same size and permissions as given in [[#CreateTransferMemory]], otherwise error.

== UnmapTransferMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || Handle<TransferMemory> || TransferMemoryHandle
|-
| (In) X1 || void* || Address
|-
| (In) X2 || uint64_t || Size
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

Size must match size given in map syscall, otherwise there's an invalid-size error.

== CreateInterruptEvent ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X1 || [[#Interrupt]] || Interrupt
|-
| (In) W2 || [[#InterruptType]] || InterruptType
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) W1 || Handle<ReadableEvent> || ReadableEventHandle
|}
</div>

Creates an event handle for the given IRQ number. Waiting on this handle will wait until the IRQ is triggered. The InterruptType argument configures the triggering. If it is 0, the IRQ is active HIGH level sensitive, if it is 1 it is rising-edge sensitive.

=== Result codes ===
'''0x0:''' Success.

'''0xF001:''' Flags was > 1

'''0xF201:''' IRQ above 0x3FF or outside the [[NPDM#Kernel_Access_Control|IRQ access mask]] was given.

'''0xCE01:''' A SlabHeap was exhausted (too many interrupts created).

'''0xF401:''' IRQ already has an event registered.

'''0xD201:''' The handle table is full. Try closing some handles.

== QueryPhysicalAddress ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X1 || void* || VirtualAddress
|-
| (Out) W0 || [[#Result]]|| Result
|-
| (Out) X1 || uint64_t || PhysicalMemoryInfoAddress
|-
| (Out) X2 || uint64_t || PhysicalMemoryInfoBaseAddress
|-
| (Out) X3 || uint64_t || PhysicalMemoryInfoSize
|}
</div>

Queries the physical address of a virtual address. Will always fetch the lowest page-aligned mapping that contains the provided physical address.

The returned PhysicalMemoryInfoBaseAddress is the virtual address of that page-aligned mapping, while PhysicalMemoryInfoAddress is the physical address of that page. PhysicalMemoryInfoSize is the amount of continuous physical memory in that mapping.

== QueryIoMapping ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X1 || R2, R3 || uint64_t || IoAddress
|-
| (In) X2 || R0 || uint64_t || Size
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) X1 || R1 || void* || VirtualAddress
|}
</div>

Returns a virtual address mapped to a given IO range.

== CreateDeviceAddressSpace ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X1 || R2, R3 || uint64_t || DeviceAddressSpaceStartAddress
|-
| (In) X2 || R0, R1 || uint64_t || DeviceAddressSpaceEndAddress
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) W1 || R1 || Handle<DeviceAddressSpace> || DeviceAddressSpaceHandle
|}
</div>

Creates a virtual address space for binding device address spaces and returns a handle.

StartAddr is normally set to 0 and EndAddr is normally set to 0xFFFFFFFF.

== AttachDeviceAddressSpace ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || [[#DeviceName]] || DeviceName
|-
| (In) X1 || Handle<DeviceAddressSpace> || DeviceAddressSpaceHandle
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

Attaches a device address space to a [[#DeviceName|device]].

== DetachDeviceAddressSpace ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || [[#DeviceName]] || DeviceName
|-
| (In) X1 || Handle<DeviceAddressSpace> || DeviceAddressSpaceHandle
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

Detaches a device address space from a [[#DeviceName|device]].

== MapDeviceAddressSpaceByForce ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R0 || Handle<DeviceAddressSpace> || DeviceAddressSpaceHandle
|-
| (In) W1 || R1 || Handle<Process> || ProcessHandle
|-
| (In) X2 || R2, R3 || void* || Address
|-
| (In) X3 || R4 || uint64_t || DeviceAddressSpaceSize
|-
| (In) X4 || R5, R6 || uint64_t || DeviceAddressSpaceAddress
|-
| (In) W5 || R7 || uint32_t || Option
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

Maps an attached device address space to an userspace address.

Address is the userspace destination address, while DeviceAddressSpaceAddress is the source address between DeviceAddressSpaceStartAddress and DeviceAddressSpaceEndAddress (passed to [[#CreateDeviceAddressSpace]]).

The userspace destination address must have the [[SVC#MemoryState|FlagCanDeviceMap]] bit set. Bit [[SVC#MemoryAttribute|DeviceShared]] will be set after mapping.

The Option encodes a [[#MemoryPermission]] in the low 16 bits, and an indicator of IO mapping in the high bits.

== MapDeviceAddressSpaceAligned ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R0 || Handle<DeviceAddressSpace> || DeviceAddressSpaceHandle
|-
| (In) W1 || R1 || Handle<Process> || ProcessHandle
|-
| (In) X2 || R2, R3 || void* || Address
|-
| (In) X3 || R4 || uint64_t || DeviceAddressSpaceSize
|-
| (In) X4 || R5, R6 || uint64_t || DeviceAddressSpaceAddress
|-
| (In) W5 || R7 || uint32_t || Option
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

Maps an attached device address space to an userspace address.

Same as [[#MapDeviceAddressSpaceByForce]], but the userspace destination address must have the [[SVC#MemoryState|FlagCanAlignedDeviceMap]] bit set instead.

The Option encodes a [[#MemoryPermission]] in the low 16 bits, and an indicator of IO mapping in the high bits.

== MapDeviceAddressSpace ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W1 || R1 || Handle<DeviceAddressSpace> || DeviceAddressSpaceHandle
|-
| (In) W2 || R2 || Handle<Process> || ProcessHandle
|-
| (In) X3 || R0, R3 || void* || Address
|-
| (In) X4 || R4 || uint64_t || DeviceAddressSpaceSize
|-
| (In) X5 || R5, R6 || uint64_t || DeviceAddressSpaceAddress
|-
| (In) W6 || R7 || [[#MemoryPermission]] || MemoryPermission
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) X1 || R1 || uint64_t || Size
|}
</div>

== UnmapDeviceAddressSpace ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R0 || Handle<DeviceAddressSpace> || DeviceAddressSpaceHandle
|-
| (In) W1 || R1 || Handle<Process> || ProcessHandle
|-
| (In) X2 || R2, R3 || void* || Address
|-
| (In) X3 || R4 || uint64_t || DeviceAddressSpaceSize
|-
| (In) X4 || R5, R6 || uint64_t || DeviceAddressSpaceAddress
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

Unmaps an attached device address space from an userspace address.

== InvalidateProcessDataCache ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R0 || Handle<Process> || ProcessHandle
|-
| (In) X1 || R2, R3 || void* || Address
|-
| (In) X2 || R1, R4 || uint64_t || Size
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

== StoreProcessDataCache ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R0 || Handle<Process> || ProcessHandle
|-
| (In) X1 || R2, R3 || void* || Address
|-
| (In) X2 || R1, R4 || uint64_t || Size
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

== FlushProcessDataCache ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R0 || Handle<Process> || ProcessHandle
|-
| (In) X1 || R2, R3 || void* || Address
|-
| (In) X2 || R1, R4 || uint64_t || Size
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

== DebugActiveProcess ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X1 || R2, R3 || uint64_t || ProcessId
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) W1 || R1 || Handle<Debug> || DebugHandle
|}
</div>

== BreakDebugProcess ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<Debug> || DebugHandle
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== TerminateDebugProcess ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<Debug> || DebugHandle
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== GetDebugEvent ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || [[#DebugEventInfo]]* || DebugEventInfo
|-
| (In) W1 || Handle<Debug> || DebugHandle
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== ContinueDebugEvent ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R0 || Handle<Debug> || DebugHandle
|-
| (In) W1 || R1 || uint32_t || [[#ContinueDebugFlags]] ([1.0.0-2.3.0] [[#ContinueDebugFlagsOld]])
|-
| (In) X2 || R2 ([1.0.0-2.3.0] R2, R3) || uint64_t* ([1.0.0-2.3.0] uint64_t)|| ThreadIdList ([1.0.0-2.3.0] ThreadId)
|-
| (In) X3 || R3 || uint64_t || [3.0.0+] NumThreadIds
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

Maximum NumThreadIds is 64. 0 means "all threads".

=== Result codes ===
'''0x0:''' Success. The process has been resumed.

'''0xe401:''' Invalid debug handle.

'''0xf401:''' Process has debug events queued or is already running.

== GetProcessList ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X1 || R1 || uint64_t* || ProcessIdBuffer
|-
| (In) W2 || R2 || uint32_t || ProcessIdBufferSize
|-
| (Out) X0 || R0 || [[#Result]] || Result
|-
| (Out) W1 || R1 || uint32_t || NumProcesses
|}
</div>

Fills the provided array with the pids of currently living processes. A process "lives" so long as it is currently running or a handle to it still exists.

It returns the total number of processes currently alive. If this number is bigger than the size of ProcessIdBuffer, the user won't have all the pids.

=== Result codes ===
'''0x0:''' Success.

'''0xd401:''' The provided buffer is outside the process address space.

'''0xe601:''' copyToUser failed. The provided buffer is not user-accessible.

'''0xee01:''' The provided buffer size is too big. Max value is 0xFFFFFFF.

== GetThreadList ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X1 || R1 || uint64_t* || ThreadIdBuffer
|-
| (In) W2 || R2 || uint32_t || ThreadIdBufferSize
|-
| (In) W3 || R3 || Handle<Debug> || DebugHandle
|-
| (Out) X0 || R0 || [[#Result]] || Result
|-
| (Out) W1 || R1 || uint32_t || NumThreads
|}
</div>

== GetDebugThreadContext ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X0 || R0 || [[#ThreadContext]]* || ThreadContext
|-
| (In) X1 || R1 || Handle<Debug> || DebugHandle
|-
| (In) X2 || R2, R3 || uint64_t || ThreadId
|-
| (In) W3 || R4 || uint32_t || [[#ThreadContextFlags]]
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

== SetDebugThreadContext ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R0 || Handle<Debug> || DebugHandle
|-
| (In) X1 || R2, R3 || uint64_t || ThreadId
|-
| (In) X2 || R1 || [[#ThreadContext]]* || ThreadContext
|-
| (In) W3 || R4 || uint32_t || [[#ThreadContextFlags]]
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

== QueryDebugProcessMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || [[#MemoryInfo]]* || MemoryInfo
|-
| (In) W2 || Handle<Debug> || DebugHandle
|-
| (In) X3 || void* || Address
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) W1 || [[#PageInfo]] || PageInfo
|}
</div>

== ReadDebugProcessMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || void* || MemoryBufferAddress
|-
| (In) W1 || Handle<Debug> || DebugHandle
|-
| (In) X2 || void* || SrcAddress
|-
| (In) X3 || uint64_t || Size
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== WriteDebugProcessMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<Debug> || DebugHandle
|-
| (In) X1 || void* || MemoryBufferAddress
|-
| (In) X2 || void* || DstAddress
|-
| (In) X3 || uint64_t || Size
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== SetHardwareBreakPoint ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R0 || [[#HardwareBreakPointRegisterName]] || Name
|-
| (In) X1 || R2, R3 || uint64_t || Flags
|-
| (In) X2 || R1, R4 || uint64_t || Value
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

Sets one of the AArch64 hardware breakpoints. The nintendo switch has 6 hardware breakpoints, and 4 hardware watchpoints. The syscall has two behaviors depending on the value of HardwareBreakPointRegisterName:

If HardwareBreakPointRegisterName < 0x10, then it sets one of the AArch64 hardware breakpoints. Flags will go to DBGBCRn_EL1, and value to DBGBVRn_EL1. The only flags the user is allowed to set are those in the bitmask 0x7F01E1. Furthermore, the kernel will or it with 0x4004, in order to set various security flags to guarantee the watchpoints only triggers for code in EL0. If the user asks for a Breakpoint Type of ContextIDR match, the kernel shall use the given DebugHandle to set DBGBVRn_EL1 to the ContextID of the debugged process.

If HardwareBreakPointRegisterName is between 0x10 and 0x20 (exclusive), then it sets one of the AArch64 hardware watchpoints. Flags will go to DBGWCRn_EL1, and the value to DBGWVRn_EL1. The only flags the user is allowed to set are those in the bitmask 0xFF0F1FF9. Furthermore, the kernel will or it with 0x104004. This will set various security flags, and set the watchpoint type to be a Linked Watchpoint. This means that you need to link it to a Linked ContextIDR breakpoint. Check the ARM documentation for more information.

Note that HardwareBreakPointRegisterName 0 to 4 match only to Virtual Address, while HardwareBreakPointRegisterName 5 and 6 match against either Virtual Address, ContextID, or VMID. As such, if you are configuring a breakpoint to link for a watchpoint, make sure you use hardware_breakpoint_id 5 or 6.

For more documentation for hardware breakpoints, check out the AArch64 documentation for the [http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.ddi0488h/way1382455558968.html DBGBCRn_EL1 register] and the [http://infocenter.arm.com/help/topic/com.arm.doc.ddi0488h/way1382455560629.html DBGWCRn_EL1 register]

== GetDebugThreadParam ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X2 || R2 || Handle<Debug> || DebugHandle
|-
| (In) X3 || R0, R1 || uint64_t || ThreadId
|-
| (In) W4 || R3 || [[#DebugThreadParam]] || DebugThreadParam
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) X1 || R1, R2 || uint64_t || Out0
|-
| (Out) W2 || R3 || uint32_t || Out1
|}
</div>

== GetSystemInfo ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X1 || [[#SystemInfoType]] || SystemInfoType
|-
| (In) W2 || Handle || Handle
|-
| (In) X3 || uint64_t || SystemInfoSubType
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) X1 || uint64_t || SystemInfo
|}
</div>

== CreatePort ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W2 || R2 || int32_t || MaxSessions
|-
| (In) W3 || R3 || bool || IsLight
|-
| (In) X4 || R0 || uint64_t || Name
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) W1 || R1 || Handle<Port> || ServerPortHandle
|-
| (Out) W2 || R2 || Handle<Port> || ClientPortHandle
|}
</div>

== ManageNamedPort ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X1 || char* || Name
|-
| (In) W2 || int32_t || MaxSessions
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) W1 || Handle<Port> || ServerPortHandle
|}
</div>

== ConnectToPort ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W1 || Handle<Port> || ClientPortHandle
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) W1 || Handle<Session> || SessionHandle
|}
</div>

== SetProcessMemoryPermission ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R0 || Handle<Process> || ProcessHandle
|-
| (In) X1 || R2, R3 || void* || Addr
|-
| (In) X2 || R1, R4 || uint64_t || Size
|-
| (In) W3 || R5 || [[#MemoryPermission]] || MemoryPermission
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

This sets the memory permissions for the specified memory with the supplied process handle.

This throws an error(0xD801) when the input perm is >0x5, hence -WX and RWX are not allowed.

== MapProcessMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X0 || R0 || void* || DstAddress
|-
| (In) W1 || R1 || Handle<Process> || ProcessHandle
|-
| (In) X2 || R2, R3 || void* || SrcAddress
|-
| (In) X3 || R4 || uint64_t || Size
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

Maps the src address from the supplied process handle into the current process.

This allows mapping code and rodata with RW- permission.

== UnmapProcessMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X0 || R0 || void* || DstAddress
|-
| (In) W1 || R1 || Handle<Process> || ProcessHandle
|-
| (In) X2 || R2, R3 || void* || SrcAddress
|-
| (In) X3 || R4 || uint64_t || Size
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

Unmaps what was mapped by [[#MapProcessMemory]].

== QueryProcessMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X0 || R0 || [[#MemoryInfo]]* || MemoryInfo
|-
| (In) W2 || R2 || Handle<Process> || ProcessHandle
|-
| (In) X3 || R1, R3 || void* || Address
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) W1 || R1 || [[#PageInfo]] || PageInfo
|}
</div>

Equivalent to [[#QueryMemory]] except takes a process handle.

== MapProcessCodeMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R0 || Handle<Process> || ProcessHandle
|-
| (In) X1 || R2, R3 || void* || DstAddress
|-
| (In) X2 || R1, R4 || void* || SrcAddress
|-
| (In) X3 || R5, R6 || uint64_t || Size
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

Takes a process handle, and maps normal heap in that process as executable code in that process. Used when loading NROs. This does not support using the current-process handle alias.

== UnmapProcessCodeMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R0 || Handle<Process> || ProcessHandle
|-
| (In) X1 || R2, R3 || void* || DstAddress
|-
| (In) X2 || R1, R4 || void* || SrcAddress
|-
| (In) X3 || R5, R6 || uint64_t || Size
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

Unmaps what was mapped by [[#MapProcessCodeMemory]].

== CreateProcess ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X1 || [[#CreateProcessParameter]]* || CreateProcessParameter
|-
| (In) X2 || uint32_t* || Capabilities
|-
| (In) X3 || int32_t || CapabilitiesNum
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) W1 || Handle<Process> || ProcessHandle
|}
</div>

Takes a [[#CreateProcessParameter]] as input.
Capabilities points to an array of [[NPDM#Kernel_Access_Control|kernel capabilities]].
CapabilitiesNum is a number of capabilities in the Capabilities array (number of element, not number of bytes).

=== Result codes ===
'''0x0:''' Success.

'''0xCA01:''' Attempted to map more code pages than available in address space.

'''0xCC01:''' Provided CodeAddr is invalid (make sure it's in range?)

'''0xE401:''' The resource handle passed is invalid.

'''0xE601:''' Attempt to copy procinfo from user-supplied pointer failed. Attempt to copy capabilities_num from user-supplied pointer failed.

'''0xE801:''' Attempted to create a 32-bit process with a 36-bit address space.

'''0xF001:''' Unused bits are set in mmuflags. Unknown address space type used.

== StartProcess ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R0 || Handle<Process> || ProcessHandle
|-
| (In) W1 || R1 || int32_t || MainThreadPriority
|-
| (In) W2 || R2 || int32_t || DefaultCpuId
|-
| (In) X3 || R3, R4 || uint64_t || MainThreadStackSize
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

== TerminateProcess ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<Process> || ProcessHandle
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== GetProcessInfo ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R1 || Handle<Process> || ProcessHandle
|-
| (In) W1 || R2 || [[#ProcessInfoType]] || ProcessInfoType
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) X1 || R1, R2 || uint64_t || [[#ProcessState]]
|}
</div>

Returns an enum with value 0-7.

== CreateResourceLimit ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) None || ||
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) W1 || Handle<ResourceLimit> || ResourceLimitHandle
|}
</div>

== SetResourceLimitLimitValue ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R0 || Handle<ResourceLimit> || ResourceLimitHandle
|-
| (In) W1 || R1 || [[#LimitableResource]] || LimitableResource
|-
| (In) X2 || R2, R3 || int64_t || LimitValue
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

== CallSecureMonitor ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X0 || R0 || uint64_t || [[SMC#Secure_Monitor_calls|FunctionId]]
|-
| (In) X1-X7 || R1-R7 || uint64_t || SMC arguments
|-
| (Out) X0 || R0 || [[SMC#Result|Result]] || SMC result
|-
| (Out) X1-X7 || R1-R7 || uint64_t || SMC output
|}
</div>

Takes in a SMC function ID in X0, and arguments for that SMC function in X1-X7.

Passing an invalid SMC function ID or calling from a core other than core 3 will result in a secure monitor panic.

The kernel parses bits 9-15 in the passed SMC function ID (per the ARM SMC calling convention), and when set uses as an indicator to translate a pointer in the associated register (X1-X7) to a physical address. The kernel will translate any address mapped as R-W, other addresses (R--, R-X, or invalid pointers) will be translated as 0/NULL.

Output is returned raw from the Secure Monitor; X0 will be the untranslated SMC result and X1-X7 will contain other SMC output (or be unchanged, depending on the SMC).

== Debugging ==
[2.0.0+] Exactly 6 debug SVCs require that [[SPL_services#GetConfig|IsDebugMode]] is non-zero. Error 0x4201 is returned otherwise.
* BreakDebugProcess
* ContinueDebugEvent
* WriteDebugProcessMemory
* SetDebugThreadContext
* TerminateDebugProcess
* SetHardwareBreakPoint

DebugActiveProcess stops execution of the target process, the normal method for resuming it requires ContinueDebugEvent(see above). Closing the debug handle also results in execution being resumed.

= Enum/Structures =
== InfoType ==
{| class=wikitable
! Handle type || InfoType || InfoSubType || Description
|-
| Process || 0 || 0 || CoreMask
|-
| Process || 1 || 0 || PriorityMask
|-
| Process || 2 || 0 || AliasRegionAddress
|-
| Process || 3 || 0 || AliasRegionSize
|-
| Process || 4 || 0 || HeapRegionAddress
|-
| Process || 5 || 0 || HeapRegionSize
|-
| Process || 6 || 0 || TotalMemorySize. Total memory available(free+used).
|-
| Process || 7 || 0 || UsedMemorySize. Total used size of codebin memory + main-thread stack + allocated heap.
|-
| Zero || 8 || 0 || DebuggerAttached
|-
| Zero || 9 || 0 || ResourceLimit
|-
| Zero || 10 || -1, {current coreid} || IdleTickCount
|-
| Zero || 11 || 0-3 || RandomEntropy. Used to seed usermode PRNGs.
|-
| Process || 12 || 0 || [2.0.0+] AslrRegionAddress
|-
| Process || 13 || 0 || [2.0.0+] AslrRegionSize
|-
| Process || 14 || 0 || [2.0.0+] StackRegionAddress
|-
| Process || 15 || 0 || [2.0.0+] StackRegionSize
|-
| Process || 16 || 0 || [3.0.0+] SystemResourceSizeTotal
|-
| Process || 17 || 0 || [3.0.0+] SystemResourceSizeUsed
|-
| Process || 18 || 0 || [3.0.0+] ProgramId
|-
| Zero || 19 || 0 || [4.0.0-4.1.0] InitialProcessIdRange_LowerBound
|-
| Zero || 19 || 1 || [4.0.0-4.1.0] InitialProcessIdRange_UpperBound
|-
| Process || 20 || 0 || [5.0.0+] UserExceptionContextAddress
|-
| Process || 21 || 0 || [6.0.0+] TotalNonSystemMemorySize
|-
| Process || 22 || 0 || [6.0.0+] UsedNonSystemMemorySize
|-
| Process || 23 || 0 || [9.0.0+] IsApplication
|-
| Process || 24 || 0 || [11.0.0+] FreeThreadCount
|-
| Thread || 25 ([1.0.0-12.1.0] 0xF0000002) || 0-3, -1 || ThreadTickCount. When 0-3 are passed, gets specific core CPU ticks spent on thread. When -1 is passed, gets total CPU ticks spent on thread.
|-
| Process || 26 || 0 || [14.0.0+] IsSvcPermitted
|}

== SystemInfoType ==
{| class=wikitable
! Handle type || SystemInfoType || SystemInfoSubType || Description
|-
| Zero || 0 || 0 || TotalPhysicalMemorySize_Application
|-
| Zero || 0 || 1 || TotalPhysicalMemorySize_Applet
|-
| Zero || 0 || 2 || TotalPhysicalMemorySize_System
|-
| Zero || 0 || 3 || TotalPhysicalMemorySize_SystemUnsafe
|-
| Zero || 1 || 0 || UsedPhysicalMemorySize_Application
|-
| Zero || 1 || 1 || UsedPhysicalMemorySize_Applet
|-
| Zero || 1 || 2 || UsedPhysicalMemorySize_System
|-
| Zero || 1 || 3 || UsedPhysicalMemorySize_SystemUnsafe
|-
| Zero || 2 || 0 || InitialProcessIdRange_LowerBound
|-
| Zero || 2 || 1 || InitialProcessIdRange_UpperBound
|}

== ThreadContextFlags ==
Bitfield of one of more of these:

{| class=wikitable
! Bit || Bitmask || Name || Description
|-
| 0 || 1 || General-purpose registers || If in 64-bit mode, GPRs 0–28 will be read/written. If in 32-bit mode, GPRs 0–12 will be read/written.
|-
| 1 || 2 || Control registers || Reads/writes the FP, LR, PC, SP, PSTATE, and TPIDR registers.
|-
| 2 || 4 || Floating-point registers || Reads/writes the floating-point vector registers.
|-
| 3 || 8 || Floating-point control registers || Reads/writes the FPCR and FPSR registers.
|}

== DeviceName ==
{| class=wikitable
! Value || Name
|-
| 0 || AFI
|-
| 1 || AVPC
|-
| 2 || DC
|-
| 3 || DCB
|-
| 4 || HC
|-
| 5 || HDA
|-
| 6 || ISP2
|-
| 7 || MSENCNVENC
|-
| 8 || NV
|-
| 9 || NV2
|-
| 10 || PPCS
|-
| 11 || SATA
|-
| 12 || VI
|-
| 13 || VIC
|-
| 14 || XUSB_HOST
|-
| 15 || XUSB_DEV
|-
| 16 || TSEC
|-
| 17 || PPCS1
|-
| 18 || DC1
|-
| 19 || SDMMC1A
|-
| 20 || SDMMC2A
|-
| 21 || SDMMC3A
|-
| 22 || SDMMC4A
|-
| 23 || ISP2B
|-
| 24 || GPU
|-
| 25 || GPUB
|-
| 26 || PPCS2
|-
| 27 || NVDEC
|-
| 28 || APE
|-
| 29 || SE
|-
| 30 || NVJPG
|-
| 31 || HC1
|-
| 32 || SE1
|-
| 33 || AXIAP
|-
| 34 || ETR
|-
| 35 || TSECB
|-
| 36 || TSEC1
|-
| 37 || TSECB1
|-
| 38 || NVDEC1
|}

== CodeMemoryOperation ==
{| class=wikitable
! Value || Name
|-
| 0 || MapOwner
|-
| 1 || MapSlave
|-
| 2 || UnmapOwner
|-
| 3 || UnmapSlave
|}

== LimitableResource ==
{| class=wikitable
! Value || Name || Description
|-
| 0 || PhysicalMemoryMax || Bytes of memory a process may allocate.
|-
| 1 || ThreadCountMax || Amount of threads a process can create.
|-
| 2 || EventCountMax || Amount of events a process can create through [[#CreateEvent]] or [[#SendAsyncRequestWithUserBuffer]].
|-
| 3 || TransferMemoryCountMax || Amount of TransferMemory a process can create through [[#CreateTransferMemory]].
|-
| 4 || SessionCountMax || Amount of session a process can create through [[#CreateSession]], [[#ConnectToPort]] or [[#ConnectToNamedPort]].
|}

= ThreadActivity =
{| class=wikitable
! Value || Name
|-
| 0 || None
|-
| 1 || Runnable
|}

== ProcessActivity ==
{| class=wikitable
! Value || Name
|-
| 0 || None
|-
| 1 || Runnable
|}

== ProcessInfoType ==
{| class=wikitable
! Value || Name
|-
| 0 || [[#ProcessState|ProcessState]]
|}

== ProcessState ==
{| class=wikitable
! Value || Name || Notes
|-
| 0 || Created ||
|-
| 1 || CreatedAttached ||
|-
| 2 || Started ||
|-
| 3 || Crashed || Processes will not enter this state unless they were created with [[#CreateProcessParameter|EnableDebug]].
|-
| 4 || StartedAttached ||
|-
| 5 || Exiting ||
|-
| 6 || Exited ||
|-
| 7 || DebugSuspended ||
|}

== DebugThreadParam ==
{| class=wikitable
! Value || Name
|-
| 0 || DynamicPriority
|-
| 1 || SchedulingStatus
|-
| 2 || PreferredCpuCore
|-
| 3 || CurrentCpuCore
|-
| 4 || AffinityMask
|}

Dynamic priority: output in out2

Scheduling status: out1 contains bit0: is debug-suspended, bit1: is user-suspended ([[#SetThreadActivity]] 1 or [[#SetProcessActivity]] 1).
Out2 contains {suspended, idle, running, terminating} => {5, 0, 1, 4}

PreferredCpuCore: output in out2

CurrentCpuCore: output in out2

AffinityMask: output in out1

== CreateProcessParameter ==
{| class=wikitable
! Offset || Length || Bits || Description
|-
| 0 || 12 || || ProcessName (doesn't have to be null-terminated)
|-
| 0x0C || 4 || || ProcessCategory (0: regular title, 1: kernel built-in)
|-
| 0x10 || 8 || || TitleId
|-
| 0x18 || 8 || || CodeAddr
|-
| 0x20 || 4 || || CodeNumPages
|-
| 0x24 || 4 || || Flags
|-
| || || Bit0 || Is64BitInstruction
|-
| || || Bit3-1 || [[#AddressSpaceType]]
|-
| || || Bit4 || [2.0.0+] EnableDebug
|-
| || || Bit5 || EnableAslr
|-
| || || Bit6 || IsApplication
|-
| || || Bit7 || [4.0.0] UseSecureMemory
|-
| || || Bit10-7 || [5.0.0+] MemoryRegion (0 = Application, 1 = Applet, 2 = SecureSystem, 3 = NonSecureSystem)
|-
| || || Bit11 || [7.0.0+] OptimizeMemoryAllocation (only allowed in combination with IsApplication)
|-
| 0x28 || 4 || || ResourceLimitHandle (can be zero)
|-
| 0x2C || 4 || || [3.0.0+] SystemResourceNumPages
|}

On [1.0.0] there's only one MemoryRegion.

On [2.0.0-4.0.0] MemoryRegion is 1 for built-ins and 0 for rest.

On [5.0.0] MemoryRegion is specified in CreateProcessArgs. There are now 4 pool partitions.

On [5.0.0] (maybe lower?) a zero ResourceLimitHandle defaults to sysmodule limits and 0x12300000 bytes of memory.

The PersonalMmHeap are allocated as follows:
* For the application, normal insecure pool is used. Carveout 5 is used to provide protection.
* For the applet, a pre-allocated secure pool segment of size 0x400000 is used.
* For sysmodules, secure pool is allocated.

=== AddressSpaceType ===
{| class=wikitable
! Type || Name || Width || Description
|-
| 0 || AddressSpace32Bit || 32 ||
|-
| 1 || AddressSpace64BitOld || 36 ||
|-
| 2 || AddressSpace32BitNoReserved || 32 || Appears to be missing map region [?]
|-
| 3 || [2.0.0+] AddressSpace64Bit || 39 ||
|}

== MemoryInfo ==
{| class=wikitable
! Offset || Length || Description
|-
| 0 || 8 || BaseAddress
|-
| 8 || 8 || Size
|-
| 0x10 || 4 || [[#MemoryType]]
|-
| 0x14 || 4 || [[#MemoryAttribute]]
|-
| 0x18 || 4 || [[#MemoryPermission]]
|-
| 0x1C || 4 || IpcRefCount
|-
| 0x20 || 4 || DeviceRefCount
|-
| 0x24 || 4 || Padding: always zero
|}

== MemoryPermission ==
{| class=wikitable
! Bits || Name || Description
|-
| 0 || Read || Can be set by [[#SetMemoryPermission]].
|-
| 1 || Write || Can be set by [[#SetMemoryPermission]].
|-
| 2 || Execute || Can be set by [[#SetProcessMemoryPermission]] and [[#ControlCodeMemory]].
|-
| 28 || DontCare ||
|}

== MemoryAttribute ==
{| class=wikitable
! Bits || Name || Description
|-
| 0 || Locked || Used by MapMemory, as an async IPC user buffer.
|-
| 1 || IpcLocked || True when IpcRefCount > 0.
|-
| 2 || DeviceShared || True when DeviceRefCount > 0.
|-
| 3 || Uncached ||
|}

== MemoryState ==
{| class=wikitable
! Bits || Description || Meaning
|-
| 7-0 || [[#MemoryType]] ||
|-
| 8 || [[#SetMemoryPermission|FlagCanReprotect]] ||
|-
| 9 || FlagCanDebug || Allows using [[#WriteDebugProcessMemory]] on segments mapped read-only.
|-
| 10 || FlagCanUseIpc || Allows sending this region as an IPC A/B/W buffer with flags=0.
|-
| 11 || FlagCanUseNonDeviceIpc || Allows sending this region as an IPC A/B/W buffer with flags=1.
|-
| 12 || FlagCanUseNonSecureIpc || Allows sending this region as an IPC A/B/W buffer with flags=3.
|-
| 13 || FlagMapped ||
|-
| 14 || [[#SetProcessMemoryPermission|FlagCode]] ||
|-
| 15 || [[#MapMemory|FlagCanAlias]] ||
|-
| 16 || [[#MapProcessCodeMemory|FlagCanCodeAlias]] ||
|-
| 17 || [[#CreateTransferMemory|FlagCanTransfer]] ||
|-
| 18 || [[#QueryPhysicalAddress|FlagCanQueryPhysical]] ||
|-
| 19 || [[#MapDeviceAddressSpace|FlagCanDeviceMap]] ||
|-
| 20 || [[#MapDeviceAddressSpaceAligned|FlagCanAlignedDeviceMap]] ||
|-
| 21 || [[#SendSyncRequestWithUserBuffer|FlagCanIpcUserBuffer]] ||
|-
| 22 || FlagReferenceCounted || The physical memory blocks backing this region are refcounted.
|-
| 23 || [[#MapProcessMemory|FlagCanMapProcess]] ||
|-
| 24 || [[#SetMemoryAttribute|FlagCanChangeAttribute]] ||
|-
| 25 || [4.0.0+] [[#CreateCodeMemory|FlagCanCodeMemory]] ||
|}

=== MemoryType ===
{| class=wikitable
! Value || Type || Meaning
|-
| 0x00000000 || Free ||
|-
| 0x00002001 || Io || Mapped by kernel capability parsing in [[#CreateProcess]].
|-
| 0x00042002 || Static || Mapped by kernel capability parsing in [[#CreateProcess]].
|-
| 0x00DC7E03 || Code || Mapped during [[#CreateProcess]].
|-
| [1.0.0+]

0x01FEBD04

[4.0.0+]

0x03FEBD04
|| CodeData || Transition from 0xDC7E03 performed by [[#SetProcessMemoryPermission]].
|-
| [1.0.0+]
0x017EBD05

[4.0.0+]

0x037EBD05
|| Normal || Mapped using [[#SetHeapSize]].
|-
| 0x00402006 || Shared || Mapped using [[#MapSharedMemory]].
|-
| 0x00482907 || [1.0.0] Alias || Mapped using [[#MapMemory]].
|-
| 0x00DD7E08 || AliasCode || Mapped using [[#MapProcessCodeMemory]].
|-
| [1.0.0+]

0x01FFBD09

[4.0.0+]

0x03FFBD09
|| AliasCodeData || Transition from 0xDD7E08 performed by [[#SetProcessMemoryPermission]].
|-
| 0x005C3C0A || [[IPC_Marshalling|Ipc]] || IPC buffers with descriptor flags=0.
|-
| 0x005C3C0B || Stack || Mapped using [[#MapMemory]].
|-
| 0x0040200C || [[Thread Local Storage|ThreadLocal]] || Mapped during [[#CreateThread]].
|-
| 0x015C3C0D || Transfered || Mapped using [[#MapTransferMemory]] when the owning process has perm=0.
|-
| 0x005C380E || SharedTransfered || Mapped using [[#MapTransferMemory]] when the owning process has perm!=0.
|-
| 0x0040380F || SharedCode || Mapped using [[#MapProcessMemory]].
|-
| 0x00000010 || Inaccessible ||
|-
| 0x005C3811 || [[IPC_Marshalling|NonSecureIpc]] || IPC buffers with descriptor flags=1.
|-
| 0x004C2812 || [[IPC_Marshalling|NonDeviceIpc]] || IPC buffers with descriptor flags=3.
|-
| 0x00002013 || Kernel || Mapped in kernel during [[#CreateThread]].
|-
| 0x00402214 || [4.0.0+] GeneratedCode || Mapped in kernel during [[#ControlCodeMemory]].
|-
| 0x00402015 || [4.0.0+] CodeOut || Mapped in kernel during [[#ControlCodeMemory]].
|-
| 0x00002016 || [13.0.0+] Coverage ||
|}

== ArbitrationType ==
{| class=wikitable
! Value || Type
|-
| 0x0 || WaitIfLessThan
|-
| 0x1 || DecrementAndWaitIfLessThan
|-
| 0x2 || WaitIfEqual
|}

== SignalType ==
{| class=wikitable
! Value || Type
|-
| 0x0 || Signal
|-
| 0x1 || SignalAndIncrementIfEqual
|-
| 0x2 || SignalAndModifyBasedOnWaitingThreadCountIfEqual
|}

== ContinueDebugFlagsOld ==
[1.0.0-2.3.0]
{| class=wikitable
! Bit || Bitmask || Description
|-
| 0 || 1 || IgnoreException (note: ResumeAllThreads or debug-suspended-thread-id needed)
|-
| 1 || 2 || SwallowException
|-
| 2 || 4 || ResumeAllThreads
|}

== ContinueDebugFlags ==
[3.0.0+]
{| class=wikitable
! Bit || Bitmask || Description
|-
| 0 || 1 || IgnoreException (note: doesn't need to be set in the same call than Resume)
|-
| 1 || 2 || DontCatchExceptions
|-
| 2 || 4 || Resume
|-
| 3 || 8 || IgnoreOtherThreadsExceptions
|}

IgnoreExceptionsOfOthers is like IgnoreException but acts on all threads that aren't in the input list. The affected threads are resumed.

Only one of of Resume and IgnoreOtherThreadsExceptions can be set at a time.

If the input number of threads is 0, this means "all threads".

== DebugEventInfo ==
The below table is for the Aarch64 version of the system call. For A32, all u64 fields but title/process/thread id are actually u32, making the structure 0x28-byte-big (0x40 for a64).

Size: 0x40

{| class=wikitable
! Offset || Length || Description
|-
| 0 || u32 || EventType
|-
| 4 || u32 || Flags (bit0: NeedsContinue)
|-
| 8 || u64 || ThreadId
|-
| 0x10 || || PerTypeSpecifics
|}

AttachProcess specific:
{| class=wikitable
! Offset || Length || Description
|-
| 0x10 || u64 || TitleId
|-
| 0x18 || u64 || ProcessId
|-
| 0x20 || char[12] || ProcessName
|-
| 0x2C || u32 || MmuFlags
|-
| 0x30 || u64 || [5.0.0+] UserExceptionContextAddr
|}

AttachThread specific:
{| class=wikitable
! Offset || Length || Description
|-
| 0x10 || u64 || ThreadId
|-
| 0x18 || u64 || TlsPtr
|-
| 0x20 || u64 || Entrypoint
|}

Exit specific:
{| class=wikitable
! Offset || Length || Description
|-
| 0x10 || u32|| Type (0=PausedThread, 1=RunningThread, 2=ExitedProcess, 3=TerminatedProcess)
|}

Exception specific:
{| class=wikitable
! Offset || Length || Description
|-
| 0x10 || u32 || ExceptionType
|-
| 0x18 || u64 || FaultRegister
|-
| 0x20 || || PerExceptionSpecifics
|}

=== DebugEventType ===
{| class=wikitable
! Value || Name
|-
| 0 || AttachProcess
|-
| 1 || AttachThread
|-
| 2 || ExitProcess
|-
| 3 || ExitThread
|-
| 4 || Exception
|}

=== DebugExceptionType ===
{| class=wikitable
! Value || Name
|-
| 0 || Trap (*)
|-
| 1 || InstructionAbort
|-
| 2 || DataAbortMisc (**)
|-
| 3 || PcSpAlignmentFault
|-
| 4 || DebuggerAttached
|-
| 5 || BreakPoint
|-
| 6 || UserBreak
|-
| 7 || DebuggerBreak
|-
| 8 || BadSvcId
|-
| 9 || [2.0.0+] SError
|}

<nowiki>*</nowiki> Undefined instructions, software breakpoints, some other traps.

<nowiki>**</nowiki> Data aborts, FP traps, and everything else that doesn't belong to any of the above.

Trap specifics:
{| class=wikitable
! Offset || Length || Description
|-
| 0x20 || u32 || Opcode
|}

BreakPoint specifics:
{| class=wikitable
! Offset || Length || Description
|-
| 0x20 || u32 || IsWatchpoint
|}

UserBreak specifics:
{| class=wikitable
! Offset || Length || Description
|-
| 0x20 || u32 || Info0
|-
| 0x28 || u64 || Info1
|-
| 0x30 || u64 || Info2
|}

BadSvcId specifics:
{| class=wikitable
! Offset || Length || Description
|-
| 0x20 || u32 || SvcId
|}

= Exception handling =
First of all, a function that might be called by synchronous exception handler and that is called by the SError handler fetches the exception info, adjusts PC, panics on exceptions taken from EL1, then dispatches the exception.

The dispatcher has two mutually exclusive exception reporting methods:
* by storing information at the start of the process's TLS memregion (TPIDRRO_EL0) and jumping back to the crt0
* by using KDebug

KDebug dispatching is used when at least one of the following conditions are met:
* SMC ConfigItem KernelMemConfig bit 1 is NOT set (it isn't on retail), unless: this is a software or hardware breakpoint, or a watchpoint, or [4.0.0+?] the process is attached and this is a Google PNaCl trap instruction (see LLVM source)
* FAR doesn't point to a valid address in mapped-readable CodeStatic memory (i.e. this is the case for NRO and JIT memory) or this is one of the following exceptions (it particular, that doesn't include FP exceptions occurring in CodeStatic memory):
** Uncategorized
** IllegalState
** SupervisorCallA32
** SupervisorCallA64
** PCAlignment
** SPAlignment
** SError
** BreakpointLowerEl
** SoftwareStepLowerEl (note: no way set single-step flag; not parsed)
** WatchpointLowerEl
** SoftwareBreakpointA32 (note: not parsed)
** SoftwareBreakpointA64 (note: not parsed)

In all other cases the userland-handled exception path is taken.

KDebug path:

If the process is attached, the exception is reported to the KDebug. If the thread was continued using flag IgnoreExceptions, it returns from the exception as if nothing happened.

If the latter is not the case, or if the process isn't attached, proceed to [2.0.0+] crash reporting (or in [1.0.0] just terminate the process):
if EnableDebug is set, and depending on the process state (more than one crash per process isn't permitted) it may signal itself with ProcessState_Crashed so that PM asks NS to start creport so that creport attaches to it and reports the crashes. Otherwise, just terminate.

Userland reporting path and [[#ReturnFromException]]:

TLS region start (A64):
{| class=wikitable
! Offset || Length || Description
|-
| 0x0 || 0x148 || Exception stack
|-
| 0x148 || 0x78 || ExceptionFrameA64
|}

ExceptionFrameA64:
{| class=wikitable
! Offset || Length || Description
|-
| 0x0 || 0x48 (8*9) || GPRs 0..8.
|-
| 0x48 || 0x8 || lr
|-
| 0x50 || 0x8 || sp
|-
| 0x58 || 0x8 || pc (elr_el1)
|-
| 0x60 || 0x4 || pstate & 0xFF0FFE20
|-
| 0x64 || 0x4 || afsr0
|-
| 0x68 || 0x4 || afsr1
|-
| 0x6C || 0x4 || esr
|-
| 0x70 || 0x8 || far
|}

TLS region start (A32):
{| class=wikitable
! Offset || Length || Description
|-
| 0x0 || 0x178 || Exception stack
|-
| 0x148 || 0x44 || ExceptionFrameA32
|}

ExceptionFrameA32:
{| class=wikitable
! Offset || Length || Description
|-
| 0x0 || 0x20 (8*4) || GPRs 0..7.
|-
| 0x20 || 0x4 || sp
|-
| 0x24 || 0x4 || lr
|-
| 0x28 || 0x4 || pc (elr_el1)
|-
| 0x2C || 0x4 || tpidr_el0 = 1
|-
| 0x30 || 0x4 || cpsr & 0xFF0FFE20
|-
| 0x34 || 0x4 || afsr0
|-
| 0x38 || 0x4 || afsr1
|-
| 0x3C || 0x4 || esr
|-
| 0x40 || 0x4 || far
|}

In that case, after storing the regs in the TLS, the exception handler returns to the application's crt0 (entrypoint), with X0=<error description code> (see below) and X1=SP=frame=<stack top> (see above)

{| class=wikitable
! Desc. code || Meaning
|-
| 0x100 || Instruction abort
|-
| 0x102 || Misaligned PC
|-
| 0x103 || Misaligned SP
|-
| 0x106 || [2.0.0+] SError
|-
| 0x301 || Bad SVC
|-
| 0x104 || Uncategorized, CP15RTTrap, CP15RRTTrap, CP14RTTrap, CP14RRTTrap, IllegalState, SystemRegisterTrap
|-
| 0x101 || None of the above, EC <= 0x34 and not a breakpoint
|-
|}

(During normal app boot the process is invoked with X0=0 and X1=main_thread_handle. The crt0 of retail apps determines whether to boot normally or handle an exception if X0 is set to 0 or not)

The application is supposed to promptly update the contents of elr_el1 to a user handler (and any other regs it sees fit) and call [[#ReturnFromException]] (error code) to call that handler. The latter is then expected to promptly abort the program.

[[#ReturnFromException]] updates the contents of the kernel stack frame with what the user provided in the TLS structure, sets TPIDR_EL0 to 1, then:
* if the provided error code is 0, gracefully pivots and returns from exception
* if it is not, replays the exception and pass it to the KDebug (see above). One can pass 0x10001 to prevent process termination. If the process is attached, this also prevents crash-collection/termination (different from the exception handler behavior)

If an exception occurs from the above user handler, the entire exception handling process will repeat with the new exception.

Note that if a thread that wasn't faulting calls [[#ReturnFromException]], it signals an "invalid syscall" exception

Note that [[SMC|IsDebugMode]] is not used during exception-handling, except for enabling printing a message to UART-A. This UART code causes a system-hang on retail (likely due to a loop that doesn't exit). This printing doesn't seem to run when the process is attached for debugging?

SVC

2023-02-18T18:29:57Z

Liamwhite: ClearEvent does not fail if the event is not signaled

__NOTOC__

= System calls =
{| class=wikitable
! ID || Return Type || Name || Arguments
|-
| 0x01 || Result || [[#SetHeapSize|SetHeapSize]] || uintptr_t *out_address, size_t size
|-
| 0x02 || Result || [[#SetMemoryPermission|SetMemoryPermission]] || uintptr_t address, size_t size, MemoryPermission perm
|-
| 0x03 || Result || [[#SetMemoryAttribute|SetMemoryAttribute]] || uintptr_t address, size_t size, uint32_t mask, uint32_t attr
|-
| 0x04 || Result || [[#MapMemory|MapMemory]] || uintptr_t dst_address, uintptr_t src_address, size_t size
|-
| 0x05 || Result || [[#UnmapMemory|UnmapMemory]] || uintptr_t dst_address, uintptr_t src_address, size_t size
|-
| 0x06 || Result || [[#QueryMemory|QueryMemory]] || arch::MemoryInfo *out_memory_info, PageInfo *out_page_info, uintptr_t address
|-
| 0x07 || void || [[#ExitProcess|ExitProcess]] ||
|-
| 0x08 || Result || [[#CreateThread|CreateThread]] || Handle *out_handle, ThreadFunc func, uintptr_t arg, uintptr_t stack_bottom, int32_t priority, int32_t core_id
|-
| 0x09 || Result || [[#StartThread|StartThread]] || Handle thread_handle
|-
| 0x0A || void || [[#ExitThread|ExitThread]] ||
|-
| 0x0B || void || [[#SleepThread|SleepThread]] || int64_t ns
|-
| 0x0C || Result || [[#GetThreadPriority|GetThreadPriority]] || int32_t *out_priority, Handle thread_handle
|-
| 0x0D || Result || [[#SetThreadPriority|SetThreadPriority]] || Handle thread_handle, int32_t priority
|-
| 0x0E || Result || [[#GetThreadCoreMask|GetThreadCoreMask]] || int32_t *out_core_id, uint64_t *out_affinity_mask, Handle thread_handle
|-
| 0x0F || Result || [[#SetThreadCoreMask|SetThreadCoreMask]] || Handle thread_handle, int32_t core_id, uint64_t affinity_mask
|-
| 0x10 || int32_t || [[#GetCurrentProcessorNumber|GetCurrentProcessorNumber]] ||
|-
| 0x11 || Result || [[#SignalEvent|SignalEvent]] || Handle event_handle
|-
| 0x12 || Result || [[#ClearEvent|ClearEvent]] || Handle event_handle
|-
| 0x13 || Result || [[#MapSharedMemory|MapSharedMemory]] || Handle shmem_handle, uintptr_t address, size_t size, MemoryPermission map_perm
|-
| 0x14 || Result || [[#UnmapSharedMemory|UnmapSharedMemory]] || Handle shmem_handle, uintptr_t address, size_t size
|-
| 0x15 || Result || [[#CreateTransferMemory|CreateTransferMemory]] || Handle *out_handle, uintptr_t address, size_t size, MemoryPermission map_perm
|-
| 0x16 || Result || [[#CloseHandle|CloseHandle]] || Handle handle
|-
| 0x17 || Result || [[#ResetSignal|ResetSignal]] || Handle handle
|-
| 0x18 || Result || [[#WaitSynchronization|WaitSynchronization]] || int32_t *out_index, const Handle *handles, int32_t numHandles, int64_t timeout_ns
|-
| 0x19 || Result || [[#CancelSynchronization|CancelSynchronization]] || Handle handle
|-
| 0x1A || Result || [[#ArbitrateLock|ArbitrateLock]] || Handle thread_handle, uintptr_t address, uint32_t tag
|-
| 0x1B || Result || [[#ArbitrateUnlock|ArbitrateUnlock]] || uintptr_t address
|-
| 0x1C || Result || [[#WaitProcessWideKeyAtomic|WaitProcessWideKeyAtomic]] || uintptr_t address, uintptr_t cv_key, uint32_t tag, int64_t timeout_ns
|-
| 0x1D || void || [[#SignalProcessWideKey|SignalProcessWideKey]] || uintptr_t cv_key, int32_t count
|-
| 0x1E || int64_t || [[#GetSystemTick|GetSystemTick]] ||
|-
| 0x1F || Result || [[#ConnectToNamedPort|ConnectToNamedPort]] || Handle *out_handle, const char *name
|-
| 0x20 || Result || [[#SendSyncRequestLight|SendSyncRequestLight]] || Handle session_handle
|-
| 0x21 || Result || [[#SendSyncRequest|SendSyncRequest]] || Handle session_handle
|-
| 0x22 || Result || [[#SendSyncRequestWithUserBuffer|SendSyncRequestWithUserBuffer]] || uintptr_t message_buffer, size_t message_buffer_size, Handle session_handle
|-
| 0x23 || Result || [[#SendAsyncRequestWithUserBuffer|SendAsyncRequestWithUserBuffer]] || Handle *out_event_handle, uintptr_t message_buffer, size_t message_buffer_size, Handle session_handle
|-
| 0x24 || Result || [[#GetProcessId|GetProcessId]] || uint64_t *out_process_id, Handle process_handle
|-
| 0x25 || Result || [[#GetThreadId|GetThreadId]] || uint64_t *out_thread_id, Handle thread_handle
|-
| 0x26 || void || [[#Break|Break]] || BreakReason break_reason, uintptr_t arg, size_t size
|-
| 0x27 || Result || [[#OutputDebugString|OutputDebugString]] || const char *debug_str, size_t len
|-
| 0x28 || void || [[#ReturnFromException|ReturnFromException]] || Result result
|-
| 0x29 || Result || [[#GetInfo|GetInfo]] || uint64_t *out, InfoType info_type, Handle handle, uint64_t info_subtype
|-
| 0x2A || void || [[#FlushEntireDataCache|FlushEntireDataCache]] ||
|-
| 0x2B || Result || [[#FlushDataCache|FlushDataCache]] || uintptr_t address, size_t size
|-
| [3.0.0+] 0x2C || Result || [[#MapPhysicalMemory|MapPhysicalMemory]] || uintptr_t address, size_t size
|-
| [3.0.0+] 0x2D || Result || [[#UnmapPhysicalMemory|UnmapPhysicalMemory]] || uintptr_t address, size_t size
|-
| [5.0.0-5.1.0] 0x2E || Result || GetFutureThreadInfo || arch::LastThreadContext *out_context, uintptr_t *out_tls_address, uint32_t *out_flags, int64_t ns
|-
| [6.0.0+] 0x2E || Result || [[#GetDebugFutureThreadInfo|GetDebugFutureThreadInfo]] || arch::LastThreadContext *out_context, uint64_t *thread_id, Handle debug_handle, int64_t ns
|-
| 0x2F || Result || [[#GetLastThreadInfo|GetLastThreadInfo]] || arch::LastThreadContext *out_context, uintptr_t *out_tls_address, uint32_t *out_flags
|-
| 0x30 || Result || [[#GetResourceLimitLimitValue|GetResourceLimitLimitValue]] || int64_t *out_limit_value, Handle resource_limit_handle, LimitableResource which
|-
| 0x31 || Result || [[#GetResourceLimitCurrentValue|GetResourceLimitCurrentValue]] || int64_t *out_current_value, Handle resource_limit_handle, LimitableResource which
|-
| 0x32 || Result || [[#SetThreadActivity|SetThreadActivity]] || Handle thread_handle, ThreadActivity thread_activity
|-
| 0x33 || Result || [[#GetThreadContext3|GetThreadContext3]] || ThreadContext *out_context, Handle thread_handle
|-
| [4.0.0+] 0x34 || Result || [[#WaitForAddress|WaitForAddress]] || uintptr_t address, ArbitrationType arb_type, int32_t value, int64_t timeout_ns
|-
| [4.0.0+] 0x35 || Result || [[#SignalToAddress|SignalToAddress]] || uintptr_t address, SignalType signal_type, int32_t value, int32_t count
|-
| [8.0.0+] 0x36 || void || [[#SynchronizePreemptionState|SynchronizePreemptionState]] ||
|-
| [11.0.0+] 0x37 || Result || [[#GetResourceLimitPeakValue|GetResourceLimitPeakValue]] || int64_t *out_peak_value, Handle resource_limit_handle, LimitableResource which
|- style="border-top: double"
| [13.0.0+] 0x39 || Result || CreateIoPool || Handle *out_handle, IoPoolType which_pool
|-
| [13.0.0+] 0x3A || Result || CreateIoRegion || Handle *out_handle, Handle io_pool, PhysicalAddress physical_address, size_t size, MemoryMapping mapping, MemoryPermission perm
|- style="border-top: double"
| [1.0.0-3.0.2] 0x3C || void || [[#DumpInfo|DumpInfo]] || DumpInfoType dump_info_type, uint64_t arg
|-
| [4.0.0+] 0x3C || void || [[#KernelDebug|KernelDebug]] || KernelDebugType kern_debug_type, uint64_t arg0, uint64_t arg1, uint64_t arg2
|-
| [4.0.0+] 0x3D || void || [[#ChangeKernelTraceState|ChangeKernelTraceState]] || KernelTraceState kern_trace_state
|- style="border-top: double"
| 0x40 || Result || [[#CreateSession|CreateSession]] || Handle *out_server_session_handle, Handle *out_client_session_handle, bool is_light, uintptr_t name
|-
| 0x41 || Result || [[#AcceptSession|AcceptSession]] || Handle *out_handle, Handle port
|-
| 0x42 || Result || [[#ReplyAndReceiveLight|ReplyAndReceiveLight]] || Handle handle
|-
| 0x43 || Result || [[#ReplyAndReceive|ReplyAndReceive]] || int32_t *out_index, const Handle *handles, int32_t num_handles, Handle reply_target, int64_t timeout_ns
|-
| 0x44 || Result || [[#ReplyAndReceiveWithUserBuffer|ReplyAndReceiveWithUserBuffer]] || int32_t *out_index, uintptr_t message_buffer, size_t message_buffer_size, const Handle *handles, int32_t num_handles, Handle reply_target, int64_t timeout_ns
|-
| 0x45 || Result || [[#CreateEvent|CreateEvent]] || Handle *out_write_handle, Handle *out_read_handle
|-
| [13.0.0+] 0x46 || Result || MapIoRegion || Handle io_region, uintptr_t address, size_t size, MemoryPermission perm
|-
| [13.0.0+] 0x47 || Result || UnmapIoRegion || Handle io_region, uintptr_t address, size_t size
|-
| [5.0.0+] 0x48 || Result || [[#MapPhysicalMemoryUnsafe|MapPhysicalMemoryUnsafe]] || uintptr_t address, size_t size
|-
| [5.0.0+] 0x49 || Result || [[#UnmapPhysicalMemoryUnsafe|UnmapPhysicalMemoryUnsafe]] || uintptr_t address, size_t size
|-
| [5.0.0+] 0x4A || Result || [[#SetUnsafeLimit|SetUnsafeLimit]] || size_t limit
|-
| [4.0.0+] 0x4B || Result || [[#CreateCodeMemory|CreateCodeMemory]] || Handle *out_handle, uintptr_t address, size_t size
|-
| [4.0.0+] 0x4C || Result || [[#ControlCodeMemory|ControlCodeMemory]] || Handle code_memory_handle, CodeMemoryOperation operation, uint64_t address, uint64_t size, MemoryPermission perm
|-
| 0x4D || void || [[#SleepSystem|SleepSystem]] ||
|-
| 0x4E || Result || [[#ReadWriteRegister|ReadWriteRegister]] || uint32_t *out_value, PhysicalAddress address, uint32_t mask, uint32_t value
|-
| 0x4F || Result || [[#SetProcessActivity|SetProcessActivity]] || Handle process_handle, ProcessActivity process_activity
|-
| 0x50 || Result || [[#CreateSharedMemory|CreateSharedMemory]] || Handle *out_handle, size_t size, MemoryPermission owner_perm, MemoryPermission remote_perm
|-
| 0x51 || Result || [[#MapTransferMemory|MapTransferMemory]] || Handle trmem_handle, uintptr_t address, size_t size, MemoryPermission owner_perm
|-
| 0x52 || Result || [[#UnmapTransferMemory|UnmapTransferMemory]] || Handle trmem_handle, uintptr_t address, size_t size
|-
| 0x53 || Result || [[#CreateInterruptEvent|CreateInterruptEvent]] || Handle *out_read_handle, int32_t interrupt_id, InterruptType interrupt_type
|-
| 0x54 || Result || [[#QueryPhysicalAddress|QueryPhysicalAddress]] || arch::PhysicalMemoryInfo *out_info, uintptr_t address
|-
| 0x55 || Result || [[#QueryIoMapping|QueryIoMapping]] || uintptr_t *out_address, [10.0.0+] size_t *out_size, PhysicalAddress physical_address, size_t size
|-
| 0x56 || Result || [[#CreateDeviceAddressSpace|CreateDeviceAddressSpace]] || Handle *out_handle, uint64_t das_address, uint64_t das_size
|-
| 0x57 || Result || [[#AttachDeviceAddressSpace|AttachDeviceAddressSpace]] || DeviceName device_name, Handle das_handle
|-
| 0x58 || Result || [[#DetachDeviceAddressSpace|DetachDeviceAddressSpace]] || DeviceName device_name, Handle das_handle
|-
| 0x59 || Result || [[#MapDeviceAddressSpaceByForce|MapDeviceAddressSpaceByForce]] || Handle das_handle, Handle process_handle, uint64_t process_address, size_t size, uint64_t device_address, uint32_t option
|-
| 0x5A || Result || [[#MapDeviceAddressSpaceAligned|MapDeviceAddressSpaceAligned]] || Handle das_handle, Handle process_handle, uint64_t process_address, size_t size, uint64_t device_address, uint32_t option
|-
| [1.0.0-12.1.0] 0x5B || Result || [[#MapDeviceAddressSpace|MapDeviceAddressSpace]] || size_t *out_mapped_size, Handle das_handle, Handle process_handle, uint64_t process_address, size_t size, uint64_t device_address, MemoryPermission device_perm
|-
| 0x5C || Result || [[#UnmapDeviceAddressSpace|UnmapDeviceAddressSpace]] || Handle das_handle, Handle process_handle, uint64_t process_address, size_t size, uint64_t device_address
|-
| 0x5D || Result || [[#InvalidateProcessDataCache|InvalidateProcessDataCache]] || Handle process_handle, uint64_t address, uint64_t size
|-
| 0x5E || Result || [[#StoreProcessDataCache|StoreProcessDataCache]] || Handle process_handle, uint64_t address, uint64_t size
|-
| 0x5F || Result || [[#FlushProcessDataCache|FlushProcessDataCache]] || Handle process_handle, uint64_t address, uint64_t size
|-
| 0x60 || Result || [[#DebugActiveProcess|DebugActiveProcess]] || Handle *out_handle, uint64_t process_id
|-
| 0x61 || Result || [[#BreakDebugProcess|BreakDebugProcess]] || Handle debug_handle
|-
| 0x62 || Result || [[#TerminateDebugProcess|TerminateDebugProcess]] || Handle debug_handle
|-
| 0x63 || Result || [[#GetDebugEvent|GetDebugEvent]] || arch::DebugEventInfo *out_info, Handle debug_handle
|-
| 0x64 || Result || [[#ContinueDebugEvent|ContinueDebugEvent]] || Handle debug_handle, uint32_t flags, const uint64_t *thread_ids, int32_t num_thread_ids
|-
| 0x65 || Result || [[#GetProcessList|GetProcessList]] || int32_t *out_num_processes, uint64_t *out_process_ids, int32_t max_out_count
|-
| 0x66 || Result || [[#GetThreadList|GetThreadList]] || int32_t *out_num_threads, uint64_t *out_thread_ids, int32_t max_out_count, Handle debug_handle
|-
| 0x67 || Result || [[#GetDebugThreadContext|GetDebugThreadContext]] || ThreadContext *out_context, Handle debug_handle, uint64_t thread_id, uint32_t context_flags
|-
| 0x68 || Result || [[#SetDebugThreadContext|SetDebugThreadContext]] || Handle debug_handle, uint64_t thread_id, const ThreadContext *context, uint32_t context_flags
|-
| 0x69 || Result || [[#QueryDebugProcessMemory|QueryDebugProcessMemory]] || arch::MemoryInfo *out_memory_info, PageInfo *out_page_info, Handle process_handle, uintptr_t address
|-
| 0x6A || Result || [[#ReadDebugProcessMemory|ReadDebugProcessMemory]] || uintptr_t buffer, Handle debug_handle, uintptr_t address, size_t size
|-
| 0x6B || Result || [[#WriteDebugProcessMemory|WriteDebugProcessMemory]] || Handle debug_handle, uintptr_t buffer, uintptr_t address, size_t size
|-
| 0x6C || Result || [[#SetHardwareBreakPoint|SetHardwareBreakPoint]] || HardwareBreakPointRegisterName name, uint64_t flags, uint64_t value
|-
| 0x6D || Result || [[#GetDebugThreadParam|GetDebugThreadParam]] || uint64_t *out_64, uint32_t *out_32, Handle debug_handle, uint64_t thread_id, DebugThreadParam param
|- style="border-top: double"
| [5.0.0+] 0x6F || Result || [[#GetSystemInfo|GetSystemInfo]] || uint64_t *out, SystemInfoType info_type, Handle handle, uint64_t info_subtype
|-
| 0x70 || Result || [[#CreatePort|CreatePort]] || Handle *out_server_handle, Handle *out_client_handle, int32_t max_sessions, bool is_light, uintptr_t name
|-
| 0x71 || Result || [[#ManageNamedPort|ManageNamedPort]] || Handle *out_server_handle, const char *name, int32_t max_sessions
|-
| 0x72 || Result || [[#ConnectToPort|ConnectToPort]] || Handle *out_handle, Handle port
|-
| 0x73 || Result || [[#SetProcessMemoryPermission|SetProcessMemoryPermission]] || Handle process_handle, uint64_t address, uint64_t size, MemoryPermission perm
|-
| 0x74 || Result || [[#MapProcessMemory|MapProcessMemory]] || uintptr_t dst_address, Handle process_handle, uint64_t src_address, size_t size
|-
| 0x75 || Result || [[#UnmapProcessMemory|UnmapProcessMemory]] || uintptr_t dst_address, Handle process_handle, uint64_t src_address, size_t size
|-
| 0x76 || Result || [[#QueryProcessMemory|QueryProcessMemory]] || arch::MemoryInfo *out_memory_info, PageInfo *out_page_info, Handle process_handle, uint64_t address
|-
| 0x77 || Result || [[#MapProcessCodeMemory|MapProcessCodeMemory]] || Handle process_handle, uint64_t dst_address, uint64_t src_address, uint64_t size
|-
| 0x78 || Result || [[#UnmapProcessCodeMemory|UnmapProcessCodeMemory]] || Handle process_handle, uint64_t dst_address, uint64_t src_address, uint64_t size
|-
| 0x79 || Result || [[#CreateProcess|CreateProcess]] || Handle *out_handle, const arch::CreateProcessParameter *parameters, const uint32_t *caps, int32_t num_caps
|-
| 0x7A || Result || [[#StartProcess|StartProcess]] || Handle process_handle, int32_t priority, int32_t core_id, uint64_t main_thread_stack_size
|-
| 0x7B || Result || [[#TerminateProcess|TerminateProcess]] || Handle process_handle
|-
| 0x7C || Result || [[#GetProcessInfo|GetProcessInfo]] || int64_t *out_info, Handle process_handle, ProcessInfoType info_type
|-
| 0x7D || Result || [[#CreateResourceLimit|CreateResourceLimit]] || Handle *out_handle
|-
| 0x7E || Result || [[#SetResourceLimitLimitValue|SetResourceLimitLimitValue]] || Handle resource_limit_handle, LimitableResource which, int64_t limit_value
|-
| 0x7F || void || [[#CallSecureMonitor|CallSecureMonitor]] || SecureMonitorArguments *args
|- style="border-top: double"
| [15.0.0+] 0x90 || Result || MapInsecureMemory || uintptr_t address, size_t size
|-
| [15.0.0+] 0x91 || Result || UnmapInsecureMemory || uintptr_t address, size_t size
|-
|}

== SetHeapSize ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X1 || uint64_t || Size
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) X1 || void* || HeapAddress
|}
</div>

Sets the process heap to a given Size. It can both extend and shrink the heap.

Size must be a multiple of 0x200000 (2MB).

On success, the heap base-address (which is fixed by kernel, aslr'd, and always in the Heap memory region) is written to HeapAddress.

Uses current process pool partition. The memory allocated counts towards the caller's process Memory ResourceLimit.

[2.0.0+] Size must be less than or equal to 4GB.

=== Result codes ===
'''0x0:''' Success.

'''0xCA01:''' Invalid size passed. It's either bigger than 4GB, or misaligned.

'''0xD001:''' Size is bigger than the Heap Region size.

'''0xCE01:''' KMemoryBlockAllocator slab allocator exhausted.

'''0xD401:''' The memory region is in an invalid state. Likely because a mapping was made in the heap region.

'''0x10801:''' Memory resource limit reached.

== SetMemoryPermission ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || void* || Address
|-
| (In) X1 || uint64_t || Size
|-
| (In) W2 || [[#MemoryPermission]] || MemoryPermission
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

Changes permission of page-aligned memory region.

Bit2 of permission (exec) is not allowed. Setting write-only is not allowed either (bit1).

This can be used to move back and forth between ---, r-- and rw-.

=== Result codes ===
'''0x0:''' Success. The memory region was reprotected.

'''0xCC01:''' Unaligned address specified.

'''0xCA01:''' Unaligned or zero size specified.

'''0xD401:''' The provided memory region does not fall within the userland address space.

'''0xD801:''' Invalid permission specified. Valid permissions are ---, r-- and rw-.

'''0xD401:''' The provided memory region was in an invalid state. The region must have the [[#MemoryState|FlagCanReprotect]] state, and must not have the [[#MemoryAttribute|Locked]] or [[#MemoryAttribute|Uncached]] attributes.

'''0xCE01:''' Kernel resource exhausted.

== SetMemoryAttribute ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || void* || Address
|-
| (In) X1 || uint64_t || Size
|-
| (In) W2 || uint32_t || Mask
|-
| (In) W3 || uint32_t || Value
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

Changes attribute of page-aligned memory region. The only allowed combination of Value and Mask is 0x8, which means only bit3 in [[#MemoryAttribute]] can be set or cleared.

This is used to turn on/off caching for a given memory area. Useful when talking to devices such as the GPU.

What happens "under the hood" is the "Memory Attribute Indirection Register" index is changed from 2 to 3 in the MMU descriptor.

== MapMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || void* || DstAddress
|-
| (In) X1 || void* || SrcAddress
|-
| (In) X2 || uint64_t || Size
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

Maps a memory range into a different range.

Mainly used for adding guard pages around stack.

Source range gets reprotected to --- (it can no longer be accessed), and bit0 is set in the source [[#MemoryAttribute]].

[1.0.0] This could be used to map into either the Alias Region or the Stack region.

[2.0.0+] This can only be used to map into the Stack region.

Code can get the range of the Alias region from [[#GetInfo]] id0=2,3, and on 2.0.0+ the range of the Stack region via [[#GetInfo]] id0=14, 15 (on 1.0.0, the Stack region had hardcoded limits).

When mapped into the Alias region, the mapped memory will have state 0x482907.

When mapped into the Stack region, the mapped memory will have state 0x5C3C0B.

== UnmapMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || void* || DstAddress
|-
| (In) X1 || void* || SrcAddress
|-
| (In) X2 || uint64_t || Size
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

Unmaps a region that was previously mapped with [[#MapMemory]].

It's possible to unmap ranges partially, you don't need to unmap the entire range "in one go".

The srcaddr/dstaddr must match what was given when the pages were originally mapped.

== QueryMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || [[#MemoryInfo]]* || MemoryInfo
|-
| (In) X2 || void* || Address
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) W1 || [[#PageInfo]] || PageInfo
|}
</div>

Queries information about an address. Will always fetch the lowest page-aligned mapping that contains the provided address.

Outputs a [[#MemoryInfo]] struct.

== ExitProcess ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) None || ||
|-
| (Out) None || ||
|}
</div>

Exits the current process.

== CreateThread ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X1 || R1 || void(*)(void*) || Entry
|-
| (In) X2 || R2 || void* || ThreadContext
|-
| (In) X3 || R3 || void* || StackTop
|-
| (In) W4 || R0 || int32_t || Priority
|-
| (In) W5 || R4 || int32_t || ProcessorId
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) W1 || R1 || Handle<Thread> || ThreadHandle
|}
</div>

Creates a thread in the current process.

ProcessorId must be 0,1,2,3 or -2, where -2 uses the default CpuId for process.

== StartThread ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<Thread> || ThreadHandle
|-
| (Out) None || ||
|}
</div>

Starts the thread for the provided handle.

== ExitThread ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) None || ||
|-
| (Out) None || ||
|}
</div>

Exits the current thread.

== SleepThread ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X0 || R0, R1 || uint64_t || Nanoseconds
|}
</div>

Sleeps for a specified amount of time, or yields the thread.

Setting nanoseconds to 0, -1, or -2 indicates a yielding type.

<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Value || Type
|-
| 0 || Yielding without core migration
|-
| -1 || Yielding with core migration
|-
| -2 || Yielding to any other thread
|}
</div>

== GetThreadPriority ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W1|| Handle<Thread> || ThreadHandle
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) W1 || int32_t || Priority
|}
</div>

Gets the priority of provided thread handle.

== SetThreadPriority ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0|| Handle<Thread> || ThreadHandle
|-
| (In) W1|| int32_t || Priority
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

Sets the priority of provided thread handle.

Priority is a number 0-0x3F. Lower value means higher priority.

== GetThreadCoreMask ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W2 || R2 || Handle<Thread> || ThreadHandle
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) W1 || R1 || int32_t || CoreMask0
|-
| (Out) X2 || R2, R3 || uint64_t || CoreMask1
|}
</div>

Gets the affinity mask of provided thread handle.

== SetThreadCoreMask ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R0 || Handle<Thread> || ThreadHandle
|-
| (In) W1 || R1 || int32_t || CoreMask0
|-
| (In) X2 || R2, R3 || uint64_t || CoreMask1
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

Sets the affinity mask of provided thread handle.

== GetCurrentProcessorNumber ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) None || ||
|-
| (Out) W0 || uint32_t || CpuId
|}
</div>

Gets which cpu is executing the current thread.

CpuId is an integer in the range 0-3.

== SignalEvent ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<WritableEvent> || EventHandle
|-
| (Out) X0 || [[#Result]] || Result
|}
</div>

Puts the given event in the signaled state.

Will wake up any thread currently waiting on this event. Can potentially trigger a reschedule.

Any calls to [[#WaitSynchronization]] on this handle will return immediately, until the event's signaled state is reset.

=== Result codes ===
'''0x0:''' Success. Event is now in signaled state.

'''0xE401:''' Invalid handle. The handle either does not exist, or is not a WritableEvent.

== ClearEvent ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<WritableEvent> or Handle<ReadableEvent> || EventHandle
|-
| (Out) X0 || [[#Result]] || Result
|}
</div>

Takes the given event out of the signaled state, if it is signaled.

=== Result codes ===
'''0x0:''' Success, the event is now in the not-signaled state.

'''0xE401:''' Invalid handle. The handle either does not exist, or is not a ReadableEvent nor a WritableEvent.

== MapSharedMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<SharedMemory> || SharedMemoryHandle
|-
| (In) X1 || void* || Address
|-
| (In) X2 || uint64_t || Size
|-
| (In) W3 || [[#MemoryPermission]] || MemoryPermission
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

Maps the block supplied by the handle. The required permissions are different for the process that created the handle and all other processes.

Increases reference count for the KSharedMemory object. Thus in order to release the memory associated with the object, all handles to it must be closed and all mappings must be unmapped.

== UnmapSharedMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<SharedMemory> || SharedMemoryHandle
|-
| (In) X1 || void* || Address
|-
| (In) X2 || uint64_t || Size
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== CreateTransferMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X1 || void* || Address
|-
| (In) X2 || uint64_t || Size
|-
| (In) W3 || [[#MemoryPermission]] || MemoryPermission
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) W1 || Handle<TransferMemory> || TransferMemoryHandle
|}
</div>

This one reprotects the src block with perms you give it. It also sets bit0 into [[#MemoryAttribute]].

Executable bit perm not allowed.

Closing all handles automatically causes the bit0 in [[#MemoryAttribute]] to clear, and the permission to reset.

== CloseHandle ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle || Handle
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== ResetSignal ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<ReadableEvent> or Handle<Process> || Handle
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

Resets the signal on the given handle, ensuring future calls to [[#WaitSynchronization]] on this handle will sleep until the handle is signaled again. If the handle is a ReadableEvent, this is equivalent to calling ClearEvent() on the handle.

If the handle is a Process, it will clear the signaled state (which is set when the process changes [[#ProcessState]]. Once the process enters the Exited state, calling ResetSignal on the process will no longer have an effect (the process is permanently signaled), and the syscall will return 0xFA01.

=== Result codes ===
'''0x0:''' Success. The signal was reset.

'''0xE401:''' The handle is invalid or of the wrong type.

'''0xFA01:''' The handle was not signaled, or the process is in exited state, causing it to be permanently signaled.

== WaitSynchronization ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X1 || R1 || Handle* || HandlesPtr
|-
| (In) W2 || R2 || int32_t || HandlesNum
|-
| (In) X3 || R0, R3 || int64_t || Timeout
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) W1 || R1 || uint64_t || HandleIndex
|}
</div>

Works with HandlesNum <= 0x40.

When zero handles are passed, this will wait forever until either timeout or cancellation occurs.

Does not accept 0xFFFF8001 or 0xFFFF8000 as handles.

=== Object types ===
'''KDebug:''' signals when there is a new [[#DebugEventInfo|DebugEvent]] (retrievable via [[#GetDebugEvent]]).

'''KClientPort:''' signals when the number of sessions is less than the maximum allowed.

'''KProcess:''' signals when the process undergoes a state change (retrievable via [[#GetProcessInfo]]).

'''KReadableEvent:''' signals when the event's corresponding KWritableEvent has been signaled via [[#SignalEvent]].

'''KServerPort:''' signals when there is an incoming connection waiting to be [[#AcceptSession|accepted]].

'''KServerSession:''' signals when there is an incoming message waiting to be [[#ReplyAndReceive|received]] or the pipe is closed.

'''KThread:''' signals when the thread has exited.

=== Result codes ===
'''0x0:''' Success. One of the objects was signaled before the timeout expired, or one of the objects is a Session with a closed remote. Handle index is updated to indicate which object signaled.

'''0x7601:''' Thread termination requested. Handle index is not updated.

'''0xe401:''' Invalid handle. Returned when one of the handles passed is invalid. Handle index is not updated.

'''0xe601:''' Invalid address. Returned when the handles pointer is not a readable address. Handle index is not updated.

'''0xea01:''' Timeout. Returned when no objects have been signaled within the timeout. Handle index is not updated.

'''0xec01:''' Interrupted. Returned when another thread uses [[#CancelSynchronization]] to cancel this thread. Handle index is not updated.

'''0xee01:''' Too many handles. Returned when the number of handles passed is > 0x40.

== CancelSynchronization ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<Thread> || ThreadHandle
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

If the referenced thread is currently in a synchronization call ([[#WaitSynchronization]], [[#ReplyAndReceive]] or [[#ReplyAndReceiveLight]]), that call will be interrupted and return 0xec01.
If that thread is not currently executing such a synchronization call, the next call to a synchronization call will return 0xec01.

This doesn't take force-pause (activity/debug pause) into account.

=== Result codes ===
'''0x0:''' Success. The thread was either interrupted or has had its flag set.

'''0xe401:''' Invalid handle. The handle given was either invalid or not a thread handle.

== ArbitrateLock ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<Thread> || ThreadHandle
|-
| (In) X1 || void* || Address
|-
| (In) W2 || uint32_t || Tag
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== ArbitrateUnlock ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || void* || Address
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== WaitProcessWideKeyAtomic ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X0 || R0 || void* || KeyAddress
|-
| (In) X1 || R1 || void* || TagAddress
|-
| (In) W2 || R2 || uint32_t || Tag
|-
| (In) X3 || R3, R4 || int64_t || Timeout
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

== SignalProcessWideKey ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || void* || Address
|-
| (In) W1 || int32_t || Value
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== GetSystemTick ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (Out) X0 || R0, R1 || uint64_t || Ticks
|}
</div>

Returns the value of cntpct_el0.

The frequency is 19200000 Hz (constant from official sw).

Official sw reads cntpct_el0 directly from usermode without using this SVC. [[ExeFS|sdk-nso]] has this SVC, but it's not known to be called anywhere.

== ConnectToNamedPort ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X1 || char* || PortName
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) W1 || Handle<Session> || SessionHandle
|}
</div>

== SendSyncRequestLight ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<Session> || SessionHandle
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== SendSyncRequest ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<Session> || SessionHandle
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== SendSyncRequestWithUserBuffer ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || void* || Address
|-
| (In) X1 || uint64_t || Size
|-
| (In) W2 || Handle<Session> || SessionHandle
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

Size and Address must be 0x1000-aligned.

=== Result codes ===
'''0x0:''' Success.

'''0xcc01:''' Address is not 0x1000-aligned.

'''0xca01:''' Size is not 0x1000-aligned.

'''0xce01:''' KSessionRequest allocation failed (unlikely) or pointer buffer size exceeded.

'''0xe401:''' Handles does not exist, or handle is not an instance of KClientSession.

== SendAsyncRequestWithUserBuffer ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X1 || void* || Address
|-
| (In) X2 || uint64_t || Size
|-
| (In) W3 || Handle<Session> || SessionHandle
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) W1 || Handle<ReadableEvent> || EventHandle
|}
</div>

Size and Address must be 0x1000-aligned.

== GetProcessId ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W1 || R1 || Handle<Process> || ProcessHandle
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) X1 || R1, R2 || uint64_t || ProcessId
|}
</div>

== GetThreadId ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W1 || R1 || Handle<Thread> || ThreadHandle
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) X1 || R1, R2 || uint64_t || ThreadId
|}
</div>

== Break ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || [[#BreakReason]] || BreakReason
|-
| (In) X1 || uint64_t ||
|-
| (In) X2 || uint64_t || Info
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

If the process is attached, report the Break event. Then, if [[#ContinueDebugEvent]] didn't apply IgnoreException on the thread: if TPIDR_EL0 is 0, adjust ELR_EL1 to retry to svc instruction (and set TPIDR_EL0 to 1).

Otherwise, if bit31 in reason isn't set, perform crash reporting (see Exception Handling section below), if it doesn't terminate the process adjust ELR_EL1 as well.

Otherwise just return 0.

== OutputDebugString ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || char* || String
|-
| (In) X1 || uint64_t || Size
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== ReturnFromException ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || [[#Result]] || Result
|}
</div>

== GetInfo ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W1 || R1 || [[#InfoType]] || InfoType
|-
| (In) W2 || R2 || Handle || Handle
|-
| (In) X3 || R0, R3 || uint64_t || InfoSubType
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) X1 || R1, R2 || uint64_t || Info
|}
</div>

== FlushEntireDataCache ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) None || ||
|-
| (Out) None || ||
|}
</div>

== FlushDataCache ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || void* || Address
|-
| (In) X1 || uint64_t || Size
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== MapPhysicalMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || void* || Address
|-
| (In) X1 || uint64_t || Size
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

Acts like [[#SetHeapSize]] except you can allocate heap at any address you'd like.

Uses current process pool partition.

=== Result codes ===
'''0x0:''' Success.

'''0xCA01:''' Invalid size passed. It's either zero or not 4k-aligned

'''0xCC01:''' Invalid address. (not 4k-aligned)

'''0xDC01:''' Invalid memory range. It's either causes overflow, or does not fall into "reserved" address range (aka Alias). See AliasRegionAddress at [[#InfoType]]

'''0xFA01:''' Invalid state. (not enough SystemResource (see [[NPDM#SystemResourceSize]]))

== UnmapPhysicalMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || void* || Address
|-
| (In) X1 || uint64_t || Size
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== GetDebugFutureThreadInfo ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X3 || R0, R1 || uint64_t || Timeout
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) X1 || uint64_t || LastThreadContextParam0
|-
| (Out) X2 || uint64_t || LastThreadContextParam1
|-
| (Out) X3 || uint64_t || LastThreadContextParam2
|-
| (Out) X4 || uint64_t || LastThreadContextParam3
|-
| (Out) X5 || uint64_t ||
|-
| (Out) W6 || uint32_t ||
|}
</div>

== GetLastThreadInfo ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) None || ||
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) X1 || uint64_t || LastThreadContextParam0
|-
| (Out) X2 || uint64_t || LastThreadContextParam1
|-
| (Out) X3 || uint64_t || LastThreadContextParam2
|-
| (Out) X4 || uint64_t || LastThreadContextParam3
|-
| (Out) X5 || uint64_t ||
|-
| (Out) W6 || uint32_t ||
|}
</div>

== GetResourceLimitLimitValue ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W1 || R1 || Handle<ResourceLimit> || ResourceLimitHandle
|-
| (In) W2 || R2 || [[#LimitableResource]] || LimitableResource
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) X1 || R1, R2 || int64_t || LimitValue
|}
</div>

== GetResourceLimitCurrentValue ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W1 || R1 || Handle<ResourceLimit> || ResourceLimitHandle
|-
| (In) W2 || R2 || [[#LimitableResource]] || LimitableResource
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) X1 || R1, R2 || int64_t || CurrentValue
|}
</div>

== SetThreadActivity ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<Thread> || ThreadHandle
|-
| (In) W1 || [[#ThreadActivity]] || ThreadActivity
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== GetThreadContext3 ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || [[#ThreadContext]]* || ThreadContext
|-
| (In) W1 || Handle<Thread> || ThreadHandle
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== WaitForAddress ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X0 || R0 || void* || Address
|-
| (In) W1 || R1 || [[#ArbitrationType]] || ArbitrationType
|-
| (In) W2 || R2 || uint32_t || Value
|-
| (In) X3 || R3, R4 || uint64_t || Timeout
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

== SignalToAddress ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X0 || R0 || void* || Address
|-
| (In) W1 || R1 || [[#SignalType]] || SignalType
|-
| (In) W2 || R2 || uint32_t || Value
|-
| (In) W3 || R3 || uint32_t || NumToSignal
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

== SynchronizePreemptionState ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) None || ||
|-
| (Out) None || ||
|}
</div>

== GetResourceLimitPeakValue ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W1 || R1 || Handle<ResourceLimit> || ResourceLimitHandle
|-
| (In) W2 || R2 || [[#LimitableResource]] || LimitableResource
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) X1 || R1, R2 || int64_t || PeakValue
|}
</div>

== DumpInfo ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || [[#DumpInfoType]] || DumpInfoType
|-
| (In) X1 || uint64_t || DumpInfoSubType
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

Stubbed in retail kernel.

[4.0.0+] This function was removed and replaced by [[#KernelDebug]].

== KernelDebug ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || [[#KernelDebugType]] || KernelDebugType
|-
| (In) X1 || uint64_t ||
|-
| (In) X2 || uint64_t ||
|-
| (In) X3 || uint64_t ||
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

Stubbed in retail kernel.

== ChangeKernelTraceState ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || [[#KernelTraceState]] || KernelTraceState
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

Stubbed in retail kernel.

== CreateSession ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W2 || bool || IsLight
|-
| (In) X3 || uint64_t || Name
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) W1 || Handle<ServerSession> || ServerSessionHandle
|-
| (Out) W2 || Handle<ClientSession> || ClientSessionHandle
|}
</div>

== AcceptSession ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W1 || Handle<Port> || PortHandle
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) W1 || Handle<ServerSession> || ServerSessionHandle
|}
</div>

=== Result codes ===
'''0xf201:''' No session waiting to be accepted

== ReplyAndReceiveLight ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<Port> or Handle<ServerSession> || Handle
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== ReplyAndReceive ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X1 || R1 || Handle<Port>* or Handle<ServerSession>* || Handles
|-
| (In) W2 || R2 || uint32_t || NumHandles
|-
| (In) W3 || R3 || Handle<ServerSession> || ReplyTargetSessionHandle
|-
| (In) X4 || R0, R4 || uint64_t || Timeout
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) W1 || R1 || uint32_t || HandleIndex
|}
</div>

If ReplyTargetSessionHandle is not zero, a reply from the TLS will be sent to that session.
Then it will wait until either of the passed sessions has an incoming message, is closed, a passed port has an incoming connection, or the timeout expires.
If there is an incoming message, it is copied to the TLS.

If ReplyTargetSessionHandle is zero, the TLS should contain a blank message. If this message has a C descriptor, the buffer it points to will be used as the pointer buffer. See [[IPC_Marshalling#IPC_buffers]]. Note that a pointer buffer cannot be specified if ReplyTargetSessionHandle is not zero.

After being validated, passed handles will be enumerated in order; even if a session has been closed, if one that appears earlier in the list has an incoming message, it will take priority and a result code of 0x0 will be returned.

=== Result codes ===
'''0x0:''' Success. Either a session has an incoming message or a port has an incoming connection. HandleIndex is set appropriately.

'''0xea01:''' Timeout. No handles were signalled before the timeout expired. HandleIndex is not updated.

'''0xf601:''' Port remote dead. One of the sessions has been closed. HandleIndex is set appropriately.

== ReplyAndReceiveWithUserBuffer ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X1 || R1 || void* || Address
|-
| (In) X2 || R2 || uint64_t || Size
|-
| (In) X3 || R3 || Handle<Port>* or Handle<ServerSession>* || Handles
|-
| (In) W4 || R0 || uint32_t || NumHandles
|-
| (In) W5 || R4 || Handle<ServerSession> || ReplyTargetSessionHandle
|-
| (In) X6 || R5, R6 || uint64_t || Timeout
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) W1 || R1 || uint32_t || HandleIndex
|}
</div>

== CreateEvent ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) None || ||
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) W1 || Handle<WritableEvent> || WritableEventHandle
|-
| (Out) W2 || Handle<ReadableEvent> || ReadableEventHandle
|}
</div>

== MapPhysicalMemoryUnsafe ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || void* || Address
|-
| (In) X1 || uint64_t || Size
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

Same as [[#MapPhysicalMemory]] except it always uses pool partition 0.

== UnmapPhysicalMemoryUnsafe ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || void* || Address
|-
| (In) X1 || uint64_t || Size
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== SetUnsafeLimit ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || uint64_t || Limit
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== CreateCodeMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X1 || void* || Address
|-
| (In) X2 || uint64_t || Size
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) W1 || Handle<CodeMemory> || CodeMemoryHandle
|}
</div>

Takes an address range with backing memory to create the code memory object.

The memory is initially memset to 0xFF after being locked.

== ControlCodeMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R0 || Handle<CodeMemory> || CodeMemoryHandle
|-
| (In) W1 || R1 || [[#CodeMemoryOperation]] || CodeMemoryOperation
|-
| (In) X2 || R2, R3 || void* || Address
|-
| (In) X3 || R4, R5 || uint64_t || Size
|-
| (In) W4 || R6 || [[#MemoryPermission]] || MemoryPermission
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

Maps the backing memory for a CodeMemory object into the current process.

For [[#CodeMemoryOperation|MapOwner]], memory permission must be RW-.

For [[#CodeMemoryOperation|MapSlave]], memory permission must be R-- or R-X.

Operations [[#CodeMemoryOperation|UnmapOwner/UnmapSlave]] unmap memory that was previously mapped this way.

This allows one "secure JIT" process to map the code memory as RW-, and the other "slave" process to map it R-X.

[5.0.0+] Error 0xE401 is now returned when the process owner of the Code memory object is the same as the current process.

== SleepSystem ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) None || ||
|-
| (Out) None || ||
|}
</div>

== ReadWriteRegister ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X1 || R2, R3 || uint64_t || RegisterAddress
|-
| (In) W2 || R0 || uint32_t || RwMask
|-
| (In) W3 || R1 || uint32_t || InValue
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) W1 || R1 || uint32_t || OutValue
|}
</div>

Read/write IO registers with a hardcoded whitelist. Input address is physical-address and must be aligned to 4.

rw_mask is 0 for reading and 0xffffffff for writing. You can also write individual bits by using a mask value.

You can only write to registers inside physical pages 0x70019000 (MC), 0x7001C000 (MC0), 0x7001D000 (MC1), and they all share the same whitelist.

The whitelist is same for writing as for reading.

The whitelist is:

0x054, 0x090, 0x094, 0x098, 0x09c, 0x0a0, 0x0a4, 0x0a8, 0x0ac, 0x0b0, 0x0b4, 0x0b8, 0x0bc, 0x0c0, 0x0c4, 0x0c8, 0x0d0, 0x0d4, 0x0d8, 0x0dc, 0x0e0, 0x100, 0x108, 0x10c, 0x118, 0x11c, 0x124, 0x128, 0x12c, 0x130, 0x134, 0x138, 0x13c, 0x158, 0x15c, 0x164, 0x168, 0x16c, 0x170, 0x174, 0x178, 0x17c, 0x200, 0x204, 0x2e4, 0x2e8, 0x2ec, 0x2f4, 0x2f8, 0x310, 0x314, 0x320, 0x328, 0x344, 0x348, 0x370, 0x374, 0x37c, 0x380, 0x390, 0x394, 0x398, 0x3ac, 0x3b8, 0x3bc, 0x3c0, 0x3c4, 0x3d8, 0x3e8, 0x41c, 0x420, 0x424, 0x428, 0x42c, 0x430, 0x44c, 0x47c, 0x480, 0x484, 0x50c, 0x554, 0x558, 0x55c, 0x670, 0x674, 0x690, 0x694, 0x698, 0x69c, 0x6a0, 0x6a4, 0x6c0, 0x6c4, 0x6f0, 0x6f4, 0x960, 0x970, 0x974, 0xa20, 0xa24, 0xb88, 0xb8c, 0xbc4, 0xbc8, 0xbcc, 0xbd0, 0xbd4, 0xbd8, 0xbdc, 0xbe0, 0xbe4, 0xbe8, 0xbec, 0xc00, 0xc5c, 0xcac

[2.0.0+] Whitelist was extended with 0x4c4, 0x4c8, 0x4cc, 0x584, 0x588, 0x58c.

[2.0.0+] The IO registers in range 0x7000E400 (PMC) size 0xC00 skip the whitelist, and do a TrustZone call using [[SMC#ReadWriteRegister|ReadWriteRegister]].

[4.0.0+] Access to the Memory Controller (0x70019000) also uses smcReadWriteRegister.

Here is the whitelist imposed by that SMC, relative to the start of the PMC registers:

0x000, 0x00c, 0x010, 0x014, 0x01c, 0x020, 0x02c, 0x030, 0x034, 0x038, 0x03c, 0x040, 0x044, 0x048, 0x0dc, 0x0e0, 0x0e4, 0x160, 0x164, 0x168, 0x170, 0x1a8, 0x1b8, 0x1bc, 0x1c0, 0x1c4, 0x1c8, 0x2b4, 0x2d4, 0x440, 0x4d8

Here is the whitelist imposed by the SMC [[SMC#ReadWriteRegister|ReadWriteRegister]] (checked in addition to the whitelist in the ReadWriteRegister SVC), relative to the start of the MC registers:

0x000, 0x004, 0x008, 0x00C, 0x010, 0x01C, 0x020, 0x030, 0x034, 0x050, 0x054, 0x090, 0x094, 0x098, 0x09C, 0x0A0, 0x0A4, 0x0A8, 0x0AC, 0x0B0, 0x0B4, 0x0B8, 0x0BC, 0x0C0, 0x0C4, 0x0C8, 0x0D0, 0x0D4, 0x0D8, 0x0DC, 0x0E0, 0x100, 0x108, 0x10C, 0x118, 0x11C, 0x124, 0x128, 0x12C, 0x130, 0x134, 0x138, 0x13C, 0x158, 0x15C, 0x164, 0x168, 0x16C, 0x170, 0x174, 0x178, 0x17C, 0x200, 0x204, 0x238, 0x240, 0x244, 0x250, 0x254, 0x258, 0x264, 0x268, 0x26C, 0x270, 0x274, 0x280, 0x284, 0x288, 0x28C, 0x294, 0x2E4, 0x2E8, 0x2EC, 0x2F4, 0x2F8, 0x310, 0x314, 0x320, 0x328, 0x344, 0x348, 0x370, 0x374, 0x37C, 0x380, 0x390, 0x394, 0x398, 0x3AC, 0x3B8, 0x3BC, 0x3C0, 0x3C4, 0x3D8, 0x3E8, 0x41C, 0x420, 0x424, 0x428, 0x42C, 0x430, 0x44C, 0x47C, 0x480, 0x484, 0x4C4, 0x4C8, 0x4CC, 0x50C, 0x554, 0x558, 0x55C, 0x584, 0x588, 0x58C, 0x670, 0x674, 0x690, 0x694, 0x698, 0x69C, 0x6A0, 0x6A4, 0x6C0, 0x6C4, 0x6F0, 0x6F4, 0x960, 0x970, 0x974, 0x9B8, 0xA20, 0xA24, 0xA88, 0xA94, 0xA98, 0xA9C, 0xAA0, 0xAA4, 0xAA8, 0xAAC, 0xAB0, 0xAB4, 0xAB8, 0xABC, 0xAC0, 0xAC4, 0xAC8, 0xACC, 0xAD0, 0xAD4, 0xAD8, 0xADC, 0xAE0, 0xB88, 0xB8C, 0xBC4, 0xBC8, 0xBCC, 0xBD0, 0xBD4, 0xBD8, 0xBDC, 0xBE0, 0xBE4, 0xBE8, 0xBEC, 0xC00, 0xC5C, 0xCAC

== SetProcessActivity ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<Process> || ProcessHandle
|-
| (In) W1 || [[#ProcessActivity]] || ProcessActivity
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== CreateSharedMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W1 || uint64_t || Size
|-
| (In) W2 || [[#MemoryPermission]] || LocalMemoryPermission
|-
| (In) W3 || [[#MemoryPermission]] || RemoteMemoryPermission
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) W1 || Handle<SharedMemory> || SharedMemoryHandle
|}
</div>

Other perm can be used to enforce permission 1, 3, or 0x10000000 if don't care.

Allocates memory from the current process' pool partition.

== MapTransferMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || Handle<TransferMemory> || TransferMemoryHandle
|-
| (In) X1 || void* || Address
|-
| (In) X2 || uint64_t || Size
|-
| (In) W3 || [[#MemoryPermission]] || MemoryPermission
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

You must pass same size and permissions as given in [[#CreateTransferMemory]], otherwise error.

== UnmapTransferMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || Handle<TransferMemory> || TransferMemoryHandle
|-
| (In) X1 || void* || Address
|-
| (In) X2 || uint64_t || Size
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

Size must match size given in map syscall, otherwise there's an invalid-size error.

== CreateInterruptEvent ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X1 || [[#Interrupt]] || Interrupt
|-
| (In) W2 || [[#InterruptType]] || InterruptType
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) W1 || Handle<ReadableEvent> || ReadableEventHandle
|}
</div>

Creates an event handle for the given IRQ number. Waiting on this handle will wait until the IRQ is triggered. The InterruptType argument configures the triggering. If it is 0, the IRQ is active HIGH level sensitive, if it is 1 it is rising-edge sensitive.

=== Result codes ===
'''0x0:''' Success.

'''0xF001:''' Flags was > 1

'''0xF201:''' IRQ above 0x3FF or outside the [[NPDM#Kernel_Access_Control|IRQ access mask]] was given.

'''0xCE01:''' A SlabHeap was exhausted (too many interrupts created).

'''0xF401:''' IRQ already has an event registered.

'''0xD201:''' The handle table is full. Try closing some handles.

== QueryPhysicalAddress ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X1 || void* || VirtualAddress
|-
| (Out) W0 || [[#Result]]|| Result
|-
| (Out) X1 || uint64_t || PhysicalMemoryInfoAddress
|-
| (Out) X2 || uint64_t || PhysicalMemoryInfoBaseAddress
|-
| (Out) X3 || uint64_t || PhysicalMemoryInfoSize
|}
</div>

Queries the physical address of a virtual address. Will always fetch the lowest page-aligned mapping that contains the provided physical address.

The returned PhysicalMemoryInfoBaseAddress is the virtual address of that page-aligned mapping, while PhysicalMemoryInfoAddress is the physical address of that page. PhysicalMemoryInfoSize is the amount of continuous physical memory in that mapping.

== QueryIoMapping ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X1 || R2, R3 || uint64_t || IoAddress
|-
| (In) X2 || R0 || uint64_t || Size
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) X1 || R1 || void* || VirtualAddress
|}
</div>

Returns a virtual address mapped to a given IO range.

== CreateDeviceAddressSpace ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X1 || R2, R3 || uint64_t || DeviceAddressSpaceStartAddress
|-
| (In) X2 || R0, R1 || uint64_t || DeviceAddressSpaceEndAddress
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) W1 || R1 || Handle<DeviceAddressSpace> || DeviceAddressSpaceHandle
|}
</div>

Creates a virtual address space for binding device address spaces and returns a handle.

StartAddr is normally set to 0 and EndAddr is normally set to 0xFFFFFFFF.

== AttachDeviceAddressSpace ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || [[#DeviceName]] || DeviceName
|-
| (In) X1 || Handle<DeviceAddressSpace> || DeviceAddressSpaceHandle
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

Attaches a device address space to a [[#DeviceName|device]].

== DetachDeviceAddressSpace ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || [[#DeviceName]] || DeviceName
|-
| (In) X1 || Handle<DeviceAddressSpace> || DeviceAddressSpaceHandle
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

Detaches a device address space from a [[#DeviceName|device]].

== MapDeviceAddressSpaceByForce ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R0 || Handle<DeviceAddressSpace> || DeviceAddressSpaceHandle
|-
| (In) W1 || R1 || Handle<Process> || ProcessHandle
|-
| (In) X2 || R2, R3 || void* || Address
|-
| (In) X3 || R4 || uint64_t || DeviceAddressSpaceSize
|-
| (In) X4 || R5, R6 || uint64_t || DeviceAddressSpaceAddress
|-
| (In) W5 || R7 || uint32_t || Option
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

Maps an attached device address space to an userspace address.

Address is the userspace destination address, while DeviceAddressSpaceAddress is the source address between DeviceAddressSpaceStartAddress and DeviceAddressSpaceEndAddress (passed to [[#CreateDeviceAddressSpace]]).

The userspace destination address must have the [[SVC#MemoryState|FlagCanDeviceMap]] bit set. Bit [[SVC#MemoryAttribute|DeviceShared]] will be set after mapping.

The Option encodes a [[#MemoryPermission]] in the low 16 bits, and an indicator of IO mapping in the high bits.

== MapDeviceAddressSpaceAligned ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R0 || Handle<DeviceAddressSpace> || DeviceAddressSpaceHandle
|-
| (In) W1 || R1 || Handle<Process> || ProcessHandle
|-
| (In) X2 || R2, R3 || void* || Address
|-
| (In) X3 || R4 || uint64_t || DeviceAddressSpaceSize
|-
| (In) X4 || R5, R6 || uint64_t || DeviceAddressSpaceAddress
|-
| (In) W5 || R7 || uint32_t || Option
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

Maps an attached device address space to an userspace address.

Same as [[#MapDeviceAddressSpaceByForce]], but the userspace destination address must have the [[SVC#MemoryState|FlagCanAlignedDeviceMap]] bit set instead.

The Option encodes a [[#MemoryPermission]] in the low 16 bits, and an indicator of IO mapping in the high bits.

== MapDeviceAddressSpace ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W1 || R1 || Handle<DeviceAddressSpace> || DeviceAddressSpaceHandle
|-
| (In) W2 || R2 || Handle<Process> || ProcessHandle
|-
| (In) X3 || R0, R3 || void* || Address
|-
| (In) X4 || R4 || uint64_t || DeviceAddressSpaceSize
|-
| (In) X5 || R5, R6 || uint64_t || DeviceAddressSpaceAddress
|-
| (In) W6 || R7 || [[#MemoryPermission]] || MemoryPermission
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) X1 || R1 || uint64_t || Size
|}
</div>

== UnmapDeviceAddressSpace ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R0 || Handle<DeviceAddressSpace> || DeviceAddressSpaceHandle
|-
| (In) W1 || R1 || Handle<Process> || ProcessHandle
|-
| (In) X2 || R2, R3 || void* || Address
|-
| (In) X3 || R4 || uint64_t || DeviceAddressSpaceSize
|-
| (In) X4 || R5, R6 || uint64_t || DeviceAddressSpaceAddress
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

Unmaps an attached device address space from an userspace address.

== InvalidateProcessDataCache ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R0 || Handle<Process> || ProcessHandle
|-
| (In) X1 || R2, R3 || void* || Address
|-
| (In) X2 || R1, R4 || uint64_t || Size
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

== StoreProcessDataCache ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R0 || Handle<Process> || ProcessHandle
|-
| (In) X1 || R2, R3 || void* || Address
|-
| (In) X2 || R1, R4 || uint64_t || Size
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

== FlushProcessDataCache ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R0 || Handle<Process> || ProcessHandle
|-
| (In) X1 || R2, R3 || void* || Address
|-
| (In) X2 || R1, R4 || uint64_t || Size
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

== DebugActiveProcess ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X1 || R2, R3 || uint64_t || ProcessId
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) W1 || R1 || Handle<Debug> || DebugHandle
|}
</div>

== BreakDebugProcess ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<Debug> || DebugHandle
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== TerminateDebugProcess ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<Debug> || DebugHandle
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== GetDebugEvent ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || [[#DebugEventInfo]]* || DebugEventInfo
|-
| (In) W1 || Handle<Debug> || DebugHandle
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== ContinueDebugEvent ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R0 || Handle<Debug> || DebugHandle
|-
| (In) W1 || R1 || uint32_t || [[#ContinueDebugFlags]] ([1.0.0-2.3.0] [[#ContinueDebugFlagsOld]])
|-
| (In) X2 || R2 ([1.0.0-2.3.0] R2, R3) || uint64_t* ([1.0.0-2.3.0] uint64_t)|| ThreadIdList ([1.0.0-2.3.0] ThreadId)
|-
| (In) X3 || R3 || uint64_t || [3.0.0+] NumThreadIds
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

Maximum NumThreadIds is 64. 0 means "all threads".

=== Result codes ===
'''0x0:''' Success. The process has been resumed.

'''0xe401:''' Invalid debug handle.

'''0xf401:''' Process has debug events queued or is already running.

== GetProcessList ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X1 || R1 || uint64_t* || ProcessIdBuffer
|-
| (In) W2 || R2 || uint32_t || ProcessIdBufferSize
|-
| (Out) X0 || R0 || [[#Result]] || Result
|-
| (Out) W1 || R1 || uint32_t || NumProcesses
|}
</div>

Fills the provided array with the pids of currently living processes. A process "lives" so long as it is currently running or a handle to it still exists.

It returns the total number of processes currently alive. If this number is bigger than the size of ProcessIdBuffer, the user won't have all the pids.

=== Result codes ===
'''0x0:''' Success.

'''0xd401:''' The provided buffer is outside the process address space.

'''0xe601:''' copyToUser failed. The provided buffer is not user-accessible.

'''0xee01:''' The provided buffer size is too big. Max value is 0xFFFFFFF.

== GetThreadList ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X1 || R1 || uint64_t* || ThreadIdBuffer
|-
| (In) W2 || R2 || uint32_t || ThreadIdBufferSize
|-
| (In) W3 || R3 || Handle<Debug> || DebugHandle
|-
| (Out) X0 || R0 || [[#Result]] || Result
|-
| (Out) W1 || R1 || uint32_t || NumThreads
|}
</div>

== GetDebugThreadContext ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X0 || R0 || [[#ThreadContext]]* || ThreadContext
|-
| (In) X1 || R1 || Handle<Debug> || DebugHandle
|-
| (In) X2 || R2, R3 || uint64_t || ThreadId
|-
| (In) W3 || R4 || uint32_t || [[#ThreadContextFlags]]
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

== SetDebugThreadContext ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R0 || Handle<Debug> || DebugHandle
|-
| (In) X1 || R2, R3 || uint64_t || ThreadId
|-
| (In) X2 || R1 || [[#ThreadContext]]* || ThreadContext
|-
| (In) W3 || R4 || uint32_t || [[#ThreadContextFlags]]
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

== QueryDebugProcessMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || [[#MemoryInfo]]* || MemoryInfo
|-
| (In) W2 || Handle<Debug> || DebugHandle
|-
| (In) X3 || void* || Address
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) W1 || [[#PageInfo]] || PageInfo
|}
</div>

== ReadDebugProcessMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X0 || void* || MemoryBufferAddress
|-
| (In) W1 || Handle<Debug> || DebugHandle
|-
| (In) X2 || void* || SrcAddress
|-
| (In) X3 || uint64_t || Size
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== WriteDebugProcessMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<Debug> || DebugHandle
|-
| (In) X1 || void* || MemoryBufferAddress
|-
| (In) X2 || void* || DstAddress
|-
| (In) X3 || uint64_t || Size
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== SetHardwareBreakPoint ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R0 || [[#HardwareBreakPointRegisterName]] || Name
|-
| (In) X1 || R2, R3 || uint64_t || Flags
|-
| (In) X2 || R1, R4 || uint64_t || Value
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

Sets one of the AArch64 hardware breakpoints. The nintendo switch has 6 hardware breakpoints, and 4 hardware watchpoints. The syscall has two behaviors depending on the value of HardwareBreakPointRegisterName:

If HardwareBreakPointRegisterName < 0x10, then it sets one of the AArch64 hardware breakpoints. Flags will go to DBGBCRn_EL1, and value to DBGBVRn_EL1. The only flags the user is allowed to set are those in the bitmask 0x7F01E1. Furthermore, the kernel will or it with 0x4004, in order to set various security flags to guarantee the watchpoints only triggers for code in EL0. If the user asks for a Breakpoint Type of ContextIDR match, the kernel shall use the given DebugHandle to set DBGBVRn_EL1 to the ContextID of the debugged process.

If HardwareBreakPointRegisterName is between 0x10 and 0x20 (exclusive), then it sets one of the AArch64 hardware watchpoints. Flags will go to DBGWCRn_EL1, and the value to DBGWVRn_EL1. The only flags the user is allowed to set are those in the bitmask 0xFF0F1FF9. Furthermore, the kernel will or it with 0x104004. This will set various security flags, and set the watchpoint type to be a Linked Watchpoint. This means that you need to link it to a Linked ContextIDR breakpoint. Check the ARM documentation for more information.

Note that HardwareBreakPointRegisterName 0 to 4 match only to Virtual Address, while HardwareBreakPointRegisterName 5 and 6 match against either Virtual Address, ContextID, or VMID. As such, if you are configuring a breakpoint to link for a watchpoint, make sure you use hardware_breakpoint_id 5 or 6.

For more documentation for hardware breakpoints, check out the AArch64 documentation for the [http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.ddi0488h/way1382455558968.html DBGBCRn_EL1 register] and the [http://infocenter.arm.com/help/topic/com.arm.doc.ddi0488h/way1382455560629.html DBGWCRn_EL1 register]

== GetDebugThreadParam ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X2 || R2 || Handle<Debug> || DebugHandle
|-
| (In) X3 || R0, R1 || uint64_t || ThreadId
|-
| (In) W4 || R3 || [[#DebugThreadParam]] || DebugThreadParam
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) X1 || R1, R2 || uint64_t || Out0
|-
| (Out) W2 || R3 || uint32_t || Out1
|}
</div>

== GetSystemInfo ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X1 || [[#SystemInfoType]] || SystemInfoType
|-
| (In) W2 || Handle || Handle
|-
| (In) X3 || uint64_t || SystemInfoSubType
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) X1 || uint64_t || SystemInfo
|}
</div>

== CreatePort ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W2 || R2 || int32_t || MaxSessions
|-
| (In) W3 || R3 || bool || IsLight
|-
| (In) X4 || R0 || uint64_t || Name
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) W1 || R1 || Handle<Port> || ServerPortHandle
|-
| (Out) W2 || R2 || Handle<Port> || ClientPortHandle
|}
</div>

== ManageNamedPort ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X1 || char* || Name
|-
| (In) W2 || int32_t || MaxSessions
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) W1 || Handle<Port> || ServerPortHandle
|}
</div>

== ConnectToPort ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W1 || Handle<Port> || ClientPortHandle
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) W1 || Handle<Session> || SessionHandle
|}
</div>

== SetProcessMemoryPermission ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R0 || Handle<Process> || ProcessHandle
|-
| (In) X1 || R2, R3 || void* || Addr
|-
| (In) X2 || R1, R4 || uint64_t || Size
|-
| (In) W3 || R5 || [[#MemoryPermission]] || MemoryPermission
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

This sets the memory permissions for the specified memory with the supplied process handle.

This throws an error(0xD801) when the input perm is >0x5, hence -WX and RWX are not allowed.

== MapProcessMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X0 || R0 || void* || DstAddress
|-
| (In) W1 || R1 || Handle<Process> || ProcessHandle
|-
| (In) X2 || R2, R3 || void* || SrcAddress
|-
| (In) X3 || R4 || uint64_t || Size
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

Maps the src address from the supplied process handle into the current process.

This allows mapping code and rodata with RW- permission.

== UnmapProcessMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X0 || R0 || void* || DstAddress
|-
| (In) W1 || R1 || Handle<Process> || ProcessHandle
|-
| (In) X2 || R2, R3 || void* || SrcAddress
|-
| (In) X3 || R4 || uint64_t || Size
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

Unmaps what was mapped by [[#MapProcessMemory]].

== QueryProcessMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X0 || R0 || [[#MemoryInfo]]* || MemoryInfo
|-
| (In) W2 || R2 || Handle<Process> || ProcessHandle
|-
| (In) X3 || R1, R3 || void* || Address
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) W1 || R1 || [[#PageInfo]] || PageInfo
|}
</div>

Equivalent to [[#QueryMemory]] except takes a process handle.

== MapProcessCodeMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R0 || Handle<Process> || ProcessHandle
|-
| (In) X1 || R2, R3 || void* || DstAddress
|-
| (In) X2 || R1, R4 || void* || SrcAddress
|-
| (In) X3 || R5, R6 || uint64_t || Size
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

Takes a process handle, and maps normal heap in that process as executable code in that process. Used when loading NROs. This does not support using the current-process handle alias.

== UnmapProcessCodeMemory ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R0 || Handle<Process> || ProcessHandle
|-
| (In) X1 || R2, R3 || void* || DstAddress
|-
| (In) X2 || R1, R4 || void* || SrcAddress
|-
| (In) X3 || R5, R6 || uint64_t || Size
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

Unmaps what was mapped by [[#MapProcessCodeMemory]].

== CreateProcess ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) X1 || [[#CreateProcessParameter]]* || CreateProcessParameter
|-
| (In) X2 || uint32_t* || Capabilities
|-
| (In) X3 || int32_t || CapabilitiesNum
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) W1 || Handle<Process> || ProcessHandle
|}
</div>

Takes a [[#CreateProcessParameter]] as input.
Capabilities points to an array of [[NPDM#Kernel_Access_Control|kernel capabilities]].
CapabilitiesNum is a number of capabilities in the Capabilities array (number of element, not number of bytes).

=== Result codes ===
'''0x0:''' Success.

'''0xCA01:''' Attempted to map more code pages than available in address space.

'''0xCC01:''' Provided CodeAddr is invalid (make sure it's in range?)

'''0xE401:''' The resource handle passed is invalid.

'''0xE601:''' Attempt to copy procinfo from user-supplied pointer failed. Attempt to copy capabilities_num from user-supplied pointer failed.

'''0xE801:''' Attempted to create a 32-bit process with a 36-bit address space.

'''0xF001:''' Unused bits are set in mmuflags. Unknown address space type used.

== StartProcess ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R0 || Handle<Process> || ProcessHandle
|-
| (In) W1 || R1 || int32_t || MainThreadPriority
|-
| (In) W2 || R2 || int32_t || DefaultCpuId
|-
| (In) X3 || R3, R4 || uint64_t || MainThreadStackSize
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

== TerminateProcess ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) W0 || Handle<Process> || ProcessHandle
|-
| (Out) W0 || [[#Result]] || Result
|}
</div>

== GetProcessInfo ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R1 || Handle<Process> || ProcessHandle
|-
| (In) W1 || R2 || [[#ProcessInfoType]] || ProcessInfoType
|-
| (Out) W0 || R0 || [[#Result]] || Result
|-
| (Out) X1 || R1, R2 || uint64_t || [[#ProcessState]]
|}
</div>

Returns an enum with value 0-7.

== CreateResourceLimit ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument || Type || Name
|-
| (In) None || ||
|-
| (Out) W0 || [[#Result]] || Result
|-
| (Out) W1 || Handle<ResourceLimit> || ResourceLimitHandle
|}
</div>

== SetResourceLimitLimitValue ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) W0 || R0 || Handle<ResourceLimit> || ResourceLimitHandle
|-
| (In) W1 || R1 || [[#LimitableResource]] || LimitableResource
|-
| (In) X2 || R2, R3 || int64_t || LimitValue
|-
| (Out) W0 || R0 || [[#Result]] || Result
|}
</div>

== CallSecureMonitor ==
<div style="display: inline-block;">
{| class="wikitable" border="1"
|-
! Argument64 || Argument32 || Type || Name
|-
| (In) X0 || R0 || uint64_t || [[SMC#Secure_Monitor_calls|FunctionId]]
|-
| (In) X1-X7 || R1-R7 || uint64_t || SMC arguments
|-
| (Out) X0 || R0 || [[SMC#Result|Result]] || SMC result
|-
| (Out) X1-X7 || R1-R7 || uint64_t || SMC output
|}
</div>

Takes in a SMC function ID in X0, and arguments for that SMC function in X1-X7.

Passing an invalid SMC function ID or calling from a core other than core 3 will result in a secure monitor panic.

The kernel parses bits 9-15 in the passed SMC function ID (per the ARM SMC calling convention), and when set uses as an indicator to translate a pointer in the associated register (X1-X7) to a physical address. The kernel will translate any address mapped as R-W, other addresses (R--, R-X, or invalid pointers) will be translated as 0/NULL.

Output is returned raw from the Secure Monitor; X0 will be the untranslated SMC result and X1-X7 will contain other SMC output (or be unchanged, depending on the SMC).

== Debugging ==
[2.0.0+] Exactly 6 debug SVCs require that [[SPL_services#GetConfig|IsDebugMode]] is non-zero. Error 0x4201 is returned otherwise.
* BreakDebugProcess
* ContinueDebugEvent
* WriteDebugProcessMemory
* SetDebugThreadContext
* TerminateDebugProcess
* SetHardwareBreakPoint

DebugActiveProcess stops execution of the target process, the normal method for resuming it requires ContinueDebugEvent(see above). Closing the debug handle also results in execution being resumed.

= Enum/Structures =
== InfoType ==
{| class=wikitable
! Handle type || InfoType || InfoSubType || Description
|-
| Process || 0 || 0 || CoreMask
|-
| Process || 1 || 0 || PriorityMask
|-
| Process || 2 || 0 || AliasRegionAddress
|-
| Process || 3 || 0 || AliasRegionSize
|-
| Process || 4 || 0 || HeapRegionAddress
|-
| Process || 5 || 0 || HeapRegionSize
|-
| Process || 6 || 0 || TotalMemorySize. Total memory available(free+used).
|-
| Process || 7 || 0 || UsedMemorySize. Total used size of codebin memory + main-thread stack + allocated heap.
|-
| Zero || 8 || 0 || DebuggerAttached
|-
| Zero || 9 || 0 || ResourceLimit
|-
| Zero || 10 || -1, {current coreid} || IdleTickCount
|-
| Zero || 11 || 0-3 || RandomEntropy. Used to seed usermode PRNGs.
|-
| Process || 12 || 0 || [2.0.0+] AslrRegionAddress
|-
| Process || 13 || 0 || [2.0.0+] AslrRegionSize
|-
| Process || 14 || 0 || [2.0.0+] StackRegionAddress
|-
| Process || 15 || 0 || [2.0.0+] StackRegionSize
|-
| Process || 16 || 0 || [3.0.0+] SystemResourceSizeTotal
|-
| Process || 17 || 0 || [3.0.0+] SystemResourceSizeUsed
|-
| Process || 18 || 0 || [3.0.0+] ProgramId
|-
| Zero || 19 || 0 || [4.0.0-4.1.0] InitialProcessIdRange_LowerBound
|-
| Zero || 19 || 1 || [4.0.0-4.1.0] InitialProcessIdRange_UpperBound
|-
| Process || 20 || 0 || [5.0.0+] UserExceptionContextAddress
|-
| Process || 21 || 0 || [6.0.0+] TotalNonSystemMemorySize
|-
| Process || 22 || 0 || [6.0.0+] UsedNonSystemMemorySize
|-
| Process || 23 || 0 || [9.0.0+] IsApplication
|-
| Process || 24 || 0 || [11.0.0+] FreeThreadCount
|-
| Thread || 25 ([1.0.0-12.1.0] 0xF0000002) || 0-3, -1 || ThreadTickCount. When 0-3 are passed, gets specific core CPU ticks spent on thread. When -1 is passed, gets total CPU ticks spent on thread.
|-
| Process || 26 || 0 || [14.0.0+] IsSvcPermitted
|}

== SystemInfoType ==
{| class=wikitable
! Handle type || SystemInfoType || SystemInfoSubType || Description
|-
| Zero || 0 || 0 || TotalPhysicalMemorySize_Application
|-
| Zero || 0 || 1 || TotalPhysicalMemorySize_Applet
|-
| Zero || 0 || 2 || TotalPhysicalMemorySize_System
|-
| Zero || 0 || 3 || TotalPhysicalMemorySize_SystemUnsafe
|-
| Zero || 1 || 0 || UsedPhysicalMemorySize_Application
|-
| Zero || 1 || 1 || UsedPhysicalMemorySize_Applet
|-
| Zero || 1 || 2 || UsedPhysicalMemorySize_System
|-
| Zero || 1 || 3 || UsedPhysicalMemorySize_SystemUnsafe
|-
| Zero || 2 || 0 || InitialProcessIdRange_LowerBound
|-
| Zero || 2 || 1 || InitialProcessIdRange_UpperBound
|}

== ThreadContextFlags ==
Bitfield of one of more of these:

{| class=wikitable
! Bit || Bitmask || Name || Description
|-
| 0 || 1 || General-purpose registers || If in 64-bit mode, GPRs 0–28 will be read/written. If in 32-bit mode, GPRs 0–12 will be read/written.
|-
| 1 || 2 || Control registers || Reads/writes the FP, LR, PC, SP, PSTATE, and TPIDR registers.
|-
| 2 || 4 || Floating-point registers || Reads/writes the floating-point vector registers.
|-
| 3 || 8 || Floating-point control registers || Reads/writes the FPCR and FPSR registers.
|}

== DeviceName ==
{| class=wikitable
! Value || Name
|-
| 0 || AFI
|-
| 1 || AVPC
|-
| 2 || DC
|-
| 3 || DCB
|-
| 4 || HC
|-
| 5 || HDA
|-
| 6 || ISP2
|-
| 7 || MSENCNVENC
|-
| 8 || NV
|-
| 9 || NV2
|-
| 10 || PPCS
|-
| 11 || SATA
|-
| 12 || VI
|-
| 13 || VIC
|-
| 14 || XUSB_HOST
|-
| 15 || XUSB_DEV
|-
| 16 || TSEC
|-
| 17 || PPCS1
|-
| 18 || DC1
|-
| 19 || SDMMC1A
|-
| 20 || SDMMC2A
|-
| 21 || SDMMC3A
|-
| 22 || SDMMC4A
|-
| 23 || ISP2B
|-
| 24 || GPU
|-
| 25 || GPUB
|-
| 26 || PPCS2
|-
| 27 || NVDEC
|-
| 28 || APE
|-
| 29 || SE
|-
| 30 || NVJPG
|-
| 31 || HC1
|-
| 32 || SE1
|-
| 33 || AXIAP
|-
| 34 || ETR
|-
| 35 || TSECB
|-
| 36 || TSEC1
|-
| 37 || TSECB1
|-
| 38 || NVDEC1
|}

== CodeMemoryOperation ==
{| class=wikitable
! Value || Name
|-
| 0 || MapOwner
|-
| 1 || MapSlave
|-
| 2 || UnmapOwner
|-
| 3 || UnmapSlave
|}

== LimitableResource ==
{| class=wikitable
! Value || Name || Description
|-
| 0 || PhysicalMemoryMax || Bytes of memory a process may allocate.
|-
| 1 || ThreadCountMax || Amount of threads a process can create.
|-
| 2 || EventCountMax || Amount of events a process can create through [[#CreateEvent]] or [[#SendAsyncRequestWithUserBuffer]].
|-
| 3 || TransferMemoryCountMax || Amount of TransferMemory a process can create through [[#CreateTransferMemory]].
|-
| 4 || SessionCountMax || Amount of session a process can create through [[#CreateSession]], [[#ConnectToPort]] or [[#ConnectToNamedPort]].
|}

= ThreadActivity =
{| class=wikitable
! Value || Name
|-
| 0 || None
|-
| 1 || Runnable
|}

== ProcessActivity ==
{| class=wikitable
! Value || Name
|-
| 0 || None
|-
| 1 || Runnable
|}

== ProcessInfoType ==
{| class=wikitable
! Value || Name
|-
| 0 || [[#ProcessState|ProcessState]]
|}

== ProcessState ==
{| class=wikitable
! Value || Name || Notes
|-
| 0 || Created ||
|-
| 1 || CreatedAttached ||
|-
| 2 || Started ||
|-
| 3 || Crashed || Processes will not enter this state unless they were created with [[#CreateProcessParameter|EnableDebug]].
|-
| 4 || StartedAttached ||
|-
| 5 || Exiting ||
|-
| 6 || Exited ||
|-
| 7 || DebugSuspended ||
|}

== DebugThreadParam ==
{| class=wikitable
! Value || Name
|-
| 0 || DynamicPriority
|-
| 1 || SchedulingStatus
|-
| 2 || PreferredCpuCore
|-
| 3 || CurrentCpuCore
|-
| 4 || AffinityMask
|}

Dynamic priority: output in out2

Scheduling status: out1 contains bit0: is debug-suspended, bit1: is user-suspended ([[#SetThreadActivity]] 1 or [[#SetProcessActivity]] 1).
Out2 contains {suspended, idle, running, terminating} => {5, 0, 1, 4}

PreferredCpuCore: output in out2

CurrentCpuCore: output in out2

AffinityMask: output in out1

== CreateProcessParameter ==
{| class=wikitable
! Offset || Length || Bits || Description
|-
| 0 || 12 || || ProcessName (doesn't have to be null-terminated)
|-
| 0x0C || 4 || || ProcessCategory (0: regular title, 1: kernel built-in)
|-
| 0x10 || 8 || || TitleId
|-
| 0x18 || 8 || || CodeAddr
|-
| 0x20 || 4 || || CodeNumPages
|-
| 0x24 || 4 || || Flags
|-
| || || Bit0 || Is64BitInstruction
|-
| || || Bit3-1 || [[#AddressSpaceType]]
|-
| || || Bit4 || [2.0.0+] EnableDebug
|-
| || || Bit5 || EnableAslr
|-
| || || Bit6 || IsApplication
|-
| || || Bit7 || [4.0.0] UseSecureMemory
|-
| || || Bit10-7 || [5.0.0+] MemoryRegion (0 = Application, 1 = Applet, 2 = SecureSystem, 3 = NonSecureSystem)
|-
| || || Bit11 || [7.0.0+] OptimizeMemoryAllocation (only allowed in combination with IsApplication)
|-
| 0x28 || 4 || || ResourceLimitHandle (can be zero)
|-
| 0x2C || 4 || || [3.0.0+] SystemResourceNumPages
|}

On [1.0.0] there's only one MemoryRegion.

On [2.0.0-4.0.0] MemoryRegion is 1 for built-ins and 0 for rest.

On [5.0.0] MemoryRegion is specified in CreateProcessArgs. There are now 4 pool partitions.

On [5.0.0] (maybe lower?) a zero ResourceLimitHandle defaults to sysmodule limits and 0x12300000 bytes of memory.

The PersonalMmHeap are allocated as follows:
* For the application, normal insecure pool is used. Carveout 5 is used to provide protection.
* For the applet, a pre-allocated secure pool segment of size 0x400000 is used.
* For sysmodules, secure pool is allocated.

=== AddressSpaceType ===
{| class=wikitable
! Type || Name || Width || Description
|-
| 0 || AddressSpace32Bit || 32 ||
|-
| 1 || AddressSpace64BitOld || 36 ||
|-
| 2 || AddressSpace32BitNoReserved || 32 || Appears to be missing map region [?]
|-
| 3 || [2.0.0+] AddressSpace64Bit || 39 ||
|}

== MemoryInfo ==
{| class=wikitable
! Offset || Length || Description
|-
| 0 || 8 || BaseAddress
|-
| 8 || 8 || Size
|-
| 0x10 || 4 || [[#MemoryType]]
|-
| 0x14 || 4 || [[#MemoryAttribute]]
|-
| 0x18 || 4 || [[#MemoryPermission]]
|-
| 0x1C || 4 || IpcRefCount
|-
| 0x20 || 4 || DeviceRefCount
|-
| 0x24 || 4 || Padding: always zero
|}

== MemoryPermission ==
{| class=wikitable
! Bits || Name || Description
|-
| 0 || Read || Can be set by [[#SetMemoryPermission]].
|-
| 1 || Write || Can be set by [[#SetMemoryPermission]].
|-
| 2 || Execute || Can be set by [[#SetProcessMemoryPermission]] and [[#ControlCodeMemory]].
|-
| 28 || DontCare ||
|}

== MemoryAttribute ==
{| class=wikitable
! Bits || Name || Description
|-
| 0 || Locked || Used by MapMemory, as an async IPC user buffer.
|-
| 1 || IpcLocked || True when IpcRefCount > 0.
|-
| 2 || DeviceShared || True when DeviceRefCount > 0.
|-
| 3 || Uncached ||
|}

== MemoryState ==
{| class=wikitable
! Bits || Description || Meaning
|-
| 7-0 || [[#MemoryType]] ||
|-
| 8 || [[#SetMemoryPermission|FlagCanReprotect]] ||
|-
| 9 || FlagCanDebug || Allows using [[#WriteDebugProcessMemory]] on segments mapped read-only.
|-
| 10 || FlagCanUseIpc || Allows sending this region as an IPC A/B/W buffer with flags=0.
|-
| 11 || FlagCanUseNonDeviceIpc || Allows sending this region as an IPC A/B/W buffer with flags=1.
|-
| 12 || FlagCanUseNonSecureIpc || Allows sending this region as an IPC A/B/W buffer with flags=3.
|-
| 13 || FlagMapped ||
|-
| 14 || [[#SetProcessMemoryPermission|FlagCode]] ||
|-
| 15 || [[#MapMemory|FlagCanAlias]] ||
|-
| 16 || [[#MapProcessCodeMemory|FlagCanCodeAlias]] ||
|-
| 17 || [[#CreateTransferMemory|FlagCanTransfer]] ||
|-
| 18 || [[#QueryPhysicalAddress|FlagCanQueryPhysical]] ||
|-
| 19 || [[#MapDeviceAddressSpace|FlagCanDeviceMap]] ||
|-
| 20 || [[#MapDeviceAddressSpaceAligned|FlagCanAlignedDeviceMap]] ||
|-
| 21 || [[#SendSyncRequestWithUserBuffer|FlagCanIpcUserBuffer]] ||
|-
| 22 || FlagReferenceCounted || The physical memory blocks backing this region are refcounted.
|-
| 23 || [[#MapProcessMemory|FlagCanMapProcess]] ||
|-
| 24 || [[#SetMemoryAttribute|FlagCanChangeAttribute]] ||
|-
| 25 || [4.0.0+] [[#CreateCodeMemory|FlagCanCodeMemory]] ||
|}

=== MemoryType ===
{| class=wikitable
! Value || Type || Meaning
|-
| 0x00000000 || Free ||
|-
| 0x00002001 || Io || Mapped by kernel capability parsing in [[#CreateProcess]].
|-
| 0x00042002 || Static || Mapped by kernel capability parsing in [[#CreateProcess]].
|-
| 0x00DC7E03 || Code || Mapped during [[#CreateProcess]].
|-
| [1.0.0+]

0x01FEBD04

[4.0.0+]

0x03FEBD04
|| CodeData || Transition from 0xDC7E03 performed by [[#SetProcessMemoryPermission]].
|-
| [1.0.0+]
0x017EBD05

[4.0.0+]

0x037EBD05
|| Normal || Mapped using [[#SetHeapSize]].
|-
| 0x00402006 || Shared || Mapped using [[#MapSharedMemory]].
|-
| 0x00482907 || [1.0.0] Alias || Mapped using [[#MapMemory]].
|-
| 0x00DD7E08 || AliasCode || Mapped using [[#MapProcessCodeMemory]].
|-
| [1.0.0+]

0x01FFBD09

[4.0.0+]

0x03FFBD09
|| AliasCodeData || Transition from 0xDD7E08 performed by [[#SetProcessMemoryPermission]].
|-
| 0x005C3C0A || [[IPC_Marshalling|Ipc]] || IPC buffers with descriptor flags=0.
|-
| 0x005C3C0B || Stack || Mapped using [[#MapMemory]].
|-
| 0x0040200C || [[Thread Local Storage|ThreadLocal]] || Mapped during [[#CreateThread]].
|-
| 0x015C3C0D || Transfered || Mapped using [[#MapTransferMemory]] when the owning process has perm=0.
|-
| 0x005C380E || SharedTransfered || Mapped using [[#MapTransferMemory]] when the owning process has perm!=0.
|-
| 0x0040380F || SharedCode || Mapped using [[#MapProcessMemory]].
|-
| 0x00000010 || Inaccessible ||
|-
| 0x005C3811 || [[IPC_Marshalling|NonSecureIpc]] || IPC buffers with descriptor flags=1.
|-
| 0x004C2812 || [[IPC_Marshalling|NonDeviceIpc]] || IPC buffers with descriptor flags=3.
|-
| 0x00002013 || Kernel || Mapped in kernel during [[#CreateThread]].
|-
| 0x00402214 || [4.0.0+] GeneratedCode || Mapped in kernel during [[#ControlCodeMemory]].
|-
| 0x00402015 || [4.0.0+] CodeOut || Mapped in kernel during [[#ControlCodeMemory]].
|-
| 0x00002016 || [13.0.0+] Coverage ||
|}

== ArbitrationType ==
{| class=wikitable
! Value || Type
|-
| 0x0 || WaitIfLessThan
|-
| 0x1 || DecrementAndWaitIfLessThan
|-
| 0x2 || WaitIfEqual
|}

== SignalType ==
{| class=wikitable
! Value || Type
|-
| 0x0 || Signal
|-
| 0x1 || SignalAndIncrementIfEqual
|-
| 0x2 || SignalAndModifyBasedOnWaitingThreadCountIfEqual
|}

== ContinueDebugFlagsOld ==
[1.0.0-2.3.0]
{| class=wikitable
! Bit || Bitmask || Description
|-
| 0 || 1 || IgnoreException (note: ResumeAllThreads or debug-suspended-thread-id needed)
|-
| 1 || 2 || SwallowException
|-
| 2 || 4 || ResumeAllThreads
|}

== ContinueDebugFlags ==
[3.0.0+]
{| class=wikitable
! Bit || Bitmask || Description
|-
| 0 || 1 || IgnoreException (note: doesn't need to be set in the same call than Resume)
|-
| 1 || 2 || DontCatchExceptions
|-
| 2 || 4 || Resume
|-
| 3 || 8 || IgnoreOtherThreadsExceptions
|}

IgnoreExceptionsOfOthers is like IgnoreException but acts on all threads that aren't in the input list. The affected threads are resumed.

Only one of of Resume and IgnoreOtherThreadsExceptions can be set at a time.

If the input number of threads is 0, this means "all threads".

== DebugEventInfo ==
The below table is for the Aarch64 version of the system call. For A32, all u64 fields but title/process/thread id are actually u32, making the structure 0x28-byte-big (0x40 for a64).

Size: 0x40

{| class=wikitable
! Offset || Length || Description
|-
| 0 || u32 || EventType
|-
| 4 || u32 || Flags (bit0: NeedsContinue)
|-
| 8 || u64 || ThreadId
|-
| 0x10 || || PerTypeSpecifics
|}

AttachProcess specific:
{| class=wikitable
! Offset || Length || Description
|-
| 0x10 || u64 || TitleId
|-
| 0x18 || u64 || ProcessId
|-
| 0x20 || char[12] || ProcessName
|-
| 0x2C || u32 || MmuFlags
|-
| 0x30 || u64 || [5.0.0+] UserExceptionContextAddr
|}

AttachThread specific:
{| class=wikitable
! Offset || Length || Description
|-
| 0x10 || u64 || ThreadId
|-
| 0x18 || u64 || TlsPtr
|-
| 0x20 || u64 || Entrypoint
|}

Exit specific:
{| class=wikitable
! Offset || Length || Description
|-
| 0x10 || u32|| Type (0=PausedThread, 1=RunningThread, 2=ExitedProcess, 3=TerminatedProcess)
|}

Exception specific:
{| class=wikitable
! Offset || Length || Description
|-
| 0x10 || u32 || ExceptionType
|-
| 0x18 || u64 || FaultRegister
|-
| 0x20 || || PerExceptionSpecifics
|}

=== DebugEventType ===
{| class=wikitable
! Value || Name
|-
| 0 || AttachProcess
|-
| 1 || AttachThread
|-
| 2 || ExitProcess
|-
| 3 || ExitThread
|-
| 4 || Exception
|}

=== DebugExceptionType ===
{| class=wikitable
! Value || Name
|-
| 0 || Trap (*)
|-
| 1 || InstructionAbort
|-
| 2 || DataAbortMisc (**)
|-
| 3 || PcSpAlignmentFault
|-
| 4 || DebuggerAttached
|-
| 5 || BreakPoint
|-
| 6 || UserBreak
|-
| 7 || DebuggerBreak
|-
| 8 || BadSvcId
|-
| 9 || [2.0.0+] SError
|}

<nowiki>*</nowiki> Undefined instructions, software breakpoints, some other traps.

<nowiki>**</nowiki> Data aborts, FP traps, and everything else that doesn't belong to any of the above.

Trap specifics:
{| class=wikitable
! Offset || Length || Description
|-
| 0x20 || u32 || Opcode
|}

BreakPoint specifics:
{| class=wikitable
! Offset || Length || Description
|-
| 0x20 || u32 || IsWatchpoint
|}

UserBreak specifics:
{| class=wikitable
! Offset || Length || Description
|-
| 0x20 || u32 || Info0
|-
| 0x28 || u64 || Info1
|-
| 0x30 || u64 || Info2
|}

BadSvcId specifics:
{| class=wikitable
! Offset || Length || Description
|-
| 0x20 || u32 || SvcId
|}

= Exception handling =
First of all, a function that might be called by synchronous exception handler and that is called by the SError handler fetches the exception info, adjusts PC, panics on exceptions taken from EL1, then dispatches the exception.

The dispatcher has two mutually exclusive exception reporting methods:
* by storing information at the start of the process's TLS memregion (TPIDRRO_EL0) and jumping back to the crt0
* by using KDebug

KDebug dispatching is used when at least one of the following conditions are met:
* SMC ConfigItem KernelMemConfig bit 1 is NOT set (it isn't on retail), unless: this is a software or hardware breakpoint, or a watchpoint, or [4.0.0+?] the process is attached and this is a Google PNaCl trap instruction (see LLVM source)
* FAR doesn't point to a valid address in mapped-readable CodeStatic memory (i.e. this is the case for NRO and JIT memory) or this is one of the following exceptions (it particular, that doesn't include FP exceptions occurring in CodeStatic memory):
** Uncategorized
** IllegalState
** SupervisorCallA32
** SupervisorCallA64
** PCAlignment
** SPAlignment
** SError
** BreakpointLowerEl
** SoftwareStepLowerEl (note: no way set single-step flag; not parsed)
** WatchpointLowerEl
** SoftwareBreakpointA32 (note: not parsed)
** SoftwareBreakpointA64 (note: not parsed)

In all other cases the userland-handled exception path is taken.

KDebug path:

If the process is attached, the exception is reported to the KDebug. If the thread was continued using flag IgnoreExceptions, it returns from the exception as if nothing happened.

If the latter is not the case, or if the process isn't attached, proceed to [2.0.0+] crash reporting (or in [1.0.0] just terminate the process):
if EnableDebug is set, and depending on the process state (more than one crash per process isn't permitted) it may signal itself with ProcessState_Crashed so that PM asks NS to start creport so that creport attaches to it and reports the crashes. Otherwise, just terminate.

Userland reporting path and [[#ReturnFromException]]:

TLS region start (A64):
{| class=wikitable
! Offset || Length || Description
|-
| 0x0 || 0x148 || Exception stack
|-
| 0x148 || 0x78 || ExceptionFrameA64
|}

ExceptionFrameA64:
{| class=wikitable
! Offset || Length || Description
|-
| 0x0 || 0x48 (8*9) || GPRs 0..8.
|-
| 0x48 || 0x8 || lr
|-
| 0x50 || 0x8 || sp
|-
| 0x58 || 0x8 || pc (elr_el1)
|-
| 0x60 || 0x4 || pstate & 0xFF0FFE20
|-
| 0x64 || 0x4 || afsr0
|-
| 0x68 || 0x4 || afsr1
|-
| 0x6C || 0x4 || esr
|-
| 0x70 || 0x8 || far
|}

TLS region start (A32):
{| class=wikitable
! Offset || Length || Description
|-
| 0x0 || 0x178 || Exception stack
|-
| 0x148 || 0x44 || ExceptionFrameA32
|}

ExceptionFrameA32:
{| class=wikitable
! Offset || Length || Description
|-
| 0x0 || 0x20 (8*4) || GPRs 0..7.
|-
| 0x20 || 0x4 || sp
|-
| 0x24 || 0x4 || lr
|-
| 0x28 || 0x4 || pc (elr_el1)
|-
| 0x2C || 0x4 || tpidr_el0 = 1
|-
| 0x30 || 0x4 || cpsr & 0xFF0FFE20
|-
| 0x34 || 0x4 || afsr0
|-
| 0x38 || 0x4 || afsr1
|-
| 0x3C || 0x4 || esr
|-
| 0x40 || 0x4 || far
|}

In that case, after storing the regs in the TLS, the exception handler returns to the application's crt0 (entrypoint), with X0=<error description code> (see below) and X1=SP=frame=<stack top> (see above)

{| class=wikitable
! Desc. code || Meaning
|-
| 0x100 || Instruction abort
|-
| 0x102 || Misaligned PC
|-
| 0x103 || Misaligned SP
|-
| 0x106 || [2.0.0+] SError
|-
| 0x301 || Bad SVC
|-
| 0x104 || Uncategorized, CP15RTTrap, CP15RRTTrap, CP14RTTrap, CP14RRTTrap, IllegalState, SystemRegisterTrap
|-
| 0x101 || None of the above, EC <= 0x34 and not a breakpoint
|-
|}

(During normal app boot the process is invoked with X0=0 and X1=main_thread_handle. The crt0 of retail apps determines whether to boot normally or handle an exception if X0 is set to 0 or not)

The application is supposed to promptly update the contents of elr_el1 to a user handler (and any other regs it sees fit) and call [[#ReturnFromException]] (error code) to call that handler. The latter is then expected to promptly abort the program.

[[#ReturnFromException]] updates the contents of the kernel stack frame with what the user provided in the TLS structure, sets TPIDR_EL0 to 1, then:
* if the provided error code is 0, gracefully pivots and returns from exception
* if it is not, replays the exception and pass it to the KDebug (see above). One can pass 0x10001 to prevent process termination. If the process is attached, this also prevents crash-collection/termination (different from the exception handler behavior)

If an exception occurs from the above user handler, the entire exception handling process will repeat with the new exception.

Note that if a thread that wasn't faulting calls [[#ReturnFromException]], it signals an "invalid syscall" exception

Note that [[SMC|IsDebugMode]] is not used during exception-handling, except for enabling printing a message to UART-A. This UART code causes a system-hang on retail (likely due to a loop that doesn't exit). This printing doesn't seem to run when the process is attached for debugging?

Super Mario 3D All-Stars

2022-04-17T14:06:32Z

Liamwhite: fix wiki syntax

This page documents the Super Mario 3D All-Stars (SM3DAS) game.

The initial menu is the Stardust launcher, which has the base [[NCM_services#ProgramId|ProgramId]] 010049900F546000. Each game launched from here has a different [[Applet_Manager_services#ProgramSpecifyKind|ProgramIndex]], therefore each [[NCM_services#ProgramId|ProgramId]] differs: 0x1 (010049900F546001) SuperMario64, 0x2 (010049900F546002) SuperMarioSunshine, 0x3 (010049900F546003) SuperMarioGalaxy.

The launcher launches each game by using [[Applet_Manager_services#ExecuteProgram|ExecuteProgram]] with ProgramIndex={above values}, with 0x10-byte [[Applet_Manager_services#UnpopToUserChannel|parameter-data]]: {+0x0 = [[Settings_services#LanguageCode|LanguageCode]] selected in the launcher for this game, +0x8/+0xC = floats loaded from a fixed-data array specific for each game, which games can use with [[Audio_services#SetAudioDeviceOutputVolumeAuto|SetAudioDeviceOutputVolume]]}. Each game returns to the launcher by using [[Applet_Manager_services#ExecuteProgram|ExecuteProgram]] with ProgramIndex=0, no [[Applet_Manager_services#UnpopToUserChannel|parameter-data]] is passed to the launcher.

Each game uses different methods of emulation.

These games use Vulkan for rendering.

These games save PlayReports with [[BCAT_services|prepo]], the fields include "num_stars" etc.

The pause-menu when pressing the '-' button in each game uses the Offline web-applet with [[Internet_Browser#WebSession|WebSession]].

= NPDM =
This section documents the [[NPDM]] for the launcher and each game.
* Launcher: Roughly the same as most Switch games' NPDM.
* SuperMario64: Locked down since this uses [[JIT_services|JIT]]. Compared to the Launcher NPDM (besides ProgramId):
** ProgramIdMin/ProgramIdMax is 010049900F546001-010049900F546001, with other NPDMs it's the normal full Application-range.
** Access to [[SVC|svcMapPhysicalMemory]]/[[SVC|svcUnmapPhysicalMemory]] was removed, and access to [[SVC|svcCreateCodeMemory]] was added.
** The only other difference is service-access-control: this was locked down, and only has the following services: [[Account_services|acc:u0]], [[NS_Services|aoc:u]], [[PPC_services#apm|apm]], [[Applet_Manager_services|appletOE]], [[Audio_services|audren:u]], [[Filesystem_services|fsp-srv]], [[HID_services|hid]], [[JIT_services|jit:u]], [[RO_services|ldr:ro]], [[Log_services|lm]], [[NV_services|nvdrv]], [[Parental_Control_services|pctl]], [[BCAT_services|prepo:u]], [[Settings_services|set]], [[PCV_services|time:u]], [[Display_services|vi:u]].
** Note that aoc:u, pctl, and lm are only accessible since sdknso automatically initializes these during startup, the main-codebin itself doesn't use these.
* SuperMarioSunshine: Same as Launcher (besides ProgramId), except [[NPDM#Flags|flag]] OptimizeMemoryAllocation is set.
* SuperMarioGalaxy: Same as Launcher (besides ProgramId), except [[NPDM#Flags|flags]] is 0x4: Is64BitInstruction=0(AArch32) and ProcessAddressSpace=0x2.

= SuperMario64 =
This is a Nintendo 64 emulator. This uses [[JIT_services|JIT]] for running the emulated executable. RomFs also contains an AOT [[NRO]]. A NRO does get loaded, however it's not used other than that (no symbols from the NRO are resolved).

At the time of release, this was the very first title to use [[JIT_services|JIT]] on retail.

The ROMIMAGE .bin in RomFs is identical to the [https://tcrf.net/Super_Mario_64_(Nintendo_64)/Regional_and_Version_Differences#Shindou_Pak_Taiou_Version Shindou] region N64 ROM. Patches are applied at runtime with the config/lua files.

The LanguageCode is loaded from the launch-parameter passed by the launcher, if not available it will fallback to the output from [[Applet_Manager_services#GetDesiredLanguage|GetDesiredLanguage]]. This is used to select the <language> to load from RomFs "/Message/", the data from there is then used for patching the ROM. Note that the .lua file runs <code>n64InitMessageData();</code> from the GameBegin() function.

The ROMIMAGE .bin in RomFs can be replaced with other data (an unofficial image for example) when the config files are adjusted, however note that in some cases a hang may occur during the loading screen.

RomFs contains the following:
* "/Pipeline.cache", "/shader_p1_frag.spv", "/shader_p1_vert.spv", "/shader_vulkan_frag.spv", "/shader_vulkan_vert.spv"
* "/Message/<language>/" contains:
** "Messages.bin", "UI_Font8.bin", "UI_Font16.bin", "UI_Font16_code2.bin", "UI_FontS88.bin".
* "/.nrr/" contains:
** "EmuAppNX64.nrr": The [[NRR]] for the [[JIT_services|JitPlugin]].
** "04_UNSMJ3.002.nrr": [[NRR]] for the AOT [[NRO]].
* "/nro/" contains:
** "EmuSystemJITPlugin.nro": The [[NRO]] for the [[JIT_services|JitPlugin]].
** "NROBuilder.nro": AOT [[NRO]].
** "05_UNSMJ3.002.nro": Same as "NROBuilder.nro".
** "/rom/": This contains the ROM sub-directory, in this case that dir-name is "Stardust_JP" which contains the following:
*** "Textures/texture_pack.cpio": Standard (?) .cpio archive containing textures.
*** "00_UNSMJ3.002.meta": Contains json metadata for the other files in this directory, etc.
*** "01_UNSMJ3.002.bin": This is the ROMIMAGE.
*** "02_UNSMJ3.002.cfg": Configuration json file, ROMCONFIG.
*** "03_UNSMJ3.002.pcb": This is the "PRECMP" file referenced by the .meta. See [[#EmuSystemJITPlugin]]. Using this can be disabled by changing the "PRECMP" string in the .meta to an invalid string, etc.
*** "04_UNSMJ3.002.nrr": Unused [[NRR]] which is the same as "/.nrr/04_UNSMJ3.002.nrr", except the [[NRR#Certification|Certification]] and ApplicationId are all-zero.
*** "05_UNSMJ3.002.nro": Identical to "/nro/05_UNSMJ3.002.nro".
*** "06_UNSMJ3.002.lua": This is the "ROMPATCH" Lua file referenced by the .meta.
*** "07_UNSMJ3.002.ppl": This is the "PIPELINE" file referenced by the .meta.

== Emulation Notes ==
The generated-code runs from the main-thread. The following 4 threads are created:
* Audio thread.
* "g_trlRenderTaskThread". Calls funcptr/object-vfunc from a list of tasks (funcptr/object only used if set), where the tasks are sent by the main-thread. These tasks can be triggered by accessing various IO regs with Write32 (see below), etc.
* A thread which basically does nothing, just uses a Semaphore and sleeps, while checking state.
* An unknown thread.

* <code>n64MemDefault{Read/Write}{bitsize}(...)</code>, where bitsize is {8, 16, 32, 64}: implements memory read/write, all read/written data is byte-swapped. First param is the u32 vaddr. For Write, the second param is the value. For Read, the returned u32 is the read value.
* <code>n64MemDefaultReadSpecial{bitsize}(...)</code>, where bitsize is {8, 16, 32, 64}: same as <code>n64MemDefaultRead{bitsize}</code>, except this runs the additional Special functionality when accessing RAM.
* <code>n64MemDefault{Read/Write}{bitsize}WithDestLog(...)</code>, where bitsize is {8, 16, 32, 64}: same as <code>n64MemDefault{Read/Write}{bitsize}</code>, except this calls an additional logging func when accessing RAM.

* Read8/Write8 only implements access for RAM and SP_DMEM/SP_IMEM. 0 is returned for Read when the address is unrecognized.
* Read16/Write16 only implements access for RAM. Read16WithDestLog/Write16WithDestLog will additionally call the logging func if the address is in the IO region (high byte is 0x04). 0 is returned for Read when the address is unrecognized.
* Read32/Write32 implements RAM access and all supported non-RAM IO/memory access. 0 is returned for Read when the address is unrecognized.
* Read64/Write64 are implemented the same as *16 above, except this is for 64bit.

== EmuSystemJITPlugin ==
This section documents the [[JIT_services|JIT]] plugin.

First, [[JIT_services#Control|Control]] is used with a 0xEB0-byte struct for the InBuffer, and cmd in_u64=0. The OutBuffer is unused. This does initialization, and copies the input struct to workmem+0x0.

The u64 for [[JIT_services#GenerateCode|GenerateCode]] is the type: 1-4 are valid. Type1 is used first, then type2. Then type3 is used with data loaded from the "PRECMP" file (the passed array data will be empty if the PRECMP file is not available). Type4 is only used when executing an emu_pc_addr which was not previously compiled, with a matching emu_pc_addr.

The u32 for the input Struct32 size is ignored by the plugin.

* Type1: Struct32 and InBuffer are unused. Generates the entry code which can be called for running the rest of the code in the CodeMemory. After the generated code finishes setup, it jumps to x0.
* Type2: Struct32 and InBuffer are unused. Generates the code for returning from CodeMemory, which is used by the rest of the generated code.
* Type3: The emulator passes the 0x8-bytes from InBuffer+0 as the input Struct32, however the plugin doesn't use the Struct32. The emulator passes InBuffer_size=0x8C00048 and OutBuffer_size=0x2900008. This generates code for the MIPS code specified in the InBuffer. The InBuffer contains array data etc. The InBuffer can contain multiple blocks of code, which are generally individual MIPS functions. The MIPS instructions are big-endian.
* Type4: 0x20-bytes are passed for the input Struct32: u32 +0 = emu_pc_addr, u32 +4 = set by emulator but unused by the plugin, u32 +0x18 = instruction_count (which determines the InBuffer size), the rest is unused / overwritten by the plugin. This generates code for the MIPS code specified in the InBuffer. InBuffer+0 is the u32s for the big-endian MIPS instructions. The OutBuffer is 0x2000C-bytes:
** +0x0 is an array of u32s with the count from u32 +0x20004. Each entry is the generated-code offset for each compiled MIPS instruction, relative to the CodeRange offset.
** +0x10000 is an array of u32s with the count from u32 +0x20004. Each entry is flags for each compiled MIPS instruction.
** The 3 u32s at +0x20000 are the same as OutBuffer+0x0 with type1/type2 (except the last two fields can be non-zero). +0x20004 is the total compiled MIPS instructions. +0x20008 is emu_pc_addr for the first compiled instruction.

0xC-bytes are copied to the OutBuffer with type1/type2, these come from workmem. These 3 u32s are left at all-zero, except for +0 which is the generated_code_size (which is then copied to the output CodeRange size).

The 0xEB0-byte controldata struct has the following structure (all addrs/data are from the emulator user-process):

{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0 || 0x8 || Data addr: g_pGPR
|-
| 0x8 || 0x8 || Data addr: g_pFPR
|-
| 0x10 || 0x8 || Data addr: g_pCP0
|-
| 0x18 || 0x8 || Data addr: g_nRegHi
|-
| 0x20 || 0x8 || Data addr: g_nRegLo
|-
| 0x28 || 0x8 || Data addr.
|-
| 0x30 || 0x8 || Data addr: g_nFCSR
|-
| 0x38 || 0x8 || Data addr: g_bN64CpuCmpEndCheck
|-
| 0x40 || 0x8 || Data addr: g_nN64CpuPC
|-
| 0x48 || 0x8 || Data addr: g_nN64CpuJmpPC. s32, normally -1. When not -1 this is a value which can be copied into g_nN64CpuJmpPC by the generated code, with g_nN64CpuJmpPC being reset to -1 afterwards regardless of the original value.
|-
| 0x50 || 0x8 || Data addr.
|-
| 0x58 || 0x8 || Data addr: g_nN64CpuHaveExp
|-
| 0x60 || 0x658 || Array of funcptrs. Called with w0=instruction_value from generated code for handling instructions' implementation, when the plugin itself doesn't handle it.
|-
| 0x6B8 || 0x8 || Funcptr: <code>n64CPUProcInstCOP1Check()</code>
|-
| 0x6C0 || 0x8 || Funcptr.
|-
| 0x6C8 || 0x8 || Funcptr.
|-
| 0x6D0 || 0x8 || Funcptr: <code>n64CPUSetRegisterCP0(int, unsigned int)</code>
|-
| 0x6D8 || 0x8 || Funcptr: <code>n64CPUGetRegisterCP0(int)</code>
|-
| 0x6E0 || 0x20 || Funcptrs for reading data: <code>n64MemDefaultRead{bitsize}(unsigned int)</code>, where bitsize is {8, 16, 32, 64} (32 uses <code>n64MemDefaultRead32WithDestLog</code>). Unused by the plugin.
|-
| 0x700 || 0x20 || Funcptrs for reading Special data: <code>n64MemDefaultReadSpecial{bitsize}(unsigned int)</code>, where bitsize is {8, 16, 32, 64}.
|-
| 0x720 || 0x20 || Funcptrs for writing data: <code>n64MemDefaultWrite{bitsize}(unsigned int, ...)</code>, where bitsize is {8, 16, 32, 64} (32 uses <code>n64MemDefaultWrite32WithDestLog</code>). Unused by the plugin.
|-
| 0x740 || 0x20 || Funcptrs for reading data via the WithDestLog version: <code>n64MemDefaultRead{bitsize}WithDestLog(unsigned int)</code>, where bitsize is {8, 16, 32, 64}.
|-
| 0x760 || 0x20 || Funcptrs for writing data via the WithDestLog version: <code>n64MemDefaultWrite{bitsize}WithDestLog(unsigned int, ...)</code>, where bitsize is {8, 16, 32, 64}.
|-
| 0x780 || 0x8 || Funcptr: <code>n64CPU_CallLuaAfterInst(unsigned int, unsigned int)</code>
|-
| 0x788 || 0x8 || Funcptr: <code>n64CPU_CallLuaBeforeInst(unsigned int, unsigned int)</code>
|-
| 0x790 || 0x8 || Funcptr.
|-
| 0x798 || 0x4 || Array count for the the following array.
|-
| 0x79C || 0x180 (0x20*0xC) || Array data with the above count, each entry is 0xC-bytes. The emulator loads this from config array "Idle". +0 = u32 emu_pc_addr (config "JmpAddr"), +4 = u32 instruction_value (config "JmpInst"), +8 = u32 is_idle (config "IsIdle", 0x1 = enabled).
|-
| 0x91C || 0x4 || Array count for the the following array.
|-
| 0x920 || 0x500 (0x40*0x14) || Array data with the above count, each entry is 0x14-bytes. The emulator loads this from config array "SpecialInst". +0 = u32 emu_pc_addr (config "Addr"), +4 = u32 instruction_value (config "Inst"), +8 = u32 flags. The emulator sets the flags to 0 by default, then compares config "Type" with various strings to determine the value. Flags: bit0 = Type "BreakLoop", bit5 = Type "LoadFrameBuffer", bit6 = Type "Lua_BeforeInst", bit7 = Type "Lua_AfterInst".

When the config for {any of the previously mentioned Type strings} is set to value 1, the emulator will also enable the corresponding flags bit mentioned above. Likewise with config "Return", which sets flags bit8.

When the plugin loads a funcptr from +0x740, it will load a funcptr from +0x700 instead if there's a matching entry here which has bit5 set.
|-
| 0xE20 || 0x4 || Array count for the the following array. The plugin doesn't use this.
|-
| 0xE24 || 0x80 (0x10*0x8) || Array data with the above count, each entry is 0x8-bytes. The emulator loads this from config array "FrameBuffer". +0 = u32 (config "Addr"), +4 = u32 (config "Length"). The plugin doesn't use this.
|-
| 0xEA4 || 0x4 || Set to 0 by default, then if available the emulator sets bit flags here depending on the content of the config for <code>"Cmp", "g_nN64CpuCmpTLBCheckLevel"</code>.
|-
| 0xEA8 || 0x4 || Set to 0 by default by the emulator. With config <code>"Cmp", "CodeMultiAddr"</code> this is set to 1, and with config <code>"Cmp", "BlockDynamicPC"</code> this is set to 2. The plugin only checks whether this ==2 or !=2, so values 0-1 are basically the same.
|-
| 0xEAC || 0x4 || Padding
|}

= SuperMarioSunshine =
This is a Nintendo Gamecube emulator. The emulator (which is the main-codebin) name is "Hagi". This uses an AOT [[NRO]] for running the emulated executable.

Since this uses AOT, attempting to run a different .dol with this emulator is equivalent to attempting to run an emulator with an executable where .text (code) is the from the original executable, while everything else is from the other executable.

This emulator supports arguments with argc/argv, when launched officially zero [[Loader_services#SetProgramArgument|arguments]] are passed for this (unless [[Loader_services#SetProgramArgument|SetProgramArgument]] is used manually prior to launching). The emulator will also load arguments from RomFs "/default_cmd.txt" when argc==1, otherwise it loads arguments from a filepath loaded elsewhere. Hence, when not launched with arguments with an official launch, "/default_cmd.txt" is not used. Some of the supported arguments are:

{| class="wikitable"
|-
! Argument !! Description
|-
| --volume=<0..100> || Set sound volume (default: 100).
|-
| --disable-file-cache || Disable file cache if supported by the platform.
|-
| --no-dol-hash || Do not calculate DOL hash (unsafe)
|-
| --screenshot-period=<value>, -sp || Takes screenshots every n frame
|-
| --screenshot-write-queue-thread-count=<0..n> || Change the number of threads allocated to the screenshot write queue, 0 to disable (default: 1).
|-
| --delete-after-load || Delete save state after a successful load.
|-
| --listen-port=<port> || Specify the service port to listen to (default: 1234).
|-
| --card-uncompressed || Do not compress card.
|-
| --sync-guest-none || Don't synchronize emulation, run as fast as possible.
|-
| --gecko-patch=<name> || Apply Gecko patch <name>
|-
| --log=<file> || Log to file instead of stdout. Defaults to stdout
|-
| --rootdir=<path>, -r<path> || Set the root directory
|-
| --no-patch || Do not apply standard patch
|-
| --stop-failed-test[=<number>] || Stop subtests after <number> differences (default 10).
|-
| --exit=<value>, -e || Exit after n frames
|-
| --help, -h || Print usage and exit.
|-
| --mute || Start ROM with mute sound.
|-
| --sync-guest-with-wall || Synchronize emulation with wall time.
|-
| --sync-guest-with-host || Synchronize emulation with host.
|-
| --test=<filename>, -t || Starts emulator in unit test mode.
|-
| --no-pip || Don't use pipeline database.
|-
| --play-input || Play previously recorded input
|-
| --command=<file> || Use file as the contents of the command line (one arg per line).
|-
| --dim-screen-after=<s> || Dim screen after <s> seconds of inactivity.
|-
| --random-inputs-period=<0..n> || Change the random inputs period in number of frames (default: 10).
|-
| --config=<filename>, -cfg || Gives path to the config file
|-
| --ask, -a || Ask for a rom and execute it.
|-
| --load-state-slot=<index>, -lss<index> || Load save state by index.
|-
| --load-state-file=<filename>, -lsf<filename> || Load save state by filename.
|-
| --generatetest=<directory>, -gt || Starts emulator in unit test mode and generate output files inside the given directory.
|-
| --waitcontroller, -wc || Stop CPU until controller 0 has been detected
|-
| --card-format=<size_in_Mbits> || Format card using given size in MBits (default 4, possible 8, 16, 32, 64, 128).
|-
| --card-force-copy || Force card copy from read-only support to read-write support (on supported platforms).
|-
| --screenshot-output-format=[png|ppm] || Change the format of the screenshots when using the generic screenshot capture code (default: png).
|-
| --config-override || Use a specific config override filename.
|-
| --random-inputs || Use random inputs instead of values from physical controllers.
|-
| --log-unit-test || Enable log in unit test mode.
|-
| --break-on-start, -bos || Break at the start of the rom.
|-
| --record-input || Record input
|-
| --screenshot-write-queue-capacity=<1..n> || Change the capacity of the screenshot queue (default: thread-count * 2 + 1).
|-
| --random-inputs-seed=<0..n> || Change the random inputs seed value (default: 0).
|-
| --listen-address=<address> || Specify the service address to listen to (default: 0.0.0.0).
|-
| --gui, -gui || Use the GUI mode
|-
| --break-on-start-dsp, -bosd || Break at the start of the dsp program.
|-
| --no-db-config || Do not use the ROM DB config override.
|-
| --features || Print features and exit.
|-
|}

This emulator uses various hashes, SHA-1 is used for this.

This supports loading Bios from a file where the path is determined using the specified LanguageCode, when config flags "Emulate" and "LoadBios" are true, however with the MarioSunshine config the latter config flag is false.

RomFs contains the following:
* "/hagi.config": Emulator json configuration.
* "/hagi-override.config": Emulator json configuration.
* "/rom.json": ROM json configuration, contains the following fields:
** "UID": Game-name.
** "DolHash": Hash.
** "ROM": An array of strings for the absolute file path for the ROM. In this case, it only contains the following: "rom:/MarioSunshine/Super_Mario_Sunshine_Stardust-trimmed.gcm".
* "/.nrr/Hagi.nrr": [[NRR]] for the AOT [[NRO]].
* "/MarioSunshine/": This contains the following:
** "Super_Mario_Sunshine_Stardust-trimmed.gcm": This is the .gcm image mentioned above.
** "Super_Mario_Sunshine_Stardust-trimmed.hash": Contains json configuration for various hashes.
* "/data/": This contains the following:
** "database/": This contains the following:
*** "config/MarioSunshine.config": This contains game-specific emulator json configuration.
*** "hagi/MarioSunshine.json": This contains ROM json configuration. IDs, names, etc. This also contains various hashes, including a duplicate of the above .hash file.
*** "pip/MarioSunshine/pipelineDB.pip"
*** "vulkan/MarioSunshine/B1317A6632265CF763766CF6339AC8D1.cache": This is the .cache file mentioned in [[#Savedata]].
** "gekko/MarioSunshine/nx/MarioSunshine.nrolz": This is the AOT [[NRO]]. LZ4 compressed, first 4-bytes is the big-endian decompressed size, then the compressed data follows.
** "lazy_texture_replace/MarioSunshine": Contains PNG textures.
** "saves/MarioSunshine/A.sav": Savedata. Presumably used to create the initial savedata file?
** "texture_replace/": Contains "MarioSunshine.har" and "MarioSunshine.hix".
** "video_replace/MarioSunshine/": Contains MP4 videos.

== AOT NRO ==
This section documents the AOT NRO. There are only two symbols from NRO which the main-codebin does lookup for and uses: "SetGekkoMemoryPointer" and "GetStatifierInfo".

During initialization, <code>nn::os::AllocateAddressRegion</code> is used with size 0x100200000. Then <code>nn::os::AllocateMemoryPages</code> is used (which uses [[SVC#MapPhysicalMemory|svcMapPhysicalMemory]]):
* base+0 size 0x1000 is allocated.
* base+0x80000000 size 0x1800000 is allocated.
* base+0xE0000000 size 0x4000 is allocated.
* base+0xFFF00000 size 0x200000 is allocated.

Initially SetGekkoMemoryPointer is called with base+0x80000000, however at some point it's called (?) with base+0.

The AOT NRO does all main-memory accesses by accessing {global ptr set by SetGekkoMemoryPointer}+{ppc_addr}. Therefore, above base+0 == ppc_addr 0x0. Since svcMapPhysicalMemory is used above, attempting to access any PPC-addrs not in the allocated regions above will result in the emulator crashing due to accessing unmapped memory - accessing non-PPC emulator data with invalid PPC-addrs is not possible. These crashes may happen when attempting to run a different .dol with the emulator as previously mentioned.

GetStatifierInfo takes an input string param and an output u64* param. This returns a bool: 0 = error, 1 = success. The NRO compares the input string with various strings to determine an array index, returning 0 if there's no match. Otherwise, the u64 data from the located array entry is copied to the output u64.
* "GET_FUNCTION_INFO": Ptr to a table, where each entry is 0x18-bytes. Structure: +0x0 = ppc_code_addr, +0x8 = nro_code_addr, +0x10 = string ptr (normally "").
* "GET_FUNCTION_INFO_SIZE" Ptr to the size of the FUNCTION_INFO table, in entries.
* ...

Each func in the NRO listed in the above table (which are the AOT funcs) is called with x0={state ptr}, where state contains:
* +0x0: u32 array for the PPC GPRs.
* ...

= SuperMarioGalaxy =
This appears to use an emulator similar to the one used by [[#SuperMarioSunshine]]. The code/data for the MarioGalaxy executable is included directly in the main-codebin.

RomFs contains the following:
* "/hagi.config": This is mostly the same as the "/hagi.config" for [[#SuperMarioSunshine]], except with various config fields adjusted.
* "/data/": This contains the following:
** "database/": This contains "pip/pipelineDB.pip" and "vulkan/FDBD9F0C3FEA5778E10FFFA74093E0B8.cache".
** "dsp/": This contains "drom.bin" and "irom.bin".
** "ondemand_texture_replace/MarioGalaxy/": This contains PNG textures.
** "texture_replace/": This contains "MarioGalaxy.har", "MarioGalaxy.hix", "MarioGalaxy_<language>.har", "MarioGalaxy_<language>.hix", "MarioGalaxy_Sub.har", "MarioGalaxy_Sub.hix".
** "video_replace/MarioGalaxy/MovieData/": This contains MP4 videos.
* The rest is the MarioGalaxy game assets stored directly in RomFs.

= Versions =
This section documents the game-update changes.

== v1.0.1 ==
In ExeFs, the only [[NPDM]] change was the usual ACID pubkey/signature update. The only other ExeFs change, was that the main-codebin was updated only for SuperMarioSunshine/SuperMarioGalaxy.

RomFs changes:
* Launcher: Not updated.
* SuperMario64: Both [[NRR]]s were updated, pubkey/signature was updated. No other files were updated.
* SuperMarioSunshine: Only "/.nrr/Hagi.nrr" was updated, same as above.
* SuperMarioGalaxy:
** "/data/texture_replace/": Various files here were updated.
** "/<language>/LayoutData/Font.arc": Updated.
** "/LayoutData/CameraInfo.arc", "/LayoutData/IconAButton.arc", "/StationedData/GDDR3.arc", "/StationedData/GDDR3.zst": Updated.

== v1.1.0 ==
ExeFs:
* Updated for using SDK 10.8.1.0, except for SuperMarioSunshine/SuperMarioGalaxy.
* NPDMs for all Programs only had the usual update (see [[#v1.0.1]]).
** Launcher: All files in ExeFs were updated.
** SuperMario64: All files in ExeFs were updated, except subsdk*.
** SuperMarioSunshine/SuperMarioGalaxy: Only main-codebin and the NPDM were updated.

RomFs:
* Launcher: The following was updated:
** /Layout/CursorArrow.Nin_NX_NVN.blarc.zs
** /Layout/DialogKeyButton.Nin_NX_NVN.blarc.zs
** /Layout/DialogTwoButton.Nin_NX_NVN.blarc.zs
** /Message/Msg_CNzh.d.sarc.zs
** /Message/Msg_JPja.d.sarc.zs
* SuperMario64: The following was updated:
** /nro/05_UNSMJ3.002.nro
** /nro/EmuSystemJITPlugin.nro
*** This appears to be just a rebuild. A func called by _fini/etc was updated, nothing else specific to the plugin was changed in .text. The .nrs build filepath was also changed.
** /nro/NROBuilder.nro
** /.nrr/04_UNSMJ3.002.nrr
** /.nrr/EmuAppNX64.nrr
** /Pipeline.cache
** "/rom/Stardust_JP/00_UNSMJ3.002.meta" Newlines now use LF instead of CRLF.
** "/rom/Stardust_JP/02_UNSMJ3.002.cfg" Newlines now use LF instead of CRLF. The content of the "Comment" entries under "SpecialInst" had the string characters replaced with '*' (for redacting the string). The Lua hook entries were updated under "SpecialInst". The "Comment" entries under "VertexHack" were redacted the same way, nothing else changed under "VertexHack".
** /rom/Stardust_JP/04_UNSMJ3.002.nrr
** /rom/Stardust_JP/05_UNSMJ3.002.nro
** "/rom/Stardust_JP/06_UNSMJ3.002.lua" Newlines now use LF instead of CRLF. Comments were redacted, see above. HookFunc_AfterInst was updated for handling the updated hooks mentioned above.
* SuperMarioSunshine:
** "/data/database/config/MarioSunshine.config" The config entries for "KeyPadAxisTriggerLeft"/"KeyPadAxisTriggerRight" were updated.
** "/data/gekko/MarioSunshine/nx/MarioSunshine.nrolz" updated
** The following files were added under "/data/lazy_texture_replace/MarioSunshine/":
*** 5323227429978722713_lod1.png
*** 5323227429978722713_lod2.png
*** 5323227429978722713_lod3.png
*** 5323227429978722713.png
** "/hagi-override.config" Formatting was adjusted.
** "/MarioSunshine/Super_Mario_Sunshine_Stardust-trimmed.gcm" updated
** "/.nrr/Hagi.nrr" updated
** "/rom.json" The DolHash was updated.
* SuperMarioGalaxy: The only change was removing the following files from "/StationedData/":
** DEBUG.arc
** DEBUG.zst
** GDDR3.arc
** NAPA.zst

The Manual RomFs for each game was also updated.

DeltaFragment NCAs were also added.

== v1.1.1 ==
ExeFs:
* NPDMs for all Programs only had the usual update (see [[#v1.0.1]]).
* The only other change was updating the main-codebin for SuperMario64.

RomFs: ...

= Savedata =
The savedata contains the following:

* "/PlayReport/account.prsav"
* "/StardustLauncher/game_data.sav"
* "/Mario64/Mario64.sav": The raw N64 savedata.
* "/MarioSunshine/": This contains the following data, for MarioSunshine:
** "gekko/log/", "gekko/trace/", and "hanafuda/": Empty directories.
** "A.sav": The memory card image. The first 4-bytes are the big-endian decompressed size, followed by the LZ4 compressed data.
** "B.raw": Uncompressed raw version of the memory card image. All-zeros, since it doesn't seem to be used after creation? This normally doesn't exist: this only exists if the application had argv parameter "--card-uncompressed" passed.
** "B1317A6632265CF763766CF6339AC8D1.cache": This is probably graphics pipeline related?(RomFs has an identical file)
* "/MarioGalaxy/GameData.bin": The savedata for SuperMarioGalaxy.

Super Mario 3D All-Stars

2022-04-15T14:46:41Z

Liamwhite: fix wiki syntax

Super Mario 3D All-Stars

2022-04-15T14:35:44Z

Liamwhite: Add argument table for Sunshine Hagi