Difference between revisions of "HID services"

 
(208 intermediate revisions by 4 users not shown)
Line 54: Line 54:
 
| 69 || EnableSixAxisSensorFusion
 
| 69 || EnableSixAxisSensorFusion
 
|-
 
|-
| 70 || SetSixAxisSensorFusionParameters
+
| 70 || [[#SetSixAxisSensorFusionParameters]]
 
|-
 
|-
| 71 || GetSixAxisSensorFusionParameters
+
| 71 || [[#GetSixAxisSensorFusionParameters]]
 
|-
 
|-
| 72 || ResetSixAxisSensorFusionParameters
+
| 72 || [[#ResetSixAxisSensorFusionParameters]]
 
|-
 
|-
 
| 73 || SetAccelerometerParameters
 
| 73 || SetAccelerometerParameters
Line 72: Line 72:
 
| 78 || ResetAccelerometerPlayMode
 
| 78 || ResetAccelerometerPlayMode
 
|-
 
|-
| 79 || SetGyroscopeZeroDriftMode
+
| 79 || [[#SetGyroscopeZeroDriftMode]]
 
|-
 
|-
| 80 || GetGyroscopeZeroDriftMode
+
| 80 || [[#GetGyroscopeZeroDriftMode]]
 
|-
 
|-
| 81 || ResetGyroscopeZeroDriftMode
+
| 81 || [[#ResetGyroscopeZeroDriftMode]]
 
|-
 
|-
 
| 82 || IsSixAxisSensorAtRest
 
| 82 || IsSixAxisSensorAtRest
Line 90: Line 90:
 
| 102 || [[#SetSupportedNpadIdType]]
 
| 102 || [[#SetSupportedNpadIdType]]
 
|-
 
|-
| 103 || ActivateNpad
+
| 103 || [[#ActivateNpad]]
 
|-
 
|-
| 104 || DeactivateNpad
+
| 104 || [[#DeactivateNpad]]
 
|-
 
|-
 
| 106 || [[#AcquireNpadStyleSetUpdateEventHandle]]
 
| 106 || [[#AcquireNpadStyleSetUpdateEventHandle]]
Line 100: Line 100:
 
| 108 || GetPlayerLedPattern
 
| 108 || GetPlayerLedPattern
 
|-
 
|-
| 109 || [5.0.0+] ActivateNpadWithRevision
+
| 109 || [5.0.0+] [[#ActivateNpadWithRevision]]
 
|-
 
|-
| 120 || SetNpadJoyHoldType
+
| 120 || [[#SetNpadJoyHoldType]]
 
|-
 
|-
| 121 || GetNpadJoyHoldType
+
| 121 || [[#GetNpadJoyHoldType]]
 
|-
 
|-
 
| 122 || [[#SetNpadJoyAssignmentModeSingleByDefault]]
 
| 122 || [[#SetNpadJoyAssignmentModeSingleByDefault]]
Line 160: Line 160:
 
| 211 || [7.0.0+] [[#IsVibrationDeviceMounted]]
 
| 211 || [7.0.0+] [[#IsVibrationDeviceMounted]]
 
|-
 
|-
| 300 || ActivateConsoleSixAxisSensor
+
| 300 || [3.0.0+] [[#ActivateConsoleSixAxisSensor]]
 
|-
 
|-
| 301 || StartConsoleSixAxisSensor
+
| 301 || [3.0.0+] StartConsoleSixAxisSensor
 
|-
 
|-
| 302 || StopConsoleSixAxisSensor
+
| 302 || [3.0.0+] StopConsoleSixAxisSensor
 
|-
 
|-
 
| 303 || [5.0.0+] [[#ActivateSevenSixAxisSensor]]
 
| 303 || [5.0.0+] [[#ActivateSevenSixAxisSensor]]
Line 176: Line 176:
 
| 307 || [5.0.0+] [[#FinalizeSevenSixAxisSensor]]
 
| 307 || [5.0.0+] [[#FinalizeSevenSixAxisSensor]]
 
|-
 
|-
| 308 || [5.0.0+] SetSevenSixAxisSensorFusionStrength
+
| 308 || [5.0.0+] [[#SetSevenSixAxisSensorFusionStrength]]
 
|-
 
|-
| 309 || [5.0.0+] GetSevenSixAxisSensorFusionStrength
+
| 309 || [5.0.0+] [[#GetSevenSixAxisSensorFusionStrength]]
 
|-
 
|-
 
| 310 || [6.0.0+] [[#ResetSevenSixAxisSensorTimestamp]]
 
| 310 || [6.0.0+] [[#ResetSevenSixAxisSensorTimestamp]]
 
|-
 
|-
| 400 || IsUsbFullKeyControllerEnabled
+
| 400 || [3.0.0+] IsUsbFullKeyControllerEnabled
 
|-
 
|-
| 401 || EnableUsbFullKeyController
+
| 401 || [3.0.0+] EnableUsbFullKeyController
 
|-
 
|-
| 402 || IsUsbFullKeyControllerConnected
+
| 402 || [3.0.0+] IsUsbFullKeyControllerConnected
 
|-
 
|-
 
| 403 || [4.0.0+] HasBattery
 
| 403 || [4.0.0+] HasBattery
Line 192: Line 192:
 
| 404 || [4.0.0+] HasLeftRightBattery
 
| 404 || [4.0.0+] HasLeftRightBattery
 
|-
 
|-
| 405 || [4.0.0+] GetNpadInterfaceType
+
| 405 || [4.0.0+] [[#GetNpadInterfaceType]]
 
|-
 
|-
 
| 406 || [4.0.0+] GetNpadLeftRightInterfaceType
 
| 406 || [4.0.0+] GetNpadLeftRightInterfaceType
 +
|-
 +
| 407 || [10.0.0+] GetNpadOfHighestBatteryLevel ([9.0.0+] GetNpadOfHighestBatteryLevelForJoyLeft)
 +
|-
 +
| 408 || [9.0.0-9.2.0] GetNpadOfHighestBatteryLevelForJoyRight
 
|-
 
|-
 
| 500 || [5.0.0+] GetPalmaConnectionHandle
 
| 500 || [5.0.0+] GetPalmaConnectionHandle
Line 259: Line 263:
 
|-
 
|-
 
| 1001 || GetNpadCommunicationMode
 
| 1001 || GetNpadCommunicationMode
 +
|-
 +
| 1002 || [9.0.0+] SetTouchScreenConfiguration
 +
|-
 +
| 1003 || [9.0.0+] IsFirmwareUpdateNeededForNotification
 +
|-
 +
| 2000 || [10.0.0+] ActivateDigitizer
 
|}
 
|}
  
 
== CreateAppletResource ==
 
== CreateAppletResource ==
 
Takes a PID and an u64 [[AM_services|AppletResourceUserId]]. Returns an [[#IAppletResource]].
 
Takes a PID and an u64 [[AM_services|AppletResourceUserId]]. Returns an [[#IAppletResource]].
 +
 +
== SetSixAxisSensorFusionParameters ==
 +
Takes a PID-descriptor, an u32 [[#SixAxisSensorHandle]], two floats, and an u64 [[AM_services|AppletResourceUserId]], no output.
 +
 +
Official sw will throw an error before using this cmd, if the first float is outside of the bounds of 0.0f-1.0f.
 +
 +
== GetSixAxisSensorFusionParameters ==
 +
Takes a PID-descriptor, an u32 [[#SixAxisSensorHandle]], and an u64 [[AM_services|AppletResourceUserId]], returns two output floats.
 +
 +
== ResetSixAxisSensorFusionParameters ==
 +
Takes a PID-descriptor, an u32 [[#SixAxisSensorHandle]], and an u64 [[AM_services|AppletResourceUserId]], no output.
 +
 +
== SetGyroscopeZeroDriftMode ==
 +
Takes a PID-descriptor, an u32 [[#SixAxisSensorHandle]], an u32 [[#GyroscopeZeroDriftMode]], and an u64 [[AM_services|AppletResourceUserId]], no output.
 +
 +
== GetGyroscopeZeroDriftMode ==
 +
Takes a PID-descriptor, an u32 [[#SixAxisSensorHandle]], and an u64 [[AM_services|AppletResourceUserId]], returns an output u32 [[#GyroscopeZeroDriftMode]].
 +
 +
Gets the value written by [[#SetGyroscopeZeroDriftMode]].
 +
 +
== ResetGyroscopeZeroDriftMode ==
 +
Takes a PID-descriptor, an u32 [[#SixAxisSensorHandle]], and an u64 [[AM_services|AppletResourceUserId]], no output.
 +
 +
Same as [[#SetGyroscopeZeroDriftMode]] except the [[#GyroscopeZeroDriftMode]] is hard-coded to value 1 (Standard).
  
 
== SetSupportedNpadStyleSet ==
 
== SetSupportedNpadStyleSet ==
Takes an u32 [[#NpadStyleTag]].
+
Takes a PID-descriptor, an u32 [[#NpadStyleTag]], and an u64 [[AM_services|AppletResourceUserId]], no output.
  
 
== GetSupportedNpadStyleSet ==
 
== GetSupportedNpadStyleSet ==
Returns an u32 [[#NpadStyleTag]].
+
Takes a PID-descriptor and an u64 [[AM_services|AppletResourceUserId]], returns an u32 [[#NpadStyleTag]].
  
 
== SetSupportedNpadIdType ==
 
== SetSupportedNpadIdType ==
Line 274: Line 308:
  
 
The input buffer contains an array of u32 [[#NpadIdType]].
 
The input buffer contains an array of u32 [[#NpadIdType]].
 +
 +
== ActivateNpad ==
 +
Takes a PID-descriptor and an [[AM_services|AppletResourceUserId]]. No output.
 +
 +
On newer sysvers this runs the same code as [[#ActivateNpadWithRevision]], with revision=0.
 +
 +
== DeactivateNpad ==
 +
Takes a PID-descriptor and an [[AM_services|AppletResourceUserId]]. No output.
 +
 +
This just returns 0.
  
 
== AcquireNpadStyleSetUpdateEventHandle ==
 
== AcquireNpadStyleSetUpdateEventHandle ==
Takes an input u32, an u64 [[AM_services|AppletResourceUserId]], and an u64. Returns an output event handle, autoclear for this is user-specified.
+
Takes a PID, 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.
 
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.
 +
 +
== ActivateNpadWithRevision ==
 +
Takes a PID-descriptor, a s32 revision, and an [[AM_services|AppletResourceUserId]]. No output.
 +
 +
Revisions:
 +
* 0x0: Initial [[#ActivateNpad|revision]], pre-5.0.0.
 +
* 0x1: [5.0.0+]
 +
* 0x2: [6.0.0+]
 +
* 0x3: [8.0.0+]
 +
 +
== SetNpadJoyHoldType ==
 +
Takes a PID-descriptor, a s64, and an [[AM_services|AppletResourceUserId]]. No output.
 +
 +
== GetNpadJoyHoldType ==
 +
Takes a PID-descriptor and an [[AM_services|AppletResourceUserId]]. Returns an output s64.
  
 
== SetNpadJoyAssignmentModeSingleByDefault ==
 
== SetNpadJoyAssignmentModeSingleByDefault ==
Line 321: Line 380:
  
 
== IsVibrationDeviceMounted ==
 
== IsVibrationDeviceMounted ==
Takes a total of 0x10-bytes of input and a PID, returns an output u8 bool.
+
Takes a PID, an [[#VibrationDeviceHandle]], and an u64 [[AM_services|AppletResourceUserId]], returns an output u8 bool.
 +
 
 +
== ActivateConsoleSixAxisSensor ==
 +
Takes a PID and an u64 [[AM_services|AppletResourceUserId]], no output.
 +
 
 +
As of [10.0.0+] sdknso no longer uses this.
  
 
== ActivateSevenSixAxisSensor ==
 
== ActivateSevenSixAxisSensor ==
 
Takes a PID and an u64 [[AM_services|AppletResourceUserId]], no output.
 
Takes a PID and an u64 [[AM_services|AppletResourceUserId]], no output.
 +
 +
Unused by official sw, [[#ActivateConsoleSixAxisSensor]] is used instead. However, internally ActivateSevenSixAxisSensor is identical to [[#ActivateConsoleSixAxisSensor]]. Deactivation is done with hiddbg DeactivateConsoleSixAxisSensor (which is unused by official sw).
  
 
== StartSevenSixAxisSensor ==
 
== StartSevenSixAxisSensor ==
Line 335: Line 401:
 
Takes a PID, an u64 [[AM_services|AppletResourceUserId]], two u64s for the size of each TransferMemory, and two TransferMemory handles. No output.
 
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.
+
The size of the first TransferMemory is 0x1000 with MemoryPermission=read-only, while the second one has size 0x7F000 with MemoryPermission=none. sdknso uses an user-specified buffer for this, with the second tmem immediately following the first one. sdknso later uses data at buf+0 for loading SevenSixAxisSensor state.
 
+
 
== FinalizeSevenSixAxisSensor ==
+
The data at tmem+0 has the following structure:
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"
 
{| class="wikitable" border="1"
 
|-
 
|-
! Cmd || Name
+
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x10 || Unused by sdknso.
 +
|-
 +
| 0x10 || 0x8 || Latest entry.
 +
|-
 +
| 0x18 || 0x8 || Total entries.
 
|-
 
|-
| 0 || [[#GetSharedMemoryHandle]]
+
| 0x20 || 0xA50(0x21*0x50) || Array of the below entries.
 
|}
 
|}
  
=== GetSharedMemoryHandle ===
+
Entry:
No input. Returned a [[HID_Shared_Memory|sharedmem]] handle.
 
 
 
== IActiveVibrationDeviceList ==
 
This is "nn::hid::IActiveVibrationDeviceList".
 
  
 
{| class="wikitable" border="1"
 
{| class="wikitable" border="1"
 
|-
 
|-
! Cmd || Name
+
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x8 || Timestamp
 +
|-
 +
| 0x8 || 0x10 || Unused by sdknso.
 
|-
 
|-
| 0 || [[#ActivateVibrationDevice]]
+
| 0x10 || 0x40 || SevenSixAxisSensorState
 
|}
 
|}
  
=== ActivateVibrationDevice ===
+
SevenSixAxisSensorState:
Takes an input [[#VibrationDeviceHandle]]. No output.
 
 
 
== NpadStyleTag ==
 
This is a bitfield describing which controller styles are supported.
 
  
 
{| class="wikitable" border="1"
 
{| class="wikitable" border="1"
!  Bits
 
!  Description
 
!  Notes
 
 
|-
 
|-
| 0
+
! Offset || Size || Description
| NpadFullKey
 
| Pro Controller.
 
 
|-
 
|-
| 1
+
| 0x0 || 0x8 || First timestamp.
| NpadHandheld
 
| Joy-Con controller in handheld mode.
 
 
|-
 
|-
| 2
+
| 0x8 || 0x8 || Second timestamp (in samples).
| NpadJoyDual
 
| Joy-Con controller in dual mode.
 
 
|-
 
|-
| 3
+
| 0x10 || 0x8 || ?
| NpadJoyLeft
 
| Joy-Con left controller in single mode.
 
 
|-
 
|-
| 4
+
| 0x18 || 0x28 || float data
| NpadJoyRight
+
|}
| Joy-Con right controller in single mode.
+
 
|-
+
== FinalizeSevenSixAxisSensor ==
| 5
+
Takes a PID and an u64 [[AM_services|AppletResourceUserId]], no output.
| NpadGc
+
 
| GameCube controller.
+
== SetSevenSixAxisSensorFusionStrength ==
 +
Takes a PID, a float, and an u64 [[AM_services|AppletResourceUserId]], no output.
 +
 
 +
== GetSevenSixAxisSensorFusionStrength ==
 +
Takes a PID and an u64 [[AM_services|AppletResourceUserId]], returns an output float.
 +
 
 +
== ResetSevenSixAxisSensorTimestamp ==
 +
Takes a PID and an u64 [[AM_services|AppletResourceUserId]], no output.
 +
 
 +
== GetNpadInterfaceType ==
 +
Takes an input u32 NpadIdType, returns an output u8 [[#NpadInterfaceType]].
 +
 
 +
The NpadInterfaceType must be 1-4, otherwise this will assert.
 +
 
 +
== IAppletResource ==
 +
{| class="wikitable" border="1"
 
|-
 
|-
| 6
+
! Cmd || Name
| NpadPalma
 
| Poké Ball Plus controller.
 
 
|-
 
|-
| 7
+
| 0 || [[#GetSharedMemoryHandle]]
| NpadLark
+
|}
| NES controller.
+
 
 +
=== GetSharedMemoryHandle ===
 +
No input. Returned a [[HID_Shared_Memory|sharedmem]] handle.
 +
 
 +
== IActiveVibrationDeviceList ==
 +
This is "nn::hid::IActiveVibrationDeviceList".
 +
 
 +
{| class="wikitable" border="1"
 
|-
 
|-
| 8
+
! Cmd || Name
| NpadHandheldLark
 
| NES controller in handheld mode.
 
 
|-
 
|-
| 9-28
+
| 0 || [[#ActivateVibrationDevice]]
| Reserved
 
|
 
|-
 
| 29
 
| NpadSystemExt
 
|
 
|-
 
| 30
 
| NpadSystem
 
|
 
|-
 
| 31
 
| Reserved
 
|
 
 
|}
 
|}
  
== NpadIdType ==
+
=== ActivateVibrationDevice ===
This is an u32. This is the controller index used in [[HID_Shared_Memory#Controllers|sharedmem]]. 0x20 is handheld.
+
Takes an input [[#VibrationDeviceHandle]]. No output.
 +
 
 +
== SixAxisSensorHandle ==
 +
This is an u32.
 +
 
 +
== VibrationDeviceHandle ==
 +
This is an u32.
 +
 
 +
== VibrationDeviceInfo ==
 +
This is a 0x8-byte struct.
 +
 
 +
== VibrationValue ==
 +
This is a 0x10-byte struct, which contains 4 float values.
  
 
= hid:dbg =
 
= hid:dbg =
Line 459: Line 517:
 
|-
 
|-
 
| 12 || UnsetTouchScreenAutoPilotState
 
| 12 || UnsetTouchScreenAutoPilotState
 +
|-
 +
| 13 || [9.0.0+] GetTouchScreenConfiguration
 
|-
 
|-
 
| 20 || DeactivateMouse
 
| 20 || DeactivateMouse
Line 474: Line 534:
 
| 50 || DeactivateXpad
 
| 50 || DeactivateXpad
 
|-
 
|-
| 51 || SetXpadAutoPilotState
+
| 51 || [1.0.0-9.2.0] SetXpadAutoPilotState
 
|-
 
|-
| 52 || UnsetXpadAutoPilotState
+
| 52 || [1.0.0-9.2.0] UnsetXpadAutoPilotState
 
|-
 
|-
| 60 || DeactivateJoyXpad
+
| 53 ([1.0.0-8.1.0] 60) || [1.0.0-9.2.0] [[#DeactivateJoyXpad]]
 
|-
 
|-
| 91 || DeactivateGesture
+
| 60 || [9.0.0+] ClearNpadSystemCommonPolicy
 
|-
 
|-
| 110 || DeactivateHomeButton
+
| 61 || [10.0.0+] DeactivateNpad
 +
|-
 +
| 62 || [10.0.0+] ForceDisconnectNpad
 +
|-
 +
| 91 || DeactivateGesture
 +
|-
 +
| 110 || DeactivateHomeButton
 
|-
 
|-
 
| 111 || SetHomeButtonAutoPilotState
 
| 111 || SetHomeButtonAutoPilotState
Line 494: Line 560:
 
| 122 || UnsetSleepButtonAutoPilotState
 
| 122 || UnsetSleepButtonAutoPilotState
 
|-
 
|-
| 123 || DeactivateInputDetector
+
| 123 || [1.0.0-9.2.0] DeactivateInputDetector
 
|-
 
|-
 
| 130 || DeactivateCaptureButton
 
| 130 || DeactivateCaptureButton
Line 502: Line 568:
 
| 132 || UnsetCaptureButtonAutoPilotState
 
| 132 || UnsetCaptureButtonAutoPilotState
 
|-
 
|-
| 133 || SetShiftAccelerometerCalibrationValue
+
| 133 || [3.0.0+] SetShiftAccelerometerCalibrationValue
 
|-
 
|-
| 134 || GetShiftAccelerometerCalibrationValue
+
| 134 || [3.0.0+] GetShiftAccelerometerCalibrationValue
 
|-
 
|-
| 135 || SetShiftGyroscopeCalibrationValue
+
| 135 || [3.0.0+] SetShiftGyroscopeCalibrationValue
 
|-
 
|-
| 136 || GetShiftGyroscopeCalibrationValue
+
| 136 || [3.0.0+] GetShiftGyroscopeCalibrationValue
 
|-
 
|-
| 140 || DeactivateConsoleSixAxisSensor
+
| 140 || [3.0.0+] DeactivateConsoleSixAxisSensor
 
|-
 
|-
 
| 141 || [5.0.0+] GetConsoleSixAxisSensorSamplingFrequency
 
| 141 || [5.0.0+] GetConsoleSixAxisSensorSamplingFrequency
Line 533: Line 599:
 
|-
 
|-
 
| 151 || [8.0.0+] SetGyroscopeOdr
 
| 151 || [8.0.0+] SetGyroscopeOdr
 +
|-
 +
| 152 || [10.0.0+] GetWhoAmI
 
|-
 
|-
 
| 201 || ActivateFirmwareUpdate
 
| 201 || ActivateFirmwareUpdate
Line 538: Line 606:
 
| 202 || DeactivateFirmwareUpdate
 
| 202 || DeactivateFirmwareUpdate
 
|-
 
|-
| 203 || StartFirmwareUpdate
+
| 203 || [[#StartFirmwareUpdate]]
 
|-
 
|-
 
| 204 || GetFirmwareUpdateStage
 
| 204 || GetFirmwareUpdateStage
 
|-
 
|-
| 205 || GetFirmwareVersion
+
| 205 || [[#GetFirmwareVersion]]
 
|-
 
|-
| 206 || GetDestinationFirmwareVersion
+
| 206 || [[#GetDestinationFirmwareVersion]]
 
|-
 
|-
| 207 || DiscardFirmwareInfoCacheForRevert
+
| 207 || [[#DiscardFirmwareInfoCacheForRevert]]
 
|-
 
|-
| 208 || StartFirmwareUpdateForRevert
+
| 208 || [3.0.0+] StartFirmwareUpdateForRevert
 
|-
 
|-
| 209 || GetAvailableFirmwareVersionForRevert
+
| 209 || [3.0.0+] GetAvailableFirmwareVersionForRevert
 
|-
 
|-
 
| 210 || [4.0.0+] IsFirmwareUpdatingDevice
 
| 210 || [4.0.0+] IsFirmwareUpdatingDevice
Line 560: Line 628:
 
| 216 || [6.0.0+] SetAllKuinaDevicesToFirmwareUpdateMode
 
| 216 || [6.0.0+] SetAllKuinaDevicesToFirmwareUpdateMode
 
|-
 
|-
| 221 || [[#UpdateControllerColor]]
+
| 221 || [3.0.0+] [[#UpdateControllerColor]]
 
|-
 
|-
 
| 222 || [4.0.0+] ConnectUsbPadsAsync
 
| 222 || [4.0.0+] ConnectUsbPadsAsync
Line 566: Line 634:
 
| 223 || [4.0.0+] DisconnectUsbPadsAsync
 
| 223 || [4.0.0+] DisconnectUsbPadsAsync
 
|-
 
|-
| 224 || [5.0.0+] UpdateDesignInfo
+
| 224 || [5.0.0+] [[#UpdateDesignInfo]]
 
|-
 
|-
| 225 || [5.0.0+] GetUniquePadDriverState
+
| 225 || [5.0.0+] [[#GetUniquePadDriverState]]
 
|-
 
|-
| 226 || [5.0.0+] GetSixAxisSensorDriverStates
+
| 226 || [5.0.0+] [[#GetSixAxisSensorDriverStates]]
 
|-
 
|-
 
| 227 || [5.0.0+] GetRxPacketHistory
 
| 227 || [5.0.0+] GetRxPacketHistory
 
|-
 
|-
| 228 || [6.0.0+] AcquireOperationEventHandle
+
| 228 || [6.0.0+] [[#AcquireOperationEventHandle]]
 
|-
 
|-
| 229 || [6.0.0+] ReadSerialFlash
+
| 229 || [6.0.0+] [[#ReadSerialFlash]]
 
|-
 
|-
| 230 || [6.0.0+] WriteSerialFlash
+
| 230 || [6.0.0+] [[#WriteSerialFlash]]
 
|-
 
|-
| 231 || [6.0.0+] GetOperationResult
+
| 231 || [6.0.0+] [[#GetOperationResult]]
 
|-
 
|-
 
| 232 || [6.0.0+] EnableShipmentMode
 
| 232 || [6.0.0+] EnableShipmentMode
Line 586: Line 654:
 
| 233 || [6.0.0+] ClearPairingInfo
 
| 233 || [6.0.0+] ClearPairingInfo
 
|-
 
|-
| 234 || [6.0.0+] GetUniquePadDeviceTypeSetInternal
+
| 234 || [6.0.0+] [[#GetUniquePadDeviceTypeSetInternal]]
 
|-
 
|-
 
| 235 || [7.0.0+] EnableAnalogStickPower
 
| 235 || [7.0.0+] EnableAnalogStickPower
 
|-
 
|-
| 301 || [5.0.0+] GetAbstractedPadHandles
+
| 236 || [9.0.0+] RequestKuinaUartClockCal
 +
|-
 +
| 237 || [9.0.0+] GetKuinaUartClockCal
 
|-
 
|-
| 302 || [5.0.0+] GetAbstractedPadState
+
| 238 || [9.0.0+] SetKuinaUartClockTrim
 
|-
 
|-
| 303 || [5.0.0+] GetAbstractedPadsState
+
| 239 || [9.0.0+] KuinaLoopbackTest
 
|-
 
|-
| 321 || [5.0.0+] SetAutoPilotVirtualPadState
+
| 240 || [9.0.0+] RequestBatteryVoltage
 
|-
 
|-
| 322 || [5.0.0+] UnsetAutoPilotVirtualPadState
+
| 241 || [9.0.0+] GetBatteryVoltage
 
|-
 
|-
| 323 || [5.0.0+] UnsetAllAutoPilotVirtualPadState
+
| 242 || [9.0.0+] GetUniquePadPowerInfo
 
|-
 
|-
| 324 || [7.0.0+] AttachHdlsWorkBuffer
+
| 243 || [9.0.0+] RebootUniquePad
 
|-
 
|-
| 325 || [7.0.0+] ReleaseHdlsWorkBuffer
+
| 244 || [9.0.0+] RequestKuinaFirmwareVersion
 
|-
 
|-
| 326 || [7.0.0+] DumpHdlsNpadAssignmentState
+
| 245 || [9.0.0+] GetKuinaFirmwareVersion
 
|-
 
|-
| 327 || [7.0.0+] DumpHdlsStates
+
| 246 || [9.0.0+] GetVidPid
 
|-
 
|-
| 328 || [7.0.0+] ApplyHdlsNpadAssignmentState
+
| 301 || [5.0.0-8.1.0] [[#GetAbstractedPadHandles]]
 
|-
 
|-
| 329 || [7.0.0+] ApplyHdlsStateList
+
| 302 || [5.0.0-8.1.0] [[#GetAbstractedPadState]]
 
|-
 
|-
| 330 || [7.0.0+] AttachHdlsVirtualDevice
+
| 303 || [5.0.0-8.1.0] [[#GetAbstractedPadsState]]
 
|-
 
|-
| 331 || [7.0.0+] DetachHdlsVirtualDevice
+
| 321 || [5.0.0-8.1.0] [[#SetAutoPilotVirtualPadState]]
 
|-
 
|-
| 332 || [7.0.0+] SetHdlsState
+
| 322 || [5.0.0-8.1.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
 
| 350 || [5.0.0+] AddRegisteredDevice
Line 625: Line 715:
 
|-
 
|-
 
| 401 || [6.0.0+] DisableRailDeviceFiltering
 
| 401 || [6.0.0+] DisableRailDeviceFiltering
 +
|-
 +
| 402 || [10.0.0+] EnableWiredPairing
 +
|-
 +
| 403 || [10.0.0+] EnableShipmentModeAutoClear
 
|-
 
|-
 
| 500 || [8.0.0+] SetFactoryInt
 
| 500 || [8.0.0+] SetFactoryInt
 
|-
 
|-
 
| 501 || [8.0.0+] IsFactoryBootEnabled
 
| 501 || [8.0.0+] IsFactoryBootEnabled
 +
|-
 +
| 550 || [9.0.0+] SetAnalogStickModelDataTemporarily
 +
|-
 +
| 551 || [9.0.0+] GetAnalogStickModelData
 +
|-
 +
| 552 || [9.0.0+] ResetAnalogStickModelData
 +
|-
 +
| 600 || [10.0.0+] ConvertPadState
 +
|-
 +
| 2000 || [10.0.0+] DeactivateDigitizer
 +
|-
 +
| 2001 || [10.0.0+] SetDigitizerAutoPilotState
 +
|-
 +
| 2002 || [10.0.0+] UnsetDigitizerAutoPilotState
 
|}
 
|}
  
== UpdateControllerColor ==
+
== StartFirmwareUpdate ==
Takes two input u32s for the colors, an input u64 '''UniquePadId''', and no output.
+
Takes a total of 0x20-bytes of input, 2 handles, and returns an output handle.
  
A state flag must be clear, otherwise an error is thrown. Afterwards, this flag is set.
+
[3.0.0+] Now takes a total of 8-bytes of input, and no longer uses any input/output handles.
  
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.
+
== GetFirmwareVersion ==
 +
Takes a total of 8-bytes of input, and returns a total of 4-bytes of output.
  
= hid:sys =
+
[3.0.0+] Now returns an additional 0xC-bytes of output.
This is "nn::hid::IHidSystemServer".
+
 
 +
== GetDestinationFirmwareVersion ==
 +
Takes a total of 8-bytes of input, and returns a total of 4-bytes of output.
 +
 
 +
[3.0.0+] Now returns an additional 0xC-bytes of output.
 +
 
 +
== DiscardFirmwareInfoCacheForRevert ==
 +
Takes a total of 8-bytes of input, and returns a total of 5-bytes of output.
 +
 
 +
[3.0.0+] No input/output.
 +
 
 +
== UpdateControllerColor ==
 +
Takes two input u32s for the colors, an [[#UniquePadId]], and no output.
 +
 
 +
A state flag must be clear, otherwise an error is thrown. Afterwards, this flag is set.
 +
 
 +
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.
 +
 
 +
== UpdateDesignInfo ==
 +
Takes 4 input u32s for the colors, an input u8, an input [[#UniquePadId]], and no output.
 +
 
 +
A state flag must be clear (same as [[#UpdateControllerColor]]), otherwise an error is thrown. Afterwards, this flag is set.
 +
 
 +
Sends the spi-write subcommand to the specified controller, for writing to offset 0x6050 size 0xD. The first 3-bytes from each u32 is used for the spi-write-data, with the u8 being copied immediately afterwards the color data.
 +
 
 +
== GetUniquePadDriverState ==
 +
Takes a total of 8-bytes of input, returns a total of 0x20-bytes of output.
  
{| class="wikitable" border="1"
+
[9.0.0+] Now takes a total of 8-bytes of input, returns a total of 0x18-bytes of output.
|-
+
 
! Cmd || Name
+
== GetSixAxisSensorDriverStates ==
|-
+
Takes a total of 8-bytes of input and a type-0xA output buffer, returns a total of 8-bytes of output.
| 31 || SendKeyboardLockKeyEvent
+
 
|-
+
[9.0.0+] Now takes a total of 8-bytes of input and a type-0x6 output buffer, returns a total of 8-bytes of output.
| 101 || AcquireHomeButtonEventHandle
+
 
|-
+
== AcquireOperationEventHandle ==
| 111 || ActivateHomeButton
+
Takes an input [[#UniquePadId]], returns an output Event handle. The EventClearMode used by official sw is user-specified.
|-
+
 
| 121 || AcquireSleepButtonEventHandle
+
This is not used internally by sdk-nso besides exposing it to the user. With the sdk-nso for [9.0.0+] the wrapper funcs for this was removed (sdk-nso still has the actual cmd).
|-
+
 
| 131 || ActivateSleepButton
+
This must be used before [[#ReadSerialFlash]]/[[#WriteSerialFlash]]. Afterwards, this Event is used to wait for the async operation started by [[#ReadSerialFlash]]/[[#WriteSerialFlash]] to finish. After waiting on the Event, [[#GetOperationResult]] should be used.
|-
+
 
| 141 || AcquireCaptureButtonEventHandle
+
== ReadSerialFlash ==
|-
+
Takes an input TransferMemory handle, an input u32 offset, an input u64 size, and an [[#UniquePadId]], no output.
| 151 || ActivateCaptureButton
+
 
|-
+
Reads from the specified controller's spi-flash. The input size is the original size without page-alignment. The TransferMemory permissions is RW-.
| 161 || [7.0.0+] GetPlatformConfig
+
 
|-
+
See also [[#AcquireOperationEventHandle]].
| 210 || AcquireNfcDeviceUpdateEventHandle
+
 
|-
+
With the sdk-nso for [9.0.0+] the wrapper funcs for this was removed (sdk-nso still has the actual cmd).
| 211 || GetNpadsWithNfc
+
 
|-
+
== WriteSerialFlash ==
| 212 || AcquireNfcActivateEventHandle
+
Takes an input TransferMemory handle, an input u32 offset, an input u64 tmem_size, an input u64 size, and an [[#UniquePadId]], no output.
|-
+
 
| 213 || ActivateNfc
+
Writes to the specified controller's spi-flash. The TransferMemory permissions is R--.
|-
+
 
| 214 || [4.0.0+] GetXcdHandleForNpadWithNfc
+
See also [[#AcquireOperationEventHandle]].
|-
+
 
| 215 || [4.0.0+] IsNfcActivated
+
With the sdk-nso for [9.0.0+] the wrapper funcs for this was removed (sdk-nso still has the actual cmd).
|-
+
 
| 230 || AcquireIrSensorEventHandle
+
== GetOperationResult ==
|-
+
Takes an input [[#UniquePadId]], no output.
| 231 || ActivateIrSensor
+
 
|-
+
Get the Result for the Operation and handles cleanup, for the specified controller.
| 301 || ActivateNpadSystem
+
 
|-
+
This is not used internally by sdk-nso besides exposing it to the user. With the sdk-nso for [9.0.0+] the wrapper funcs for this was removed (sdk-nso still has the actual cmd).
| 303 || ApplyNpadSystemCommonPolicy
+
 
|-
+
== GetUniquePadDeviceTypeSetInternal ==
| 304 || EnableAssigningSingleOnSlSrPress
+
Takes an input [[#UniquePadId]], returns an [[#DeviceTypeInternal]].
 +
 
 +
== GetAbstractedPadHandles ==
 +
Takes a type-0xA output buffer containing an array of u64 '''AbstractedPadHandle''' and returns an output s32 for total entries.
 +
 
 +
Returns a handle for each controller detected by the system.
 +
 
 +
== GetAbstractedPadState ==
 +
Takes an input u64 '''AbstractedPadHandle''', returns an output [[#AbstractedPadState]].
 +
 
 +
== GetAbstractedPadsState ==
 +
Takes a type-0xA output buffer containing an array of u64 '''AbstractedPadHandle''', a type-0x22 output buffer containing an array of [[#AbstractedPadState]], and returns an output s32 for total entries.
 +
 
 +
== SetAutoPilotVirtualPadState ==
 +
Takes an input s8 '''AbstractedVirtualPadId''' and an input [[#AbstractedPadState]], no output.
 +
 
 +
== UnsetAutoPilotVirtualPadState ==
 +
Takes an input s8 '''AbstractedVirtualPadId''', no output.
 +
 
 +
Clears AutoPilot state for the specified pad.
 +
 
 +
== UnsetAllAutoPilotVirtualPadState ==
 +
No input/output.
 +
 
 +
Same as [[#UnsetAutoPilotVirtualPadState]] except this clears state for every pad.
 +
 
 +
== AttachHdlsWorkBuffer ==
 +
Takes an input TransferMemory handle and an u64 for the TransferMemory size, no output.
 +
 
 +
Official user-processes use TransferMemory size=0x1000 and permissions=RW.
 +
 
 +
This TransferMemory is used as input/output by the other Hdls commands.
 +
 
 +
Hdls is for virtual HID controllers.
 +
 
 +
== ReleaseHdlsWorkBuffer ==
 +
No input/output.
 +
 
 +
== DumpHdlsNpadAssignmentState ==
 +
No input/output.
 +
 
 +
After using this cmd, the output [[#HdlsNpadAssignment]] is located at tmem+0.
 +
 
 +
== DumpHdlsStates ==
 +
No input/output.
 +
 
 +
After using this cmd, the output [[#HdlsStateList]] struct is located at tmem+0.
 +
 
 +
== ApplyHdlsNpadAssignmentState ==
 +
Takes an input u8 bool, no output.
 +
 
 +
Prior to using this cmd, the input [[#HdlsNpadAssignment]] is written to tmem+0 by the user-process.
 +
 
 +
== ApplyHdlsStateList ==
 +
No input/output.
 +
 
 +
Prior to using this cmd, the input [[#HdlsStateList]] is written to tmem+0 by the user-process.
 +
 
 +
The [[#HdlsState]] will be applied for each HdlsHandle. If a HdlsHandle is not found, code similar to [[#AttachHdlsVirtualDevice]] will run with the [[#HdlsDeviceInfo]], then it will continue with applying state with the new device.
 +
 
 +
== AttachHdlsVirtualDevice ==
 +
Takes an [[#HdlsDeviceInfo]], returns a 8-byte '''HdlsHandle'''.
 +
 
 +
== DetachHdlsVirtualDevice ==
 +
Takes an input 8-byte '''HdlsHandle''', no output.
 +
 
 +
== SetHdlsState ==
 +
Takes an input [[#HdlsState]] and an input 8-byte '''HdlsHandle''', no output.
 +
 
 +
[9.0.0+] Input order was swapped: now takes an input 8-byte '''HdlsHandle''' and a [[#HdlsState]], no output.
 +
 
 +
= hid:sys =
 +
This is "nn::hid::IHidSystemServer".
 +
 
 +
{| class="wikitable" border="1"
 
|-
 
|-
| 305 || DisableAssigningSingleOnSlSrPress
+
! Cmd || Name
 
|-
 
|-
| 306 || GetLastActiveNpad
+
| 31 || SendKeyboardLockKeyEvent
 
|-
 
|-
| 307 || GetNpadSystemExtStyle
+
| 101 || AcquireHomeButtonEventHandle
 
|-
 
|-
| 308 || [5.0.0+] ApplyNpadSystemCommonPolicyFull
+
| 111 || ActivateHomeButton
 
|-
 
|-
| 309 || [5.0.0+] GetNpadFullKeyGripColor
+
| 121 || AcquireSleepButtonEventHandle
 
|-
 
|-
| 310 || [6.0.0+] GetMaskedSupportedNpadStyleSet
+
| 131 || ActivateSleepButton
 
|-
 
|-
| 311 || SetNpadPlayerLedBlinkingDevice
+
| 141 || AcquireCaptureButtonEventHandle
 
|-
 
|-
| 312 || [6.0.0+] SetSupportedNpadStyleSetAll
+
| 151 || ActivateCaptureButton
 
|-
 
|-
| 321 || [3.0.0+] [[#GetUniquePadsFromNpad]]
+
| 161 || [7.0.0+] GetPlatformConfig
 
|-
 
|-
| 322 || GetIrSensorState
+
| 210 || AcquireNfcDeviceUpdateEventHandle
 
|-
 
|-
| 323 || GetXcdHandleForNpadWithIrSensor
+
| 211 || GetNpadsWithNfc
 
|-
 
|-
| 500 || SetAppletResourceUserId
+
| 212 || AcquireNfcActivateEventHandle
 
|-
 
|-
| 501 || RegisterAppletResourceUserId
+
| 213 || ActivateNfc
 
|-
 
|-
| 502 || UnregisterAppletResourceUserId
+
| 214 || [4.0.0+] GetXcdHandleForNpadWithNfc
 
|-
 
|-
| 503 || EnableAppletToGetInput
+
| 215 || [4.0.0+] IsNfcActivated
 
|-
 
|-
| 504 || SetAruidValidForVibration
+
| 230 || AcquireIrSensorEventHandle
 
|-
 
|-
| 505 || EnableAppletToGetSixAxisSensor
+
| 231 || ActivateIrSensor
 
|-
 
|-
| 510 || [[#SetVibrationMasterVolume]]
+
| 232 || [10.0.0+] GetIrSensorState
 
|-
 
|-
| 511 || GetVibrationMasterVolume
+
| 233 || [10.0.0+] GetXcdHandleForNpadWithIrSensor
 
|-
 
|-
| 512 || BeginPermitVibrationSession
+
| 301 || ActivateNpadSystem
 
|-
 
|-
| 513 || EndPermitVibrationSession
+
| 303 || ApplyNpadSystemCommonPolicy
 
|-
 
|-
| 520 || EnableHandheldHids
+
| 304 || EnableAssigningSingleOnSlSrPress
 
|-
 
|-
| 521 || DisableHandheldHids
+
| 305 || DisableAssigningSingleOnSlSrPress
 
|-
 
|-
| 540 || AcquirePlayReportControllerUsageUpdateEvent
+
| 306 || GetLastActiveNpad
 
|-
 
|-
| 541 || GetPlayReportControllerUsages
+
| 307 || GetNpadSystemExtStyle
 
|-
 
|-
| 542 || AcquirePlayReportRegisteredDeviceUpdateEvent
+
| 308 || [5.0.0+] ApplyNpadSystemCommonPolicyFull
 
|-
 
|-
| 543 || GetRegisteredDevicesOld ([1.0.0-4.1.0] GetRegisteredDevices)
+
| 309 || [5.0.0+] GetNpadFullKeyGripColor
 
|-
 
|-
| 544 || AcquireConnectionTriggerTimeoutEvent
+
| 310 || [6.0.0+] [[#GetMaskedSupportedNpadStyleSet]]
 
|-
 
|-
| 545 || SendConnectionTrigger
+
| 311 || SetNpadPlayerLedBlinkingDevice
 
|-
 
|-
| 546 || AcquireDeviceRegisteredEventForControllerSupport
+
| 312 || [6.0.0+] SetSupportedNpadStyleSetAll
 
|-
 
|-
| 547 || GetAllowedBluetoothLinksCount
+
| 313 || [9.0.0+] GetNpadCaptureButtonAssignment
 
|-
 
|-
| 548 || [5.0.0+] GetRegisteredDevices
+
| 314 || [9.0.0+] GetAppletFooterUiType
 
|-
 
|-
| 549 || [6.0.0+] GetConnectableRegisteredDevices
+
| 315 || [9.0.0+] GetAppletDetailedUiType
 
|-
 
|-
| 700 || ActivateUniquePad
+
| 316 || [10.0.0+] GetNpadInterfaceType
 
|-
 
|-
| 702 || AcquireUniquePadConnectionEventHandle
+
| 317 || [10.0.0+] GetNpadLeftRightInterfaceType
 
|-
 
|-
| 703 || [[#GetUniquePadIds]]
+
| 318 || [10.0.0+] HasBattery
 
|-
 
|-
| 751 || AcquireJoyDetachOnBluetoothOffEventHandle
+
| 319 || [10.0.0+] HasLeftRightBattery
 
|-
 
|-
| 800 || ListSixAxisSensorHandles
+
| 321 || [3.0.0+] [[#GetUniquePadsFromNpad]]
 
|-
 
|-
| 801 || IsSixAxisSensorUserCalibrationSupported
+
| 322 || [10.0.0+] SetNpadSystemExtStateEnabled ([1.0.0-9.2.0] GetIrSensorState)
 
|-
 
|-
| 802 || ResetSixAxisSensorCalibrationValues
+
| 323 || [10.0.0+] GetLastActiveUniquePad ([1.0.0-9.2.0] GetXcdHandleForNpadWithIrSensor)
 
|-
 
|-
| 803 || StartSixAxisSensorUserCalibration
+
| 324 || [10.0.0+] GetUniquePadButtonSet
 
|-
 
|-
| 804 || CancelSixAxisSensorUserCalibration
+
| 325 || [10.0.0+] GetUniquePadColor
 
|-
 
|-
| 805 || GetUniquePadBluetoothAddress
+
| 326 || [10.0.0+] GetUniquePadAppletDetailedUiType
 
|-
 
|-
| 806 || DisconnectUniquePad
+
| 500 || SetAppletResourceUserId
 
|-
 
|-
| 807 || [5.0.0+] GetUniquePadType
+
| 501 || RegisterAppletResourceUserId
 
|-
 
|-
| 808 || [5.0.0+] GetUniquePadInterface
+
| 502 || UnregisterAppletResourceUserId
 
|-
 
|-
| 809 || [5.0.0+] GetUniquePadSerialNumber
+
| 503 || EnableAppletToGetInput
 
|-
 
|-
| 810 || [5.0.0+] GetUniquePadControllerNumber
+
| 504 || SetAruidValidForVibration
 
|-
 
|-
| 811 || [5.0.0+] GetSixAxisSensorUserCalibrationStage
+
| 505 || EnableAppletToGetSixAxisSensor
 
|-
 
|-
| 812 || [8.0.0+] GetConsoleUniqueSixAxisSensorHandle
+
| 510 || [[#SetVibrationMasterVolume]]
 
|-
 
|-
| 821 || StartAnalogStickManualCalibration
+
| 511 || GetVibrationMasterVolume
 
|-
 
|-
| 822 || RetryCurrentAnalogStickManualCalibrationStage
+
| 512 || [3.0.0+] BeginPermitVibrationSession
 
|-
 
|-
| 823 || CancelAnalogStickManualCalibration
+
| 513 || [3.0.0+] EndPermitVibrationSession
 
|-
 
|-
| 824 || ResetAnalogStickManualCalibration
+
| 520 || EnableHandheldHids
 
|-
 
|-
| 825 || [5.0.0+] GetAnalogStickState
+
| 521 || DisableHandheldHids
 
|-
 
|-
| 826 || [5.0.0+] GetAnalogStickManualCalibrationStage
+
| 522 || [9.0.0+] SetJoyConRailEnabled
 
|-
 
|-
| 827 || [5.0.0+] IsAnalogStickButtonPressed
+
| 523 || [9.0.0+] IsJoyConRailEnabled
 
|-
 
|-
| 828 || [5.0.0+] IsAnalogStickInReleasePosition
+
| 524 || [10.0.0+] IsHandheldHidsEnabled
 
|-
 
|-
| 829 || [5.0.0+] IsAnalogStickInCircumference
+
| 540 || AcquirePlayReportControllerUsageUpdateEvent
 
|-
 
|-
| 830 || [7.0.0+] [[#SetNotificationLedPattern]]
+
| 541 || GetPlayReportControllerUsages
 
|-
 
|-
| 850 || IsUsbFullKeyControllerEnabled
+
| 542 || AcquirePlayReportRegisteredDeviceUpdateEvent
 
|-
 
|-
| 851 || EnableUsbFullKeyController
+
| 543 || GetRegisteredDevicesOld ([1.0.0-4.1.0] GetRegisteredDevices)
 
|-
 
|-
| 852 || IsUsbConnected
+
| 544 || [3.0.0+] AcquireConnectionTriggerTimeoutEvent
 
|-
 
|-
| 870 || [5.1.0+] IsHandheldButtonPressedOnConsoleMode
+
| 545 || [3.0.0+] SendConnectionTrigger
 
|-
 
|-
| 900 || ActivateInputDetector
+
| 546 || [3.0.0+] AcquireDeviceRegisteredEventForControllerSupport
 
|-
 
|-
| 901 || [[#NotifyInputDetector]]
+
| 547 || [3.0.0+] GetAllowedBluetoothLinksCount
 
|-
 
|-
| 1000 || InitializeFirmwareUpdate
+
| 548 || [5.0.0+] GetRegisteredDevices
 
|-
 
|-
| 1001 || GetFirmwareVersion
+
| 549 || [6.0.0+] GetConnectableRegisteredDevices
 
|-
 
|-
| 1002 || GetAvailableFirmwareVersion
+
| 700 || ActivateUniquePad
 
|-
 
|-
| 1003 || IsFirmwareUpdateAvailable
+
| 702 || AcquireUniquePadConnectionEventHandle
 
|-
 
|-
| 1004 || CheckFirmwareUpdateRequired
+
| 703 || [[#GetUniquePadIds]]
 
|-
 
|-
| 1005 || StartFirmwareUpdate
+
| 751 || AcquireJoyDetachOnBluetoothOffEventHandle
 
|-
 
|-
| 1006 || AbortFirmwareUpdate
+
| 800 || ListSixAxisSensorHandles
 
|-
 
|-
| 1007 || GetFirmwareUpdateState
+
| 801 || IsSixAxisSensorUserCalibrationSupported
 
|-
 
|-
| 1008 || [4.0.0+] ActivateAudioControl
+
| 802 || ResetSixAxisSensorCalibrationValues
 
|-
 
|-
| 1009 || [4.0.0+] AcquireAudioControlEventHandle
+
| 803 || StartSixAxisSensorUserCalibration
 
|-
 
|-
| 1010 || [4.0.0+] GetAudioControlStates
+
| 804 || CancelSixAxisSensorUserCalibration
 
|-
 
|-
| 1011 || [4.0.0+] DeactivateAudioControl
+
| 805 || [3.0.0+] GetUniquePadBluetoothAddress
 
|-
 
|-
| 1050 || [5.0.0+] IsSixAxisSensorAccurateUserCalibrationSupported
+
| 806 || [3.0.0+] DisconnectUniquePad
 
|-
 
|-
| 1051 || [5.0.0+] StartSixAxisSensorAccurateUserCalibration
+
| 807 || [5.0.0+] [[#GetUniquePadType]]
 
|-
 
|-
| 1052 || [5.0.0+] CancelSixAxisSensorAccurateUserCalibration
+
| 808 || [5.0.0+] GetUniquePadInterface
 
|-
 
|-
| 1053 || [5.0.0+] GetSixAxisSensorAccurateUserCalibrationState
+
| 809 || [5.0.0+] GetUniquePadSerialNumber
 
|-
 
|-
| 1100 || [5.0.0+] GetHidbusSystemServiceObject
+
| 810 || [5.0.0+] GetUniquePadControllerNumber
 
|-
 
|-
| 1120 || [6.0.0+] SetFirmwareHotfixUpdateSkipEnabled
+
| 811 || [5.0.0+] GetSixAxisSensorUserCalibrationStage
 
|-
 
|-
| 1130 || [6.0.0+] InitializeUsbFirmwareUpdate
+
| 812 || [8.0.0+] GetConsoleUniqueSixAxisSensorHandle
 
|-
 
|-
| 1131 || [6.0.0+] FinalizeUsbFirmwareUpdate
+
| 821 || StartAnalogStickManualCalibration
 
|-
 
|-
| 1132 || [6.0.0+] CheckUsbFirmwareUpdateRequired
+
| 822 || RetryCurrentAnalogStickManualCalibrationStage
 
|-
 
|-
| 1133 || [6.0.0+] StartUsbFirmwareUpdate
+
| 823 || CancelAnalogStickManualCalibration
 
|-
 
|-
| 1134 || [6.0.0+] GetUsbFirmwareUpdateState
+
| 824 || ResetAnalogStickManualCalibration
 
|-
 
|-
| 1150 || [8.0.0+] SetTouchScreenMagnification
+
| 825 || [5.0.0+] GetAnalogStickState
|}
 
 
 
== 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
+
| 826 || [5.0.0+] GetAnalogStickManualCalibrationStage
 
|-
 
|-
| 0x0 || 0x1 || 0x0 || Low || Mini Cycle Base Duration. Value 0x1-0xF: 12.5ms - 187.5ms. Value 0x0 = 0ms/OFF.
+
| 827 || [5.0.0+] IsAnalogStickButtonPressed
 
|-
 
|-
| 0x1 || 0x1 || 0x0 || High || Number of Mini Cycles + 1. Value 0x0-0xF: 1 - 16 mini cycles.
+
| 828 || [5.0.0+] IsAnalogStickInReleasePosition
 
|-
 
|-
| 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.
+
| 829 || [5.0.0+] IsAnalogStickInCircumference
 
|-
 
|-
| 0x3 || 0x1 || 0x1 || High || LED Start Intensity. Value 0x0-0xF: 0% - 100%. (In HW, 1 - 241 duty)
+
| 830 || [7.0.0+] [[#SetNotificationLedPattern]]
 
|-
 
|-
| 0x4 || 0x1 || 0x2 || High || Mini Cycle 1 LED Intensity. Value 0x0-0xF: 0% - 100%. (In HW, 1 - 241 duty)
+
| 831 || [9.0.0+] [[#SetNotificationLedPatternWithTimeout]]
 
|-
 
|-
| 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.
+
| 832 || [9.0.0+] [[#PrepareHidsForNotificationWake]]
 
|-
 
|-
| 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.
+
| 850 || [3.0.0+] IsUsbFullKeyControllerEnabled
 
|-
 
|-
| 0x7 || 0x1 || || || Unused
+
| 851 || [3.0.0+] EnableUsbFullKeyController
 
|-
 
|-
| 0x8 || 0x1 || 0x2 || Low || Mini Cycle 2 LED Intensity.
+
| 852 || [3.0.0+] IsUsbConnected
 
|-
 
|-
| 0x9 || 0x1 || 0x4 || High || Fading Transition Steps to Mini Cycle 2 (see above).
+
| 870 || [5.1.0+] IsHandheldButtonPressedOnConsoleMode
 
|-
 
|-
| 0xA || 0x1 || 0x4 || Low || Final Step Duration Multiplier of Mini Cycle 2 (see above).
+
| 900 || [1.0.0-9.2.0] ActivateInputDetector
 
|-
 
|-
| 0xB || 0x1 || || || Unused
+
| 901 || [1.0.0-9.2.0] [[#NotifyInputDetector]]
 
|-
 
|-
| 0xC || 0x1 || 0x5 || High || Mini Cycle 3 LED Intensity.
+
| 1000 || [3.0.0+] InitializeFirmwareUpdate
 
|-
 
|-
| 0xD || 0x1 || 0x6 || High || Fading Transition Steps to Mini Cycle 3 (see above).
+
| 1001 || [3.0.0+] GetFirmwareVersion
 
|-
 
|-
| 0xE || 0x1 || 0x6 || Low || Final Step Duration Multiplier of Mini Cycle 3 (see above).
+
| 1002 || [3.0.0+] GetAvailableFirmwareVersion
 
|-
 
|-
| 0xF || 0x1 || || || Unused
+
| 1003 || [3.0.0+] IsFirmwareUpdateAvailable
 
|-
 
|-
| 0x10 || 0x1 || 0x5 || Low || Mini Cycle 4 LED Intensity.
+
| 1004 || [3.0.0+] CheckFirmwareUpdateRequired
 
|-
 
|-
| 0x11 || 0x1 || 0x7 || High || Fading Transition Duration to Mini Cycle 4 (see above).
+
| 1005 || [3.0.0+] StartFirmwareUpdate
 
|-
 
|-
| 0x12 || 0x1 || 0x7 || Low || Final Step Duration Multiplier of Mini Cycle 4 (see above).
+
| 1006 || [3.0.0+] AbortFirmwareUpdate
 
|-
 
|-
| 0x13 || 0x1 || || || Unused
+
| 1007 || [3.0.0+] GetFirmwareUpdateState
 
|-
 
|-
| 0x14 || 0x1 || 0x8 || High || Mini Cycle 5 LED Intensity.
+
| 1008 || [4.0.0+] ActivateAudioControl
 
|-
 
|-
| 0x15 || 0x1 || 0x9 || High || Fading Transition Steps to Mini Cycle 5 (see above).
+
| 1009 || [4.0.0+] AcquireAudioControlEventHandle
 
|-
 
|-
| 0x16 || 0x1 || 0x9 || Low || Final Step Duration Multiplier of Mini Cycle 5 (see above).
+
| 1010 || [4.0.0+] GetAudioControlStates
 
|-
 
|-
| 0x17 || 0x1 || || || Unused
+
| 1011 || [4.0.0+] DeactivateAudioControl
 
|-
 
|-
| 0x18 || 0x1 || 0x8 || Low || Mini Cycle 6 LED Intensity.
+
| 1050 || [5.0.0+] IsSixAxisSensorAccurateUserCalibrationSupported
 
|-
 
|-
| 0x19 || 0x1 || 0xA || High || Fading Transition Steps to Mini Cycle 6 (see above).
+
| 1051 || [5.0.0+] StartSixAxisSensorAccurateUserCalibration
 
|-
 
|-
| 0x1A || 0x1 || 0xA || Low || Final Step Duration Multiplier of Mini Cycle 6 (see above).
+
| 1052 || [5.0.0+] CancelSixAxisSensorAccurateUserCalibration
 
|-
 
|-
| 0x1B || 0x1 || || || Unused
+
| 1053 || [5.0.0+] GetSixAxisSensorAccurateUserCalibrationState
 
|-
 
|-
| 0x1C || 0x1 || 0xB || High || Mini Cycle 7 LED Intensity.
+
| 1100 || [5.0.0+] [[#GetHidbusSystemServiceObject]]
 
|-
 
|-
| 0x1D || 0x1 || 0xC || High || Fading Transition Steps  to Mini Cycle 7 (see above).
+
| 1120 || [6.0.0+] SetFirmwareHotfixUpdateSkipEnabled
 
|-
 
|-
| 0x1E || 0x1 || 0xC || Low || Final Step Duration Multiplier of Mini Cycle 7 (see above).
+
| 1130 || [6.0.0+] InitializeUsbFirmwareUpdate
 
|-
 
|-
| 0x1F || 0x1 || || || Unused
+
| 1131 || [6.0.0+] FinalizeUsbFirmwareUpdate
 
|-
 
|-
| 0x20 || 0x1 || 0xB || Low || Mini Cycle 8 LED Intensity.
+
| 1132 || [6.0.0+] CheckUsbFirmwareUpdateRequired
 
|-
 
|-
| 0x21 || 0x1 || 0xD || Low || Fading Transition Steps to Mini Cycle 8 (see above).
+
| 1133 || [6.0.0+] StartUsbFirmwareUpdate
 
|-
 
|-
| 0x22 || 0x1 || 0xD || High || Final Step Duration Multiplier of Mini Cycle 8 (see above).
+
| 1134 || [6.0.0+] GetUsbFirmwareUpdateState
 
|-
 
|-
| 0x23 || 0x1 || || || Unused
+
| 1150 || [8.0.0+] SetTouchScreenMagnification
 
|-
 
|-
| 0x24 || 0x1 || 0xE || High || Mini Cycle 9 LED Intensity.
+
| 1151 || [9.0.0+] GetTouchScreenFirmwareVersion
 
|-
 
|-
| 0x25 || 0x1 || 0xF || High || Fading Transition Steps to Mini Cycle 9 (see above).
+
| 1152 || [9.0.0+] SetTouchScreenDefaultConfiguration
 
|-
 
|-
| 0x26 || 0x1 || 0xF || Low || Final Step Duration Multiplier of Mini Cycle 9 (see above).
+
| 1153 || [9.0.0+] GetTouchScreenDefaultConfiguration
 
|-
 
|-
| 0x27 || 0x1 || || || Unused
+
| 1154 || [9.0.0+] IsFirmwareAvailableForNotification
 
|-
 
|-
| 0x28 || 0x1 || 0xE || Low || Mini Cycle 10 LED Intensity.
+
| 1155 || [9.0.0+] SetForceHandheldStyleVibration
 
|-
 
|-
| 0x29 || 0x1 || 0x10 || High || Fading Transition Steps to Mini Cycle 10 (see above).
+
| 1156 || [9.0.0+] SendConnectionTriggerWithoutTimeoutEvent
 
|-
 
|-
| 0x2A || 0x1 || 0x10 || Low || Final Step Duration Multiplier of Mini Cycle 10 (see above).
+
| 1157 || [10.0.0+] [[#CancelConnectionTrigger]]
 
|-
 
|-
| 0x2B || 0x1 || || || Unused
+
| 1200 || [10.0.0+] [[#IsButtonConfigSupported]]
 
|-
 
|-
| 0x2C || 0x1 || 0x11 || High || Mini Cycle 11 LED Intensity.
+
| 1201 || [10.0.0+] [[#DeleteButtonConfig]]
 
|-
 
|-
| 0x2D || 0x1 || 0x12 || High || Fading Transition Steps to Mini Cycle 11 (see above).
+
| 1202 || [10.0.0+] [[#SetButtonConfigEnabled]]
 
|-
 
|-
| 0x2E || 0x1 || 0x12 || Low || Final Step Duration Multiplier of Mini Cycle 11 (see above).
+
| 1203 || [10.0.0+] [[#IsButtonConfigEnabled]]
 
|-
 
|-
| 0x2F || 0x1 || || || Unused
+
| 1204 || [10.0.0+] [[#SetButtonConfigEmbedded]]
 
|-
 
|-
| 0x30 || 0x1 || 0x11 || Low || Mini Cycle 12 LED Intensity.
+
| 1205 || [10.0.0+] [[#SetButtonConfigFull]]
 
|-
 
|-
| 0x31 || 0x1 || 0x13 || High || Fading Transition Steps to Mini Cycle 12 (see above).
+
| 1206 || [10.0.0+] [[#SetButtonConfigLeft]]
 
|-
 
|-
| 0x32 || 0x1 || 0x13 || Low || Final Step Duration Multiplier of Mini Cycle 12 (see above).
+
| 1207 || [10.0.0+] [[#SetButtonConfigRight]]
 
|-
 
|-
| 0x33 || 0x1 || || || Unused
+
| 1208 || [10.0.0+] [[#GetButtonConfigEmbedded]]
 
|-
 
|-
| 0x34 || 0x1 || 0x14 || High || Mini Cycle 13 LED Intensity.
+
| 1209 || [10.0.0+] [[#GetButtonConfigFull]]
 
|-
 
|-
| 0x35 || 0x1 || 0x15 || High || Fading Transition Steps to Mini Cycle 13 (see above).
+
| 1210 || [10.0.0+] [[#GetButtonConfigLeft]]
 
|-
 
|-
| 0x36 || 0x1 || 0x15 || Low || Final Step Duration Multiplier of Mini Cycle 13 (see above).
+
| 1211 || [10.0.0+] [[#GetButtonConfigRight]]
 
|-
 
|-
| 0x37 || 0x1 || || || Unused
+
| 1250 || [10.0.0+] [[#IsCustomButtonConfigSupported]]
 
|-
 
|-
| 0x38 || 0x1 || 0x14 || Low || Mini Cycle 14 LED Intensity.
+
| 1251 || [10.0.0+] [[#IsDefaultButtonConfigEmbedded]]
 
|-
 
|-
| 0x39 || 0x1 || 0x16 || High || Fading Transition Steps to Mini Cycle 14 (see above).
+
| 1252 || [10.0.0+] [[#IsDefaultButtonConfigFull]]
 
|-
 
|-
| 0x3A || 0x1 || 0x16 || Low || Final Step Duration Multiplier of Mini Cycle 14 (see above).
+
| 1253 || [10.0.0+] [[#IsDefaultButtonConfigLeft]]
 
|-
 
|-
| 0x3B || 0x1 || || || Unused
+
| 1254 || [10.0.0+] [[#IsDefaultButtonConfigRight]]
 
|-
 
|-
| 0x3C || 0x1 || 0x17 || High || Mini Cycle 15 LED Intensity.
+
| 1255 || [10.0.0+] [[#IsButtonConfigStorageEmbeddedEmpty]]
 
|-
 
|-
| 0x3D || 0x1 || 0x18 || High || Fading Transition Steps to Mini Cycle 15 (see above).
+
| 1256 || [10.0.0+] [[#IsButtonConfigStorageFullEmpty]]
 
|-
 
|-
| 0x3E || 0x1 || 0x18 || Low || Final Step Duration Multiplier of Mini Cycle 15 (see above).
+
| 1257 || [10.0.0+] [[#IsButtonConfigStorageLeftEmpty]]
 
|-
 
|-
| 0x3F || 0x1 || || || Unused
+
| 1258 || [10.0.0+] [[#IsButtonConfigStorageRightEmpty]]
 
|-
 
|-
| 0x40 || 0x1 || 0x17 || Low || Mini Cycle 16 LED Intensity.
+
| 1259 || [10.0.0+] [[#GetButtonConfigStorageEmbedded]]
 
|-
 
|-
| 0x41 || 0x1 || 0x19 || High || Fading Transition Steps to Mini Cycle 16 (see above). (Unused in older Joy-Con / Pro-Con FW. Unknown for new.)
+
| 1260 || [10.0.0+] [[#GetButtonConfigStorageFull]]
 
|-
 
|-
| 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.)
+
| 1261 || [10.0.0+] [[#GetButtonConfigStorageLeft]]
 
|-
 
|-
| 0x43 || 0x1 || || || Unused
+
| 1262 || [10.0.0+] [[#GetButtonConfigStorageRight]]
 
|-
 
|-
| 0x44 || 0x1 || 0x1A || High || Unknown (Unused in older Joy-Con / Pro-Con FW. Unknown for new.)
+
| 1263 || [10.0.0+] [[#SetButtonConfigStorageEmbedded]]
 
|-
 
|-
| 0x45 || 0x1 || 0x1A || Low || Unknown (Unused in older Joy-Con / Pro-Con FW. Unknown for new.)
+
| 1264 || [10.0.0+] [[#SetButtonConfigStorageFull]]
 
|-
 
|-
| 0x46 || 0x1 || || || Padding
+
| 1265 || [10.0.0+] [[#SetButtonConfigStorageLeft]]
 
|-
 
|-
| 0x47 || 0x1 || || || Padding
+
| 1266 || [10.0.0+] [[#SetButtonConfigStorageRight]]
 
|-
 
|-
|}
+
| 1267 || [10.0.0+] [[#DeleteButtonConfigStorageEmbedded]]
 
 
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
+
| 1268 || [10.0.0+] [[#DeleteButtonConfigStorageFull]]
 
|-
 
|-
| 0x0 || 0x1B || See above.
+
| 1269 || [10.0.0+] [[#DeleteButtonConfigStorageLeft]]
 
|-
 
|-
| 0x1B || 0xB || Cleared to zero.
+
| 1270 || [10.0.0+] [[#DeleteButtonConfigStorageRight]]
 
|-
 
|-
| 0x26 || 0x5 || Unused
+
| 1271 || [10.0.0+] [[#IsUsingCustomButtonConfig]]
 
|-
 
|-
| 0x2B || 0x8 || Set to an input value, which is hard-coded 0.
+
| 1272 || [10.0.0+] [[#IsAnyCustomButtonConfigEnabled]]
 
|-
 
|-
| 0x33 || 0x2 || Set to value 0.
+
| 1273 || [10.0.0+] [[#SetAllCustomButtonConfigEnabled]]
 
|-
 
|-
| 0x35 || 0x1 || Set to value 1.
+
| 1274 || [10.0.0+] [[#SetDefaultButtonConfig]]
|}
 
 
 
= hid:tmp =
 
This is "nn::hid::IHidTemporaryServer".
 
 
 
This service no longer exists in [8.0.0+].
 
 
 
{| class="wikitable" border="1"
 
 
|-
 
|-
! Cmd || Name
+
| 1275 || [10.0.0+] [[#SetAllDefaultButtonConfig]]
 
|-
 
|-
| 0 || GetConsoleSixAxisSensorCalibrationValues
+
| 1276 || [10.0.0+] [[#SetHidButtonConfigEmbedded]]
|}
 
 
 
= irs =
 
This is "nn::irsensor::IIrSensorServer".
 
 
 
{| class="wikitable" border="1"
 
 
|-
 
|-
! Cmd || Name
+
| 1277 || [10.0.0+] [[#SetHidButtonConfigFull]]
 
|-
 
|-
| 302 || [[#ActivateIrsensor]]
+
| 1278 || [10.0.0+] [[#SetHidButtonConfigLeft]]
 
|-
 
|-
| 303 || [[#DeactivateIrsensor]]
+
| 1279 || [10.0.0+] [[#SetHidButtonConfigRight]]
 
|-
 
|-
| 304 || [[#GetIrsensorSharedMemoryHandle]]
+
| 1280 || [10.0.0+] [[#GetHidButtonConfigEmbedded]]
 
|-
 
|-
| 305 || [[#StopImageProcessor]]
+
| 1281 || [10.0.0+] [[#GetHidButtonConfigFull]]
 
|-
 
|-
| 306 || [[#RunMomentProcessor]]
+
| 1282 || [10.0.0+] [[#GetHidButtonConfigLeft]]
 
|-
 
|-
| 307 || [[#RunClusteringProcessor]]
+
| 1283 || [10.0.0+] [[#GetHidButtonConfigRight]]
|-
+
|}
| 308 || [[#RunImageTransferProcessor]]
+
 
|-
+
== GetMaskedSupportedNpadStyleSet ==
| 309 || [[#GetImageTransferProcessorState]]
+
Takes an input u64 AppletResourceUserId, returns an output u32 [[#NpadStyleTag]].
|-
+
 
| 310 || [[#RunTeraPluginProcessor]]
+
Official sw uses the output from [[Applet_Manager_services|GetAppletResourceUserIdOfCallerApplet]] with this.
|-
+
 
| 311 || [[#GetNpadIrCameraHandle]]
+
== GetUniquePadsFromNpad ==
|-
+
Takes an input u32 [[#NpadIdType]], a type-0xA output buffer, and returns an output s64 for total output entries (which is copied to a s32 by official sw).
| 312 || [[#RunPointingProcessor]]
+
 
|-
+
The output buffer contains an array of [[#UniquePadId]].
| 313 || [[#SuspendImageProcessor]]
+
 
|-
+
== SetVibrationMasterVolume ==
| 314 || [3.0.0+] [[#CheckFirmwareVersion]]
+
Takes an input 32bit float.
|-
+
 
| 315 || [5.0.0+] SetFunctionLevel
+
== GetUniquePadIds ==
|-
+
Takes a type-0xA output buffer, and returns an output s64 for total output entries (which is copied to a s32 by official sw).
| 316 || [5.0.0+] RunImageTransferExProcessor
 
|-
 
| 317 || [5.0.0+] RunIrLedProcessor
 
|-
 
| 318 || [5.0.0+] StopImageProcessorAsync
 
|-
 
| 319 || [5.0.0+] ActivateIrsensorWithFunctionLevel
 
|}
 
  
== ActivateIrsensor ==
+
The output buffer contains an array of [[#UniquePadId]].
Takes a PID-descriptor and an [[AM_services|AppletResourceUserId]]. No output.
 
  
== DeactivateIrsensor ==
+
== GetUniquePadType ==
Takes a PID-descriptor and an [[AM_services|AppletResourceUserId]]. No output.
+
Takes an input [[#UniquePadId]] and returns an output u64 [[#UniquePadType]].
  
== GetIrsensorSharedMemoryHandle ==
+
== SetNotificationLedPattern ==
Takes a PID-descriptor and an [[AM_services|AppletResourceUserId]]. Returns a SharedMemory handle.
+
Takes an input [[#NotificationLedPattern]] and an [[#UniquePadId]], no output.
  
The SharedMemory is mapped with permissions=read-only and size=0x8000.
+
The specified controller must have a HOME button.
  
== StopImageProcessor ==
+
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].
Takes a PID-descriptor, an [[#IrCameraHandle]], and an [[AM_services|AppletResourceUserId]]. No output.
 
  
== RunMomentProcessor ==
+
[9.0.0+] This runs code similar to [[#SetNotificationLedPatternWithTimeout]], except it passes the following param values to an internal func: flag=1 and TimeSpan=0 (with [[#SetNotificationLedPatternWithTimeout]] these are flag=0 and TimeSpan={input value}).
Takes a PID-descriptor, an [[#IrCameraHandle]], an [[AM_services|AppletResourceUserId]], and a [[#PackedMomentProcessorConfig]]. No output.
 
  
== RunClusteringProcessor ==
+
== SetNotificationLedPatternWithTimeout ==
Takes a PID-descriptor, an [[#IrCameraHandle]], an [[AM_services|AppletResourceUserId]], and a [[#PackedClusteringProcessorConfig]]. No output.
+
Takes an input [[#NotificationLedPattern]], an [[#UniquePadId]], and an s64 TimeSpan, no output.
 +
 
 +
== PrepareHidsForNotificationWake ==
 +
Takes a type-0x9 input buffer containing an array of [[#UniquePadId]], no output.
 +
 
 +
== NotifyInputDetector ==
 +
Takes an input u32 bitmask InputSourceId, no output.
 +
 
 +
This is the only hid:sys command used by USB-sysmodule (with value 0x40).
 +
 
 +
== GetHidbusSystemServiceObject ==
 +
No input, returns an [[#IHidbusSystemServer]].
 +
 
 +
== CancelConnectionTrigger ==
 +
Takes an input "nn::bluetooth::Address", no output.
 +
 
 +
== IsButtonConfigSupported ==
 +
Takes an input [[#UniquePadId]], returns an output bool.
  
== RunImageTransferProcessor ==
+
== DeleteButtonConfig ==
Takes a PID-descriptor, an [[#IrCameraHandle]], an [[AM_services|AppletResourceUserId]], a [[#PackedImageTransferProcessorConfig]], an u64 for the TransferMemory_size, and a TransferMemory handle. No output.
+
Takes an input [[#UniquePadId]], no output.
  
Official sw creates the TransferMemory with an user-specified buffer and permissions=0.
+
== SetButtonConfigEnabled ==
 +
Takes an input bool, an [[#UniquePadId]], no output.
  
== GetImageTransferProcessorState ==
+
== IsButtonConfigEnabled ==
Takes a PID-descriptor, a type-0x6 output buffer, an [[#IrCameraHandle]], and an [[AM_services|AppletResourceUserId]]. Returns an [[#ImageTransferProcessorState]]. No output.
+
Takes an input [[#UniquePadId]], returns an output bool.
  
== RunTeraPluginProcessor==
+
== SetButtonConfigEmbedded ==
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedTeraPluginProcessorConfig]] (immediately after the previous word), and an [[AM_services|AppletResourceUserId]]. No output.
+
Takes an input [[#UniquePadId]], a type-0x15 input buffer containing a [[#SystemButtonConfigEmbedded]], no output.
  
== GetNpadIrCameraHandle ==
+
== SetButtonConfigFull ==
Takes an input u32. Returns an output [[#IrCameraHandle]].
+
Takes an input [[#UniquePadId]], a type-0x15 input buffer containing a [[#SystemButtonConfigFull]], no output.
  
== RunPointingProcessor ==
+
== SetButtonConfigLeft ==
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedDpdProcessorConfig]] (immediately after the previous word), and an [[AM_services|AppletResourceUserId]]. No output.
+
Takes an input [[#UniquePadId]], a type-0x15 input buffer containing a [[#SystemButtonConfigLeft]], no output.
  
== SuspendImageProcessor ==
+
== SetButtonConfigRight ==
Takes a PID-descriptor, an [[#IrCameraHandle]], and an [[AM_services|AppletResourceUserId]]. No output.
+
Takes an input [[#UniquePadId]], a type-0x15 input buffer containing a [[#SystemButtonConfigRight]], no output.
  
== CheckFirmwareVersion ==
+
== GetButtonConfigEmbedded ==
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedMcuVersion]], and an [[AM_services|AppletResourceUserId]]. No output.
+
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#SystemButtonConfigEmbedded]].
  
== IrCameraHandle ==
+
== GetButtonConfigFull ==
This is an u32.
+
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#SystemButtonConfigFull]].
  
== PackedMomentProcessorConfig ==
+
== GetButtonConfigLeft ==
This is a 0x20-byte struct. This is converted from another structure by the official user-process.
+
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#SystemButtonConfigLeft]].
  
{| class="wikitable" border="1"
+
== GetButtonConfigRight ==
|-
+
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#SystemButtonConfigRight]].
! Offset || Size || Description || DefaultConfig
+
 
|-
+
== IsCustomButtonConfigSupported ==
| 0x0 || 0x8 || ? || 0x493E0
+
Takes an input [[#UniquePadId]], returns an output bool.
|-
+
 
| 0x8 || 0x1 || ? || 0x0
+
== IsDefaultButtonConfigEmbedded ==
|-
+
Takes a type-0x15 input buffer containing a [[#ButtonConfigEmbedded]], returns an output bool.
| 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 compares the input config with config in state, sets the output bool to whether these match, then returns 0.
This is a 0x28-byte struct.
 
  
== PackedImageTransferProcessorConfig ==
+
== IsDefaultButtonConfigFull ==
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.
+
Takes a type-0x15 input buffer containing a [[#ButtonConfigFull]], returns an output bool.
  
== ImageTransferProcessorState ==
+
This compares the input config with config in state, sets the output bool to whether these match, then returns 0.
This is a 0x10-byte struct.
 
  
== PackedTeraPluginProcessorConfig ==
+
== IsDefaultButtonConfigLeft ==
This is an u64.
+
Takes a type-0x15 input buffer containing a [[#ButtonConfigLeft]], returns an output bool.
  
== PackedDpdProcessorConfig ==
+
This compares the input config with config in state, sets the output bool to whether these match, then returns 0.
This is a 0x10-byte struct.
 
  
== PackedMcuVersion ==
+
== IsDefaultButtonConfigRight ==
This is an u32.
+
Takes a type-0x15 input buffer containing a [[#ButtonConfigRight]], returns an output bool.
  
= irs:sys =
+
This compares the input config with config in state, sets the output bool to whether these match, then returns 0.
This is "nn::irsensor::IIrSensorSystemServer".
 
  
{| class="wikitable" border="1"
+
== IsButtonConfigStorageEmbeddedEmpty ==
|-
+
Takes an input s32 entry-index, returns an output bool.
! Cmd || Name
 
|-
 
| 500 || SetAppletResourceUserId
 
|-
 
| 501 || RegisterAppletResourceUserId
 
|-
 
| 502 || UnregisterAppletResourceUserId
 
|-
 
| 503 || EnableAppletToGetInput
 
|}
 
  
= ahid:cd =
+
Uses [[Settings_services#GetButtonConfigSettingsEmbedded|GetButtonConfigSettingsEmbedded]] with count=5 (output s32 ignored). The input entry-index is used with this array. Then the output bool is set to [[Settings_services#ButtonConfigSettings|IsFull]] bit0 == 0. Then 0 is returned.
This is "nn::ahid::IServerSession".
 
  
Used for USB HID devices.  
+
== IsButtonConfigStorageFullEmpty ==
 +
Takes an input s32 entry-index, returns an output bool.
  
{| class="wikitable" border="1"
+
Same as [[#IsButtonConfigStorageEmbeddedEmpty]] except with a different setsys cmd.
|-
+
 
! Cmd || Name || Notes
+
== IsButtonConfigStorageLeftEmpty ==
|-
+
Takes an input s32 entry-index, returns an output bool.
| 0 || || Takes an input s32, no output.
+
 
|-
+
Same as [[#IsButtonConfigStorageEmbeddedEmpty]] except with a different setsys cmd.
| 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 ==
+
== IsButtonConfigStorageRightEmpty ==
This is "nn::ahid::ICtrlSession".
+
Takes an input s32 entry-index, returns an output bool.
  
{| class="wikitable" border="1"
+
Same as [[#IsButtonConfigStorageEmbeddedEmpty]] except with a different setsys cmd.
|-
 
! 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.
+
== GetButtonConfigStorageEmbedded ==
 +
Takes an input s32 entry-index, and a type-0x16 output buffer containing a [[#ButtonConfigEmbedded]].
  
== IReadSession ==
+
Uses [[Settings_services#GetButtonConfigSettingsEmbedded|GetButtonConfigSettingsEmbedded]] with count=5 (output s32 ignored). The input entry-index is used with this array. Then an error is thrown if [[Settings_services#ButtonConfigSettings|IsFull]] bit0 is clear. Then the data at +0x1C8 is converted to [[#ButtonConfigEmbedded]], copied to output, and returns 0.
This is "nn::ahid::IReadSession".
 
  
{| class="wikitable" border="1"
+
== GetButtonConfigStorageFull ==
|-
+
Takes an input s32 entry-index, and a type-0x16 output buffer containing a [[#ButtonConfigFull]].
! Cmd || Name || Notes
+
 
|-
+
Same as [[#GetButtonConfigStorageEmbedded]], except this uses a different setsys cmd, and uses a different conversion func / different output struct.
| 0 || ||
+
 
|}
+
== GetButtonConfigStorageLeft ==
 +
Takes an input s32 entry-index, and a type-0x16 output buffer containing a [[#ButtonConfigLeft]].
  
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.
+
Same as [[#GetButtonConfigStorageEmbedded]], except this uses a different setsys cmd, and uses a different conversion func / different output struct.
  
== IWriteSession ==
+
== GetButtonConfigStorageRight ==
This is "nn::ahid::IWriteSession".
+
Takes an input s32 entry-index, and a type-0x16 output buffer containing a [[#ButtonConfigRight]].
  
{| class="wikitable" border="1"
+
Same as [[#GetButtonConfigStorageEmbedded]], except this uses a different setsys cmd, and uses a different conversion func / different output struct.
|-
 
! Cmd || Name || Notes
 
|-
 
| 0 || || This is the inverse of [[#IReadSession]] cmd0. Uses the OUTPUT endpoint with an input buffer.
 
|}
 
  
= ahid:hdr =
+
== SetButtonConfigStorageEmbedded ==
This is "nn::ahid::hdr::ISession".
+
Takes an input s32 entry-index, and a type-0x15 input buffer containing a [[#ButtonConfigEmbedded]].
  
Used internally for USB HID devices.
+
If the input config matches the [[#IsDefaultButtonConfigEmbedded|default]], this first does:
 +
* Uses [[Settings_services#GetButtonConfigSettingsEmbedded|GetButtonConfigSettingsEmbedded]] with count=5 (output s32 ignored). The input entry-index is used with this array. When [[Settings_services#ButtonConfigSettings|IsFull]] is set, the config is deleted the same way as [[#DeleteButtonConfigStorageEmbedded]] (following the IsFull check).
  
{| class="wikitable" border="1"
+
Afterwards, this uses [[Settings_services#GetButtonConfigSettingsEmbedded|GetButtonConfigSettingsEmbedded]] with count=5 (output s32 ignored). The input entry-index is used with this array. The input struct is converted, the output from that is copied to +0x1C8 size 0x3E0, IsFull is set, [[Settings_services#SetButtonConfigSettingsEmbedded|SetButtonConfigSettingsEmbedded]] is used with the updated array, and then returns 0.
|-
 
! Cmd || Name
 
|-
 
| 0 ||
 
|-
 
| 1 ||
 
|-
 
| 2 ||
 
|-
 
| 3 ||
 
|-
 
| 4 ||
 
|-
 
| 5 || [6.0.0+]
 
|}
 
  
= xcd:sys =
+
== SetButtonConfigStorageFull ==
This is "nn::xcd::detail::ISystemServer".
+
Takes an input s32 entry-index, and a type-0x15 input buffer containing a [[#ButtonConfigFull]].
  
{| class="wikitable" border="1"
+
Same as [[#SetButtonConfigStorageEmbedded]], except this uses different setsys cmds, and uses a different structs etc.
 +
 
 +
== SetButtonConfigStorageLeft ==
 +
Takes an input s32 entry-index, and a type-0x15 input buffer containing a [[#ButtonConfigLeft]].
 +
 
 +
Same as [[#SetButtonConfigStorageEmbedded]], except this uses different setsys cmds, and uses a different structs etc.
 +
 
 +
== SetButtonConfigStorageRight ==
 +
Takes an input s32 entry-index, and a type-0x15 input buffer containing a [[#ButtonConfigRight]].
 +
 
 +
Same as [[#SetButtonConfigStorageEmbedded]], except this uses different setsys cmds, and uses a different structs etc.
 +
 
 +
== DeleteButtonConfigStorageEmbedded ==
 +
Takes an input s32 entry-index, no output.
 +
 
 +
Uses [[Settings_services#GetButtonConfigSettingsEmbedded|GetButtonConfigSettingsEmbedded]] with count=5 (output s32 ignored). The input entry-index is used with this array. Then an error is thrown if [[Settings_services#ButtonConfigSettings|IsFull]] bit0 is clear. Then the data at +0x1C8 size 0x3E0 is cleared, IsFull bit0 is cleared, [[Settings_services#SetButtonConfigSettingsEmbedded|SetButtonConfigSettingsEmbedded]] is used with the updated array, and then returns 0.
 +
 
 +
== DeleteButtonConfigStorageFull ==
 +
Takes an input s32 entry-index, no output.
 +
 
 +
Same as [[#IsButtonConfigStorageEmbeddedEmpty]] except with different setsys cmds.
 +
 
 +
== DeleteButtonConfigStorageLeft ==
 +
Takes an input s32 entry-index, no output.
 +
 
 +
Same as [[#IsButtonConfigStorageEmbeddedEmpty]] except with different setsys cmds.
 +
 
 +
== DeleteButtonConfigStorageRight ==
 +
Takes an input s32 entry-index, no output.
 +
 
 +
Same as [[#IsButtonConfigStorageEmbeddedEmpty]] except with different setsys cmds.
 +
 
 +
== IsUsingCustomButtonConfig ==
 +
Takes an input [[#UniquePadId]], returns an output bool.
 +
 
 +
== IsAnyCustomButtonConfigEnabled ==
 +
No input, returns an output bool.
 +
 
 +
== SetAllCustomButtonConfigEnabled ==
 +
Takes an input bool and an AppletResourceUserId, no output.
 +
 
 +
== SetDefaultButtonConfig ==
 +
Takes an input [[#UniquePadId]], no output.
 +
 
 +
== SetAllDefaultButtonConfig ==
 +
No input/output.
 +
 
 +
== SetHidButtonConfigEmbedded ==
 +
Takes an input [[#UniquePadId]] and a type-0x15 input buffer containing a [[#ButtonConfigEmbedded]], no output.
 +
 
 +
== SetHidButtonConfigFull ==
 +
Takes an input [[#UniquePadId]] and a type-0x15 input buffer containing a [[#ButtonConfigFull]], no output.
 +
 
 +
== SetHidButtonConfigLeft ==
 +
Takes an input [[#UniquePadId]] and a type-0x15 input buffer containing a [[#ButtonConfigLeft]], no output.
 +
 
 +
== SetHidButtonConfigRight ==
 +
Takes an input [[#UniquePadId]] and a type-0x15 input buffer containing a [[#ButtonConfigRight]], no output.
 +
 
 +
== GetHidButtonConfigEmbedded ==
 +
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#ButtonConfigEmbedded]].
 +
 
 +
== GetHidButtonConfigFull ==
 +
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#ButtonConfigFull]].
 +
 
 +
== GetHidButtonConfigLeft ==
 +
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#ButtonConfigLeft]].
 +
 
 +
== GetHidButtonConfigRight ==
 +
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#ButtonConfigRight]].
 +
 
 +
== IHidbusSystemServer ==
 +
This is "nn::hidbus::IHidbusSystemServer".
 +
 
 +
This was added with [5.0.0+].
 +
 
 +
{| class="wikitable" border="1"
 
|-
 
|-
 
! Cmd || Name
 
! Cmd || Name
 
|-
 
|-
| 0 || GetDataFormat
+
| 500 || SetAppletResourceUserId
 
|-
 
|-
| 1 || SetDataFormat
+
| 501 || RegisterAppletResourceUserId
 
|-
 
|-
| 2 || GetMcuState
+
| 502 || UnregisterAppletResourceUserId
 +
|}
 +
 
 +
= hid:tmp =
 +
This is "nn::hid::IHidTemporaryServer".
 +
 
 +
This service was added with [3.0.0+], then removed with [8.0.0+].
 +
 
 +
{| class="wikitable" border="1"
 
|-
 
|-
| 3 || SetMcuState
+
! Cmd || Name
 
|-
 
|-
| 4 || GetMcuVersionForNfc
+
| 0 || GetConsoleSixAxisSensorCalibrationValues
 +
|}
 +
 
 +
= irs =
 +
This is "nn::irsensor::IIrSensorServer".
 +
 
 +
This was added to sdknso with 3.x.
 +
 
 +
With sdknso versions pre-4.x PointingProcessor used to be DpdProcessor. The [[#PackedPointingProcessorConfig|packed-config]] with DpdProcessor (besides RequiredMcuVersion) used to be initialized from user-specified config, now it's hard-coded.
 +
 
 +
{| class="wikitable" border="1"
 
|-
 
|-
| 5 || CheckNfcDevicePower
+
! Cmd || Name
 
|-
 
|-
| 10 || SetNfcEvent
+
| 302 || [[#ActivateIrsensor]]
 
|-
 
|-
| 11 || GetNfcInfo
+
| 303 || [[#DeactivateIrsensor]]
 +
|-
 +
| 304 || [[#GetIrsensorSharedMemoryHandle]]
 +
|-
 +
| 305 || [[#StopImageProcessor]]
 +
|-
 +
| 306 || [[#RunMomentProcessor]]
 +
|-
 +
| 307 || [[#RunClusteringProcessor]]
 +
|-
 +
| 308 || [[#RunImageTransferProcessor]]
 
|-
 
|-
| 12 || StartNfcDiscovery
+
| 309 || [[#GetImageTransferProcessorState]]
 
|-
 
|-
| 13 || StopNfcDiscovery
+
| 310 || [[#RunTeraPluginProcessor]]
 
|-
 
|-
| 14 || StartNtagRead
+
| 311 || [[#GetNpadIrCameraHandle]]
 
|-
 
|-
| 15 || StartNtagWrite
+
| 312 || [[#RunPointingProcessor]]
 
|-
 
|-
| 16 || SendNfcRawData
+
| 313 || [[#SuspendImageProcessor]]
 
|-
 
|-
| 17 || RegisterMifareKey
+
| 314 || [3.0.0+] [[#CheckFirmwareVersion]]
 
|-
 
|-
| 18 || ClearMifareKey
+
| 315 || [4.0.0+] [[#SetFunctionLevel]]
 
|-
 
|-
| 19 || StartMifareRead
+
| 316 || [4.0.0+] [[#RunImageTransferExProcessor]]
 
|-
 
|-
| 20 || StartMifareWrite
+
| 317 || [4.0.0+] [[#RunIrLedProcessor]]
 
|-
 
|-
| 101 || GetAwakeTriggerReasonForLeftRail
+
| 318 || [4.0.0+] [[#StopImageProcessorAsync]]
 
|-
 
|-
| 102 || GetAwakeTriggerReasonForRightRail
+
| 319 || [4.0.0+] [[#ActivateIrsensorWithFunctionLevel]]
 
|}
 
|}
  
[6.0.0+]: The buffer type used by GetNfcInfo is now 0x32 instead of 0x1A.
+
== 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 "nn::irsensor::detail::StatusManager". It's mapped with permission read-only and size 0x8000.
 +
 
 +
It's structure is as follows:
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x7FB0 || Array of [[#DeviceFormat]]
 +
|-
 +
| 0x7FB0 || 0x50 || Array of [[#AruidFormat]]
 +
|}
 +
 
 +
The array of [[#DeviceFormat]] is indexed by [[#IrCameraHandle|PlayerNumber]] and can hold up to 9 entries. The array of [[#AruidFormat]] can only hold up to 5 entries.
 +
 
 +
=== DeviceFormat ===
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x4 || [[#IrCameraStatus]]
 +
|-
 +
| 0x4 || 0x4 || [[#IrCameraInternalStatus]]
 +
|-
 +
| 0x8 || 0x8 || [[#IrSensorMode]]
 +
|-
 +
| 0x10 || 0xE20 || [[#ProcessorStateRingLifo]]
 +
|}
 +
 
 +
==== ProcessorStateRingLifo ====
 +
This is "nn::irsensor::detail::RingLifo<X,Y>" where "X" is a specialized processor state (e.g.: "nn::irsensor::MomentProcessorState") and "Y" is the maximum element count (e.g.: 5).
  
= hidbus =
+
{| class="wikitable" border="1"
This is "nn::hidbus::IHidbusServer".
+
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x8 || Start
 +
|-
 +
| 0x8 || 0x4 || Count
 +
|-
 +
| 0xC || 0x4 || Padding
 +
|-
 +
| 0x10 || Variable || ProcessorState
 +
|}
 +
 
 +
The maximum element count is 6 for [[#PointingProcessorMarkerState]] or 5 for any of the other states.
 +
 
 +
ProcessorState is specialized depending on the value of [[#IrSensorMode]].
 +
 
 +
===== MomentProcessorState =====
 +
This is "nn::irsensor::MomentProcessorState".
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x8 || SamplingNumber
 +
|-
 +
| 0x8 || 0x8 || TimeStamp
 +
|-
 +
| 0x10 || 0x4 || AmbientNoiseLevel
 +
|-
 +
| 0x14 || 0x4 || Reserved
 +
|-
 +
| 0x18 || 0x240 || Array of [[#MomentStatistic]]
 +
|}
 +
 
 +
The array of [[#MomentStatistic]] can hold up to 48 entries. This array can be accessed as [y + x*8] (this is a 6x8 array). region_x = image_x/6, region_y = image_y/8.
 +
 
 +
====== MomentStatistic ======
 +
In sdknso GetMomentProcessorStates, this loops through each MomentProcessorState->MomentStatistic entry: <code>AverageIntensity *= scale;</code> The scale is calculated with: <code>scale = 76800.0f / (float)([[#PackedMomentProcessorConfig|WindowOfInterest]].width * [[#PackedMomentProcessorConfig|WindowOfInterest]].height);</code> Note that <code>76800 == 320*240</code>, hence with the default width/height the calculated scale is 1.0f.
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x4 || float AverageIntensity
 +
|-
 +
| 0x4 || 0x4 || float CentroidX
 +
|-
 +
| 0x8 || 0x4 || float CentroidY
 +
|}
 +
 
 +
===== ClusteringProcessorState =====
 +
This is "nn::irsensor::ClusteringProcessorState".
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x8 || SamplingNumber
 +
|-
 +
| 0x8 || 0x8 || TimeStamp
 +
|-
 +
| 0x10 || 0x1 || ObjectCount
 +
|-
 +
| 0x11 || 0x3 || Reserved
 +
|-
 +
| 0x14 || 0x4 || AmbientNoiseLevel
 +
|-
 +
| 0x18 || 0x180 || Array of [[#ClusteringData]]
 +
|}
 +
 
 +
The array of [[#ClusteringData]] can hold up to 16 entries.
 +
 
 +
====== ClusteringData ======
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x4 || float AverageIntensity
 +
|-
 +
| 0x4 || 0x4 || float CentroidX
 +
|-
 +
| 0x8 || 0x4 || float CentroidY
 +
|-
 +
| 0xC || 0x4 || PixelCount
 +
|-
 +
| 0x10 || 0x2 || BoundX
 +
|-
 +
| 0x12 || 0x2 || BoundY
 +
|-
 +
| 0x14 || 0x2 || BoundtWidth
 +
|-
 +
| 0x16 || 0x2 || BoundHeight
 +
|}
 +
 
 +
===== PointingProcessorMarkerState =====
 +
This is "nn::irsensor::PointingProcessorMarkerState".
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x8 || SamplingNumber
 +
|-
 +
| 0x8 || 0x8 || TimeStamp
 +
|-
 +
| 0x10 || 0x1 || PointingStatus
 +
|-
 +
| 0x11 || 0x3 || Reserved
 +
|-
 +
| 0x14 || 0x4 || Unknown
 +
|-
 +
| 0x18 || 0x4 || float Unknown
 +
|-
 +
| 0x1C || 0x4 || float PositionX
 +
|-
 +
| 0x20 || 0x4 || float PositionY
 +
|-
 +
| 0x24 || 0x4 || float Unknown
 +
|-
 +
| 0x28 || 0x2 || WindowOfInterestX
 +
|-
 +
| 0x2A || 0x2 || WindowOfInterestY
 +
|-
 +
| 0x2C || 0x2 || WindowOfInterestWidth
 +
|-
 +
| 0x2E || 0x2 || WindowOfInterestHeight
 +
|-
 +
| 0x30 || 0x1 || PointingStatus
 +
|-
 +
| 0x31 || 0x3 || Reserved
 +
|-
 +
| 0x34 || 0x4 || Unknown
 +
|-
 +
| 0x38 || 0x4 || float Unknown
 +
|-
 +
| 0x3C || 0x4 || float PositionX
 +
|-
 +
| 0x40 || 0x4 || float PositionY
 +
|-
 +
| 0x44 || 0x4 || float Unknown
 +
|-
 +
| 0x48 || 0x2 || WindowOfInterestX
 +
|-
 +
| 0x4A || 0x2 || WindowOfInterestY
 +
|-
 +
| 0x4C || 0x2 || WindowOfInterestWidth
 +
|-
 +
| 0x4E || 0x2 || WindowOfInterestHeight
 +
|-
 +
| 0x50 || 0x1 || PointingStatus
 +
|-
 +
| 0x51 || 0x3 || Reserved
 +
|-
 +
| 0x54 || 0x4 || Unknown
 +
|-
 +
| 0x58 || 0x4 || float Unknown
 +
|-
 +
| 0x5C || 0x4 || float PositionX
 +
|-
 +
| 0x60 || 0x4 || float PositionY
 +
|-
 +
| 0x64 || 0x4 || float Unknown
 +
|-
 +
| 0x68 || 0x2 || WindowOfInterestX
 +
|-
 +
| 0x6A || 0x2 || WindowOfInterestY
 +
|-
 +
| 0x6C || 0x2 || WindowOfInterestWidth
 +
|-
 +
| 0x6E || 0x2 || WindowOfInterestHeight
 +
|}
 +
 
 +
===== PointingProcessorState =====
 +
This is "nn::irsensor::PointingProcessorState".
 +
 
 +
This is created from [[#PointingProcessorMarkerState]].
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x8 || SamplingNumber
 +
|-
 +
| 0x8 || 0x8 || TimeStamp
 +
|-
 +
| 0x10 || 0x4 || PointingStatus
 +
|-
 +
| 0x14 || 0x4 || float PositionX
 +
|-
 +
| 0x18 || 0x4 || float PositionY
 +
|-
 +
| 0x1C || 0x4 || Reserved
 +
|}
 +
 
 +
===== TeraPluginProcessorState =====
 +
This is "nn::irsensor::TeraPluginProcessorState".
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x8 || SamplingNumber
 +
|-
 +
| 0x8 || 0x8 || TimeStamp
 +
|-
 +
| 0x10 || 0x4 || AmbientNoiseLevel
 +
|-
 +
| 0x14 || 0x12C || PluginData
 +
|}
 +
 
 +
===== AdaptiveClusteringProcessorState =====
 +
This is "nn::irsensor::AdaptiveClusteringProcessorState".
 +
 
 +
This is created from [[#TeraPluginProcessorState]].
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x8 || SamplingNumber
 +
|-
 +
| 0x8 || 0x8 || TimeStamp
 +
|-
 +
| 0x10 || 0x4 || AmbientNoiseLevel
 +
|-
 +
| 0x14 || 0x4 || AccuracyLevel
 +
|-
 +
| 0x18 || 0x1 || ObjectCount
 +
|-
 +
| 0x19 || 0x1 || BackgroundIntensity
 +
|-
 +
| 0x1A || 0x6 || Reserved
 +
|-
 +
| 0x20 || 0x200 || Array of [[#AdaptiveClusteringData]]
 +
|}
 +
 
 +
The array of [[#AdaptiveClusteringData]] can hold up to 16 entries.
 +
 
 +
====== AdaptiveClusteringData ======
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x4 || float CentroidX
 +
|-
 +
| 0x4 || 0x4 || float CentroidY
 +
|-
 +
| 0x8 || 0x4 || float Area
 +
|-
 +
| 0xC || 0x4 || IsIncomplete
 +
|}
 +
 
 +
===== HandAnalysisImageState =====
 +
This is "nn::irsensor::HandAnalysisImageState".
 +
 
 +
This is created from [[#TeraPluginProcessorState]].
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x8 || SamplingNumber
 +
|-
 +
| 0x8 || 0x4 || AmbientNoiseLevel
 +
|-
 +
| 0xC || 0x960 || Image
 +
|-
 +
| 0x96C || 0x4 || Reserved
 +
|}
 +
 
 +
===== HandAnalysisSilhouetteState =====
 +
This is "nn::irsensor::HandAnalysisSilhouetteState".
 +
 
 +
This is created from [[#TeraPluginProcessorState]].
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x8 || SamplingNumber
 +
|-
 +
| 0x8 || 0x4 || AmbientNoiseLevel
 +
|-
 +
| 0xC || 0x1354 || Unknown
 +
|}
 +
 
 +
===== HandAnalysisSilhouetteStateWithFullFrameShape =====
 +
This is "nn::irsensor::HandAnalysisSilhouetteStateWithFullFrameShape".
 +
 
 +
This is created from [[#TeraPluginProcessorState]].
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x8 || SamplingNumber
 +
|-
 +
| 0x8 || 0x4 || AmbientNoiseLevel
 +
|-
 +
| 0xC || 0x156C || Unknown
 +
|}
 +
 
 +
=== AruidFormat ===
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x8 || IrSensorAruid
 +
|-
 +
| 0x8 || 0x8 || IrSensorAruidStatus
 +
|}
 +
 
 +
== 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's size, and a TransferMemory handle. No output.
 +
 
 +
The TransferMemory is created with an user specified buffer and permission none.
 +
 
 +
== 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 [[#NpadIdType]]. Returns an output [[#IrCameraHandle]].
 +
 
 +
== RunPointingProcessor ==
 +
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedPointingProcessorConfig]] (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.
 +
 
 +
sdknso uses this from the Run*Processor funcs to suspend the current Processor when the current [[#PackedFunctionLevel|FunctionLevel]] is >= 0x1, prior to starting another Processor if needed (depending on  what Processor was already active via a state field). Hence, this cmd is only used with [4.0.0+].
 +
 
 +
== CheckFirmwareVersion ==
 +
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedMcuVersion]], and an [[AM_services|AppletResourceUserId]]. No output.
 +
 
 +
sdknso didn't actually use this until 4.x (the RequiredMcuVersion was also updated with that version).
 +
 
 +
== SetFunctionLevel ==
 +
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedFunctionLevel]], and an [[AM_services|AppletResourceUserId]]. No output.
 +
 
 +
== RunImageTransferExProcessor ==
 +
Takes a PID-descriptor, an [[#IrCameraHandle]], an [[AM_services|AppletResourceUserId]], a [[#PackedImageTransferProcessorExConfig]], an u64 for the TransferMemory's size, and a TransferMemory handle. No output.
 +
 
 +
The TransferMemory is created with an user specified buffer and permission none.
 +
 
 +
== RunIrLedProcessor ==
 +
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedIrLedProcessorConfig]] (immediately after the previous word), and an [[AM_services|AppletResourceUserId]]. No output.
 +
 
 +
== StopImageProcessorAsync ==
 +
Takes a PID-descriptor, an [[#IrCameraHandle]], and an [[AM_services|AppletResourceUserId]]. No output.
 +
 
 +
== ActivateIrsensorWithFunctionLevel ==
 +
Takes a PID-descriptor, an [[#PackedFunctionLevel]], and an [[AM_services|AppletResourceUserId]]. No output.
 +
 
 +
= irs:sys =
 +
This is "nn::irsensor::IIrSensorSystemServer".
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Cmd || Name
 +
|-
 +
| 500 || [[#SetAppletResourceUserId]]
 +
|-
 +
| 501 || [[#RegisterAppletResourceUserId]]
 +
|-
 +
| 502 || [[#UnregisterAppletResourceUserId]]
 +
|-
 +
| 503 || [[#EnableAppletToGetInput]]
 +
|}
 +
 
 +
== SetAppletResourceUserId ==
 +
Takes an [[AM_services|AppletResourceUserId]]. No output.
 +
 
 +
== RegisterAppletResourceUserId ==
 +
Takes a bool and an [[AM_services|AppletResourceUserId]]. No output.
 +
 
 +
== UnregisterAppletResourceUserId ==
 +
Takes an [[AM_services|AppletResourceUserId]]. No output.
 +
 
 +
== EnableAppletToGetInput ==
 +
Takes a bool and an [[AM_services|AppletResourceUserId]]. No output.
 +
 
 +
= ahid:cd =
 +
This is "nn::ahid::IServerSession".
 +
 
 +
Used for USB HID devices.
 +
 
 +
This service no longer exists in [9.0.0+].
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Cmd || Name
 +
|-
 +
| 0 || [[#AcquireDevice]]
 +
|-
 +
| 1 || [[#ReleaseDevice]]
 +
|-
 +
| 2 || [[#GetCtrlSession]]
 +
|-
 +
| 3 || [[#GetReadSession]]
 +
|-
 +
| 4 || [1.0.0-2.3.0] [[#GetWriteSession]]
 +
|}
 +
 
 +
== AcquireDevice ==
 +
Takes an input s32, no output.
 +
 
 +
== ReleaseDevice ==
 +
Takes an input s32, no output.
 +
 
 +
== GetCtrlSession ==
 +
Takes an input u32, returns an [[#ICtrlSession]].
 +
 
 +
== GetReadSession ==
 +
Takes an input u32, returns an [[#IReadSession]].
 +
 
 +
== GetWriteSession ==
 +
Takes an input u32, returns an [[#IWriteSession]].
 +
 
 +
== ICtrlSession ==
 +
This is "nn::ahid::ICtrlSession".
 +
 
 +
This no longer exists in [9.0.0+].
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Cmd || Name
 +
|-
 +
| 0 || GetString
 +
|-
 +
| 1 || GetCodeBook
 +
|-
 +
| 2 || GetReport
 +
|-
 +
| 3 || SetReport
 +
|-
 +
| 4 || GetIdle
 +
|-
 +
| 5 || SetIdle
 +
|-
 +
| 6 || GetProtocol
 +
|-
 +
| 7 || SetProtocol
 +
|-
 +
| 8 || GetDescriptor
 +
|-
 +
| 9 || SetDescriptor
 +
|-
 +
| 10 || GetStateChangeEvent
 +
|-
 +
| 11 || SignalStateChangeEvent
 +
|-
 +
| 12 || [3.0.0+] Write
 +
|}
 +
 
 +
All of these use USB [[USB_services|CtrlXfer]], except for GetStateChangeEvent and SignalStateChangeEvent, and GetCodeBook which copies 0x4000-bytes from state to output.
 +
 
 +
== IReadSession ==
 +
This is "nn::ahid::IReadSession".
 +
 
 +
This no longer exists in [9.0.0+].
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Cmd || Name
 +
|-
 +
| 0 || [[#Read]]
 +
|}
 +
 
 +
=== Read ===
 +
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.
 +
 
 +
[3.0.0+] Now takes a total of 8-bytes of input.
 +
 
 +
== IWriteSession ==
 +
This is "nn::ahid::IWriteSession".
 +
 
 +
This was removed with [3.0.0+].
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Cmd || Name
 +
|-
 +
| 0 || [[#Write]]
 +
|}
 +
 
 +
=== Write ===
 +
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.
 +
 
 +
This service no longer exists in [9.0.0+].
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Cmd || Name
 +
|-
 +
| 0 || GetDeviceEntries
 +
|-
 +
| 1 || GetDeviceList
 +
|-
 +
| 2 || GetDeviceParameters
 +
|-
 +
| 3 || AttachDevice
 +
|-
 +
| 4 || DetachDevice
 +
|-
 +
| 5 || [6.0.0+] SetDeviceFilter
 +
|}
 +
 
 +
= 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
 +
|-
 +
| 6 || [5.0.0+] SetMcuStateImmediate
 +
|-
 +
| 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
 +
|-
 +
| 103 || [10.0.0+] GetAwakeTriggerBatteryLevelTransitionForLeftRail
 +
|-
 +
| 104 || [10.0.0+] GetAwakeTriggerBatteryLevelTransitionForRightRail
 +
|}
 +
 
 +
[5.0.0+] SetDataFormat, SetMcuState, and ClearMifareKey: now takes a total of 0xC-bytes of input instead of 0x10.
 +
 
 +
[6.0.0+]: The buffer type used by GetNfcInfo is now 0x32 instead of 0x1A.
 +
 
 +
= hidbus =
 +
This is "nn::hidbus::IHidbusServer".
 +
 
 +
This was added with [5.0.0+].
 +
 
 +
Official sw opens a temporary service-session for each func using this, with it being closed once done: no global session is kept open.
 +
 
 +
{| 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]]
 +
|-
 +
| 13 || [5.0.0-6.2.0] GetPollingData
 +
|-
 +
| 14 || [6.0.0+] [[#SetStatusManagerType]]
 +
|}
 +
 
 +
sdknso doesn't use the GetPollingData cmd.
 +
 
 +
== GetBusHandle ==
 +
Takes an input u32 [[#NpadIdType]], an u64 [[#BusType]], an u64 [[AM_services|AppletResourceUserId]], returns an output u8 bool and a [[#BusHandle]].
 +
 
 +
The bool indicates whether the [[#BusHandle]] is valid.
 +
 
 +
Official sw will assert when [[#BusHandle]] InternalIndex is >=0x11 (>=0x13 with [6.0.0+]). This same check is also done for all funcs using [[#BusHandle]] as input.
 +
 
 +
This cmd will throw an error when [[#BusType]] is invalid.
 +
 
 +
== IsExternalDeviceConnected ==
 +
Takes an input [[#BusHandle]], returns an output u8 bool.
 +
 
 +
This is not used by sdknso.
 +
 
 +
== Initialize ==
 +
Takes an input [[#BusHandle]], an u64 [[AM_services|AppletResourceUserId]], no output.
 +
 
 +
Prior to using this cmd, sdknso handles [[#GetSharedMemoryHandle|sharedmem]] mapping if not done previously.
 +
 
 +
== Finalize ==
 +
Takes an input [[#BusHandle]], an u64 [[AM_services|AppletResourceUserId]], no output.
 +
 
 +
== EnableExternalDevice ==
 +
Takes an input u8 bool, a [[#BusHandle]], an u64, an u64 [[AM_services|AppletResourceUserId]], no output.
 +
 
 +
sdknso passes value 0x38900050018 (0x3A600050018 with 7.x+) for the u64.
 +
 
 +
The bool flag indicates whether to enable the device (true = enable, false = disable).  When false, this will use [[#DisableJoyPollingReceiveMode]] if needed.
 +
 
 +
== GetExternalDeviceId ==
 +
Takes an input [[#BusHandle]], returns an output u32 ExternalDeviceId.
 +
 
 +
== SendCommandAsync ==
 +
Takes a type-0x21 input buffer and a [[#BusHandle]], no output.
 +
 
 +
== GetSendCommandAsynceResult ==
 +
Takes a type-0x22 output buffer and a [[#BusHandle]], returns an output u32.
 +
 
 +
Official sw copies the u32 to an output u64, for the actual output size.
 +
 
 +
== SetEventForSendCommandAsycResult ==
 +
Takes an input [[#BusHandle]], returns an output Event handle with EventClearMode=0.
 +
 
 +
Official sw with SendAndReceive clears this event (6.x+ sdknso), uses [[#SendCommandAsync]], waits on + clears this event, then uses [[#GetSendCommandAsynceResult]].
 +
 
 +
== GetSharedMemoryHandle ==
 +
No input, returns an output SharedMemory handle.
 +
 
 +
The SharedMemory is mapped with size 0x1000 and permissions=R--.
 +
 
 +
See also [[#SetStatusManagerType]].
 +
 
 +
This sharedmem is the StatusManager. This sharedmem contains an array of 0x100-byte (0x80-byte with [[#SetStatusManagerType|[6.0.0+]]]) entries, with entry-count {max [[#GetBusHandle|BusHandles]]}.
 +
 
 +
sdknso only uses the first 0x10-bytes of these entries, the rest is the ignored. Entry structure:
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x1 || Bool flag
 +
|-
 +
| 0x1 || 0x3 || Padding
 +
|-
 +
| 0x4 || 0x4 || Result
 +
|-
 +
| 0x8 || 0x1 || DeviceEnabled. Bool flag indicating whether a device is [[#EnableExternalDevice|enabled]].
 +
|-
 +
| 0x9 || 0x1 || IsValid. Bool flag indicating whether this entry is valid.
 +
|-
 +
| 0xA || 0x1 || PollingEnabled. Bool flag indicating whether polling is [[#EnableJoyPollingReceiveMode|enabled]].
 +
|-
 +
| 0xB || 0x1 || Unknown / padding?
 +
|-
 +
| 0xC || 0x4 || [[#JoyPollingMode]]
 +
|}
 +
 
 +
== EnableJoyPollingReceiveMode ==
 +
Takes a type-0x21 input buffer, a TransferMemory handle, an u32 tmem_size, an u32 [[#JoyPollingMode]], a [[#BusHandle]], no output.
 +
 
 +
The TransferMemory is created with an user-specified output buffer, with permissions=R--.
 +
 
 +
The content of the TransferMemory depends of the [[#JoyPollingMode]]. This is used by GetJoyPollingReceivedData. Structure of the TransferMemory (DisableSixAxisPollingDataAccessor, EnableSixAxisPollingDataAccessor, JoyButtonOnlyPollingDataAccessor):
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x4 || Result.
 +
|-
 +
| 0x0 || 0x4 || Padding.
 +
|-
 +
| 0x8 || 0x18 || Initialized sysmodule-side, not used by sdknso.
 +
|-
 +
| 0x20 || 0x8 || Latest entry.
 +
|-
 +
| 0x28 || 0x8 || Total entries.
 +
|}
 +
 
 +
The entries specific to the [[#JoyPollingMode]] follow, with 0xA entries total. Each entry starts with an u64 timestamp. Structure for each mode, after the timestamp:
 +
 
 +
DisableSixAxisPollingDataAccessor:
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x26 || Data
 +
|-
 +
| 0x26 || 0x1 || Size of data.
 +
|-
 +
| 0x27 || 0x1 || Padding
 +
|-
 +
| 0x28 || 0x8 || Timestamp
 +
|}
 +
 
 +
JoyEnableSixAxisPollingDataAccessor:
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x8 || Data
 +
|-
 +
| 0x8 || 0x1 || Size of data.
 +
|-
 +
| 0x9 || 0x7 || Padding
 +
|-
 +
| 0x10 || 0x8 || Timestamp
 +
|}
 +
 
 +
JoyButtonOnlyPollingDataAccessor:
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x2C || Data
 +
|-
 +
| 0x2C || 0x1 || Size of data.
 +
|-
 +
| 0x2D || 0x3 || Padding
 +
|-
 +
| 0x30 || 0x8 || Timestamp
 +
|}
 +
 
 +
== DisableJoyPollingReceiveMode ==
 +
Takes an input [[#BusHandle]], no output.
 +
 
 +
== SetStatusManagerType ==
 +
Takes an input u32, no output.
 +
 
 +
This is used by sdknso immediately after mapping [[#GetSharedMemoryHandle|sharedmem]] (before [[#Initialize]]) with hard-coded value 0x2.
 +
 
 +
= GyroscopeZeroDriftMode =
 +
This is "nn::hid::GyroscopeZeroDriftMode".
 +
 
 +
{| class="wikitable" border="1"
 +
!  Value
 +
!  Description
 +
|-
 +
| 0 || Loose
 +
|-
 +
| 1 || Standard
 +
|-
 +
| 2 || Tight
 +
|}
 +
 
 +
= NpadStyleTag =
 +
This is "nn::hid::NpadStyleTag".
 +
 
 +
{| 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/Famicom controller
 +
|-
 +
| 8
 +
| NpadHandheldLark
 +
| NES/Famicom controller in handheld mode
 +
|-
 +
| 9
 +
| NpadLucia
 +
| SNES controller
 +
|-
 +
| 10-28
 +
| Reserved
 +
|
 +
|-
 +
| 29
 +
| NpadSystemExt
 +
| Generic external controller
 +
|-
 +
| 30
 +
| NpadSystem
 +
| Generic controller
 +
|-
 +
| 31
 +
| Reserved
 +
|
 +
|}
 +
 
 +
= NpadIdType =
 +
This is "nn::hid::NpadIdType". This is the controller index used in [[HID_Shared_Memory#Controllers|sharedmem]].
 +
 
 +
{| class="wikitable" border="1"
 +
!  Value
 +
!  Description
 +
|-
 +
| 0x0 || No1
 +
|-
 +
| 0x1 || No2
 +
|-
 +
| 0x2 || No3
 +
|-
 +
| 0x3 || No4
 +
|-
 +
| 0x4 || No5
 +
|-
 +
| 0x5 || No6
 +
|-
 +
| 0x6 || No7
 +
|-
 +
| 0x7 || No8
 +
|-
 +
| 0x10 || Other
 +
|-
 +
| 0x20 || Handheld
 +
|}
 +
 
 +
= NpadInterfaceType =
 +
This is "nn::hid::NpadInterfaceType".
 +
 
 +
{| class="wikitable" border="1"
 +
!  Value
 +
!  Description
 +
|-
 +
| 1 || Bluetooth
 +
|-
 +
| 2 || Rail
 +
|-
 +
| 3 || USB
 +
|-
 +
| 4 || Unknown
 +
|}
 +
 
 +
= AbstractedPadState =
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x4 || Type, only 1 bit can be set. Converted to [[#HdlsDeviceInfo]]::type internally by [[#SetAutoPilotVirtualPadState]].
 +
|-
 +
| 0x4 || 0x1 || Flags. [[#SetAutoPilotVirtualPadState]] only uses bit0: when clear it will skip using the rest of the input and run [[#UnsetAutoPilotVirtualPadState]] internally.
 +
|-
 +
| 0x5 || 0x3 || Padding
 +
|-
 +
| 0x8 || 0x4 || RGBA Single Body Color
 +
|-
 +
| 0xC || 0x4 || RGBA Single Buttons Color
 +
|-
 +
| 0x10 || 0x1 || See [[#HiddbgHdlsDeviceInfo]]::[[#NpadInterfaceType]].
 +
|-
 +
| 0x11 || 0x3 || Padding
 +
|-
 +
| 0x14 || 0x24 || [[#HdlsState]]. Unknown if the last 4-bytes are included in this struct, [[#SetAutoPilotVirtualPadState]]/[[#hiddbgGetAbstractedPadsState]] only uses the first 0x20-bytes.
 +
|-
 +
| 0x38 || 0x60 || Unused with [[#SetAutoPilotVirtualPadState]]/[[#GetAbstractedPadsState]].
 +
|}
 +
 
 +
Normally the input state is merged with an existing controller selected by Type. However in some cases (BIT(2-5) with type2!=0x2 and BIT(31)) it's detected as a dedicated controller.
 +
 
 +
Type:
 +
{| class="wikitable" border="1"
 +
!  Bits
 +
!  [[#HdlsDeviceInfo]]::type bits
 +
!  Description
 +
!  Notes
 +
|-
 +
| 0 || 0 || ||
 +
|-
 +
| 1 || 15 || || [[#DeviceType]] |= BIT(1)
 +
|-
 +
| 2 || 1 || ||
 +
|-
 +
| 3 || 2 || ||
 +
|-
 +
| 4 || 1 || ||
 +
|-
 +
| 5 || 2 || ||
 +
|-
 +
| 6 || 3 || ||
 +
|-
 +
| 7 || 11 || || [[#DeviceType]] |= BIT(11)
 +
|-
 +
| 8 || 12 || || [[#DeviceType]] |= BIT(12)
 +
|-
 +
| 9 || 13 || || [[#DeviceType]] |= BIT(13)
 +
|-
 +
| 10 || 14 || || [[#DeviceType]] |= BIT(14)
 +
|-
 +
| 11 || 15 || || [[#DeviceType]] |= BIT(11)
 +
|-
 +
| 12 || 12 || || [[#DeviceType]] |= BIT(12)
 +
|-
 +
| 13 || 13 || || [[#DeviceType]] |= BIT(13)
 +
|-
 +
| 14 || 14 || || [[#DeviceType]] |= BIT(14)
 +
|-
 +
| 15 || 17 || ||
 +
|-
 +
| 31 || 21 || || [[#DeviceType]] = BIT(31)
 +
|-
 +
|}
 +
 
 +
The above "[[#DeviceType]] |=" notes only apply when type2 is 0x2.
 +
 
 +
= HdlsNpadAssignment =
 +
This is a 0x208-byte struct.
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x4 || s32 Total entries
 +
|-
 +
| 0x4 || 0x4 || Padding
 +
|-
 +
| 0x8 || 0x200(0x20*0x10) || Array of [[#HdlsNpadAssignmentEntry]].
 +
|}
 +
 
 +
= HdlsNpadAssignmentEntry =
 +
This is a 0x20-byte struct.
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x8 || HdlsHandle
 +
|-
 +
| 0x8 || 0x4 || ?
 +
|-
 +
| 0xC || 0x4 || ?
 +
|-
 +
| 0x10 || 0x8 || ?
 +
|-
 +
| 0x18 || 0x1 || ?
 +
|-
 +
| 0x19 || 0x7 || Padding
 +
|}
 +
 
 +
= HdlsStateList =
 +
This is a 0x408-byte struct.
 +
 
 +
[9.0.0+] This is a 0x488-byte struct.
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x4 || s32 Total entries
 +
|-
 +
| 0x4 || 0x4 || Padding
 +
|-
 +
| 0x8 || <[[#HdlsStateListEntry]] size>*0x10 || Array of [[#HdlsStateListEntry]].
 +
|}
 +
 
 +
This contains a list of all controllers, including non-virtual controllers.
 +
 
 +
= HdlsStateListEntry =
 +
This is a 0x40-byte struct.
 +
 
 +
[9.0.0+] This is a 0x48-byte struct.
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x8 || HdlsHandle
 +
|-
 +
| 0x8 || [[#HdlsDeviceInfo]] size || [[#HdlsDeviceInfo]]. With [[#ApplyHdlsStateList]] this is only used when creating new devices.
 +
|-
 +
| 0x8 + [[#HdlsDeviceInfo]] size, with 8-byte alignment || 0x24 || [[#HdlsState]]
 +
|-
 +
| <Immediately following the above> || 0x4 || Padding
 +
|}
 +
 
 +
= HdlsDeviceInfo =
 +
This is a 0x10-byte struct.
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x4 || [[#DeviceTypeInternal]]
 +
|-
 +
| 0x4 || 0x4 || RGBA Single Body Color
 +
|-
 +
| 0x8 || 0x4 || RGBA Single Buttons Color
 +
|-
 +
| 0xC || 0x1 || [[#NpadInterfaceType]]. Additional type field used with the above type field, if the value doesn't match one of the following a default is used. Type Pro-Controller: value 0x3 indicates that the controller is connected via USB. Type bit21: value 0x3 = unknown. When value is 0x2, state is merged with an existing controller (when the type value is compatible with this). Otherwise, it's a dedicated controller.
 +
|-
 +
| 0xD || 0x3 || Padding
 +
|}
 +
 
 +
[9.0.0+] This is a 0x14-byte struct.
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x1 || [[#DeviceTypeInternal]]
 +
|-
 +
| 0x1 || 0x1 || [[#NpadInterfaceType]]. Similar to the field from the old struct.
 +
|-
 +
| 0x2 || 0x2 || Padding
 +
|-
 +
| 0x4 || 0x4 || RGBA Single Body Color
 +
|-
 +
| 0x8 || 0x4 || RGBA Single Buttons Color
 +
|-
 +
| 0xC || 0x4 || RGBA Unknown Body Color
 +
|-
 +
| 0x10 || 0x4 || RGBA Unknown Buttons Color
 +
|}
 +
 
 +
= DeviceTypeInternal =
 +
This is "nn::hid::detail::DeviceTypeInternal".
 +
 
 +
{| class="wikitable" border="1"
 +
!  Bits
 +
!  Description
 +
|-
 +
| 0-7
 +
| BIT(N*4+0) = Pro Controller, BIT(N*4+1) = Joy-Con Left, BIT(N*4+2) = Joy-Con Right, BIT(N*4+3) = invalid. Where N is 0-1.
 +
|-
 +
| 8-10
 +
| Pro Controller
 +
|-
 +
| 11
 +
| Famicom left controller
 +
|-
 +
| 12
 +
| Famicom right controller (with microphone)
 +
|-
 +
| 13
 +
| NES left controller
 +
|-
 +
| 14
 +
| NES right controller
 +
|-
 +
| 15-16
 +
| Invalid
 +
|-
 +
| 17
 +
| Generic external controller
 +
|-
 +
| 18-20
 +
| Invalid
 +
|-
 +
| 21-23
 +
| Generic controller
 +
|}
 +
 
 +
[9.0.0+] This is "nn::hidtypes::DeviceType".
 +
 
 +
{| class="wikitable" border="1"
 +
!  Value
 +
!  [[#DeviceType|DeviceType]]
 +
!  [[#UniquePadType|UniquePadType]]
 +
!  Description
 +
|-
 +
| 1 || JoyRight, HandheldRight || JoyRight || Joy-Con right controller
 +
|-
 +
| 2 || JoyLeft, HandheldLeft || JoyLeft || Joy-Con left controller
 +
|-
 +
| 3 || FullKey || FullKey || Pro Controller
 +
|-
 +
| 4 || JoyLeft || JoyLeft || Reserved
 +
|-
 +
| 5 || JoyRight || JoyRight || Reserved
 +
|-
 +
| 6 || FullKey || FullKey || Reserved
 +
|-
 +
| 7 || LarkHvcLeft, HandheldLarkHvcLeft || JoyLeft || Famicom left controller
 +
|-
 +
| 8 || LarkHvcRight, HandheldLarkHvcRight || JoyRight || Famicom right controller (with microphone)
 +
|-
 +
| 9 || LarkNesLeft, HandheldLarkNesLeft || JoyLeft || NES left controller
 +
|-
 +
| 10 || LarkNesRight, HandheldLarkNesRight || JoyRight || NES right controller
 +
|-
 +
| 11 || Lucia || FullKey || SNES controller
 +
|-
 +
| 12 || Palma || Other || Poké Ball Plus controller
 +
|-
 +
| 13 || FullKey || FullKey || Gc controller
 +
|-
 +
| 14 || HandheldLeft || JoyLeft || Reserved
 +
|-
 +
| 15 || FullKey || FullKey || Reserved
 +
|-
 +
| 16 || FullKey || FullKey || Reserved
 +
|-
 +
| 17 || DebugPad || DebugPad || Debug controller
 +
|-
 +
| 18 || HandheldRight || JoyRight || Reserved
 +
|-
 +
| 19 || System || Other || Unknown (has [[#NpadStyleTag|NpadFullKey]] style tag)
 +
|-
 +
| 20 || System || Other || Unknown (has [[#NpadStyleTag|NpadJoyDual]] style tag)
 +
|-
 +
| 21 || System || Other || Unknown (has [[#NpadStyleTag|NpadJoyDual]] style tag)
 +
|}
 +
 
 +
= HdlsState =
 +
This is a 0x24-byte struct.
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x1 || powerConnected for the main [[HID_Shared_Memory#Controllers|PowerInfo]].
 +
|-
 +
| 0x1 || 0x1 || ORRed with powerConnected to set the value of the first byte for the controller [[HID_Shared_Memory#Flags|flags]].
 +
|-
 +
| 0x2 || 0x6 || Unknown
 +
|-
 +
| 0x8 || 0x4 || batteryCharge for the main [[HID_Shared_Memory#Controllers|PowerInfo]].
 +
|-
 +
| 0xC || 0x4 || [[HID_Shared_Memory#Button_State|Buttons]]. Bit18 = HOME and bit19 = Capture.
 +
|-
 +
| 0x10 || 0x10(4*2*2) || Joystick data, see [[HID_Shared_Memory#Controller_State]].
 +
|-
 +
| 0x20 || 0x1 || Unused for input. Set with output from [[#DumpHdlsStates]] (zero in some cases).
 +
|-
 +
| 0x21 || 0x3 || Padding
 +
|}
 +
 
 +
[9.0.0+]:
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x4 || batteryCharge for the main [[HID_Shared_Memory#Controllers|PowerInfo]].
 +
|-
 +
| 0x4 || 0x4 || Unknown
 +
|-
 +
| 0x8 || 0x8 || [[HID_Shared_Memory#Button_State|Buttons]], masked with 0xfffffffff00fffff. See above table regarding HOME/Capture buttons.
 +
|-
 +
| 0x10 || 0x10(4*2*2) || Joystick data, see [[HID_Shared_Memory#Controller_State]].
 +
|-
 +
| 0x20 || 0x1 || Unused for input. Set with output from [[#DumpHdlsStates]] (zero in some cases).
 +
|-
 +
| 0x21 || 0x3 || Padding
 +
|}
 +
 
 +
= 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.
 +
|}
 +
 
 +
= DeviceType =
 +
This is "nn::hid::system::DeviceType".
 +
 
 +
{| class="wikitable" border="1"
 +
!  Bits
 +
!  Description
 +
|-
 +
| 0
 +
| FullKey
 +
|-
 +
| 1
 +
| DebugPad
 +
|-
 +
| 2
 +
| HandheldLeft
 +
|-
 +
| 3
 +
| HandheldRight
 +
|-
 +
| 4
 +
| JoyLeft
 +
|-
 +
| 5
 +
| JoyRight
 +
|-
 +
| 6
 +
| Palma
 +
|-
 +
| 7
 +
| LarkHvcLeft
 +
|-
 +
| 8
 +
| LarkHvcRight
 +
|-
 +
| 9
 +
| LarkNesLeft
 +
|-
 +
| 10
 +
| LarkNesRight
 +
|-
 +
| 11
 +
| HandheldLarkHvcLeft
 +
|-
 +
| 12
 +
| HandheldLarkHvcRight
 +
|-
 +
| 13
 +
| HandheldLarkNesLeft
 +
|-
 +
| 14
 +
| HandheldLarkNesRight
 +
|-
 +
| 15
 +
| Lucia
 +
|-
 +
| 16-30
 +
| Reserved
 +
|-
 +
| 31
 +
| System
 +
|}
 +
 
 +
= UniquePadId =
 +
This is "nn::hid::system::UniquePadId". This struct contains an u64.
 +
 
 +
= UniquePadType =
 +
This is "nn::hid::system::UniquePadType".
 +
 
 +
{| class="wikitable" border="1"
 +
!  Value
 +
!  Description
 +
|-
 +
| 0x0 || Other
 +
|-
 +
| 0x1 || FullKey
 +
|-
 +
| 0x2 || JoyRight
 +
|-
 +
| 0x3 || JoyLeft
 +
|-
 +
| 0x4 || DebugPad
 +
|}
 +
 
 +
= SystemButtonConfigEmbedded =
 +
This is "nn::hid::system::ButtonConfigEmbedded". This is a 0x2C8-byte struct.
 +
 
 +
= SystemButtonConfigFull =
 +
This is "nn::hid::system::ButtonConfigFull". This is a 0x2C8-byte struct.
 +
 
 +
= SystemButtonConfigLeft =
 +
This is "nn::hid::system::ButtonConfigLeft". This is a 0x1C8-byte struct.
 +
 
 +
= SystemButtonConfigRight =
 +
This is "nn::hid::system::ButtonConfigRight". This is a 0x1A0-byte struct.
 +
 
 +
= ButtonConfigEmbedded =
 +
This is "nn::hidconfig::ButtonConfigEmbedded". This is a 0x54-byte struct.
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x44 (4*17) || [[#ButtonConfig]], for the following buttons: DLeft, DUp, DRight, DDown, A, B, X, Y, L-Stick, R-Stick, L, R, ZL, ZR, -, +, Capture.
 +
|-
 +
| 0x44 || 0x8 || [[#JoystickConfig]], for the left-stick.
 +
|-
 +
| 0x4C || 0x8 || [[#JoystickConfig]], for the right-stick.
 +
|}
 +
 
 +
== ButtonConfig ==
 +
u32 button mapping config. Must be value 0 - 22, which selects what button to map to.
 +
 
 +
{| class="wikitable" border="1"
 +
!  Value
 +
!  Description
 +
|-
 +
| 0 || A
 +
|-
 +
| 1 || B
 +
|-
 +
| 2 || X
 +
|-
 +
| 3 || Y
 +
|-
 +
| 4 || L-Stick
 +
|-
 +
| 5 || R-Stick
 +
|-
 +
| 6 || L
 +
|-
 +
| 7 || R
 +
|-
 +
| 8 || ZL
 +
|-
 +
| 9 || ZR
 +
|-
 +
| 10 || -
 +
|-
 +
| 11 || +
 +
|-
 +
| 12 || DLeft
 +
|-
 +
| 13 || DUp
 +
|-
 +
| 14 || DRight
 +
|-
 +
| 15 || DDown
 +
|-
 +
| 16 || SL_Left
 +
|-
 +
| 17 || SR_Left
 +
|-
 +
| 18 || SL_Right
 +
|-
 +
| 19 || SR_Right
 +
|-
 +
| 20 || HOME
 +
|-
 +
| 21 || Capture
 +
|-
 +
| 22 || Disabled
 +
|}
 +
 
 +
== JoystickConfig ==
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x4 || Orientation. 0 = default, 1 = enabled for Left, 2 = enabled for Right.
 +
|-
 +
| 0x4 || 0x1 || StickChange
 +
|-
 +
| 0x5 || 0x3 || Padding
 +
|}
 +
 
 +
= ButtonConfigFull =
 +
This is "nn::hidconfig::ButtonConfigFull". This is a 0x54-byte struct.
 +
 
 +
This is identical to [[#ButtonConfigEmbedded]].
 +
 
 +
= ButtonConfigLeft =
 +
This is "nn::hidconfig::ButtonConfigLeft". This is a 0x34-byte struct.
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x2C (4*11) || [[#ButtonConfig]], for the following buttons: DLeft, DUp, DRight, DDown, L-Stick, L, ZL, -, SL_Left, SR_Left, Capture.
 +
|-
 +
| 0x2C || 0x8 || [[#JoystickConfig]]
 +
|}
 +
 
 +
= ButtonConfigRight =
 +
This is "nn::hidconfig::ButtonConfigRight". This is a 0x30-byte struct.
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x28 (4*10) || [[#ButtonConfig]], for the following buttons: A, B, X, Y, R-Stick, R, ZR, +, SL_Right, SR_Right.
 +
|-
 +
| 0x28 || 0x8 || [[#JoystickConfig]]
 +
|}
 +
 
 +
 
 +
= IrCameraHandle =
 +
This is "nn::irsensor::IrCameraHandle".
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x1 || PlayerNumber
 +
|-
 +
| 0x1 || 0x1 || DeviceType
 +
|-
 +
| 0x2 || 0x2 || Reserved
 +
|}
 +
 
 +
= IrCameraStatus =
 +
This is "nn::irsensor::IrCameraStatus".
 +
 
 +
{| class="wikitable" border="1"
 +
!  Value
 +
!  Description
 +
|-
 +
| 0 || Available
 +
|-
 +
| 1 || Unsupported
 +
|-
 +
| 2 || Unconnected
 +
|}
 +
 
 +
= IrCameraInternalStatus =
 +
This is "nn::irsensor::IrCameraInternalStatus".
 +
 
 +
{| class="wikitable" border="1"
 +
!  Value
 +
!  Description
 +
|-
 +
| 0 || Stopped
 +
|-
 +
| 1 || FirmwareUpdateNeeded
 +
|-
 +
| 2 ||
 +
|-
 +
| 3 ||
 +
|-
 +
| 4 ||
 +
|-
 +
| 5 || FirmwareVersionRequested
 +
|-
 +
| 6 || FirmwareVersionIsInvalid
 +
|-
 +
| 7 || [4.0.0+] Ready
 +
|-
 +
| 8 || [4.0.0+] Setting
 +
|}
 +
 
 +
= IrSensorMode =
 +
This is "nn::irsensor::detail::StatusManager::IrSensorMode".
 +
 
 +
{| class="wikitable" border="1"
 +
!  Value
 +
!  Description
 +
|-
 +
| 0 || None
 +
|-
 +
| 1 || [[#MomentProcessorState|MomentProcessor]]
 +
|-
 +
| 2 || [[#ClusteringProcessorState|ClusteringProcessor]]
 +
|-
 +
| 3 || [[#ImageTransferProcessorState|ImageTransferProcessor]]
 +
|-
 +
| 4 || [[#PointingProcessorMarkerState|PointingProcessorMarker]]
 +
|-
 +
| 5 || [[#TeraPluginProcessorState|TeraPluginProcessor]]
 +
|-
 +
| 6 || Unknown
 +
|}
 +
 
 +
= ImageProcessorStatus =
 +
This is "nn::irsensor::ImageProcessorStatus".
 +
 
 +
{| class="wikitable" border="1"
 +
!  Value
 +
!  Description
 +
|-
 +
| 0 || Stopped
 +
|-
 +
| 1 || Running
 +
|}
 +
 
 +
= ImageTransferProcessorFormat =
 +
This is "nn::irsensor::ImageTransferProcessorFormat".
 +
 
 +
This controls the IR Sensor image resolution.
 +
 
 +
{| class="wikitable" border="1"
 +
!  Value
 +
!  Description
 +
|-
 +
| 0 || 320x240
 +
|-
 +
| 1 || 160x120
 +
|-
 +
| 2 || 80x60
 +
|-
 +
| 3 || [4.0.0+] 40x30
 +
|-
 +
| 4 || [4.0.0+] 20x15
 +
|}
 +
 
 +
= MomentProcessorConfig =
 +
This is "nn::irsensor::MomentProcessorConfig".
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x8 || ExposureTime (default is 0x493E0)
 +
|-
 +
| 0x8 || 0x4 || LightTarget (default is 0)
 +
|-
 +
| 0xC || 0x4 || Gain (default is 0x8)
 +
|-
 +
| 0x10 || 0x1 || IsNegativeImageUsed (default is 0)
 +
|-
 +
| 0x11 || 0x7 || Reserved
 +
|-
 +
| 0x18 || 0x2 || WindowOfInterestX (default is 0)
 +
|-
 +
| 0x1A || 0x2 || WindowOfInterestY (default is 0)
 +
|-
 +
| 0x1C || 0x2 || WindowOfInterestWidth (default is 0x140)
 +
|-
 +
| 0x1E || 0x2 || WindowOfInterestHeight (default is 0xF0)
 +
|-
 +
| 0x20 || 0x4 || Preprocess (default is 0x1)
 +
|-
 +
| 0x24 || 0x4 || PreprocessIntensityThreshold (default is 0x50)
 +
|}
 +
 
 +
= PackedMomentProcessorConfig =
 +
This is "nn::irsensor::PackedMomentProcessorConfig".
 +
 
 +
This is converted from [[#MomentProcessorConfig]].
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x8 || ExposureTime (default is 0x493E0)
 +
|-
 +
| 0x8 || 0x1 || LightTarget (default is 0)
 +
|-
 +
| 0x9 || 0x1 || Gain (default is 0x8)
 +
|-
 +
| 0xA || 0x1 || IsNegativeImageUsed (default is 0)
 +
|-
 +
| 0xB || 0x5 || Reserved
 +
|-
 +
| 0x10 || 0x2 || WindowOfInterestX (default is 0)
 +
|-
 +
| 0x12 || 0x2 || WindowOfInterestY (default is 0)
 +
|-
 +
| 0x14 || 0x2 || WindowOfInterestWidth (default is 0x140)
 +
|-
 +
| 0x16 || 0x2 || WindowOfInterestHeight (default is 0xF0)
 +
|-
 +
| 0x18 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
 +
|-
 +
| 0x1C || 0x1 || Preprocess (default is 0x1)
 +
|-
 +
| 0x1D || 0x1 || PreprocessIntensityThreshold (default is 0x50)
 +
|-
 +
| 0x1E || 0x2 || Reserved
 +
|}
 +
 
 +
= ClusteringProcessorConfig =
 +
This is "nn::irsensor::ClusteringProcessorConfig".
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x8 || ExposureTime (default is 200000)
 +
|-
 +
| 0x8 || 0x4 || LightTarget (default is 0)
 +
|-
 +
| 0xC || 0x4 || Gain (default is 0x2)
 +
|-
 +
| 0x10 || 0x1 || IsNegativeImageUsed (default is 0)
 +
|-
 +
| 0x11 || 0x7 || Reserved
 +
|-
 +
| 0x18 || 0x2 || WindowOfInterestX (default is 0)
 +
|-
 +
| 0x1A || 0x2 || WindowOfInterestY (default is 0)
 +
|-
 +
| 0x1C || 0x2 || WindowOfInterestWidth (default is 320)
 +
|-
 +
| 0x1E || 0x2 || WindowOfInterestHeight (default is 240)
 +
|-
 +
| 0x20 || 0x4 || ObjectPixelCountMin (default is 0x3)
 +
|-
 +
| 0x24 || 0x4 || ObjectPixelCountMax (default is 0x12C00)
 +
|-
 +
| 0x28 || 0x4 || ObjectIntensityMin (default is 150)
 +
|-
 +
| 0x2C || 0x1 || IsExternalLightFilterEnabled (default is 0x1)
 +
|}
 +
 
 +
= PackedClusteringProcessorConfig =
 +
This is "nn::irsensor::PackedClusteringProcessorConfig".
 +
 
 +
This is converted from [[#ClusteringProcessorConfig]].
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x8 || ExposureTime
 +
|-
 +
| 0x8 || 0x1 || LightTarget
 +
|-
 +
| 0x9 || 0x1 || Gain
 +
|-
 +
| 0xA || 0x1 || IsNegativeImageUsed
 +
|-
 +
| 0xB || 0x5 || Reserved
 +
|-
 +
| 0x10 || 0x2 || WindowOfInterestX
 +
|-
 +
| 0x12 || 0x2 || WindowOfInterestY
 +
|-
 +
| 0x14 || 0x2 || WindowOfInterestWidth
 +
|-
 +
| 0x16 || 0x2 || WindowOfInterestHeight
 +
|-
 +
| 0x18 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
 +
|-
 +
| 0x1C || 0x4 || ObjectPixelCountMin
 +
|-
 +
| 0x20 || 0x4 || ObjectPixelCountMax
 +
|-
 +
| 0x24 || 0x1 || ObjectIntensityMin
 +
|-
 +
| 0x25 || 0x1 || IsExternalLightFilterEnabled
 +
|-
 +
| 0x26 || 0x2 || Reserved
 +
|}
 +
 
 +
= ImageTransferProcessorConfig =
 +
This is "nn::irsensor::ImageTransferProcessorConfig".
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x8 || ExposureTime
 +
|-
 +
| 0x8 || 0x4 || LightTarget
 +
|-
 +
| 0xC || 0x4 || Gain
 +
|-
 +
| 0x10 || 0x1 || IsNegativeImageUsed
 +
|-
 +
| 0x11 || 0x7 || Reserved
 +
|-
 +
| 0x18 || 0x4 || [[#ImageTransferProcessorFormat|Format]]
 +
|}
 +
 
 +
= PackedImageTransferProcessorConfig =
 +
This is "nn::irsensor::PackedImageTransferProcessorConfig".
 +
 
 +
This is converted from [[#ImageTransferProcessorConfig]].
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x8 || ExposureTime
 +
|-
 +
| 0x8 || 0x1 || LightTarget
 +
|-
 +
| 0x9 || 0x1 || Gain
 +
|-
 +
| 0xA || 0x1 || IsNegativeImageUsed
 +
|-
 +
| 0xB || 0x5 || Reserved
 +
|-
 +
| 0x10 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
 +
|-
 +
| 0x14 || 0x1 || [[#ImageTransferProcessorFormat|Format]]
 +
|-
 +
| 0x15 || 0x3 || Reserved
 +
|}
 +
 
 +
= ImageTransferProcessorState =
 +
This is "nn::irsensor::ImageTransferProcessorState".
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x8 || SamplingNumber
 +
|-
 +
| 0x8 || 0x4 || AmbientNoiseLevel
 +
|-
 +
| 0xC || 0x4 || Reserved
 +
|}
 +
 
 +
= TeraPluginProcessorConfig =
 +
This is "nn::irsensor::TeraPluginProcessorConfig".
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x1 || Mode
 +
|-
 +
| 0x1 || 0x1 ||
 +
|-
 +
| 0x2 || 0x1 ||
 +
|-
 +
| 0x3 || 0x1 ||
 +
|}
 +
 
 +
= PackedTeraPluginProcessorConfig =
 +
This is "nn::irsensor::PackedTeraPluginProcessorConfig".
 +
 
 +
This is converted from [[#TeraPluginProcessorConfig]]. The data starting at offset 0x5 is only initialized by the user-process with [6.0.0+].
 +
 
 +
[[#TeraPluginProcessorConfig]] +0x0, +0x2, and +0x3 are copied to +0x4, 0x6, and +0x7 here. +0x5 here is set to 0x2 | ([[#TeraPluginProcessorConfig]]+0x1 << 7).
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
 +
|-
 +
| 0x4 || 0x1 || Mode
 +
|-
 +
| 0x5 || 0x1 ||
 +
|-
 +
| 0x6 || 0x1 ||
 +
|-
 +
| 0x7 || 0x1 ||
 +
|}
 +
 
 +
= PointingProcessorConfig =
 +
This is "nn::irsensor::PointingProcessorConfig".
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x2 || WindowOfInterestX (default is 0)
 +
|-
 +
| 0x2 || 0x2 || WindowOfInterestY (default is 0)
 +
|-
 +
| 0x4 || 0x2 || WindowOfInterestWidth (default is 320)
 +
|-
 +
| 0x6 || 0x2 || WindowOfInterestHeight (default is 240)
 +
|}
 +
 
 +
= PackedPointingProcessorConfig =
 +
This is "nn::irsensor::PackedPointingProcessorConfig".
 +
 
 +
This is converted from [[#PointingProcessorConfig]].
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x2 || WindowOfInterestX (default is 0)
 +
|-
 +
| 0x2 || 0x2 || WindowOfInterestY (default is 0)
 +
|-
 +
| 0x4 || 0x2 || WindowOfInterestWidth (default is 320)
 +
|-
 +
| 0x6 || 0x2 || WindowOfInterestHeight (default is 240)
 +
|-
 +
| 0x8 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
 +
|}
 +
 
 +
= PackedMcuVersion =
 +
This is "nn::irsensor::PackedMcuVersion".
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x2 || MajorVersion
 +
|-
 +
| 0x2 || 0x2 || MinorVersion
 +
|}
 +
 
 +
== Versions ==
 +
{| class="wikitable" border="1"
 +
|-
 +
! MajorVersion || MinorVersion || SystemVersion
 +
|-
 +
| 0x3 || 0xB || [1.0.0+]
 +
|-
 +
| 0x4 || 0x12 || [4.0.0+]
 +
|-
 +
| 0x5 || 0x18 || [5.0.0+]
 +
|-
 +
| 0x6 || 0x1A || [6.0.0+]
 +
|-
 +
| 0x8 || 0x1B || [8.0.0+]
 +
|}
 +
 
 +
= PackedFunctionLevel =
 +
This is nn::irsensor::PackedFunctionLevel.
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x1 || [[#IrSensorFunctionLevel]]
 +
|-
 +
| 0x1 || 0x3 || Reserved
 +
|}
 +
 
 +
== IrSensorFunctionLevel ==
 +
This is "nn::irsensor::IrSensorFunctionLevel".
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Value || SystemVersion
 +
|-
 +
| 0 || [1.0.0+]
 +
|-
 +
| 1 || [4.0.0+]
 +
|-
 +
| 2 || [5.0.0+]
 +
|-
 +
| 3 || [6.0.0+]
 +
|-
 +
| 4 || [8.0.0+]
 +
|}
 +
 
 +
= ImageTransferProcessorExConfig =
 +
This is "nn::irsensor::ImageTransferProcessorExConfig".
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x8 || ExposureTime
 +
|-
 +
| 0x8 || 0x4 || LightTarget
 +
|-
 +
| 0xC || 0x4 || Gain
 +
|-
 +
| 0x10 || 0x1 || IsNegativeImageUsed
 +
|-
 +
| 0x11 || 0x7 || Reserved
 +
|-
 +
| 0x18 || 0x4 || [[#ImageTransferProcessorFormat|OrigFormat]]
 +
|-
 +
| 0x1C || 0x4 || [[#ImageTransferProcessorFormat|TrimmingFormat]]
 +
|-
 +
| 0x20 || 0x2 || TrimmingStartX
 +
|-
 +
| 0x22 || 0x2 || TrimmingStartY
 +
|-
 +
| 0x24 || 0x1 || IsExternalLightFilterEnabled
 +
|}
 +
 
 +
= PackedImageTransferProcessorExConfig =
 +
This is "nn::irsensor::PackedImageTransferProcessorExConfig".
 +
 
 +
This is converted from [[#ImageTransferProcessorExConfig]].
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x8 || ExposureTime
 +
|-
 +
| 0x8 || 0x1 || LightTarget
 +
|-
 +
| 0x9 || 0x1 || Gain
 +
|-
 +
| 0xA || 0x1 || IsNegativeImageUsed
 +
|-
 +
| 0xB || 0x5 || Reserved
 +
|-
 +
| 0x10 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
 +
|-
 +
| 0x14 || 0x1 || [[#ImageTransferProcessorFormat|OrigFormat]]
 +
|-
 +
| 0x15 || 0x1 || [[#ImageTransferProcessorFormat|TrimmingFormat]]
 +
|-
 +
| 0x16 || 0x2 || TrimmingStartX
 +
|-
 +
| 0x18 || 0x2 || TrimmingStartY
 +
|-
 +
| 0x1A || 0x1 || IsExternalLightFilterEnabled
 +
|-
 +
| 0x1B || 0x5 || Reserved
 +
|}
 +
 
 +
= IrLedProcessorConfig =
 +
This is "nn::irsensor::IrLedProcessorConfig".
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x4 || LightTarget
 +
|}
 +
 
 +
= PackedIrLedProcessorConfig =
 +
This is "nn::irsensor::PackedIrLedProcessorConfig".
 +
 
 +
This is converted from [[#IrLedProcessorConfig]].
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
 +
|-
 +
| 0x4 || 0x1 || LightTarget
 +
|-
 +
| 0x5 || 0x3 || Padding
 +
|}
 +
 
 +
= AdaptiveClusteringProcessorConfig =
 +
This is "nn::irsensor::AdaptiveClusteringProcessorConfig".
 +
 
 +
AdaptiveClusteringProcessor was added with [5.0.0+].
 +
 
 +
This is converted to [[#TeraPluginProcessorConfig]] by the user-process. [[#TeraPluginProcessorConfig]]+0x3 is zero.
 +
 
 +
The default config is all-zero.
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x4 || [[#AdaptiveClusteringMode]]
 +
|-
 +
| 0x4 || 0x4 || [6.0.0+] [[#AdaptiveClusteringTargetDistance]]
 +
|}
 +
 
 +
== AdaptiveClusteringMode ==
 +
{| class="wikitable" border="1"
 +
!  Value
 +
!  Description
 +
|-
 +
| 0 || StaticFov
 +
|-
 +
| 1 || DynamicFov
 +
|}
 +
 
 +
Controls the mode for [[#TeraPluginProcessorConfig]] (DynamicFov -> 0x10; StaticFov -> 0x0F).
 +
 
 +
== AdaptiveClusteringTargetDistance ==
 +
{| class="wikitable" border="1"
 +
!  Value
 +
!  Description
 +
|-
 +
| 0 || Near
 +
|-
 +
| 1 || Middle
 +
|-
 +
| 2 || Far
 +
|}
 +
 
 +
Controls the second and third bytes for [[#TeraPluginProcessorConfig]] (Near-> 0x00, 0x00; Middle -> 0x01, 0x03; Far -> 0x01, 0x08).
 +
 
 +
= HandAnalysisConfig =
 +
This is "nn::irsensor::HandAnalysisConfig".
 +
 
 +
This is converted to [[#TeraPluginProcessorConfig]] by the user-process, which is all-zero except the mode.
 +
* pre-4.0.0: [[#TeraPluginProcessorConfig]] mode = [[#HandAnalysisMode]] - 1.
 +
* [4.0.0+]: Silhouette = 0x5, Image = 0x6, SilhouetteAndImage = 0x7, SilhouetteOnly = 0xA.
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x4 || [[#HandAnalysisMode]]
 +
|}
 +
 
 +
== HandAnalysisMode ==
 +
{| class="wikitable" border="1"
 +
!  Value
 +
!  Description
 +
|-
 +
| 0 || None (invalid)
 +
|-
 +
| 1 || Silhouette
 +
|-
 +
| 2 || Image
 +
|-
 +
| 3 || SilhouetteAndImage
 +
|-
 +
| 4 || [4.0.0+] SilhouetteOnly
 +
|}
 +
 
 +
= BusHandle =
 +
This is "nn::hidbus::BusHandle".
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x4 || AbstractedPadId
 +
|-
 +
| 0x4 || 0x1 || InternalIndex
 +
|-
 +
| 0x5 || 0x1 || PlayerNumber
 +
|-
 +
| 0x6 || 0x1 || BusTypeId
 +
|-
 +
| 0x7 || 0x1 || IsValid
 +
|}
 +
 
 +
= JoyPollingReceivedData =
 +
This is "nn::hidbus::JoyPollingReceivedData".
 +
 
 +
This is copied from the entries in [[#EnableJoyPollingReceiveMode|TransferMemory]] by GetJoyPollingReceivedData.
 +
 
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset || Size || Description
 +
|-
 +
| 0x0 || 0x30 || Data
 +
|-
 +
| 0x30 || 0x8 || Size of data.
 +
|-
 +
| 0x38 || 0x8 || Timestamp
 +
|}
 +
 
 +
= BusType =
 +
This is "nn::hidbus::BusType".
 +
 
 +
{| class="wikitable" border="1"
 +
!  Value
 +
!  Description
 +
|-
 +
| 0 || JoyLeftRail
 +
|-
 +
| 1 || JoyRightRail
 +
|-
 +
| 2 || [6.0.0+] LarkRightRail (for microphone)
 +
|}
 +
 
 +
= JoyPollingMode =
 +
This is "nn::hidbus::JoyPollingMode".
 +
 
 +
{| class="wikitable" border="1"
 +
!  Value
 +
!  Description
 +
|-
 +
| 0 || sdknso uses <code>GetJoyDisableSixAxisPollingDataAccessor</code> with this.
 +
|-
 +
| 1 || sdknso uses <code>GetJoyEnableSixAxisPollingDataAccessor</code> with this.
 +
|-
 +
| 2 || [6.0.0+] sdknso uses <code>GetJoyButtonOnlyPollingDataAccessor</code> with this.
 +
|}
 +
 
 +
Other values causes [[#EnableJoyPollingReceiveMode]] to assert.
 +
 
 +
= ExternalDevices =
 +
The following devices are used via hidbus:
 +
* [[Ring-Con]]
 +
* Famicom right controller (with microphone)
 +
 
 +
= RomFS =
 +
The hid-sysmodule RomFS contains:
 +
  ftmFwUpdate
 +
    ├── NTD_4CD_1801.fts256
 +
    ├── NTD_4CD_2602.fts256
 +
    ├── NTD_4CD_3801.fts256
 +
    └── NTD_4CD_xxxx.fts256 [7.0.0+]
 +
 
 +
These are firmware files for the touchscreen controller.
 +
 
 +
[9.0.0+] The hid-sysmodule RomFS now contains:
 +
  ftmFwUpdate
 +
    ├── FTS_00120100.fts256
 +
    ├── FTS_32000001.fts256
 +
    ├── FTS_32000102.fts256
 +
    ├── FTS_32000302.fts256
 +
    └── FTS_32000402.fts256
 +
 
 +
= Firmware update =
 +
HID-sysmodule mounts the contents of title [[Title_list|0100000000000822]] as "systemData" or the contents of title [[Title_list|010000000000B22B]] as "systemDataD". Both titles contain the same files, but [[Title_list|0100000000000822]] is used on retail units while [[Title_list|010000000000B22B]] is used for development.
  
{| class="wikitable" border="1"
+
[10.0.0+]: The RomFs for hid-sysmodule was removed, the data which used to be in that RomFs was moved into this SystemData (the below .fts256 files).
|-
 
! 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.
+
These titles contain the following files:
 
+
* '''ExpectVersionInfo.csv''' - List in the format "[device],[type],[version]" where "device" can be "JoyLeft", "JoyRight", "FullKey", "Palma" or "Handheld", "type" can be "BT", "MCU", "USB" or "SioH" and "version" is the hexadecimal representation of the firmware file's version.
= Firmware update =
+
* '''FirmwareInfo.csv''' - List in the format "[device],[type],[version],[file]" where "device", "type" and "version" should match the values from "ExpectVersionInfo" and "file" is the name of the firmware file.
Starting with [[3.0.0]] HID-sysmodule now contains strings for data stored in title [[Title_list|0100000000000822]].
+
* '''ukyosakyo_ep2_ota.bin''' - Left/Right Joy-Con BT firmware.
 +
* '''raizo_ep2_ota.bin''' - Pro Controller BT firmware.
 +
* '''tera_ota.bin''' - Right Joy-Con MCU firmware.
 +
* '''tera_ota_iap.bin''' - Right Joy-Con MCU (IAP profile) firmware.
 +
* '''tera_fullkey_ota.bin''' - Pro Controller MCU firmware.
 +
* '''tera_fullkey_ota_iap.bin''' - Pro Controller MCU (IAP profile) firmware.
 +
* [6.0.0+] '''ProController.dfu''' - Pro Controller USB firmware.
 +
* [6.1.0+] '''PalmaFw.bin''' - Poké Ball Plus BT firmware.
 +
* [9.0.0+] '''ExpectVersionInfo-platform.hoag.csv''' - Same as "ExpectVersionInfo.csv" but for the Switch Lite platform.
 +
* [9.0.0+] '''FirmwareInfo-platform.hoag.csv''' - Same as "FirmwareInfo.csv" but for the Switch Lite platform.
 +
* [9.0.0+] '''sioh.bin''' - Switch Lite Joy-Con firmware.
 +
* [9.0.0+] '''sioh_iap.bin''' - Switch Lite Joy-Con (IAP profile) firmware.
 +
* [10.0.0+] '''FTS_00120100.fts256'''
 +
* [10.0.0+] '''FTS_32000001.fts256'''
 +
* [10.0.0+] '''FTS_32000102.fts256'''
 +
* [10.0.0+] '''FTS_32000302.fts256'''
 +
* [10.0.0+] '''FTS_32000402.fts256'''
 +
* [10.0.0+] '''TouchScreenConfiguration.csv'''
 +
* [10.0.0+] '''TouchScreenFirmwareInfo.csv'''
  
 
[[Category:Services]]
 
[[Category:Services]]

Latest revision as of 21:45, 31 May 2020

See here for the HID shared-memory.

Contents

hid

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

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 [3.0.0+] #ActivateConsoleSixAxisSensor
301 [3.0.0+] StartConsoleSixAxisSensor
302 [3.0.0+] 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 [3.0.0+] IsUsbFullKeyControllerEnabled
401 [3.0.0+] EnableUsbFullKeyController
402 [3.0.0+] IsUsbFullKeyControllerConnected
403 [4.0.0+] HasBattery
404 [4.0.0+] HasLeftRightBattery
405 [4.0.0+] #GetNpadInterfaceType
406 [4.0.0+] GetNpadLeftRightInterfaceType
407 [10.0.0+] GetNpadOfHighestBatteryLevel ([9.0.0+] GetNpadOfHighestBatteryLevelForJoyLeft)
408 [9.0.0-9.2.0] GetNpadOfHighestBatteryLevelForJoyRight
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
1002 [9.0.0+] SetTouchScreenConfiguration
1003 [9.0.0+] IsFirmwareUpdateNeededForNotification
2000 [10.0.0+] ActivateDigitizer

CreateAppletResource

Takes a PID and an u64 AppletResourceUserId. Returns an #IAppletResource.

SetSixAxisSensorFusionParameters

Takes a PID-descriptor, an u32 #SixAxisSensorHandle, two floats, and an u64 AppletResourceUserId, no output.

Official sw will throw an error before using this cmd, if the first float is outside of the bounds of 0.0f-1.0f.

GetSixAxisSensorFusionParameters

Takes a PID-descriptor, an u32 #SixAxisSensorHandle, and an u64 AppletResourceUserId, returns two output floats.

ResetSixAxisSensorFusionParameters

Takes a PID-descriptor, an u32 #SixAxisSensorHandle, and an u64 AppletResourceUserId, no output.

SetGyroscopeZeroDriftMode

Takes a PID-descriptor, an u32 #SixAxisSensorHandle, an u32 #GyroscopeZeroDriftMode, and an u64 AppletResourceUserId, no output.

GetGyroscopeZeroDriftMode

Takes a PID-descriptor, an u32 #SixAxisSensorHandle, and an u64 AppletResourceUserId, returns an output u32 #GyroscopeZeroDriftMode.

Gets the value written by #SetGyroscopeZeroDriftMode.

ResetGyroscopeZeroDriftMode

Takes a PID-descriptor, an u32 #SixAxisSensorHandle, and an u64 AppletResourceUserId, no output.

Same as #SetGyroscopeZeroDriftMode except the #GyroscopeZeroDriftMode is hard-coded to value 1 (Standard).

SetSupportedNpadStyleSet

Takes a PID-descriptor, an u32 #NpadStyleTag, and an u64 AppletResourceUserId, no output.

GetSupportedNpadStyleSet

Takes a PID-descriptor and an u64 AppletResourceUserId, returns an u32 #NpadStyleTag.

SetSupportedNpadIdType

Takes a PID-descriptor, a type-0x9 input buffer, and an AppletResourceUserId. No output.

The input buffer contains an array of u32 #NpadIdType.

ActivateNpad

Takes a PID-descriptor and an AppletResourceUserId. No output.

On newer sysvers this runs the same code as #ActivateNpadWithRevision, with revision=0.

DeactivateNpad

Takes a PID-descriptor and an AppletResourceUserId. No output.

This just returns 0.

AcquireNpadStyleSetUpdateEventHandle

Takes a PID, an input u32, an u64 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.

ActivateNpadWithRevision

Takes a PID-descriptor, a s32 revision, and an AppletResourceUserId. No output.

Revisions:

  • 0x0: Initial revision, pre-5.0.0.
  • 0x1: [5.0.0+]
  • 0x2: [6.0.0+]
  • 0x3: [8.0.0+]

SetNpadJoyHoldType

Takes a PID-descriptor, a s64, and an AppletResourceUserId. No output.

GetNpadJoyHoldType

Takes a PID-descriptor and an AppletResourceUserId. Returns an output s64.

SetNpadJoyAssignmentModeSingleByDefault

Takes a PID-descriptor, an u32, and an AppletResourceUserId. No output.

SetNpadJoyAssignmentModeSingle

Takes a PID-descriptor, an u32, AppletResourceUserId, and s64 NpadJoyDeviceType. No output.

SetNpadJoyAssignmentModeDual

Takes a PID-descriptor, an u32, and an AppletResourceUserId. No output.

MergeSingleJoyAsDualJoy

Takes a PID-descriptor, two u32s, and an AppletResourceUserId. No output.

GetNpadHandheldActivationMode

Takes a PID and an u64 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 AppletResourceUserId. No output.

GetActualVibrationValue

Takes a PID-descriptor, a #VibrationDeviceHandle, and an u64 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 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 PID, an #VibrationDeviceHandle, and an u64 AppletResourceUserId, returns an output u8 bool.

ActivateConsoleSixAxisSensor

Takes a PID and an u64 AppletResourceUserId, no output.

As of [10.0.0+] sdknso no longer uses this.

ActivateSevenSixAxisSensor

Takes a PID and an u64 AppletResourceUserId, no output.

Unused by official sw, #ActivateConsoleSixAxisSensor is used instead. However, internally ActivateSevenSixAxisSensor is identical to #ActivateConsoleSixAxisSensor. Deactivation is done with hiddbg DeactivateConsoleSixAxisSensor (which is unused by official sw).

StartSevenSixAxisSensor

Takes a PID and an u64 AppletResourceUserId, no output.

StopSevenSixAxisSensor

Takes a PID and an u64 AppletResourceUserId, no output.

InitializeSevenSixAxisSensor

Takes a PID, an u64 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. sdknso uses an user-specified buffer for this, with the second tmem immediately following the first one. sdknso later uses data at buf+0 for loading SevenSixAxisSensor state.

The data at tmem+0 has the following structure:

Offset Size Description
0x0 0x10 Unused by sdknso.
0x10 0x8 Latest entry.
0x18 0x8 Total entries.
0x20 0xA50(0x21*0x50) Array of the below entries.

Entry:

Offset Size Description
0x0 0x8 Timestamp
0x8 0x10 Unused by sdknso.
0x10 0x40 SevenSixAxisSensorState

SevenSixAxisSensorState:

Offset Size Description
0x0 0x8 First timestamp.
0x8 0x8 Second timestamp (in samples).
0x10 0x8 ?
0x18 0x28 float data

FinalizeSevenSixAxisSensor

Takes a PID and an u64 AppletResourceUserId, no output.

SetSevenSixAxisSensorFusionStrength

Takes a PID, a float, and an u64 AppletResourceUserId, no output.

GetSevenSixAxisSensorFusionStrength

Takes a PID and an u64 AppletResourceUserId, returns an output float.

ResetSevenSixAxisSensorTimestamp

Takes a PID and an u64 AppletResourceUserId, no output.

GetNpadInterfaceType

Takes an input u32 NpadIdType, returns an output u8 #NpadInterfaceType.

The NpadInterfaceType must be 1-4, otherwise this will assert.

IAppletResource

Cmd Name
0 #GetSharedMemoryHandle

GetSharedMemoryHandle

No input. Returned a sharedmem handle.

IActiveVibrationDeviceList

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

Cmd Name
0 #ActivateVibrationDevice

ActivateVibrationDevice

Takes an input #VibrationDeviceHandle. No output.

SixAxisSensorHandle

This is an u32.

VibrationDeviceHandle

This is an u32.

VibrationDeviceInfo

This is a 0x8-byte struct.

VibrationValue

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

hid:dbg

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

Cmd Name
0 DeactivateDebugPad
1 SetDebugPadAutoPilotState
2 UnsetDebugPadAutoPilotState
10 DeactivateTouchScreen
11 SetTouchScreenAutoPilotState
12 UnsetTouchScreenAutoPilotState
13 [9.0.0+] GetTouchScreenConfiguration
20 DeactivateMouse
21 SetMouseAutoPilotState
22 UnsetMouseAutoPilotState
30 DeactivateKeyboard
31 SetKeyboardAutoPilotState
32 UnsetKeyboardAutoPilotState
50 DeactivateXpad
51 [1.0.0-9.2.0] SetXpadAutoPilotState
52 [1.0.0-9.2.0] UnsetXpadAutoPilotState
53 ([1.0.0-8.1.0] 60) [1.0.0-9.2.0] #DeactivateJoyXpad
60 [9.0.0+] ClearNpadSystemCommonPolicy
61 [10.0.0+] DeactivateNpad
62 [10.0.0+] ForceDisconnectNpad
91 DeactivateGesture
110 DeactivateHomeButton
111 SetHomeButtonAutoPilotState
112 UnsetHomeButtonAutoPilotState
120 DeactivateSleepButton
121 SetSleepButtonAutoPilotState
122 UnsetSleepButtonAutoPilotState
123 [1.0.0-9.2.0] DeactivateInputDetector
130 DeactivateCaptureButton
131 SetCaptureButtonAutoPilotState
132 UnsetCaptureButtonAutoPilotState
133 [3.0.0+] SetShiftAccelerometerCalibrationValue
134 [3.0.0+] GetShiftAccelerometerCalibrationValue
135 [3.0.0+] SetShiftGyroscopeCalibrationValue
136 [3.0.0+] GetShiftGyroscopeCalibrationValue
140 [3.0.0+] 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
152 [10.0.0+] GetWhoAmI
201 ActivateFirmwareUpdate
202 DeactivateFirmwareUpdate
203 #StartFirmwareUpdate
204 GetFirmwareUpdateStage
205 #GetFirmwareVersion
206 #GetDestinationFirmwareVersion
207 #DiscardFirmwareInfoCacheForRevert
208 [3.0.0+] StartFirmwareUpdateForRevert
209 [3.0.0+] GetAvailableFirmwareVersionForRevert
210 [4.0.0+] IsFirmwareUpdatingDevice
211 [6.0.0+] StartFirmwareUpdateIndividual
215 [6.0.0+] SetUsbFirmwareForceUpdateEnabled
216 [6.0.0+] SetAllKuinaDevicesToFirmwareUpdateMode
221 [3.0.0+] #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
236 [9.0.0+] RequestKuinaUartClockCal
237 [9.0.0+] GetKuinaUartClockCal
238 [9.0.0+] SetKuinaUartClockTrim
239 [9.0.0+] KuinaLoopbackTest
240 [9.0.0+] RequestBatteryVoltage
241 [9.0.0+] GetBatteryVoltage
242 [9.0.0+] GetUniquePadPowerInfo
243 [9.0.0+] RebootUniquePad
244 [9.0.0+] RequestKuinaFirmwareVersion
245 [9.0.0+] GetKuinaFirmwareVersion
246 [9.0.0+] GetVidPid
301 [5.0.0-8.1.0] #GetAbstractedPadHandles
302 [5.0.0-8.1.0] #GetAbstractedPadState
303 [5.0.0-8.1.0] #GetAbstractedPadsState
321 [5.0.0-8.1.0] #SetAutoPilotVirtualPadState
322 [5.0.0-8.1.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
402 [10.0.0+] EnableWiredPairing
403 [10.0.0+] EnableShipmentModeAutoClear
500 [8.0.0+] SetFactoryInt
501 [8.0.0+] IsFactoryBootEnabled
550 [9.0.0+] SetAnalogStickModelDataTemporarily
551 [9.0.0+] GetAnalogStickModelData
552 [9.0.0+] ResetAnalogStickModelData
600 [10.0.0+] ConvertPadState
2000 [10.0.0+] DeactivateDigitizer
2001 [10.0.0+] SetDigitizerAutoPilotState
2002 [10.0.0+] UnsetDigitizerAutoPilotState

StartFirmwareUpdate

Takes a total of 0x20-bytes of input, 2 handles, and returns an output handle.

[3.0.0+] Now takes a total of 8-bytes of input, and no longer uses any input/output handles.

GetFirmwareVersion

Takes a total of 8-bytes of input, and returns a total of 4-bytes of output.

[3.0.0+] Now returns an additional 0xC-bytes of output.

GetDestinationFirmwareVersion

Takes a total of 8-bytes of input, and returns a total of 4-bytes of output.

[3.0.0+] Now returns an additional 0xC-bytes of output.

DiscardFirmwareInfoCacheForRevert

Takes a total of 8-bytes of input, and returns a total of 5-bytes of output.

[3.0.0+] No input/output.

UpdateControllerColor

Takes two input u32s for the colors, an #UniquePadId, and no output.

A state flag must be clear, otherwise an error is thrown. Afterwards, this flag is set.

Sends the spi-write subcommand to the specified controller, for writing the 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.

UpdateDesignInfo

Takes 4 input u32s for the colors, an input u8, an input #UniquePadId, and no output.

A state flag must be clear (same as #UpdateControllerColor), otherwise an error is thrown. Afterwards, this flag is set.

Sends the spi-write subcommand to the specified controller, for writing to offset 0x6050 size 0xD. The first 3-bytes from each u32 is used for the spi-write-data, with the u8 being copied immediately afterwards the color data.

GetUniquePadDriverState

Takes a total of 8-bytes of input, returns a total of 0x20-bytes of output.

[9.0.0+] Now takes a total of 8-bytes of input, returns a total of 0x18-bytes of output.

GetSixAxisSensorDriverStates

Takes a total of 8-bytes of input and a type-0xA output buffer, returns a total of 8-bytes of output.

[9.0.0+] Now takes a total of 8-bytes of input and a type-0x6 output buffer, returns a total of 8-bytes of output.

AcquireOperationEventHandle

Takes an input #UniquePadId, returns an output Event handle. The EventClearMode used by official sw is user-specified.

This is not used internally by sdk-nso besides exposing it to the user. With the sdk-nso for [9.0.0+] the wrapper funcs for this was removed (sdk-nso still has the actual cmd).

This must be used before #ReadSerialFlash/#WriteSerialFlash. Afterwards, this Event is used to wait for the async operation started by #ReadSerialFlash/#WriteSerialFlash to finish. After waiting on the Event, #GetOperationResult should be used.

ReadSerialFlash

Takes an input TransferMemory handle, an input u32 offset, an input u64 size, and an #UniquePadId, no output.

Reads from the specified controller's spi-flash. The input size is the original size without page-alignment. The TransferMemory permissions is RW-.

See also #AcquireOperationEventHandle.

With the sdk-nso for [9.0.0+] the wrapper funcs for this was removed (sdk-nso still has the actual cmd).

WriteSerialFlash

Takes an input TransferMemory handle, an input u32 offset, an input u64 tmem_size, an input u64 size, and an #UniquePadId, no output.

Writes to the specified controller's spi-flash. The TransferMemory permissions is R--.

See also #AcquireOperationEventHandle.

With the sdk-nso for [9.0.0+] the wrapper funcs for this was removed (sdk-nso still has the actual cmd).

GetOperationResult

Takes an input #UniquePadId, no output.

Get the Result for the Operation and handles cleanup, for the specified controller.

This is not used internally by sdk-nso besides exposing it to the user. With the sdk-nso for [9.0.0+] the wrapper funcs for this was removed (sdk-nso still has the actual cmd).

GetUniquePadDeviceTypeSetInternal

Takes an input #UniquePadId, returns an #DeviceTypeInternal.

GetAbstractedPadHandles

Takes a type-0xA output buffer containing an array of u64 AbstractedPadHandle and returns an output s32 for total entries.

Returns a handle for each controller detected by the system.

GetAbstractedPadState

Takes an input u64 AbstractedPadHandle, returns an output #AbstractedPadState.

GetAbstractedPadsState

Takes a type-0xA output buffer containing an array of u64 AbstractedPadHandle, a type-0x22 output buffer containing an array of #AbstractedPadState, and returns an output s32 for total entries.

SetAutoPilotVirtualPadState

Takes an input s8 AbstractedVirtualPadId and an input #AbstractedPadState, no output.

UnsetAutoPilotVirtualPadState

Takes an input s8 AbstractedVirtualPadId, no output.

Clears AutoPilot state for the specified pad.

UnsetAllAutoPilotVirtualPadState

No input/output.

Same as #UnsetAutoPilotVirtualPadState except this clears state for every pad.

AttachHdlsWorkBuffer

Takes an input TransferMemory handle and an u64 for the TransferMemory size, no output.

Official user-processes use TransferMemory size=0x1000 and permissions=RW.

This TransferMemory is used as input/output by the other Hdls commands.

Hdls is for virtual HID controllers.

ReleaseHdlsWorkBuffer

No input/output.

DumpHdlsNpadAssignmentState

No input/output.

After using this cmd, the output #HdlsNpadAssignment is located at tmem+0.

DumpHdlsStates

No input/output.

After using this cmd, the output #HdlsStateList struct is located at tmem+0.

ApplyHdlsNpadAssignmentState

Takes an input u8 bool, no output.

Prior to using this cmd, the input #HdlsNpadAssignment is written to tmem+0 by the user-process.

ApplyHdlsStateList

No input/output.

Prior to using this cmd, the input #HdlsStateList is written to tmem+0 by the user-process.

The #HdlsState will be applied for each HdlsHandle. If a HdlsHandle is not found, code similar to #AttachHdlsVirtualDevice will run with the #HdlsDeviceInfo, then it will continue with applying state with the new device.

AttachHdlsVirtualDevice

Takes an #HdlsDeviceInfo, returns a 8-byte HdlsHandle.

DetachHdlsVirtualDevice

Takes an input 8-byte HdlsHandle, no output.

SetHdlsState

Takes an input #HdlsState and an input 8-byte HdlsHandle, no output.

[9.0.0+] Input order was swapped: now takes an input 8-byte HdlsHandle and a #HdlsState, no output.

hid:sys

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

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
232 [10.0.0+] GetIrSensorState
233 [10.0.0+] GetXcdHandleForNpadWithIrSensor
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
313 [9.0.0+] GetNpadCaptureButtonAssignment
314 [9.0.0+] GetAppletFooterUiType
315 [9.0.0+] GetAppletDetailedUiType
316 [10.0.0+] GetNpadInterfaceType
317 [10.0.0+] GetNpadLeftRightInterfaceType
318 [10.0.0+] HasBattery
319 [10.0.0+] HasLeftRightBattery
321 [3.0.0+] #GetUniquePadsFromNpad
322 [10.0.0+] SetNpadSystemExtStateEnabled ([1.0.0-9.2.0] GetIrSensorState)
323 [10.0.0+] GetLastActiveUniquePad ([1.0.0-9.2.0] GetXcdHandleForNpadWithIrSensor)
324 [10.0.0+] GetUniquePadButtonSet
325 [10.0.0+] GetUniquePadColor
326 [10.0.0+] GetUniquePadAppletDetailedUiType
500 SetAppletResourceUserId
501 RegisterAppletResourceUserId
502 UnregisterAppletResourceUserId
503 EnableAppletToGetInput
504 SetAruidValidForVibration
505 EnableAppletToGetSixAxisSensor
510 #SetVibrationMasterVolume
511 GetVibrationMasterVolume
512 [3.0.0+] BeginPermitVibrationSession
513 [3.0.0+] EndPermitVibrationSession
520 EnableHandheldHids
521 DisableHandheldHids
522 [9.0.0+] SetJoyConRailEnabled
523 [9.0.0+] IsJoyConRailEnabled
524 [10.0.0+] IsHandheldHidsEnabled
540 AcquirePlayReportControllerUsageUpdateEvent
541 GetPlayReportControllerUsages
542 AcquirePlayReportRegisteredDeviceUpdateEvent
543 GetRegisteredDevicesOld ([1.0.0-4.1.0] GetRegisteredDevices)
544 [3.0.0+] AcquireConnectionTriggerTimeoutEvent
545 [3.0.0+] SendConnectionTrigger
546 [3.0.0+] AcquireDeviceRegisteredEventForControllerSupport
547 [3.0.0+] 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 [3.0.0+] GetUniquePadBluetoothAddress
806 [3.0.0+] 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
831 [9.0.0+] #SetNotificationLedPatternWithTimeout
832 [9.0.0+] #PrepareHidsForNotificationWake
850 [3.0.0+] IsUsbFullKeyControllerEnabled
851 [3.0.0+] EnableUsbFullKeyController
852 [3.0.0+] IsUsbConnected
870 [5.1.0+] IsHandheldButtonPressedOnConsoleMode
900 [1.0.0-9.2.0] ActivateInputDetector
901 [1.0.0-9.2.0] #NotifyInputDetector
1000 [3.0.0+] InitializeFirmwareUpdate
1001 [3.0.0+] GetFirmwareVersion
1002 [3.0.0+] GetAvailableFirmwareVersion
1003 [3.0.0+] IsFirmwareUpdateAvailable
1004 [3.0.0+] CheckFirmwareUpdateRequired
1005 [3.0.0+] StartFirmwareUpdate
1006 [3.0.0+] AbortFirmwareUpdate
1007 [3.0.0+] 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
1151 [9.0.0+] GetTouchScreenFirmwareVersion
1152 [9.0.0+] SetTouchScreenDefaultConfiguration
1153 [9.0.0+] GetTouchScreenDefaultConfiguration
1154 [9.0.0+] IsFirmwareAvailableForNotification
1155 [9.0.0+] SetForceHandheldStyleVibration
1156 [9.0.0+] SendConnectionTriggerWithoutTimeoutEvent
1157 [10.0.0+] #CancelConnectionTrigger
1200 [10.0.0+] #IsButtonConfigSupported
1201 [10.0.0+] #DeleteButtonConfig
1202 [10.0.0+] #SetButtonConfigEnabled
1203 [10.0.0+] #IsButtonConfigEnabled
1204 [10.0.0+] #SetButtonConfigEmbedded
1205 [10.0.0+] #SetButtonConfigFull
1206 [10.0.0+] #SetButtonConfigLeft
1207 [10.0.0+] #SetButtonConfigRight
1208 [10.0.0+] #GetButtonConfigEmbedded
1209 [10.0.0+] #GetButtonConfigFull
1210 [10.0.0+] #GetButtonConfigLeft
1211 [10.0.0+] #GetButtonConfigRight
1250 [10.0.0+] #IsCustomButtonConfigSupported
1251 [10.0.0+] #IsDefaultButtonConfigEmbedded
1252 [10.0.0+] #IsDefaultButtonConfigFull
1253 [10.0.0+] #IsDefaultButtonConfigLeft
1254 [10.0.0+] #IsDefaultButtonConfigRight
1255 [10.0.0+] #IsButtonConfigStorageEmbeddedEmpty
1256 [10.0.0+] #IsButtonConfigStorageFullEmpty
1257 [10.0.0+] #IsButtonConfigStorageLeftEmpty
1258 [10.0.0+] #IsButtonConfigStorageRightEmpty
1259 [10.0.0+] #GetButtonConfigStorageEmbedded
1260 [10.0.0+] #GetButtonConfigStorageFull
1261 [10.0.0+] #GetButtonConfigStorageLeft
1262 [10.0.0+] #GetButtonConfigStorageRight
1263 [10.0.0+] #SetButtonConfigStorageEmbedded
1264 [10.0.0+] #SetButtonConfigStorageFull
1265 [10.0.0+] #SetButtonConfigStorageLeft
1266 [10.0.0+] #SetButtonConfigStorageRight
1267 [10.0.0+] #DeleteButtonConfigStorageEmbedded
1268 [10.0.0+] #DeleteButtonConfigStorageFull
1269 [10.0.0+] #DeleteButtonConfigStorageLeft
1270 [10.0.0+] #DeleteButtonConfigStorageRight
1271 [10.0.0+] #IsUsingCustomButtonConfig
1272 [10.0.0+] #IsAnyCustomButtonConfigEnabled
1273 [10.0.0+] #SetAllCustomButtonConfigEnabled
1274 [10.0.0+] #SetDefaultButtonConfig
1275 [10.0.0+] #SetAllDefaultButtonConfig
1276 [10.0.0+] #SetHidButtonConfigEmbedded
1277 [10.0.0+] #SetHidButtonConfigFull
1278 [10.0.0+] #SetHidButtonConfigLeft
1279 [10.0.0+] #SetHidButtonConfigRight
1280 [10.0.0+] #GetHidButtonConfigEmbedded
1281 [10.0.0+] #GetHidButtonConfigFull
1282 [10.0.0+] #GetHidButtonConfigLeft
1283 [10.0.0+] #GetHidButtonConfigRight

GetMaskedSupportedNpadStyleSet

Takes an input u64 AppletResourceUserId, returns an output u32 #NpadStyleTag.

Official sw uses the output from GetAppletResourceUserIdOfCallerApplet with this.

GetUniquePadsFromNpad

Takes an input u32 #NpadIdType, a type-0xA output buffer, and returns an output s64 for total output entries (which is copied to a s32 by official sw).

The output buffer contains an array of #UniquePadId.

SetVibrationMasterVolume

Takes an input 32bit float.

GetUniquePadIds

Takes a type-0xA output buffer, and returns an output s64 for total output entries (which is copied to a s32 by official sw).

The output buffer contains an array of #UniquePadId.

GetUniquePadType

Takes an input #UniquePadId and returns an output u64 #UniquePadType.

SetNotificationLedPattern

Takes an input #NotificationLedPattern and an #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 subcommand.

[9.0.0+] This runs code similar to #SetNotificationLedPatternWithTimeout, except it passes the following param values to an internal func: flag=1 and TimeSpan=0 (with #SetNotificationLedPatternWithTimeout these are flag=0 and TimeSpan={input value}).

SetNotificationLedPatternWithTimeout

Takes an input #NotificationLedPattern, an #UniquePadId, and an s64 TimeSpan, no output.

PrepareHidsForNotificationWake

Takes a type-0x9 input buffer containing an array of #UniquePadId, no output.

NotifyInputDetector

Takes an input u32 bitmask InputSourceId, no output.

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

GetHidbusSystemServiceObject

No input, returns an #IHidbusSystemServer.

CancelConnectionTrigger

Takes an input "nn::bluetooth::Address", no output.

IsButtonConfigSupported

Takes an input #UniquePadId, returns an output bool.

DeleteButtonConfig

Takes an input #UniquePadId, no output.

SetButtonConfigEnabled

Takes an input bool, an #UniquePadId, no output.

IsButtonConfigEnabled

Takes an input #UniquePadId, returns an output bool.

SetButtonConfigEmbedded

Takes an input #UniquePadId, a type-0x15 input buffer containing a #SystemButtonConfigEmbedded, no output.

SetButtonConfigFull

Takes an input #UniquePadId, a type-0x15 input buffer containing a #SystemButtonConfigFull, no output.

SetButtonConfigLeft

Takes an input #UniquePadId, a type-0x15 input buffer containing a #SystemButtonConfigLeft, no output.

SetButtonConfigRight

Takes an input #UniquePadId, a type-0x15 input buffer containing a #SystemButtonConfigRight, no output.

GetButtonConfigEmbedded

Takes an input #UniquePadId, and a type-0x16 output buffer containing a #SystemButtonConfigEmbedded.

GetButtonConfigFull

Takes an input #UniquePadId, and a type-0x16 output buffer containing a #SystemButtonConfigFull.

GetButtonConfigLeft

Takes an input #UniquePadId, and a type-0x16 output buffer containing a #SystemButtonConfigLeft.

GetButtonConfigRight

Takes an input #UniquePadId, and a type-0x16 output buffer containing a #SystemButtonConfigRight.

IsCustomButtonConfigSupported

Takes an input #UniquePadId, returns an output bool.

IsDefaultButtonConfigEmbedded

Takes a type-0x15 input buffer containing a #ButtonConfigEmbedded, returns an output bool.

This compares the input config with config in state, sets the output bool to whether these match, then returns 0.

IsDefaultButtonConfigFull

Takes a type-0x15 input buffer containing a #ButtonConfigFull, returns an output bool.

This compares the input config with config in state, sets the output bool to whether these match, then returns 0.

IsDefaultButtonConfigLeft

Takes a type-0x15 input buffer containing a #ButtonConfigLeft, returns an output bool.

This compares the input config with config in state, sets the output bool to whether these match, then returns 0.

IsDefaultButtonConfigRight

Takes a type-0x15 input buffer containing a #ButtonConfigRight, returns an output bool.

This compares the input config with config in state, sets the output bool to whether these match, then returns 0.

IsButtonConfigStorageEmbeddedEmpty

Takes an input s32 entry-index, returns an output bool.

Uses GetButtonConfigSettingsEmbedded with count=5 (output s32 ignored). The input entry-index is used with this array. Then the output bool is set to IsFull bit0 == 0. Then 0 is returned.

IsButtonConfigStorageFullEmpty

Takes an input s32 entry-index, returns an output bool.

Same as #IsButtonConfigStorageEmbeddedEmpty except with a different setsys cmd.

IsButtonConfigStorageLeftEmpty

Takes an input s32 entry-index, returns an output bool.

Same as #IsButtonConfigStorageEmbeddedEmpty except with a different setsys cmd.

IsButtonConfigStorageRightEmpty

Takes an input s32 entry-index, returns an output bool.

Same as #IsButtonConfigStorageEmbeddedEmpty except with a different setsys cmd.

GetButtonConfigStorageEmbedded

Takes an input s32 entry-index, and a type-0x16 output buffer containing a #ButtonConfigEmbedded.

Uses GetButtonConfigSettingsEmbedded with count=5 (output s32 ignored). The input entry-index is used with this array. Then an error is thrown if IsFull bit0 is clear. Then the data at +0x1C8 is converted to #ButtonConfigEmbedded, copied to output, and returns 0.

GetButtonConfigStorageFull

Takes an input s32 entry-index, and a type-0x16 output buffer containing a #ButtonConfigFull.

Same as #GetButtonConfigStorageEmbedded, except this uses a different setsys cmd, and uses a different conversion func / different output struct.

GetButtonConfigStorageLeft

Takes an input s32 entry-index, and a type-0x16 output buffer containing a #ButtonConfigLeft.

Same as #GetButtonConfigStorageEmbedded, except this uses a different setsys cmd, and uses a different conversion func / different output struct.

GetButtonConfigStorageRight

Takes an input s32 entry-index, and a type-0x16 output buffer containing a #ButtonConfigRight.

Same as #GetButtonConfigStorageEmbedded, except this uses a different setsys cmd, and uses a different conversion func / different output struct.

SetButtonConfigStorageEmbedded

Takes an input s32 entry-index, and a type-0x15 input buffer containing a #ButtonConfigEmbedded.

If the input config matches the default, this first does:

Afterwards, this uses GetButtonConfigSettingsEmbedded with count=5 (output s32 ignored). The input entry-index is used with this array. The input struct is converted, the output from that is copied to +0x1C8 size 0x3E0, IsFull is set, SetButtonConfigSettingsEmbedded is used with the updated array, and then returns 0.

SetButtonConfigStorageFull

Takes an input s32 entry-index, and a type-0x15 input buffer containing a #ButtonConfigFull.

Same as #SetButtonConfigStorageEmbedded, except this uses different setsys cmds, and uses a different structs etc.

SetButtonConfigStorageLeft

Takes an input s32 entry-index, and a type-0x15 input buffer containing a #ButtonConfigLeft.

Same as #SetButtonConfigStorageEmbedded, except this uses different setsys cmds, and uses a different structs etc.

SetButtonConfigStorageRight

Takes an input s32 entry-index, and a type-0x15 input buffer containing a #ButtonConfigRight.

Same as #SetButtonConfigStorageEmbedded, except this uses different setsys cmds, and uses a different structs etc.

DeleteButtonConfigStorageEmbedded

Takes an input s32 entry-index, no output.

Uses GetButtonConfigSettingsEmbedded with count=5 (output s32 ignored). The input entry-index is used with this array. Then an error is thrown if IsFull bit0 is clear. Then the data at +0x1C8 size 0x3E0 is cleared, IsFull bit0 is cleared, SetButtonConfigSettingsEmbedded is used with the updated array, and then returns 0.

DeleteButtonConfigStorageFull

Takes an input s32 entry-index, no output.

Same as #IsButtonConfigStorageEmbeddedEmpty except with different setsys cmds.

DeleteButtonConfigStorageLeft

Takes an input s32 entry-index, no output.

Same as #IsButtonConfigStorageEmbeddedEmpty except with different setsys cmds.

DeleteButtonConfigStorageRight

Takes an input s32 entry-index, no output.

Same as #IsButtonConfigStorageEmbeddedEmpty except with different setsys cmds.

IsUsingCustomButtonConfig

Takes an input #UniquePadId, returns an output bool.

IsAnyCustomButtonConfigEnabled

No input, returns an output bool.

SetAllCustomButtonConfigEnabled

Takes an input bool and an AppletResourceUserId, no output.

SetDefaultButtonConfig

Takes an input #UniquePadId, no output.

SetAllDefaultButtonConfig

No input/output.

SetHidButtonConfigEmbedded

Takes an input #UniquePadId and a type-0x15 input buffer containing a #ButtonConfigEmbedded, no output.

SetHidButtonConfigFull

Takes an input #UniquePadId and a type-0x15 input buffer containing a #ButtonConfigFull, no output.

SetHidButtonConfigLeft

Takes an input #UniquePadId and a type-0x15 input buffer containing a #ButtonConfigLeft, no output.

SetHidButtonConfigRight

Takes an input #UniquePadId and a type-0x15 input buffer containing a #ButtonConfigRight, no output.

GetHidButtonConfigEmbedded

Takes an input #UniquePadId, and a type-0x16 output buffer containing a #ButtonConfigEmbedded.

GetHidButtonConfigFull

Takes an input #UniquePadId, and a type-0x16 output buffer containing a #ButtonConfigFull.

GetHidButtonConfigLeft

Takes an input #UniquePadId, and a type-0x16 output buffer containing a #ButtonConfigLeft.

GetHidButtonConfigRight

Takes an input #UniquePadId, and a type-0x16 output buffer containing a #ButtonConfigRight.

IHidbusSystemServer

This is "nn::hidbus::IHidbusSystemServer".

This was added with [5.0.0+].

Cmd Name
500 SetAppletResourceUserId
501 RegisterAppletResourceUserId
502 UnregisterAppletResourceUserId

hid:tmp

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

This service was added with [3.0.0+], then removed with [8.0.0+].

Cmd Name
0 GetConsoleSixAxisSensorCalibrationValues

irs

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

This was added to sdknso with 3.x.

With sdknso versions pre-4.x PointingProcessor used to be DpdProcessor. The packed-config with DpdProcessor (besides RequiredMcuVersion) used to be initialized from user-specified config, now it's hard-coded.

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 [4.0.0+] #SetFunctionLevel
316 [4.0.0+] #RunImageTransferExProcessor
317 [4.0.0+] #RunIrLedProcessor
318 [4.0.0+] #StopImageProcessorAsync
319 [4.0.0+] #ActivateIrsensorWithFunctionLevel

ActivateIrsensor

Takes a PID-descriptor and an AppletResourceUserId. No output.

DeactivateIrsensor

Takes a PID-descriptor and an AppletResourceUserId. No output.

GetIrsensorSharedMemoryHandle

Takes a PID-descriptor and an AppletResourceUserId. Returns a SharedMemory handle.

The SharedMemory is "nn::irsensor::detail::StatusManager". It's mapped with permission read-only and size 0x8000.

It's structure is as follows:

Offset Size Description
0x0 0x7FB0 Array of #DeviceFormat
0x7FB0 0x50 Array of #AruidFormat

The array of #DeviceFormat is indexed by PlayerNumber and can hold up to 9 entries. The array of #AruidFormat can only hold up to 5 entries.

DeviceFormat

Offset Size Description
0x0 0x4 #IrCameraStatus
0x4 0x4 #IrCameraInternalStatus
0x8 0x8 #IrSensorMode
0x10 0xE20 #ProcessorStateRingLifo

ProcessorStateRingLifo

This is "nn::irsensor::detail::RingLifo<X,Y>" where "X" is a specialized processor state (e.g.: "nn::irsensor::MomentProcessorState") and "Y" is the maximum element count (e.g.: 5).

Offset Size Description
0x0 0x8 Start
0x8 0x4 Count
0xC 0x4 Padding
0x10 Variable ProcessorState

The maximum element count is 6 for #PointingProcessorMarkerState or 5 for any of the other states.

ProcessorState is specialized depending on the value of #IrSensorMode.

MomentProcessorState

This is "nn::irsensor::MomentProcessorState".

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x8 TimeStamp
0x10 0x4 AmbientNoiseLevel
0x14 0x4 Reserved
0x18 0x240 Array of #MomentStatistic

The array of #MomentStatistic can hold up to 48 entries. This array can be accessed as [y + x*8] (this is a 6x8 array). region_x = image_x/6, region_y = image_y/8.

MomentStatistic

In sdknso GetMomentProcessorStates, this loops through each MomentProcessorState->MomentStatistic entry: AverageIntensity *= scale; The scale is calculated with: scale = 76800.0f / (float)(WindowOfInterest.width * WindowOfInterest.height); Note that 76800 == 320*240, hence with the default width/height the calculated scale is 1.0f.

Offset Size Description
0x0 0x4 float AverageIntensity
0x4 0x4 float CentroidX
0x8 0x4 float CentroidY
ClusteringProcessorState

This is "nn::irsensor::ClusteringProcessorState".

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x8 TimeStamp
0x10 0x1 ObjectCount
0x11 0x3 Reserved
0x14 0x4 AmbientNoiseLevel
0x18 0x180 Array of #ClusteringData

The array of #ClusteringData can hold up to 16 entries.

ClusteringData
Offset Size Description
0x0 0x4 float AverageIntensity
0x4 0x4 float CentroidX
0x8 0x4 float CentroidY
0xC 0x4 PixelCount
0x10 0x2 BoundX
0x12 0x2 BoundY
0x14 0x2 BoundtWidth
0x16 0x2 BoundHeight
PointingProcessorMarkerState

This is "nn::irsensor::PointingProcessorMarkerState".

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x8 TimeStamp
0x10 0x1 PointingStatus
0x11 0x3 Reserved
0x14 0x4 Unknown
0x18 0x4 float Unknown
0x1C 0x4 float PositionX
0x20 0x4 float PositionY
0x24 0x4 float Unknown
0x28 0x2 WindowOfInterestX
0x2A 0x2 WindowOfInterestY
0x2C 0x2 WindowOfInterestWidth
0x2E 0x2 WindowOfInterestHeight
0x30 0x1 PointingStatus
0x31 0x3 Reserved
0x34 0x4 Unknown
0x38 0x4 float Unknown
0x3C 0x4 float PositionX
0x40 0x4 float PositionY
0x44 0x4 float Unknown
0x48 0x2 WindowOfInterestX
0x4A 0x2 WindowOfInterestY
0x4C 0x2 WindowOfInterestWidth
0x4E 0x2 WindowOfInterestHeight
0x50 0x1 PointingStatus
0x51 0x3 Reserved
0x54 0x4 Unknown
0x58 0x4 float Unknown
0x5C 0x4 float PositionX
0x60 0x4 float PositionY
0x64 0x4 float Unknown
0x68 0x2 WindowOfInterestX
0x6A 0x2 WindowOfInterestY
0x6C 0x2 WindowOfInterestWidth
0x6E 0x2 WindowOfInterestHeight
PointingProcessorState

This is "nn::irsensor::PointingProcessorState".

This is created from #PointingProcessorMarkerState.

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x8 TimeStamp
0x10 0x4 PointingStatus
0x14 0x4 float PositionX
0x18 0x4 float PositionY
0x1C 0x4 Reserved
TeraPluginProcessorState

This is "nn::irsensor::TeraPluginProcessorState".

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x8 TimeStamp
0x10 0x4 AmbientNoiseLevel
0x14 0x12C PluginData
AdaptiveClusteringProcessorState

This is "nn::irsensor::AdaptiveClusteringProcessorState".

This is created from #TeraPluginProcessorState.

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x8 TimeStamp
0x10 0x4 AmbientNoiseLevel
0x14 0x4 AccuracyLevel
0x18 0x1 ObjectCount
0x19 0x1 BackgroundIntensity
0x1A 0x6 Reserved
0x20 0x200 Array of #AdaptiveClusteringData

The array of #AdaptiveClusteringData can hold up to 16 entries.

AdaptiveClusteringData
Offset Size Description
0x0 0x4 float CentroidX
0x4 0x4 float CentroidY
0x8 0x4 float Area
0xC 0x4 IsIncomplete
HandAnalysisImageState

This is "nn::irsensor::HandAnalysisImageState".

This is created from #TeraPluginProcessorState.

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x4 AmbientNoiseLevel
0xC 0x960 Image
0x96C 0x4 Reserved
HandAnalysisSilhouetteState

This is "nn::irsensor::HandAnalysisSilhouetteState".

This is created from #TeraPluginProcessorState.

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x4 AmbientNoiseLevel
0xC 0x1354 Unknown
HandAnalysisSilhouetteStateWithFullFrameShape

This is "nn::irsensor::HandAnalysisSilhouetteStateWithFullFrameShape".

This is created from #TeraPluginProcessorState.

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x4 AmbientNoiseLevel
0xC 0x156C Unknown

AruidFormat

Offset Size Description
0x0 0x8 IrSensorAruid
0x8 0x8 IrSensorAruidStatus

StopImageProcessor

Takes a PID-descriptor, an #IrCameraHandle, and an AppletResourceUserId. No output.

RunMomentProcessor

Takes a PID-descriptor, an #IrCameraHandle, an AppletResourceUserId, and a #PackedMomentProcessorConfig. No output.

RunClusteringProcessor

Takes a PID-descriptor, an #IrCameraHandle, an AppletResourceUserId, and a #PackedClusteringProcessorConfig. No output.

RunImageTransferProcessor

Takes a PID-descriptor, an #IrCameraHandle, an AppletResourceUserId, a #PackedImageTransferProcessorConfig, an u64 for the TransferMemory's size, and a TransferMemory handle. No output.

The TransferMemory is created with an user specified buffer and permission none.

GetImageTransferProcessorState

Takes a PID-descriptor, a type-0x6 output buffer, an #IrCameraHandle, and an AppletResourceUserId. Returns an #ImageTransferProcessorState. No output.

RunTeraPluginProcessor

Takes a PID-descriptor, an #IrCameraHandle, a #PackedTeraPluginProcessorConfig (immediately after the previous word), and an AppletResourceUserId. No output.

GetNpadIrCameraHandle

Takes an input #NpadIdType. Returns an output #IrCameraHandle.

RunPointingProcessor

Takes a PID-descriptor, an #IrCameraHandle, a #PackedPointingProcessorConfig (immediately after the previous word), and an AppletResourceUserId. No output.

SuspendImageProcessor

Takes a PID-descriptor, an #IrCameraHandle, and an AppletResourceUserId. No output.

sdknso uses this from the Run*Processor funcs to suspend the current Processor when the current FunctionLevel is >= 0x1, prior to starting another Processor if needed (depending on what Processor was already active via a state field). Hence, this cmd is only used with [4.0.0+].

CheckFirmwareVersion

Takes a PID-descriptor, an #IrCameraHandle, a #PackedMcuVersion, and an AppletResourceUserId. No output.

sdknso didn't actually use this until 4.x (the RequiredMcuVersion was also updated with that version).

SetFunctionLevel

Takes a PID-descriptor, an #IrCameraHandle, a #PackedFunctionLevel, and an AppletResourceUserId. No output.

RunImageTransferExProcessor

Takes a PID-descriptor, an #IrCameraHandle, an AppletResourceUserId, a #PackedImageTransferProcessorExConfig, an u64 for the TransferMemory's size, and a TransferMemory handle. No output.

The TransferMemory is created with an user specified buffer and permission none.

RunIrLedProcessor

Takes a PID-descriptor, an #IrCameraHandle, a #PackedIrLedProcessorConfig (immediately after the previous word), and an AppletResourceUserId. No output.

StopImageProcessorAsync

Takes a PID-descriptor, an #IrCameraHandle, and an AppletResourceUserId. No output.

ActivateIrsensorWithFunctionLevel

Takes a PID-descriptor, an #PackedFunctionLevel, and an AppletResourceUserId. No output.

irs:sys

This is "nn::irsensor::IIrSensorSystemServer".

Cmd Name
500 #SetAppletResourceUserId
501 #RegisterAppletResourceUserId
502 #UnregisterAppletResourceUserId
503 #EnableAppletToGetInput

SetAppletResourceUserId

Takes an AppletResourceUserId. No output.

RegisterAppletResourceUserId

Takes a bool and an AppletResourceUserId. No output.

UnregisterAppletResourceUserId

Takes an AppletResourceUserId. No output.

EnableAppletToGetInput

Takes a bool and an AppletResourceUserId. No output.

ahid:cd

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

Used for USB HID devices.

This service no longer exists in [9.0.0+].

Cmd Name
0 #AcquireDevice
1 #ReleaseDevice
2 #GetCtrlSession
3 #GetReadSession
4 [1.0.0-2.3.0] #GetWriteSession

AcquireDevice

Takes an input s32, no output.

ReleaseDevice

Takes an input s32, no output.

GetCtrlSession

Takes an input u32, returns an #ICtrlSession.

GetReadSession

Takes an input u32, returns an #IReadSession.

GetWriteSession

Takes an input u32, returns an #IWriteSession.

ICtrlSession

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

This no longer exists in [9.0.0+].

Cmd Name
0 GetString
1 GetCodeBook
2 GetReport
3 SetReport
4 GetIdle
5 SetIdle
6 GetProtocol
7 SetProtocol
8 GetDescriptor
9 SetDescriptor
10 GetStateChangeEvent
11 SignalStateChangeEvent
12 [3.0.0+] Write

All of these use USB CtrlXfer, except for GetStateChangeEvent and SignalStateChangeEvent, and GetCodeBook which copies 0x4000-bytes from state to output.

IReadSession

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

This no longer exists in [9.0.0+].

Cmd Name
0 #Read

Read

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

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

IWriteSession

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

This was removed with [3.0.0+].

Cmd Name
0 #Write

Write

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.

This service no longer exists in [9.0.0+].

Cmd Name
0 GetDeviceEntries
1 GetDeviceList
2 GetDeviceParameters
3 AttachDevice
4 DetachDevice
5 [6.0.0+] SetDeviceFilter

xcd:sys

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

Cmd Name
0 GetDataFormat
1 SetDataFormat
2 GetMcuState
3 SetMcuState
4 GetMcuVersionForNfc
5 CheckNfcDevicePower
6 [5.0.0+] SetMcuStateImmediate
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
103 [10.0.0+] GetAwakeTriggerBatteryLevelTransitionForLeftRail
104 [10.0.0+] GetAwakeTriggerBatteryLevelTransitionForRightRail

[5.0.0+] SetDataFormat, SetMcuState, and ClearMifareKey: now takes a total of 0xC-bytes of input instead of 0x10.

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

hidbus

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

This was added with [5.0.0+].

Official sw opens a temporary service-session for each func using this, with it being closed once done: no global session is kept open.

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
13 [5.0.0-6.2.0] GetPollingData
14 [6.0.0+] #SetStatusManagerType

sdknso doesn't use the GetPollingData cmd.

GetBusHandle

Takes an input u32 #NpadIdType, an u64 #BusType, an u64 AppletResourceUserId, returns an output u8 bool and a #BusHandle.

The bool indicates whether the #BusHandle is valid.

Official sw will assert when #BusHandle InternalIndex is >=0x11 (>=0x13 with [6.0.0+]). This same check is also done for all funcs using #BusHandle as input.

This cmd will throw an error when #BusType is invalid.

IsExternalDeviceConnected

Takes an input #BusHandle, returns an output u8 bool.

This is not used by sdknso.

Initialize

Takes an input #BusHandle, an u64 AppletResourceUserId, no output.

Prior to using this cmd, sdknso handles sharedmem mapping if not done previously.

Finalize

Takes an input #BusHandle, an u64 AppletResourceUserId, no output.

EnableExternalDevice

Takes an input u8 bool, a #BusHandle, an u64, an u64 AppletResourceUserId, no output.

sdknso passes value 0x38900050018 (0x3A600050018 with 7.x+) for the u64.

The bool flag indicates whether to enable the device (true = enable, false = disable). When false, this will use #DisableJoyPollingReceiveMode if needed.

GetExternalDeviceId

Takes an input #BusHandle, returns an output u32 ExternalDeviceId.

SendCommandAsync

Takes a type-0x21 input buffer and a #BusHandle, no output.

GetSendCommandAsynceResult

Takes a type-0x22 output buffer and a #BusHandle, returns an output u32.

Official sw copies the u32 to an output u64, for the actual output size.

SetEventForSendCommandAsycResult

Takes an input #BusHandle, returns an output Event handle with EventClearMode=0.

Official sw with SendAndReceive clears this event (6.x+ sdknso), uses #SendCommandAsync, waits on + clears this event, then uses #GetSendCommandAsynceResult.

GetSharedMemoryHandle

No input, returns an output SharedMemory handle.

The SharedMemory is mapped with size 0x1000 and permissions=R--.

See also #SetStatusManagerType.

This sharedmem is the StatusManager. This sharedmem contains an array of 0x100-byte (0x80-byte with [6.0.0+]) entries, with entry-count {max BusHandles}.

sdknso only uses the first 0x10-bytes of these entries, the rest is the ignored. Entry structure:

Offset Size Description
0x0 0x1 Bool flag
0x1 0x3 Padding
0x4 0x4 Result
0x8 0x1 DeviceEnabled. Bool flag indicating whether a device is enabled.
0x9 0x1 IsValid. Bool flag indicating whether this entry is valid.
0xA 0x1 PollingEnabled. Bool flag indicating whether polling is enabled.
0xB 0x1 Unknown / padding?
0xC 0x4 #JoyPollingMode

EnableJoyPollingReceiveMode

Takes a type-0x21 input buffer, a TransferMemory handle, an u32 tmem_size, an u32 #JoyPollingMode, a #BusHandle, no output.

The TransferMemory is created with an user-specified output buffer, with permissions=R--.

The content of the TransferMemory depends of the #JoyPollingMode. This is used by GetJoyPollingReceivedData. Structure of the TransferMemory (DisableSixAxisPollingDataAccessor, EnableSixAxisPollingDataAccessor, JoyButtonOnlyPollingDataAccessor):

Offset Size Description
0x0 0x4 Result.
0x0 0x4 Padding.
0x8 0x18 Initialized sysmodule-side, not used by sdknso.
0x20 0x8 Latest entry.
0x28 0x8 Total entries.

The entries specific to the #JoyPollingMode follow, with 0xA entries total. Each entry starts with an u64 timestamp. Structure for each mode, after the timestamp:

DisableSixAxisPollingDataAccessor:

Offset Size Description
0x0 0x26 Data
0x26 0x1 Size of data.
0x27 0x1 Padding
0x28 0x8 Timestamp

JoyEnableSixAxisPollingDataAccessor:

Offset Size Description
0x0 0x8 Data
0x8 0x1 Size of data.
0x9 0x7 Padding
0x10 0x8 Timestamp

JoyButtonOnlyPollingDataAccessor:

Offset Size Description
0x0 0x2C Data
0x2C 0x1 Size of data.
0x2D 0x3 Padding
0x30 0x8 Timestamp

DisableJoyPollingReceiveMode

Takes an input #BusHandle, no output.

SetStatusManagerType

Takes an input u32, no output.

This is used by sdknso immediately after mapping sharedmem (before #Initialize) with hard-coded value 0x2.

GyroscopeZeroDriftMode

This is "nn::hid::GyroscopeZeroDriftMode".

Value Description
0 Loose
1 Standard
2 Tight

NpadStyleTag

This is "nn::hid::NpadStyleTag".

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/Famicom controller
8 NpadHandheldLark NES/Famicom controller in handheld mode
9 NpadLucia SNES controller
10-28 Reserved
29 NpadSystemExt Generic external controller
30 NpadSystem Generic controller
31 Reserved

NpadIdType

This is "nn::hid::NpadIdType". This is the controller index used in sharedmem.

Value Description
0x0 No1
0x1 No2
0x2 No3
0x3 No4
0x4 No5
0x5 No6
0x6 No7
0x7 No8
0x10 Other
0x20 Handheld

NpadInterfaceType

This is "nn::hid::NpadInterfaceType".

Value Description
1 Bluetooth
2 Rail
3 USB
4 Unknown

AbstractedPadState

Offset Size Description
0x0 0x4 Type, only 1 bit can be set. Converted to #HdlsDeviceInfo::type internally by #SetAutoPilotVirtualPadState.
0x4 0x1 Flags. #SetAutoPilotVirtualPadState only uses bit0: when clear it will skip using the rest of the input and run #UnsetAutoPilotVirtualPadState internally.
0x5 0x3 Padding
0x8 0x4 RGBA Single Body Color
0xC 0x4 RGBA Single Buttons Color
0x10 0x1 See #HiddbgHdlsDeviceInfo::#NpadInterfaceType.
0x11 0x3 Padding
0x14 0x24 #HdlsState. Unknown if the last 4-bytes are included in this struct, #SetAutoPilotVirtualPadState/#hiddbgGetAbstractedPadsState only uses the first 0x20-bytes.
0x38 0x60 Unused with #SetAutoPilotVirtualPadState/#GetAbstractedPadsState.

Normally the input state is merged with an existing controller selected by Type. However in some cases (BIT(2-5) with type2!=0x2 and BIT(31)) it's detected as a dedicated controller.

Type:

Bits #HdlsDeviceInfo::type bits Description Notes
0 0
1 15 #DeviceType |= BIT(1)
2 1
3 2
4 1
5 2
6 3
7 11 #DeviceType |= BIT(11)
8 12 #DeviceType |= BIT(12)
9 13 #DeviceType |= BIT(13)
10 14 #DeviceType |= BIT(14)
11 15 #DeviceType |= BIT(11)
12 12 #DeviceType |= BIT(12)
13 13 #DeviceType |= BIT(13)
14 14 #DeviceType |= BIT(14)
15 17
31 21 #DeviceType = BIT(31)

The above "#DeviceType |=" notes only apply when type2 is 0x2.

HdlsNpadAssignment

This is a 0x208-byte struct.

Offset Size Description
0x0 0x4 s32 Total entries
0x4 0x4 Padding
0x8 0x200(0x20*0x10) Array of #HdlsNpadAssignmentEntry.

HdlsNpadAssignmentEntry

This is a 0x20-byte struct.

Offset Size Description
0x0 0x8 HdlsHandle
0x8 0x4 ?
0xC 0x4 ?
0x10 0x8 ?
0x18 0x1 ?
0x19 0x7 Padding

HdlsStateList

This is a 0x408-byte struct.

[9.0.0+] This is a 0x488-byte struct.

Offset Size Description
0x0 0x4 s32 Total entries
0x4 0x4 Padding
0x8 <#HdlsStateListEntry size>*0x10 Array of #HdlsStateListEntry.

This contains a list of all controllers, including non-virtual controllers.

HdlsStateListEntry

This is a 0x40-byte struct.

[9.0.0+] This is a 0x48-byte struct.

Offset Size Description
0x0 0x8 HdlsHandle
0x8 #HdlsDeviceInfo size #HdlsDeviceInfo. With #ApplyHdlsStateList this is only used when creating new devices.
0x8 + #HdlsDeviceInfo size, with 8-byte alignment 0x24 #HdlsState
<Immediately following the above> 0x4 Padding

HdlsDeviceInfo

This is a 0x10-byte struct.

Offset Size Description
0x0 0x4 #DeviceTypeInternal
0x4 0x4 RGBA Single Body Color
0x8 0x4 RGBA Single Buttons Color
0xC 0x1 #NpadInterfaceType. Additional type field used with the above type field, if the value doesn't match one of the following a default is used. Type Pro-Controller: value 0x3 indicates that the controller is connected via USB. Type bit21: value 0x3 = unknown. When value is 0x2, state is merged with an existing controller (when the type value is compatible with this). Otherwise, it's a dedicated controller.
0xD 0x3 Padding

[9.0.0+] This is a 0x14-byte struct.

Offset Size Description
0x0 0x1 #DeviceTypeInternal
0x1 0x1 #NpadInterfaceType. Similar to the field from the old struct.
0x2 0x2 Padding
0x4 0x4 RGBA Single Body Color
0x8 0x4 RGBA Single Buttons Color
0xC 0x4 RGBA Unknown Body Color
0x10 0x4 RGBA Unknown Buttons Color

DeviceTypeInternal

This is "nn::hid::detail::DeviceTypeInternal".

Bits Description
0-7 BIT(N*4+0) = Pro Controller, BIT(N*4+1) = Joy-Con Left, BIT(N*4+2) = Joy-Con Right, BIT(N*4+3) = invalid. Where N is 0-1.
8-10 Pro Controller
11 Famicom left controller
12 Famicom right controller (with microphone)
13 NES left controller
14 NES right controller
15-16 Invalid
17 Generic external controller
18-20 Invalid
21-23 Generic controller

[9.0.0+] This is "nn::hidtypes::DeviceType".

Value DeviceType UniquePadType Description
1 JoyRight, HandheldRight JoyRight Joy-Con right controller
2 JoyLeft, HandheldLeft JoyLeft Joy-Con left controller
3 FullKey FullKey Pro Controller
4 JoyLeft JoyLeft Reserved
5 JoyRight JoyRight Reserved
6 FullKey FullKey Reserved
7 LarkHvcLeft, HandheldLarkHvcLeft JoyLeft Famicom left controller
8 LarkHvcRight, HandheldLarkHvcRight JoyRight Famicom right controller (with microphone)
9 LarkNesLeft, HandheldLarkNesLeft JoyLeft NES left controller
10 LarkNesRight, HandheldLarkNesRight JoyRight NES right controller
11 Lucia FullKey SNES controller
12 Palma Other Poké Ball Plus controller
13 FullKey FullKey Gc controller
14 HandheldLeft JoyLeft Reserved
15 FullKey FullKey Reserved
16 FullKey FullKey Reserved
17 DebugPad DebugPad Debug controller
18 HandheldRight JoyRight Reserved
19 System Other Unknown (has NpadFullKey style tag)
20 System Other Unknown (has NpadJoyDual style tag)
21 System Other Unknown (has NpadJoyDual style tag)

HdlsState

This is a 0x24-byte struct.

Offset Size Description
0x0 0x1 powerConnected for the main PowerInfo.
0x1 0x1 ORRed with powerConnected to set the value of the first byte for the controller flags.
0x2 0x6 Unknown
0x8 0x4 batteryCharge for the main PowerInfo.
0xC 0x4 Buttons. Bit18 = HOME and bit19 = Capture.
0x10 0x10(4*2*2) Joystick data, see HID_Shared_Memory#Controller_State.
0x20 0x1 Unused for input. Set with output from #DumpHdlsStates (zero in some cases).
0x21 0x3 Padding

[9.0.0+]:

Offset Size Description
0x0 0x4 batteryCharge for the main PowerInfo.
0x4 0x4 Unknown
0x8 0x8 Buttons, masked with 0xfffffffff00fffff. See above table regarding HOME/Capture buttons.
0x10 0x10(4*2*2) Joystick data, see HID_Shared_Memory#Controller_State.
0x20 0x1 Unused for input. Set with output from #DumpHdlsStates (zero in some cases).
0x21 0x3 Padding

NotificationLedPattern

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

argdata in the subcommand is initialized as follows: ((u8*)cmd_argdata)[pos] = u8_in[pos2] | u8_in[pos3]<<4; 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:

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.

DeviceType

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

Bits Description
0 FullKey
1 DebugPad
2 HandheldLeft
3 HandheldRight
4 JoyLeft
5 JoyRight
6 Palma
7 LarkHvcLeft
8 LarkHvcRight
9 LarkNesLeft
10 LarkNesRight
11 HandheldLarkHvcLeft
12 HandheldLarkHvcRight
13 HandheldLarkNesLeft
14 HandheldLarkNesRight
15 Lucia
16-30 Reserved
31 System

UniquePadId

This is "nn::hid::system::UniquePadId". This struct contains an u64.

UniquePadType

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

Value Description
0x0 Other
0x1 FullKey
0x2 JoyRight
0x3 JoyLeft
0x4 DebugPad

SystemButtonConfigEmbedded

This is "nn::hid::system::ButtonConfigEmbedded". This is a 0x2C8-byte struct.

SystemButtonConfigFull

This is "nn::hid::system::ButtonConfigFull". This is a 0x2C8-byte struct.

SystemButtonConfigLeft

This is "nn::hid::system::ButtonConfigLeft". This is a 0x1C8-byte struct.

SystemButtonConfigRight

This is "nn::hid::system::ButtonConfigRight". This is a 0x1A0-byte struct.

ButtonConfigEmbedded

This is "nn::hidconfig::ButtonConfigEmbedded". This is a 0x54-byte struct.

Offset Size Description
0x0 0x44 (4*17) #ButtonConfig, for the following buttons: DLeft, DUp, DRight, DDown, A, B, X, Y, L-Stick, R-Stick, L, R, ZL, ZR, -, +, Capture.
0x44 0x8 #JoystickConfig, for the left-stick.
0x4C 0x8 #JoystickConfig, for the right-stick.

ButtonConfig

u32 button mapping config. Must be value 0 - 22, which selects what button to map to.

Value Description
0 A
1 B
2 X
3 Y
4 L-Stick
5 R-Stick
6 L
7 R
8 ZL
9 ZR
10 -
11 +
12 DLeft
13 DUp
14 DRight
15 DDown
16 SL_Left
17 SR_Left
18 SL_Right
19 SR_Right
20 HOME
21 Capture
22 Disabled

JoystickConfig

Offset Size Description
0x0 0x4 Orientation. 0 = default, 1 = enabled for Left, 2 = enabled for Right.
0x4 0x1 StickChange
0x5 0x3 Padding

ButtonConfigFull

This is "nn::hidconfig::ButtonConfigFull". This is a 0x54-byte struct.

This is identical to #ButtonConfigEmbedded.

ButtonConfigLeft

This is "nn::hidconfig::ButtonConfigLeft". This is a 0x34-byte struct.

Offset Size Description
0x0 0x2C (4*11) #ButtonConfig, for the following buttons: DLeft, DUp, DRight, DDown, L-Stick, L, ZL, -, SL_Left, SR_Left, Capture.
0x2C 0x8 #JoystickConfig

ButtonConfigRight

This is "nn::hidconfig::ButtonConfigRight". This is a 0x30-byte struct.

Offset Size Description
0x0 0x28 (4*10) #ButtonConfig, for the following buttons: A, B, X, Y, R-Stick, R, ZR, +, SL_Right, SR_Right.
0x28 0x8 #JoystickConfig


IrCameraHandle

This is "nn::irsensor::IrCameraHandle".

Offset Size Description
0x0 0x1 PlayerNumber
0x1 0x1 DeviceType
0x2 0x2 Reserved

IrCameraStatus

This is "nn::irsensor::IrCameraStatus".

Value Description
0 Available
1 Unsupported
2 Unconnected

IrCameraInternalStatus

This is "nn::irsensor::IrCameraInternalStatus".

Value Description
0 Stopped
1 FirmwareUpdateNeeded
2
3
4
5 FirmwareVersionRequested
6 FirmwareVersionIsInvalid
7 [4.0.0+] Ready
8 [4.0.0+] Setting

IrSensorMode

This is "nn::irsensor::detail::StatusManager::IrSensorMode".

Value Description
0 None
1 MomentProcessor
2 ClusteringProcessor
3 ImageTransferProcessor
4 PointingProcessorMarker
5 TeraPluginProcessor
6 Unknown

ImageProcessorStatus

This is "nn::irsensor::ImageProcessorStatus".

Value Description
0 Stopped
1 Running

ImageTransferProcessorFormat

This is "nn::irsensor::ImageTransferProcessorFormat".

This controls the IR Sensor image resolution.

Value Description
0 320x240
1 160x120
2 80x60
3 [4.0.0+] 40x30
4 [4.0.0+] 20x15

MomentProcessorConfig

This is "nn::irsensor::MomentProcessorConfig".

Offset Size Description
0x0 0x8 ExposureTime (default is 0x493E0)
0x8 0x4 LightTarget (default is 0)
0xC 0x4 Gain (default is 0x8)
0x10 0x1 IsNegativeImageUsed (default is 0)
0x11 0x7 Reserved
0x18 0x2 WindowOfInterestX (default is 0)
0x1A 0x2 WindowOfInterestY (default is 0)
0x1C 0x2 WindowOfInterestWidth (default is 0x140)
0x1E 0x2 WindowOfInterestHeight (default is 0xF0)
0x20 0x4 Preprocess (default is 0x1)
0x24 0x4 PreprocessIntensityThreshold (default is 0x50)

PackedMomentProcessorConfig

This is "nn::irsensor::PackedMomentProcessorConfig".

This is converted from #MomentProcessorConfig.

Offset Size Description
0x0 0x8 ExposureTime (default is 0x493E0)
0x8 0x1 LightTarget (default is 0)
0x9 0x1 Gain (default is 0x8)
0xA 0x1 IsNegativeImageUsed (default is 0)
0xB 0x5 Reserved
0x10 0x2 WindowOfInterestX (default is 0)
0x12 0x2 WindowOfInterestY (default is 0)
0x14 0x2 WindowOfInterestWidth (default is 0x140)
0x16 0x2 WindowOfInterestHeight (default is 0xF0)
0x18 0x4 RequiredMcuVersion
0x1C 0x1 Preprocess (default is 0x1)
0x1D 0x1 PreprocessIntensityThreshold (default is 0x50)
0x1E 0x2 Reserved

ClusteringProcessorConfig

This is "nn::irsensor::ClusteringProcessorConfig".

Offset Size Description
0x0 0x8 ExposureTime (default is 200000)
0x8 0x4 LightTarget (default is 0)
0xC 0x4 Gain (default is 0x2)
0x10 0x1 IsNegativeImageUsed (default is 0)
0x11 0x7 Reserved
0x18 0x2 WindowOfInterestX (default is 0)
0x1A 0x2 WindowOfInterestY (default is 0)
0x1C 0x2 WindowOfInterestWidth (default is 320)
0x1E 0x2 WindowOfInterestHeight (default is 240)
0x20 0x4 ObjectPixelCountMin (default is 0x3)
0x24 0x4 ObjectPixelCountMax (default is 0x12C00)
0x28 0x4 ObjectIntensityMin (default is 150)
0x2C 0x1 IsExternalLightFilterEnabled (default is 0x1)

PackedClusteringProcessorConfig

This is "nn::irsensor::PackedClusteringProcessorConfig".

This is converted from #ClusteringProcessorConfig.

Offset Size Description
0x0 0x8 ExposureTime
0x8 0x1 LightTarget
0x9 0x1 Gain
0xA 0x1 IsNegativeImageUsed
0xB 0x5 Reserved
0x10 0x2 WindowOfInterestX
0x12 0x2 WindowOfInterestY
0x14 0x2 WindowOfInterestWidth
0x16 0x2 WindowOfInterestHeight
0x18 0x4 RequiredMcuVersion
0x1C 0x4 ObjectPixelCountMin
0x20 0x4 ObjectPixelCountMax
0x24 0x1 ObjectIntensityMin
0x25 0x1 IsExternalLightFilterEnabled
0x26 0x2 Reserved

ImageTransferProcessorConfig

This is "nn::irsensor::ImageTransferProcessorConfig".

Offset Size Description
0x0 0x8 ExposureTime
0x8 0x4 LightTarget
0xC 0x4 Gain
0x10 0x1 IsNegativeImageUsed
0x11 0x7 Reserved
0x18 0x4 Format

PackedImageTransferProcessorConfig

This is "nn::irsensor::PackedImageTransferProcessorConfig".

This is converted from #ImageTransferProcessorConfig.

Offset Size Description
0x0 0x8 ExposureTime
0x8 0x1 LightTarget
0x9 0x1 Gain
0xA 0x1 IsNegativeImageUsed
0xB 0x5 Reserved
0x10 0x4 RequiredMcuVersion
0x14 0x1 Format
0x15 0x3 Reserved

ImageTransferProcessorState

This is "nn::irsensor::ImageTransferProcessorState".

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x4 AmbientNoiseLevel
0xC 0x4 Reserved

TeraPluginProcessorConfig

This is "nn::irsensor::TeraPluginProcessorConfig".

Offset Size Description
0x0 0x1 Mode
0x1 0x1
0x2 0x1
0x3 0x1

PackedTeraPluginProcessorConfig

This is "nn::irsensor::PackedTeraPluginProcessorConfig".

This is converted from #TeraPluginProcessorConfig. The data starting at offset 0x5 is only initialized by the user-process with [6.0.0+].

#TeraPluginProcessorConfig +0x0, +0x2, and +0x3 are copied to +0x4, 0x6, and +0x7 here. +0x5 here is set to 0x2 | (#TeraPluginProcessorConfig+0x1 << 7).

Offset Size Description
0x0 0x4 RequiredMcuVersion
0x4 0x1 Mode
0x5 0x1
0x6 0x1
0x7 0x1

PointingProcessorConfig

This is "nn::irsensor::PointingProcessorConfig".

Offset Size Description
0x0 0x2 WindowOfInterestX (default is 0)
0x2 0x2 WindowOfInterestY (default is 0)
0x4 0x2 WindowOfInterestWidth (default is 320)
0x6 0x2 WindowOfInterestHeight (default is 240)

PackedPointingProcessorConfig

This is "nn::irsensor::PackedPointingProcessorConfig".

This is converted from #PointingProcessorConfig.

Offset Size Description
0x0 0x2 WindowOfInterestX (default is 0)
0x2 0x2 WindowOfInterestY (default is 0)
0x4 0x2 WindowOfInterestWidth (default is 320)
0x6 0x2 WindowOfInterestHeight (default is 240)
0x8 0x4 RequiredMcuVersion

PackedMcuVersion

This is "nn::irsensor::PackedMcuVersion".

Offset Size Description
0x0 0x2 MajorVersion
0x2 0x2 MinorVersion

Versions

MajorVersion MinorVersion SystemVersion
0x3 0xB [1.0.0+]
0x4 0x12 [4.0.0+]
0x5 0x18 [5.0.0+]
0x6 0x1A [6.0.0+]
0x8 0x1B [8.0.0+]

PackedFunctionLevel

This is nn::irsensor::PackedFunctionLevel.

Offset Size Description
0x0 0x1 #IrSensorFunctionLevel
0x1 0x3 Reserved

IrSensorFunctionLevel

This is "nn::irsensor::IrSensorFunctionLevel".

Value SystemVersion
0 [1.0.0+]
1 [4.0.0+]
2 [5.0.0+]
3 [6.0.0+]
4 [8.0.0+]

ImageTransferProcessorExConfig

This is "nn::irsensor::ImageTransferProcessorExConfig".

Offset Size Description
0x0 0x8 ExposureTime
0x8 0x4 LightTarget
0xC 0x4 Gain
0x10 0x1 IsNegativeImageUsed
0x11 0x7 Reserved
0x18 0x4 OrigFormat
0x1C 0x4 TrimmingFormat
0x20 0x2 TrimmingStartX
0x22 0x2 TrimmingStartY
0x24 0x1 IsExternalLightFilterEnabled

PackedImageTransferProcessorExConfig

This is "nn::irsensor::PackedImageTransferProcessorExConfig".

This is converted from #ImageTransferProcessorExConfig.

Offset Size Description
0x0 0x8 ExposureTime
0x8 0x1 LightTarget
0x9 0x1 Gain
0xA 0x1 IsNegativeImageUsed
0xB 0x5 Reserved
0x10 0x4 RequiredMcuVersion
0x14 0x1 OrigFormat
0x15 0x1 TrimmingFormat
0x16 0x2 TrimmingStartX
0x18 0x2 TrimmingStartY
0x1A 0x1 IsExternalLightFilterEnabled
0x1B 0x5 Reserved

IrLedProcessorConfig

This is "nn::irsensor::IrLedProcessorConfig".

Offset Size Description
0x0 0x4 LightTarget

PackedIrLedProcessorConfig

This is "nn::irsensor::PackedIrLedProcessorConfig".

This is converted from #IrLedProcessorConfig.

Offset Size Description
0x0 0x4 RequiredMcuVersion
0x4 0x1 LightTarget
0x5 0x3 Padding

AdaptiveClusteringProcessorConfig

This is "nn::irsensor::AdaptiveClusteringProcessorConfig".

AdaptiveClusteringProcessor was added with [5.0.0+].

This is converted to #TeraPluginProcessorConfig by the user-process. #TeraPluginProcessorConfig+0x3 is zero.

The default config is all-zero.

Offset Size Description
0x0 0x4 #AdaptiveClusteringMode
0x4 0x4 [6.0.0+] #AdaptiveClusteringTargetDistance

AdaptiveClusteringMode

Value Description
0 StaticFov
1 DynamicFov

Controls the mode for #TeraPluginProcessorConfig (DynamicFov -> 0x10; StaticFov -> 0x0F).

AdaptiveClusteringTargetDistance

Value Description
0 Near
1 Middle
2 Far

Controls the second and third bytes for #TeraPluginProcessorConfig (Near-> 0x00, 0x00; Middle -> 0x01, 0x03; Far -> 0x01, 0x08).

HandAnalysisConfig

This is "nn::irsensor::HandAnalysisConfig".

This is converted to #TeraPluginProcessorConfig by the user-process, which is all-zero except the mode.

Offset Size Description
0x0 0x4 #HandAnalysisMode

HandAnalysisMode

Value Description
0 None (invalid)
1 Silhouette
2 Image
3 SilhouetteAndImage
4 [4.0.0+] SilhouetteOnly

BusHandle

This is "nn::hidbus::BusHandle".

Offset Size Description
0x0 0x4 AbstractedPadId
0x4 0x1 InternalIndex
0x5 0x1 PlayerNumber
0x6 0x1 BusTypeId
0x7 0x1 IsValid

JoyPollingReceivedData

This is "nn::hidbus::JoyPollingReceivedData".

This is copied from the entries in TransferMemory by GetJoyPollingReceivedData.

Offset Size Description
0x0 0x30 Data
0x30 0x8 Size of data.
0x38 0x8 Timestamp

BusType

This is "nn::hidbus::BusType".

Value Description
0 JoyLeftRail
1 JoyRightRail
2 [6.0.0+] LarkRightRail (for microphone)

JoyPollingMode

This is "nn::hidbus::JoyPollingMode".

Value Description
0 sdknso uses GetJoyDisableSixAxisPollingDataAccessor with this.
1 sdknso uses GetJoyEnableSixAxisPollingDataAccessor with this.
2 [6.0.0+] sdknso uses GetJoyButtonOnlyPollingDataAccessor with this.

Other values causes #EnableJoyPollingReceiveMode to assert.

ExternalDevices

The following devices are used via hidbus:

  • Ring-Con
  • Famicom right controller (with microphone)

RomFS

The hid-sysmodule RomFS contains:

 ftmFwUpdate
   ├── NTD_4CD_1801.fts256
   ├── NTD_4CD_2602.fts256
   ├── NTD_4CD_3801.fts256
   └── NTD_4CD_xxxx.fts256 [7.0.0+]

These are firmware files for the touchscreen controller.

[9.0.0+] The hid-sysmodule RomFS now contains:

 ftmFwUpdate
   ├── FTS_00120100.fts256
   ├── FTS_32000001.fts256
   ├── FTS_32000102.fts256
   ├── FTS_32000302.fts256
   └── FTS_32000402.fts256

Firmware update

HID-sysmodule mounts the contents of title 0100000000000822 as "systemData" or the contents of title 010000000000B22B as "systemDataD". Both titles contain the same files, but 0100000000000822 is used on retail units while 010000000000B22B is used for development.

[10.0.0+]: The RomFs for hid-sysmodule was removed, the data which used to be in that RomFs was moved into this SystemData (the below .fts256 files).

These titles contain the following files:

  • ExpectVersionInfo.csv - List in the format "[device],[type],[version]" where "device" can be "JoyLeft", "JoyRight", "FullKey", "Palma" or "Handheld", "type" can be "BT", "MCU", "USB" or "SioH" and "version" is the hexadecimal representation of the firmware file's version.
  • FirmwareInfo.csv - List in the format "[device],[type],[version],[file]" where "device", "type" and "version" should match the values from "ExpectVersionInfo" and "file" is the name of the firmware file.
  • ukyosakyo_ep2_ota.bin - Left/Right Joy-Con BT firmware.
  • raizo_ep2_ota.bin - Pro Controller BT firmware.
  • tera_ota.bin - Right Joy-Con MCU firmware.
  • tera_ota_iap.bin - Right Joy-Con MCU (IAP profile) firmware.
  • tera_fullkey_ota.bin - Pro Controller MCU firmware.
  • tera_fullkey_ota_iap.bin - Pro Controller MCU (IAP profile) firmware.
  • [6.0.0+] ProController.dfu - Pro Controller USB firmware.
  • [6.1.0+] PalmaFw.bin - Poké Ball Plus BT firmware.
  • [9.0.0+] ExpectVersionInfo-platform.hoag.csv - Same as "ExpectVersionInfo.csv" but for the Switch Lite platform.
  • [9.0.0+] FirmwareInfo-platform.hoag.csv - Same as "FirmwareInfo.csv" but for the Switch Lite platform.
  • [9.0.0+] sioh.bin - Switch Lite Joy-Con firmware.
  • [9.0.0+] sioh_iap.bin - Switch Lite Joy-Con (IAP profile) firmware.
  • [10.0.0+] FTS_00120100.fts256
  • [10.0.0+] FTS_32000001.fts256
  • [10.0.0+] FTS_32000102.fts256
  • [10.0.0+] FTS_32000302.fts256
  • [10.0.0+] FTS_32000402.fts256
  • [10.0.0+] TouchScreenConfiguration.csv
  • [10.0.0+] TouchScreenFirmwareInfo.csv