Nintendo Switch Brew - User contributions [en]

PTM services

2020-10-10T22:28:34Z

Ctcaer:

= fan =
This is "nn::fan::detail::IManager".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || OpenController
|}

== IController ==
This is "nn::fan::detail::IController".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || SetRotationSpeedLevel
|-
| 1 || SetRotationSpeedLevelByDiff
|-
| 2 || GetRotationSpeedLevel
|-
| 3 || SetRotationRate
|-
| 4 || GetRotationRate
|-
| 5 || [1.0.0-6.2.0] EnableFan
|-
| 6 || [1.0.0-6.2.0] DisableFan
|-
| 7 || [1.0.0-6.2.0] GetActualRotationSpeedLevel
|}

[7.0.0+] SetRotationSpeedLevelByDiff/SetRotationRate no longer takes any input. GetRotationRate no longer returns output. These were presumably replaced with new cmds?

= psm =
This is "nn::psm::IPsmServer".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#GetBatteryChargePercentage]]
|-
| 1 || [[#GetChargerType]]
|-
| 2 || [[#EnableBatteryCharging]]
|-
| 3 || [[#DisableBatteryCharging]]
|-
| 4 || [[#IsBatteryChargingEnabled]]
|-
| 5 || [[#AcquireControllerPowerSupply]]
|-
| 6 || [[#ReleaseControllerPowerSupply]]
|-
| 7 || [[#OpenSession]]
|-
| 8 || [[#EnableEnoughPowerChargeEmulation]]
|-
| 9 || [[#DisableEnoughPowerChargeEmulation]]
|-
| 10 || [[#EnableFastBatteryCharging]]
|-
| 11 || [[#DisableFastBatteryCharging]]
|-
| 12 || [[#GetBatteryVoltageState]]
|-
| 13 || [[#GetRawBatteryChargePercentage]]
|-
| 14 || [[#IsEnoughPowerSupplied]]
|-
| 15 || [[#GetBatteryAgePercentage]]
|-
| 16 || [[#GetBatteryChargeInfoEvent]]
|-
| 17 || [[#GetBatteryChargeInfoFields]]
|-
| 18 || [3.0.0+] GetBatteryChargeCalibratedEvent
|}

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

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

== EnableBatteryCharging ==
No input/output.

== DisableBatteryCharging ==
No input/output.

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

== AcquireControllerPowerSupply ==
No input/output.

== ReleaseControllerPowerSupply ==
No input/output.

== OpenSession ==
No input, returns an output [[#IPsmSession]].

== EnableEnoughPowerChargeEmulation ==
No input/output.

== DisableEnoughPowerChargeEmulation ==
No input/output.

== EnableFastBatteryCharging ==
No input/output.

== DisableFastBatteryCharging ==
No input/output.

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

== GetRawBatteryChargePercentage ==
No input, returns an output double.

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

== GetBatteryAgePercentage ==
No input, returns an output double.

== GetBatteryChargeInfoEvent ==
No input, returns an output Event handle.

== GetBatteryChargeInfoFields ==
No input, returns an output 0x40-byte struct:

{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x00 || 0x4 || u32. Input (Sink) current limit in mA
|-
| 0x04 || 0x4 || u32. Output (Source/Vbus/OTG) current limit in mA
|-
| 0x08 || 0x4 || u32. Battery charging current limit in mA
|-
| 0x0C || 0x4 || u32. Battery charging voltage limit in mV
|-
| 0x10 || 0x4 || enum, same as power-role? Always 1 except when OTG where it becomes 2
|-
| 0x14 || 0x4 || Possibly a bit field
|-
| 0x18 || 0x4 || u32. Charging limits state based on battery temperature
|-
| 0x1C || 0x4 || u32. Battery Temperature (milli C)
|-
| 0x20 || 0x4 || u32. Capacity now per cent-mille (i.e. 100% = 100000 pcm)
|-
| 0x24 || 0x4 || u32. Voltage now in mV
|-
| 0x28 || 0x4 || u32. Battery age (capacity full / capacity design) per cent-mille (i.e. 100% = 100000 pcm)
|-
| 0x2C || 0x4 || enum. Power role (0: Unknown, 1: Sink, 2: Source)
|-
| 0x30 || 0x4 || enum. [[#Charger_Type]]
|-
| 0x34 || 0x4 || u32. Charger voltage limit in mV
|-
| 0x38 || 0x4 || u32. Charger current limit in mA
|-
| 0x3C || 0x4 || Possibly bit field (bit0: potentially no hub, bit8: unknown, bit12: OTG)
|-
|}

=== Charger Type ===
{| class="wikitable" border="1"
|-
! Value || Name
|-
| 0 || Unknown
|-
| 1 || PD
|-
| 2 || Type-C 1.5A
|-
| 3 || Type-C 3.0A
|-
| 4 || DCP
|-
| 5 || CDP
|-
| 6 || SDP
|-
| 7 || Apple 500mA
|-
| 8 || Apple 1000mA
|-
| 9 || Apple 2000mA
|}

== IPsmSession ==
This is "nn::psm::IPsmSession".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#BindStateChangeEvent]]
|-
| 1 || [[#UnbindStateChangeEvent]]
|-
| 2 || [[#SetChargerTypeChangeEventEnabled]]
|-
| 3 || [[#SetPowerSupplyChangeEventEnabled]]
|-
| 4 || [[#SetBatteryVoltageStateChangeEventEnabled]]
|}

=== BindStateChangeEvent ===
No input, returns an output event with autoclear disabled.

=== UnbindStateChangeEvent ===
No input/output.

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

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

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

= tc =
This is "nn::tc::IManager".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || SetOperatingMode
|-
| 1 || GetThermalEvent
|-
| 2 || IsActionAllowed
|-
| 3 || EnableVirtualTemperature
|-
| 4 || DisableVirtualTemperature
|-
| 5 || SetVirtualTemperature
|-
| 6 || EnableFanControl
|-
| 7 || DisableFanControl
|-
| 8 || IsFanControlEnabled
|-
| 9 || [5.0.0+] GetSkinTemperatureMilliC
|}

= ts =
This is "nn::ts::server::IMeasurementServer".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#GetTemperatureRange]]
|-
| 1 || [[#GetTemperature]]
|-
| 2 || [[#SetMeasurementMode]]
|-
| 3 || [[#GetTemperatureMilliC]]
|-
| 4 || [8.0.0+] ? (Takes a total of 4-bytes of input, returns an [[#IUnknown0]])
|}

== IUnknown0 ==
Added with [8.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 ||
|-
| 1 ||
|-
| 2 ||
|-
| 3 ||
|-
| 4 || [10.0.0+]
|}

== GetTemperatureRange ==
Takes an u8 [[#Location]] and returns an s32 minimum temperature + s32 maximum temperature.

The returned temperature values are in Celsius.

== GetTemperature ==
Takes an u8 [[#Location]] and returns an output s32.

The output is the temperature in Celsius.

== SetMeasurementMode ==
Takes an u8 [[#Location]] and an u8 MeasurementMode, no output.

== GetTemperatureMilliC ==
Takes an u8 [[#Location]] and returns an output s32.

The output is the temperature in MilliC.

== Location ==
{| class="wikitable" border="1"
|-
! Value || Name
|-
| 0 || Internal
|-
| 1 || External
|}

= pcm =
This is "nn::pcm::IManager".

[4.0.0+] This service was moved to '''nvdbgsvc''' and is only available to SDEV units.

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || IsSupported
|-
| 1 || ReadCurrentPower
|-
| 2 || [4.0.0+] IsServiceEnabled
|-
| 3 || [4.0.0+] ReadCurrentVoltage
|}

= apm:am =
This is "nn::apm::IManager".

This was added with [8.0.0+] and replaces the old [[PPC_services#apm|apm]] service.

{| 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.

= apm:sys =
This is "nn::apm::ISystemManager".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || RequestPerformanceMode
|-
| 1 || GetPerformanceEvent
|-
| 2 || GetThrottlingState
|-
| 3 || GetLastThrottlingState
|-
| 4 || ClearLastThrottlingState
|-
| 5 || [5.0.0+] LoadAndApplySettings
|-
| 6 || [7.0.0+] [[#SetCpuBoostMode]]
|-
| 7 || [7.0.0+] [[#GetCurrentPerformanceConfiguration]]
|}

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

== SetCpuBoostMode ==
Takes an u32 [[#CpuBoostMode]].

=== CpuBoostMode ===
{| class="wikitable" border="1"
|-
! Mode || Description
|-
| 0 || Disabled.
|-
| 1 || Boost CPU. Additionally, throttle GPU to minimum.
Use [[#PerformanceConfiguration|performance configurations]] 0x92220009 and 0x9222000A, or 0x9222000B and 0x9222000C.
|-
| 2 || Conserve power. Only throttle GPU to minimum.
Use [[#PerformanceConfiguration|performance configurations]] 0x9222000B and 0x9222000C.
|}

== GetCurrentPerformanceConfiguration ==
Returns the currently active [[#PerformanceConfiguration]] (default value is 0x00020003).

= ISession =
This is "nn::apm::ISession".

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

== SetPerformanceConfiguration ==
Takes an u32 [[#PerformanceMode]] and an u32 [[#PerformanceConfiguration]].

== GetPerformanceConfiguration ==
Takes an u32 [[#PerformanceMode]] and returns an output u32 [[#PerformanceConfiguration]].

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

== PerformanceMode ==
{| class="wikitable" border="1"
|-
! Value || Name
|-
| 0 || Normal
|-
| 1 || Boost
|}

== PerformanceConfiguration ==
{| class="wikitable" border="1"
|-
! Value || CPU clock || GPU clock || Memory clock
|-
| 0x00010000 || 1020.0 || 384.0 || 1600.0
|-
| 0x00010001 || 1020.0 || 768.0 || 1600.0
|-
| 0x00010002 || 1224.0 || 691.2 || 1600.0
|-
| 0x00020000 || 1020.0 || 230.4 || 1600.0
|-
| 0x00020001 || 1020.0 || 307.2 || 1600.0
|-
| 0x00020002 || 1224.0 || 230.4 || 1600.0
|-
| 0x00020003 || 1020.0 || 307.2 || 1331.2
|-
| 0x00020004 || 1020.0 || 384.0 || 1331.2
|-
| 0x00020005 || 1020.0 || 307.2 || 1065.6
|-
| 0x00020006 || 1020.0 || 384.0 || 1065.6
|-
| 0x92220007 || 1020.0 || 460.8 || 1600.0
|-
| 0x92220008 || 1020.0 || 460.8 || 1331.2
|-
| [7.0.0+] 0x92220009 || 1785.0 || 76.8 || 1600.0
|-
| [7.0.0+] 0x9222000A || 1785.0 || 76.8 || 1331.2
|-
| [7.0.0+] 0x9222000B || 1020.0 || 76.8 || 1600.0
|-
| [7.0.0+] 0x9222000C || 1020.0 || 76.8 || 1331.2
|}

Clocks are all in MHz.

Configurations 0x10001 and 0x20000 are only available while docked. Configurations 0x10002 and 0x20002 are only available for SDEV units.

= fgm, fgm:0, fgm:1, fgm:2, fgm:3, fgm:4, fgm:5, fgm:6, fgm:7, fgm:9 =
These are "nn::fgm::sf::ISession".

Each service represents a different priority from 0 to 9. The "fgm" service represents priority 8 (default).

[2.0.0+] Only "fgm", "fgm:0" and "fgm:9" are now valid.

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

== Initialize ==
No input. Returns an [[#IRequest]].

== IRequest ==
This is "nn::fgm::sf::IRequest".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#Initialize_2|Initialize]]
|-
| 1 || [[#Set|Set]]
|-
| 2 || [[#Get|Get]]
|-
| 3 || [[#Cancel|Cancel]]
|}

=== Initialize ===
Takes a PID-descriptor, a [[#Module]] and an u64. Returns an Event handle with EventClearMode 0.

=== Set ===
Takes 2 u32s '''ClockMinRate''' and '''ClockMaxRate'''. No output.

=== Get ===
No input. Returns an u32 '''ClockRate'''.

=== Cancel ===
No input/output.

= fgm:dbg =
This is "nn::fgm::sf::IDebugger".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || Initialize
|-
| 1 || Read
|-
| 2 || Cancel
|}

= lbl =
This is "nn::lbl::detail::ILblController". This was moved from [[Backlight_services|lbl]] with [10.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || SaveCurrentSetting
|-
| 1 || LoadCurrentSetting
|-
| 2 || SetCurrentBrightnessSetting
|-
| 3 || GetCurrentBrightnessSetting
|-
| 4 || ApplyCurrentBrightnessSettingToBacklight
|-
| 5 || GetBrightnessSettingAppliedToBacklight
|-
| 6 || SwitchBacklightOn
|-
| 7 || SwitchBacklightOff
|-
| 8 || GetBacklightSwitchStatus
|-
| 9 || EnableDimming
|-
| 10 || DisableDimming
|-
| 11 || IsDimmingEnabled
|-
| 12 || EnableAutoBrightnessControl
|-
| 13 || DisableAutoBrightnessControl
|-
| 14 || IsAutoBrightnessControlEnabled
|-
| 15 || SetAmbientLightSensorValue
|-
| 16 || [[#GetAmbientLightSensorValue]]
|-
| 17 || SetBrightnessReflectionDelayLevel
|-
| 18 || GetBrightnessReflectionDelayLevel
|-
| 19 || SetCurrentBrightnessMapping
|-
| 20 || GetCurrentBrightnessMapping
|-
| 21 || SetCurrentAmbientLightSensorMapping
|-
| 22 || GetCurrentAmbientLightSensorMapping
|-
| 23 || [3.0.0+] IsAmbientLightSensorAvailable
|-
| 24 || [3.0.0+] SetCurrentBrightnessSettingForVrMode
|-
| 25 || [3.0.0+] GetCurrentBrightnessSettingForVrMode
|-
| 26 || [3.0.0+] [[#EnableVrMode]]
|-
| 27 || [3.0.0+] [[#DisableVrMode]]
|-
| 28 || [3.0.0+] [[#IsVrModeEnabled]]
|-
| 29 || [7.0.0+] IsAutoBrightnessControlSupported
|}

== Ambient Light Sensor Notes ==
The BH1730 outputs 2 values. Visible light and IR light. This is then calculated through an algorithm that checks for Gain, Measurement time, filter qualities and ouputs lux (max correct measurement of 100K lux).
The default values are Gain 64x and ITIME of 38 (256 - 218). This allows for a max lux value of 17972 lux when visible light value is maximum and IR light is 0. When both of them are on their limit, the output is 1192 lux.
The sensor is fully configurable.

== GetAmbientLightSensorValue ==
No input. Before 5.x, outputs lux in float. (5.0.0+) Returns an output struct:
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || bOverLimit. (u32) Equals to 1 if visible or IR light data is over 65534.
|-
| 0x4 || 0x4 || fLux. (float) Value in lux from the ambient light sensor.
|}
Note: if bOverLimit=1 and the default ALS configuration is used, the measurement of fLux should not be considered and the actual max value depends on the type of light. Ranges from 12.5K - 17.5K.

== GetCurrentBrightnessSetting ==
No input. Returns an output u32 int of the current backlight level.

== GetBrightnessSettingAppliedToBacklight ==
No input. Returns an output u32 int of the backlight level computed from the ambient light sensor.

== IsAutoBrightnessControlEnabled ==
No input. Returns an output u8 bool indicating whether auto brightness is enabled.

== EnableVrMode ==
No input/output. Used by [[AM_services#SetVrModeEnabled]].

Sets a global state field to 0x1.

== DisableVrMode ==
No input/output. Used by [[AM_services#SetVrModeEnabled]].

Sets the global state field used by [[#EnableVrMode]] to 0x0.

== IsVrModeEnabled ==
No input. Returns an output u8 bool set by the above commands.

= Module =
This is "nn::fgm::Module".

{| class="wikitable" border="1"
|-
! Name || Block
|-
| 0 || CPU
|-
| 1 || GPU
|-
| 2 || EMC
|-
| 3 || SCLK
|-
| 4 || MSELECT
|-
| 5 || NVDEC
|-
| 6 || NVENC
|-
| 7 || NVJPG
|}

= Settings =
{| class="wikitable" border="1"
|-
! Key || Size || Notes
|-
| background_download_stress_testing_storage || strlen || "sdcard", "builtin", "system".
|-
| battery_draining_enabled || 1 || ?
|-
| fs_access_log_mode || strlen || "log", "sdcard", "log+sdcard", "off".
|-
| fs_speed_emulation_mode || strlen || "faster", "slower", "random", "off".
|-
| host_romfs_redirection_target || strlen || "builtin", "off".
|-
| idle_time_detect_mode || strlen || "on", "off".
|-
| initial_tick_value || strlen || "7days", "14days", "30days", "90days", "hex": ?.
|-
| memory_mode || strlen || "auto", "4GB", "6GB".
|-
| needs_update_vulnerability_policy || strlen || "default": ?, "force_true": ?, "force_false": ?.
|-
| operation_mode_policy || strlen || "auto": ?, "handheld", "console".
|-
| performance_mode_policy || strlen || "auto": use boost mode when docked. "normal": never use boost mode. "boost": always use boost mode (SDEV only).
|-
| screenshot_target || strlen || "screenshot": ?, "physical": ?.
|-
| sdev_cpu_overclock_enabled || 1 || SDEV only. Used to allow access to 1224MHz CPU mode.
|-
| sdev_throttling_additional_delay_us || 4 || SDEV only.
|-
| sdev_throttling_additional_delay_enabled || 1 || SDEV only.
|-
| sleep_mode || strlen || "default": ?, "pseudo": ?.
|-
| throttling_for_smpd_enabled || 1 || Not used as of 3.0.
|-
| throttling_for_undock_enabled || 1 || Not used as of 3.0.
|}

[[Category:Services]]

PPC services

2019-09-27T06:11:59Z

Ctcaer: also fix cpu boost values in PPC

APM is utilized for setting system performance profiles including clocks for CPU, GPU, and memory.

[9.0.0+] The PPC system module is now stubbed and all its services were moved into [[PTM_services|PTM]].

= apm =
This is "nn::apm::IManager".

This was moved to [[Applet_Manager_services|AM]] with [8.0.0+] and is now a shim for [[#apm:am|apm:am]].

{| 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.

= apm:p =
This is "nn::apm::IManagerPrivileged".

This service no longer exists in [8.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || OpenSession
|}

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

= apm:am =
This is "nn::apm::IManager".

This was added with [8.0.0+] and is the same as the old [[#apm|apm]] service.

= apm:sys =
This is "nn::apm::ISystemManager".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || RequestPerformanceMode
|-
| 1 || GetPerformanceEvent
|-
| 2 || GetThrottlingState
|-
| 3 || GetLastThrottlingState
|-
| 4 || ClearLastThrottlingState
|-
| 5 || [5.0.0+] LoadAndApplySettings
|-
| 6 || [7.0.0+] [[#SetCpuBoostMode]]
|-
| 7 || [7.0.0+] [[#GetCurrentPerformanceConfiguration]]
|}

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

== SetCpuBoostMode ==
Takes an u32 [[#CpuBoostMode]].

=== CpuBoostMode ===
{| class="wikitable" border="1"
|-
! Mode || Description
|-
| 0 || Disabled.
|-
| 1 || Boost CPU. Additionally, throttle GPU to minimum.
Use [[#PerformanceConfiguration|performance configurations]] 0x92220009 and 0x9222000A, or 0x9222000B and 0x9222000C.
|-
| 2 || Conserve power. Only throttle GPU to minimum.
Use [[#PerformanceConfiguration|performance configurations]] 0x9222000B and 0x9222000C.
|}

== GetCurrentPerformanceConfiguration ==
Returns the currently active [[#PerformanceConfiguration]] (default value is 0x00020003).

= ISession =
This is "nn::apm::ISession".

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

== SetPerformanceConfiguration ==
Takes an u32 [[#PerformanceMode]] and an u32 [[#PerformanceConfiguration]].

== GetPerformanceConfiguration ==
Takes an u32 [[#PerformanceMode]] and returns an output u32 [[#PerformanceConfiguration]].

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

== PerformanceMode ==
{| class="wikitable" border="1"
|-
! Value || Name
|-
| 0 || Handheld
|-
| 1 || Docked
|}

== PerformanceConfiguration ==
{| class="wikitable" border="1"
|-
! Value || CPU clock || GPU clock || Memory clock
|-
| 0x00010000 || 1020.0 || 384.0 || 1600.0
|-
| 0x00010001 || 1020.0 || 768.0 || 1600.0
|-
| 0x00010002 || 1224.0 || 691.2 || 1600.0
|-
| 0x00020000 || 1020.0 || 230.4 || 1600.0
|-
| 0x00020001 || 1020.0 || 307.2 || 1600.0
|-
| 0x00020002 || 1224.0 || 230.4 || 1600.0
|-
| 0x00020003 || 1020.0 || 307.2 || 1331.2
|-
| 0x00020004 || 1020.0 || 384.0 || 1331.2
|-
| 0x00020005 || 1020.0 || 307.2 || 1065.6
|-
| 0x00020006 || 1020.0 || 384.0 || 1065.6
|-
| 0x92220007 || 1020.0 || 460.8 || 1600.0
|-
| 0x92220008 || 1020.0 || 460.8 || 1331.2
|-
| [7.0.0+] 0x92220009 || 1785.0 || 76.8 || 1600.0
|-
| [7.0.0+] 0x9222000A || 1785.0 || 76.8 || 1331.2
|-
| [7.0.0+] 0x9222000B || 1020.0 || 76.8 || 1600.0
|-
| [7.0.0+] 0x9222000C || 1020.0 || 76.8 || 1331.2
|}

Clocks are all in MHz.

Configurations 0x10001 and 0x20000 are only available while docked. Configurations 0x10002 and 0x20002 are only available for SDEV units.

Some of these require apm:p.

= fgm, fgm:0, fgm:9 =
This is "nn::fgm::sf::ISession".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || Initialize
|}

== IRequest ==
This is "nn::fgm::sf::IRequest".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || Initialize
|-
| 1 || Set
|-
| 2 || Get
|-
| 3 || Cancel
|}

= fgm:dbg =
This is "nn::fgm::sf::IDebugger".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || Initialize
|-
| 1 || Read
|-
| 2 || Cancel
|}

= Settings =
{| class="wikitable" border="1"
|-
! Key || Size || Notes
|-
| background_download_stress_testing_storage || strlen || "sdcard", "builtin", "system".
|-
| battery_draining_enabled || 1 || ?
|-
| fs_access_log_mode || strlen || "log", "sdcard", "log+sdcard", "off".
|-
| fs_speed_emulation_mode || strlen || "faster", "slower", "random", "off".
|-
| host_romfs_redirection_target || strlen || "builtin", "off".
|-
| idle_time_detect_mode || strlen || "on", "off".
|-
| initial_tick_value || strlen || "7days", "14days", "30days", "90days", "hex": ?.
|-
| memory_mode || strlen || "auto", "4GB", "6GB".
|-
| needs_update_vulnerability_policy || strlen || "default": ?, "force_true": ?, "force_false": ?.
|-
| operation_mode_policy || strlen || "auto": ?, "handheld", "console".
|-
| performance_mode_policy || strlen || "auto": use boost mode when docked. "normal": never use boost mode. "boost": always use boost mode (SDEV only).
|-
| screenshot_target || strlen || "screenshot": ?, "physical": ?.
|-
| sdev_cpu_overclock_enabled || 1 || SDEV only. Used to allow access to 1224MHz CPU mode.
|-
| sdev_throttling_additional_delay_us || 4 || SDEV only.
|-
| sdev_throttling_additional_delay_enabled || 1 || SDEV only.
|-
| sleep_mode || strlen || "default": ?, "pseudo": ?.
|-
| throttling_for_smpd_enabled || 1 || Not used as of 3.0.
|-
| throttling_for_undock_enabled || 1 || Not used as of 3.0.
|}

[[Category:Services]]

PTM services

2019-09-25T13:51:47Z

Ctcaer: oof - On the other hand, CPU boost mode should not drain more battery, it can even result to the opposite. That's because of total throttle of GPU.

Bus services

2019-09-05T23:33:13Z

Ctcaer:

= gpio =
This is "nn::gpio::IManager".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#OpenSessionForDev]]
|-
| 1 || [[#OpenSession]]
|-
| 2 || [[#OpenSessionForTest]]
|-
| 3 || [1.0.0-6.2.0] IsWakeEventActive
|-
| 4 || [1.0.0-6.2.0] GetWakeEventActiveFlagSet
|-
| 5 || [1.0.0-6.2.0] SetWakeEventActiveFlagSetForDebug
|-
| 6 || SetWakePinDebugMode
|-
| 7 || [5.0.0+] [[#OpenSession2]]
|-
| 8 || [5.0.0+] IsWakeEventActive2
|-
| 9 || [5.0.0+] SetWakeEventActiveFlagSetForDebug2
|-
| 10 || [6.0.0+]
|}

== Known Devices ==
{| class="wikitable sortable" border="1"
|-
! GpioPadName || GpioPadDescriptor || DeviceCode || Tegra (port, pin) || Usage || Direction || Used by
|-
| 0x01 || 0xCC || 0x33000002 || Z, 4 || Audio Codec (ALC5639) Power (CODEC_LDO_EN_TEMP) || Out || [[Audio services]], [[Fatal services]]
|-
| 0x02 || 0x24 || 0x3C000001 || E, 4 || SDCard Power (POW_SD_EN) || Out || [[PCV services]]
|-
| 0x03 || 0x3C || 0x37000002 || H, 4 || Bluetooth Reset (BT_RST_PH4) || Out || [[Bluetooth Driver services]]
|-
| 0x04 || 0xDA || 0xC9000402 || BB, 2 || Secondary Boot Device Configration (RAM_CODE3) || In ||
|-
| 0x05 || 0xDB || 0x3C000402 || BB, 3 || GcAsic Reset (GC_RST) || Out || [[Filesystem services]]
|-
| 0x06 || 0xDC || 0x33000003 || BB, 4 || Audio Codec (ALC5639) Alert (CODEC_ALERT) || In || [[Audio services]]
|-
| 0x07 || 0x25 || 0x3C000401 || E, 5 || GcAsic Power (POW_GC) || Out ||
|-
| 0x08 || 0x90 || 0x350000CA || S, 0 || Debug Pad Detect (DEBUG_CONTROLLER_DET) || In || [[HID services]]
|-
| 0x09 || 0x91 || 0x39000407 || S, 1 || Battery Charge Status (BATT_CHG_STATUS) || In ||
|-
| 0x0A || 0x96 || 0x39000003 || S, 6 || Charger IC (BQ24193) Charge Enable (BATT_CHG_ENABLE_N) || Out || [[PTM services]]
|-
| 0x0B || 0x97 || 0x3D000002 || S, 7 || Fan Tachometer (FAN_TACH) || In ||
|-
| 0x0C || 0x26 || 0x3500040B || E, 6 || Joy-Con(L) IsAttached (insertion, Joy-Con pin 5/console TX, pulled low on insert?) (EXTCON_DET_S) || In || [[HID services]]
|-
| 0x0D || 0x05 || 0x39000401 || A, 5 || Fan and Joy-Con Rails Power (Battery - BQ24193 5V) (VDD50A_EN) || Out || [[PTM services]]
|-
| 0x0E || 0x78 || 0xCA000402 || P, 0 || SDEV Coax Select (SDEV_COAX_SEL_1) || In ||
|-
| 0x0F || 0x93 || 0x3C000403 || S, 3 || GcAsic Card Detect (GC_CD) || In || [[Filesystem services]]
|-
| 0x10 || 0x7D || 0xC900040B || P, 5 || PROD_TYPE_0 || In ||
|-
| 0x11 || 0x7C || 0xC900040C || P, 4 || PROD_TYPE_1 || In ||
|-
| 0x12 || 0x7B || 0xC900040D || P, 3 || PROD_TYPE_2 || In ||
|-
| 0x13 || 0x7A || 0xC900040E || P, 2 || PROD_TYPE_3 || In ||
|-
| 0x14 || 0xBC || 0x3E000002 || X, 4 || Temperature Sensor (TEMP_ALERT) || In ||
|-
| 0x15 || 0xAE || 0x33000004 || V, 6 || Audio Codec (ALC5639) Headphone Detect (CODEC_HP_DET_IRQ) || In || [[Audio services]]
|-
| 0x16 || 0xBA || 0x35000041 || X, 2 || MOTION_INT_PX2 || In ||
|-
| 0x17 || 0xB9 || 0x35000036 || X, 1 || TouchPanel IRQ (TP_IRQ) (unused - polled instead) || In || [[HID services]]
|-
| 0x18 || 0xBD || 0x35000001 || X, 5 || Power Button (BUTTON_POWER_ON_PX5) || In ||
|-
| 0x19 || 0xBE || 0x35000002 || X, 6 || Volume Up (BUTTON_VOL_UP_PX6) || In || [[Boot2]], [[Audio services]]
|-
| 0x1A || 0xBF || 0x35000003 || X, 7 || Volume Down (BUTTON_VOL_DOWN_PX7) || In || [[Boot2]], [[Audio services]]
|-
| 0x1B || 0xC0 || 0x39000034 || Y, 0 || Fuel Gauge IC (MAX17050) IRQ (BATT_MGIC_IRQ) || In || [[PTM services]]
|-
| 0x1C || 0xC1 || 0x35000004 || Y, 1 || Recovery Mode Key (BUTTON_HOME_PY1) || In ||
|-
| 0x1D || 0xA9 || 0x3400003E || V, 1 || Backlight Enable (LCD_BL_EN_PV1) || Out || [[NV services]], [[Backlight services]]
|-
| 0x1E || 0xAA || 0x34000033 || V, 2 || Backlight Reset (LCD_RST_PV2) || Out || [[NV services]]
|-
| 0x1F || 0x55 || 0x040000CC || K, 5 || USB-PD Controller (RHOM BM92T30MWV) VCONN Power (PD_VCONN_EN) || Out || [[PTM services]], [[USB services]]
|-
| 0x20 || 0xAD || 0x040000CA || V, 5 || USB-PD Controller (RHOM BM92T30MWV) Reset (PD_RST) || Out || [[USB services]]
|-
| 0x21 || 0xC8 || 0x39000002 || Z, 0 || Charger IC (BQ24193) IRQ (BQ24193_IRQ) || In || [[PTM services]]
|-
| 0x22 || 0xCA || 0xCA000401 || Z, 2 || SDEV Coax Select (SDEV_COAX_SEL_0) || In ||
|-
| 0x23 || 0xCB || 0x3C000003 || Z, 3 || SDCard Write Protect (SD_WP) || In ||
|-
| 0x24 || 0x4F || 0x35000035 || J, 7 || TouchPanel Reset (TP_RST) || Out || [[HID services]]
|-
| 0x25 || 0x50 || 0x37000401 || K, 0 || BT_GPIO_2 || In ||
|-
| 0x26 || 0x51 || 0x37000402 || K, 1 || BT_GPIO_3 || In ||
|-
| 0x27 || 0x52 || 0x37000403 || K, 2 || BT_GPIO_4 || In ||
|-
| 0x28 || 0x54 || 0x040000CB || K, 4 || USB-PD Controller (RHOM BM92T30MWV) IRQ (PD_IRQ) || In || [[USB services]]
|-
| 0x29 || 0x56 || 0x3E000003 || K, 6 || POW_VCPU_INT || In ||
|-
| 0x2A || 0x57 || 0x3E000004 || K, 7 || MAX77621_GPU_INT || In ||
|-
| 0x2B || 0x53 || 0x35000402 || K, 3 || Joy-Con(R) Charge (EXTCON_CHG_U) || Out || [[HID services]]
|-
| 0x2C || 0xE3 || 0x3500040C || CC, 3 || Joy-Con(L) Charge (EXTCON_CHG_S) || Out || [[HID services]]
|-
| 0x2D || 0x38 || 0x38000003 || H, 0 || WIFI_RF_DISABLE || Out ||
|-
| 0x2E || 0x39 || 0x38000002 || H, 1 || WiFi Reset (WIFI_RST_PH1) || Out || [[WLAN services]], [[PCIe services]]
|-
| 0x2F || 0x3B || 0x37000003 || H, 3 || AP_WAKE_BT_PH3 || Out || [[Bluetooth Driver services]]
|-
| 0x30 || 0x3D || 0x37000004 || H, 5 || BT_WAKE_AP || In ||
|-
| 0x31 || 0x3F || 0x37000404 || H, 7 || BT_GPIO_5 || Out ||
|-
| 0x32 || 0x40 || 0x34000034 || I, 0 || Backlight +5V (LCD_VDD_P_EN) || Out || [[NV services]]
|-
| 0x33 || 0x41 || 0x34000035 || I, 1 || Backlight -5V (LCD_VDD_N_EN) || Out || [[NV services]]
|-
| 0x34 || 0x3E || 0x35000401 || H, 6 || Joy-Con(R) IsAttached (insertion, Joy-Con pin 5/console TX, pulled low on insert?) (EXTCON_DET_U) || In || [[HID services]]
|-
| 0x35 || 0xE2 || 0xC9000401 || CC, 2 || Secondary Boot Device Configration (RAM_CODE2) || In ||
|-
| 0x36 || 0xE4 || 0x39000402 || CC, 4 || Fan and Joy-Con Rails Power (USB 5V) (VDD50B_EN) || Out || [[PTM services]]
|-
| 0x37 || 0x3A || 0x38000004 || H, 2 || WIFI_WAKE_HOST || In ||
|-
| 0x38 || 0xC9 || 0x3C000002 || Z, 1 || SDCard Card Detect (SD_CD) || In || [[Filesystem services]]
|-
| 0x39 || 0x4D || 0x39000404 || J, 5 || Charger IC (BQ24193) OTG Charge Select (OTG_FET_1) || Out || [[PTM services]], [[USB services]]
|-
| 0x3A || 0x58 || 0x39000405 || L, 0 || Charger IC (BQ24193) OTG Charge Select (OTG_FET_2) || Out || [[PTM services]], [[USB services]]
|-
| 0x3B || 0x3E || 0x35000403 || H, 6 || Joy-Con(R) Wake Detect (EXTCON_DET_U) || In ||
|-
| 0x3C || 0x26 || 0x3500040D || E, 6 || Joy-Con(L) Wake Detect (EXTCON_DET_S) || In ||
|-
| 0x3D || -1 || 0x39000406 || || || ||
|-
| 0x3E || 0x33 || 0x35000404 || G, 3 || Joy-Con(R) CTS (checked low) (EXT_UART2_CTS) || In || [[HID services]]
|-
| 0x3F || 0x1C || 0x3500040E || D, 4 || Joy-Con(L) CTS (checked low) (EXT_UART3_CTS) || In || [[HID services]]
|-
| 0x40 || 0xD9 || 0x39000408 || BB, 1 || 5V Step-Down Regulator Power (5V_STEPDOWN_EN) || Out || (SDEV only)
|-
| 0x41 || 0x0C || 0x04000401 || B, 4 || USB Root Port 2 Over Current (USB_B2_OC) || In || [[USB services]] (SDEV only)
|-
| 0x42 || 0x0D || 0x39000409 || B, 5 || 5V Step-Down Regulator Power Good Flag (5V_STEPDOWN_PG) || In || (SDEV only)
|-
| 0x43 || 0x21 || 0x04000402 || E, 1 || USB Power (USB_A_EN) || Out || [[USB services]] (SDEV only)
|-
| 0x44 || 0x27 || 0x04000403 || E, 7 || USB Power Flag (USB_A_FLAG) || In || [[USB services]] (SDEV only)
|-
| 0x45 || 0x92 || 0x04000404 || S, 2 || USB Root Port 3 Over Current (USB_B3_OC) || In || [[USB services]] (SDEV only)
|-
| 0x46 || 0x95 || 0x04000405 || S, 5 || USB Root Port 3 Power (USB_B3_EN) || Out || [[USB services]] (SDEV only)
|-
| 0x47 || 0x98 || 0x04000406 || T, 0 || USB Root Port 2 Power (USB_B2_EN) || Out || [[USB services]] (SDEV only)
|-
| 0x48 || 0x10 || 0x34000004 || C, 0 || HDMI 5V (HDMI_5V_EN) || Out || [2.0.0+] [[NV services]]
|-
| 0x49 || 0x11 || 0x04000407 || C, 1 || USB Root Port 1 Power (USB_B1_EN) || Out || [[USB services]]
|-
| 0x4A || 0x12 || 0x34000005 || C, 2 || HDMI/Power Delivery Switch (HDMI_PD_TR_EN) || Out || [[NV services]]
|-
| 0x4B || 0x42 || 0x3D000003 || I, 2 || Fan Enable (FAN_EN) || Out || [[PTM services]]
|-
| 0x4C || 0xE6 || 0x04000408 || CC, 6 || USB Root Port 1 Over Current (USB_B1_OC) || In || [[USB services]] (SDEV only)
|-
| [2.0.0+] 0x4D || 0xAC || 0x3D000001 || V, 4 || Fan Pulse-Width Modulation Control (PWM_FAN) || Out || [[PTM services]]
|-
| [2.0.0+] 0x4E || 0xE1 || 0x34000006 || CC, 1 || HDMI Hot Plug Detect (HDMI_INT_DP_HPD_PCC1) || In || [[NV services]]
|-
| [5.0.0+] 0x4F || 0x56 || 0x3E000003 || K, 6 || MAX77812_IRQ || ||
|-
| [6.0.0+] 0x50 || 0x20 || 0xCA000001 || E, 0 || || ||
|-
| [6.0.0+] 0x51 || 0x21 || 0xCA000002 || E, 1 || || ||
|-
| [6.0.0+] 0x52 || 0x22 || 0xCA000003 || E, 2 || || ||
|-
| [6.0.0+] 0x53 || 0x23 || 0xCA000004 || E, 3 || || ||
|-
| [6.0.0+] 0x54 || 0x4C || 0x36000004 || J, 4 || NFC_IRQ || ||
|-
| [6.0.0+] 0x55 || 0x57 || 0x36000003 || K, 7 || NFC_RST || ||
|-
| [6.0.0+] 0x56 || 0x27 ([6.0.0-8.0.0] 0x94) || 0x35000415 || S, 4 || MCU_IRQ || ||
|-
| [6.0.0+] 0x57 || 0x98 || 0x35000416 || T, 0 || MCU_BOOT || ||
|-
| [6.0.0+] 0x58 || 0x99 || 0x35000417 || T, 1 || MCU_RST || ||
|-
| [6.0.0+] 0x59 || 0xBB || 0x39000403 || X, 3 || Fan Power (5V3) (VDD5V3_EN) || || [[PTM services]]
|-
| [6.0.0+] 0x5A || 0xE5 || 0x35000418 || CC, 5 || MCU_POR || ||
|-
| [6.0.0+] 0x5B || 0xAB || 0x35000005 || V, 3 || || ||
|-
| [6.0.0+] 0x5C || 0x4E || 0x36000002 || J, 6 || || ||
|-
| [7.0.0+] - || 0x32 || 0x35000406 || G, 2 || Joy-Con(R) RTS || ||
|-
| [7.0.0+] - || 0x1B || 0x35000410 || D, 3 || Joy-Con(L) RTS || ||
|-
| [7.0.0+] - || 0x17 || 0x3500041B || C, 7 || || ||
|-
| [7.0.0+] - || 0x18 || 0x3500041C || D, 0 || || ||
|-
| [7.0.0+] - || 0x15 || 0x3500041D || C, 5 || || ||
|-
| [7.0.0+] - || 0x16 || 0x3500041E || C, 6 || || ||
|}

== GpioPadDescriptor ==
{| class="wikitable" border="1"
|-
! Bits || Description
|-
| 7-5 || Controller index
|-
| 4-3 || Port index
|-
| 2-0 || Pin number
|}

== OpenSessionForDev ==
Takes a raw [[#GpioPadDescriptor]] and returns a [[#IPadSession]] session for it.

== OpenSession ==
Same thing as [[#OpenSessionForDev]] except it takes a '''GpioPadName''' which is then converted to a [[#GpioPadDescriptor]]. Returns an [[#IPadSession]] session.

== OpenSessionForTest ==
Same as [[#OpenSession]] but panics on failure.

== OpenSession2 ==
Same as [[#OpenSession]] but takes a '''DeviceCode''' instead of a '''GpioPadName''' and an u32 '''DeviceUnk'''.

== IPadSession ==
This is "nn::gpio::IPadSession".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || SetDirection
|-
| 1 || GetDirection
|-
| 2 || SetInterruptMode
|-
| 3 || GetInterruptMode
|-
| 4 || SetInterruptEnable
|-
| 5 || GetInterruptEnable
|-
| 6 || GetInterruptStatus
|-
| 7 || ClearInterruptStatus
|-
| 8 || SetValue
|-
| 9 || GetValue
|-
| 10 || BindInterrupt
|-
| 11 || UnbindInterrupt
|-
| 12 || SetDebounceEnabled
|-
| 13 || GetDebounceEnabled
|-
| 14 || SetDebounceTime
|-
| 15 || GetDebounceTime
|-
| 16 || [4.0.0+] SetValueForSleepState
|-
| 17 || [6.0.0+] GetValueForSleepState
|}

= i2c, i2c:pcv =
This is "nn::i2c::IManager".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#OpenSessionForDev_2|OpenSessionForDev]]
|-
| 1 || [[#OpenSession_2|OpenSession]]
|-
| [1.0.0-5.1.0] 2 || [[#HasDevice|HasDevice]]
|-
| [1.0.0-5.1.0] 3 || [[#HasDeviceForDev|HasDeviceForDev]]
|-
| 4 || [6.0.0+] [[#OpenSession2_2|OpenSession2]]
|}

== Known Devices ==
{| class="wikitable sortable" border="1"
|-
! Name || DeviceCode || Port:Addr || Is10bit || Speed || Max Retries || Retry Delay || Usage || Used by
|-
| 0 || 0x350000C9 || 0:52 || N || 100000 || 0 || 0 || DebugPadDriver || [[HID services]]
|-
| 1 || 0x35000033 || 2:49 || N || 400000 || 0 || 0 || TouchPanel || [[HID services]]
|-
| 2 || 0x3E000001 || 0:4c || N || 100000 || 0 || 0 || Temperature Sensor (TMP451 or NCT72) || [[PTM services]]
|-
| 3 || 0x3E000001 || 0:4c || N || 100000 || 0 || 0 || Temperature Sensor (TMP451 or NCT72) (duplicate) || [[PTM services]]
|-
| 4 || 0x33000001 || 0:1c || N || 100000 || 0 || 0 || Audio Codec (ALC5639) || [[Audio services]], [[Fatal services]]
|-
| 5 || 0x3B000001 || 4:68 || N || 400000 || 3 || 5000000 || PMIC RTC (max77620_rtc0), max77620_irq0 || [[PCV services]]
|-
| 6 || 0x3A000001 || 4:3c || N || 400000 || 3 || 5000000 || PMIC (MAX77620), max77620_irq0 || [[PCV services]]
|-
| 7 || 0x3A000003 || 4:1b || N || 400000 || 3 || 5000000 || Sub-PMIC for CPU (max77621_cpu) || [[PCV services]]
|-
| 8 || 0x3A000004 || 4:1c || N || 400000 || 3 || 5000000 || Sub-PMIC for GPU (max77621_gpu) || [[PCV services]]
|-
| 9 || 0x39000001 || 0:6b || N || 100000 || 3 || 5000000 || Charger IC (BQ24193) || [[PTM services]]
|-
| 10 || 0x39000033 || 0:36 || N || 100000 || 3 || 5000000 || Fuel Gauge IC (MAX17050) || [[PTM services]], [[PCV services]]
|-
| 11 || 0x040000C9 || 0:18 || N || 100000 || 3 || 5000000 || USB-PD controller (RHOM BM92T30MWV) || [[USB services]]
|-
| 12 || 0x3F000401 || 1:40 || N || 400000 || 3 || 5000000 || Power Monitor (ina226_V_VDD15V0-HB) || Factory testing
|-
| 13 || 0x3F000001 || 1:41 || N || 400000 || 3 || 5000000 || Power Monitor (ina226_V_VSYS-CPU-DS) || Factory testing
|-
| 14 || 0x3F000002 || 1:44 || N || 400000 || 3 || 5000000 || Power Monitor (ina226_V_VSYS-GPU-DS) || Factory testing
|-
| 15 || 0x3F000003 || 1:45 || N || 400000 || 3 || 5000000 || Power Monitor (ina226_V_VSYS-DDR-DS) || Factory testing
|-
| 16 || 0x3F000402 || 1:46 || N || 400000 || 3 || 5000000 || Power Monitor (ina226_V_VSYS-AP) || Factory testing
|-
| 17 || 0x3F000403 || 1:47 || N || 400000 || 3 || 5000000 || Power Monitor (ina226_V_VSYS-BL-DS) || Factory testing
|-
| 18 || 0x35000047 || 1:29 || N || 400000 || 3 || 5000000 || Ambient Light Sensor (BH1730) || [[Backlight services]]
|-
| 19 || 0x3F000404 || 1:48 || N || 400000 || 3 || 5000000 || Power Monitor (ina226_CORE) || Factory testing
|-
| 20 || 0x3F000405 || 1:49 || N || 400000 || 3 || 5000000 || Power Monitor (ina226_Soc-1V8) || Factory testing
|-
| 21 || 0x3F000406 || 1:4a || N || 400000 || 3 || 5000000 || Power Monitor (ina226_LPDDR4-1V8) || Factory testing
|-
| 22 || 0x3F000407 || 1:4b || N || 400000 || 3 || 5000000 || Power Monitor (ina226_REG1V32) || Factory testing
|-
| 23 || 0x3F000408 || 1:4d || N || 400000 || 3 || 5000000 || Power Monitor (ina226_VDD3V3-SYS) || Factory testing
|-
| [2.0.0+] 24 || 0x34000001 || 3:50 || N || 100000 || 0 || 0 || HDMI DDC || [[NV services]]
|-
| [2.0.0+] 25 || 0x34000002 || 3:54 || N || 100000 || 0 || 0 || HDMI SCDC || [[NV services]]
|-
| [2.0.0+] 26 || 0x34000003 || 3:3a || N || 100000 || 0 || 0 || HDMI HDCP || [[NV services]]
|-
| [4.0.0+] 27 || 0x3A000005 || 4:52 ([4.0.0-8.0.0] 4:a4) || N || 400000 || 0 || 0 || Buck Regulator (FAN53528) ||
|-
| [4.0.0+] 28 || 0x3A000002 || 4:33 ([4.0.0-8.0.0] 4:31) || N || 400000 || 0 || 0 || PMIC (MAX77812) || [[PCV services]]
|-
| [4.0.0+] 29 || 0x3A000002 || 4:33 ([4.0.0-8.0.0] 4:31) || N || 400000 || 0 || 0 || PMIC (MAX77812) || [[PCV services]]
|-
| [4.0.0+] 30 || 0x3F000409 || 1:4e || N || 400000 || 3 || 5000000 || Power Monitor (ina226_V_VDD-DDR-0V6) || Factory testing
|-
| [8.0.0+] 31 || 0x36000001 || 1:08 || N || 400000 || 3 || 5000000 || ||
|}

== OpenSessionForDev ==
Takes an u32 '''port''', an u16 '''addr''', an '''AddressingMode''' (1 for 10-bit, 0 otherwise) and a '''SpeedMode''' (400000 or 100000). Returns a [[#II2cSession]] session.

== OpenSession ==
Takes an '''I2cDevice''' and returns a [[#II2cSession]] session for it.

== HasDevice ==
Takes an '''I2cDevice''' and returns true if the device exists or false otherwise.

== HasDeviceForDev ==
Takes an u32 '''port''', an u16 '''addr''', an '''AddressingMode''' (1 for 10-bit, 0 otherwise) and a '''SpeedMode''' (400000 or 100000). Returns true if the device exists or false otherwise.

== OpenSession2 ==
Same as [[#OpenSession_2|OpenSession]] but takes a '''DeviceCode''' instead of a '''I2cDevice'''.

== II2cSession ==
This is "nn::i2c::ISession".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| [1.0.0-5.1.0] 0 || Send
|-
| [1.0.0-5.1.0] 1 || Receive
|-
| [1.0.0-5.1.0] 2 || ExecuteCommandList
|-
| 10 || [[#SendAuto]]
|-
| 11 || ReceiveAuto
|-
| 12 || [[#ExecuteCommandListAuto]]
|-
| 13 || [6.0.0+]
|}

== SendAuto ==
Takes bytes to write in either a static buffer or a receive buffer, returns an error code for success

== ExecuteCommandListAuto ==
Takes a command list from either a static buffer or a receive buffer, returns data in either a static (or recieve?) buffer.

=== Commands ===
* 0x40 [u8 len] <bytes> - Write bytes to device
* 0xC1 [u8 len] - Receive bytes from device

= uart =
This is "nn::uart::IManager".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#DoesUartExist]]
|-
| 1 || DoesUartExistForTest
|-
| 2 || [[#IsUartBaudrateValid]]
|-
| 3 || IsUartBaudrateValidForTest
|-
| 4 || [[#IsSomethingUartValid]]
|-
| 5 || IsSomethingUartValidForTest
|-
| 6 || [[#GetSession]]
|-
| 7 || IsSomethingUartValid2
|-
| 8 || IsSomethingUartValid2ForTest
|-
| 9 || [7.0.0+] IsSomethingUartValid3
|-
| 10 || [7.0.0+] IsSomethingUartValid3ForTest
|}

== DoesUartExist ==
Takes a u32 [[#UartPort]] and returns boolean success value

== IsUartBaudrateValid ==
Takes a u32 [[#UartPort]] and a u32 baudrate and returns boolean success value

== IsSomethingUartValid ==
Takes a u32 [[#UartPort]] and returns boolean success value

== GetSession ==
Takes a u32 [[#UartPort]] and returns an [[#IPortSession]]

== UartPort ==
{| class="wikitable sortable" border="1"
|-
! Name || DeviceCode || Port || Usage
|-
| 1 || 0x37000001 || UART-D || Bluetooth
|-
| 2 || 0x35000405 || UART-B || Joy-Con(R)
|-
| 3 || 0x3500040F || UART-C || Joy-Con(L)
|-
| 4 || 0x35000419 || ||
|}

== IPortSession ==
This is "nn::uart::IPortSession".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || OpenSession
|-
| 1 || OpenSessionForTest
|-
| 2 ||
|-
| 3 ||
|-
| 4 ||
|-
| 5 ||
|-
| 6 ||
|-
| 7 ||
|}

[7.0.0+] OpenSession/OpenSessionForTest now takes an additional 0x8-bytes of input.

=== Port Mapping ===
OpenSession translates user IDs to to the [[#UartPort]] index.

OpenSessionForTest takes the port index verbatim.

= pwm =
This is "nn::pwm::IManager".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || OpenSessionForDev
|-
| 1 || OpenSession
|-
| 2 || [6.0.0+] OpenSession2
|}

== Known Channels ==
{| class="wikitable sortable" border="1"
|-
! Name || DeviceCode || Interface || Usage || Used by
|-
| 1 || 0x3D000001 || PWM Channel 1 || Fan || [[PTM services]]
|-
| 2 || 0x3400003D || PWM Channel 0 || Backlight || [[Backlight services]], [[NV services]]
|-
| 3 || 0x35000065 || PMC Blinker || ||
|}

== IChannelSession ==
This is "nn::pwm::IChannelSession".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || SetPeriod
|-
| 1 || GetPeriod
|-
| 2 || SetDuty
|-
| 3 || GetDuty
|-
| 4 || SetEnabled
|-
| 5 || GetEnabled
|-
| 6 || [6.0.0+]
|-
| 7 || [6.0.0+]
|}

= pinmux =
This is "nn::pinmux::IManager".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || OpenSession
|}

== ISession ==
This is "nn::pinmux::ISession".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || SetPinAssignment
|-
| 1 || GetPinAssignment
|-
| 2 || SetPinAssignmentForHardwareTest
|}

= sasbus =
This is "nn::sasbus::IManager".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || OpenSession
|}

== ISession ==
This is "nn::sasbus::ISession".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 ||
|-
| 1 ||
|-
| 2 ||
|-
| 3 ||
|}

[[Category:Services]]

Bus services

2019-05-06T23:00:42Z

Ctcaer:

= gpio =
This is "nn::gpio::IManager".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#OpenSessionForDev]]
|-
| 1 || [[#OpenSession]]
|-
| 2 || [[#OpenSessionForTest]]
|-
| 3 || [1.0.0-6.2.0] IsWakeEventActive
|-
| 4 || [1.0.0-6.2.0] GetWakeEventActiveFlagSet
|-
| 5 || [1.0.0-6.2.0] SetWakeEventActiveFlagSetForDebug
|-
| 6 || SetWakePinDebugMode
|-
| 7 || [5.0.0+] [[#OpenSession2]]
|-
| 8 || [5.0.0+] IsWakeEventActive2
|-
| 9 || [5.0.0+] SetWakeEventActiveFlagSetForDebug2
|-
| 10 || [6.0.0+]
|}

== Known Devices ==
{| class="wikitable sortable" border="1"
|-
! GpioPadName || GpioPadDescriptor || DeviceCode || Tegra (port, pin) || Usage || Direction || Used by
|-
| 0x01 || 0xCC || 0x33000002 || Z, 4 || Audio Codec (ALC5639) Power (CODEC_LDO_EN_TEMP) || Out || [[Audio services]], [[Fatal services]]
|-
| 0x02 || 0x24 || 0x3C000001 || E, 4 || SDCard Power (POW_SD_EN) || Out || [[PCV services]]
|-
| 0x03 || 0x3C || 0x37000002 || H, 4 || Bluetooth Reset (BT_RST_PH4) || Out || [[Bluetooth Driver services]]
|-
| 0x04 || 0xDA || 0xC9000402 || BB, 2 || Secondary Boot Device Configration (RAM_CODE3) || In ||
|-
| 0x05 || 0xDB || 0x3C000402 || BB, 3 || GcAsic Reset (GC_RST) || Out || [[Filesystem services]]
|-
| 0x06 || 0xDC || 0x33000003 || BB, 4 || Audio Codec (ALC5639) Alert (CODEC_ALERT) || In || [[Audio services]]
|-
| 0x07 || 0x25 || 0x3C000401 || E, 5 || GcAsic Power (POW_GC) || Out ||
|-
| 0x08 || 0x90 || 0x350000CA || S, 0 || Debug Pad Detect (DEBUG_CONTROLLER_DET) || In || [[HID services]]
|-
| 0x09 || 0x91 || 0x39000407 || S, 1 || Battery Charge Status (BATT_CHG_STATUS) || In ||
|-
| 0x0A || 0x96 || 0x39000003 || S, 6 || Charger IC (BQ24193) Charge Enable (BATT_CHG_ENABLE_N) || Out || [[PTM services]]
|-
| 0x0B || 0x97 || 0x3D000002 || S, 7 || Fan Tachometer (FAN_TACH) || In ||
|-
| 0x0C || 0x26 || 0x3500040B || E, 6 || Joy-Con(L) IsAttached (insertion, Joy-Con pin 5/console TX, pulled low on insert?) (EXTCON_DET_S) || In || [[HID services]]
|-
| 0x0D || 0x05 || 0x39000401 || A, 5 || Fan Power (battery) (VDD50A_EN) || Out || [[PTM services]]
|-
| 0x0E || 0x78 || 0xCA000402 || P, 0 || SDEV Coax Select (SDEV_COAX_SEL_1) || In ||
|-
| 0x0F || 0x93 || 0x3C000403 || S, 3 || GcAsic Card Detect (GC_CD) || In || [[Filesystem services]]
|-
| 0x10 || 0x7D || 0xC900040B || P, 5 || PROD_TYPE_0 || In ||
|-
| 0x11 || 0x7C || 0xC900040C || P, 4 || PROD_TYPE_1 || In ||
|-
| 0x12 || 0x7B || 0xC900040D || P, 3 || PROD_TYPE_2 || In ||
|-
| 0x13 || 0x7A || 0xC900040E || P, 2 || PROD_TYPE_3 || In ||
|-
| 0x14 || 0xBC || 0x3E000002 || X, 4 || Temperature Sensor (TEMP_ALERT) || In ||
|-
| 0x15 || 0xAE || 0x33000004 || V, 6 || Audio Codec (ALC5639) Headphone Detect (CODEC_HP_DET_IRQ) || In || [[Audio services]]
|-
| 0x16 || 0xBA || 0x35000041 || X, 2 || MOTION_INT_PX2 || In ||
|-
| 0x17 || 0xB9 || 0x35000036 || X, 1 || TouchPanel IRQ (TP_IRQ) (unused - polled instead) || In || [[HID services]]
|-
| 0x18 || 0xBD || 0x35000001 || X, 5 || Power Button (BUTTON_POWER_ON_PX5) || In ||
|-
| 0x19 || 0xBE || 0x35000002 || X, 6 || Volume Up (BUTTON_VOL_UP_PX6) || In || [[Boot2]], [[Audio services]]
|-
| 0x1A || 0xBF || 0x35000003 || X, 7 || Volume Down (BUTTON_VOL_DOWN_PX7) || In || [[Boot2]], [[Audio services]]
|-
| 0x1B || 0xC0 || 0x39000034 || Y, 0 || Fuel Gauge IC (MAX17050) IRQ (BATT_MGIC_IRQ) || In || [[PTM services]]
|-
| 0x1C || 0xC1 || 0x35000004 || Y, 1 || Recovery Mode Key (BUTTON_HOME_PY1) || In ||
|-
| 0x1D || 0xA9 || 0x3400003E || V, 1 || Backlight Enable (LCD_BL_EN_PV1) || Out || [[NV services]], [[Backlight services]]
|-
| 0x1E || 0xAA || 0x34000033 || V, 2 || Backlight Reset (LCD_RST_PV2) || Out || [[NV services]]
|-
| 0x1F || 0x55 || 0x040000CC || K, 5 || USB-PD Controller (RHOM BM92T30MWV) VCONN Power (PD_VCONN_EN) || Out || [[PTM services]], [[USB services]]
|-
| 0x20 || 0xAD || 0x040000CA || V, 5 || USB-PD Controller (RHOM BM92T30MWV) Reset (PD_RST) || Out || [[USB services]]
|-
| 0x21 || 0xC8 || 0x39000002 || Z, 0 || Charger IC (BQ24193) IRQ (BQ24193_IRQ) || In || [[PTM services]]
|-
| 0x22 || 0xCA || 0xCA000401 || Z, 2 || SDEV Coax Select (SDEV_COAX_SEL_0) || In ||
|-
| 0x23 || 0xCB || 0x3C000003 || Z, 3 || SDCard Write Protect (SD_WP) || In ||
|-
| 0x24 || 0x4F || 0x35000035 || J, 7 || TouchPanel Reset (TP_RST) || Out || [[HID services]]
|-
| 0x25 || 0x50 || 0x37000401 || K, 0 || BT_GPIO_2 || In ||
|-
| 0x26 || 0x51 || 0x37000402 || K, 1 || BT_GPIO_3 || In ||
|-
| 0x27 || 0x52 || 0x37000403 || K, 2 || BT_GPIO_4 || In ||
|-
| 0x28 || 0x54 || 0x040000CB || K, 4 || USB-PD Controller (RHOM BM92T30MWV) IRQ (PD_IRQ) || In || [[USB services]]
|-
| 0x29 || 0x56 || 0x3E000003 || K, 6 || POW_VCPU_INT || In ||
|-
| 0x2A || 0x57 || 0x3E000004 || K, 7 || MAX77621_GPU_INT || In ||
|-
| 0x2B || 0x53 || 0x35000402 || K, 3 || Joy-Con(R) Charge Detect (EXTCON_CHG_U) || Out || [[HID services]]
|-
| 0x2C || 0xE3 || 0x3500040C || CC, 3 || Joy-Con(L) Charge Detect (EXTCON_CHG_S) || Out || [[HID services]]
|-
| 0x2D || 0x38 || 0x38000003 || H, 0 || WIFI_RF_DISABLE || Out ||
|-
| 0x2E || 0x39 || 0x38000002 || H, 1 || WiFi Reset (WIFI_RST_PH1) || Out || [[WLAN services]], [[PCIe services]]
|-
| 0x2F || 0x3B || 0x37000003 || H, 3 || AP_WAKE_BT_PH3 || Out || [[Bluetooth Driver services]]
|-
| 0x30 || 0x3D || 0x37000004 || H, 5 || BT_WAKE_AP || In ||
|-
| 0x31 || 0x3F || 0x37000404 || H, 7 || BT_GPIO_5 || Out ||
|-
| 0x32 || 0x40 || 0x34000034 || I, 0 || Backlight +5V (LCD_VDD_P_EN) || Out || [[NV services]]
|-
| 0x33 || 0x41 || 0x34000035 || I, 1 || Backlight -5V (LCD_VDD_N_EN) || Out || [[NV services]]
|-
| 0x34 || 0x3E || 0x35000401 || H, 6 || Joy-Con(R) IsAttached (insertion, Joy-Con pin 5/console TX, pulled low on insert?) (EXTCON_DET_U) || In || [[HID services]]
|-
| 0x35 || 0xE2 || 0xC9000401 || CC, 2 || Secondary Boot Device Configration (RAM_CODE2) || In ||
|-
| 0x36 || 0xE4 || 0x39000402 || CC, 4 || Fan Power (USB) (VDD50B_EN) || Out || [[PTM services]]
|-
| 0x37 || 0x3A || 0x38000004 || H, 2 || WIFI_WAKE_HOST || In ||
|-
| 0x38 || 0xC9 || 0x3C000002 || Z, 1 || SDCard Card Detect (SD_CD) || In || [[Filesystem services]]
|-
| 0x39 || 0x4D || 0x39000404 || J, 5 || Charger IC (BQ24193) OTG Charge Select (OTG_FET_1) || Out || [[PTM services]], [[USB services]]
|-
| 0x3A || 0x58 || 0x39000405 || L, 0 || Charger IC (BQ24193) OTG Charge Select (OTG_FET_2) || Out || [[PTM services]], [[USB services]]
|-
| 0x3B || 0x3E || 0x35000403 || H, 6 || Joy-Con(R) Wake Detect (EXTCON_DET_U) || In ||
|-
| 0x3C || 0x26 || 0x3500040D || E, 6 || Joy-Con(L) Wake Detect (EXTCON_DET_S) || In ||
|-
| 0x3D || -1 || 0x39000406 || || || ||
|-
| 0x3E || 0x33 || 0x35000404 || G, 3 || Joy-Con(R) CTS (checked low) (EXT_UART2_CTS) || In || [[HID services]]
|-
| 0x3F || 0x1C || 0x3500040E || D, 4 || Joy-Con(L) CTS (checked low) (EXT_UART3_CTS) || In || [[HID services]]
|-
| 0x40 || 0xD9 || 0x39000408 || BB, 1 || 5V Step-Down Regulator Power (5V_STEPDOWN_EN) || Out || (SDEV only)
|-
| 0x41 || 0x0C || 0x04000401 || B, 4 || USB Root Port 2 Over Current (USB_B2_OC) || In || [[USB services]] (SDEV only)
|-
| 0x42 || 0x0D || 0x39000409 || B, 5 || 5V Step-Down Regulator Power Good Flag (5V_STEPDOWN_PG) || In || (SDEV only)
|-
| 0x43 || 0x21 || 0x04000402 || E, 1 || USB Power (USB_A_EN) || Out || [[USB services]] (SDEV only)
|-
| 0x44 || 0x27 || 0x04000403 || E, 7 || USB Power Flag (USB_A_FLAG) || In || [[USB services]] (SDEV only)
|-
| 0x45 || 0x92 || 0x04000404 || S, 2 || USB Root Port 3 Over Current (USB_B3_OC) || In || [[USB services]] (SDEV only)
|-
| 0x46 || 0x95 || 0x04000405 || S, 5 || USB Root Port 3 Power (USB_B3_EN) || Out || [[USB services]] (SDEV only)
|-
| 0x47 || 0x98 || 0x04000406 || T, 0 || USB Root Port 2 Power (USB_B2_EN) || Out || [[USB services]] (SDEV only)
|-
| 0x48 || 0x10 || 0x34000004 || C, 0 || HDMI 5V (HDMI_5V_EN) || Out || [2.0.0+] [[NV services]]
|-
| 0x49 || 0x11 || 0x04000407 || C, 1 || USB Root Port 1 Power (USB_B1_EN) || Out || [[USB services]]
|-
| 0x4A || 0x12 || 0x34000005 || C, 2 || HDMI/Power Delivery Switch (HDMI_PD_TR_EN) || Out || [[NV services]]
|-
| 0x4B || 0x42 || 0x3D000003 || I, 2 || Fan Enable (FAN_EN) || Out || [[PTM services]]
|-
| 0x4C || 0xE6 || 0x04000408 || CC, 6 || USB Root Port 1 Over Current (USB_B1_OC) || In || [[USB services]] (SDEV only)
|-
| [2.0.0+] 0x4D || 0xAC || 0x3D000001 || V, 4 || Fan Pulse-Width Modulation Control (PWM_FAN) || Out || [[PTM services]]
|-
| [2.0.0+] 0x4E || 0xE1 || 0x34000006 || CC, 1 || HDMI Hot Plug Detect (HDMI_INT_DP_HPD_PCC1) || In || [[NV services]]
|-
| [5.0.0+] 0x4F || 0x56 || 0x3E000003 || K, 6 || MAX77812_IRQ || ||
|-
| [6.0.0+] 0x50 || 0x20 || 0xCA000001 || E, 0 || || ||
|-
| [6.0.0+] 0x51 || 0x21 || 0xCA000002 || E, 1 || || ||
|-
| [6.0.0+] 0x52 || 0x22 || 0xCA000003 || E, 2 || || ||
|-
| [6.0.0+] 0x53 || 0x23 || 0xCA000004 || E, 3 || || ||
|-
| [6.0.0+] 0x54 || 0x4C || 0x36000004 || J, 4 || NFC_IRQ || ||
|-
| [6.0.0+] 0x55 || 0x57 || 0x36000003 || K, 7 || NFC_RST || ||
|-
| [6.0.0+] 0x56 || 0x94 || 0x35000415 || S, 4 || MCU_IRQ || ||
|-
| [6.0.0+] 0x57 || 0x98 || 0x35000416 || T, 0 || MCU_BOOT || ||
|-
| [6.0.0+] 0x58 || 0x99 || 0x35000417 || T, 1 || MCU_RST || ||
|-
| [6.0.0+] 0x59 || 0xBB || 0x39000403 || X, 3 || Fan Power (5V3) (VDD5V3_EN) || || [[PTM services]]
|-
| [6.0.0+] 0x5A || 0xE5 || 0x35000418 || CC, 5 || MCU_POR || ||
|-
| [6.0.0+] 0x5B || 0xAB || 0x35000005 || V, 3 || || ||
|-
| [6.0.0+] 0x5C || 0x4E || 0x36000002 || J, 6 || || ||
|-
| [7.0.0+] - || 0x32 || 0x35000406 || G, 2 || Joy-Con(R) RTS || ||
|-
| [7.0.0+] - || 0x1B || 0x35000410 || D, 3 || Joy-Con(L) RTS || ||
|-
| [7.0.0+] - || 0x17 || 0x3500041B || C, 7 || || ||
|-
| [7.0.0+] - || 0x18 || 0x3500041C || D, 0 || || ||
|-
| [7.0.0+] - || 0x15 || 0x3500041D || C, 5 || || ||
|-
| [7.0.0+] - || 0x16 || 0x3500041E || C, 6 || || ||
|-
| [8.0.0+] - || 0x27 || 0x35000415 || S, 4 || MCU_IRQ (duplicate) || ||
|}

== GpioPadDescriptor ==
{| class="wikitable" border="1"
|-
! Bits || Description
|-
| 7-5 || Controller index
|-
| 4-3 || Port index
|-
| 2-0 || Pin number
|}

== OpenSessionForDev ==
Takes a raw [[#GpioPadDescriptor]] and returns a [[#IPadSession]] session for it.

== OpenSession ==
Same thing as [[#OpenSessionForDev]] except it takes a '''GpioPadName''' which is then converted to a [[#GpioPadDescriptor]]. Returns an [[#IPadSession]] session.

== OpenSessionForTest ==
Same as [[#OpenSession]] but panics on failure.

== OpenSession2 ==
Same as [[#OpenSession]] but takes a '''DeviceCode''' instead of a '''GpioPadName''' and an u32 '''DeviceUnk'''.

== IPadSession ==
This is "nn::gpio::IPadSession".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || SetDirection
|-
| 1 || GetDirection
|-
| 2 || SetInterruptMode
|-
| 3 || GetInterruptMode
|-
| 4 || SetInterruptEnable
|-
| 5 || GetInterruptEnable
|-
| 6 || GetInterruptStatus
|-
| 7 || ClearInterruptStatus
|-
| 8 || SetValue
|-
| 9 || GetValue
|-
| 10 || BindInterrupt
|-
| 11 || UnbindInterrupt
|-
| 12 || SetDebounceEnabled
|-
| 13 || GetDebounceEnabled
|-
| 14 || SetDebounceTime
|-
| 15 || GetDebounceTime
|-
| 16 || [4.0.0+] SetValueForSleepState
|-
| 17 || [6.0.0+] GetValueForSleepState
|}

= i2c, i2c:pcv =
This is "nn::i2c::IManager".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#OpenSessionForDev_2|OpenSessionForDev]]
|-
| 1 || [[#OpenSession_2|OpenSession]]
|-
| [1.0.0-5.1.0] 2 || [[#HasDevice|HasDevice]]
|-
| [1.0.0-5.1.0] 3 || [[#HasDeviceForDev|HasDeviceForDev]]
|-
| 4 || [6.0.0+] [[#OpenSession2_2|OpenSession2]]
|}

== Known Devices ==
{| class="wikitable sortable" border="1"
|-
! Name || DeviceCode || Port:Addr || Is10bit || Speed || Max Retries || Retry Delay || Usage || Used by
|-
| 0 || 0x350000C9 || 0:52 || N || 100000 || 0 || 0 || DebugPadDriver || [[HID services]]
|-
| 1 || 0x35000033 || 2:49 || N || 400000 || 0 || 0 || TouchPanel || [[HID services]]
|-
| 2 || 0x3E000001 || 0:4c || N || 100000 || 0 || 0 || Temperature Sensor (TMP451 or NCT72) || [[PTM services]]
|-
| 3 || 0x3E000001 || 0:4c || N || 100000 || 0 || 0 || Temperature Sensor (TMP451 or NCT72) (duplicate) || [[PTM services]]
|-
| 4 || 0x33000001 || 0:1c || N || 100000 || 0 || 0 || Audio Codec (ALC5639) || [[Audio services]], [[Fatal services]]
|-
| 5 || 0x3B000001 || 4:68 || N || 400000 || 3 || 5000000 || PMIC RTC (max77620_rtc0), max77620_irq0 || [[PCV services]]
|-
| 6 || 0x3A000001 || 4:3c || N || 400000 || 3 || 5000000 || PMIC (MAX77620), max77620_irq0 || [[PCV services]]
|-
| 7 || 0x3A000003 || 4:1b || N || 400000 || 3 || 5000000 || Sub-PMIC for CPU (max77621_cpu) || [[PCV services]]
|-
| 8 || 0x3A000004 || 4:1c || N || 400000 || 3 || 5000000 || Sub-PMIC for GPU (max77621_gpu) || [[PCV services]]
|-
| 9 || 0x39000001 || 0:6b || N || 100000 || 3 || 5000000 || Charger IC (BQ24193) || [[PTM services]]
|-
| 10 || 0x39000033 || 0:36 || N || 100000 || 3 || 5000000 || Fuel Gauge IC (MAX17050) || [[PTM services]], [[PCV services]]
|-
| 11 || 0x040000C9 || 0:18 || N || 100000 || 3 || 5000000 || USB-PD controller (RHOM BM92T30MWV) || [[USB services]]
|-
| 12 || 0x3F000401 || 1:40 || N || 400000 || 3 || 5000000 || Power Monitor (ina226_V_VDD15V0-HB) || Factory testing
|-
| 13 || 0x3F000001 || 1:41 || N || 400000 || 3 || 5000000 || Power Monitor (ina226_V_VSYS-CPU-DS) || Factory testing
|-
| 14 || 0x3F000002 || 1:44 || N || 400000 || 3 || 5000000 || Power Monitor (ina226_V_VSYS-GPU-DS) || Factory testing
|-
| 15 || 0x3F000003 || 1:45 || N || 400000 || 3 || 5000000 || Power Monitor (ina226_V_VSYS-DDR-DS) || Factory testing
|-
| 16 || 0x3F000402 || 1:46 || N || 400000 || 3 || 5000000 || Power Monitor (ina226_V_VSYS-AP) || Factory testing
|-
| 17 || 0x3F000403 || 1:47 || N || 400000 || 3 || 5000000 || Power Monitor (ina226_V_VSYS-BL-DS) || Factory testing
|-
| 18 || 0x35000047 || 1:29 || N || 400000 || 3 || 5000000 || Ambient Light Sensor (BH1730) || [[Backlight services]]
|-
| 19 || 0x3F000404 || 1:48 || N || 400000 || 3 || 5000000 || Power Monitor (ina226_CORE) || Factory testing
|-
| 20 || 0x3F000405 || 1:49 || N || 400000 || 3 || 5000000 || Power Monitor (ina226_Soc-1V8) || Factory testing
|-
| 21 || 0x3F000406 || 1:4a || N || 400000 || 3 || 5000000 || Power Monitor (ina226_LPDDR4-1V8) || Factory testing
|-
| 22 || 0x3F000407 || 1:4b || N || 400000 || 3 || 5000000 || Power Monitor (ina226_REG1V32) || Factory testing
|-
| 23 || 0x3F000408 || 1:4d || N || 400000 || 3 || 5000000 || Power Monitor (ina226_VDD3V3-SYS) || Factory testing
|-
| [2.0.0+] 24 || 0x34000001 || 3:50 || N || 100000 || 0 || 0 || HDMI DDC || [[NV services]]
|-
| [2.0.0+] 25 || 0x34000002 || 3:54 || N || 100000 || 0 || 0 || HDMI SCDC || [[NV services]]
|-
| [2.0.0+] 26 || 0x34000003 || 3:3a || N || 100000 || 0 || 0 || HDMI HDCP || [[NV services]]
|-
| [4.0.0+] 27 || 0x3A000005 || 4:a4 || N || 400000 || 0 || 0 || Buck Regulator (FAN53528) ||
|-
| [4.0.0+] 28 || 0x3A000002 || 4:31 || N || 400000 || 0 || 0 || PMIC (MAX77812) || [[PCV services]]
|-
| [4.0.0+] 29 || 0x3A000002 || 4:33 || N || 400000 || 0 || 0 || PMIC (MAX77812) || [[PCV services]]
|-
| [4.0.0+] 30 || 0x3F000409 || 1:4e || N || 400000 || 3 || 5000000 || Power Monitor (ina226_V_VDD-DDR-0V6) || Factory testing
|-
| [8.0.0+] 31 || 0x36000001 || 1:08 || N || 400000 || 3 || 5000000 || ||
|}

== OpenSessionForDev ==
Takes an u32 '''port''', an u16 '''addr''', an '''AddressingMode''' (1 for 10-bit, 0 otherwise) and a '''SpeedMode''' (400000 or 100000). Returns a [[#II2cSession]] session.

== OpenSession ==
Takes an '''I2cDevice''' and returns a [[#II2cSession]] session for it.

== HasDevice ==
Takes an '''I2cDevice''' and returns true if the device exists or false otherwise.

== HasDeviceForDev ==
Takes an u32 '''port''', an u16 '''addr''', an '''AddressingMode''' (1 for 10-bit, 0 otherwise) and a '''SpeedMode''' (400000 or 100000). Returns true if the device exists or false otherwise.

== OpenSession2 ==
Same as [[#OpenSession_2|OpenSession]] but takes a '''DeviceCode''' instead of a '''I2cDevice'''.

== II2cSession ==
This is "nn::i2c::ISession".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| [1.0.0-5.1.0] 0 || Send
|-
| [1.0.0-5.1.0] 1 || Receive
|-
| [1.0.0-5.1.0] 2 || ExecuteCommandList
|-
| 10 || [[#SendAuto]]
|-
| 11 || ReceiveAuto
|-
| 12 || [[#ExecuteCommandListAuto]]
|-
| 13 || [6.0.0+]
|}

== SendAuto ==
Takes bytes to write in either a static buffer or a receive buffer, returns an error code for success

== ExecuteCommandListAuto ==
Takes a command list from either a static buffer or a receive buffer, returns data in either a static (or recieve?) buffer.

=== Commands ===
* 0x40 [u8 len] <bytes> - Write bytes to device
* 0xC1 [u8 len] - Receive bytes from device

= uart =
This is "nn::uart::IManager".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#DoesUartExist]]
|-
| 1 || DoesUartExistForTest
|-
| 2 || [[#IsUartBaudrateValid]]
|-
| 3 || IsUartBaudrateValidForTest
|-
| 4 || [[#IsSomethingUartValid]]
|-
| 5 || IsSomethingUartValidForTest
|-
| 6 || [[#GetSession]]
|-
| 7 || IsSomethingUartValid2
|-
| 8 || IsSomethingUartValid2ForTest
|-
| 9 || [7.0.0+] IsSomethingUartValid3
|-
| 10 || [7.0.0+] IsSomethingUartValid3ForTest
|}

== DoesUartExist ==
Takes a u32 [[#UartPort]] and returns boolean success value

== IsUartBaudrateValid ==
Takes a u32 [[#UartPort]] and a u32 baudrate and returns boolean success value

== IsSomethingUartValid ==
Takes a u32 [[#UartPort]] and returns boolean success value

== GetSession ==
Takes a u32 [[#UartPort]] and returns an [[#IPortSession]]

== UartPort ==
{| class="wikitable sortable" border="1"
|-
! Name || Port || Usage
|-
| 1 || UART-D || Bluetooth
|-
| 2 || UART-B || Joy-Con(R)
|-
| 3 || UART-C || Joy-Con(L)
|}

== IPortSession ==
This is "nn::uart::IPortSession".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || OpenSession
|-
| 1 || OpenSessionForTest
|-
| 2 ||
|-
| 3 ||
|-
| 4 ||
|-
| 5 ||
|-
| 6 ||
|-
| 7 ||
|}

[7.0.0+] OpenSession/OpenSessionForTest now takes an additional 0x8-bytes of input.

=== Port Mapping ===
OpenSession translates user IDs to to the [[#UartPort]] index.

OpenSessionForTest takes the port index verbatim.

= pwm =
This is "nn::pwm::IManager".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || OpenSessionForDev
|-
| 1 || OpenSession
|-
| 2 || [6.0.0+]
|}

== Known Channels ==
{| class="wikitable sortable" border="1"
|-
! Name || Interface || Usage || Used by
|-
| 1 || PWM Channel 1 || Fan || [[PTM services]]
|-
| 2 || PWM Channel 0 || Backlight || [[Backlight services]], [[NV services]]
|-
| 3 || PMC Blinker || ||
|}

== IChannelSession ==
This is "nn::pwm::IChannelSession".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || SetPeriod
|-
| 1 || GetPeriod
|-
| 2 || SetDuty
|-
| 3 || GetDuty
|-
| 4 || SetEnabled
|-
| 5 || GetEnabled
|-
| 6 || [6.0.0+]
|-
| 7 || [6.0.0+]
|}

= pinmux =
This is "nn::pinmux::IManager".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || OpenSession
|}

== ISession ==
This is "nn::pinmux::ISession".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || SetPinAssignment
|-
| 1 || GetPinAssignment
|-
| 2 || SetPinAssignmentForHardwareTest
|}

= sasbus =
This is "nn::sasbus::IManager".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || OpenSession
|}

== ISession ==
This is "nn::sasbus::ISession".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 ||
|-
| 1 ||
|-
| 2 ||
|-
| 3 ||
|}

[[Category:Services]]

Cryptosystem

2019-05-02T00:12:03Z

Ctcaer: Undo revision 6770 by Shchmue (talk) - ("Storage" is used in all other patents and all nv code, docs and binaries

== BootROM ==
The bootrom initializes two keyslots in the hardware engine:

* the SBK (Secure Boot Key) in keyslot 14
* the SSK (Secure Storage Key) in keyslot 15.

Reads from both of these keyslots are disabled by the bootROM.
The SBK is stored in [[Fuses#FUSE_PRIVATE_KEY|FUSE_PRIVATE_KEY]], which are locked to read out only FFs after the bootrom finishes.

SBK is '''unique''' per console, and not shared among consoles as originally believed.

The SSK is derived on boot via the SBK, the 32-bit console-unique "Device Key", and hardware information stored in fuses.

Pseudocode for the derivation is as follows:
void generateSSK() {
char keyBuffer[0x10]; // Used to store keydata
uint hwInfoBuffer[4]; // Used to store info about hardware from fuses
uint deviceKey = getDeviceKey(); // Reads 32-bit device key from FUSE_PRIVATE_KEY4.
for (int i = 0; i < 4; i++) { // Keybuffer = deviceKey || deviceKey || deviceKey || deviceKey
((uint *)keyBuffer)[i] = deviceKey;
}

encryptWithSBK(keyBuffer); // keyBuffer = AES-ECB(SBK, deviceKey || {...})

// Set up Hardware info buffer
uint vendor_code = *((uint *)0x7000FA00) & 0x0000000F; // FUSE_VENDOR_CODE
uint fab_code = *((uint *)0x7000FA04) & 0x0000003F; // FUSE_FAB_CODE
uint lot_code_0 = *((uint *)0x7000FA08) & 0xFFFFFFFF; // FUSE_LOT_CODE_0
uint lot_code_1 = *((uint *)0x7000FA0C) & 0x0FFFFFFF; // FUSE_LOT_CODE_1
uint wafer_id = *((uint *)0x7000FA10) & 0x0000003F; // FUSE_WAFER_ID
uint x_coord = *((uint *)0x7000FA14) & 0x000001FF; // FUSE_X_COORDINATE
uint y_coord = *((uint *)0x7000FA18) & 0x000001FF; // FUSE_Y_COORDINATE
uint unk_hw_fuse = *((uint *)0x7000FA20) & 0x0000003F; // Unknown cached fuse.

// HARDWARE_INFO_BUFFER = unk_hw_fuse || Y_COORD || X_COORD || WAFER_ID || LOT_CODE || FAB_CODE || VENDOR_ID
hwInfoBuffer[0] = (lot_code_1 << 30) | (wafer_id << 24) | (x_coord << 15) | (y_coord << 6) | unk_hw_fuse;
hwInfoBuffer[1] = (lot_code_0 << 26) | (lot_code_1 >> 2);
hwInfoBuffer[2] = (fab_code << 26) | (lot_code_0 >> 6);
hwInfoBuffer[3] = vendor_code;

for (int i = 0; i < 0x10; i++) { // keyBuffer = XOR(AES-ECB(SBK, deviceKey || {...}), HARDWARE_INFO_BUFFER)
keyBuffer[i] ^= ((char *)hwInfoBuffer)[i];
}

encryptWithSBK(keyBuffer); // keyBuffer = AES-ECB(SBK, XOR(AES-ECB(SBK, deviceKey || {...}), HARDWARE_INFO_BUFFER))

setKeyslot(KEYSLOT_SSK, keyBuffer); // SSK = keyBuffer.
}

== Falcon coprocessor ==
The falcon processor (TSEC) generates a special console-unique key (that will be referred to as the "tsec key").

This is presumably using data stored in fuses that only microcode authenticated by NVidia has access to.

== Package1ldr ==

=== Key table during package1ldr ===

{| class="wikitable" border="1"
|-
! Keyslot
! Name
! Set by
! Per-console
! Per-firmware
|-
| 11
| Package1Key
| [[Package1#Package1ldr|Package1ldr]]
| No
| Yes
|-
| 14
| SecureBootKey
| Bootrom
| Yes
| No
|-
| 15
| SecureStorageKey
| Bootrom
| Yes
| No
|}

=== [1.0.0-3.0.2] Key table after package1ldr ===

{| class="wikitable" border="1"
|-
! Keyslot
! Name
! Set by
! Per-console
! Per-firmware
|-
| 12
| MasterKey
| [[Package1#Package1ldr|Package1ldr]]
| No
| Yes, on security updates
|-
| 13
| PerConsoleKey
| [[Package1#Package1ldr|Package1ldr]]
| Yes
| No
|}

=== [4.0.0]+ Key table after package1ldr (Secure Monitor boot) ===

{| class="wikitable" border="1"
|-
! Keyslot
! Name
! Set by
! Per-console
! Per-firmware
|-
| 12
| MasterKey
| [[Package1#Package1ldr|Package1ldr]]
| No
| Yes, on security updates
|-
| 13
| PerConsoleKeyForFirmwareSpecificPerConsoleKeyGen
| [[Package1#Package1ldr|Package1ldr]]
| Yes
| No
|-
| 14
| StaticKeyForFirmwareSpecificPerConsoleKeyGen
| [[Package1#Package1ldr|Package1ldr]]
| No
| Yes, on security updates
|-
| 15
| PerConsoleKey
| [[Package1#Package1ldr|Package1ldr]]
| Yes
| No
|}

=== [4.0.0]+ Key table after package1ldr (Secure Monitor runtime) ===

{| class="wikitable" border="1"
|-
! Keyslot
! Name
! Set by
! Per-console
! Per-firmware
|-
| 12
| MasterKey
| [[Package1#Package1ldr|Package1ldr]]
| No
| Yes, on security updates
|-
| 13
| FirmwareSpecificPerConsoleKey
| Secure Monitor init
| Yes
| Yes, on security updates
|-
| 15
| PerConsoleKey
| [[Package1#Package1ldr|Package1ldr]]
| Yes
| No
|}

=== [6.2.0]+ Key table after package1ldr/TSEC Payload (Secure Monitor boot) ===

{| class="wikitable" border="1"
|-
! Keyslot
! Name
! Set by
! Per-console
! Per-firmware
|-
| 12
| TsecKey
| [[TSEC#Payload|Package1ldr TSEC Firmware]]
| Yes
| No
|-
| 13
| TsecRootKey
| [[TSEC#Payload|Package1ldr TSEC Firmware]]
| No
| Unknown
|-
| 14
| SecureBootKey
| Bootrom
| Yes
| No
|-
| 15
| SecureStorageKey
| Bootrom
| Yes
| No
|}

=== Key generation ===
Note: aes_unwrap(wrapped_key, wrap_key) is just another name for a single AES-128 block decryption.

If bit0 of 0x7000FB94 is clear, it will initialize keys like this (probably used for internal development units only):
// Final keys:
package1_key /* slot11 */ = aes_unwrap(f5b1eadb.., sbk)
master_key /* slot12 */ = aes_unwrap(bct->pubkey[0] == 0x11 ? simpleseed_dev0 : simpleseed_dev1, aes_unwrap(5ff9c2d9.., sbk))
per_console_key /* slot13 */ = aes_unwrap(4f025f0e..., aes_unwrap(6e4a9592.., ssk))

[4.0.0+] Above method was removed.

Normal key generation looks like this on 1.0.0/2.0.0:

keyblob_key /* slot13 */ = aes_unwrap(aes_unwrap(wrapped_keyblob_key, tsec_key /* slot13 */), sbk /* slot14 */)
cmac_key /* slot11 */ = aes_unwrap(59c7fb6f.., keyblob_key)

if aes_cmac(buf=keyblob+0x10, len=0xA0, cmac_key) != keyblob[0:0x10]:
panic()

aes_ctr_decrypt(buf=keyblob+0x20, len=0x90, iv=keyblob+0x10 key=keyblob_key)

// Final keys:
package1_key /* slot11 */ = keyblob[0x80:0x90]
master_key /* slot12 */ = aes_unwrap(bct->pubkey[0] == 0x4f ? normalseed_dev : normalseed_retail, keyblob+0x20)
per_console_key /* slot13 */ = aes_unwrap(4f025f0e.., keyblob_key)

.. and on 3.0.0, they moved keyslots around a little to generate the same per-console key as 1.0.0:

old_keyblob_key /* slot10 */ = aes_unwrap(aes_unwrap(df206f59.., tsec_key /* slot13 */), sbk /* slot14 */)
keyblob_key /* slot13 */ = aes_unwrap(aes_unwrap(wrapped_keyblob_key, tsec_key /* slot13 */), sbk /* slot14 */)
cmac_key /* slot11 */ = aes_unwrap(59c7fb6f.., keyblob_key)

if aes_cmac(buf=keyblob+0x10, len=0xA0, cmac_key) != keyblob[0:0x10]:
panic()

aes_ctr_decrypt(buf=keyblob+0x20, len=0x90, iv=keyblob+0x10 key=keyblob_key)

// Final keys:
package1_key /* slot11 */ = keyblob[0x80:0x90]
master_key /* slot12 */ = aes_unwrap(bct->pubkey[0] == 0x4f ? normalseed_dev : normalseed_retail, keyblob+0x20)
per_console_key /* slot13 */ = aes_unwrap(4f025f0e.., old_keyblob_key)

.. and on 4.0.0 it was further moved around:

keyblob_key /* slot13 */ = aes_unwrap(aes_unwrap(wrapped_keyblob_key, tsec_key /* slot13 */), sbk /* slot14 */)
cmac_key /* slot11 */ = aes_unwrap(59c7fb6f.., keyblob_key)

if aes_cmac(buf=keyblob+0x10, len=0xA0, cmac_key) != keyblob[0:0x10]:
panic()

aes_ctr_decrypt(buf=keyblob+0x20, len=0x90, iv=keyblob+0x10 key=keyblob_key)

// Final keys:
package1_key /* slot11 */ = keyblob[0x80:0x90]
master_key /* slot12 */ = aes_unwrap(normalseed_retail, keyblob+0x20)
new_master_key /* slot14 */ = aes_unwrap(2dc1f48d.., keyblob+0x20)
new_per_console_key /* slot13 */ = aes_unwrap(0c9109db.., old_keyblob_key)
per_console_key /* slot15 */ = aes_unwrap(4f025f0e.., old_keyblob_key)

.. and on 6.2.0, they moved key generation out of package1ldr, and into the Secure Monitor's boot section:

clear_keyslots_other_than_12_13_and_14()

old_keyblob_key /* slot15 */ = aes_unwrap(aes_unwrap(df206f59.., tsec_key /* slot12 */), sbk /* slot14 */)
/* Previously, master_kek was stored at keyblob+0x20) */
master_kek /* slot13 */ = aes_unwrap(374b7729.. /* probably firmware specific */, tsec_root_key /* slot13 */)

clear_keyslot(12)

// Final keys:
new_master_key /* slot12 */ = aes_unwrap(2dc1f48d.., master_kek)
master_key /* slot13 */ = aes_unwrap(normalseed_retail, master_kek)
new_per_console_key /* slot14 */ = aes_unwrap(0c9109db.., old_keyblob_key)
per_console_key /* slot15 */ = aes_unwrap(4f025f0e.., old_keyblob_key)

SBK and SSK keyslots are cleared after keys have been generated.

See table above for which keys are console unique.

The key used to verify a keyblob's MAC is not the keyblob key but a key derived from it; this is likely part of an attempt to mitigate side-channel attacks as the MAC is an alterable part of the keyblob.

The bootloader only stores the hardcoded constants for the keyblob used in the current revision. Nintendo are withholding all the future hardcoded constants.

This means that if you have an attack on the bootloader, you need to re-preform it every time they move to a new keyblob.

Dumping the SBK and TSEC key of any single system should be enough to derive all key material on the system, prior to 6.2.0.

The key-derivation is described in more detail [[Package1#Key_generation|here]].

==== Keyblob ====
There are 32 keyblobs written to NAND at factory, with each keyblob encrypted with a console-unique key derived from the console's SBK, the console's tsec key, and a constant specific to each keyblob.

Despite being encrypted with console unique keys, though, the decrypted keyblob contents are shared for all consoles.

==== Seeds ====
normalseed_retail = d8a2410a...

[1.0.0] wrapped_keyblob_key = df206f59...
[1.0.0] simpleseed_dev0 = aff11423...
[1.0.0] simpleseed_dev1 = 5e177ee1...
[1.0.0] normalseed_dev = 0542a0fd...

[3.0.0] wrapped_keyblob_key = 0c25615d...
[3.0.0] simpleseed_dev0 = de00216a...
[3.0.0] simpleseed_dev1 = 2db7c0a1...
[3.0.0] normalseed_dev = 678c5a03...

[3.0.1] wrapped_keyblob_key = 337685ee...
[3.0.1] simpleseed_dev0 = e045f5ba...
[3.0.1] simpleseed_dev1 = 84d92e0d...
[3.0.1] normalseed_dev = cd88155b...

[4.0.0] wrapped_keyblob_key = 2d1f4880...

==== Table of used keyblobs ====

{| class="wikitable" border="1"
|-
! System version
! Used keyblob
! Used master static key encryption key in keyblob
|-
| 1.0.0-2.3.0
| 1
| 1
|-
| 3.0.0
| 2
| 1
|-
| 3.0.1-3.0.2
| 3
| 1
|-
| 4.0.0-4.1.0
| 4
| 1
|-
| 5.0.0-5.1.0
| 5
| 1
|-
| 6.0.0-6.1.0
| 6
| 1
|}

Starting from 6.2.0, key generation no longer uses keyblobs.

== Secure Monitor Init ==
On all versions, the key to decrypt [[Package2]] is generated by decrypting a constant seed with the master key. The key is erased after use.

Additionally, starting from 4.0.0, the Secure Monitor init will decrypt another constant seed successively with a special per console key and a special static key passed by package1loader, to generate the firmware specific per-console key. The operation will erase these special keys passed by package1loader.

== Secure Monitor ==
The secure monitor performs some runtime cryptographic operations. See [[SMC]] for what operations it provides.

HID services

2019-04-27T17:58:39Z

Ctcaer:

See [[HID_Shared_Memory|here]] for the HID shared-memory.

= hid =
This is "nn::hid::IHidServer".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#CreateAppletResource]]
|-
| 1 || ActivateDebugPad
|-
| 11 || ActivateTouchScreen
|-
| 21 || ActivateMouse
|-
| 31 || ActivateKeyboard
|-
| 32 || [6.0.0+] SendKeyboardLockKeyEvent
|-
| 40 || AcquireXpadIdEventHandle
|-
| 41 || ReleaseXpadIdEventHandle
|-
| 51 || ActivateXpad
|-
| 55 || GetXpadIds
|-
| 56 || ActivateJoyXpad
|-
| 58 || GetJoyXpadLifoHandle
|-
| 59 || GetJoyXpadIds
|-
| 60 || ActivateSixAxisSensor
|-
| 61 || DeactivateSixAxisSensor
|-
| 62 || GetSixAxisSensorLifoHandle
|-
| 63 || ActivateJoySixAxisSensor
|-
| 64 || DeactivateJoySixAxisSensor
|-
| 65 || GetJoySixAxisSensorLifoHandle
|-
| 66 || StartSixAxisSensor
|-
| 67 || StopSixAxisSensor
|-
| 68 || IsSixAxisSensorFusionEnabled
|-
| 69 || EnableSixAxisSensorFusion
|-
| 70 || SetSixAxisSensorFusionParameters
|-
| 71 || GetSixAxisSensorFusionParameters
|-
| 72 || ResetSixAxisSensorFusionParameters
|-
| 73 || SetAccelerometerParameters
|-
| 74 || GetAccelerometerParameters
|-
| 75 || ResetAccelerometerParameters
|-
| 76 || SetAccelerometerPlayMode
|-
| 77 || GetAccelerometerPlayMode
|-
| 78 || ResetAccelerometerPlayMode
|-
| 79 || SetGyroscopeZeroDriftMode
|-
| 80 || GetGyroscopeZeroDriftMode
|-
| 81 || ResetGyroscopeZeroDriftMode
|-
| 82 || IsSixAxisSensorAtRest
|-
| 83 || [6.0.0+] IsFirmwareUpdateAvailableForSixAxisSensor
|-
| 91 || ActivateGesture
|-
| 100 || [[#SetSupportedNpadStyleSet]]
|-
| 101 || [[#GetSupportedNpadStyleSet]]
|-
| 102 || [[#SetSupportedNpadIdType]]
|-
| 103 || ActivateNpad
|-
| 104 || DeactivateNpad
|-
| 106 || [[#AcquireNpadStyleSetUpdateEventHandle]]
|-
| 107 || DisconnectNpad
|-
| 108 || GetPlayerLedPattern
|-
| 109 || [5.0.0+] ActivateNpadWithRevision
|-
| 120 || SetNpadJoyHoldType
|-
| 121 || GetNpadJoyHoldType
|-
| 122 || [[#SetNpadJoyAssignmentModeSingleByDefault]]
|-
| 123 || [[#SetNpadJoyAssignmentModeSingle]]
|-
| 124 || [[#SetNpadJoyAssignmentModeDual]]
|-
| 125 || [[#MergeSingleJoyAsDualJoy]]
|-
| 126 || StartLrAssignmentMode
|-
| 127 || StopLrAssignmentMode
|-
| 128 || SetNpadHandheldActivationMode
|-
| 129 || [[#GetNpadHandheldActivationMode]]
|-
| 130 || SwapNpadAssignment
|-
| 131 || IsUnintendedHomeButtonInputProtectionEnabled
|-
| 132 || EnableUnintendedHomeButtonInputProtection
|-
| 133 || [5.0.0+] SetNpadJoyAssignmentModeSingleWithDestination
|-
| 134 || [6.1.0+] SetNpadAnalogStickUseCenterClamp
|-
| 135 || [8.0.0+] SetNpadCaptureButtonAssignment
|-
| 136 || [8.0.0+] ClearNpadCaptureButtonAssignment
|-
| 200 || [[#GetVibrationDeviceInfo]]
|-
| 201 || [[#SendVibrationValue]]
|-
| 202 || [[#GetActualVibrationValue]]
|-
| 203 || [[#CreateActiveVibrationDeviceList]]
|-
| 204 || [[#PermitVibration]]
|-
| 205 || [[#IsVibrationPermitted]]
|-
| 206 || [[#SendVibrationValues]]
|-
| 207 || [4.0.0+] SendVibrationGcErmCommand
|-
| 208 || [4.0.0+] GetActualVibrationGcErmCommand
|-
| 209 || [4.0.0+] BeginPermitVibrationSession
|-
| 210 || [4.0.0+] EndPermitVibrationSession
|-
| 211 || [7.0.0+] [[#IsVibrationDeviceMounted]]
|-
| 300 || ActivateConsoleSixAxisSensor
|-
| 301 || StartConsoleSixAxisSensor
|-
| 302 || StopConsoleSixAxisSensor
|-
| 303 || [5.0.0+] [[#ActivateSevenSixAxisSensor]]
|-
| 304 || [5.0.0+] [[#StartSevenSixAxisSensor]]
|-
| 305 || [5.0.0+] [[#StopSevenSixAxisSensor]]
|-
| 306 || [5.0.0+] [[#InitializeSevenSixAxisSensor]]
|-
| 307 || [5.0.0+] [[#FinalizeSevenSixAxisSensor]]
|-
| 308 || [5.0.0+] SetSevenSixAxisSensorFusionStrength
|-
| 309 || [5.0.0+] GetSevenSixAxisSensorFusionStrength
|-
| 310 || [6.0.0+] [[#ResetSevenSixAxisSensorTimestamp]]
|-
| 400 || IsUsbFullKeyControllerEnabled
|-
| 401 || EnableUsbFullKeyController
|-
| 402 || IsUsbFullKeyControllerConnected
|-
| 403 || [4.0.0+] HasBattery
|-
| 404 || [4.0.0+] HasLeftRightBattery
|-
| 405 || [4.0.0+] GetNpadInterfaceType
|-
| 406 || [4.0.0+] GetNpadLeftRightInterfaceType
|-
| 500 || [5.0.0+] GetPalmaConnectionHandle
|-
| 501 || [5.0.0+] InitializePalma
|-
| 502 || [5.0.0+] AcquirePalmaOperationCompleteEvent
|-
| 503 || [5.0.0+] GetPalmaOperationInfo
|-
| 504 || [5.0.0+] PlayPalmaActivity
|-
| 505 || [5.0.0+] SetPalmaFrModeType
|-
| 506 || [5.0.0+] ReadPalmaStep
|-
| 507 || [5.0.0+] EnablePalmaStep
|-
| 508 || [5.0.0+] ResetPalmaStep
|-
| 509 || [5.0.0+] ReadPalmaApplicationSection
|-
| 510 || [5.0.0+] WritePalmaApplicationSection
|-
| 511 || [5.0.0+] ReadPalmaUniqueCode
|-
| 512 || [5.0.0+] SetPalmaUniqueCodeInvalid
|-
| 513 || [5.0.0+] WritePalmaActivityEntry
|-
| 514 || [5.0.0+] WritePalmaRgbLedPatternEntry
|-
| 515 || [5.0.0+] WritePalmaWaveEntry
|-
| 516 || [5.0.0+] SetPalmaDataBaseIdentificationVersion
|-
| 517 || [5.0.0+] GetPalmaDataBaseIdentificationVersion
|-
| 518 || [5.0.0+] SuspendPalmaFeature
|-
| 519 || [5.1.0+] GetPalmaOperationResult
|-
| 520 || [5.1.0+] ReadPalmaPlayLog
|-
| 521 || [5.1.0+] ResetPalmaPlayLog
|-
| 522 || [5.1.0+] SetIsPalmaAllConnectable
|-
| 523 || [5.1.0+] SetIsPalmaPairedConnectable
|-
| 524 || [5.1.0+] PairPalma
|-
| 525 || [5.1.0+] SetPalmaBoostMode
|-
| 526 || [7.0.0+] CancelWritePalmaWaveEntry
|-
| 527 || [8.0.0+] EnablePalmaBoostMode
|-
| 528 || [8.0.0+] GetPalmaBluetoothAddress
|-
| 529 || [8.0.0+] SetDisallowedPalmaConnection
|-
| 1000 || SetNpadCommunicationMode
|-
| 1001 || GetNpadCommunicationMode
|}

== CreateAppletResource ==
Takes a PID and an u64 [[AM_services|AppletResourceUserId]]. Returns an [[#IAppletResource]].

== SetSupportedNpadStyleSet ==
Takes an u32 [[#NpadStyleTag]].

== GetSupportedNpadStyleSet ==
Returns an u32 [[#NpadStyleTag]].

== SetSupportedNpadIdType ==
Takes a PID-descriptor, a type-0x9 input buffer, and an [[AM_services|AppletResourceUserId]]. No output.

The input buffer contains an array of u32 [[#NpadIdType]].

== AcquireNpadStyleSetUpdateEventHandle ==
Takes an input u32, an u64 [[AM_services|AppletResourceUserId]], and an u64. Returns an output event handle, autoclear for this is user-specified.

The value for the last u64 doesn't seem to matter (?): official sw sets this to the address of the structure used for storing the event which is initialized after using this cmd.

== SetNpadJoyAssignmentModeSingleByDefault ==
Takes a PID-descriptor, an u32, and an [[AM_services|AppletResourceUserId]]. No output.

== SetNpadJoyAssignmentModeSingle ==
Takes a PID-descriptor, an u32, [[AM_services|AppletResourceUserId]], and s64 '''NpadJoyDeviceType'''. No output.

== SetNpadJoyAssignmentModeDual ==
Takes a PID-descriptor, an u32, and an [[AM_services|AppletResourceUserId]]. No output.

== MergeSingleJoyAsDualJoy ==
Takes a PID-descriptor, two u32s, and an [[AM_services|AppletResourceUserId]]. No output.

== GetNpadHandheldActivationMode ==
Takes a PID and an u64 [[AM_services|AppletResourceUserId]]. Returns an output u64. Official user-processes panic if the output u64 is not 0-2.

== GetVibrationDeviceInfo ==
Takes a [[#VibrationDeviceHandle]]. Returns an output [[#VibrationDeviceInfo]].

== SendVibrationValue ==
Takes a PID-descriptor, a [[#VibrationDeviceHandle]], a [[#VibrationValue]] immediately after that, and an u64 [[AM_services|AppletResourceUserId]]. No output.

== GetActualVibrationValue ==
Takes a PID-descriptor, a [[#VibrationDeviceHandle]], and an u64 [[AM_services|AppletResourceUserId]]. Returns an output [[#VibrationValue]].

== CreateActiveVibrationDeviceList ==
No input. Returns an [[#IActiveVibrationDeviceList]].

== PermitVibration ==
Takes an input u8 bool. No output.

This affects the config displayed by System Settings.

== IsVibrationPermitted ==
No input. Returns an output u8 bool.

== SendVibrationValues ==
Takes an u64 [[AM_services|AppletResourceUserId]], and two type-0x9 input buffers containing an array of: [[#VibrationDeviceHandle]] for first buffer, and [[#VibrationValue]] for the second buffer.

Official sw uses the same entry-count for each array.

== IsVibrationDeviceMounted ==
Takes a total of 0x10-bytes of input and a PID, returns an output u8 bool.

== ActivateSevenSixAxisSensor ==
Takes a PID and an u64 [[AM_services|AppletResourceUserId]], no output.

== StartSevenSixAxisSensor ==
Takes a PID and an u64 [[AM_services|AppletResourceUserId]], no output.

== StopSevenSixAxisSensor ==
Takes a PID and an u64 [[AM_services|AppletResourceUserId]], no output.

== InitializeSevenSixAxisSensor ==
Takes a PID, an u64 [[AM_services|AppletResourceUserId]], two u64s for the size of each TransferMemory, and two TransferMemory handles. No output.

The size of the first TransferMemory is 0x1000 with MemoryPermission=read-only, while the second one has size 0x7F000 with MemoryPermission=none.

== FinalizeSevenSixAxisSensor ==
Takes a PID and an u64 [[AM_services|AppletResourceUserId]], no output.

== ResetSevenSixAxisSensorTimestamp ==
Takes a PID and an u64 [[AM_services|AppletResourceUserId]], no output.

== VibrationDeviceHandle ==
This is an u32.

== VibrationDeviceInfo ==
This is a 0x8-byte struct.

== VibrationValue ==
This is a 0x10-byte struct, which contains 4 float values.

== IAppletResource ==

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

=== GetSharedMemoryHandle ===
No input. Returned a [[HID_Shared_Memory|sharedmem]] handle.

== IActiveVibrationDeviceList ==
This is "nn::hid::IActiveVibrationDeviceList".

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

=== ActivateVibrationDevice ===
Takes an input [[#VibrationDeviceHandle]]. No output.

== NpadStyleTag ==
This is a bitfield describing which controller styles are supported.

{| class="wikitable" border="1"
! Bits
! Description
! Notes
|-
| 0
| NpadFullKey
| Pro Controller.
|-
| 1
| NpadHandheld
| Joy-Con controller in handheld mode.
|-
| 2
| NpadJoyDual
| Joy-Con controller in dual mode.
|-
| 3
| NpadJoyLeft
| Joy-Con left controller in single mode.
|-
| 4
| NpadJoyRight
| Joy-Con right controller in single mode.
|-
| 5
| NpadGc
| GameCube controller.
|-
| 6
| NpadPalma
| Poké Ball Plus controller.
|-
| 7
| NpadLark
| NES controller.
|-
| 8
| NpadHandheldLark
| NES controller in handheld mode.
|-
| 9-28
| Reserved
|
|-
| 29
| NpadSystemExt
|
|-
| 30
| NpadSystem
|
|-
| 31
| Reserved
|
|}

== NpadIdType ==
This is an u32. This is the controller index used in [[HID_Shared_Memory#Controllers|sharedmem]]. 0x20 is handheld.

= hid:dbg =
This is "nn::hid::IHidDebugServer".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || DeactivateDebugPad
|-
| 1 || SetDebugPadAutoPilotState
|-
| 2 || UnsetDebugPadAutoPilotState
|-
| 10 || DeactivateTouchScreen
|-
| 11 || SetTouchScreenAutoPilotState
|-
| 12 || UnsetTouchScreenAutoPilotState
|-
| 20 || DeactivateMouse
|-
| 21 || SetMouseAutoPilotState
|-
| 22 || UnsetMouseAutoPilotState
|-
| 30 || DeactivateKeyboard
|-
| 31 || SetKeyboardAutoPilotState
|-
| 32 || UnsetKeyboardAutoPilotState
|-
| 50 || DeactivateXpad
|-
| 51 || SetXpadAutoPilotState
|-
| 52 || UnsetXpadAutoPilotState
|-
| 60 || DeactivateJoyXpad
|-
| 91 || DeactivateGesture
|-
| 110 || DeactivateHomeButton
|-
| 111 || SetHomeButtonAutoPilotState
|-
| 112 || UnsetHomeButtonAutoPilotState
|-
| 120 || DeactivateSleepButton
|-
| 121 || SetSleepButtonAutoPilotState
|-
| 122 || UnsetSleepButtonAutoPilotState
|-
| 123 || DeactivateInputDetector
|-
| 130 || DeactivateCaptureButton
|-
| 131 || SetCaptureButtonAutoPilotState
|-
| 132 || UnsetCaptureButtonAutoPilotState
|-
| 133 || SetShiftAccelerometerCalibrationValue
|-
| 134 || GetShiftAccelerometerCalibrationValue
|-
| 135 || SetShiftGyroscopeCalibrationValue
|-
| 136 || GetShiftGyroscopeCalibrationValue
|-
| 140 || DeactivateConsoleSixAxisSensor
|-
| 141 || [5.0.0+] GetConsoleSixAxisSensorSamplingFrequency
|-
| 142 || [5.0.0+] DeactivateSevenSixAxisSensor
|-
| 143 || [5.0.0+] GetConsoleSixAxisSensorCountStates
|-
| 144 || [8.0.0+] GetAccelerometerFsr
|-
| 145 || [8.0.0+] SetAccelerometerFsr
|-
| 146 || [8.0.0+] GetAccelerometerOdr
|-
| 147 || [8.0.0+] SetAccelerometerOdr
|-
| 148 || [8.0.0+] GetGyroscopeFsr
|-
| 149 || [8.0.0+] SetGyroscopeFsr
|-
| 150 || [8.0.0+] GetGyroscopeOdr
|-
| 151 || [8.0.0+] SetGyroscopeOdr
|-
| 201 || ActivateFirmwareUpdate
|-
| 202 || DeactivateFirmwareUpdate
|-
| 203 || StartFirmwareUpdate
|-
| 204 || GetFirmwareUpdateStage
|-
| 205 || GetFirmwareVersion
|-
| 206 || GetDestinationFirmwareVersion
|-
| 207 || DiscardFirmwareInfoCacheForRevert
|-
| 208 || StartFirmwareUpdateForRevert
|-
| 209 || GetAvailableFirmwareVersionForRevert
|-
| 210 || [4.0.0+] IsFirmwareUpdatingDevice
|-
| 211 || [6.0.0+] StartFirmwareUpdateIndividual
|-
| 215 || [6.0.0+] SetUsbFirmwareForceUpdateEnabled
|-
| 216 || [6.0.0+] SetAllKuinaDevicesToFirmwareUpdateMode
|-
| 221 || [[#UpdateControllerColor]]
|-
| 222 || [4.0.0+] ConnectUsbPadsAsync
|-
| 223 || [4.0.0+] DisconnectUsbPadsAsync
|-
| 224 || [5.0.0+] UpdateDesignInfo
|-
| 225 || [5.0.0+] GetUniquePadDriverState
|-
| 226 || [5.0.0+] GetSixAxisSensorDriverStates
|-
| 227 || [5.0.0+] GetRxPacketHistory
|-
| 228 || [6.0.0+] AcquireOperationEventHandle
|-
| 229 || [6.0.0+] ReadSerialFlash
|-
| 230 || [6.0.0+] WriteSerialFlash
|-
| 231 || [6.0.0+] GetOperationResult
|-
| 232 || [6.0.0+] EnableShipmentMode
|-
| 233 || [6.0.0+] ClearPairingInfo
|-
| 234 || [6.0.0+] GetUniquePadDeviceTypeSetInternal
|-
| 235 || [7.0.0+] EnableAnalogStickPower
|-
| 301 || [5.0.0+] GetAbstractedPadHandles
|-
| 302 || [5.0.0+] GetAbstractedPadState
|-
| 303 || [5.0.0+] GetAbstractedPadsState
|-
| 321 || [5.0.0+] SetAutoPilotVirtualPadState
|-
| 322 || [5.0.0+] UnsetAutoPilotVirtualPadState
|-
| 323 || [5.0.0+] UnsetAllAutoPilotVirtualPadState
|-
| 324 || [7.0.0+] AttachHdlsWorkBuffer
|-
| 325 || [7.0.0+] ReleaseHdlsWorkBuffer
|-
| 326 || [7.0.0+] DumpHdlsNpadAssignmentState
|-
| 327 || [7.0.0+] DumpHdlsStates
|-
| 328 || [7.0.0+] ApplyHdlsNpadAssignmentState
|-
| 329 || [7.0.0+] ApplyHdlsStateList
|-
| 330 || [7.0.0+] AttachHdlsVirtualDevice
|-
| 331 || [7.0.0+] DetachHdlsVirtualDevice
|-
| 332 || [7.0.0+] SetHdlsState
|-
| 350 || [5.0.0+] AddRegisteredDevice
|-
| 400 || [6.0.0+] DisableExternalMcuOnNxDevice
|-
| 401 || [6.0.0+] DisableRailDeviceFiltering
|-
| 500 || [8.0.0+] SetFactoryInt
|-
| 501 || [8.0.0+] IsFactoryBootEnabled
|}

== UpdateControllerColor ==
Takes two input u32s for the colors, an input u64 '''UniquePadId''', and no output.

Sends the spi-write subcommand to the specified controller, for writing the [[Joy-Con#Colors|color data]]. This writes to offset 0x6050 size 0x6, where the first 3-bytes are from the first u32 and the remaining 3-bytes are from the second u32.

= hid:sys =
This is "nn::hid::IHidSystemServer".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 31 || SendKeyboardLockKeyEvent
|-
| 101 || AcquireHomeButtonEventHandle
|-
| 111 || ActivateHomeButton
|-
| 121 || AcquireSleepButtonEventHandle
|-
| 131 || ActivateSleepButton
|-
| 141 || AcquireCaptureButtonEventHandle
|-
| 151 || ActivateCaptureButton
|-
| 161 || [7.0.0+] GetPlatformConfig
|-
| 210 || AcquireNfcDeviceUpdateEventHandle
|-
| 211 || GetNpadsWithNfc
|-
| 212 || AcquireNfcActivateEventHandle
|-
| 213 || ActivateNfc
|-
| 214 || [4.0.0+] GetXcdHandleForNpadWithNfc
|-
| 215 || [4.0.0+] IsNfcActivated
|-
| 230 || AcquireIrSensorEventHandle
|-
| 231 || ActivateIrSensor
|-
| 301 || ActivateNpadSystem
|-
| 303 || ApplyNpadSystemCommonPolicy
|-
| 304 || EnableAssigningSingleOnSlSrPress
|-
| 305 || DisableAssigningSingleOnSlSrPress
|-
| 306 || GetLastActiveNpad
|-
| 307 || GetNpadSystemExtStyle
|-
| 308 || [5.0.0+] ApplyNpadSystemCommonPolicyFull
|-
| 309 || [5.0.0+] GetNpadFullKeyGripColor
|-
| 310 || [6.0.0+] GetMaskedSupportedNpadStyleSet
|-
| 311 || SetNpadPlayerLedBlinkingDevice
|-
| 312 || [6.0.0+] SetSupportedNpadStyleSetAll
|-
| 321 || [3.0.0+] [[#GetUniquePadsFromNpad]]
|-
| 322 || GetIrSensorState
|-
| 323 || GetXcdHandleForNpadWithIrSensor
|-
| 500 || SetAppletResourceUserId
|-
| 501 || RegisterAppletResourceUserId
|-
| 502 || UnregisterAppletResourceUserId
|-
| 503 || EnableAppletToGetInput
|-
| 504 || SetAruidValidForVibration
|-
| 505 || EnableAppletToGetSixAxisSensor
|-
| 510 || [[#SetVibrationMasterVolume]]
|-
| 511 || GetVibrationMasterVolume
|-
| 512 || BeginPermitVibrationSession
|-
| 513 || EndPermitVibrationSession
|-
| 520 || EnableHandheldHids
|-
| 521 || DisableHandheldHids
|-
| 540 || AcquirePlayReportControllerUsageUpdateEvent
|-
| 541 || GetPlayReportControllerUsages
|-
| 542 || AcquirePlayReportRegisteredDeviceUpdateEvent
|-
| 543 || GetRegisteredDevicesOld ([1.0.0-4.1.0] GetRegisteredDevices)
|-
| 544 || AcquireConnectionTriggerTimeoutEvent
|-
| 545 || SendConnectionTrigger
|-
| 546 || AcquireDeviceRegisteredEventForControllerSupport
|-
| 547 || GetAllowedBluetoothLinksCount
|-
| 548 || [5.0.0+] GetRegisteredDevices
|-
| 549 || [6.0.0+] GetConnectableRegisteredDevices
|-
| 700 || ActivateUniquePad
|-
| 702 || AcquireUniquePadConnectionEventHandle
|-
| 703 || [[#GetUniquePadIds]]
|-
| 751 || AcquireJoyDetachOnBluetoothOffEventHandle
|-
| 800 || ListSixAxisSensorHandles
|-
| 801 || IsSixAxisSensorUserCalibrationSupported
|-
| 802 || ResetSixAxisSensorCalibrationValues
|-
| 803 || StartSixAxisSensorUserCalibration
|-
| 804 || CancelSixAxisSensorUserCalibration
|-
| 805 || GetUniquePadBluetoothAddress
|-
| 806 || DisconnectUniquePad
|-
| 807 || [5.0.0+] GetUniquePadType
|-
| 808 || [5.0.0+] GetUniquePadInterface
|-
| 809 || [5.0.0+] GetUniquePadSerialNumber
|-
| 810 || [5.0.0+] GetUniquePadControllerNumber
|-
| 811 || [5.0.0+] GetSixAxisSensorUserCalibrationStage
|-
| 812 || [8.0.0+] GetConsoleUniqueSixAxisSensorHandle
|-
| 821 || StartAnalogStickManualCalibration
|-
| 822 || RetryCurrentAnalogStickManualCalibrationStage
|-
| 823 || CancelAnalogStickManualCalibration
|-
| 824 || ResetAnalogStickManualCalibration
|-
| 825 || [5.0.0+] GetAnalogStickState
|-
| 826 || [5.0.0+] GetAnalogStickManualCalibrationStage
|-
| 827 || [5.0.0+] IsAnalogStickButtonPressed
|-
| 828 || [5.0.0+] IsAnalogStickInReleasePosition
|-
| 829 || [5.0.0+] IsAnalogStickInCircumference
|-
| 830 || [7.0.0+] [[#SetNotificationLedPattern]]
|-
| 850 || IsUsbFullKeyControllerEnabled
|-
| 851 || EnableUsbFullKeyController
|-
| 852 || IsUsbConnected
|-
| 870 || [5.1.0+] IsHandheldButtonPressedOnConsoleMode
|-
| 900 || ActivateInputDetector
|-
| 901 || [[#NotifyInputDetector]]
|-
| 1000 || InitializeFirmwareUpdate
|-
| 1001 || GetFirmwareVersion
|-
| 1002 || GetAvailableFirmwareVersion
|-
| 1003 || IsFirmwareUpdateAvailable
|-
| 1004 || CheckFirmwareUpdateRequired
|-
| 1005 || StartFirmwareUpdate
|-
| 1006 || AbortFirmwareUpdate
|-
| 1007 || GetFirmwareUpdateState
|-
| 1008 || [4.0.0+] ActivateAudioControl
|-
| 1009 || [4.0.0+] AcquireAudioControlEventHandle
|-
| 1010 || [4.0.0+] GetAudioControlStates
|-
| 1011 || [4.0.0+] DeactivateAudioControl
|-
| 1050 || [5.0.0+] IsSixAxisSensorAccurateUserCalibrationSupported
|-
| 1051 || [5.0.0+] StartSixAxisSensorAccurateUserCalibration
|-
| 1052 || [5.0.0+] CancelSixAxisSensorAccurateUserCalibration
|-
| 1053 || [5.0.0+] GetSixAxisSensorAccurateUserCalibrationState
|-
| 1100 || [5.0.0+] GetHidbusSystemServiceObject
|-
| 1120 || [6.0.0+] SetFirmwareHotfixUpdateSkipEnabled
|-
| 1130 || [6.0.0+] InitializeUsbFirmwareUpdate
|-
| 1131 || [6.0.0+] FinalizeUsbFirmwareUpdate
|-
| 1132 || [6.0.0+] CheckUsbFirmwareUpdateRequired
|-
| 1133 || [6.0.0+] StartUsbFirmwareUpdate
|-
| 1134 || [6.0.0+] GetUsbFirmwareUpdateState
|-
| 1150 || [8.0.0+] SetTouchScreenMagnification
|}

== GetUniquePadsFromNpad ==
Takes an input u32 [[#NpadIdType]], a type-0xA output buffer, and returns an output u64 for total output entries.

The output buffer contains an array of u64 '''UniquePadId'''.

== SetVibrationMasterVolume ==
Takes an input 32bit float.

== GetUniquePadIds ==
Takes a type-0xA output buffer, and returns an output u64 for total output entries.

The output buffer contains an array of u64 '''UniquePadId'''.

== NotifyInputDetector ==
Takes an input u32 bitmask InputSourceId, no output.

This is the only hid:sys command used by USB-sysmodule (with value 0x40).

== SetNotificationLedPattern ==
Takes an input [[#NotificationLedPattern]] and an u64 '''UniquePadId''', no output.

The specified controller must have a HOME button.

This sends subcommand 0x38 to the specified controller, for setting the pattern for the HOME button notification LED. The input structure is converted to the format used by this [https://github.com/dekuNukem/Nintendo_Switch_Reverse_Engineering/blob/master/bluetooth_hid_subcommands_notes.md#subcommand-0x38-set-home-light subcommand].

== NotificationLedPattern ==
{| class="wikitable" border="1"
|-
! Offset || Size || Subcommand argdata bytepos || Subcommand argdata nibble || Description
|-
| 0x0 || 0x1 || 0x0 || Low || Mini Cycle Base Duration. Value 0x1-0xF: 12.5ms - 187.5ms. Value 0x0 = 0ms/OFF.
|-
| 0x1 || 0x1 || 0x0 || High || Number of Mini Cycles + 1. Value 0x0-0xF: 1 - 16 mini cycles.
|-
| 0x2 || 0x1 || 0x1 || Low || Number of Full Cycles. Value 0x1-0xF: 1 - 15 full cycles. Value 0x0 is repeat forever, but if Mini Cycle Base Duration is set to 0x0, it does the 1st Mini Cycle with a 12.5ms base duration and then the LED stays on with LED Start Intensity.
|-
| 0x3 || 0x1 || 0x1 || High || LED Start Intensity. Value 0x0-0xF: 0% - 100%. (In HW, 1 - 241 duty)
|-
| 0x4 || 0x1 || 0x2 || High || Mini Cycle 1 LED Intensity. Value 0x0-0xF: 0% - 100%. (In HW, 1 - 241 duty)
|-
| 0x5 || 0x1 || 0x3 || High || Fading Transition Steps to Mini Cycle 1 (Uses PWM). Value 0x0: Instant. Each step duration is based on Mini Cycle Step Duration Multiplier.
|-
| 0x6 || 0x1 || 0x3 || Low || Final Step Duration Multiplier of Mini Cycle 1. Value is a Multiplier of Mini Cycle Base Duration. Value 0x0: 12.5ms, 0x1 - xF: 1x - 15x.
|-
| 0x7 || 0x1 || || || Unused
|-
| 0x8 || 0x1 || 0x2 || Low || Mini Cycle 2 LED Intensity.
|-
| 0x9 || 0x1 || 0x4 || High || Fading Transition Steps to Mini Cycle 2 (see above).
|-
| 0xA || 0x1 || 0x4 || Low || Final Step Duration Multiplier of Mini Cycle 2 (see above).
|-
| 0xB || 0x1 || || || Unused
|-
| 0xC || 0x1 || 0x5 || High || Mini Cycle 3 LED Intensity.
|-
| 0xD || 0x1 || 0x6 || High || Fading Transition Steps to Mini Cycle 3 (see above).
|-
| 0xE || 0x1 || 0x6 || Low || Final Step Duration Multiplier of Mini Cycle 3 (see above).
|-
| 0xF || 0x1 || || || Unused
|-
| 0x10 || 0x1 || 0x5 || Low || Mini Cycle 4 LED Intensity.
|-
| 0x11 || 0x1 || 0x7 || High || Fading Transition Duration to Mini Cycle 4 (see above).
|-
| 0x12 || 0x1 || 0x7 || Low || Final Step Duration Multiplier of Mini Cycle 4 (see above).
|-
| 0x13 || 0x1 || || || Unused
|-
| 0x14 || 0x1 || 0x8 || High || Mini Cycle 5 LED Intensity.
|-
| 0x15 || 0x1 || 0x9 || High || Fading Transition Steps to Mini Cycle 5 (see above).
|-
| 0x16 || 0x1 || 0x9 || Low || Final Step Duration Multiplier of Mini Cycle 5 (see above).
|-
| 0x17 || 0x1 || || || Unused
|-
| 0x18 || 0x1 || 0x8 || Low || Mini Cycle 6 LED Intensity.
|-
| 0x19 || 0x1 || 0xA || High || Fading Transition Steps to Mini Cycle 6 (see above).
|-
| 0x1A || 0x1 || 0xA || Low || Final Step Duration Multiplier of Mini Cycle 6 (see above).
|-
| 0x1B || 0x1 || || || Unused
|-
| 0x1C || 0x1 || 0xB || High || Mini Cycle 7 LED Intensity.
|-
| 0x1D || 0x1 || 0xC || High || Fading Transition Steps to Mini Cycle 7 (see above).
|-
| 0x1E || 0x1 || 0xC || Low || Final Step Duration Multiplier of Mini Cycle 7 (see above).
|-
| 0x1F || 0x1 || || || Unused
|-
| 0x20 || 0x1 || 0xB || Low || Mini Cycle 8 LED Intensity.
|-
| 0x21 || 0x1 || 0xD || Low || Fading Transition Steps to Mini Cycle 8 (see above).
|-
| 0x22 || 0x1 || 0xD || High || Final Step Duration Multiplier of Mini Cycle 8 (see above).
|-
| 0x23 || 0x1 || || || Unused
|-
| 0x24 || 0x1 || 0xE || High || Mini Cycle 9 LED Intensity.
|-
| 0x25 || 0x1 || 0xF || High || Fading Transition Steps to Mini Cycle 9 (see above).
|-
| 0x26 || 0x1 || 0xF || Low || Final Step Duration Multiplier of Mini Cycle 9 (see above).
|-
| 0x27 || 0x1 || || || Unused
|-
| 0x28 || 0x1 || 0xE || Low || Mini Cycle 10 LED Intensity.
|-
| 0x29 || 0x1 || 0x10 || High || Fading Transition Steps to Mini Cycle 10 (see above).
|-
| 0x2A || 0x1 || 0x10 || Low || Final Step Duration Multiplier of Mini Cycle 10 (see above).
|-
| 0x2B || 0x1 || || || Unused
|-
| 0x2C || 0x1 || 0x11 || High || Mini Cycle 11 LED Intensity.
|-
| 0x2D || 0x1 || 0x12 || High || Fading Transition Steps to Mini Cycle 11 (see above).
|-
| 0x2E || 0x1 || 0x12 || Low || Final Step Duration Multiplier of Mini Cycle 11 (see above).
|-
| 0x2F || 0x1 || || || Unused
|-
| 0x30 || 0x1 || 0x11 || Low || Mini Cycle 12 LED Intensity.
|-
| 0x31 || 0x1 || 0x13 || High || Fading Transition Steps to Mini Cycle 12 (see above).
|-
| 0x32 || 0x1 || 0x13 || Low || Final Step Duration Multiplier of Mini Cycle 12 (see above).
|-
| 0x33 || 0x1 || || || Unused
|-
| 0x34 || 0x1 || 0x14 || High || Mini Cycle 13 LED Intensity.
|-
| 0x35 || 0x1 || 0x15 || High || Fading Transition Steps to Mini Cycle 13 (see above).
|-
| 0x36 || 0x1 || 0x15 || Low || Final Step Duration Multiplier of Mini Cycle 13 (see above).
|-
| 0x37 || 0x1 || || || Unused
|-
| 0x38 || 0x1 || 0x14 || Low || Mini Cycle 14 LED Intensity.
|-
| 0x39 || 0x1 || 0x16 || High || Fading Transition Steps to Mini Cycle 14 (see above).
|-
| 0x3A || 0x1 || 0x16 || Low || Final Step Duration Multiplier of Mini Cycle 14 (see above).
|-
| 0x3B || 0x1 || || || Unused
|-
| 0x3C || 0x1 || 0x17 || High || Mini Cycle 15 LED Intensity.
|-
| 0x3D || 0x1 || 0x18 || High || Fading Transition Steps to Mini Cycle 15 (see above).
|-
| 0x3E || 0x1 || 0x18 || Low || Final Step Duration Multiplier of Mini Cycle 15 (see above).
|-
| 0x3F || 0x1 || || || Unused
|-
| 0x40 || 0x1 || 0x17 || Low || Mini Cycle 16 LED Intensity.
|-
| 0x41 || 0x1 || 0x19 || High || Fading Transition Steps to Mini Cycle 16 (see above). (Unused in older Joy-Con / Pro-Con FW. Unknown for new.)
|-
| 0x42 || 0x1 || 0x19 || Low || Final Step Duration Multiplier of Mini Cycle 16 (see above). (Unused in older Joy-Con / Pro-Con FW. Unknown for new.)
|-
| 0x43 || 0x1 || || || Unused
|-
| 0x44 || 0x1 || 0x1A || High || Unknown (Unused in older Joy-Con / Pro-Con FW. Unknown for new.)
|-
| 0x45 || 0x1 || 0x1A || Low || Unknown (Unused in older Joy-Con / Pro-Con FW. Unknown for new.)
|-
| 0x46 || 0x1 || || || Padding
|-
| 0x47 || 0x1 || || || Padding
|-
|}

This is "nn::hid::system::NotificationLedPattern".

This is a 0x48-byte struct.

The above descriptions in the table are based on the info from [https://github.com/dekuNukem/Nintendo_Switch_Reverse_Engineering/blob/master/bluetooth_hid_subcommands_notes.md here].

argdata in the subcommand is initialized as follows: <code>((u8*)cmd_argdata)[pos] = u8_in[pos2] | u8_in[pos3]<<4;</code> Hence, 4bits from pairs of 2-bytes of the input struct are combined to write to the subcommand. Only the low 4bits of each used byte in the struct is used. This is written to stack initially, then copied to the actual cmd_argdata (the data immediately following the subcommandID byte). There's a total of 0x1B-bytes of cmd_argdata initialized from this.

The layout of cmd_argdata is as follows:
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x1B || See above.
|-
| 0x1B || 0xB || Cleared to zero.
|-
| 0x26 || 0x5 || Unused
|-
| 0x2B || 0x8 || Set to an input value, which is hard-coded 0.
|-
| 0x33 || 0x2 || Set to value 0.
|-
| 0x35 || 0x1 || Set to value 1.
|}

= hid:tmp =
This is "nn::hid::IHidTemporaryServer".

This service no longer exists in [8.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetConsoleSixAxisSensorCalibrationValues
|}

= irs =
This is "nn::irsensor::IIrSensorServer".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 302 || [[#ActivateIrsensor]]
|-
| 303 || [[#DeactivateIrsensor]]
|-
| 304 || [[#GetIrsensorSharedMemoryHandle]]
|-
| 305 || [[#StopImageProcessor]]
|-
| 306 || [[#RunMomentProcessor]]
|-
| 307 || [[#RunClusteringProcessor]]
|-
| 308 || [[#RunImageTransferProcessor]]
|-
| 309 || [[#GetImageTransferProcessorState]]
|-
| 310 || [[#RunTeraPluginProcessor]]
|-
| 311 || [[#GetNpadIrCameraHandle]]
|-
| 312 || [[#RunPointingProcessor]]
|-
| 313 || [[#SuspendImageProcessor]]
|-
| 314 || [3.0.0+] [[#CheckFirmwareVersion]]
|-
| 315 || [5.0.0+] SetFunctionLevel
|-
| 316 || [5.0.0+] RunImageTransferExProcessor
|-
| 317 || [5.0.0+] RunIrLedProcessor
|-
| 318 || [5.0.0+] StopImageProcessorAsync
|-
| 319 || [5.0.0+] ActivateIrsensorWithFunctionLevel
|}

== ActivateIrsensor ==
Takes a PID-descriptor and an [[AM_services|AppletResourceUserId]]. No output.

== DeactivateIrsensor ==
Takes a PID-descriptor and an [[AM_services|AppletResourceUserId]]. No output.

== GetIrsensorSharedMemoryHandle ==
Takes a PID-descriptor and an [[AM_services|AppletResourceUserId]]. Returns a SharedMemory handle.

The SharedMemory is mapped with permissions=read-only and size=0x8000.

== StopImageProcessor ==
Takes a PID-descriptor, an [[#IrCameraHandle]], and an [[AM_services|AppletResourceUserId]]. No output.

== RunMomentProcessor ==
Takes a PID-descriptor, an [[#IrCameraHandle]], an [[AM_services|AppletResourceUserId]], and a [[#PackedMomentProcessorConfig]]. No output.

== RunClusteringProcessor ==
Takes a PID-descriptor, an [[#IrCameraHandle]], an [[AM_services|AppletResourceUserId]], and a [[#PackedClusteringProcessorConfig]]. No output.

== RunImageTransferProcessor ==
Takes a PID-descriptor, an [[#IrCameraHandle]], an [[AM_services|AppletResourceUserId]], a [[#PackedImageTransferProcessorConfig]], an u64 for the TransferMemory_size, and a TransferMemory handle. No output.

Official sw creates the TransferMemory with an user-specified buffer and permissions=0.

== GetImageTransferProcessorState ==
Takes a PID-descriptor, a type-0x6 output buffer, an [[#IrCameraHandle]], and an [[AM_services|AppletResourceUserId]]. Returns an [[#ImageTransferProcessorState]]. No output.

== RunTeraPluginProcessor==
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedTeraPluginProcessorConfig]] (immediately after the previous word), and an [[AM_services|AppletResourceUserId]]. No output.

== GetNpadIrCameraHandle ==
Takes an input u32. Returns an output [[#IrCameraHandle]].

== RunPointingProcessor ==
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedDpdProcessorConfig]] (immediately after the previous word), and an [[AM_services|AppletResourceUserId]]. No output.

== SuspendImageProcessor ==
Takes a PID-descriptor, an [[#IrCameraHandle]], and an [[AM_services|AppletResourceUserId]]. No output.

== CheckFirmwareVersion ==
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedMcuVersion]], and an [[AM_services|AppletResourceUserId]]. No output.

== IrCameraHandle ==
This is an u32.

== PackedMomentProcessorConfig ==
This is a 0x20-byte struct. This is converted from another structure by the official user-process.

{| class="wikitable" border="1"
|-
! Offset || Size || Description || DefaultConfig
|-
| 0x0 || 0x8 || ? || 0x493E0
|-
| 0x8 || 0x1 || ? || 0x0
|-
| 0x9 || 0x1 || ? || 0x8
|-
| 0xA || 0x1 || ? || 0x0
|-
| 0xB || 0x5 || Padding ||
|-
| 0x10 || 0x8 || u16, u32, u16 || {Not written}, 0x1400000, 0xF0
|-
| 0x18 || 0x4 || Hard-coded to 0xA0003. ||
|-
| 0x1C || 0x1 || ? || 0x1
|-
| 0x1D || 0x1 || ? || 0x50
|-
| 0x1E || 0x2 || Padding ||
|}

== PackedClusteringProcessorConfig ==
This is a 0x28-byte struct.

== PackedImageTransferProcessorConfig ==
This is a 0x18-byte struct. This is converted from another structure by the official user-process. The conversion is the same as PackedMomentProcessorConfig, except the code using out +0x1C/+0x1D was removed, and the constant is now located at out+0x10. The code which wrote to out u64 +0x10 from in+0x24 was replaced with code which writes an u8 to out+0x14.

== ImageTransferProcessorState ==
This is a 0x10-byte struct.

== PackedTeraPluginProcessorConfig ==
This is an u64.

== PackedDpdProcessorConfig ==
This is a 0x10-byte struct.

== PackedMcuVersion ==
This is an u32.

= irs:sys =
This is "nn::irsensor::IIrSensorSystemServer".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 500 || SetAppletResourceUserId
|-
| 501 || RegisterAppletResourceUserId
|-
| 502 || UnregisterAppletResourceUserId
|-
| 503 || EnableAppletToGetInput
|}

= ahid:cd =
This is "nn::ahid::IServerSession".

Used for USB HID devices.

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || || Takes an input s32, no output.
|-
| 1 || || Takes an input s32, no output.
|-
| 2 || || Takes an input u32, returns an [[#ICtrlSession]].
|-
| 3 || || Takes an input u32, returns an [[#IReadSession]].
|-
| 4 || || Takes an input u32, returns an [[#IWriteSession]].
|}

== ICtrlSession ==
This is "nn::ahid::ICtrlSession".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || ||
|-
| 1 || ||
|-
| 2 || ||
|-
| 3 || ||
|-
| 4 || ||
|-
| 5 || ||
|-
| 6 || ||
|-
| 7 || ||
|-
| 8 || ||
|-
| 9 || ||
|-
| 10 || ||
|-
| 11 || ||
|}

All of these use USB [[USB_services|CtrlXfer]], except for cmd10-11 which are event(?) related, and cmd1 which copies 0x4000-bytes from state to output.

== IReadSession ==
This is "nn::ahid::IReadSession".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || ||
|}

Cmd0 uses [[USB_services|PostBufferAsync]] etc with the INPUT endpoint. The size must be <=0x1000. The actual transfer size is returned in an output u64. The data is copied from the tmpbuf to the output buffer using the actual-transfer-size.

== IWriteSession ==
This is "nn::ahid::IWriteSession".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || || This is the inverse of [[#IReadSession]] cmd0. Uses the OUTPUT endpoint with an input buffer.
|}

= ahid:hdr =
This is "nn::ahid::hdr::ISession".

Used internally for USB HID devices.

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 ||
|-
| 1 ||
|-
| 2 ||
|-
| 3 ||
|-
| 4 ||
|-
| 5 || [6.0.0+]
|}

= xcd:sys =
This is "nn::xcd::detail::ISystemServer".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetDataFormat
|-
| 1 || SetDataFormat
|-
| 2 || GetMcuState
|-
| 3 || SetMcuState
|-
| 4 || GetMcuVersionForNfc
|-
| 5 || CheckNfcDevicePower
|-
| 10 || SetNfcEvent
|-
| 11 || GetNfcInfo
|-
| 12 || StartNfcDiscovery
|-
| 13 || StopNfcDiscovery
|-
| 14 || StartNtagRead
|-
| 15 || StartNtagWrite
|-
| 16 || SendNfcRawData
|-
| 17 || RegisterMifareKey
|-
| 18 || ClearMifareKey
|-
| 19 || StartMifareRead
|-
| 20 || StartMifareWrite
|-
| 101 || GetAwakeTriggerReasonForLeftRail
|-
| 102 || GetAwakeTriggerReasonForRightRail
|}

[6.0.0+]: The buffer type used by GetNfcInfo is now 0x32 instead of 0x1A.

= hidbus =
This is "nn::hidbus::IHidbusServer".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 1 || GetBusHandle
|-
| 2 || IsExternalDeviceConnected
|-
| 3 || Initialize
|-
| 4 || Finalize
|-
| 5 || EnableExternalDevice
|-
| 6 || GetExternalDeviceId
|-
| 7 || SendCommandAsync
|-
| 8 || GetSendCommandAsynceResult
|-
| 9 || SetEventForSendCommandAsycResult
|-
| 10 || GetSharedMemoryHandle
|-
| 11 || EnableJoyPollingReceiveMode
|-
| 12 || DisableJoyPollingReceiveMode
|-
| [5.0.0-6.2.0] 13 || GetPollingData
|-
| 14 || [6.0.0+] SetStatusManagerType
|}

= RomFS =
The hid-sysmodule RomFS contains:
ftmFwUpdate
├── NTD_4CD_1801.fts256
├── NTD_4CD_2602.fts256
└── NTD_4CD_3801.fts256

These are firmware files for the touchscreen controller.

= Firmware update =
Starting with [[3.0.0]] HID-sysmodule now contains strings for data stored in title [[Title_list|0100000000000822]].

[[Category:Services]]

HID services

2019-04-27T13:43:33Z

Ctcaer: Correct some copy paste typos I did in dekunukem repo and also normalize the description for easier comprehension.

See [[HID_Shared_Memory|here]] for the HID shared-memory.

= hid =
This is "nn::hid::IHidServer".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || [[#CreateAppletResource]]
|-
| 1 || ActivateDebugPad
|-
| 11 || ActivateTouchScreen
|-
| 21 || ActivateMouse
|-
| 31 || ActivateKeyboard
|-
| 32 || [6.0.0+] SendKeyboardLockKeyEvent
|-
| 40 || AcquireXpadIdEventHandle
|-
| 41 || ReleaseXpadIdEventHandle
|-
| 51 || ActivateXpad
|-
| 55 || GetXpadIds
|-
| 56 || ActivateJoyXpad
|-
| 58 || GetJoyXpadLifoHandle
|-
| 59 || GetJoyXpadIds
|-
| 60 || ActivateSixAxisSensor
|-
| 61 || DeactivateSixAxisSensor
|-
| 62 || GetSixAxisSensorLifoHandle
|-
| 63 || ActivateJoySixAxisSensor
|-
| 64 || DeactivateJoySixAxisSensor
|-
| 65 || GetJoySixAxisSensorLifoHandle
|-
| 66 || StartSixAxisSensor
|-
| 67 || StopSixAxisSensor
|-
| 68 || IsSixAxisSensorFusionEnabled
|-
| 69 || EnableSixAxisSensorFusion
|-
| 70 || SetSixAxisSensorFusionParameters
|-
| 71 || GetSixAxisSensorFusionParameters
|-
| 72 || ResetSixAxisSensorFusionParameters
|-
| 73 || SetAccelerometerParameters
|-
| 74 || GetAccelerometerParameters
|-
| 75 || ResetAccelerometerParameters
|-
| 76 || SetAccelerometerPlayMode
|-
| 77 || GetAccelerometerPlayMode
|-
| 78 || ResetAccelerometerPlayMode
|-
| 79 || SetGyroscopeZeroDriftMode
|-
| 80 || GetGyroscopeZeroDriftMode
|-
| 81 || ResetGyroscopeZeroDriftMode
|-
| 82 || IsSixAxisSensorAtRest
|-
| 83 || [6.0.0+] IsFirmwareUpdateAvailableForSixAxisSensor
|-
| 91 || ActivateGesture
|-
| 100 || [[#SetSupportedNpadStyleSet]]
|-
| 101 || [[#GetSupportedNpadStyleSet]]
|-
| 102 || [[#SetSupportedNpadIdType]]
|-
| 103 || ActivateNpad
|-
| 104 || DeactivateNpad
|-
| 106 || [[#AcquireNpadStyleSetUpdateEventHandle]]
|-
| 107 || DisconnectNpad
|-
| 108 || GetPlayerLedPattern
|-
| 109 || [5.0.0+] ActivateNpadWithRevision
|-
| 120 || SetNpadJoyHoldType
|-
| 121 || GetNpadJoyHoldType
|-
| 122 || [[#SetNpadJoyAssignmentModeSingleByDefault]]
|-
| 123 || [[#SetNpadJoyAssignmentModeSingle]]
|-
| 124 || [[#SetNpadJoyAssignmentModeDual]]
|-
| 125 || [[#MergeSingleJoyAsDualJoy]]
|-
| 126 || StartLrAssignmentMode
|-
| 127 || StopLrAssignmentMode
|-
| 128 || SetNpadHandheldActivationMode
|-
| 129 || [[#GetNpadHandheldActivationMode]]
|-
| 130 || SwapNpadAssignment
|-
| 131 || IsUnintendedHomeButtonInputProtectionEnabled
|-
| 132 || EnableUnintendedHomeButtonInputProtection
|-
| 133 || [5.0.0+] SetNpadJoyAssignmentModeSingleWithDestination
|-
| 134 || [6.1.0+] SetNpadAnalogStickUseCenterClamp
|-
| 135 || [8.0.0+] SetNpadCaptureButtonAssignment
|-
| 136 || [8.0.0+] ClearNpadCaptureButtonAssignment
|-
| 200 || [[#GetVibrationDeviceInfo]]
|-
| 201 || [[#SendVibrationValue]]
|-
| 202 || [[#GetActualVibrationValue]]
|-
| 203 || [[#CreateActiveVibrationDeviceList]]
|-
| 204 || [[#PermitVibration]]
|-
| 205 || [[#IsVibrationPermitted]]
|-
| 206 || [[#SendVibrationValues]]
|-
| 207 || [4.0.0+] SendVibrationGcErmCommand
|-
| 208 || [4.0.0+] GetActualVibrationGcErmCommand
|-
| 209 || [4.0.0+] BeginPermitVibrationSession
|-
| 210 || [4.0.0+] EndPermitVibrationSession
|-
| 211 || [7.0.0+] [[#IsVibrationDeviceMounted]]
|-
| 300 || ActivateConsoleSixAxisSensor
|-
| 301 || StartConsoleSixAxisSensor
|-
| 302 || StopConsoleSixAxisSensor
|-
| 303 || [5.0.0+] [[#ActivateSevenSixAxisSensor]]
|-
| 304 || [5.0.0+] [[#StartSevenSixAxisSensor]]
|-
| 305 || [5.0.0+] [[#StopSevenSixAxisSensor]]
|-
| 306 || [5.0.0+] [[#InitializeSevenSixAxisSensor]]
|-
| 307 || [5.0.0+] [[#FinalizeSevenSixAxisSensor]]
|-
| 308 || [5.0.0+] SetSevenSixAxisSensorFusionStrength
|-
| 309 || [5.0.0+] GetSevenSixAxisSensorFusionStrength
|-
| 310 || [6.0.0+] [[#ResetSevenSixAxisSensorTimestamp]]
|-
| 400 || IsUsbFullKeyControllerEnabled
|-
| 401 || EnableUsbFullKeyController
|-
| 402 || IsUsbFullKeyControllerConnected
|-
| 403 || [4.0.0+] HasBattery
|-
| 404 || [4.0.0+] HasLeftRightBattery
|-
| 405 || [4.0.0+] GetNpadInterfaceType
|-
| 406 || [4.0.0+] GetNpadLeftRightInterfaceType
|-
| 500 || [5.0.0+] GetPalmaConnectionHandle
|-
| 501 || [5.0.0+] InitializePalma
|-
| 502 || [5.0.0+] AcquirePalmaOperationCompleteEvent
|-
| 503 || [5.0.0+] GetPalmaOperationInfo
|-
| 504 || [5.0.0+] PlayPalmaActivity
|-
| 505 || [5.0.0+] SetPalmaFrModeType
|-
| 506 || [5.0.0+] ReadPalmaStep
|-
| 507 || [5.0.0+] EnablePalmaStep
|-
| 508 || [5.0.0+] ResetPalmaStep
|-
| 509 || [5.0.0+] ReadPalmaApplicationSection
|-
| 510 || [5.0.0+] WritePalmaApplicationSection
|-
| 511 || [5.0.0+] ReadPalmaUniqueCode
|-
| 512 || [5.0.0+] SetPalmaUniqueCodeInvalid
|-
| 513 || [5.0.0+] WritePalmaActivityEntry
|-
| 514 || [5.0.0+] WritePalmaRgbLedPatternEntry
|-
| 515 || [5.0.0+] WritePalmaWaveEntry
|-
| 516 || [5.0.0+] SetPalmaDataBaseIdentificationVersion
|-
| 517 || [5.0.0+] GetPalmaDataBaseIdentificationVersion
|-
| 518 || [5.0.0+] SuspendPalmaFeature
|-
| 519 || [5.1.0+] GetPalmaOperationResult
|-
| 520 || [5.1.0+] ReadPalmaPlayLog
|-
| 521 || [5.1.0+] ResetPalmaPlayLog
|-
| 522 || [5.1.0+] SetIsPalmaAllConnectable
|-
| 523 || [5.1.0+] SetIsPalmaPairedConnectable
|-
| 524 || [5.1.0+] PairPalma
|-
| 525 || [5.1.0+] SetPalmaBoostMode
|-
| 526 || [7.0.0+] CancelWritePalmaWaveEntry
|-
| 527 || [8.0.0+] EnablePalmaBoostMode
|-
| 528 || [8.0.0+] GetPalmaBluetoothAddress
|-
| 529 || [8.0.0+] SetDisallowedPalmaConnection
|-
| 1000 || SetNpadCommunicationMode
|-
| 1001 || GetNpadCommunicationMode
|}

== CreateAppletResource ==
Takes a PID and an u64 [[AM_services|AppletResourceUserId]]. Returns an [[#IAppletResource]].

== SetSupportedNpadStyleSet ==
Takes an u32 [[#NpadStyleTag]].

== GetSupportedNpadStyleSet ==
Returns an u32 [[#NpadStyleTag]].

== SetSupportedNpadIdType ==
Takes a PID-descriptor, a type-0x9 input buffer, and an [[AM_services|AppletResourceUserId]]. No output.

The input buffer contains an array of u32 [[#NpadIdType]].

== AcquireNpadStyleSetUpdateEventHandle ==
Takes an input u32, an u64 [[AM_services|AppletResourceUserId]], and an u64. Returns an output event handle, autoclear for this is user-specified.

The value for the last u64 doesn't seem to matter (?): official sw sets this to the address of the structure used for storing the event which is initialized after using this cmd.

== SetNpadJoyAssignmentModeSingleByDefault ==
Takes a PID-descriptor, an u32, and an [[AM_services|AppletResourceUserId]]. No output.

== SetNpadJoyAssignmentModeSingle ==
Takes a PID-descriptor, an u32, [[AM_services|AppletResourceUserId]], and s64 '''NpadJoyDeviceType'''. No output.

== SetNpadJoyAssignmentModeDual ==
Takes a PID-descriptor, an u32, and an [[AM_services|AppletResourceUserId]]. No output.

== MergeSingleJoyAsDualJoy ==
Takes a PID-descriptor, two u32s, and an [[AM_services|AppletResourceUserId]]. No output.

== GetNpadHandheldActivationMode ==
Takes a PID and an u64 [[AM_services|AppletResourceUserId]]. Returns an output u64. Official user-processes panic if the output u64 is not 0-2.

== GetVibrationDeviceInfo ==
Takes a [[#VibrationDeviceHandle]]. Returns an output [[#VibrationDeviceInfo]].

== SendVibrationValue ==
Takes a PID-descriptor, a [[#VibrationDeviceHandle]], a [[#VibrationValue]] immediately after that, and an u64 [[AM_services|AppletResourceUserId]]. No output.

== GetActualVibrationValue ==
Takes a PID-descriptor, a [[#VibrationDeviceHandle]], and an u64 [[AM_services|AppletResourceUserId]]. Returns an output [[#VibrationValue]].

== CreateActiveVibrationDeviceList ==
No input. Returns an [[#IActiveVibrationDeviceList]].

== PermitVibration ==
Takes an input u8 bool. No output.

This affects the config displayed by System Settings.

== IsVibrationPermitted ==
No input. Returns an output u8 bool.

== SendVibrationValues ==
Takes an u64 [[AM_services|AppletResourceUserId]], and two type-0x9 input buffers containing an array of: [[#VibrationDeviceHandle]] for first buffer, and [[#VibrationValue]] for the second buffer.

Official sw uses the same entry-count for each array.

== IsVibrationDeviceMounted ==
Takes a total of 0x10-bytes of input and a PID, returns an output u8 bool.

== ActivateSevenSixAxisSensor ==
Takes a PID and an u64 [[AM_services|AppletResourceUserId]], no output.

== StartSevenSixAxisSensor ==
Takes a PID and an u64 [[AM_services|AppletResourceUserId]], no output.

== StopSevenSixAxisSensor ==
Takes a PID and an u64 [[AM_services|AppletResourceUserId]], no output.

== InitializeSevenSixAxisSensor ==
Takes a PID, an u64 [[AM_services|AppletResourceUserId]], two u64s for the size of each TransferMemory, and two TransferMemory handles. No output.

The size of the first TransferMemory is 0x1000 with MemoryPermission=read-only, while the second one has size 0x7F000 with MemoryPermission=none.

== FinalizeSevenSixAxisSensor ==
Takes a PID and an u64 [[AM_services|AppletResourceUserId]], no output.

== ResetSevenSixAxisSensorTimestamp ==
Takes a PID and an u64 [[AM_services|AppletResourceUserId]], no output.

== VibrationDeviceHandle ==
This is an u32.

== VibrationDeviceInfo ==
This is a 0x8-byte struct.

== VibrationValue ==
This is a 0x10-byte struct, which contains 4 float values.

== IAppletResource ==

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

=== GetSharedMemoryHandle ===
No input. Returned a [[HID_Shared_Memory|sharedmem]] handle.

== IActiveVibrationDeviceList ==
This is "nn::hid::IActiveVibrationDeviceList".

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

=== ActivateVibrationDevice ===
Takes an input [[#VibrationDeviceHandle]]. No output.

== NpadStyleTag ==
This is a bitfield describing which controller styles are supported.

{| class="wikitable" border="1"
! Bits
! Description
! Notes
|-
| 0
| NpadFullKey
| Pro Controller.
|-
| 1
| NpadHandheld
| Joy-Con controller in handheld mode.
|-
| 2
| NpadJoyDual
| Joy-Con controller in dual mode.
|-
| 3
| NpadJoyLeft
| Joy-Con left controller in single mode.
|-
| 4
| NpadJoyRight
| Joy-Con right controller in single mode.
|-
| 5
| NpadGc
| GameCube controller.
|-
| 6
| NpadPalma
| Poké Ball Plus controller.
|-
| 7
| NpadLark
| NES controller.
|-
| 8
| NpadHandheldLark
| NES controller in handheld mode.
|-
| 9-28
| Reserved
|
|-
| 29
| NpadSystemExt
|
|-
| 30
| NpadSystem
|
|-
| 31
| Reserved
|
|}

== NpadIdType ==
This is an u32. This is the controller index used in [[HID_Shared_Memory#Controllers|sharedmem]]. 0x20 is handheld.

= hid:dbg =
This is "nn::hid::IHidDebugServer".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || DeactivateDebugPad
|-
| 1 || SetDebugPadAutoPilotState
|-
| 2 || UnsetDebugPadAutoPilotState
|-
| 10 || DeactivateTouchScreen
|-
| 11 || SetTouchScreenAutoPilotState
|-
| 12 || UnsetTouchScreenAutoPilotState
|-
| 20 || DeactivateMouse
|-
| 21 || SetMouseAutoPilotState
|-
| 22 || UnsetMouseAutoPilotState
|-
| 30 || DeactivateKeyboard
|-
| 31 || SetKeyboardAutoPilotState
|-
| 32 || UnsetKeyboardAutoPilotState
|-
| 50 || DeactivateXpad
|-
| 51 || SetXpadAutoPilotState
|-
| 52 || UnsetXpadAutoPilotState
|-
| 60 || DeactivateJoyXpad
|-
| 91 || DeactivateGesture
|-
| 110 || DeactivateHomeButton
|-
| 111 || SetHomeButtonAutoPilotState
|-
| 112 || UnsetHomeButtonAutoPilotState
|-
| 120 || DeactivateSleepButton
|-
| 121 || SetSleepButtonAutoPilotState
|-
| 122 || UnsetSleepButtonAutoPilotState
|-
| 123 || DeactivateInputDetector
|-
| 130 || DeactivateCaptureButton
|-
| 131 || SetCaptureButtonAutoPilotState
|-
| 132 || UnsetCaptureButtonAutoPilotState
|-
| 133 || SetShiftAccelerometerCalibrationValue
|-
| 134 || GetShiftAccelerometerCalibrationValue
|-
| 135 || SetShiftGyroscopeCalibrationValue
|-
| 136 || GetShiftGyroscopeCalibrationValue
|-
| 140 || DeactivateConsoleSixAxisSensor
|-
| 141 || [5.0.0+] GetConsoleSixAxisSensorSamplingFrequency
|-
| 142 || [5.0.0+] DeactivateSevenSixAxisSensor
|-
| 143 || [5.0.0+] GetConsoleSixAxisSensorCountStates
|-
| 144 || [8.0.0+] GetAccelerometerFsr
|-
| 145 || [8.0.0+] SetAccelerometerFsr
|-
| 146 || [8.0.0+] GetAccelerometerOdr
|-
| 147 || [8.0.0+] SetAccelerometerOdr
|-
| 148 || [8.0.0+] GetGyroscopeFsr
|-
| 149 || [8.0.0+] SetGyroscopeFsr
|-
| 150 || [8.0.0+] GetGyroscopeOdr
|-
| 151 || [8.0.0+] SetGyroscopeOdr
|-
| 201 || ActivateFirmwareUpdate
|-
| 202 || DeactivateFirmwareUpdate
|-
| 203 || StartFirmwareUpdate
|-
| 204 || GetFirmwareUpdateStage
|-
| 205 || GetFirmwareVersion
|-
| 206 || GetDestinationFirmwareVersion
|-
| 207 || DiscardFirmwareInfoCacheForRevert
|-
| 208 || StartFirmwareUpdateForRevert
|-
| 209 || GetAvailableFirmwareVersionForRevert
|-
| 210 || [4.0.0+] IsFirmwareUpdatingDevice
|-
| 211 || [6.0.0+] StartFirmwareUpdateIndividual
|-
| 215 || [6.0.0+] SetUsbFirmwareForceUpdateEnabled
|-
| 216 || [6.0.0+] SetAllKuinaDevicesToFirmwareUpdateMode
|-
| 221 || [[#UpdateControllerColor]]
|-
| 222 || [4.0.0+] ConnectUsbPadsAsync
|-
| 223 || [4.0.0+] DisconnectUsbPadsAsync
|-
| 224 || [5.0.0+] UpdateDesignInfo
|-
| 225 || [5.0.0+] GetUniquePadDriverState
|-
| 226 || [5.0.0+] GetSixAxisSensorDriverStates
|-
| 227 || [5.0.0+] GetRxPacketHistory
|-
| 228 || [6.0.0+] AcquireOperationEventHandle
|-
| 229 || [6.0.0+] ReadSerialFlash
|-
| 230 || [6.0.0+] WriteSerialFlash
|-
| 231 || [6.0.0+] GetOperationResult
|-
| 232 || [6.0.0+] EnableShipmentMode
|-
| 233 || [6.0.0+] ClearPairingInfo
|-
| 234 || [6.0.0+] GetUniquePadDeviceTypeSetInternal
|-
| 235 || [7.0.0+] EnableAnalogStickPower
|-
| 301 || [5.0.0+] GetAbstractedPadHandles
|-
| 302 || [5.0.0+] GetAbstractedPadState
|-
| 303 || [5.0.0+] GetAbstractedPadsState
|-
| 321 || [5.0.0+] SetAutoPilotVirtualPadState
|-
| 322 || [5.0.0+] UnsetAutoPilotVirtualPadState
|-
| 323 || [5.0.0+] UnsetAllAutoPilotVirtualPadState
|-
| 324 || [7.0.0+] AttachHdlsWorkBuffer
|-
| 325 || [7.0.0+] ReleaseHdlsWorkBuffer
|-
| 326 || [7.0.0+] DumpHdlsNpadAssignmentState
|-
| 327 || [7.0.0+] DumpHdlsStates
|-
| 328 || [7.0.0+] ApplyHdlsNpadAssignmentState
|-
| 329 || [7.0.0+] ApplyHdlsStateList
|-
| 330 || [7.0.0+] AttachHdlsVirtualDevice
|-
| 331 || [7.0.0+] DetachHdlsVirtualDevice
|-
| 332 || [7.0.0+] SetHdlsState
|-
| 350 || [5.0.0+] AddRegisteredDevice
|-
| 400 || [6.0.0+] DisableExternalMcuOnNxDevice
|-
| 401 || [6.0.0+] DisableRailDeviceFiltering
|-
| 500 || [8.0.0+] SetFactoryInt
|-
| 501 || [8.0.0+] IsFactoryBootEnabled
|}

== UpdateControllerColor ==
Takes two input u32s for the colors, an input u64 '''UniquePadId''', and no output.

Sends the spi-write subcommand to the specified controller, for writing the [[Joy-Con#Colors|color data]]. This writes to offset 0x6050 size 0x6, where the first 3-bytes are from the first u32 and the remaining 3-bytes are from the second u32.

= hid:sys =
This is "nn::hid::IHidSystemServer".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 31 || SendKeyboardLockKeyEvent
|-
| 101 || AcquireHomeButtonEventHandle
|-
| 111 || ActivateHomeButton
|-
| 121 || AcquireSleepButtonEventHandle
|-
| 131 || ActivateSleepButton
|-
| 141 || AcquireCaptureButtonEventHandle
|-
| 151 || ActivateCaptureButton
|-
| 161 || [7.0.0+] GetPlatformConfig
|-
| 210 || AcquireNfcDeviceUpdateEventHandle
|-
| 211 || GetNpadsWithNfc
|-
| 212 || AcquireNfcActivateEventHandle
|-
| 213 || ActivateNfc
|-
| 214 || [4.0.0+] GetXcdHandleForNpadWithNfc
|-
| 215 || [4.0.0+] IsNfcActivated
|-
| 230 || AcquireIrSensorEventHandle
|-
| 231 || ActivateIrSensor
|-
| 301 || ActivateNpadSystem
|-
| 303 || ApplyNpadSystemCommonPolicy
|-
| 304 || EnableAssigningSingleOnSlSrPress
|-
| 305 || DisableAssigningSingleOnSlSrPress
|-
| 306 || GetLastActiveNpad
|-
| 307 || GetNpadSystemExtStyle
|-
| 308 || [5.0.0+] ApplyNpadSystemCommonPolicyFull
|-
| 309 || [5.0.0+] GetNpadFullKeyGripColor
|-
| 310 || [6.0.0+] GetMaskedSupportedNpadStyleSet
|-
| 311 || SetNpadPlayerLedBlinkingDevice
|-
| 312 || [6.0.0+] SetSupportedNpadStyleSetAll
|-
| 321 || [3.0.0+] [[#GetUniquePadsFromNpad]]
|-
| 322 || GetIrSensorState
|-
| 323 || GetXcdHandleForNpadWithIrSensor
|-
| 500 || SetAppletResourceUserId
|-
| 501 || RegisterAppletResourceUserId
|-
| 502 || UnregisterAppletResourceUserId
|-
| 503 || EnableAppletToGetInput
|-
| 504 || SetAruidValidForVibration
|-
| 505 || EnableAppletToGetSixAxisSensor
|-
| 510 || [[#SetVibrationMasterVolume]]
|-
| 511 || GetVibrationMasterVolume
|-
| 512 || BeginPermitVibrationSession
|-
| 513 || EndPermitVibrationSession
|-
| 520 || EnableHandheldHids
|-
| 521 || DisableHandheldHids
|-
| 540 || AcquirePlayReportControllerUsageUpdateEvent
|-
| 541 || GetPlayReportControllerUsages
|-
| 542 || AcquirePlayReportRegisteredDeviceUpdateEvent
|-
| 543 || GetRegisteredDevicesOld ([1.0.0-4.1.0] GetRegisteredDevices)
|-
| 544 || AcquireConnectionTriggerTimeoutEvent
|-
| 545 || SendConnectionTrigger
|-
| 546 || AcquireDeviceRegisteredEventForControllerSupport
|-
| 547 || GetAllowedBluetoothLinksCount
|-
| 548 || [5.0.0+] GetRegisteredDevices
|-
| 549 || [6.0.0+] GetConnectableRegisteredDevices
|-
| 700 || ActivateUniquePad
|-
| 702 || AcquireUniquePadConnectionEventHandle
|-
| 703 || [[#GetUniquePadIds]]
|-
| 751 || AcquireJoyDetachOnBluetoothOffEventHandle
|-
| 800 || ListSixAxisSensorHandles
|-
| 801 || IsSixAxisSensorUserCalibrationSupported
|-
| 802 || ResetSixAxisSensorCalibrationValues
|-
| 803 || StartSixAxisSensorUserCalibration
|-
| 804 || CancelSixAxisSensorUserCalibration
|-
| 805 || GetUniquePadBluetoothAddress
|-
| 806 || DisconnectUniquePad
|-
| 807 || [5.0.0+] GetUniquePadType
|-
| 808 || [5.0.0+] GetUniquePadInterface
|-
| 809 || [5.0.0+] GetUniquePadSerialNumber
|-
| 810 || [5.0.0+] GetUniquePadControllerNumber
|-
| 811 || [5.0.0+] GetSixAxisSensorUserCalibrationStage
|-
| 812 || [8.0.0+] GetConsoleUniqueSixAxisSensorHandle
|-
| 821 || StartAnalogStickManualCalibration
|-
| 822 || RetryCurrentAnalogStickManualCalibrationStage
|-
| 823 || CancelAnalogStickManualCalibration
|-
| 824 || ResetAnalogStickManualCalibration
|-
| 825 || [5.0.0+] GetAnalogStickState
|-
| 826 || [5.0.0+] GetAnalogStickManualCalibrationStage
|-
| 827 || [5.0.0+] IsAnalogStickButtonPressed
|-
| 828 || [5.0.0+] IsAnalogStickInReleasePosition
|-
| 829 || [5.0.0+] IsAnalogStickInCircumference
|-
| 830 || [7.0.0+] [[#SetNotificationLedPattern]]
|-
| 850 || IsUsbFullKeyControllerEnabled
|-
| 851 || EnableUsbFullKeyController
|-
| 852 || IsUsbConnected
|-
| 870 || [5.1.0+] IsHandheldButtonPressedOnConsoleMode
|-
| 900 || ActivateInputDetector
|-
| 901 || [[#NotifyInputDetector]]
|-
| 1000 || InitializeFirmwareUpdate
|-
| 1001 || GetFirmwareVersion
|-
| 1002 || GetAvailableFirmwareVersion
|-
| 1003 || IsFirmwareUpdateAvailable
|-
| 1004 || CheckFirmwareUpdateRequired
|-
| 1005 || StartFirmwareUpdate
|-
| 1006 || AbortFirmwareUpdate
|-
| 1007 || GetFirmwareUpdateState
|-
| 1008 || [4.0.0+] ActivateAudioControl
|-
| 1009 || [4.0.0+] AcquireAudioControlEventHandle
|-
| 1010 || [4.0.0+] GetAudioControlStates
|-
| 1011 || [4.0.0+] DeactivateAudioControl
|-
| 1050 || [5.0.0+] IsSixAxisSensorAccurateUserCalibrationSupported
|-
| 1051 || [5.0.0+] StartSixAxisSensorAccurateUserCalibration
|-
| 1052 || [5.0.0+] CancelSixAxisSensorAccurateUserCalibration
|-
| 1053 || [5.0.0+] GetSixAxisSensorAccurateUserCalibrationState
|-
| 1100 || [5.0.0+] GetHidbusSystemServiceObject
|-
| 1120 || [6.0.0+] SetFirmwareHotfixUpdateSkipEnabled
|-
| 1130 || [6.0.0+] InitializeUsbFirmwareUpdate
|-
| 1131 || [6.0.0+] FinalizeUsbFirmwareUpdate
|-
| 1132 || [6.0.0+] CheckUsbFirmwareUpdateRequired
|-
| 1133 || [6.0.0+] StartUsbFirmwareUpdate
|-
| 1134 || [6.0.0+] GetUsbFirmwareUpdateState
|-
| 1150 || [8.0.0+] SetTouchScreenMagnification
|}

== GetUniquePadsFromNpad ==
Takes an input u32 [[#NpadIdType]], a type-0xA output buffer, and returns an output u64 for total output entries.

The output buffer contains an array of u64 '''UniquePadId'''.

== SetVibrationMasterVolume ==
Takes an input 32bit float.

== GetUniquePadIds ==
Takes a type-0xA output buffer, and returns an output u64 for total output entries.

The output buffer contains an array of u64 '''UniquePadId'''.

== NotifyInputDetector ==
Takes an input u32 bitmask InputSourceId, no output.

This is the only hid:sys command used by USB-sysmodule (with value 0x40).

== SetNotificationLedPattern ==
Takes an input [[#NotificationLedPattern]] and an u64 '''UniquePadId''', no output.

The specified controller must have a HOME button.

This sends subcommand 0x38 to the specified controller, for setting the pattern for the HOME button notification LED. The input structure is converted to the format used by this [https://github.com/dekuNukem/Nintendo_Switch_Reverse_Engineering/blob/master/bluetooth_hid_subcommands_notes.md#subcommand-0x38-set-home-light subcommand].

== NotificationLedPattern ==
{| class="wikitable" border="1"
|-
! Offset || Size || Subcommand argdata bytepos || Subcommand argdata nibble || Description
|-
| 0x0 || 0x1 || 0x0 || Low || Mini Cycle Base Duration. Value 0x1-0xF: 12.5ms - 187.5ms. Value 0x0 = 0ms/OFF.
|-
| 0x1 || 0x1 || 0x0 || High || Number of Mini Cycles + 1. Value 0x0-0xF: 1 - 16 mini cycles.
|-
| 0x2 || 0x1 || 0x1 || Low || Number of Full Cycles. Value 0x1-0xF: 1 - 15 full cycles. Value 0x0 is repeat forever, but if Mini Cycle Base Duration is set to 0x0, it does the 1st Mini Cycle with a 12.5ms base duration and then the LED stays on with LED Start Intensity.
|-
| 0x3 || 0x1 || 0x1 || High || LED Start Intensity. Value 0x0-0xF: 0% - 100%. (In HW, 1 - 241 duty)
|-
| 0x4 || 0x1 || 0x2 || High || Mini Cycle 1 LED Intensity. Value 0x0-0xF: 0% - 100%. (In HW, 1 - 241 duty)
|-
| 0x5 || 0x1 || 0x3 || High || Fading Transition Steps to Mini Cycle 1 (Uses PWM). Value 0x0: Instant. Each step duration is based on Mini Cycle Step Duration Multiplier.
|-
| 0x6 || 0x1 || 0x3 || Low || Mini Cycle Step Duration Multiplier of Mini Cycle 1. Value is a Multiplier of Mini Cycle Base Duration. Value 0x0: x1, 0x1 - xF: 1x - 15x.
|-
| 0x7 || 0x1 || || || Unused
|-
| 0x8 || 0x1 || 0x2 || Low || Mini Cycle 2 LED Intensity.
|-
| 0x9 || 0x1 || 0x4 || High || Fading Transition Steps to Mini Cycle 2 (see above).
|-
| 0xA || 0x1 || 0x4 || Low || Mini Cycle Step Duration Multiplier of Mini Cycle 2 (see above).
|-
| 0xB || 0x1 || || || Unused
|-
| 0xC || 0x1 || 0x5 || High || Mini Cycle 3 LED Intensity.
|-
| 0xD || 0x1 || 0x6 || High || Fading Transition Steps to Mini Cycle 3 (see above).
|-
| 0xE || 0x1 || 0x6 || Low || Mini Cycle Step Duration Multiplier of Mini Cycle 3 (see above).
|-
| 0xF || 0x1 || || || Unused
|-
| 0x10 || 0x1 || 0x5 || Low || Mini Cycle 4 LED Intensity.
|-
| 0x11 || 0x1 || 0x7 || High || Fading Transition Duration to Mini Cycle 4 (see above).
|-
| 0x12 || 0x1 || 0x7 || Low || Mini Cycle Step Duration Multiplier of Mini Cycle 4 (see above).
|-
| 0x13 || 0x1 || || || Unused
|-
| 0x14 || 0x1 || 0x8 || High || Mini Cycle 5 LED Intensity.
|-
| 0x15 || 0x1 || 0x9 || High || Fading Transition Steps to Mini Cycle 5 (see above).
|-
| 0x16 || 0x1 || 0x9 || Low || Mini Cycle Step Duration Multiplier of Mini Cycle 5 (see above).
|-
| 0x17 || 0x1 || || || Unused
|-
| 0x18 || 0x1 || 0x8 || Low || Mini Cycle 6 LED Intensity.
|-
| 0x19 || 0x1 || 0xA || High || Fading Transition Steps to Mini Cycle 6 (see above).
|-
| 0x1A || 0x1 || 0xA || Low || Mini Cycle Step Duration Multiplier of Mini Cycle 6 (see above).
|-
| 0x1B || 0x1 || || || Unused
|-
| 0x1C || 0x1 || 0xB || High || Mini Cycle 7 LED Intensity.
|-
| 0x1D || 0x1 || 0xC || High || Fading Transition Steps to Mini Cycle 7 (see above).
|-
| 0x1E || 0x1 || 0xC || Low || Mini Cycle Step Duration Multiplier of Mini Cycle 7 (see above).
|-
| 0x1F || 0x1 || || || Unused
|-
| 0x20 || 0x1 || 0xB || Low || Mini Cycle 8 LED Intensity.
|-
| 0x21 || 0x1 || 0xD || Low || Fading Transition Steps to Mini Cycle 8 (see above).
|-
| 0x22 || 0x1 || 0xD || High || Mini Cycle Step Duration Multiplier of Mini Cycle 8 (see above).
|-
| 0x23 || 0x1 || || || Unused
|-
| 0x24 || 0x1 || 0xE || High || Mini Cycle 9 LED Intensity.
|-
| 0x25 || 0x1 || 0xF || High || Fading Transition Steps to Mini Cycle 9 (see above).
|-
| 0x26 || 0x1 || 0xF || Low || Mini Cycle Step Duration Multiplier of Mini Cycle 9 (see above).
|-
| 0x27 || 0x1 || || || Unused
|-
| 0x28 || 0x1 || 0xE || Low || Mini Cycle 10 LED Intensity.
|-
| 0x29 || 0x1 || 0x10 || High || Fading Transition Steps to Mini Cycle 10 (see above).
|-
| 0x2A || 0x1 || 0x10 || Low || Mini Cycle Step Duration Multiplier of Mini Cycle 10 (see above).
|-
| 0x2B || 0x1 || || || Unused
|-
| 0x2C || 0x1 || 0x11 || High || Mini Cycle 11 LED Intensity.
|-
| 0x2D || 0x1 || 0x12 || High || Fading Transition Steps to Mini Cycle 11 (see above).
|-
| 0x2E || 0x1 || 0x12 || Low || Mini Cycle Step Duration Multiplier of Mini Cycle 11 (see above).
|-
| 0x2F || 0x1 || || || Unused
|-
| 0x30 || 0x1 || 0x11 || Low || Mini Cycle 12 LED Intensity.
|-
| 0x31 || 0x1 || 0x13 || High || Fading Transition Steps to Mini Cycle 12 (see above).
|-
| 0x32 || 0x1 || 0x13 || Low || Mini Cycle Step Duration Multiplier of Mini Cycle 12 (see above).
|-
| 0x33 || 0x1 || || || Unused
|-
| 0x34 || 0x1 || 0x14 || High || Mini Cycle 13 LED Intensity.
|-
| 0x35 || 0x1 || 0x15 || High || Fading Transition Steps to Mini Cycle 13 (see above).
|-
| 0x36 || 0x1 || 0x15 || Low || Mini Cycle Step Duration Multiplier of Mini Cycle 13 (see above).
|-
| 0x37 || 0x1 || || || Unused
|-
| 0x38 || 0x1 || 0x14 || Low || Mini Cycle 14 LED Intensity.
|-
| 0x39 || 0x1 || 0x16 || High || Fading Transition Steps to Mini Cycle 14 (see above).
|-
| 0x3A || 0x1 || 0x16 || Low || Mini Cycle Step Duration Multiplier of Mini Cycle 14 (see above).
|-
| 0x3B || 0x1 || || || Unused
|-
| 0x3C || 0x1 || 0x17 || High || Mini Cycle 15 LED Intensity.
|-
| 0x3D || 0x1 || 0x18 || High || Fading Transition Steps to Mini Cycle 15 (see above).
|-
| 0x3E || 0x1 || 0x18 || Low || Mini Cycle Step Duration Multiplier of Mini Cycle 15 (see above).
|-
| 0x3F || 0x1 || || || Unused
|-
| 0x40 || 0x1 || 0x17 || Low || Mini Cycle 16 LED Intensity.
|-
| 0x41 || 0x1 || 0x19 || High || Fading Transition Steps to Mini Cycle 16 (see above). (Unused in older Joy-Con / Pro-Con FW. Unknown for new.)
|-
| 0x42 || 0x1 || 0x19 || Low || Mini Cycle Step Duration Multiplier of Mini Cycle 16 (see above). (Unused in older Joy-Con / Pro-Con FW. Unknown for new.)
|-
| 0x43 || 0x1 || || || Unused
|-
| 0x44 || 0x1 || 0x1A || High || Unknown (Unused in older Joy-Con / Pro-Con FW. Unknown for new.)
|-
| 0x45 || 0x1 || 0x1A || Low || Unknown (Unused in older Joy-Con / Pro-Con FW. Unknown for new.)
|-
| 0x46 || 0x1 || || || Padding
|-
| 0x47 || 0x1 || || || Padding
|-
|}

This is "nn::hid::system::NotificationLedPattern".

This is a 0x48-byte struct.

The above descriptions in the table are based on the info from [https://github.com/dekuNukem/Nintendo_Switch_Reverse_Engineering/blob/master/bluetooth_hid_subcommands_notes.md here].

argdata in the subcommand is initialized as follows: <code>((u8*)cmd_argdata)[pos] = u8_in[pos2] | u8_in[pos3]<<4;</code> Hence, 4bits from pairs of 2-bytes of the input struct are combined to write to the subcommand. Only the low 4bits of each used byte in the struct is used. This is written to stack initially, then copied to the actual cmd_argdata (the data immediately following the subcommandID byte). There's a total of 0x1B-bytes of cmd_argdata initialized from this.

The layout of cmd_argdata is as follows:
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x1B || See above.
|-
| 0x1B || 0xB || Cleared to zero.
|-
| 0x26 || 0x5 || Unused
|-
| 0x2B || 0x8 || Set to an input value, which is hard-coded 0.
|-
| 0x33 || 0x2 || Set to value 0.
|-
| 0x35 || 0x1 || Set to value 1.
|}

= hid:tmp =
This is "nn::hid::IHidTemporaryServer".

This service no longer exists in [8.0.0+].

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetConsoleSixAxisSensorCalibrationValues
|}

= irs =
This is "nn::irsensor::IIrSensorServer".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 302 || [[#ActivateIrsensor]]
|-
| 303 || [[#DeactivateIrsensor]]
|-
| 304 || [[#GetIrsensorSharedMemoryHandle]]
|-
| 305 || [[#StopImageProcessor]]
|-
| 306 || [[#RunMomentProcessor]]
|-
| 307 || [[#RunClusteringProcessor]]
|-
| 308 || [[#RunImageTransferProcessor]]
|-
| 309 || [[#GetImageTransferProcessorState]]
|-
| 310 || [[#RunTeraPluginProcessor]]
|-
| 311 || [[#GetNpadIrCameraHandle]]
|-
| 312 || [[#RunPointingProcessor]]
|-
| 313 || [[#SuspendImageProcessor]]
|-
| 314 || [3.0.0+] [[#CheckFirmwareVersion]]
|-
| 315 || [5.0.0+] SetFunctionLevel
|-
| 316 || [5.0.0+] RunImageTransferExProcessor
|-
| 317 || [5.0.0+] RunIrLedProcessor
|-
| 318 || [5.0.0+] StopImageProcessorAsync
|-
| 319 || [5.0.0+] ActivateIrsensorWithFunctionLevel
|}

== ActivateIrsensor ==
Takes a PID-descriptor and an [[AM_services|AppletResourceUserId]]. No output.

== DeactivateIrsensor ==
Takes a PID-descriptor and an [[AM_services|AppletResourceUserId]]. No output.

== GetIrsensorSharedMemoryHandle ==
Takes a PID-descriptor and an [[AM_services|AppletResourceUserId]]. Returns a SharedMemory handle.

The SharedMemory is mapped with permissions=read-only and size=0x8000.

== StopImageProcessor ==
Takes a PID-descriptor, an [[#IrCameraHandle]], and an [[AM_services|AppletResourceUserId]]. No output.

== RunMomentProcessor ==
Takes a PID-descriptor, an [[#IrCameraHandle]], an [[AM_services|AppletResourceUserId]], and a [[#PackedMomentProcessorConfig]]. No output.

== RunClusteringProcessor ==
Takes a PID-descriptor, an [[#IrCameraHandle]], an [[AM_services|AppletResourceUserId]], and a [[#PackedClusteringProcessorConfig]]. No output.

== RunImageTransferProcessor ==
Takes a PID-descriptor, an [[#IrCameraHandle]], an [[AM_services|AppletResourceUserId]], a [[#PackedImageTransferProcessorConfig]], an u64 for the TransferMemory_size, and a TransferMemory handle. No output.

Official sw creates the TransferMemory with an user-specified buffer and permissions=0.

== GetImageTransferProcessorState ==
Takes a PID-descriptor, a type-0x6 output buffer, an [[#IrCameraHandle]], and an [[AM_services|AppletResourceUserId]]. Returns an [[#ImageTransferProcessorState]]. No output.

== RunTeraPluginProcessor==
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedTeraPluginProcessorConfig]] (immediately after the previous word), and an [[AM_services|AppletResourceUserId]]. No output.

== GetNpadIrCameraHandle ==
Takes an input u32. Returns an output [[#IrCameraHandle]].

== RunPointingProcessor ==
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedDpdProcessorConfig]] (immediately after the previous word), and an [[AM_services|AppletResourceUserId]]. No output.

== SuspendImageProcessor ==
Takes a PID-descriptor, an [[#IrCameraHandle]], and an [[AM_services|AppletResourceUserId]]. No output.

== CheckFirmwareVersion ==
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedMcuVersion]], and an [[AM_services|AppletResourceUserId]]. No output.

== IrCameraHandle ==
This is an u32.

== PackedMomentProcessorConfig ==
This is a 0x20-byte struct. This is converted from another structure by the official user-process.

{| class="wikitable" border="1"
|-
! Offset || Size || Description || DefaultConfig
|-
| 0x0 || 0x8 || ? || 0x493E0
|-
| 0x8 || 0x1 || ? || 0x0
|-
| 0x9 || 0x1 || ? || 0x8
|-
| 0xA || 0x1 || ? || 0x0
|-
| 0xB || 0x5 || Padding ||
|-
| 0x10 || 0x8 || u16, u32, u16 || {Not written}, 0x1400000, 0xF0
|-
| 0x18 || 0x4 || Hard-coded to 0xA0003. ||
|-
| 0x1C || 0x1 || ? || 0x1
|-
| 0x1D || 0x1 || ? || 0x50
|-
| 0x1E || 0x2 || Padding ||
|}

== PackedClusteringProcessorConfig ==
This is a 0x28-byte struct.

== PackedImageTransferProcessorConfig ==
This is a 0x18-byte struct. This is converted from another structure by the official user-process. The conversion is the same as PackedMomentProcessorConfig, except the code using out +0x1C/+0x1D was removed, and the constant is now located at out+0x10. The code which wrote to out u64 +0x10 from in+0x24 was replaced with code which writes an u8 to out+0x14.

== ImageTransferProcessorState ==
This is a 0x10-byte struct.

== PackedTeraPluginProcessorConfig ==
This is an u64.

== PackedDpdProcessorConfig ==
This is a 0x10-byte struct.

== PackedMcuVersion ==
This is an u32.

= irs:sys =
This is "nn::irsensor::IIrSensorSystemServer".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 500 || SetAppletResourceUserId
|-
| 501 || RegisterAppletResourceUserId
|-
| 502 || UnregisterAppletResourceUserId
|-
| 503 || EnableAppletToGetInput
|}

= ahid:cd =
This is "nn::ahid::IServerSession".

Used for USB HID devices.

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || || Takes an input s32, no output.
|-
| 1 || || Takes an input s32, no output.
|-
| 2 || || Takes an input u32, returns an [[#ICtrlSession]].
|-
| 3 || || Takes an input u32, returns an [[#IReadSession]].
|-
| 4 || || Takes an input u32, returns an [[#IWriteSession]].
|}

== ICtrlSession ==
This is "nn::ahid::ICtrlSession".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || ||
|-
| 1 || ||
|-
| 2 || ||
|-
| 3 || ||
|-
| 4 || ||
|-
| 5 || ||
|-
| 6 || ||
|-
| 7 || ||
|-
| 8 || ||
|-
| 9 || ||
|-
| 10 || ||
|-
| 11 || ||
|}

All of these use USB [[USB_services|CtrlXfer]], except for cmd10-11 which are event(?) related, and cmd1 which copies 0x4000-bytes from state to output.

== IReadSession ==
This is "nn::ahid::IReadSession".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || ||
|}

Cmd0 uses [[USB_services|PostBufferAsync]] etc with the INPUT endpoint. The size must be <=0x1000. The actual transfer size is returned in an output u64. The data is copied from the tmpbuf to the output buffer using the actual-transfer-size.

== IWriteSession ==
This is "nn::ahid::IWriteSession".

{| class="wikitable" border="1"
|-
! Cmd || Name || Notes
|-
| 0 || || This is the inverse of [[#IReadSession]] cmd0. Uses the OUTPUT endpoint with an input buffer.
|}

= ahid:hdr =
This is "nn::ahid::hdr::ISession".

Used internally for USB HID devices.

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 ||
|-
| 1 ||
|-
| 2 ||
|-
| 3 ||
|-
| 4 ||
|-
| 5 || [6.0.0+]
|}

= xcd:sys =
This is "nn::xcd::detail::ISystemServer".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetDataFormat
|-
| 1 || SetDataFormat
|-
| 2 || GetMcuState
|-
| 3 || SetMcuState
|-
| 4 || GetMcuVersionForNfc
|-
| 5 || CheckNfcDevicePower
|-
| 10 || SetNfcEvent
|-
| 11 || GetNfcInfo
|-
| 12 || StartNfcDiscovery
|-
| 13 || StopNfcDiscovery
|-
| 14 || StartNtagRead
|-
| 15 || StartNtagWrite
|-
| 16 || SendNfcRawData
|-
| 17 || RegisterMifareKey
|-
| 18 || ClearMifareKey
|-
| 19 || StartMifareRead
|-
| 20 || StartMifareWrite
|-
| 101 || GetAwakeTriggerReasonForLeftRail
|-
| 102 || GetAwakeTriggerReasonForRightRail
|}

[6.0.0+]: The buffer type used by GetNfcInfo is now 0x32 instead of 0x1A.

= hidbus =
This is "nn::hidbus::IHidbusServer".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 1 || GetBusHandle
|-
| 2 || IsExternalDeviceConnected
|-
| 3 || Initialize
|-
| 4 || Finalize
|-
| 5 || EnableExternalDevice
|-
| 6 || GetExternalDeviceId
|-
| 7 || SendCommandAsync
|-
| 8 || GetSendCommandAsynceResult
|-
| 9 || SetEventForSendCommandAsycResult
|-
| 10 || GetSharedMemoryHandle
|-
| 11 || EnableJoyPollingReceiveMode
|-
| 12 || DisableJoyPollingReceiveMode
|-
| [5.0.0-6.2.0] 13 || GetPollingData
|-
| 14 || [6.0.0+] SetStatusManagerType
|}

= RomFS =
The hid-sysmodule RomFS contains:
ftmFwUpdate
├── NTD_4CD_1801.fts256
├── NTD_4CD_2602.fts256
└── NTD_4CD_3801.fts256

These are firmware files for the touchscreen controller.

= Firmware update =
Starting with [[3.0.0]] HID-sysmodule now contains strings for data stored in title [[Title_list|0100000000000822]].

[[Category:Services]]

Backlight services

2019-01-15T00:21:55Z

Ctcaer:

= lbl =
This is "nn::lbl::detail::ILblController".

{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || SaveCurrentSetting
|-
| 1 || LoadCurrentSetting
|-
| 2 || SetCurrentBrightnessSetting
|-
| 3 || GetCurrentBrightnessSetting
|-
| 4 || ApplyCurrentBrightnessSettingToBacklight
|-
| 5 || GetBrightnessSettingAppliedToBacklight
|-
| 6 || SwitchBacklightOn
|-
| 7 || SwitchBacklightOff
|-
| 8 || GetBacklightSwitchStatus
|-
| 9 || EnableDimming
|-
| 10 || DisableDimming
|-
| 11 || IsDimmingEnabled
|-
| 12 || EnableAutoBrightnessControl
|-
| 13 || DisableAutoBrightnessControl
|-
| 14 || IsAutoBrightnessControlEnabled
|-
| 15 || SetAmbientLightSensorValue
|-
| 16 || [[#GetAmbientLightSensorValue]]
|-
| 17 || SetBrightnessReflectionDelayLevel
|-
| 18 || GetBrightnessReflectionDelayLevel
|-
| 19 || SetCurrentBrightnessMapping
|-
| 20 || GetCurrentBrightnessMapping
|-
| 21 || SetCurrentAmbientLightSensorMapping
|-
| 22 || GetCurrentAmbientLightSensorMapping
|-
| 23 || [3.0.0+] IsAmbientLightSensorAvailable
|-
| 24 || [3.0.0+] SetCurrentBrightnessSettingForVrMode
|-
| 25 || [3.0.0+] GetCurrentBrightnessSettingForVrMode
|-
| 26 || [3.0.0+] [[#EnableVrMode]]
|-
| 27 || [3.0.0+] [[#DisableVrMode]]
|-
| 28 || [3.0.0+] [[#IsVrModeEnabled]]
|}

== Ambient Light Sensor Notes ==
The BH1730 outputs 2 values. Visible light and IR light. This is then calculated through an algorithm that checks for Gain, Measurement time, filter qualities and ouputs lux (max correct measurement of 100K lux).
The default values are Gain 64x and ITIME of 38 (256 - 218). This allows for a max lux value of 17972 lux when visible light value is maximum and IR light is 0. When both of them are on their limit, the output is 1192 lux.
The sensor is fully configurable.

== GetAmbientLightSensorValue ==
No input. Before 5.x, outputs lux in float. (5.0.0+) Returns an output struct:
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || bOverLimit. (u32) Equals to 1 if visible or IR light data is over 65534.
|-
| 0x4 || 0x4 || fLux. (float) Value in lux from the ambient light sensor.
|}
Note: if bOverLimit=1 and the default ALS configuration is used, the measurement of fLux should not be considered and the actual max value depends on the type of light. Ranges from 12.5K - 17.5K.

== GetCurrentBrightnessSetting ==
No input. Returns an output u32 int of the current backlight level.

== GetBrightnessSettingAppliedToBacklight ==
No input. Returns an output u32 int of the backlight level computed from the ambient light sensor.

== IsAutoBrightnessControlEnabled ==
No input. Returns an output u8 bool indicating whether auto brightness is enabled.

== EnableVrMode ==
No input/output. Used by [[AM_services#SetVrModeEnabled]].

Sets a global state field to 0x1.

== DisableVrMode ==
No input/output. Used by [[AM_services#SetVrModeEnabled]].

Sets the global state field used by [[#EnableVrMode]] to 0x0.

== IsVrModeEnabled ==
No input. Returns an output u8 bool set by the above commands.

[[Category:Services]]