Difference between revisions of "HID services"

From Nintendo Switch Brew
Jump to navigation Jump to search
 
Line 984: Line 984:
  
 
== ActivateDigitizer ==
 
== ActivateDigitizer ==
Takes a PID and an [[AM_services|AppletResourceUserId]], no output.
+
Takes a PID and an [[AM_services|AppletResourceUserId]]. No output.
  
 
== IAppletResource ==
 
== IAppletResource ==
Line 1,321: Line 1,321:
 
| 652 || [12.0.0+] StopButtonPlayData
 
| 652 || [12.0.0+] StopButtonPlayData
 
|-
 
|-
| 2000 || [10.0.0+] DeactivateDigitizer
+
| 2000 || [10.0.0+] [[#DeactivateDigitizer]]
 
|-
 
|-
| 2001 || [10.0.0+] SetDigitizerAutoPilotState
+
| 2001 || [10.0.0+] [[#SetDigitizerAutoPilotState]]
 
|-
 
|-
| 2002 || [10.0.0+] UnsetDigitizerAutoPilotState
+
| 2002 || [10.0.0+] [[#UnsetDigitizerAutoPilotState]]
 
|-
 
|-
 
| 3000 || [16.0.0+] ReloadFirmwareDebugSettings
 
| 3000 || [16.0.0+] ReloadFirmwareDebugSettings
Line 1,547: Line 1,547:
  
 
[11.0.0+] Takes an input [[#DebugRegisteredDevice]], no output.
 
[11.0.0+] Takes an input [[#DebugRegisteredDevice]], no output.
 +
 +
== DeactivateDigitizer ==
 +
No input/output.
 +
 +
== SetDigitizerAutoPilotState ==
 +
Takes an input [[#DigitizerAutoPilotState]]. No output.
 +
 +
== UnsetDigitizerAutoPilotState ==
 +
No input/output.
  
 
= hid:sys =
 
= hid:sys =
Line 8,522: Line 8,531:
 
|-
 
|-
 
| 0x0 || 0x8 || Buttons (only bit0 is used)
 
| 0x0 || 0x8 || Buttons (only bit0 is used)
 +
|}
 +
 +
= DigitizerAutoPilotState =
 +
This is "nn::hid::debug::DigitizerAutoPilotState".
 +
 +
{| class="wikitable" border="1"
 +
|-
 +
! Offset
 +
! Size
 +
! Description
 +
|-
 +
| 0x0 || 0x44 ||
 
|}
 
|}
  

Latest revision as of 18:21, 15 December 2024

hid

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

Cmd Name
0 #CreateAppletResource
1 #ActivateDebugPad
11 #ActivateTouchScreen
21 #ActivateMouse
22 [19.0.0+] AddMouseWheelDelta
26 [16.0.0+] ActivateDebugMouse
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
84 [13.0.0+] #EnableSixAxisSensorUnalteredPassthrough
85 [13.0.0+] #IsSixAxisSensorUnalteredPassthroughEnabled
86 [13.0.0+] #StoreSixAxisSensorCalibrationParameter
87 [13.0.0+] #LoadSixAxisSensorCalibrationParameter
88 [13.0.0+] #GetSixAxisSensorIcInformation
89 [13.0.0+] #ResetIsSixAxisSensorDeviceNewlyAssigned
91 #ActivateGesture
92 [18.0.0+] SetGestureOutputRanges
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
212 [11.0.0+] #SendVibrationValueInBool
213 [17.0.0+] SendVibrationValueInMode
214 [17.0.0+] SendVibrationValuesInMode
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
311 [17.0.0+] ForceActivateConsoleSixAxisSensor
312 [17.0.0+] ForceDeactivateConsoleSixAxisSensor
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
1004 [17.0.0+] SetTouchScreenResolution
2000 [10.0.0+] #ActivateDigitizer
3000 [15.0.0+] GetDebugPadGenericPadMap
3001 [15.0.0+] SetDebugPadGenericPadMap
3002 [15.0.0+] ResetDebugPadGenericPadMap
3003 [15.0.0+] GetDebugPadKeyboardMap
3004 [15.0.0+] SetDebugPadKeyboardMap
3005 [15.0.0+] ResetDebugPadKeyboardMap
3006 [15.0.0+] GetFullKeyGenericPadMap
3007 [15.0.0+] SetFullKeyGenericPadMap
3008 [15.0.0+] ResetFullKeyGenericPadMap
3009 [15.0.0+] GetFullKeyKeyboardMap
3010 [15.0.0+] SetFullKeyKeyboardMap
3011 [15.0.0+] ResetFullKeyKeyboardMap

CreateAppletResource

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

ActivateDebugPad

Takes a PID and an AppletResourceUserId, no output.

ActivateTouchScreen

Takes a PID and an AppletResourceUserId, no output.

ActivateMouse

Takes a PID and an AppletResourceUserId, no output.

ActivateKeyboard

Takes a PID and an AppletResourceUserId, no output.

SendKeyboardLockKeyEvent

Takes a PID, an u32 BitFlagSet #KeyboardLockKeyEvent, and an AppletResourceUserId, no output.

This is identical to the hidsys cmd.

AcquireXpadIdEventHandle

Takes an input u64, returns an output handle.

[10.0.0+] Stubbed, just returns 0.

ReleaseXpadIdEventHandle

Takes an input u64, no output.

[10.0.0+] Stubbed, just returns 0.

ActivateXpad

Takes a PID, an u32 "nn::hid::BasicXpadId", an AppletResourceUserId, no output.

[10.0.0+] Stubbed, just returns 0.

GetXpadIds

Takes a type-0xA output buffer containing an array of u32 "nn::hid::BasicXpadId", returns an output s64 total_out (which is exposed by sdknso as a s32).

[10.0.0+] Now returns a hard-coded list of Ids.

ActivateJoyXpad

Takes an input u32 "nn::hid::JoyXpadId", no output.

[10.0.0+] Stubbed, just returns 0.

GetJoyXpadLifoHandle

Takes an input u32 "nn::hid::JoyXpadId", returns an output handle.

[10.0.0+] Stubbed, just returns 0.

GetJoyXpadIds

Takes a type-0xA output buffer containing an array of u32 "nn::hid::BasicXpadId", returns an output s64.

[10.0.0+] Stubbed, just returns 0.

ActivateSixAxisSensor

Takes an input u32 "nn::hid::JoyXpadId", no output.

[10.0.0+] Stubbed, just returns 0.

DeactivateSixAxisSensor

Takes an input u32 "nn::hid::JoyXpadId", no output.

[10.0.0+] Stubbed, just returns 0.

GetSixAxisSensorLifoHandle

Takes an input u32 "nn::hid::JoyXpadId", returns an output handle.

[10.0.0+] Stubbed, just returns 0.

ActivateJoySixAxisSensor

Takes an input u32 "nn::hid::JoyXpadId", no output.

[10.0.0+] Stubbed, just returns 0.

DeactivateJoySixAxisSensor

Takes an input u32 "nn::hid::JoyXpadId", no output.

[10.0.0+] Stubbed, just returns 0.

GetJoySixAxisSensorLifoHandle

Takes an input u32 "nn::hid::JoyXpadId", returns an output handle.

[10.0.0+] Stubbed, just returns 0.

StartSixAxisSensor

Takes a PID, a #SixAxisSensorHandle, and an AppletResourceUserId, no output.

StopSixAxisSensor

Takes a PID, a #SixAxisSensorHandle, and an AppletResourceUserId, no output.

IsSixAxisSensorFusionEnabled

Takes a PID, a #SixAxisSensorHandle, and an AppletResourceUserId, returns an output bool.

EnableSixAxisSensorFusion

Takes a PID, a bool, a #SixAxisSensorHandle, and an AppletResourceUserId, no output.

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.

SetAccelerometerParameters

Takes a PID, a #SixAxisSensorHandle, two floats, and an AppletResourceUserId, no output.

sdknso will throw an error before using this cmd, if either of the floats are less than 0.0f, or when the second float is larger than the first float.

sdknso 10.x removed the nn::hid wrapper for this.

GetAccelerometerParameters

Takes a PID, a #SixAxisSensorHandle, and an AppletResourceUserId, returns two output floats.

sdknso 10.x removed the nn::hid wrapper for this.

ResetAccelerometerParameters

Takes a PID, a #SixAxisSensorHandle, and an AppletResourceUserId, no output.

sdknso 10.x removed the nn::hid wrapper for this.

SetAccelerometerPlayMode

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

sdknso 10.x removed the nn::hid wrapper for this.

GetAccelerometerPlayMode

Takes a PID, a #SixAxisSensorHandle, and an AppletResourceUserId, returns an output u32 #AccelerometerPlayMode.

sdknso 10.x removed the nn::hid wrapper for this.

ResetAccelerometerPlayMode

Takes a PID, a #SixAxisSensorHandle, and an AppletResourceUserId, no output.

sdknso 10.x removed the nn::hid wrapper for this.

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

IsSixAxisSensorAtRest

Takes a PID, a #SixAxisSensorHandle, and an AppletResourceUserId, returns an output bool.

IsFirmwareUpdateAvailableForSixAxisSensor

Takes a PID, a #SixAxisSensorHandle, and an AppletResourceUserId, returns an output bool.

EnableSixAxisSensorUnalteredPassthrough

Takes a PID, a #SixAxisSensorHandle, a bool, and an AppletResourceUserId, no output.

IsSixAxisSensorUnalteredPassthroughEnabled

Takes a PID, a #SixAxisSensorHandle, and an AppletResourceUserId, returns an output bool.

StoreSixAxisSensorCalibrationParameter

Takes a PID, a #SixAxisSensorHandle, a SixAxisSensorCalibrationParameter, and an AppletResourceUserId, no output.

LoadSixAxisSensorCalibrationParameter

Takes a PID, a #SixAxisSensorHandle, and an AppletResourceUserId, returns a SixAxisSensorCalibrationParameter.

GetSixAxisSensorIcInformation

Takes a PID, a #SixAxisSensorHandle, and an AppletResourceUserId, returns a SixAxisSensorIcInformation.

ResetIsSixAxisSensorDeviceNewlyAssigned

Takes a PID, a #SixAxisSensorHandle, and an AppletResourceUserId, no output.

ActivateGesture

Takes a PID-descriptor, a s32, and an u64 AppletResourceUserId, no output.

sdknso passes hard-coded value 1 for the s32.

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 #NpadIdType. The total entries in this array must be <=10.

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 and an AppletResourceUserId. No output.

This just returns 0.

[10.0.0+] sdknso now uses the hiddbg cmd instead.

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.

DisconnectNpad

Takes a PID, an u32 #NpadIdType, and an AppletResourceUserId. No output.

GetPlayerLedPattern

Takes an input u32 #NpadIdType, returns an output u64 (which is exposed by sdknso as an u8).

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+]
  • 0x5: [18.0.0+]

SetNpadJoyHoldType

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

GetNpadJoyHoldType

Takes a PID-descriptor and an AppletResourceUserId. Returns an output #NpadJoyHoldType.

sdknso will Abort when the output is not 0-1.

SetNpadJoyAssignmentModeSingleByDefault

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

This eventually calls the same func as #SetNpadJoyAssignmentModeSingle, except with #NpadJoyDeviceType=0.

SetNpadJoyAssignmentModeSingle

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

This eventually runs the same code as #SetNpadJoyAssignmentModeSingleWithDestination, except the output fields aren't exposed.

SetNpadJoyAssignmentModeDual

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

MergeSingleJoyAsDualJoy

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

StartLrAssignmentMode

Takes a PID and an AppletResourceUserId, no output.

StopLrAssignmentMode

Takes a PID and an AppletResourceUserId, no output.

SetNpadHandheldActivationMode

Takes a PID, an AppletResourceUserId, a s64 #NpadHandheldActivationMode, no output.

GetNpadHandheldActivationMode

Takes a PID and an u64 AppletResourceUserId. Returns an output s64 #NpadHandheldActivationMode. Official user-processes Abort if the output value is not 0-2.

SwapNpadAssignment

Takes a PID, two u32s #NpadIdType, and an AppletResourceUserId. No output.

IsUnintendedHomeButtonInputProtectionEnabled

Takes a PID, an u32 #NpadIdType, and an AppletResourceUserId. Returns an output bool.

Unused by sdknso, the flag from #NpadSystemProperties is used instead.

EnableUnintendedHomeButtonInputProtection

Takes a PID, a bool, an u32 #NpadIdType, and an AppletResourceUserId. No output.

SetNpadJoyAssignmentModeSingleWithDestination

Takes a PID, an u32, an AppletResourceUserId, and s64 #NpadJoyDeviceType. Returns an output bool and u32 #NpadIdType.

The bool indicates whether the output #NpadIdType is set.

SetNpadAnalogStickUseCenterClamp

Takes a PID, a bool, an AppletResourceUserId, no output.

SetNpadCaptureButtonAssignment

Takes a PID, a #NpadStyleSet, an AppletResourceUserId, a #NpadButtonSet, no output.

Exactly 1 bit must be set in the #NpadStyleSet. Multiple button bits can be set.

This assigns the button(s) which trigger the CaptureButton.

ClearNpadCaptureButtonAssignment

Takes a PID, an AppletResourceUserId, no output.

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.

SendVibrationGcErmCommand

Takes a PID, a #VibrationDeviceHandle, AppletResourceUserId, an u64 #VibrationGcErmCommand, no output.

GetActualVibrationGcErmCommand

Takes a PID, a #VibrationDeviceHandle, AppletResourceUserId, returns an output u64 #VibrationGcErmCommand.

BeginPermitVibrationSession

Takes an input AppletResourceUserId, no output.

Begins a forced-permitted vibration session.

EndPermitVibrationSession

No input/output.

Ends the session started by #BeginPermitVibrationSession.

IsVibrationDeviceMounted

Takes a PID, an #VibrationDeviceHandle, and an u64 AppletResourceUserId, returns an output u8 bool.

SendVibrationValueInBool

Takes a PID, a bool, a #VibrationDeviceHandle, and an AppletResourceUserId, no output.

Stubbed, this just returns 0.

This is currently not exposed by sdknso.

ActivateConsoleSixAxisSensor

Takes a PID and an u64 AppletResourceUserId, no output.

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

StartConsoleSixAxisSensor

Takes a PID, a #ConsoleSixAxisSensorHandle, and an AppletResourceUserId, no output.

StopConsoleSixAxisSensor

Takes a PID, a #ConsoleSixAxisSensorHandle, and an AppletResourceUserId, no output.

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 ? (Increased every sleep cicle)
0x18 0x4 float AccelerationX
0x1C 0x4 float AccelerationY
0x20 0x4 float AccelerationZ
0x24 0x4 float AngularVelocityX
0x28 0x4 float AngularVelocityY
0x2C 0x4 float AngularVelocityZ
0x30 0x4 float QuaternionX
0x34 0x4 float QuaternionY
0x38 0x4 float QuaternionZ
0x3C 0x4 float QuaternionW

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.

IsUsbFullKeyControllerEnabled

No input, returns an output bool.

EnableUsbFullKeyController

Takes an input bool, no output.

IsUsbFullKeyControllerConnected

Takes an input u32 #NpadIdType, returns an output bool.

HasBattery

Takes an input u32, returns an output bool.

sdknso exposes this under "nn::hid::system::". [10.0.0+] sdknso now only exposes the hidsys version of this cmd.

HasLeftRightBattery

Takes an input u32, returns two output bools.

sdknso exposes this under "nn::hid::system::". [10.0.0+] sdknso now only exposes the hidsys version of this cmd.

GetNpadInterfaceType

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

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

sdknso exposes this under "nn::hid::system::". [10.0.0+] sdknso now only exposes the hidsys version of this cmd.

GetNpadLeftRightInterfaceType

Takes an input u32 #NpadIdType, returns two output u8s #NpadInterfaceType.

sdknso exposes this under "nn::hid::system::". [10.0.0+] sdknso now only exposes the hidsys version of this cmd.

GetNpadOfHighestBatteryLevel

Takes a PID, a type-0x9 input buffer containing an array of u32 #NpadIdType, an u64 AppletResourceUserId, returns an output u32 #NpadIdType.

Handheld is ignored.

GetPalmaConnectionHandle

Takes a PID, an u32 #NpadIdType, an AppletResourceUserId, returns an output #PalmaConnectionHandle.

InitializePalma

Takes an input #PalmaConnectionHandle, no output.

AcquirePalmaOperationCompleteEvent

Takes an input #PalmaConnectionHandle, returns an output Event handle.

sdknso uses an user-specified EventClearMode.

The Event is signaled when data is available with #GetPalmaOperationInfo.

GetPalmaOperationInfo

Takes a #PalmaConnectionHandle, a type-0x6 output buffer, returns an output u64 #PalmaOperationType.

sdknso passes #PalmaOperationInfo+0x8 size 0x140 for the output buffer. [5.1.0+] After using the cmd successfully, #GetPalmaOperationResult is used.

This must be used at some point following using any of the other Palma cmds which trigger an Operation, once the Event is signaled. Up to 4 Operations can be queued at once, the other cmds will throw an error once there's too many operations.

PlayPalmaActivity

Takes an input #PalmaConnectionHandle, an u64 (exposed by sdknso as an u16), no output.

See #GetPalmaOperationInfo.

SetPalmaFrModeType

Takes an input #PalmaConnectionHandle, an u64 #PalmaFrModeType, no output.

See #GetPalmaOperationInfo.

ReadPalmaStep

Takes an input #PalmaConnectionHandle, no output.

See #GetPalmaOperationInfo.

#EnablePalmaStep should be used before this.

EnablePalmaStep

Takes an input bool, a #PalmaConnectionHandle, no output.

See #GetPalmaOperationInfo.

ResetPalmaStep

Takes an input #PalmaConnectionHandle, no output.

See #GetPalmaOperationInfo.

ReadPalmaApplicationSection

Takes an input #PalmaConnectionHandle, an u64, an u64 size, no output.

sdknso exposes the first u64 as a s32. sdknso will Abort if the input value for the second u64 is >0x100.

See #GetPalmaOperationInfo.

WritePalmaApplicationSection

Takes an input #PalmaConnectionHandle, an u64, an u64 size, a type-0x19 input buffer containing a #PalmaApplicationSectionAccessBuffer, no output.

sdknso exposes the first u64 as a s32. Data is copied from the input #PalmaApplicationSectionAccessBuffer with the specified size.

See #GetPalmaOperationInfo.

ReadPalmaUniqueCode

Takes an input #PalmaConnectionHandle, no output.

See #GetPalmaOperationInfo.

SetPalmaUniqueCodeInvalid

Takes an input #PalmaConnectionHandle, no output.

See #GetPalmaOperationInfo.

WritePalmaActivityEntry

Takes an input #PalmaConnectionHandle, an u64, an u64, an u64, an u64, no output.

sdknso exposes the first u64 as an u16, while the rest are exposed as #PalmaActivityEntry.

See #GetPalmaOperationInfo.

WritePalmaRgbLedPatternEntry

Takes an input #PalmaConnectionHandle, an u64, a type-0x5 input buffer, no output.

sdknso exposes the u64 as an u16.

See #GetPalmaOperationInfo.

WritePalmaWaveEntry

Takes an input #PalmaConnectionHandle, an u64 #PalmaWaveSet, an u64 (exposed by sdknso as an u16), a TransferMemory handle, an u64 tmem_size, an u64 size, no output.

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

Note that the sysmodule will not properly close the TransferMemory handle if the #PalmaConnectionHandle is invalid.

See #GetPalmaOperationInfo.

SetPalmaDataBaseIdentificationVersion

Takes an input s32, a #PalmaConnectionHandle, no output.

See #GetPalmaOperationInfo.

GetPalmaDataBaseIdentificationVersion

Takes an input #PalmaConnectionHandle, no output.

See #GetPalmaOperationInfo.

SuspendPalmaFeature

Takes an input "nn::util::BitFlagSet<32, #PalmaFeature>", a #PalmaConnectionHandle, no output.

See #GetPalmaOperationInfo.

GetPalmaOperationResult

Takes an input #PalmaConnectionHandle, no output.

sdknso only uses this from the wrapper for #GetPalmaOperationInfo.

ReadPalmaPlayLog

Takes an input u16, a #PalmaConnectionHandle, no output.

See #GetPalmaOperationInfo.

ResetPalmaPlayLog

Takes an input u16, a #PalmaConnectionHandle, no output.

See #GetPalmaOperationInfo.

SetIsPalmaAllConnectable

Takes a PID, a bool, an AppletResourceUserId, no output.

The sysmodule also calls the code which eventually runs from this, from various other funcs internally (bool value varies).

This updates various state. If needed, this uses either StartBleScanForGeneral or StopBleScanForGeneral.

SetIsPalmaPairedConnectable

Takes a PID, a bool, an AppletResourceUserId, no output.

The actual cmd impl ignores the PID/AppletResourceUserId.

This code is also called by another func internally by the sysmodule, where flag = {whether bit6 in a field is set} (presumably #NpadStyleSet). This is eventually called from various funcs, including #SetSupportedNpadStyleSet.

This updates various state. If needed, this uses either StartBleScanForPairedDevice or StopBleScanForPairedDevice.

PairPalma

Takes an input #PalmaConnectionHandle, no output.

This eventually uses BlePairDevice if needed, and updates state.

SetPalmaBoostMode

Takes an input bool, no output.

Stubbed, just returns 0. This was replaced by #EnablePalmaBoostMode.

CancelWritePalmaWaveEntry

Takes an input #PalmaConnectionHandle, no output.

EnablePalmaBoostMode

Takes a PID, a bool, an AppletResourceUserId, no output.

GetPalmaBluetoothAddress

Takes an input #PalmaConnectionHandle, returns an output Address.

SetDisallowedPalmaConnection

Takes a PID, an AppletResourceUserId, a type-0x9 input buffer containing an array of Address, no output.

SetNpadCommunicationMode

Takes a PID, an AppletResourceUserId, a s64 #NpadCommunicationMode, no output.

[2.0.0+] Stubbed, just returns 0.

GetNpadCommunicationMode

No input, returns an output s64 #NpadCommunicationMode.

sdknso uses a switch-statement to determine the value to write to the output #NpadCommunicationMode, with the s64 (written value is the same as the s64). sdknso will Abort if the s64 is not 0-3.

[2.0.0+] Stubbed, just returns hard-coded output mode=3.

SetTouchScreenConfiguration

Takes a PID, a #TouchScreenConfigurationForNx, an AppletResourceUserId, no output.

IsFirmwareUpdateNeededForNotification

Takes a PID, a s32, an AppletResourceUserId, returns an output bool.

sdknso passes hard-coded value 1 for the s32.

ActivateDigitizer

Takes a PID and an AppletResourceUserId. No output.

IAppletResource

This is "nn::hid::IAppletResource".

Cmd Name
0 #GetSharedMemoryHandle

GetSharedMemoryHandle

No input. Returns a sharedmem handle.

IActiveVibrationDeviceList

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

Cmd Name
0 #ActivateVibrationDevice

ActivateVibrationDevice

Takes an input #VibrationDeviceHandle. No output.

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
14 [11.0.0+] ProcessTouchScreenAutoTune
15 [13.0.0+] ForceStopTouchScreenManagement
16 [13.0.0+] ForceRestartTouchScreenManagement
17 [13.0.0+] IsTouchScreenManaged
18 [18.0.0+] SetTouchScreenAutoPilotStateWithAruid
20 #DeactivateMouse
21 #SetMouseAutoPilotState
22 #UnsetMouseAutoPilotState
25 [16.0.0+] SetDebugMouseAutoPilotState
26 [16.0.0+] UnsetDebugMouseAutoPilotState
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
137 [15.0.0+] SetSixAxisSensorMode
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
212 [19.0.0+] GetDetailFirmwareVersion
215 [6.0.0+] SetUsbFirmwareForceUpdateEnabled
216 [6.0.0+] SetAllKuinaDevicesToFirmwareUpdateMode
217 [17.0.0+] StartFirmwareUpdateFromImageSet
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
247 [11.0.0+] GetAnalogStickCalibrationValue
248 [11.0.0+] GetUniquePadIdsFull
249 [11.0.0+] ConnectUniquePad
250 [12.0.0+] IsVirtual
251 [12.0.0+] GetAnalogStickModuleParam
253 [19.0.0+] ClearStorageForShipment
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
351 [17.0.0-18.1.0] GetRegisteredDevicesCountDebug
352 [17.0.0-18.1.0] DeleteRegisteredDevicesDebug
400 [6.0.0+] DisableExternalMcuOnNxDevice
401 [6.0.0+] DisableRailDeviceFiltering
402 [10.0.0+] EnableWiredPairing
403 [10.0.0+] EnableShipmentModeAutoClear
404 [11.0.0+] SetRailEnabled
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
601 [18.0.0+] #IsButtonConfigSupported
602 [18.0.0+] #IsButtonConfigEmbeddedSupported
603 [18.0.0+] #DeleteButtonConfig
604 [18.0.0+] #DeleteButtonConfigEmbedded
605 [18.0.0+] #SetButtonConfigEnabled
606 [18.0.0+] #SetButtonConfigEmbeddedEnabled
607 [18.0.0+] #IsButtonConfigEnabled
608 [18.0.0+] #IsButtonConfigEmbeddedEnabled
609 [18.0.0+] #SetButtonConfigEmbedded
610 [18.0.0+] #SetButtonConfigFull
611 [18.0.0+] #SetButtonConfigLeft
612 [18.0.0+] #SetButtonConfigRight
613 [18.0.0+] #GetButtonConfigEmbedded
614 [18.0.0+] #GetButtonConfigFull
615 [18.0.0+] #GetButtonConfigLeft
616 [18.0.0+] #GetButtonConfigRight
650 [12.0.0+] AddButtonPlayData
651 [12.0.0+] StartButtonPlayData
652 [12.0.0+] StopButtonPlayData
2000 [10.0.0+] #DeactivateDigitizer
2001 [10.0.0+] #SetDigitizerAutoPilotState
2002 [10.0.0+] #UnsetDigitizerAutoPilotState
3000 [16.0.0+] ReloadFirmwareDebugSettings

DeactivateDebugPad

No input/output.

SetDebugPadAutoPilotState

Takes an input #DebugPadAutoPilotState, no output.

UnsetDebugPadAutoPilotState

No input/output.

DeactivateTouchScreen

No input/output.

SetTouchScreenAutoPilotState

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

The max entries for the array is 16.

UnsetTouchScreenAutoPilotState

No input/output.

DeactivateMouse

No input/output.

SetMouseAutoPilotState

Takes an input #MouseAutoPilotState, no output.

UnsetMouseAutoPilotState

No input/output.

DeactivateKeyboard

No input/output.

SetKeyboardAutoPilotState

Takes an input #KeyboardAutoPilotState, no output.

UnsetKeyboardAutoPilotState

No input/output.

DeactivateXpad

Takes an input "nn::hid::BasicXpadId", no output.

DeactivateNpad

Takes a PID and an AppletResourceUserId, no output.

This just returns 0.

DeactivateSleepButton

No input/output.

SetSleepButtonAutoPilotState

Takes an input #SleepButtonAutoPilotState, no output.

UnsetSleepButtonAutoPilotState

No input/output.

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 an input #NpadIdType and an input #DeviceType. Returns an output #FirmwareVersion.

GetDestinationFirmwareVersion

Takes an input #NpadIdType and an input #DeviceType. Returns an output #FirmwareVersion.

DiscardFirmwareInfoCacheForRevert

Takes an input #NpadIdType and an input #DeviceType. 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.

[18.0.0+] Now takes a total of 8-bytes of input, returns a total of 0x20-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.

[13.0.0+] Now additionally returns an output #HdlsSessionId.

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.

[13.0.0+] Takes an input #HdlsSessionId, no output.

DumpHdlsNpadAssignmentState

No input/output.

[13.0.0+] Takes an input #HdlsSessionId, no output.

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

DumpHdlsStates

No input/output.

[13.0.0+] Takes an input #HdlsSessionId, no output.

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

ApplyHdlsNpadAssignmentState

Takes an input u8 bool, no output.

[13.0.0+] Takes an input bool and a #HdlsSessionId, no output.

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

ApplyHdlsStateList

No input/output.

[13.0.0+] Takes an input #HdlsSessionId, no 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 #HdlsHandle.

DetachHdlsVirtualDevice

Takes an input #HdlsHandle, no output.

SetHdlsState

Takes an input #HdlsState and an input #HdlsHandle, no output.

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

AddRegisteredDevice

Takes an input #RegisteredDevice, no output.

[11.0.0+] Takes an input #DebugRegisteredDevice, no output.

DeactivateDigitizer

No input/output.

SetDigitizerAutoPilotState

Takes an input #DigitizerAutoPilotState. No output.

UnsetDigitizerAutoPilotState

No input/output.

hid:sys

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

Cmd Name
31 SendKeyboardLockKeyEvent
32 [15.0.0+] SetSystemKeyboardState
33 [15.0.0+] UnsetSystemKeyboardState
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-18.1.0] GetXcdHandleForNpadWithNfc
215 [4.0.0+] IsNfcActivated
216 [19.0.0+] GetAbstractedPadIdForNpadWithNfc
217 [19.0.0+] #SetNfcEvent
218 [19.0.0+] #GetNfcInfo
219 [19.0.0+] StartNfcDiscovery
220 [19.0.0+] StopNfcDiscovery
221 [19.0.0+] StartNtagRead
222 [19.0.0+] StartNtagWrite
223 [19.0.0+] SendNfcRawData
224 [19.0.0+] RegisterMifareKey
225 [19.0.0+] ClearMifareKey
226 [19.0.0+] StartMifareRead
227 [19.0.0+] StartMifareWrite
230 AcquireIrSensorEventHandle
231 ActivateIrSensor
232 [10.0.0+] GetIrSensorState
233 [10.0.0+] GetXcdHandleForNpadWithIrSensor
234 [19.0.0+] GetNpadJoyHoldType
241 [19.0.0+] #GetDataFormat
242 [19.0.0+] #SetDataFormat
243 [19.0.0+] #GetMcuState
244 [19.0.0+] #SetMcuState
245 [19.0.0+] #GetMcuVersionForNfc
246 [19.0.0+] #CheckNfcDevicePower
247 [19.0.0+] #SetMcuStateImmediate
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
327 [14.0.0+] GetAbstractedPadIdDataFromNpad
328 [14.0.0+] AttachAbstractedPadToNpad
329 [14.0.0+] DetachAbstractedPadAll
330 [14.0.0+] CheckAbstractedPadConnection
332 [19.0.0+] ConvertAppletDetailedUiTypeFromPlayReportType
500 SetAppletResourceUserId
501 RegisterAppletResourceUserId
502 UnregisterAppletResourceUserId
503 EnableAppletToGetInput
504 SetAruidValidForVibration
505 EnableAppletToGetSixAxisSensor
506 [14.0.0+] EnableAppletToGetPadInput
507 [14.0.0+] EnableAppletToGetTouchScreen
510 #SetVibrationMasterVolume
511 GetVibrationMasterVolume
512 [3.0.0+] BeginPermitVibrationSession
513 [3.0.0+] EndPermitVibrationSession
514 [12.0.0+] SendVibrationNotificationPattern
520 EnableHandheldHids
521 DisableHandheldHids
522 [9.0.0+] SetJoyConRailEnabled
523 [9.0.0+] IsJoyConRailEnabled
524 [10.0.0+] IsHandheldHidsEnabled
525 [11.0.0+] IsJoyConAttachedOnAllRail
526 [19.0.0+] IsInvertedControllerConnectedOnRail
540 AcquirePlayReportControllerUsageUpdateEvent
541 GetPlayReportControllerUsages
542 AcquirePlayReportRegisteredDeviceUpdateEvent
543 [5.0.0-18.1.0] 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
813 [18.0.0+] GetDeviceType
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-15.0.1] InitializeUsbFirmwareUpdate
1131 [6.0.0+] FinalizeUsbFirmwareUpdate
1132 [6.0.0+] CheckUsbFirmwareUpdateRequired
1133 [6.0.0+] StartUsbFirmwareUpdate
1134 [6.0.0+] GetUsbFirmwareUpdateState
1135 [15.0.0+] InitializeUsbFirmwareUpdateWithoutMemory
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-17.0.1] #IsButtonConfigSupported
1201 [11.0.0-17.0.1] #IsButtonConfigEmbeddedSupported ([10.0.0-10.2.0] #DeleteButtonConfig)
1202 [11.0.0-17.0.1] #DeleteButtonConfig ([10.0.0-10.2.0] #SetButtonConfigEnabled)
1203 [11.0.0-17.0.1] #DeleteButtonConfigEmbedded ([10.0.0-10.2.0] #IsButtonConfigEnabled)
1204 [11.0.0-17.0.1] #SetButtonConfigEnabled ([10.0.0-10.2.0] #SetButtonConfigEmbedded)
1205 [11.0.0-17.0.1] #SetButtonConfigEmbeddedEnabled ([10.0.0-10.2.0] #SetButtonConfigFull)
1206 [11.0.0-17.0.1] #IsButtonConfigEnabled ([10.0.0-10.2.0] #SetButtonConfigLeft)
1207 [11.0.0-17.0.1] #IsButtonConfigEmbeddedEnabled ([10.0.0-10.2.0] #SetButtonConfigRight)
1208 [11.0.0-17.0.1] #SetButtonConfigEmbedded ([10.0.0-10.2.0] #GetButtonConfigEmbedded)
1209 [11.0.0-17.0.1] #SetButtonConfigFull ([10.0.0-10.2.0] #GetButtonConfigFull)
1210 [10.0.0-10.2.0] #GetButtonConfigLeft
1211 [11.0.0-17.0.1] #SetButtonConfigRight ([10.0.0-10.2.0] #GetButtonConfigRight)
1212 [11.0.0-17.0.1] #GetButtonConfigEmbedded
1213 [11.0.0-17.0.1] #GetButtonConfigFull
1214 [11.0.0-17.0.1] #GetButtonConfigLeft
1215 [11.0.0-17.0.1] #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 [11.0.0-12.1.0] #GetButtonConfigStorageEmbeddedDeprecated ([10.0.0-10.2.0] GetButtonConfigStorageEmbedded)
1260 [11.0.0-12.1.0] #GetButtonConfigStorageFullDeprecated ([10.0.0-10.2.0] GetButtonConfigStorageFull)
1261 [11.0.0-12.1.0] #GetButtonConfigStorageLeftDeprecated ([10.0.0-10.2.0] GetButtonConfigStorageLeft)
1262 [11.0.0-12.1.0] #GetButtonConfigStorageRightDeprecated ([10.0.0-10.2.0] GetButtonConfigStorageRight)
1263 [11.0.0-12.1.0] #SetButtonConfigStorageEmbeddedDeprecated ([10.0.0-10.2.0] SetButtonConfigStorageEmbedded)
1264 [11.0.0-12.1.0] #SetButtonConfigStorageFullDeprecated ([10.0.0-10.2.0] SetButtonConfigStorageFull)
1265 [11.0.0-12.1.0] #SetButtonConfigStorageLeftDeprecated ([10.0.0-10.2.0] SetButtonConfigStorageLeft)
1266 [11.0.0-12.1.0] #SetButtonConfigStorageRightDeprecated ([10.0.0-10.2.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
1284 [11.0.0+] #GetButtonConfigStorageEmbedded
1285 [11.0.0+] #GetButtonConfigStorageFull
1286 [11.0.0+] #GetButtonConfigStorageLeft
1287 [11.0.0+] #GetButtonConfigStorageRight
1288 [11.0.0+] #SetButtonConfigStorageEmbedded
1289 [11.0.0+] #SetButtonConfigStorageFull
1290 [11.0.0+] #SetButtonConfigStorageLeft
1291 [11.0.0+] #SetButtonConfigStorageRight
1308 [18.0.0+] SetButtonConfigVisible
1309 [18.0.0+] IsButtonConfigVisible
1320 [17.0.0+] WakeTouchScreenUp
1321 [17.0.0+] PutTouchScreenToSleep
1420 [19.0.0+] GetAppletResourceProperty
12010 [11.0.0-17.0.1] #SetButtonConfigLeft

SendKeyboardLockKeyEvent

Takes an u32 BitFlagSet #KeyboardLockKeyEvent, no output.

AcquireHomeButtonEventHandle

Takes a PID, an AppletResourceUserId, returns an output Event handle.

The EventClearMode used by sdknso is user-specified. The Event is signaled when #HomeButtonState is updated.

This is used by AM.

ActivateHomeButton

Takes a PID, an AppletResourceUserId, no output.

Activates the HomeButton sharedmem.

AcquireSleepButtonEventHandle

Takes a PID, an AppletResourceUserId, returns an output Event handle.

The EventClearMode used by sdknso is user-specified. The Event is signaled when #SleepButtonState is updated.

This is used by AM.

ActivateSleepButton

Takes a PID, an AppletResourceUserId, no output.

Activates the SleepButton sharedmem.

AcquireCaptureButtonEventHandle

Takes a PID, an AppletResourceUserId, returns an output Event handle.

The EventClearMode used by sdknso is user-specified. The Event is signaled when #CaptureButtonState is updated.

This is used by AM.

ActivateCaptureButton

Takes a PID, an AppletResourceUserId, no output.

Activates the CaptureButton sharedmem.

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.

GetUniquePadSerialNumber

Takes an input #UniquePadId and returns an output #UniquePadSerialNumber.

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 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 0x1D-bytes of cmd_argdata initialized from this.

The layout of cmd_argdata is as follows:

Offset Size Description
0x0 0x1 ((TimeUnit & 0xF) | ((FrameCount & 0xF) << 4))
0x1 0x1 ((CycleCount & 0xF) | ((InitialBrightness & 0xF) << 4))
0x2 0x1 ((Frame2Brightness & 0xF) | ((Frame1Brightness & 0xF) << 4))
0x3 0x1 ((Frame1TimeToHold & 0xF) | ((Frame1TimeTowards & 0xF) << 4))
0x4 0x1 ((Frame2TimeToHold & 0xF) | ((Frame2TimeTowards & 0xF) << 4))
0x5 0x1 ((Frame4Brightness & 0xF) | ((Frame3Brightness & 0xF) << 4))
0x6 0x1 ((Frame3TimeToHold & 0xF) | ((Frame3TimeTowards & 0xF) << 4))
0x7 0x1 ((Frame4TimeToHold & 0xF) | ((Frame4TimeTowards & 0xF) << 4))
0x8 0x1 ((Frame6Brightness & 0xF) | ((Frame5Brightness & 0xF) << 4))
0x9 0x1 ((Frame5TimeToHold & 0xF) | ((Frame5TimeTowards & 0xF) << 4))
0xA 0x1 ((Frame6TimeToHold & 0xF) | ((Frame6TimeTowards & 0xF) << 4))
0xB 0x1 ((Frame8Brightness & 0xF) | ((Frame7Brightness & 0xF) << 4))
0xC 0x1 ((Frame7TimeToHold & 0xF) | ((Frame7TimeTowards & 0xF) << 4))
0xD 0x1 ((Frame8TimeToHold & 0xF) | ((Frame8TimeTowards & 0xF) << 4))
0xE 0x1 ((Frame10Brightness & 0xF) | ((Frame9Brightness & 0xF) << 4))
0xF 0x1 ((Frame9TimeToHold & 0xF) | ((Frame9TimeTowards & 0xF) << 4))
0x10 0x1 ((Frame10TimeToHold & 0xF) | ((Frame10TimeTowards & 0xF) << 4))
0x11 0x1 ((Frame12Brightness & 0xF) | ((Frame11Brightness & 0xF) << 4))
0x12 0x1 ((Frame11TimeToHold & 0xF) | ((Frame11TimeTowards & 0xF) << 4))
0x13 0x1 ((Frame12TimeToHold & 0xF) | ((Frame12TimeTowards & 0xF) << 4))
0x14 0x1 ((Frame14Brightness & 0xF) | ((Frame13Brightness & 0xF) << 4))
0x15 0x1 ((Frame13TimeToHold & 0xF) | ((Frame13TimeTowards & 0xF) << 4))
0x16 0x1 ((Frame14TimeToHold & 0xF) | ((Frame14TimeTowards & 0xF) << 4))
0x17 0x1 ((Reserved & 0xF) | ((Frame15Brightness & 0xF) << 4))
0x18 0x1 ((Frame15TimeToHold & 0xF) | ((Frame15TimeTowards & 0xF) << 4))
0x19 0x1 ((Reserved & 0xF) | ((Reserved & 0xF) << 4))
0x1A 0x1 ((TimeTowardsFinalBrightness & 0xF) | ((FinalBrightness & 0xF) << 4))
0x1B 0x1 (Timeout & 0xFF)
0x1C 0x1 ((Timeout >> 8) & 0xFF)

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

IsUsbConnected

Tales an input #UniquePadId, returns an output bool.

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.

GetTouchScreenFirmwareVersion

No input. Returns a #FirmwareVersion.

This requests the current firmware version from the touch screen IC.

It first ensures the touch screen IC's chip id is one of the following:

0x7036 - Ftm4cd60d (STMicroelectronics FingerTipS FT9CJ/FT9CF)
0x4036 - Fst2ba61ya1

Then constructs the final firmware version as follows:

uint32_t FtsVersion = GetFtsReleasedVer();    // Matches the xxxx value found in the FTS_xxxx.fts256 and FTS_xxxx.ftb firmware files.

uint8_t FtsVersionByte0 = (FtsVersion & 0xFF);
uint8_t FtsVersionByte1 = (FtsVersion & 0xFF00);
uint8_t FtsVersionByte2 = (FtsVersion & 0xFF0000);
uint8_t FtsVersionByte3 = (FtsVersion & 0xFF000000);

uint8_t FirmwareVersionByte0 = FtsVersionByte3;
uint8_t FirmwareVersionByte1 = FtsVersionByte2;
uint8_t FirmwareVersionByte2 = FtsVersionByte1;
uint8_t FirmwareVersionByte3 = FtsVersionByte0;

if (FtsVersionByte3 <= 0x31) {
    FirmwareVersionByte3 = 0;
    FirmwareVersionByte1 = 0;
    FirmwareVersionByte0 = 0x31;

    if (FtsVersionByte2 == 0x5) {
        FirmwareVersionByte2 = 2;
    } else if (FtsVersionByte2 == 0x12) {
        FirmwareVersionByte2 = 0;
    } else if (FtsVersionByte2 == 0x1A) {
        FirmwareVersionByte2 = 1;
    } else {
        // Throw error.
    }
}

uint8_t FirmwareVersion[0x10] = {0};
*(uint32_t *)FirmwareVersion = (FirmwareVersionByte3 << 24) | (FirmwareVersionByte2 << 16) | (FirmwareVersionByte1 << 8) | FirmwareVersionByte0;
*((uint32_t *)FirmwareVersion + 1) = 0x5354;   // "TS"

return FirmwareVersion;

IsFirmwareAvailableForNotification

Takes a PID, a s32, an #UniquePadId, an AppletResourceUserId, returns an output bool.

sdknso uses hard-coded value 1 for the s32.

CancelConnectionTrigger

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

IsButtonConfigSupported

Takes an input #UniquePadId, returns an output bool.

[11.0.0+] Takes an input Address, returns an output bool.

IsButtonConfigEmbeddedSupported

No input, returns an output bool.

DeleteButtonConfig

Takes an input #UniquePadId, no output.

[11.0.0+] Takes an input Address, no output.

DeleteButtonConfigEmbedded

No input/output.

SetButtonConfigEnabled

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

[11.0.0+] Takes an input bool, an Address, no output.

SetButtonConfigEmbeddedEnabled

Takes an input bool, no output.

IsButtonConfigEnabled

Takes an input #UniquePadId, returns an output bool.

[11.0.0+] Takes an input Address, returns an output bool.

IsButtonConfigEmbeddedEnabled

No input, returns an output bool.

SetButtonConfigEmbedded

Takes ([10.0.0-10.2.0] 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.

[11.0.0+] Takes an input Address, 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.

[11.0.0+] Takes an input Address, 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.

[11.0.0+] Takes an input Address, a type-0x15 input buffer containing a #SystemButtonConfigRight, no output.

GetButtonConfigEmbedded

Takes ([10.0.0-10.2.0] 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.

[11.0.0+] Takes an input Address, and a type-0x16 output buffer containing a #SystemButtonConfigFull.

GetButtonConfigLeft

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

[11.0.0+] Takes an input Address, and a type-0x16 output buffer containing a #SystemButtonConfigLeft.

GetButtonConfigRight

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

[11.0.0+] Takes an input Address, 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.

[10.1.0-10.2.0] This will now Abort if the s32 is negative or >=5. [11.0.0+] This value must now be unsigned <=4, otherwise 0 is returned.

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.

GetButtonConfigStorageEmbeddedDeprecated

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

[10.1.0-10.2.0] This will now Abort if the s32 is negative or >=5.

[11.0.0+] This now calls the same func internally as #GetButtonConfigStorageEmbedded, except the #StorageName isn't exposed.

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.

GetButtonConfigStorageFullDeprecated

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

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

GetButtonConfigStorageLeftDeprecated

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

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

GetButtonConfigStorageRightDeprecated

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

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

SetButtonConfigStorageEmbeddedDeprecated

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

[10.1.0-10.2.0] This will now Abort if the s32 is negative or >=5.

[11.0.0+] This now calls the same func internally as #SetButtonConfigStorageEmbedded, except the #StorageName isn't exposed.

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.

SetButtonConfigStorageFullDeprecated

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

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

SetButtonConfigStorageLeftDeprecated

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

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

SetButtonConfigStorageRightDeprecated

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

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

DeleteButtonConfigStorageEmbedded

Takes an input s32 entry-index, no output.

[10.1.0-10.2.0] This will now Abort if the s32 is negative or >=5. [11.0.0+] When the input s32 is larger than unsigned value 4, an error is returned.

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 #DeleteButtonConfigStorageEmbedded except with different setsys cmds.

DeleteButtonConfigStorageLeft

Takes an input s32 entry-index, no output.

Same as #DeleteButtonConfigStorageEmbedded except with different setsys cmds.

DeleteButtonConfigStorageRight

Takes an input s32 entry-index, no output.

Same as #DeleteButtonConfigStorageEmbedded 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.

GetButtonConfigStorageEmbedded

Takes an input s32, a type-0x16 output buffer containing a #ButtonConfigEmbedded, a type-0x1A output buffer containing a #StorageName.

When the input s32 is larger than unsigned value 4, an error is returned.

GetButtonConfigStorageFull

Takes an input s32, a type-0x16 output buffer containing a #ButtonConfigFull, a type-0x1A output buffer containing a #StorageName.

GetButtonConfigStorageLeft

Takes an input s32, a type-0x16 output buffer containing a #ButtonConfigLeft, a type-0x1A output buffer containing a #StorageName.

GetButtonConfigStorageRight

Takes an input s32, a type-0x16 output buffer containing a #ButtonConfigRight, a type-0x1A output buffer containing a #StorageName.

SetButtonConfigStorageEmbedded

Takes an input s32, a type-0x15 input buffer containing a #ButtonConfigEmbedded, a type-0x19 input buffer containing a #StorageName.

When the input s32 is larger than unsigned value 4, this will immediately return (this cmd always returns 0 regardless).

SetButtonConfigStorageFull

Takes an input s32, a type-0x15 input buffer containing a #ButtonConfigFull, a type-0x19 input buffer containing a #StorageName.

SetButtonConfigStorageLeft

Takes an input s32, a type-0x15 input buffer containing a #ButtonConfigLeft, a type-0x19 input buffer containing a #StorageName.

SetButtonConfigStorageRight

Takes an input s32, a type-0x15 input buffer containing a #ButtonConfigRight, a type-0x19 input buffer containing a #StorageName.

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

This was removed with [19.0.0+].

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.

GetDataFormat

Takes an input 8-byte handle, returns an output u8.

SetDataFormat

Takes an input u8 and a 8-byte handle (4-byte alignment), no output.

GetMcuState

Takes an input 8-byte handle, returns an output u8.

SetMcuState

Takes an input u8 and a 8-byte handle (4-byte alignment), no output.

GetMcuVersionForNfc

Takes an input 8-byte handle, returns an output 0x20-byte struct.

CheckNfcDevicePower

Takes an input 8-byte handle, no output.

SetMcuStateImmediate

Takes an input u8 and a 8-byte handle (4-byte alignment), no output.

SetNfcEvent

Takes an input 8-byte handle, returns 2 output Event handles.

GetNfcInfo

Takes an input 8-byte handle and a type-0x1A output buffer.

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

This buffer contains a 0x804-byte struct, for the NFC data sent in response to the various other cmds.

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 and an u64 AppletResourceUserId. Returns an output bool HasHandle and a #BusHandle.

HasHandle 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 bool IsAttached.

This is not used by sdknso.

Initialize

Takes an input #BusHandle and an u64 AppletResourceUserId. No output.

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

Finalize

Takes an input #BusHandle and an u64 AppletResourceUserId. No output.

EnableExternalDevice

Takes an input bool IsEnabled, a #BusHandle, an u64 Version and an u64 AppletResourceUserId. No output.

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

IsEnabled 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 DeviceId.

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

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

SetEventForSendCommandAsycResult

Takes an input #BusHandle. Returns an output Event handle AttachmentDataReceiveEventHandle 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 IsConnected
0x1 0x3 Reserved
0x4 0x4 IsConnectedResult
0x8 0x1 IsEnabled. Bool flag indicating whether a device is enabled.
0x9 0x1 IsInFocus. Bool flag indicating whether this entry is valid.
0xA 0x1 IsPollingMode. Bool flag indicating whether polling is enabled.
0xB 0x1 Reserved
0xC 0x4 PollingMode

EnableJoyPollingReceiveMode

Takes a type-0x21 input buffer, a TransferMemory handle, an u32 TransferMemorySize, an u32 #JoyPollingMode and 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 #StatusManagerType. No output.

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

SharedMemoryFormat

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

The shared memory is a 0x40000 byte read-only segment of memory shared between applications for input. The segment contains structures for most if not all input methods available to applications.

Offset Size Description
0x0 0x400 DebugPad
0x400 0x3000 TouchScreen
0x3400 0x400 Mouse
0x3800 0x400 Keyboard
0x3C00 0x1000 Digitizer ([1.0.0-9.2.0] BasicXpad)
0x4C00 0x200 HomeButton
0x4E00 0x200 SleepButton
0x5000 0x200 CaptureButton
0x5200 0x800 InputDetector
0x5A00 0x4000 [1.0.0-4.1.0] UniquePad
0x9A00 0x32000 Npad
0x3BA00 0x800 Gesture
0x3C200 0x1C [5.0.0+] ConsoleSixAxisSensor
0x3DC00 0x400 [16.0.0+] DebugMouse

DebugPadSharedMemoryFormat

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

Offset Size Description
0x0 0x2C8 #DebugPadLifo

DebugPadLifo

This is "nn::hid::detail::DebugPadLifo". This is a RingLifo object.

Offset Size Description
0x0 0x8 RingLifoVptr
0x8 0x8 BufferCount
0x10 0x8 Tail
0x18 0x8 Count
0x20 0x28 * 17 Array of #DebugPadStateAtomicStorage

DebugPadStateAtomicStorage

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

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x20 #DebugPadState
DebugPadState

This is "nn::hid::DebugPadState".

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x4 Attributes
0xC 0x4 Buttons
0x10 0x8 AnalogStickR
0x18 0x8 AnalogStickL

TouchScreenSharedMemoryFormat

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

Offset Size Description
0x0 0x2C38 #TouchScreenLifo

TouchScreenLifo

This is "nn::hid::detail::TouchScreenLifo". This is a RingLifo object.

Offset Size Description
0x0 0x8 RingLifoVptr
0x8 0x8 BufferCount
0x10 0x8 Tail
0x18 0x8 Count
0x20 0x298 * 17 Array of #TouchScreenStateAtomicStorage

TouchScreenStateAtomicStorage

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

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x290 #TouchScreenState
TouchScreenState

This is "nn::hid::detail::TouchScreenState" / "nn::hid::TouchScreenState".

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x4 s32 Count
0xC 0x4 Reserved
0x10 0x28 * 16 Touches

MouseSharedMemoryFormat

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

Offset Size Description
0x0 0x350 #MouseLifo

MouseLifo

This is "nn::hid::detail::MouseLifo". This is a RingLifo object.

Offset Size Description
0x0 0x8 RingLifoVptr
0x8 0x8 BufferCount
0x10 0x8 Tail
0x18 0x8 Count
0x20 0x30 * 17 Array of #MouseStateAtomicStorage

MouseStateAtomicStorage

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

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x28 #MouseState
MouseState

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

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x4 X
0xC 0x4 Y
0x10 0x4 DeltaX
0x14 0x4 DeltaY
0x18 0x4 WheelDeltaX
0x1C 0x4 WheelDeltaY
0x20 0x4 Buttons
0x24 0x4 Attributes

KeyboardSharedMemoryFormat

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

Offset Size Description
0x0 0x3D8 #KeyboardLifo

KeyboardLifo

This is "nn::hid::detail::KeyboardLifo". This is a RingLifo object.

Offset Size Description
0x0 0x8 RingLifoVptr
0x8 0x8 BufferCount
0x10 0x8 Tail
0x18 0x8 Count
0x20 0x38 * 17 Array of #KeyboardStateAtomicStorage

KeyboardStateAtomicStorage

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

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x30 #KeyboardState
KeyboardState

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

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x8 Modifiers
0x10 0x20 Keys

BasicXpadSharedMemoryFormat

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

Offset Size Description
0x0 0x400 * 4 Array of #BasicXpadSharedMemoryEntry

BasicXpadSharedMemoryEntry

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

Offset Size Description
0x0 0x2C8 #BasicXpadLifo

BasicXpadLifo

This is "nn::hid::detail::BasicXpadLifo". This is a RingLifo object.

Offset Size Description
0x0 0x8 RingLifoVptr
0x8 0x8 BufferCount
0x10 0x8 Tail
0x18 0x8 Count
0x20 0x28 * 17 Array of #BasicXpadStateAtomicStorage
BasicXpadStateAtomicStorage

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

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x20 #BasicXpadState
BasicXpadState

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

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x4 Attributes
0xC 0x4 Buttons
0x10 0x8 AnalogStickL
0x18 0x8 AnalogStickR

DigitizerSharedMemoryFormat

This is "nn::hid::server::DigitizerSharedMemoryFormat".

Offset Size Description
0x0 0x680 #DigitizerLifo

DigitizerLifo

This is "nn::hid::server::DigitizerLifo". This is a RingLifo object.

Offset Size Description
0x0 0x8 RingLifoVptr
0x8 0x8 BufferCount
0x10 0x8 Tail
0x18 0x8 Count
0x20 0x60 * 17 Array of #DigitizerStateAtomicStorage

DigitizerStateAtomicStorage

This is "nn::hid::server::DigitizerStateAtomicStorage".

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x58 #DigitizerState
DigitizerState

This is "nn::hid::DigitizerState".

This is managed by the sysmodule "cs" (development only) through hid:dbg commands. No actual physical device is supported on NX.

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x4
0xC 0x4
0x10 0x4 Attributes
0x14 0x4 Buttons
0x18 0x4
0x1C 0x4
0x20 0x4
0x24 0x4
0x28 0x4
0x2C 0x4
0x30 0x4
0x34 0x4
0x38 0x4
0x3C 0x4
0x40 0x4
0x44 0x4
0x48 0x4
0x4C 0x4
0x50 0x4
0x54 0x4

HomeButtonSharedMemoryFormat

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

This is used by AM.

Offset Size Description
0x0 0x1B8 #HomeButtonLifo

HomeButtonLifo

This is "nn::hid::detail::HomeButtonLifo". This is a RingLifo object.

Offset Size Description
0x0 0x8 RingLifoVptr
0x8 0x8 BufferCount
0x10 0x8 Tail
0x18 0x8 Count
0x20 0x18 * 17 Array of #HomeButtonStateAtomicStorage

HomeButtonStateAtomicStorage

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

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x10 #HomeButtonState
HomeButtonState

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

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x8 Buttons

SleepButtonSharedMemoryFormat

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

This is used by AM.

Offset Size Description
0x0 0x1B8 #SleepButtonLifo

SleepButtonLifo

This is "nn::hid::detail::SleepButtonLifo". This is a RingLifo object.

Offset Size Description
0x0 0x8 RingLifoVptr
0x8 0x8 BufferCount
0x10 0x8 Tail
0x18 0x8 Count
0x20 0x18 * 17 Array of #SleepButtonStateAtomicStorage

SleepButtonStateAtomicStorage

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

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x10 #SleepButtonState
SleepButtonState

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

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x8 Buttons

CaptureButtonSharedMemoryFormat

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

This is used by AM.

Offset Size Description
0x0 0x1B8 #CaptureButtonLifo

CaptureButtonLifo

This is "nn::hid::detail::CaptureButtonLifo". This is a RingLifo object.

Offset Size Description
0x0 0x8 RingLifoVptr
0x8 0x8 BufferCount
0x10 0x8 Tail
0x18 0x8 Count
0x20 0x18 * 17 Array of #CaptureButtonStateAtomicStorage

CaptureButtonStateAtomicStorage

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

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x10 #CaptureButtonState
CaptureButtonState

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

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x8 Buttons

InputDetectorSharedMemoryFormat

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

Offset Size Description
0x0 0x80 * 16 Array of #InputDetectorSharedMemoryEntry

InputDetectorSharedMemoryEntry

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

Offset Size Description
0x0 0x50 #InputDetectorLifo

InputDetectorLifo

This is "nn::hid::detail::InputDetectorLifo". This is a RingLifo object.

Offset Size Description
0x0 0x8 RingLifoVptr
0x8 0x8 BufferCount
0x10 0x8 Tail
0x18 0x8 Count
0x20 0x18 * 2 Array of #InputDetectorStateAtomicStorage
InputDetectorStateAtomicStorage

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

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x10 #InputDetectorState
InputDetectorState

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

Offset Size Description
0x0 0x8 InputSourceState
0x8 0x8 SamplingNumber

UniquePadSharedMemoryFormat

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

[5.0.0+] This section has been removed from #SharedMemoryFormat. #UniquePadSharedMemoryFormat is now a specialization of #NpadSharedMemoryFormat.

Offset Size Description
0x0 0x400 * 16 Array of #UniquePadSharedMemoryEntry

UniquePadSharedMemoryEntry

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

Offset Size Description
0x0 0x1E0 #UniquePadLifo

UniquePadLifo

This is "nn::hid::detail::UniquePadLifo". This is a RingLifo object.

Offset Size Description
0x0 0x80 #UniquePadConfigLifo
0x80 0x70 * 2 Array of #AnalogStickCalibrationStateImplLifo
0x160 0x60 #SixAxisSensorUserCalibrationStateLifo
0x1C0 0x20 UniquePadConfigMutex

UniquePadConfigLifo

This is "nn::hid::detail::UniquePadConfigLifo". This is a RingLifo object.

Offset Size Description
0x0 0x8 RingLifoVptr
0x8 0x8 BufferCount
0x10 0x8 Tail
0x18 0x8 Count
0x20 0x30 * 2 Array of #UniquePadConfigAtomicStorage
UniquePadConfigAtomicStorage

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

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x28 #UniquePadConfig
UniquePadConfig

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

Offset Size Description
0x0 0x4 Type
0x4 0x4 Interface
0x8 0x10 SerialNumber
0x18 0x4 ControllerNumber
0x1C 0x1 IsActive
0x1D 0x3 Reserved
0x20 0x8 SamplingNumber

AnalogStickCalibrationStateImplLifo

This is "nn::hid::detail::AnalogStickCalibrationStateImplLifo". This is a RingLifo object.

Offset Size Description
0x0 0x8 RingLifoVptr
0x8 0x8 BufferCount
0x10 0x8 Tail
0x18 0x8 Count
0x20 0x28 * 2 Array of #AnalogStickCalibrationStateImplAtomicStorage
AnalogStickCalibrationStateImplAtomicStorage

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

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x20 #AnalogStickCalibrationStateImpl
AnalogStickCalibrationStateImpl

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

Offset Size Description
0x0 0x8 State
0x8 0x8 Flags
0x10 0x8 Stage
0x18 0x8 SamplingNumber

SixAxisSensorUserCalibrationStateLifo

This is "nn::hid::detail::SixAxisSensorUserCalibrationStateLifo". This is a RingLifo object.

Offset Size Description
0x0 0x8 RingLifoVptr
0x8 0x8 BufferCount
0x10 0x8 Tail
0x18 0x8 Count
0x20 0x20 * 2 Array of #SixAxisSensorUserCalibrationStateAtomicStorage
SixAxisSensorUserCalibrationStateAtomicStorage

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

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x18 #SixAxisSensorUserCalibrationState
SixAxisSensorUserCalibrationState

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

Offset Size Description
0x0 0x4 Flags
0x4 0x4 Reserved
0x8 0x8 Stage
0x10 0x8 SamplingNumber

NpadSharedMemoryFormat

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

Offset Size Description
0x0 0x5000 * 10 Array of #NpadSharedMemoryEntry

Each entry describes an available controller:

Entry Description
0 to 7 Players 1 to 8
8 Handheld Mode
9 Other

NpadSharedMemoryEntry

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

Offset Size Description
0x0 0x43F8 ([9.0.0-12.1.0] 0x43F0, [1.0.0-8.1.0] 0x4410) #NpadInternalState

NpadInternalState

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

Offset Size Description
0x0 0x4 StyleSet
0x4 0x4 JoyAssignmentMode
0x8 0xC FullKeyColor
0x14 0x14 JoyColor
0x28 0x350 FullKeyLifo
0x378 0x350 HandheldLifo
0x6C8 0x350 JoyDualLifo
0xA18 0x350 JoyLeftLifo
0xD68 0x350 JoyRightLifo
0x10B8 0x350 PalmaLifo ([1.0.0-3.0.2] SystemLifo)
0x1408 0x350 SystemExtLifo ([4.0.0+] also used for NpadSystem)
0x1758 0x708 FullKeySixAxisSensorLifo
0x1E60 0x708 HandheldSixAxisSensorLifo
0x2568 0x708 JoyDualLeftSixAxisSensorLifo
0x2C70 0x708 JoyDualRightSixAxisSensorLifo
0x3378 0x708 JoyLeftSixAxisSensorLifo
0x3A80 0x708 JoyRightSixAxisSensorLifo
0x4188 0x4 DeviceType
0x418C 0x4 Reserved
0x4190 0x8 SystemProperties
0x4198 0x4 SystemButtonProperties
0x419C 0x4 BatteryLevelJoyDual
0x41A0 0x4 BatteryLevelJoyLeft
0x41A4 0x4 BatteryLevelJoyRight
0x41A8 0x60 [1.0.0-8.1.0] NfcXcdDeviceHandle (replaced by #GetXcdHandleForNpadWithNfc)
0x41A8 0x4 [9.0.0+] AppletFooterUiAttributes
0x41AC 0x1 [9.0.0+] AppletFooterUiType
0x41AD 0x7B [9.0.0+] Reserved
0x4208 0x20 [1.0.0-8.1.0] Mutex
0x4228 ([1.0.0-8.1.0] 0x4248) 0x1B8 GcTriggerLifo
0x43E0 ([1.0.0-8.1.0] 0x4400) 0x4 LarkTypeLAndMain
0x43E4 ([1.0.0-8.1.0] 0x4404) 0x4 LarkTypeR
0x43E8 ([1.0.0-8.1.0] 0x4408) 0x4 LuciaType
0x43EC ([1.0.0-8.1.0] 0x440C) 0x4 LagerType
0x43F0 0x1 * 6 [13.0.0+] Array of #SixAxisSensorProperties

NpadFullKeyLifo

This is "nn::hid::detail::NpadFullKeyLifo". This is a RingLifo object.

Offset Size Description
0x0 0x8 RingLifoVptr
0x8 0x8 BufferCount
0x10 0x8 Tail
0x18 0x8 Count
0x20 0x30 * 17 Array of #NpadFullKeyStateAtomicStorage
NpadFullKeyStateAtomicStorage

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

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x28 #NpadFullKeyState
NpadFullKeyState

This is "nn::hid::NpadFullKeyState".

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x8 Buttons
0x10 0x8 AnalogStickL
0x18 0x8 AnalogStickR
0x20 0x4 Attributes
0x24 0x4 Reserved

NpadHandheldLifo

This is "nn::hid::detail::NpadHandheldLifo". This is a RingLifo object.

Offset Size Description
0x0 0x8 RingLifoVptr
0x8 0x8 BufferCount
0x10 0x8 Tail
0x18 0x8 Count
0x20 0x30 * 17 Array of #NpadHandheldStateAtomicStorage
NpadHandheldStateAtomicStorage

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

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x28 #NpadHandheldState
NpadHandheldState

This is "nn::hid::NpadHandheldState".

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x8 Buttons
0x10 0x8 AnalogStickL
0x18 0x8 AnalogStickR
0x20 0x4 Attributes
0x24 0x4 Reserved

NpadJoyDualLifo

This is "nn::hid::detail::NpadJoyDualLifo". This is a RingLifo object.

Offset Size Description
0x0 0x8 RingLifoVptr
0x8 0x8 BufferCount
0x10 0x8 Tail
0x18 0x8 Count
0x20 0x30 * 17 Array of #NpadJoyDualStateAtomicStorage
NpadJoyDualStateAtomicStorage

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

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x28 #NpadJoyDualState
NpadJoyDualState

This is "nn::hid::NpadJoyDualState".

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x8 Buttons
0x10 0x8 AnalogStickL
0x18 0x8 AnalogStickR
0x20 0x4 Attributes
0x24 0x4 Reserved

NpadJoyLeftLifo

This is "nn::hid::detail::NpadJoyLeftLifo". This is a RingLifo object.

Offset Size Description
0x0 0x8 RingLifoVptr
0x8 0x8 BufferCount
0x10 0x8 Tail
0x18 0x8 Count
0x20 0x30 * 17 Array of #NpadJoyLeftStateAtomicStorage
NpadJoyLeftStateAtomicStorage

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

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x28 #NpadJoyLeftState
NpadJoyLeftState

This is "nn::hid::NpadJoyLeftState".

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x8 Buttons
0x10 0x8 AnalogStickL
0x18 0x8 AnalogStickR
0x20 0x4 Attributes
0x24 0x4 Reserved

NpadJoyRightLifo

This is "nn::hid::detail::NpadJoyRightLifo". This is a RingLifo object.

Offset Size Description
0x0 0x8 RingLifoVptr
0x8 0x8 BufferCount
0x10 0x8 Tail
0x18 0x8 Count
0x20 0x30 * 17 Array of #NpadJoyRightStateAtomicStorage
NpadJoyRightStateAtomicStorage

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

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x28 #NpadJoyRightState
NpadJoyRightState

This is "nn::hid::NpadJoyRightState".

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x8 Buttons
0x10 0x8 AnalogStickL
0x18 0x8 AnalogStickR
0x20 0x4 Attributes
0x24 0x4 Reserved

NpadPalmaLifo

This is "nn::hid::detail::NpadPalmaLifo". This is a RingLifo object.

Offset Size Description
0x0 0x8 RingLifoVptr
0x8 0x8 BufferCount
0x10 0x8 Tail
0x18 0x8 Count
0x20 0x30 * 17 Array of #NpadPalmaStateAtomicStorage
NpadPalmaStateAtomicStorage

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

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x28 #NpadPalmaState
NpadPalmaState

This is "nn::hid::NpadPalmaState".

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x8 Buttons
0x10 0x8 AnalogStickL
0x18 0x8 AnalogStickR
0x20 0x4 Attributes
0x24 0x4 Reserved

NpadSystemLifo

This is "nn::hid::detail::NpadSystemLifo". This is a RingLifo object.

Offset Size Description
0x0 0x8 RingLifoVptr
0x8 0x8 BufferCount
0x10 0x8 Tail
0x18 0x8 Count
0x20 0x30 * 17 Array of #NpadSystemStateAtomicStorage
NpadSystemStateAtomicStorage

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

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x28 #NpadSystemState
NpadSystemState

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

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x8 Buttons
0x10 0x8 AnalogStickL
0x18 0x8 AnalogStickR
0x20 0x4 Attributes
0x24 0x4 Reserved

NpadSystemExtLifo

This is "nn::hid::detail::NpadSystemExtLifo". This is a RingLifo object.

Offset Size Description
0x0 0x8 RingLifoVptr
0x8 0x8 BufferCount
0x10 0x8 Tail
0x18 0x8 Count
0x20 0x30 * 17 Array of #NpadSystemExtStateAtomicStorage
NpadSystemExtStateAtomicStorage

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

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x28 #NpadSystemExtState
NpadSystemExtState

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

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x8 Buttons
0x10 0x8 AnalogStickL
0x18 0x8 AnalogStickR
0x20 0x4 Attributes
0x24 0x4 Reserved

NpadSixAxisSensorLifo

This is "nn::hid::detail::NpadSixAxisSensorLifo". This is a RingLifo object.

Offset Size Description
0x0 0x8 RingLifoVptr
0x8 0x8 BufferCount
0x10 0x8 Tail
0x18 0x8 Count
0x20 0x68 * 17 Array of #SixAxisSensorStateAtomicStorage
SixAxisSensorStateAtomicStorage

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

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x60 #SixAxisSensorState
SixAxisSensorState

This is "nn::hid::SixAxisSensorState".

Offset Size Description
0x0 0x8 DeltaTime
0x8 0x8 SamplingNumber
0x10 0x4 AccelerationX
0x14 0x4 AccelerationY
0x18 0x4 AccelerationZ
0x1C 0x4 AngularVelocityX
0x20 0x4 AngularVelocityY
0x24 0x4 AngularVelocityZ
0x28 0x4 AngleX
0x2C 0x4 AngleY
0x30 0x4 AngleZ
0x34 0x24 Direction
0x58 0x4 Attributes
0x5C 0x4 Reserved

NfcXcdDeviceHandleState

This is "nn::hid::detail::NfcXcdDeviceHandleState". This is a RingLifo object.

Offset Size Description
0x0 0x8 RingLifoVptr
0x8 0x8 BufferCount
0x10 0x8 Tail
0x18 0x8 Count
0x20 0x20 * 2 Array of #NfcXcdDeviceHandleStateImplAtomicStorage
NfcXcdDeviceHandleStateImplAtomicStorage

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

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x18 #NfcXcdDeviceHandleStateImpl
NfcXcdDeviceHandleStateImpl

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

Offset Size Description
0x0 0x8 Handle
0x8 0x1 IsAvailable
0x9 0x1 IsActivated
0xA 0x6 Reserved
0x10 0x8 SamplingNumber

NpadGcTriggerLifo

This is "nn::hid::detail::NpadGcTriggerLifo". This is a RingLifo object.

Offset Size Description
0x0 0x8 RingLifoVptr
0x8 0x8 BufferCount
0x10 0x8 Tail
0x18 0x8 Count
0x20 0x18 * 17 Array of #NpadGcTriggerStateAtomicStorage
NpadGcTriggerStateAtomicStorage

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

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x10 #NpadGcTriggerState
NpadGcTriggerState

This is "nn::hid::server::NpadGcTriggerState".

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x4 TriggerL
0xC 0x4 TriggerR

GestureSharedMemoryFormat

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

Offset Size Description
0x0 0x708 #GestureLifo

GestureLifo

This is "nn::hid::detail::GestureLifo". This is a RingLifo object.

Offset Size Description
0x0 0x8 RingLifoVptr
0x8 0x8 BufferCount
0x10 0x8 Tail
0x18 0x8 Count
0x20 0x68 * 17 Array of #GestureDummyStateAtomicStorage
GestureDummyStateAtomicStorage

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

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x60 #GestureDummyState
GestureDummyState

This is "nn::hid::detail::GestureDummyState" / "nn::hid::GestureState".

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x8 ContextNumber
0x10 0x4 Type
0x14 0x4 Direction
0x18 0x4 X
0x1C 0x4 Y
0x20 0x4 s32 DeltaX
0x24 0x4 s32 DeltaY
0x28 0x4 float VelocityX
0x2C 0x4 float VelocityY
0x30 0x4 Attributes
0x34 0x4 Scale
0x38 0x4 RotationAngle
0x3C 0x4 s32 PointCount
0x40 0x8 * 4 Points

ConsoleSixAxisSensorSharedMemoryFormat

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

Offset Size Description
0x0 0x8 SamplingNumber
0x8 0x1 IsSevenSixAxisSensorAtRest
0x9 0x3 Padding
0xC 0x4 VerticalizationError
0x10 0xC GyroBias

AnalogStickState

This is "nn::hid::AnalogStickState".

Offset Size Description
0x0 0x4 X
0x4 0x4 Y

TouchState

This is "nn::hid::TouchState".

Offset Size Description
0x0 0x8 DeltaTime
0x8 0x4 Attributes
0xC 0x4 FingerId
0x10 0x4 X
0x14 0x4 Y
0x18 0x4 DiameterX
0x1C 0x4 DiameterY
0x20 0x4 RotationAngle
0x24 0x4 Reserved

TouchScreenConfigurationForNx

This is "nn::hid::TouchScreenConfigurationForNx".

Offset Size Description
0x0 0x1 Mode
0x8 0xF Reserved

TouchScreenModeForNx

This is "nn::hid::TouchScreenModeForNx".

Value Description
0 UseSystemSetting
1 Finger
2 Heat2

InputSourceState

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

Offset Size Description
0x0 0x8 Timestamp

NpadControllerColor

This is "nn::hid::NpadControllerColor".

Offset Size Description
0x0 0x4 Main
0x4 0x4 Sub

NpadFullKeyColorState

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

Offset Size Description
0x0 0x4 Attribute
0x4 0x8 FullKey

NpadJoyColorState

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

Offset Size Description
0x0 0x4 Attribute
0x4 0x8 Left
0xC 0x8 Right

DirectionState

This is "nn::hid::DirectionState".

Offset Size Description
0x0 0x4 XX
0x4 0x4 XY
0x8 0x4 XZ
0xC 0x4 YX
0x10 0x4 YY
0x14 0x4 YZ
0x18 0x4 ZX
0x1C 0x4 ZY
0x20 0x4 ZZ

GesturePoint

This is "nn::hid::GesturePoint".

Offset Size Description
0x0 0x4 X
0x4 0x4 Y

ColorAttribute

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

Value Description
0 Ok
1 ReadError
2 NoController

DebugPadAttributeSet

This is "nn::hid::DebugPadAttributeSet". This is a BitFlagSet object for #DebugPadAttribute.

DebugPadAttribute

This is "nn::hid::DebugPadAttribute". This is a 32-bit flag.

Bit Description
0 IsConnected

TouchAttributeSet

This is "nn::hid::TouchAttributeSet". This is a BitFlagSet object for #TouchAttribute.

TouchAttribute

This is "nn::hid::TouchAttribute". This is a 32-bit flag.

Bit Description
0 Start
1 End

MouseAttributeSet

This is "nn::hid::MouseAttributeSet". This is a BitFlagSet object for #MouseAttribute.

MouseAttribute

This is "nn::hid::MouseAttribute". This is a 32-bit flag.

Bit Description
0 Transferable
1 IsConnected

BasicXpadAttributeSet

This is "nn::hid::BasicXpadAttributeSet". This is a BitFlagSet object for #BasicXpadAttribute.

NpadAttributesSet

This is "nn::hid::NpadAttributesSet". This is a BitFlagSet object for #NpadAttribute.

NpadAttribute

This is "nn::hid::NpadAttribute". This is a 32-bit flag.

Bit Description
0 IsConnected
1 IsWired
2 IsLeftConnected
3 IsLeftWired
4 IsRightConnected
5 IsRightWired

SixAxisSensorAttributeSet

This is "nn::hid::SixAxisSensorAttributeSet". This is a BitFlagSet object for #SixAxisSensorAttribute.

SixAxisSensorAttribute

This is "nn::hid::SixAxisSensorAttribute". This is a 32-bit flag.

Bit Description
0 IsConnected
1 IsInterpolated

GestureAttributeSet

This is "nn::hid::GestureAttributeSet". This is a BitFlagSet object for #GestureAttribute.

GestureAttribute

This is "nn::hid::GestureAttribute". This is a 32-bit flag.

Bit Description
4 IsNewTouch
8 IsDoubleTap

DebugPadButtonSet

This is "nn::hid::DebugPadButtonSet". This is a BitFlagSet object for #DebugPadButton.

DebugPadButton

This is "nn::hid::DebugPadButton". This is a 32-bit flag.

Bit Description
0 A
1 B
2 X
3 Y
4 L
5 R
6 ZL
7 ZR
8 Start
9 Select
10 Left
11 Up
12 Right
13 Down

MouseButtonSet

This is "nn::hid::MouseButtonSet". This is a BitFlagSet object for #MouseButton.

MouseButton

This is "nn::hid::MouseButton". This is a 32-bit flag.

Bit Description
0 Left
1 Right
2 Middle
3 Forward
4 Back

KeyboardModifierSet

This is "nn::hid::KeyboardModifierSet". This is a BitFlagSet object for #KeyboardModifier.

KeyboardModifier

This is "nn::hid::KeyboardModifier". This is a 32-bit flag.

Bit Description
0 Control
1 Shift
2 LeftAlt
3 RightAlt
4 Gui
8 CapsLock
9 ScrollLock
10 NumLock
11 Katakana
12 Hiragana

KeyboardKeySet

This is "nn::hid::KeyboardKeySet". This is a BitFlagSet object for #KeyboardKey.

KeyboardKey

This is "nn::hid::KeyboardKey". This is a 256-bit flag.

Bit Description
4 A
5 B
6 C
7 D
8 E
9 F
10 G
11 H
12 I
13 J
14 K
15 L
16 M
17 N
18 O
19 P
20 Q
21 R
22 S
23 T
24 U
25 V
26 W
27 X
28 Y
29 Z
30 D1
31 D2
32 D3
33 D4
34 D5
35 D6
36 D7
37 D8
38 D9
39 D0
40 Return
41 Escape
42 Backspace
43 Tab
44 Space
45 Minus
46 Plus
47 OpenBracket
48 CloseBracket
49 Pipe
50 Tilde
51 Semicolon
52 Quote
53 Backquote
54 Comma
55 Period
56 Slash
57 CapsLock
58 F1
59 F2
60 F3
61 F4
62 F5
63 F6
64 F7
65 F8
66 F9
67 F10
68 F11
69 F12
70 PrintScreen
71 ScrollLock
72 Pause
73 Insert
74 Home
75 PageUp
76 Delete
77 End
78 PageDown
79 RightArrow
80 LeftArrow
81 DownArrow
82 UpArrow
83 NumLock
84 NumPadDivide
85 NumPadMultiply
86 NumPadSubtract
87 NumPadAdd
88 NumPadEnter
89 NumPad1
90 NumPad2
91 NumPad3
92 NumPad4
93 NumPad5
94 NumPad6
95 NumPad7
96 NumPad8
97 NumPad9
98 NumPad0
99 NumPadDot
100 Backslash
101 Application
102 Power
103 NumPadEquals
104 F13
105 F14
106 F15
107 F16
108 F17
109 F18
110 F19
111 F20
112 F21
113 F22
114 F23
115 F24
133 NumPadComma
135 Ro
136 KatakanaHiragana
137 Yen
138 Henkan
139 Muhenkan
140 NumPadCommaPc98
144 HangulEnglish
145 Hanja
146 Katakana
147 Hiragana
148 ZenkakuHankaku
224 LeftControl
225 LeftShift
226 LeftAlt
227 LeftGui
228 RightControl
229 RightShift
230 RightAlt
231 RightGui

KeyboardLockKeyEventSet

This is "nn::hid::system::KeyboardLockKeyEventSet". This is a BitFlagSet object for #KeyboardLockKeyEvent.

KeyboardLockKeyEvent

This is "nn::hid::system::KeyboardLockKeyEvent". This is a 32-bit flag.

Bit Description
0 NumLockOn
1 NumLockOff
2 NumLockToggle
3 CapsLockOn
4 CapsLockOff
5 CapsLockToggle
6 ScrollLockOn
7 ScrollLockOff
8 ScrollLockToggle

BasicXpadButtonSet

This is "nn::hid::BasicXpadButtonSet". This is a BitFlagSet object for #BasicXpadButton.

HomeButtonSet

This is "nn::hid::system::HomeButtonSet". This is a BitFlagSet object for #HomeButton.

SleepButtonSet

This is "nn::hid::system::SleepButtonSet". This is a BitFlagSet object for #SleepButton.

CaptureButtonSet

This is "nn::hid::system::CaptureButtonSet". This is a BitFlagSet object for #CaptureButton.

NpadButtonSet

This is "nn::hid::NpadButtonSet". This is a BitFlagSet object for #NpadButton.

NpadButton

This is "nn::hid::NpadButton". This is a 64-bit flag.

Bit Description
0 A
1 B
2 X
3 Y
4 StickL
5 StickR
6 L
7 R
8 ZL
9 ZR
10 Plus
11 Minus
12 Left
13 Up
14 Right
15 Down
16 StickLLeft
17 StickLUp
18 StickLRight
19 StickLDown
20 StickRLeft
21 StickRUp
22 StickRRight
23 StickRDown
24 LeftSL
25 LeftSR
26 RightSL
27 RightSR
28 Palma
29 Verification
30 HandheldLeftB (Left B button on NES controllers in Handheld mode)
31 [12.0.0+] LeftC (Left C button in N64 controller)
32 [12.0.0+] UpC (Up C button in N64 controller)
33 [12.0.0+] RightC (Right C button in N64 controller)
34 [12.0.0+] DownC (Down C button in N64 controller)

AnalogStickCalibrationFlagsSet

This is "nn::hid::detail::AnalogStickCalibrationFlagsSet". This is a BitFlagSet object for #AnalogStickCalibrationFlags.

SixAxisSensorUserCalibrationFlagsSet

This is "nn::hid::detail::SixAxisSensorUserCalibrationFlagsSet". This is a BitFlagSet object for #SixAxisSensorUserCalibrationFlags.

NpadStyleSet

This is "nn::hid::NpadStyleSet". This is a BitFlagSet object for #NpadStyleTag.

NpadStyleTag

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

Bits Description
0 NpadStyleFullKey (Pro Controller)
1 NpadStyleHandheld (Joy-Con controller in handheld mode)
2 NpadStyleJoyDual (Joy-Con controller in dual mode)
3 NpadStyleJoyLeft (Joy-Con left controller in single mode)
4 NpadStyleJoyRight (Joy-Con right controller in single mode)
5 NpadStyleGc (GameCube controller)
6 NpadStylePalma (Poké Ball Plus controller)
7 NpadStyleLark (NES/Famicom controller)
8 NpadStyleHandheldLark (NES/Famicom controller in handheld mode)
9 NpadStyleLucia (SNES controller)
10 [12.0.0+] NpadStyleLagon (N64 controller)
11 [13.0.0+] NpadStyleLager (Sega Genesis controller)
12-28 Reserved
29 NpadStyleSystemExt (generic external controller)
30 NpadStyleSystem (generic controller)
31 Reserved

NpadDeviceTypeSet

This is "nn::hid::system::NpadDeviceTypeSet". This is a BitFlagSet object for NpadDeviceType.

NpadSystemPropertiesSet

This is "nn::hid::detail::NpadSystemPropertiesSet". This is a BitFlagSet object for #NpadSystemProperties.

NpadSystemProperties

This is "nn::hid::detail::NpadSystemProperties". This is a 64-bit flag.

Bit Description
0 IsChargingJoyDual
1 IsChargingJoyLeft
2 IsChargingJoyRight
3 IsPoweredJoyDual
4 IsPoweredJoyLeft
5 IsPoweredJoyRight
9 IsUnsuportedButtonPressedOnNpadSystem
10 IsUnsuportedButtonPressedOnNpadSystemExt
11 IsAbxyButtonOriented
12 IsSlSrButtonOriented
13 [4.0.0+] IsPlusAvailable
14 [4.0.0+] IsMinusAvailable
15 [8.0.0+] IsDirectionalButtonsAvailable

NpadSystemButtonPropertiesSet

This is "nn::hid::detail::NpadSystemButtonPropertiesSet". This is a BitFlagSet object for #NpadSystemButtonProperties.

NpadSystemButtonProperties

This is "nn::hid::NpadSystemButtonProperties". This is a 32-bit flag.

Bit Description
0 IsUnintendedHomeButtonInputProtectionEnabled

AppletFooterUiAttributesSet

This is "nn::hid::system::AppletFooterUiAttributesSet". This is a BitFlagSet object for #AppletFooterUiAttribute.

UniquePadType

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

Value Description
0 Embedded
1 FullKeyController
2 RightController
3 LeftController
4 DebugPadController

UniquePadInterface

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

Value Description
0 Embedded
1 Rail
2 Bluetooth
3 Usb

UniquePadSerialNumber

This is "nn::hid::system::UniquePadSerialNumber". This is a 0x10 byte value.

UniquePadId

This is "nn::hid::system::UniquePadId". This is a 8 byte value.

AnalogStickManualCalibrationStage

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

Value Description
0 ReleaseFromRight
1 ReleaseFromBottom
2 ReleaseFromLeft
3 ReleaseFromTop
4 Rotate
5 Update
6 Completed
7 Clear
8 ClearCompleted

SixAxisSensorUserCalibrationStage

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

Value Description
0 Measuring
1 Update
2 Completed

NpadJoyHoldType

This is "nn::hid::NpadJoyHoldType".

Value Description
0 Vertical
1 Horizontal

NpadJoyDeviceType

This is "nn::hid::NpadJoyDeviceType".

Value Description
0 Left
1 Right

NpadHandheldActivationMode

This is "nn::hid::NpadHandheldActivationMode".

This controls how many joycons must be attached for handheld mode to be triggered (Dual = 2, Single = 1, None = 0).

Value Description
0 Dual
1 Single
2 None

NpadJoyAssignmentMode

This is "nn::hid::NpadJoyAssignmentMode".

Value Description
0 Dual
1 Single

NpadCommunicationMode

This is "nn::hid::NpadCommunicationMode".

Value Description
0 5ms
1 10ms
2 15ms
3 Default

FirmwareVersion

This is "nn::hid::system::FirmwareVersion" ([1.0.0-2.3.0] "nn::hid::debug::FirmwareVersion").

Offset Size Description
0x0 0x1 Major
0x1 0x1 Minor
0x2 0x1 Micro
0x3 0x1 Revision
0x4 0xC [3.0.0+] #DeviceIdentifier

DeviceIdentifier

Value Description
"JR" Joy-Con right controller
"JL" Joy-Con left controller
"FK" Pro Controller
"MY" MiyabiLeft and MiyabiRight
"LC" Tarragon and Tarragon2
"HL" Famicom left controller
"HR" Famicom right controller (with microphone)
"NL" NES left controller
"NR" NES right controller
"SN" SNES controller
"LT" N64 controller
"LS" Sega Genesis controller
"PB" Poké Ball Plus controller
"SH" SioH
"TS" TouchScreen

AppletDetailedUiType

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

Value Description
0x00000000 None
0x01000000 HandheldNone
0x02000000 HandheldJoyConLeftOnly
0x02000001 HandheldLarkHvc1Only
0x02000002 HandheldLarkNesLeftOnly
0x03000000 HandheldJoyConRightOnly
0x03000001 HandheldLarkHvc2Only
0x03000002 HandheldLarkNesRightOnly
0x04000000 HandheldJoyConLeftJoyConRight
0x04000001 HandheldJoyConLeftLarkHvc2
0x04000002 HandheldJoyConLeftLarkNesRight
0x04000003 HandheldLarkHvc1JoyConRight
0x04000004 HandheldLarkHvc1LarkHvc2
0x04000005 HandheldLarkHvc1LarkNesRight
0x04000006 HandheldLarkNesLeftJoyConRight
0x04000007 HandheldLarkNesLeftLarkHvc2
0x04000008 HandheldLarkNesLeftLarkNesRight
0x05000000 JoyDual
0x06000000 JoyDualLeftOnly
0x07000000 JoyDualRightOnly
0x08000000 JoyLeftHorizontal
0x09000000 JoyLeftVertical
0x0A000000 JoyRightHorizontal
0x0B000000 JoyRightVertical
0x0C000000 SwitchProController
0x0D000000 CompatibleProController
0x0E000000 CompatibleJoyCon
0x0F000000 LarkHvc1
0x10000000 LarkHvc2
0x11000000 LarkNesLeft
0x12000000 LarkNesRight
0x13000000 LuciaU
0x13000001 LuciaJ
0x13000002 LuciaE
0x14000000 Verification
0x15000000 [13.0.0+] Lagon
0xFFFFFFFF Unknown

AppletFooterUiType

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

Value Description
0 None
1 HandheldNone
2 HandheldJoyConLeftOnly
3 HandheldJoyConRightOnly
4 HandheldJoyConLeftJoyConRight
5 JoyDual
6 JoyDualLeftOnly
7 JoyDualRightOnly
8 JoyLeftHorizontal
9 JoyLeftVertical
10 JoyRightHorizontal
11 JoyRightVertical
12 SwitchProController
13 CompatibleProController
14 CompatibleJoyCon
15 LarkHvc1
16 LarkHvc2
17 LarkNesLeft
18 LarkNesRight
19 Lucia
20 Verification
21 [13.0.0+] Lagon

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 Embedded

NpadLarkType

This is "nn::hid::NpadLarkType".

Value Description
0 Invalid
1 H1
2 H2
3 NL
4 NR

NpadLuciaType

This is "nn::hid::NpadLuciaType".

Value Description
0 Invalid
1 J
2 E
3 U

NpadLagerType

This is "nn::hid::NpadLagerType".

Value Description
0 Invalid
1 J
2 E
3 U

SixAxisSensorProperties

This is "nn::hid::server::SixAxisSensorProperties".

Bit Description
0 IsSixAxisSensorDeviceNewlyAssigned
1 IsFirmwareUpdateAvailableForSixAxisSensor

GestureDirection

This is "nn::hid::GestureDirection".

Value Description
0 None
1 Left
2 Up
3 Right
4 Down

GestureType

This is "nn::hid::GestureType".

Value Description
0 Idle
1 Complete
2 Cancel
3 Touch
4 Press
5 Tap
6 Pan
7 Swipe
8 Pinch
9 Rotate

DeviceHandle

This is "nn::xcd::DeviceHandle". This is a 8 byte value.

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 [12.0.0+] Lagon
17 [13.0.0+] Lager
18-30 Reserved
31 System

DeviceTypeInternal

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

[9.0.0+] This has been superseded by DeviceType.

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

DeviceType

This is "nn::hidtypes::DeviceType".

Value Description
0 Unknown
1 JoyConRight
2 JoyConLeft
3 SwitchProController
4 MiyabiLeft
5 MiyabiRight
6 Tarragon
7 LarkH1
8 LarkH2
9 LarkNL
10 LarkNR
11 Lucia
12 Palma
13 GcOnGggg
14 FiftyL
15 UsbPad
16 WinGenericPad
17 Sio
18 FiftyR
19 DebugSwitchProControllerCompatibleDevice
20 DebugJoyConLeftCompatibleDevice
21 DebugJoyConRightCompatibleDevice
22 [12.0.0+] Lagon
23 [12.0.0+] ExternalGrip
24 [13.0.0+] SwitchProControllerDfu
25 [13.0.0+] ExternalGripDfu
26 [13.0.0+] LuciaDfu
27 [13.0.0+] LagonDfu
28 [13.0.0+] Lager
29 [14.0.0+] LagerDfu
30 [14.0.0+] Tarragon2

JoyConRight

Joy-Con right controller. USB PID is 0x2007.

JoyConLeft

Joy-Con left controller. USB PID is 0x2006.

SwitchProController

Pro Controller. USB PID is 0x2009.

Tarragon

Licensed Pro Controller.

LarkH1

Famicom left controller.

LarkH2

Famicom right controller (with microphone).

LarkNL

NES left controller.

LarkNR

NES right controller.

Lucia

SNES controller. USB PID is 0x2017.

Palma

Poké Ball Plus controller.

GcOnGggg

GameCube controller.

Lagon

N64 controller. USB PID is 0x2019.

ExternalGrip

Joy-Con Charging Grip. USB PID is 0x200E.

SwitchProControllerDfu

"Kotetsu" (Pro Controller MCU) in DFU mode. USB PID is 0x200F.

ExternalGripDfu

"Kuina" (Joy-Con Charging Grip MCU) in DFU mode. USB PID is 0x2008.

LuciaDfu

SNES controller MCU in DFU mode. USB PID is 0x2018.

LagonDfu

N64 controller MCU in DFU mode. USB PID is 0x201A.

Lager

Sega Genesis controller. USB PID is 0x201E.

LagerDfu

Sega Genesis controller MCU in DFU mode. USB PID is 0x201F.

Tarragon2

Licensed Pro Controller.

VidPidDefinition

This is "nn::hidtypes::VidPidDefinition".

Offset Size Description
0x0 0x2 Vid
0x2 0x2 PidRangeMax
0x4 0x2 PidRangeMin
0x6 0x1 DeviceType
0x7 0x1 Reserved

VidPidDefinitions

This is "nn::hidtypes::detail::VidPidDefinitions". This is a list of VidPidDefinition objects maintained by the hid-sysmodule.

Vid PidRangeMax PidRangeMin DeviceType
0x57E 0x2006 0x2006 2
0x57E 0x2007 0x2007 1
0x57E 0x2009 0x2009 3
0x57E 0x200F 0x200F 24
0x57E 0x200E 0x200E 23
0x57E 0x2008 0x2008 25
0x57E 0x2017 0x2017 11
0x57E 0x2018 0x2018 26
0x57E 0x2019 0x2019 22
0x57E 0x201A 0x201A 27
0x57E 0x201E 0x201E 28
0x57E 0x201F 0x201F 29
0x57E 0x337 0x337 13
0x57E 0x300E 0x300E [17.0.0+] 18
0x57E 0x300D 0x300D [17.0.0+] 14
0xF0D 0x92 0x92 15
0xF0D 0xAB 0xAA 15
0xF0D 0xC1 0xC1 15
0xF0D 0xFF 0xF0 15
0xF0D 0x22F 0x200 15
0xE6F 0x193 0x180 15
0x20D6 0xA719 0xA710 15
0x20D6 0xA729 0xA720 15
0x33DD 0xB 0x1 15

NpadPowerInfo

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

Offset Size Description
0x0 0x1 IsPowered
0x1 0x1 IsCharging
0x2 0x6 Reserved
0x8 0x4 BatteryLevel

BatteryLevel

This is "nn::hid::system::NpadBatteryLevel". This is a 4 byte value.

ConsoleSixAxisSensorHandle

This is "nn::hid::ConsoleSixAxisSensorHandle". This is a 4-byte struct with 4-byte alignment.

sdknso GetConsoleSixAxisSensorHandle always returns a handle with value 0x13.

Offset Size Description
0x0 0x4 TypeValue
0x0 0x1
0x1 0x1

SixAxisSensorHandle

This is "nn::hid::SixAxisSensorHandle". This is a 4-byte struct with 4-byte alignment.

Offset Size Description
0x0 0x4 TypeValue
0x0 0x1 NpadStyleIndex
0x1 0x1 PlayerNumber
0x2 0x1 DeviceIdx

VibrationDeviceHandle

This is "nn::hid::VibrationDeviceHandle". This is a 4-byte struct with 4-byte alignment.

Offset Size Description
0x0 0x4 TypeValue
0x0 0x1 NpadStyleIndex
0x1 0x1 PlayerNumber
0x2 0x1 DeviceIdx

VibrationDeviceInfo

This is "nn::hid::VibrationDeviceInfo" / "nn::hid::VibrationDeviceInfoForIpc". This is a 0x8-byte struct.

Offset Size Description
0x0 0x4 DeviceType
0x4 0x4 Position

VibrationDeviceType

This is "nn::hid::VibrationDeviceType".

Value Description
0 Unknown
1 LinearResonantActuator
2 GcErm
3 Erm

VibrationDevicePosition

This is "nn::hid::VibrationDevicePosition".

Value Description
0 None
1 Left
2 Right

VibrationValue

This is "nn::hid::VibrationValue". This is a 0x10-byte struct, which contains 4 float values.

Offset Size Description
0x0 0x4 AmplitudeLow
0x4 0x4 FrequencyLow
0x8 0x4 AmplitudeHigh
0xC 0x4 FrequencyHigh

VibrationGcErmCommand

This is "nn::hid::VibrationGcErmCommand".

Value Name Description
0 Stop Stops the vibration with a decay phase.
1 Start Starts the vibration.
2 StopHard Stops the vibration immediately, with no decay phase.

AccelerometerPlayMode

This is "nn::hid::debug::AccelerometerPlayMode" (pre-10.0.0 this is "nn::hid::AccelerometerPlayMode").

Value Description
0 Loose
1 Tight

GyroscopeZeroDriftMode

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

Value Description
0 Loose
1 Standard
2 Tight

PalmaConnectionHandle

This is "nn::hid::PalmaConnectionHandle". This is a 0x8-byte struct with 8-byte alignment.

PalmaOperationInfo

This is "nn::hid::PalmaOperationInfo". This is a 0x148-byte struct.

Offset Size Description
0x0 0x4 #PalmaOperationType
0x4 0x4 Result
0x8 0x140 Buffer for #GetPalmaOperationInfo.

PalmaOperationType

This is "nn::hid::PalmaOperationType".

Value Description
0 PlayActivity
1 SetFrModeType
2 ReadStep
3 EnableStep
4 ResetStep
5 ReadApplicationSection
6 WriteApplicationSection
7 ReadUniqueCode
8 SetUniqueCodeInvalid
9 WriteActivityEntry
10 WriteRgbLedPatternEntry
11 WriteWaveEntry
12 ReadDataBaseIdentificationVersion
13 WriteDataBaseIdentificationVersion
14 SuspendFeature
15 [5.1.0+] ReadPlayLog
16 [5.1.0+] ResetPlayLog

PalmaFrModeType

This is "nn::hid::PalmaFrModeType".

Value Description
0 Off
1 B01
2 B02
3 B03
4 Downloaded

PalmaApplicationSectionAccessBuffer

This is "nn::hid::PalmaApplicationSectionAccessBuffer". This is a 0x100-byte struct.

PalmaActivityEntry

This is "nn::hid::PalmaActivityEntry".

Offset Size Description
0x0 0x2 RgbLedPatternIndex.
0x2 0x2 Padding
0x4 0x4 WaveSet.
0x8 0x2 WaveIndex.

PalmaWaveSet

This is "nn::hid::PalmaWaveSet".

Value Description
0 Small
1 Medium
2 Large

PalmaFeature

This is "nn::hid::PalmaFeature".

Bit Description
0 FrMode
1 RumbleFeedback
2 Step
3 MuteSwitch

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.

DebugPadAutoPilotState

This is "nn::hid::debug::DebugPadAutoPilotState"

Offset Size Description
0x0 0x4 Attributes
0x4 0x4 Buttons
0x8 0x8 AnalogStickL
0x10 0x8 AnalogStickR

MouseAutoPilotState

This is "nn::hid::debug::MouseAutoPilotState".

Offset Size Description
0x0 0x4 X
0x4 0x4 Y
0x8 0x4 DeltaX
0xC 0x4 DeltaY
0x10 0x4 WheelDelta
0x14 0x4 Buttons
0x18 0x4 Attributes

KeyboardAutoPilotState

This is "nn::hid::debug::KeyboardAutoPilotState".

Offset Size Description
0x0 0x8 Modifiers
0x8 0x20 Keys

SleepButtonAutoPilotState

This is "nn::hid::debug::SleepButtonAutoPilotState". This is a 0x8-byte struct with 8-byte alignment.

Offset Size Description
0x0 0x8 Buttons (only bit0 is used)

DigitizerAutoPilotState

This is "nn::hid::debug::DigitizerAutoPilotState".

Offset Size Description
0x0 0x44

PowerInfo

This is "nn::hidtypes::PowerInfo".

Offset Size Description
0x0 0x4 BatteryLevel
0x4 0x4 #PowerAttribute

PowerAttribute

This is "nn::hidtypes::PowerAttribute". This is a 32-bit flag.

Bits Description
0 IsPowered
1 IsCharging

HdlsAttribute

This is "nn::hidtypes::HdlsAttribute". This is a 32-bit flag.

Bits Description
0 HasVirtualSixAxisSensorAcceleration
1 HasVirtualSixAxisSensorAngle

HdlsHandle

This is "nn::hid::debug::HdlsHandle". This is a 0x8-byte struct with 8-byte alignment.

HdlsSessionId

This is "nn::hid::debug::detail::HdlsSessionId". This is a 0x8-byte struct with 8-byte alignment.

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 "nn::hid::debug::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 Left Grip Color
0x10 0x4 RGBA Right Grip Color

HdlsState

This is "nn::hid::debug::HdlsState". This is a 0x24-byte struct.

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

[9.0.0+] (0x28-bytes):

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

[12.0.0+] (0x40-bytes):

Offset Size Description
0x0 0x8 #PowerInfo
0x8 0x8 Buttons, masked with 0xfffffffff00fffff. See above table regarding HOME/Capture buttons.
0x10 0x10(4*2*2) Joystick data.
0x20 0xC VirtualSixAxisSensorAcceleration
0x2C 0xC VirtualSixAxisSensorAngle
0x38 0x4 #HdlsAttribute
0x3C 0x1 Indicator. Unused for input.
0x3D 0x3 Padding

DebugRegisteredDevice

This is "nn::hid::debug::RegisteredDevice". This is a 0x58-byte struct with 2-byte alignment.

RegisteredDevice

This is "nn::hid::system::RegisteredDevice". This is a 0x68-byte struct with 4-byte alignment.

NotificationLedPattern

This is "nn::hid::system::NotificationLedPattern". This is a 0x48-byte struct.

Offset Size Description
0x0 0x1 TimeUnit
0x1 0x1 FrameCount
0x2 0x1 CycleCount
0x3 0x1 InitialBrightness
0x4 0x4 * 15 Frames
0x40 0x1 FinalBrightness
0x41 0x1 TimeTowardsFinalBrightness
0x42 0x6 Reserved

Frame

Offset Size Description
0x0 0x1 Brightness
0x1 0x1 TimeTowards
0x2 0x1 TimeToHold
0x3 0x1 Reserved

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 0x4 HardwareButtonLeft
0x4 0x4 HardwareButtonUp
0x8 0x4 HardwareButtonRight
0xC 0x4 HardwareButtonDown
0x10 0x4 HardwareButtonA
0x14 0x4 HardwareButtonB
0x18 0x4 HardwareButtonX
0x1C 0x4 HardwareButtonY
0x20 0x4 HardwareButtonStickL
0x24 0x4 HardwareButtonStickR
0x28 0x4 HardwareButtonL
0x2C 0x4 HardwareButtonR
0x30 0x4 HardwareButtonZL
0x34 0x4 HardwareButtonZR
0x38 0x4 HardwareButtonSelect
0x3C 0x4 HardwareButtonStart
0x40 0x4 HardwareButtonCapture
0x44 0x8 HardwareStickL
0x4C 0x8 HardwareStickR

DigitalButtonAssignment

This is "nn::hidconfig::DigitalButtonAssignment".

Value Description
0 A
1 B
2 X
3 Y
4 StickL
5 StickR
6 L
7 R
8 ZL
9 ZR
10 Select
11 Start
12 Left
13 Up
14 Right
15 Down
16 LeftSL
17 LeftSR
18 RightSL
19 RightSR
20 HomeButton
21 CaptureButton
22 Invalid

AnalogStickAssignment

This is "nn::hidconfig::AnalogStickAssignment".

Offset Size Description
0x0 0x4 #AnalogStickRotation
0x4 0x1 IsPairedStickAssigned
0x5 0x3 Reserved

AnalogStickRotation

This is "nn::hidconfig::AnalogStickRotation".

Value Description
0 None
1 Clockwise90
2 Anticlockwise90

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 0x4 HardwareButtonLeft
0x4 0x4 HardwareButtonUp
0x8 0x4 HardwareButtonRight
0xC 0x4 HardwareButtonDown
0x10 0x4 HardwareButtonStickL
0x14 0x4 HardwareButtonL
0x18 0x4 HardwareButtonZL
0x1C 0x4 HardwareButtonSelect
0x20 0x4 HardwareButtonLeftSL
0x24 0x4 HardwareButtonLeftSR
0x28 0x4 HardwareButtonCapture
0x2C 0x8 HardwareStickL

ButtonConfigRight

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

Offset Size Description
0x0 0x4 HardwareButtonA
0x4 0x4 HardwareButtonB
0x8 0x4 HardwareButtonX
0xC 0x4 HardwareButtonY
0x10 0x4 HardwareButtonStickR
0x14 0x4 HardwareButtonR
0x18 0x4 HardwareButtonZR
0x1C 0x4 HardwareButtonStart
0x20 0x4 HardwareButtonRightSL
0x24 0x4 HardwareButtonRightSR
0x28 0x8 HardwareStickR

StorageName

This is "nn::hidconfig::StorageName". This is a 0x81-byte struct.

This is an UTF-8 NUL-terminated name string.

InterfaceType

This is "nn::hidtypes::InterfaceType".

Value Description
1 Bluetooth
2 Rail
3 Usb
4 Embedded

DigitalButton

This is "nn::hidtypes::DigitalButton". This is a 64-bit flag.

Bit Description
0 A
1 B
2 X
3 Y
4 StickL
5 StickR
6 L
7 R
8 ZL
9 ZR
10 Start
11 Select
12 Left
13 Up
14 Right
15 Down
16 SL
17 SR
18 Home
19 Shot
20 StickLLeft
21 StickLUp
22 StickLRight
23 StickLDown
24 StickRLeft
25 StickRUp
26 StickRRight
27 StickRDown
28 Palma
29 HandheldLeftB
30 Plus
31 Minus
32 Z
33 LeftSL
34 LeftSR
35 RightSL
36 RightSR
37 LeftC
38 UpC
39 RightC
40 DownC

AssignmentStyle

This is "nn::hidtypes::AssignmentStyle". This is a 32-bit flag.

Bit Description
0 IsExternalAssigned
1 IsExternalLeftAssigned
2 IsExternalRightAssigned
3 IsHandheldAssigned
4 IsHandheldLeftAssigned
5 IsHandheldRightAssigned

FeatureType

This is "nn::hidtypes::FeatureType". This is a 64-bit flag.

Bit Description
0 HasLeftAnalogStick
1 HasRightAnalogStick
2 HasLeftJoySixAxisSensor
3 HasRightJoySixAxisSensor
4 HasFullKeySixAxisSensor
5 HasLeftLraVibrationDevice
6 HasRightLraVibrationDevice
7 HasGcVibrationDevice
8 HasErmVibrationDevice
9 HasLeftJoyRailBus
10 HasRightJoyRailBus
11 HasInternalBus
12 IsPalma
13 HasNfc
14 HasIrSensor
15 IsAnalogStickCalibrationSupported
16 IsSixAxisSensorUserCalibrationSupported
17 HasLeftJoyRightJoyBattery
18 HasFullKeyBattery
19 IsDisconnectControllerIfBatteryNone
20 HasControllerColor
21 HasGripColor
22 HasIdentificationCode
23 HasBluetoothAddress
24 HasMcu
25 HasNotificationLed
26 HasDirectionalButtons
27 HasIndicatorLed
28 IsButtonConfigEmbeddedSupported
29 IsButtonConfigFullSupported
30 IsButtonConfigLeftSupported
31 IsButtonConfigRightSupported
32 IsUsbHidDevice
33 IsKuinaDevice
34 IsDirectUsbToBtSwitchingDevice
35 IsNormalizeAnalogStickWithInnerCross

Color

This is "nn::hidtypes::Color".

Offset Size Description
0x0 0x4 BodyColor
0x4 0x4 ButtonColor
0x8 0x4 LeftGripColor
0xC 0x4 RightGripColor

DeviceDescriptorType

This is "nn::hidtypes::DeviceDescriptorType".

Offset Size Description
0x0 0x1 DeviceType
0x1 0x7 Reserved
0x8 0x8 FeatureType
0x10 0x8 DigitalButton
0x18 0x4 AssignmentStyle
0x1C 0x10 DeviceColor
0x2C 0x4 Reserved

DeviceDescriptionList

This is "nn::hidtypes::detail::DeviceDescriptionList". This is a list of DeviceDescriptorType objects maintained by the hid-sysmodule.

DeviceType FeatureType DigitalButton AssignmentStyle DeviceColor
1 0x18BDBE44A 0x18F0406AF 0x24 0xFF828282, 0xFF0F0F0F, 0x00000000, 0x00000000
2 0x14CDB8225 0x6F8F950 0x12 0xFF828282, 0xFF0F0F0F, 0x00000000, 0x00000000
3 0x72BBDA073 0xFFCFFFF 0x1 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
4 0x108000025 0x6F8F950 0x2 0xFF828282, 0xFF0F0F0F, 0x00000000, 0x00000000
5 0x10800004A 0x18F0406AF 0x4 0xFF828282, 0xFF0F0F0F, 0x00000000, 0x00000000
6 0x108800013 0xFFCFFFF 0x1 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
7 0x108CA0000 0x2008FCC3 0x11 0xFF322891, 0xFFFFFFFF, 0x00000000, 0x00000000
8 0x108CA0800 0x4F0C3 0x21 0xFF322891, 0xFFFFFFFF, 0x00000000, 0x00000000
9 0x108CA0000 0x2008FCC3 0x11 0xFFD9D7D7, 0xFFFFFFFF, 0x00000000, 0x00000000
10 0x108CA0000 0x4FCC3 0x21 0xFFD9D7D7, 0xFFFFFFFF, 0x00000000, 0x00000000
11 0x700CC0000 0xFFCF 0x0 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
12 0x841011 0x10000010 0x1 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
13 0x83 0xFF0F6CF 0x1 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
14 0x1 0xF8F950 0x10 0xFF828282, 0xFF0F0F0F, 0x00000000, 0x00000000
15 0x3 0xFFCFFFF 0x1 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
16 0x3 0xFFCFFFF 0x1 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
17 0x1001A013 0xFFCFFFF 0x8 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
18 0x2 0xF0406AF 0x20 0xFF828282, 0xFF0F0F0F, 0x00000000, 0x00000000
19 0x1088DA073 0xFFCF3FF 0x1 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
20 0x108CA0025 0x6F8F150 0x12 0xFF828282, 0xFF0F0F0F, 0x00000000, 0x00000000
21 0x108CA604A 0x18F0402AF 0x24 0xFF828282, 0xFF0F0F0F, 0x00000000, 0x00000000
[12.0.0+] 22 0xF00CC8101 0x1E1FCF6C3 0x1 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
[12.0.0+] 23 0x100000000 0x0 0x0 0x00000000, 0x00000000, 0x00000000, 0x00000000
[13.0.0+] 28 0x700CC0000 0xCF6CF 0x1 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
[14.0.0+] 30 0x108800003 0xFFCFFFF 0x1 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646

UnmaskFeatureDescriptorType

This is "nn::hid::server::UnmaskFeatureDescriptorType".

Offset Size Description
0x0 0x1 DeviceType
0x1 0x1 InterfaceType
0x2 0x6 Reserved
0x8 0x8 FeatureType

UnmaskFeatureDescriptorList

This is "nn::hid::server::UnmaskFeatureDescriptorList". This is a list of UnmaskFeatureDescriptorType objects maintained by the hid-sysmodule.

DeviceType InterfaceType FeatureType
3 3 0x2000
2 2 0x200
1 2 0x400
19 3 0x2000
2 3 0x200
1 3 0x6400

FirmwareVersionInfo

This is "nn::hidtypes::FirmwareVersionInfo".

Offset Size Description
0x0 0x4 FirmwareVersionAttribute
0x4 0x2
0x6 0x2 MajorVersion
0x8 0x2 MinorVersion
0xA 0x2

FirmwareVersionAttribute

This is "nn::hidtypes::FirmwareVersionAttribute". This is a 32-bit flag.

Bit Description
0 IsCustomerCodeCorruption
1 IsIapCorrupted

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 OutSize
0x38 0x8 SamplingNumber

BusType

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

Value Description
0 LeftJoyRail
1 RightJoyRail
2 [6.0.0+] InternalBus (for Lark microphone)

JoyPollingMode

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

Value Description
0 SixAxisSensorDisable
1 SixAxisSensorEnable
2 ButtonOnly

Other values causes #EnableJoyPollingReceiveMode to assert.

StatusManagerType

This is "nn::hidbus::detail::StatusManagerType".

Value Description
0 None
1 16
2 32

ExternalDevices

The following devices are used via hidbus:

  • Ring-Con
    • BusType is 0 (LeftJoyRail) or 1 (RightJoyRail).
    • DeviceId is 0x20 ("Ronde").
  • Famicom right controller (with microphone)
    • BusType is 2 (InternalBus).
    • DeviceId is 0x21 ("LarkMic").
    • SendAndReceive is not used. EnableJoyPollingReceiveMode is used where the input buffer is an u32 with value 0, #JoyPollingMode = 2. GetJoyPollingReceivedData is used to get the output data.
  • "Starlink: Battle For Atlas" controller mount
    • BusType is 1 (RightJoyRail).
    • DeviceId is 0x28 ("Flight").
    • EnableJoyPollingReceiveMode is used where the input buffer is an u16 with value 0x09, #JoyPollingMode = 0. SendAndReceive is called from 1 func. GetJoyPollingReceivedData is used to determine whether to call the same func which calls SendAndReceive, which is only done if out_size==0x4 && data[0]==0x09 && (data[1] & 1 == 1).

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

[10.0.0+] The RomFs for hid-sysmodule was removed. The data which used to be in RomFs was moved into title 0100000000000822.

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.

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.
  • [8.1.1+] ExpectVersionInfo-platform.hoag.csv
    • Same as "ExpectVersionInfo.csv" but for the Switch Lite platform.
  • [8.1.1+] FirmwareInfo-platform.hoag.csv
    • Same as "FirmwareInfo.csv" but for the Switch Lite platform.
  • [8.1.1+] sioh.bin
    • Switch Lite Joy-Con firmware.
  • [8.1.1+] sioh_iap.bin
    • Switch Lite Joy-Con (IAP profile) firmware.
  • [10.0.0+] FTS_00120100.fts256
    • Touch Screen controller firmware in FTS256 format.
  • [10.0.0+] FTS_32000001.fts256
    • Touch Screen controller firmware in FTS256 format for panel vendor "Nissha".
  • [10.0.0+] FTS_32000102.fts256
    • Touch Screen controller firmware in FTS256 format for panel vendor "GIS".
  • [10.0.0+] FTS_32000302.fts256
    • Touch Screen controller firmware in FTS256 format for panel vendor "Nissha_Hoag".
  • [10.0.0+] FTS_32000402.fts256
    • Touch Screen controller firmware in FTS256 format for panel vendor "GIS_Hoag".
  • [10.0.0+] TouchScreenConfiguration.csv
    • List in the format "[gpio],[gpio],[gpio],[config],[config]" where "gpio" can be "0" or "1" and "config" is an integer number.
  • [10.0.0+] TouchScreenFirmwareInfo.csv
    • List in the format "[driver],[gpio],[gpio],[gpio],[version],[file]" where "driver" can be "FTM" or "FST2", "gpio" can be "0" or "1", "version" is the hexadecimal representation of the firmware file's version and "file" is the name of the firmware file.
  • [13.0.0+] FTS_33000510.fts256
    • Touch Screen controller firmware in FTS256 format for panel vendor "Samsung_Aula".
  • [13.0.0] FTS_98000004.ftb
    • Touch Screen controller firmware in FTB format.
  • [13.1.0-13.2.1] FTS_50000001.ftb
    • Touch Screen controller firmware in FTB format for panel vendor "Nissha".
  • [14.0.0+] FTS_50000002.ftb
    • Touch Screen controller firmware in FTB format for panel vendor "Nissha".

Versions

Ukyosakyo

SystemVersion FirmwareVersion
[1.0.0+] 0348
[5.0.0+] 0389
[6.0.0+] 038B
[7.0.0+] 03A6
[8.0.0+] 03B5
[9.0.0+] 0400
[10.0.0+] 0406
[11.0.0+] 0407
[12.1.0+] 0410
[13.0.0+] 0417
[14.0.0+] 0419

Raizo

SystemVersion FirmwareVersion
[1.0.0+] 0348
[15.0.0+] 0421

Tera

SystemVersion FirmwareVersion
[1.0.0+] 030B
[4.0.0+] 0412
[5.0.0+] 0518
[6.0.0+] 061A
[8.0.0+] 081B

TeraFullKey

SystemVersion FirmwareVersion
[1.0.0+] 0305

ProController

SystemVersion FirmwareVersion
- 010A0200
[6.0.0+] 01100210

Palma

SystemVersion FirmwareVersion
- 1100
[6.1.0+] 1200

SioH

SystemVersion FirmwareVersion
- 000D
[8.1.1+] 0200
[10.0.0+] 0301
[11.0.0+] 0304