Nintendo Switch Brew

Applet Manager services: Difference between revisions

← Older edit
No edit summary
 
(53 intermediate revisions by 4 users not shown)
Line 11: Line 11:
|-
|-
| 100 || OpenSystemAppletProxy || Returns an [[#ISystemAppletProxy]].
| 100 || OpenSystemAppletProxy || Returns an [[#ISystemAppletProxy]].
|-
| 110 || [20.0.0+] ||
|-
|-
| 200 || OpenLibraryAppletProxyOld ([1.0.0-2.3.0] OpenLibraryAppletProxy) || Returns an [[#ILibraryAppletProxy]].
| 200 || OpenLibraryAppletProxyOld ([1.0.0-2.3.0] OpenLibraryAppletProxy) || Returns an [[#ILibraryAppletProxy]].
Line 23: Line 25:
|-
|-
| 410 || [6.0.0+] [[#GetSystemAppletControllerForDebug]] ||  
| 410 || [6.0.0+] [[#GetSystemAppletControllerForDebug]] ||  
|-
| 450 || [19.0.0+] [[#GetSystemProcessCommonFunctions]] ||
|-
| 460 || [20.0.0+] ||
|-
|-
| 1000 || [6.0.0+] [[#GetDebugFunctions]] ||  
| 1000 || [6.0.0+] [[#GetDebugFunctions]] ||  
Line 58: Line 64:


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.
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.
== GetSystemProcessCommonFunctions ==
No input. Returns an [[#ISystemProcessCommonFunctions]].


== GetDebugFunctions ==
== GetDebugFunctions ==
Line 65: Line 74:


== ISystemAppletProxy ==
== ISystemAppletProxy ==
This is "nn::am::service::ISystemAppletProxy".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 95: Line 106:


=== IHomeMenuFunctions ===
=== IHomeMenuFunctions ===
This is "nn::am::service::IHomeMenuFunctions".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 116: Line 129:
|-
|-
| 41 || [12.0.0+] [[#IsRebootEnabled]]
| 41 || [12.0.0+] [[#IsRebootEnabled]]
|-
| 50 || [16.0.0+] [[#LaunchSystemApplet]]
|-
| 51 || [16.0.0+] [[#LaunchStarter]]
|-
| 60 || [19.0.0+]
|-
| 61 || [19.0.0+]
|-
|-
| 100 || [6.0.0+] [[#PopRequestLaunchApplicationForDebug]]
| 100 || [6.0.0+] [[#PopRequestLaunchApplicationForDebug]]
Line 156: Line 177:
==== IsRebootEnabled ====
==== IsRebootEnabled ====
No input, returns an output bool.
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 ====
==== PopRequestLaunchApplicationForDebug ====
Line 172: Line 205:
The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.
The cached value loaded from [[Settings_services#GetDebugModeFlag]] must be 1, otherwise an error is returned.


Uses [[NS_Services#IApplicationManagerInterface]] cmd99.
Uses [[NS_Services|ns]] LaunchDevMenu.


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


==== ILockAccessor ====
==== ILockAccessor ====
This is "nn::am::service::ILockAccessor".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 210: Line 245:


=== IGlobalStateController ===
=== IGlobalStateController ===
This is "nn::am::service::IGlobalStateController".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 326: Line 363:


=== IApplicationCreator ===
=== IApplicationCreator ===
This is "nn::am::service::IApplicationCreator".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 358: Line 397:


==== IApplicationAccessor ====
==== IApplicationAccessor ====
This is "nn::am::service::IApplicationAccessor".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 413: Line 454:
|-
|-
| 201 || [10.0.0+] [[#RestartApplicationTimer]] ||
| 201 || [10.0.0+] [[#RestartApplicationTimer]] ||
|-
| 300 || [20.0.0+] ||
|-
| 301 || [20.0.0+] ||
|}
|}


Line 500: Line 545:


===== IAppletAccessor =====
===== IAppletAccessor =====
This is "nn::am::service::IAppletAccessor".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 536: Line 583:


== IAppletCommonFunctions ==
== IAppletCommonFunctions ==
Added with [[7.0.0]].
This is "nn::am::service::IAppletCommonFunctions".
 
This was added with [7.0.0+].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 569: Line 618:
|-
|-
| 70 || [11.0.0+] [[#SetCpuBoostRequestPriority]]
| 70 || [11.0.0+] [[#SetCpuBoostRequestPriority]]
|}
|-
 
| 80 || [14.0.0+] SetHandlingCaptureButtonShortPressedMessageEnabledForApplet
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>
|-
 
| 81 || [14.0.0+] SetHandlingCaptureButtonLongPressedMessageEnabledForApplet
=== ReadThemeStorage ===
|-
Takes an input u64 '''offset''' and a type-0x22 output buffer, returns an output u64 '''actual_transfer_size'''.
| 82 || [18.0.0+] SetBlockingCaptureButtonInEntireSystem
 
|-
| 90 || [15.0.0+] OpenNamedChannelAsParent
|-
| 91 || [15.0.0+] OpenNamedChannelAsChild
|-
| 100 || [15.0.0+] SetApplicationCoreUsageMode
|-
| 160 || [18.0.0+] GetNotificationReceiverService
|-
| 161 || [18.0.0+] GetNotificationSenderService
|-
| 300 || [17.0.0+] GetCurrentApplicationId
|-
| 310 || [19.0.0+] IsSystemAppletHomeMenu
|-
| 311 || [20.0.0+]
|-
| 320 || [19.0.0+] SetGpuTimeSliceBoost
|-
| 321 || [19.0.0+] SetGpuTimeSliceBoostDueToApplication
|-
| 322 || [20.0.0+]
|-
| 330 || [19.0.0+]
|-
| 340 || [20.0.0+]
|-
| 341 || [20.0.0+]
|-
| 342 || [20.0.0+]
|-
| 350 || [20.0.0+]
|-
| 360 || [20.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 ===
=== WriteThemeStorage ===
Takes an input u64 '''offset''' and a type-0x21 input buffer, no output.
Takes an input u64 '''offset''' and a type-0x21 input buffer, no output.
Line 615: Line 704:


== ILibraryAppletProxy ==
== ILibraryAppletProxy ==
This is "nn::am::service::ILibraryAppletProxy".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 636: Line 727:
|-
|-
| 21 || [7.0.0+] GetAppletCommonFunctions || No input, returns an [[#IAppletCommonFunctions]].
| 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]].
| 1000 || GetDebugFunctions || Returns an [[#IDebugFunctions]].
Line 641: Line 736:


=== ILibraryAppletSelfAccessor ===
=== ILibraryAppletSelfAccessor ===
This is "nn::am::service::ILibraryAppletSelfAccessor".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 714: Line 811:
|-
|-
| 150 || [10.0.0+] [[#ShouldSetGpuTimeSliceManually]] ||
| 150 || [10.0.0+] [[#ShouldSetGpuTimeSliceManually]] ||
|-
| 160 || [17.0.0+] [[#GetLibraryAppletInfoEx]] ||
|}
|}


Line 846: Line 945:
==== ShouldSetGpuTimeSliceManually ====
==== ShouldSetGpuTimeSliceManually ====
No input, returns an output u8 bool.
No input, returns an output u8 bool.
==== GetLibraryAppletInfoEx ====
No input, returns an output u64. Currently always returns 0.


== IOverlayAppletProxy ==
== IOverlayAppletProxy ==
This is "nn::am::service::IOverlayAppletProxy".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 869: Line 973:
|-
|-
| 21 || [7.0.0+] GetAppletCommonFunctions || No input, returns an [[#IAppletCommonFunctions]].
| 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]].
| 1000 || GetDebugFunctions || Returns an [[#IDebugFunctions]].
Line 874: Line 980:


=== IOverlayFunctions ===
=== IOverlayFunctions ===
This is "nn::am::service::IOverlayFunctions".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 897: Line 1,005:
|-
|-
| 20 || [8.0.0+] [[#SetHandlingHomeButtonShortPressedEnabled]]
| 20 || [8.0.0+] [[#SetHandlingHomeButtonShortPressedEnabled]]
|-
| 21 || [14.0.0+] SetHandlingTouchScreenInputEnabled
|-
|-
| 30 || [9.0.0+] [[#SetHealthWarningShowingState]]
| 30 || [9.0.0+] [[#SetHealthWarningShowingState]]
|-
|-
| 31 || [10.0.0+] [[#IsHealthWarningRequired]]
| 31 || [10.0.0+] [[#IsHealthWarningRequired]]
|-
| 40 || [18.0.0+] GetApplicationNintendoLogo
|-
| 41 || [18.0.0+] GetApplicationStartupMovie
|-
| 50 || [19.0.0+] SetGpuTimeSliceBoostForApplication
|-
| 60 || [19.0.0+]
|-
|-
| 90 || [7.0.0+] [[#SetRequiresGpuResourceUse]]
| 90 || [7.0.0+] [[#SetRequiresGpuResourceUse]]
Line 966: Line 1,084:


== IApplicationProxy ==
== IApplicationProxy ==
This is "nn::am::service::IApplicationProxy".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 990: Line 1,110:


=== IApplicationFunctions ===
=== IApplicationFunctions ===
This is "nn::am::service::IApplicationFunctions".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 1,036: Line 1,158:
| 33 || [[#EndBlockingHomeButton]]
| 33 || [[#EndBlockingHomeButton]]
|-
|-
| 34 || [10.0.0+] [[#SelectApplicationLicense]]
| 34 || [10.0.0-15.0.1] [[#SelectApplicationLicense]]
|-
|-
| 35 || [11.0.0+] [[#GetDeviceSaveDataSizeMax]]
| 35 || [11.0.0+] [[#GetDeviceSaveDataSizeMax]]
|-
| 36 || [14.0.0+] GetLimitedApplicationLicense
|-
| 37 || [14.0.0+] GetLimitedApplicationLicenseUpgradableEvent
|-
|-
| 40 || [[#NotifyRunning]]
| 40 || [[#NotifyRunning]]
Line 1,073: Line 1,199:
|-
|-
| 111 || [6.0.0+] [[#QueryApplicationPlayStatisticsByUid]]
| 111 || [6.0.0+] [[#QueryApplicationPlayStatisticsByUid]]
|-
| 112 || [20.0.0+]
|-
| 113 || [20.0.0+]
|-
|-
| 120 || [5.0.0+] [[#ExecuteProgram]]
| 120 || [5.0.0+] [[#ExecuteProgram]]
Line 1,108: Line 1,238:
| 200 || [11.0.0+] [[#GetLastApplicationExitReason]]
| 200 || [11.0.0+] [[#GetLastApplicationExitReason]]
|-
|-
| 500 || [5.0.0+] [[#StartContinuousRecordingFlushForDebug]]
| 210 || [20.0.0+]
|-
| 220 || [20.0.0+]
|-
| 300 || [19.0.0+] [[#CreateMovieWriter]]
|-
| 310 || [20.0.0+]
|-
| 320 || [20.0.0+]
|-
| 500 || [5.0.0+] [[#StartContinuousRecordingFlushForDebug]]
|-
|-
| 1000 || [5.0.0+] [[#CreateMovieMaker]]
| 1000 || [5.0.0+] [[#CreateMovieMaker]]
Line 1,266: Line 1,406:


User-processes create the tmem with an user-specified buffer with permissions=0. '''width''' = 1280 and '''height''' = 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.
This is used as an overlay for screenshots.
Line 1,373: Line 1,515:
==== GetLastApplicationExitReason ====
==== GetLastApplicationExitReason ====
No input, returns an output s32.
No input, returns an output s32.
==== CreateMovieWriter ====
Takes 8-bytes of input and a handle. Returns an [[#IMovieWriter]].
This internally uses the GRC cmd to open an [[GRC_services|IMovieWriter]]. This is therefore not usable on NX since that cmd is stubbed.


==== StartContinuousRecordingFlushForDebug ====
==== StartContinuousRecordingFlushForDebug ====
Line 1,387: Line 1,534:


==== PrepareForJit ====
==== PrepareForJit ====
Takes no input. Launches the [[JIT_services|jit-sysmodule]] 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.
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:
~IApplicationFunctions() includes:
Line 1,397: Line 1,544:


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.
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.
=== IMovieWriter ===
This is "nn::am::service::IMovieWriter".
This was added with [19.0.0+].
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 ||
|}
==== Cmd0 ====
No input. Returns a GRC [[GRC_services|IMovieWriter]].


=== IMovieMaker ===
=== IMovieMaker ===
This is "nn::am::service::IMovieMaker".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 1,415: Line 1,581:


== ILibraryAppletCreator ==
== ILibraryAppletCreator ==
This is "nn::am::service::ILibraryAppletCreator".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 1,424: Line 1,592:
|-
|-
| 2 || [[#AreAnyLibraryAppletsLeft]] ||
| 2 || [[#AreAnyLibraryAppletsLeft]] ||
|-
| 3 || [20.0.0+] ||
|-
|-
| 10 || [[#CreateStorage]] ||  
| 10 || [[#CreateStorage]] ||  
Line 1,467: Line 1,637:


=== ILibraryAppletAccessor ===
=== ILibraryAppletAccessor ===
This is "nn::am::service::ILibraryAppletAccessor".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 1,486: Line 1,658:
|-
|-
| 60 || [10.0.0+] [[#PresetLibraryAppletGpuTimeSliceZero]] ||
| 60 || [10.0.0+] [[#PresetLibraryAppletGpuTimeSliceZero]] ||
|-
| 80 || [19.0.0+] RequestForLibraryAppletToGetForeground ||
|-
| 81 || [19.0.0+] GetCurrentChildLibraryApplet ||
|-
| 90 || [20.0.0+] ||
|-
|-
| 100 || [[#PushInData]] ||  
| 100 || [[#PushInData]] ||  
Line 1,559: Line 1,737:


== ICommonStateGetter ==
== ICommonStateGetter ==
This is "nn::am::service::ICommonStateGetter".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 1,592: Line 1,772:
|-
|-
| 14 || [11.0.0+] [[#GetWakeupCount]]
| 14 || [11.0.0+] [[#GetWakeupCount]]
|-
| 15 || [19.0.0+]
|-
|-
| 20 || [[#PushToGeneralChannel]]
| 20 || [[#PushToGeneralChannel]]
Line 1,662: Line 1,844:
|-
|-
| 503 || [12.0.0+] IsDisablingSleepSuppressed
| 503 || [12.0.0+] IsDisablingSleepSuppressed
|-
| 600 || [20.0.0+] ([17.0.0-18.1.0] OpenNamedChannelAsChild)
|-
|-
| 900 || [11.0.0+] [[#SetRequestExitToLibraryAppletAtExecuteNextProgramEnabled]]
| 900 || [11.0.0+] [[#SetRequestExitToLibraryAppletAtExecuteNextProgramEnabled]]
|-
| 910 || [17.0.0+] GetLaunchRequiredTick
|-
| 1000 || [19.0.0+] BeginVrMode3d
|-
| 1001 || [19.0.0+] EndVrMode3d
|-
| 1002 || [19.0.0+] IsVrModeEnabled3d
|}
|}


Line 1,854: Line 2,046:
=== ActivateMigrationService ===
=== ActivateMigrationService ===
No input/output.
No input/output.
Besides various other functionality, if required this eventually uses [[NS_Services|ns]] LaunchLibraryApplet to launch [[Migration_services|migration]].


=== DeactivateMigrationService ===
=== DeactivateMigrationService ===
Line 1,904: Line 2,098:


== ISelfController ==
== ISelfController ==
This is "nn::am::service::ISelfController".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 1,943: Line 2,139:
|-
|-
| 21 || [13.0.0+] GetScreenShotProgramId
| 21 || [13.0.0+] GetScreenShotProgramId
|-
| 22 || [19.0.0+] GetScreenShotAcdIndex
|-
| 23 || [19.0.0+] GetScreenShotApparentPlatform
|-
| 24 || [19.0.0+] GetScreenShotApplicationProperty
|-
|-
| 40 || [[#CreateManagedDisplayLayer]]
| 40 || [[#CreateManagedDisplayLayer]]
Line 2,002: Line 2,204:
| 130 || [13.0.0+] [[#SetRecordVolumeMuted]]
| 130 || [13.0.0+] [[#SetRecordVolumeMuted]]
|-
|-
| 1000 || [7.0.0+] [[#GetDebugStorageChannel]]
| 200 || [20.0.0+]
|-
| 210 || [20.0.0+]
|-
| 211 || [20.0.0+]
|-
| 220 || [20.0.0+]
|-
| 221 || [20.0.0+]
|-
| 230 || [20.0.0+]
|-
| 1000 || [7.0.0+] [[#GetDebugStorageChannel]]
|}
|}


Line 2,235: Line 2,449:


== IStorageChannel ==
== IStorageChannel ==
Added with [[7.0.0]].
This is "nn::am::service::IStorageChannel".
 
This was added with [7.0.0+].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 2,253: Line 2,469:


== IWindowController ==
== IWindowController ==
This is "nn::am::service::IWindowController".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 2,309: Line 2,527:


== IAudioController ==
== IAudioController ==
This is "nn::am::service::IAudioController".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 2,322: Line 2,542:
|-
|-
| 4 || [[#SetTransparentVolumeRate]]
| 4 || [[#SetTransparentVolumeRate]]
|-
| 5 || [20.0.0+]
|}
|}


Line 2,344: Line 2,566:


== IDisplayController ==
== IDisplayController ==
This is "nn::am::service::IDisplayController".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 2,546: Line 2,770:


== ISystemAppletControllerForDebug ==
== ISystemAppletControllerForDebug ==
This is "nn::am::service::ISystemAppletControllerForDebug".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 2,569: Line 2,795:


== IProcessWindingController ==
== IProcessWindingController ==
This is "nn::am::service::IProcessWindingController".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 2,617: Line 2,845:
=== ReserveToStartAndWait ===
=== ReserveToStartAndWait ===
Takes an input [[#ILibraryAppletAccessor]], no output.
Takes an input [[#ILibraryAppletAccessor]], no output.
== ISystemProcessCommonFunctions ==
This is "nn::am::service::ISystemProcessCommonFunctions".
This was added with [19.0.0+].
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 ||
|}
=== Cmd0 ===
No input. Returns an [[#IApplicationObserver]].
=== IApplicationObserver ===
This is "nn::am::service::IApplicationObserver".
This was added with [19.0.0+].
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 1 ||
|-
| 2 ||
|-
| 10 ||
|-
| 20 ||
|-
| 30 ||
|}


== IDebugFunctions ==
== IDebugFunctions ==
This is "nn::am::service::IDebugFunctions".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 2,633: Line 2,898:
| 30 || [6.0.0+] [[#RequestLaunchApplicationWithUserAndArgumentForDebug]]
| 30 || [6.0.0+] [[#RequestLaunchApplicationWithUserAndArgumentForDebug]]
|-
|-
| 31 || [12.0.0+] RequestLaunchApplicationByApplicationLaunchInfoForDebug
| 31 || [12.0.0+] [[#RequestLaunchApplicationByApplicationLaunchInfoForDebug]]
|-
|-
| 40 || [6.0.0+] [[#GetAppletResourceUsageInfo]]
| 40 || [6.0.0+] [[#GetAppletResourceUsageInfo]]
|-
| 50 || [15.0.0+] AddSystemProgramIdAndAppletIdForDebug
|-
| 51 || [16.0.0+] AddOperationConfirmedLibraryAppletIdForDebug
|-
| 52 || [17.0.0+] GetProgramIdFromAppletIdForDebug
|-
| 53 || [18.0.0+] GetProgramIdFromAppletIdAndLibraryAppletModeForDebug
|-
|-
| 100 || [7.0.0+] [[#SetCpuBoostModeForApplet]]
| 100 || [7.0.0+] [[#SetCpuBoostModeForApplet]]
Line 2,656: Line 2,929:
|-
|-
| 132 || [9.0.0+] [[#FriendInvitationPushApplicationParameter]]
| 132 || [9.0.0+] [[#FriendInvitationPushApplicationParameter]]
|-
| 140 || [14.0.0+] RestrictPowerOperationForSecureLaunchModeForDebug
|-
| 200 || [15.0.0+] CreateFloatingLibraryAppletAccepterForDebug
|-
| 300 || [16.0.0+] TerminateAllRunningApplicationsForDebug
|-
| 410 || [18.0.0+] CreateGeneralStorageForDebug
|-
| 411 || [18.0.0+] ReadGeneralStorageForDebug
|-
| 412 || [18.0.0+] WriteGeneralStorageForDebug
|-
| 430 || [20.0.0+]
|-
| 431 || [20.0.0+]
|-
|-
| 900 || [12.0.0+] GetGrcProcessLaunchedSystemEvent
| 900 || [12.0.0+] GetGrcProcessLaunchedSystemEvent
|-
| 910 || [20.0.0+]
|}
|}


Line 2,680: Line 2,971:


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]]).
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]]).
=== RequestLaunchApplicationByApplicationLaunchInfoForDebug ===
Takes a total of 0x58-bytes of input, a type-0x5 input buffer containing an array of 0x10-byte entries, and a type-0x5 input buffer. No output.
[19.0.0+] Takes a total of 0x88-bytes of input, a type-0x5 input buffer containing an array of 0x10-byte entries, and a type-0x5 input buffer. No output.


=== GetAppletResourceUsageInfo ===
=== GetAppletResourceUsageInfo ===
Line 2,737: Line 3,033:


== IStorage ==
== IStorage ==
This is "nn::am::service::IStorage".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 2,751: Line 3,049:


== IStorageAccessor ==
== IStorageAccessor ==
This is "nn::am::service::IStorageAccessor".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 2,763: Line 3,063:


== ITransferStorageAccessor ==
== ITransferStorageAccessor ==
This is "nn::am::service::ITransferStorageAccessor".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 2,785: Line 3,087:


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.
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.
= (Switch 2) appletOE =
[S2] This is "nn::am::service::IApplicationProxyServiceForNxCompat".
{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || [[#OpenApplicationProxy]] ||
|-
| 2000 || [[#OpenCompatApplicationFunctions]] ||  Returns an [[#(Switch 2) INxCompatApplicationFunctions]]
|}


== OpenApplicationProxy ==
== OpenApplicationProxy ==
Line 2,793: Line 3,107:
On failure, official user-processes will retry using this command in a loop while the retval is 0x19280, with svcSleepThread(10000000) being called first.
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 =
= (Switch 2) INxCompatApplicationFunctions =
This is "nn::idle::detail::IPolicyManagerSystem"
This is "nn::am::service::INxCompatApplicationFunctions".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
! Cmd || Name || Notes
|-
| 2000 || GetTipcCompatInterface? || Returns a TIPC handle to [[#TipcCompatInterface]].
|-
| 2001 || ||
|-
| 2002 || ||
|-
| 2003 || || Called directly after "nn::vi::WriteToCopyrightFramebuffer".
|-
| 2004 || ||
|-
|-
| 0 || GetAutoPowerDownEvent
| 2010 || ||  
|-
|-
|rowspan="2"| 1 || [1.0.0-3.0.2]
| 2020 || Initialize? || Called during init. Takes no args.
|-
|-
| [7.0.0+] IsAutoPowerDownRequested
| 2030 || GetVsyncEvent? || Takes no args. Returns a event handle.
|-
|-
| 2 || [1.0.0-3.0.2]
| 2040 || GetVsyncTimestamp? || When above event triggers, this returns a timestamp.
|-
|-
| 3 || [[#SetHandlingContext]]
| 2050 || ||
|-
|-
| 4 || LoadAndApplySettings
| 2060 ||  ||  
|-
|-
| 5 || ReportUserIsActive
| 2070 || CreateMovieMaker || Same args as [[#CreateMovieMaker]]. Returns an [[#IMovieMaker]].
|}
|}


== SetHandlingContext ==
== (Switch 2) TipcCompatInterface ==
[3.0.0+] Now takes an additional 0x10-bytes of input.
{| class="wikitable" border="1"
 
|-
[13.0.0+] Total input size is now 0x30 instead of 0x38.
! Cmd (adjusted - 16) || Name || Notes
 
|-
= omm =
| 4 || InitializeA || Sends current process handle, and struct { u64 aruid; u64 always_0x8000000000000005; u64 always_0; u64 always_0; u64 always_0; u64 svc_get_info_31_or_32_output; }.
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*]].
 
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
| 11 || InitializeB || Sends current process handle. No args. Sent directly after cmd4.
|-
|-
| 0 || GetOperationMode
| 101 || InitializeC || Sent directly after cmd11.
|-
|-
| 1 || GetOperationModeChangeEvent
| 111 || ||
|-
|-
| 2 || EnableAudioVisual
| 112 || ||
|-
|-
| 3 || DisableAudioVisual
| 114 || ||
|-
|-
| 4 || EnterSleepAndWait
| 115 || ||
|-
|-
| 5 || GetCradleStatus
| 187 || ||
|-
|-
| 6 || FadeInDisplay
| 201 || ||
|-
|-
| 7 || FadeOutDisplay
| 301 || ||
|-
|-
| 8 || [2.0.0+] GetCradleFwVersion
| 327 || ||
|-
|-
| 9 || [2.0.0+] NotifyCecSettingsChanged
| 303 || ||
|-
|-
| 10 || [3.0.0+] SetOperationModePolicy
| 311 || ||
|-
|-
| 11 || [3.0.0+] GetDefaultDisplayResolution
| 312 || ||
|-
|-
| 12 || [3.0.0+] GetDefaultDisplayResolutionChangeEvent
| 314 || ||
|-
|-
| 13 || [3.0.0+] UpdateDefaultDisplayResolution
| 315 || ||
|-
|-
| 14 || [3.0.0+] ShouldSleepOnBoot
| 321 || ||
|-
|-
| 15 || [4.0.0+] NotifyHdcpApplicationExecutionStarted
| 391 || ||
|-
|-
| 16 || [4.0.0+] NotifyHdcpApplicationExecutionFinished
| 401 || ||
|-
|-
| 17 || [4.0.0+] NotifyHdcpApplicationDrawingStarted
| 402 || ||
|-
|-
| 18 || [4.0.0+] NotifyHdcpApplicationDrawingFinished
| 423 || ||
|-
|-
| 19 || [4.0.0+] GetHdcpAuthenticationFailedEvent
| 434 || ||
|-
|-
| 20 || [4.0.0+] GetHdcpAuthenticationFailedEmulationEnabled
| 497 || ||
|-
|-
| 21 || [4.0.0+] SetHdcpAuthenticationFailedEmulation
| 901 || ||
|-
|-
| 22 || [4.0.0+] GetHdcpStateChangeEvent
| 902 || ||
|-
|-
| 23 || [4.0.0+] GetHdcpState
| 903 || ||
|-
|-
| 24 || [5.0.0+] ShowCardUpdateProcessing
| 905 || ||
|-
|-
| 25 || [5.0.0+] SetApplicationCecSettingsAndNotifyChanged
| 911 || ||
|-
|-
| 26 || [7.0.0+] [[#GetOperationModeSystemInfo]]
| 912 || ||
|-
|-
| 27 || [9.0.0+] GetAppletFullAwakingSystemEvent
| 922 || ||
|-
|-
| 28 || [12.0.0+] [[#CreateCradleFirmwareUpdater]]
| 961 || ||
|}
|-
 
| 991 || ||
== GetOperationModeSystemInfo ==
|-
No input, returns an output u32.
| 1001 || ||
 
|-
This is used by [[#GetOperationModeSystemInfo|ICommonStateGetter GetOperationModeSystemInfo]].
| 1002 || ||
 
|-
== CreateCradleFirmwareUpdater ==
| 1003 || ||
No input. Returns an [[#ICradleFirmwareUpdater]].
|-
 
| 1101 || ||
== ICradleFirmwareUpdater ==
|-
This is "nn::omm::detail::ICradleFirmwareUpdater".
| 1102 || ||
 
|-
This was added with [12.0.0+].
| 1401 || InitializeNvdrv2WithTransferMemory || Takes a TransferMemory handle, and u64 size. Returns an [[#INvDrv2User]].
 
|-
{| class="wikitable" border="1"
| 1402 || InitializeNvdrv2 || Returns an [[#INvDrv2User]].
|-
| 1501 || ||
|-
|-
! Cmd || Name
| 1502 || ||
|-
|-
| 0 || Start
| 1601 || ||
|-
|-
| 1 || Finish
| 1602 || ||
|-
|-
| 2 || GetUpdateDeviceStatus
| 1603 || ||
|-
|-
| 3 || GetUpdateProgress
| 1611 || ||
|-
|-
| 4 || GetUpdateDeviceStatusChangeEvent
| 1612 || ||
|-
|-
| 5 || GetUpdateProgress2
| 1691 || ||
|}
|}


= spsm =
== (Switch 2) INvDrv2User ==
This is "nn::spsm::detail::IPowerStateInterface".
This is "nn::nvdrv::INvDrv2User".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 2,926: Line 3,246:
! Cmd || Name
! Cmd || Name
|-
|-
| 0 || GetCurrentState
| 0 || Open
|-
|-
| 1 || EnterSleep
| 1 || Ioctl
|-
|-
| 2 || GetLastWakeReason
| 2 || Close
|-
|-
| 3 || Shutdown
| 4 || QueryEvent
|-
|-
| 4 || GetNotificationMessageEventHandle
| 9 || DumpStatus
|-
|-
| 5 || ReceiveNotificationMessage
| 10 || InitializeDevtools
|-
|-
| 6 || AnalyzeLogForLastSleepWakeSequence
| 11 || Ioctl2
|-
| 7 || ResetEventLog
|-
| 8 || AnalyzePerformanceLogForLastSleepWakeSequence
|-
|-
| 9 || ChangeHomeButtonLongPressingTime
| 12 || Ioctl3
|-
|-
| 10 || PutErrorState
| 13 || SetGraphicsFirmwareMemoryMarginEnabled
|-
| 11 || [1.0.0-3.0.2] InvalidateCurrentHomeButtonPressing
|}
|}


[3.0.0+] Cmd11 now takes a total of 8-bytes of input.
= idle:sys =
 
This is "nn::idle::detail::IPolicyManagerSystem"
= tcap =
This is "nn::tcap::server::IManager".


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


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


= caps:su =
== SetHandlingContext ==
This is "nn::capsrv::sf::IScreenShotApplicationService".
[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"


This was added with [[6.0.0]].
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 can be used by applications to save screenshots.
This was moved to [[OMM_services|omm]] with [14.0.0+].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Cmd || Name || Notes
! Cmd || Name
|-
|-
| 32 || [7.0.0+] SetShimLibraryVersion || Takes a total of 0x10-bytes of input and a PID, no output.
| 0 || GetOperationMode
|-
|-
| 201 || SaveScreenShot ||  
| 1 || GetOperationModeChangeEvent
|-
|-
| 203 || SaveScreenShotEx0 ||  
| 2 || EnableAudioVisual
|-
|-
| 205 || [8.0.0+] SaveScreenShotEx1 ||  
| 3 || DisableAudioVisual
|-
|-
| 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.
| 4 || EnterSleepAndWait
|}
 
'''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]].
 
= 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
| 5 || GetCradleStatus
|-
| 6 || FadeInDisplay
|-
|-
| 0x0 || 4 || 1 || Common Arguments version
| 7 || FadeOutDisplay
|-
|-
| 0x4 || 4 || 0x20 || Common Arguments size
| 8 || [2.0.0+] GetCradleFwVersion
|-
|-
| 0x8 || 4 || || Library applet version (API version)
| 9 || [2.0.0+] NotifyCecSettingsChanged
|-
|-
| 0xC || 4 || 0 || Theme color
| 10 || [3.0.0+] SetOperationModePolicy
|-
|-
| 0x10 || 1 || 0 || Play startup sound
| 11 || [3.0.0+] GetDefaultDisplayResolution
|-
|-
| 0x18 || 8 || N/A || System tick (see [[SVC#svcGetSystemTick|svcGetSystemTick]])
| 12 || [3.0.0+] GetDefaultDisplayResolutionChangeEvent
|-
|-
|}
| 13 || [3.0.0+] UpdateDefaultDisplayResolution
 
= AppletId =
This is "nn::applet::AppletId". See also [[:Category:Library Applets]].
 
{| class="wikitable" border="1"
|-
|-
! Value
| 14 || [3.0.0+] ShouldSleepOnBoot
! ProgramId
! Description
|-
|-
| 0x00
| 15 || [4.0.0+] NotifyHdcpApplicationExecutionStarted
|  
| None
|-
|-
| 0x01
| 16 || [4.0.0+] NotifyHdcpApplicationExecutionFinished
|  
| Application (not valid for use with LibraryApplets)
|-
|-
| 0x02
| 17 || [4.0.0+] NotifyHdcpApplicationDrawingStarted
| 010000000000100C
| OverlayApplet (overlayDisp)
|-
|-
| 0x03
| 18 || [4.0.0+] NotifyHdcpApplicationDrawingFinished
| 0100000000001000
| SystemAppletMenu (qlaunch)
|-
|-
| 0x04
| 19 || [4.0.0+] GetHdcpAuthenticationFailedEvent
| 0100000000001012
| SystemApplication (starter)
|-
|-
| 0x0A
| 20 || [4.0.0+] GetHdcpAuthenticationFailedEmulationEnabled
| 0100000000001001
| [[Auth_Applet|LibraryAppletAuth (auth)]]
|-
|-
| 0x0B
| 21 || [4.0.0+] SetHdcpAuthenticationFailedEmulation
| 0100000000001002
| [[Cabinet_Applet|LibraryAppletCabinet (cabinet)]]
|-
|-
| 0x0C
| 22 || [4.0.0+] GetHdcpStateChangeEvent
| 0100000000001003
| [[Controller_Applet|LibraryAppletController (controller)]]
|-
|-
| 0x0D
| 23 || [4.0.0+] GetHdcpState
| 0100000000001004
| LibraryAppletDataErase (dataErase)
|-
|-
| 0x0E
| 24 || [5.0.0+] ShowCardUpdateProcessing
| 0100000000001005
| [[Error_Applet|LibraryAppletError (error)]]
|-
|-
| 0x0F
| 25 || [5.0.0+] SetApplicationCecSettingsAndNotifyChanged
| 0100000000001006
| LibraryAppletNetConnect (netConnect)
|-
|-
| 0x10
| 26 || [7.0.0+] [[#GetOperationModeSystemInfo]]
| 0100000000001007
| [[Profile_Selector|LibraryAppletPlayerSelect (playerSelect)]]
|-
|-
| 0x11
| 27 || [9.0.0+] GetAppletFullAwakingSystemEvent
| 0100000000001008
| [[Software_Keyboard|LibraryAppletSwkbd (swkbd)]]
|-
|-
| 0x12
| 28 || [12.0.0+] [[#CreateCradleFirmwareUpdater]]
| 0100000000001009
|}
| [[MiiEdit_Applet|LibraryAppletMiiEdit (miiEdit)]]
 
== 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"
|-
|-
| 0x13
! Cmd || Name
| 010000000000100A
| [[Internet_Browser#010000000000100A|LibraryAppletWeb (web)]]
|-
|-
| 0x14
| 0 || Start
| 010000000000100B
| [[Internet_Browser#ShopN|LibraryAppletShop (shop)]]
|-
|-
| 0x15
| 1 || Finish
| 010000000000100D
| [[Album_Applet|LibraryAppletPhotoViewer (photoViewer)]]
|-
|-
| 0x16
| 2 || GetUpdateDeviceStatus
| 010000000000100E
| LibraryAppletSet (set)
|-
|-
| 0x17
| 3 || GetUpdateProgress
| 010000000000100F
| [[Internet_Browser#Offline_Applet|LibraryAppletOfflineWeb (offlineWeb)]]
|-
|-
| 0x18
| 4 || GetUpdateDeviceStatusChangeEvent
| 0100000000001010
|-
| [[Internet_Browser#Whitelisted_Applets|LibraryAppletLoginShare (loginShare)]]
| 5 || GetUpdateProgress2
|}
 
= spsm =
This is "nn::spsm::detail::IPowerStateInterface".
 
This was moved to [[OMM_services|omm]] with [14.0.0+].
 
{| class="wikitable" border="1"
|-
|-
| 0x19
! Cmd || Name
| 0100000000001011
| [[Internet_Browser#WifiWebAuthApplet|LibraryAppletWifiWebAuth (wifiWebAuth)]]
|-
|-
| 0x1A
| 0 || GetCurrentState
| 0100000000001013
| [[MyPage_Applet|LibraryAppletMyPage (myPage)]]
|-
|-
| 0x1B
| 1 || EnterSleep
| 010000000000101A
| LibraryAppletGift (gift)
|-
|-
| 0x1C
| 2 || GetLastWakeReason
| 010000000000101C
| LibraryAppletUserMigration (userMigration)
|-
|-
| 0x1D
| 3 || Shutdown
| 010000000000101D
| [9.0.0+] LibraryAppletPreomiaSys (EncounterSys)
|-
|-
| 0x1E
| 4 || GetNotificationMessageEventHandle
| 0100000000001020
| [9.0.0+] LibraryAppletStory (story)
|-
|-
| 0x1F
| 5 || ReceiveNotificationMessage
| 010070000E3C0000
| [9.0.0+] LibraryAppletPreomiaUsr (EncounterUsr)
|-
|-
| 0x20
| 6 || AnalyzeLogForLastSleepWakeSequence
| 010086000E49C000
| [9.0.0+] LibraryAppletPreomiaUsrDummy (EncounterUsrDummy)
|-
|-
| 0x21
| 7 || ResetEventLog
| 0100000000001038
| [10.0.0+] LibraryAppletSample (sample)
|-
|-
| 0x3E8
| 8 || AnalyzePerformanceLogForLastSleepWakeSequence
|  
| [10.0.0+] DevlopmentTool
|-
|-
| 0x3F1
| 9 || ChangeHomeButtonLongPressingTime
| 010000000000D619
| [10.0.0+] CombinationLA
|-
|-
| 0x3F2
| 10 || PutErrorState
| 010000000000D610
| [10.0.0+] AeSystemApplet
|-
|-
| 0x3F3
| 11 || [1.0.0-3.0.2] InvalidateCurrentHomeButtonPressing
| 010000000000D611
|}
| [10.0.0+] AeOverlayApplet
 
[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"
|-
|-
| 0x3F4
! Cmd || Name
| 010000000000D612
| [10.0.0+] AeStarter
|-
|-
| 0x3F5
| 0 || GetContinuousHighSkinTemperatureEvent
| 010000000000D613
| [10.0.0+] AeLibraryAppletAlone
|-
|-
| 0x3F6
| 1 || SetOperationMode
| 010000000000D614
| [10.0.0+] AeLibraryApplet1
|-
|-
| 0x3F7
| 2 || LoadAndApplySettings
| 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 =
= caps:su =
This is "nn::applet::LibraryAppletMode".
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"
{| class="wikitable" border="1"
|-
|-
! Value
! Cmd || Name
! Description
|-
|-
| 0x0
| 32 || [7.0.0+] [[#SetShimLibraryVersion]]
| AllForeground
|-
|-
| 0x1
| 201 || [[#SaveScreenShot]]
| PartialForeground
|-
|-
| 0x2
| 203 || [[#SaveScreenShotEx0]]
| NoUi
|-
|-
| 0x3
| 205 || [8.0.0+] [[#SaveScreenShotEx1]]
| PartialForegroundWithIndirectDisplay (see also [[#GetIndirectLayerConsumerHandle]], only used by swkbd [[Software_Keyboard|InlineKeyboard]])
|-
|-
| 0x4
| 210 || [[#SaveScreenShotEx2]]
| AllForegroundInitiallyHidden (can be used by [7.0.0+] [[Internet_Browser|WebSession]])
|}
|}


= AppletMessage =
== SetShimLibraryVersion ==
This is "nn::am::AppletMessage".
Takes a total of 0x10-bytes of input and a PID, no output.
 
This 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"
{| class="wikitable" border="1"
|-
|-
! Value
! Cmd || Name
! Description
|-
|-
| 0 || None
| 0 || [[#OpenSession]]
|-
|-
| 1 || ChangeIntoForeground
| 1 || GetPerformanceMode
|-
|-
| 2 || ChangeIntoBackground
| 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"
|-
|-
| 4 || Exit
! Cmd || Name
|-
|-
| 6 || ApplicationExited
| 0 || SetPerformanceConfiguration
|-
|-
| 15 || [[#FocusState|FocusStateChanged]]
| 1 || GetPerformanceConfiguration
|-
|-
| 16 || [[#SetRestartMessageEnabled|Resume]]
| 2 || [8.0.0+] SetCpuOverclockEnabled
|-
|}
| 20 || DetectShortPressingHomeButton
 
|-
= Library Applets =
| 21 || DetectLongPressingHomeButton
This section documents library applet launching.
|-
 
| 22 || DetectShortPressingPowerButton
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.
|-
 
| 23 || DetectMiddlePressingPowerButton
Once the applet finishes running successfully, [[#ILibraryAppletAccessor]] PopOutData can be used to get the applet-specific [[#IStorage]] containing the applet output data.
|-
 
| 24 || DetectLongPressingPowerButton
== 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.
| 25 || RequestToPrepareSleep
 
|-
This struct is 0x20-bytes.
| 26 || FinishedSleepSequence
 
|-
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.
| 27 || SleepRequiredByHighTemperature
 
|-
{| class="wikitable" border="1"
| 28 || SleepRequiredByLowBattery
|-
|-
! Offset || Size || Typical Value || Notes
| 29 || AutoPowerDown
|-
|-
| 0x0 || 4 || 1 || Common Arguments version
| 30 || [[#OperationMode|OperationModeChanged]]
|-
|-
| 0x4 || 4 || 0x20 || Common Arguments size
| 31 || [[#PerformanceMode|PerformanceModeChanged]]
|-
|-
| 0x8 || 4 || || Library applet version (API version)
| 32 || DetectReceivingCecSystemStandby
|-
|-
| 0xC || 4 || 0 || Theme color
| 33 || SdCardRemoved
|-
|-
| 0x10 || 1 || 0 || Play startup sound
| 50 || LaunchApplicationRequested
|-
|-
| 0x18 || 8 || N/A || System tick (see [[SVC#svcGetSystemTick|svcGetSystemTick]])
| 51 || [[#SetHandlesRequestToDisplay|RequestToDisplay]]
|-
|-
|}
| 55 || ShowApplicationLogo
 
|-
= AppletId =
| 56 || HideApplicationLogo
This is "nn::applet::AppletId". See also [[:Category:Library Applets]].
|-
 
| 57 || ForceHideApplicationLogo
{| class="wikitable" border="1"
|-
|-
| 60 || FloatingApplicationDetected
! Value
|-
! ProgramId
| 90 || [[#SetRequiresCaptureButtonShortPressedMessage|DetectShortPressingCaptureButton]]
! Description
|-
|-
| 92 || [[#SetAlbumImageTakenNotificationEnabled|AlbumScreenShotTaken]]
| 0x00
|-
|
| 93 || AlbumRecordingSaved
| None
|}
|-
 
| 0x01
= OperationMode =
|
This is "nn::oe::OperationMode".
| Application (not valid for use with LibraryApplets)
 
|-
{| class="wikitable" border="1"
| 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)]] (LibraryAppletOfflineWebApp_0 in Ounce)
|-
| 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+] LibraryAppletOfflineWebApp_3 ([[Internet_Browser#Offline_Applet|LibraryAppletOfflineWeb (offlineWeb)]] in NX)
|-
| 0x33
| 010000000000100F
| [17.0.0+] LibraryAppletOfflineWebSystem ([[Internet_Browser#Offline_Applet|LibraryAppletOfflineWeb (offlineWeb)]] in NX)
|-
| 0x35
| [17.0.0+] 0100000000001010 ([16.0.0-16.1.0] 0100000000001042)
| [17.0.0+] LibraryAppletLhub ([16.0.0-16.1.0] ) ([[Internet_Browser#Whitelisted_Applets|LibraryAppletLoginShare (loginShare)]] in NX)
|-
| 0x36
| [17.0.0+] 0100000000001010 ([16.0.0-16.1.0] 0100000000001042)
| [17.0.0+] LibraryAppletLogin ([16.0.0-16.1.0] ) ([[Internet_Browser#Whitelisted_Applets|LibraryAppletLoginShare (loginShare)]] in NX)
|-
| 0x37
| [17.0.0+] 0100000000001010 ([16.0.0-16.1.0] 0100000000001042)
| [17.0.0+] LibraryAppletShare ([16.0.0-16.1.0] ) ([[Internet_Browser#Whitelisted_Applets|LibraryAppletLoginShare (loginShare)]] in NX)
|-
| 0x38
| 0100000000001043
| [16.0.0-16.1.0]
|-
| 0x50
| 0100000000001007
| [18.0.0+]
|-
| 0x51
| 0100000000001007
| [18.0.0+]
|-
| 0x64
| 0100000000001048
| [20.0.0+] [[Splay_Applet|splay]]
|-
| 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
|-
| 0x700000C8
| 010000000000D65B
| [18.0.0+]
|-
| 0x700000C9
| 010000000000D65C
| [18.0.0+]
|-
| 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
|-
| 0x700000FA
| 010000000000D677
| [20.1.0+]
|}
 
= 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
|-
| 7 ||
|-
| 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
|-
| 34 ||
|-
| 50 || LaunchApplicationRequested
|-
| 51 || [[#SetHandlesRequestToDisplay|RequestToDisplay]]
|-
| 55 || ShowApplicationLogo
|-
| 56 || HideApplicationLogo
|-
| 57 || ForceHideApplicationLogo
|-
| 58 ||
|-
| 59 ||
|-
| 60 || FloatingApplicationDetected
|-
| 61 || [7.0.0+] PerformanceConfigurationChanged
|-
| 70 ||
|-
| 71 ||
|-
| 72 ||
|-
| 73 ||
|-
| 75 ||
|-
| 80 ||
|-
| 81 ||
|-
| 82 ||
|-
| 83 ||
|-
| 85 ||
|-
| 86 ||
|-
| 90 || [[#SetRequiresCaptureButtonShortPressedMessage|DetectShortPressingCaptureButton]]
|-
| 92 || [[#SetAlbumImageTakenNotificationEnabled|AlbumScreenShotTaken]]
|-
| 93 || AlbumRecordingSaved
|-
| 94 ||
|-
| 100 ||
|-
| 101 ||
|-
| 110 || [14.0.0+] DetectShortPressingCaptureButtonForApplet
|-
| 111 || [14.0.0+] DetectLongPressingCaptureButtonForApplet
|-
| 1000 ||
|}
 
= OperationMode =
This is "nn::oe::OperationMode".
 
{| class="wikitable" border="1"
|-
|-
! Value
! Value
Line 3,500: Line 4,167:


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,645: Line 4,312:
= LaunchRequiredVersion =
= LaunchRequiredVersion =
This is "nn::oe::LaunchRequiredVersion". This is a 0x40-byte struct with 1-byte alignment.
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 =
= 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.
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]]
[[Category:Services]]
Retrieved from "https://switchbrew.org/wiki/Applet_Manager_services"