Nintendo Switch Brew

HID services: Difference between revisions

← Older edit
No edit summary
 
(187 intermediate revisions by 5 users not shown)
Line 13: Line 13:
|-
|-
| 21 || [[#ActivateMouse]]
| 21 || [[#ActivateMouse]]
|-
| 22 || [19.0.0+] AddMouseWheelDelta
|-
| 26 || [16.0.0+] ActivateDebugMouse
|-
|-
| 31 || [[#ActivateKeyboard]]
| 31 || [[#ActivateKeyboard]]
|-
|-
| 32 || [6.0.0+] SendKeyboardLockKeyEvent
| 32 || [6.0.0+] [[#SendKeyboardLockKeyEvent]]
|-
|-
| 40 || AcquireXpadIdEventHandle
| 40 || [[#AcquireXpadIdEventHandle]]
|-
|-
| 41 || ReleaseXpadIdEventHandle
| 41 || [[#ReleaseXpadIdEventHandle]]
|-
|-
| 51 || ActivateXpad
| 51 || [[#ActivateXpad]]
|-
|-
| 55 || GetXpadIds
| 55 || [[#GetXpadIds]]
|-
|-
| 56 || ActivateJoyXpad
| 56 || [[#ActivateJoyXpad]]
|-
|-
| 58 || GetJoyXpadLifoHandle
| 58 || [[#GetJoyXpadLifoHandle]]
|-
|-
| 59 || GetJoyXpadIds
| 59 || [[#GetJoyXpadIds]]
|-
|-
| 60 || ActivateSixAxisSensor
| 60 || [[#ActivateSixAxisSensor]]
|-
|-
| 61 || DeactivateSixAxisSensor
| 61 || [[#DeactivateSixAxisSensor]]
|-
|-
| 62 || GetSixAxisSensorLifoHandle
| 62 || [[#GetSixAxisSensorLifoHandle]]
|-
|-
| 63 || ActivateJoySixAxisSensor
| 63 || [[#ActivateJoySixAxisSensor]]
|-
|-
| 64 || DeactivateJoySixAxisSensor
| 64 || [[#DeactivateJoySixAxisSensor]]
|-
|-
| 65 || GetJoySixAxisSensorLifoHandle
| 65 || [[#GetJoySixAxisSensorLifoHandle]]
|-
|-
| 66 || [[#StartSixAxisSensor]]
| 66 || [[#StartSixAxisSensor]]
Line 79: Line 83:
|-
|-
| 83 || [6.0.0+] [[#IsFirmwareUpdateAvailableForSixAxisSensor]]
| 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]]
| 91 || [[#ActivateGesture]]
|-
| 92 || [18.0.0+] SetGestureOutputRanges
|-
|-
| 100 || [[#SetSupportedNpadStyleSet]]
| 100 || [[#SetSupportedNpadStyleSet]]
Line 133: Line 151:
|-
|-
| 136 || [8.0.0+] [[#ClearNpadCaptureButtonAssignment]]
| 136 || [8.0.0+] [[#ClearNpadCaptureButtonAssignment]]
|-
| 137 || [20.0.0+] SetNpadGcAnalogStick8bitRawValue
|-
| 138 || [S2]
|-
| 139 || [S2]
|-
|-
| 200 || [[#GetVibrationDeviceInfo]]
| 200 || [[#GetVibrationDeviceInfo]]
Line 157: Line 181:
|-
|-
| 211 || [7.0.0+] [[#IsVibrationDeviceMounted]]
| 211 || [7.0.0+] [[#IsVibrationDeviceMounted]]
|-
| 212 || [11.0.0+] [[#SendVibrationValueInBool]]
|-
| 213 || [17.0.0+] SendVibrationValueInMode
|-
| 214 || [17.0.0+] SendVibrationValuesInMode
|-
| 220 || [S2]
|-
|-
| 300 || [3.0.0+] [[#ActivateConsoleSixAxisSensor]]
| 300 || [3.0.0+] [[#ActivateConsoleSixAxisSensor]]
Line 179: Line 211:
|-
|-
| 310 || [6.0.0+] [[#ResetSevenSixAxisSensorTimestamp]]
| 310 || [6.0.0+] [[#ResetSevenSixAxisSensorTimestamp]]
|-
| 311 || [17.0.0+] ForceActivateConsoleSixAxisSensor
|-
| 312 || [17.0.0+] ForceDeactivateConsoleSixAxisSensor
|-
|-
| 400 || [3.0.0+] [[#IsUsbFullKeyControllerEnabled]]
| 400 || [3.0.0+] [[#IsUsbFullKeyControllerEnabled]]
Line 198: Line 234:
| 408 || [9.0.0-9.2.0] GetNpadOfHighestBatteryLevelForJoyRight
| 408 || [9.0.0-9.2.0] GetNpadOfHighestBatteryLevelForJoyRight
|-
|-
| 500 || [5.0.0+] GetPalmaConnectionHandle
| 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]]
|-
|-
| 501 || [5.0.0+] InitializePalma
| 519 || [5.1.0+] [[#GetPalmaOperationResult]]
|-
|-
| 502 || [5.0.0+] AcquirePalmaOperationCompleteEvent
| 520 || [5.1.0+] [[#ReadPalmaPlayLog]]
|-
|-
| 503 || [5.0.0+] GetPalmaOperationInfo
| 521 || [5.1.0+] [[#ResetPalmaPlayLog]]
|-
|-
| 504 || [5.0.0+] PlayPalmaActivity
| 522 || [5.1.0+] [[#SetIsPalmaAllConnectable]]
|-
|-
| 505 || [5.0.0+] SetPalmaFrModeType
| 523 || [5.1.0+] [[#SetIsPalmaPairedConnectable]]
|-
|-
| 506 || [5.0.0+] ReadPalmaStep
| 524 || [5.1.0+] [[#PairPalma]]
|-
|-
| 507 || [5.0.0+] EnablePalmaStep
| 525 || [5.1.0+] [[#SetPalmaBoostMode]]
|-
|-
| 508 || [5.0.0+] ResetPalmaStep
| 526 || [7.0.0+] [[#CancelWritePalmaWaveEntry]]
|-
|-
| 509 || [5.0.0+] ReadPalmaApplicationSection
| 527 || [8.0.0+] [[#EnablePalmaBoostMode]]
|-
|-
| 510 || [5.0.0+] WritePalmaApplicationSection
| 528 || [8.0.0+] [[#GetPalmaBluetoothAddress]]
|-
|-
| 511 || [5.0.0+] ReadPalmaUniqueCode
| 529 || [8.0.0+] [[#SetDisallowedPalmaConnection]]
|-
|-
| 512 || [5.0.0+] SetPalmaUniqueCodeInvalid
| 550 || [S2]
|-
|-
| 513 || [5.0.0+] WritePalmaActivityEntry
| 1000 || [[#SetNpadCommunicationMode]]
|-
|-
| 514 || [5.0.0+] WritePalmaRgbLedPatternEntry
| 1001 || [[#GetNpadCommunicationMode]]
|-
|-
| 515 || [5.0.0+] WritePalmaWaveEntry
| 1002 || [9.0.0+] [[#SetTouchScreenConfiguration]]
|-
|-
| 516 || [5.0.0+] SetPalmaDataBaseIdentificationVersion
| 1003 || [9.0.0+] [[#IsFirmwareUpdateNeededForNotification]]
|-
|-
| 517 || [5.0.0+] GetPalmaDataBaseIdentificationVersion
| 1004 || [20.0.0+] [[#SetTouchScreenOutputRanges|SetTouchScreenOutputRanges]] ([17.0.0-19.0.1] SetTouchScreenResolution)
|-
|-
| 518 || [5.0.0+] SuspendPalmaFeature
| 1005 || [20.0.0+] EnableNxTouchScreenEmulationForTouchEnter
|-
|-
| 519 || [5.1.0+] GetPalmaOperationResult
| 2000 || [10.0.0+] [[#ActivateDigitizer]]
|-
|-
| 520 || [5.1.0+] ReadPalmaPlayLog
| 3000 || [15.0.0+] GetDebugPadGenericPadMap
|-
|-
| 521 || [5.1.0+] ResetPalmaPlayLog
| 3001 || [15.0.0+] SetDebugPadGenericPadMap
|-
|-
| 522 || [5.1.0+] SetIsPalmaAllConnectable
| 3002 || [15.0.0+] ResetDebugPadGenericPadMap
|-
|-
| 523 || [5.1.0+] SetIsPalmaPairedConnectable
| 3003 || [15.0.0+] GetDebugPadKeyboardMap
|-
|-
| 524 || [5.1.0+] PairPalma
| 3004 || [15.0.0+] SetDebugPadKeyboardMap
|-
|-
| 525 || [5.1.0+] SetPalmaBoostMode
| 3005 || [15.0.0+] ResetDebugPadKeyboardMap
|-
|-
| 526 || [7.0.0+] CancelWritePalmaWaveEntry
| 3006 || [15.0.0+] GetFullKeyGenericPadMap
|-
|-
| 527 || [8.0.0+] EnablePalmaBoostMode
| 3007 || [15.0.0+] SetFullKeyGenericPadMap
|-
|-
| 528 || [8.0.0+] GetPalmaBluetoothAddress
| 3008 || [15.0.0+] ResetFullKeyGenericPadMap
|-
|-
| 529 || [8.0.0+] SetDisallowedPalmaConnection
| 3009 || [15.0.0+] GetFullKeyKeyboardMap
|-
|-
| 1000 || SetNpadCommunicationMode
| 3010 || [15.0.0+] SetFullKeyKeyboardMap
|-
|-
| 1001 || GetNpadCommunicationMode
| 3011 || [15.0.0+] ResetFullKeyKeyboardMap
|-
|-
| 1002 || [9.0.0+] SetTouchScreenConfiguration
| 3110 || [S2]
|-
|-
| 1003 || [9.0.0+] IsFirmwareUpdateNeededForNotification
| 3111 || [S2]
|-
|-
| 2000 || [10.0.0+] ActivateDigitizer
| 3112 || [S2]
|-
| 3113 || [S2]
|-
| 3130 || [S2]
|-
| 3131 || [S2]
|-
| 3132 || [S2]
|-
| 3133 || [S2]
|-
| 3135 || [S2]
|-
| 3136 || [S2]
|-
| 3137 || [S2]
|-
| 3138 || [S2]
|-
| 3139 || [S2]
|-
| 3140 || [S2]
|-
| 3141 || [S2]
|-
| 3142 || [S2]
|-
| 3143 || [S2]
|}
|}


Line 284: Line 384:
Takes a PID and an [[AM_services|AppletResourceUserId]], no output.
Takes a PID and an [[AM_services|AppletResourceUserId]], no output.


== StartSixAxisSensor ==
== SendKeyboardLockKeyEvent ==
Takes a PID, a [[#SixAxisSensorHandle]], and an [[AM_services|AppletResourceUserId]], no output.
Takes a PID, an u32 BitFlagSet [[#KeyboardLockKeyEvent]], and an [[AM_services|AppletResourceUserId]], no output.


== StopSixAxisSensor ==
This is identical to the hidsys cmd.
Takes a PID, a [[#SixAxisSensorHandle]], and an [[AM_services|AppletResourceUserId]], no output.


== IsSixAxisSensorFusionEnabled ==
== AcquireXpadIdEventHandle ==
Takes a PID, a [[#SixAxisSensorHandle]], and an [[AM_services|AppletResourceUserId]], returns an output bool.
Takes an input u64, returns an output handle.


== EnableSixAxisSensorFusion ==
[10.0.0+] Stubbed, just returns 0.
Takes a PID, a bool, a [[#SixAxisSensorHandle]], and an [[AM_services|AppletResourceUserId]], no output.
 
== ReleaseXpadIdEventHandle ==
Takes an input u64, no output.
 
[10.0.0+] Stubbed, just returns 0.
 
== ActivateXpad ==
Takes a PID, an u32 "nn::hid::BasicXpadId", an [[AM_services|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 [[AM_services|AppletResourceUserId]], no output.
 
== StopSixAxisSensor ==
Takes a PID, a [[#SixAxisSensorHandle]], and an [[AM_services|AppletResourceUserId]], no output.
 
== IsSixAxisSensorFusionEnabled ==
Takes a PID, a [[#SixAxisSensorHandle]], and an [[AM_services|AppletResourceUserId]], returns an output bool.
 
== EnableSixAxisSensorFusion ==
Takes a PID, a bool, a [[#SixAxisSensorHandle]], and an [[AM_services|AppletResourceUserId]], no output.


== SetSixAxisSensorFusionParameters ==
== SetSixAxisSensorFusionParameters ==
Line 357: Line 527:
== IsFirmwareUpdateAvailableForSixAxisSensor ==
== IsFirmwareUpdateAvailableForSixAxisSensor ==
Takes a PID, a [[#SixAxisSensorHandle]], and an [[AM_services|AppletResourceUserId]], returns an output bool.
Takes a PID, a [[#SixAxisSensorHandle]], and an [[AM_services|AppletResourceUserId]], returns an output bool.
== EnableSixAxisSensorUnalteredPassthrough ==
Takes a PID, a [[#SixAxisSensorHandle]], a bool, and an [[AM_services|AppletResourceUserId]], no output.
== IsSixAxisSensorUnalteredPassthroughEnabled ==
Takes a PID, a [[#SixAxisSensorHandle]], and an [[AM_services|AppletResourceUserId]], returns an output bool.
== StoreSixAxisSensorCalibrationParameter ==
Takes a PID, a [[#SixAxisSensorHandle]], a SixAxisSensorCalibrationParameter, and an [[AM_services|AppletResourceUserId]], no output.
== LoadSixAxisSensorCalibrationParameter ==
Takes a PID, a [[#SixAxisSensorHandle]], and an [[AM_services|AppletResourceUserId]], returns a SixAxisSensorCalibrationParameter.
== GetSixAxisSensorIcInformation ==
Takes a PID, a [[#SixAxisSensorHandle]], and an [[AM_services|AppletResourceUserId]], returns a SixAxisSensorIcInformation.
== ResetIsSixAxisSensorDeviceNewlyAssigned ==
Takes a PID, a [[#SixAxisSensorHandle]], and an [[AM_services|AppletResourceUserId]], no output.


== ActivateGesture ==
== ActivateGesture ==
Line 380: Line 568:


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


This just returns 0.
This just returns 0.
[10.0.0+] sdknso now uses the hiddbg [[#DeactivateNpad_2|cmd]] instead.


== AcquireNpadStyleSetUpdateEventHandle ==
== AcquireNpadStyleSetUpdateEventHandle ==
Line 403: Line 593:
* 0x2: [6.0.0+]
* 0x2: [6.0.0+]
* 0x3: [8.0.0+]
* 0x3: [8.0.0+]
* 0x5: [18.0.0+]


== SetNpadJoyHoldType ==
== SetNpadJoyHoldType ==
Line 413: Line 604:


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


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


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


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


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


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


== StartLrAssignmentMode ==
== StartLrAssignmentMode ==
Line 462: Line 653:
Takes a PID, a [[#NpadStyleSet]], an [[AM_services|AppletResourceUserId]], a [[#NpadButtonSet]], no output.
Takes a PID, a [[#NpadStyleSet]], an [[AM_services|AppletResourceUserId]], a [[#NpadButtonSet]], no output.


Only 1 bit can be set in the [[#NpadStyleSet]].
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 ==
== ClearNpadCaptureButtonAssignment ==
Takes a PID, an [[AM_services|AppletResourceUserId]], no output.
Takes a PID, an [[AM_services|AppletResourceUserId]], no output.
== Cmd138 ==
This is exclusive to S2.
Takes a PID, two input u64s, no output.
== Cmd139 ==
This is exclusive to S2.
Takes a PID, an u64, returns an output u64.


== GetVibrationDeviceInfo ==
== GetVibrationDeviceInfo ==
Line 510: Line 713:
== IsVibrationDeviceMounted ==
== IsVibrationDeviceMounted ==
Takes a PID, an [[#VibrationDeviceHandle]], and an u64 [[AM_services|AppletResourceUserId]], returns an output u8 bool.
Takes a PID, an [[#VibrationDeviceHandle]], and an u64 [[AM_services|AppletResourceUserId]], returns an output u8 bool.
== SendVibrationValueInBool ==
Takes a PID, a bool, a [[#VibrationDeviceHandle]], and an [[AM_services|AppletResourceUserId]], no output.
Stubbed, this just returns 0.
This is currently not exposed by sdknso.
== Cmd220 ==
This is exclusive to S2.
Takes a PID, an u32, an u64, returns an output u8.


== ActivateConsoleSixAxisSensor ==
== ActivateConsoleSixAxisSensor ==
Line 576: Line 791:
| 0x8 || 0x8 || Second timestamp (in samples).
| 0x8 || 0x8 || Second timestamp (in samples).
|-
|-
| 0x10 || 0x8 || ?
| 0x10 || 0x8 || ? (Increased every sleep cicle)
|-
| 0x18 || 0x4 || float AccelerationX
|-
|-
| 0x18 || 0x28 || float data
| 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
|}
|}


Line 627: Line 860:
Takes a PID, a type-0x9 input buffer containing an array of u32 [[#NpadIdType]], an u64 [[AM_services|AppletResourceUserId]], returns an output u32 [[#NpadIdType]].
Takes a PID, a type-0x9 input buffer containing an array of u32 [[#NpadIdType]], an u64 [[AM_services|AppletResourceUserId]], returns an output u32 [[#NpadIdType]].


== IAppletResource ==
[[#NpadIdType|Handheld]] is ignored.
{| class="wikitable" border="1"
 
|-
== GetPalmaConnectionHandle ==
! Cmd || Name
Takes a PID, an u32 [[#NpadIdType]], an [[AM_services|AppletResourceUserId]], returns an output [[#PalmaConnectionHandle]].
|-
 
| 0 || [[#GetSharedMemoryHandle]]
== 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 [[#AcquirePalmaOperationCompleteEvent|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.


=== GetSharedMemoryHandle ===
== EnablePalmaStep ==
No input. Returns a [[#SharedMemoryFormat|sharedmem]] handle.
Takes an input bool, a [[#PalmaConnectionHandle]], no output.


== IActiveVibrationDeviceList ==
See [[#GetPalmaOperationInfo]].
This is "nn::hid::IActiveVibrationDeviceList".


{| class="wikitable" border="1"
== ResetPalmaStep ==
|-
Takes an input [[#PalmaConnectionHandle]], no output.
! Cmd || Name
|-
| 0 || [[#ActivateVibrationDevice]]
|}


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


= hid:dbg =
== ReadPalmaApplicationSection ==
This is "nn::hid::IHidDebugServer".
Takes an input [[#PalmaConnectionHandle]], an u64, an u64 size, no output.


{| class="wikitable" border="1"
sdknso exposes the first u64 as a s32. sdknso will Abort if the input value for the second u64 is >0x100.
|-
 
! Cmd || Name
See [[#GetPalmaOperationInfo]].
|-
 
| 0 || DeactivateDebugPad
== WritePalmaApplicationSection ==
|-
Takes an input [[#PalmaConnectionHandle]], an u64, an u64 size, a type-0x19 input buffer containing a [[#PalmaApplicationSectionAccessBuffer]], no output.
| 1 || SetDebugPadAutoPilotState
 
|-
sdknso exposes the first u64 as a s32. Data is copied from the input [[#PalmaApplicationSectionAccessBuffer]] with the specified size.
| 2 || UnsetDebugPadAutoPilotState
 
|-
See [[#GetPalmaOperationInfo]].
| 10 || DeactivateTouchScreen
 
|-
== ReadPalmaUniqueCode ==
| 11 || SetTouchScreenAutoPilotState
Takes an input [[#PalmaConnectionHandle]], no output.
|-
 
| 12 || UnsetTouchScreenAutoPilotState
See [[#GetPalmaOperationInfo]].
|-
 
| 13 || [9.0.0+] GetTouchScreenConfiguration
== SetPalmaUniqueCodeInvalid ==
|-
Takes an input [[#PalmaConnectionHandle]], no output.
| 20 || DeactivateMouse
 
|-
See [[#GetPalmaOperationInfo]].
| 21 || SetMouseAutoPilotState
 
|-
== WritePalmaActivityEntry ==
| 22 || UnsetMouseAutoPilotState
Takes an input [[#PalmaConnectionHandle]], an u64, an u64, an u64, an u64, no output.
|-
 
| 30 || DeactivateKeyboard
sdknso exposes the first u64 as an u16, while the rest are exposed as [[#PalmaActivityEntry]].
|-
 
| 31 || SetKeyboardAutoPilotState
See [[#GetPalmaOperationInfo]].
|-
 
| 32 || UnsetKeyboardAutoPilotState
== WritePalmaRgbLedPatternEntry ==
|-
Takes an input [[#PalmaConnectionHandle]], an u64, a type-0x5 input buffer, no output.
| 50 || DeactivateXpad
 
|-
sdknso exposes the u64 as an u16.
| 51 || [1.0.0-9.2.0] SetXpadAutoPilotState
 
|-
See [[#GetPalmaOperationInfo]].
| 52 || [1.0.0-9.2.0] UnsetXpadAutoPilotState
 
|-
== WritePalmaWaveEntry ==
| 53 ([1.0.0-8.1.0] 60) || [1.0.0-9.2.0] [[#DeactivateJoyXpad]]
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.
|-
 
| 60 || [9.0.0+] ClearNpadSystemCommonPolicy
The TransferMemory is created from an user-specified buffer with permissions=R--.
|-
 
| 61 || [10.0.0+] DeactivateNpad
Note that the sysmodule will not properly close the TransferMemory handle if the [[#PalmaConnectionHandle]] is invalid.
|-
 
| 62 || [10.0.0+] ForceDisconnectNpad
See [[#GetPalmaOperationInfo]].
|-
 
| 91 || DeactivateGesture
== SetPalmaDataBaseIdentificationVersion ==
|-
Takes an input s32, a [[#PalmaConnectionHandle]], no output.
| 110 || DeactivateHomeButton
 
|-
See [[#GetPalmaOperationInfo]].
| 111 || SetHomeButtonAutoPilotState
 
|-
== GetPalmaDataBaseIdentificationVersion ==
| 112 || UnsetHomeButtonAutoPilotState
Takes an input [[#PalmaConnectionHandle]], no output.
|-
 
| 120 || DeactivateSleepButton
See [[#GetPalmaOperationInfo]].
|-
 
| 121 || SetSleepButtonAutoPilotState
== SuspendPalmaFeature ==
|-
Takes an input "nn::util::BitFlagSet<32, [[#PalmaFeature]]>", a [[#PalmaConnectionHandle]], no output.
| 122 || UnsetSleepButtonAutoPilotState
 
|-
See [[#GetPalmaOperationInfo]].
| 123 || [1.0.0-9.2.0] DeactivateInputDetector
 
|-
== GetPalmaOperationResult ==
| 130 || DeactivateCaptureButton
Takes an input [[#PalmaConnectionHandle]], no output.
|-
 
| 131 || SetCaptureButtonAutoPilotState
sdknso only uses this from the wrapper for [[#GetPalmaOperationInfo]].
|-
 
| 132 || UnsetCaptureButtonAutoPilotState
== ReadPalmaPlayLog ==
|-
Takes an input u16, a [[#PalmaConnectionHandle]], no output.
| 133 || [3.0.0+] SetShiftAccelerometerCalibrationValue
 
|-
See [[#GetPalmaOperationInfo]].
| 134 || [3.0.0+] GetShiftAccelerometerCalibrationValue
 
|-
== ResetPalmaPlayLog ==
| 135 || [3.0.0+] SetShiftGyroscopeCalibrationValue
Takes an input u16, a [[#PalmaConnectionHandle]], no output.
|-
 
| 136 || [3.0.0+] GetShiftGyroscopeCalibrationValue
See [[#GetPalmaOperationInfo]].
|-
 
| 140 || [3.0.0+] DeactivateConsoleSixAxisSensor
== SetIsPalmaAllConnectable ==
|-
Takes a PID, a bool, an [[AM_services|AppletResourceUserId]], no output.
| 141 || [5.0.0+] GetConsoleSixAxisSensorSamplingFrequency
 
|-
The sysmodule also calls the code which eventually runs from this, from various other funcs internally (bool value varies).
| 142 || [5.0.0+] DeactivateSevenSixAxisSensor
 
|-
This updates various state. If needed, this uses either [[BTM_services|StartBleScanForGeneral]] or [[BTM_services|StopBleScanForGeneral]].
| 143 || [5.0.0+] GetConsoleSixAxisSensorCountStates
 
|-
== SetIsPalmaPairedConnectable ==
| 144 || [8.0.0+] GetAccelerometerFsr
Takes a PID, a bool, an [[AM_services|AppletResourceUserId]], no output.
|-
 
| 145 || [8.0.0+] SetAccelerometerFsr
The actual cmd impl ignores the PID/AppletResourceUserId.
|-
 
| 146 || [8.0.0+] GetAccelerometerOdr
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]].
|-
 
| 147 || [8.0.0+] SetAccelerometerOdr
This updates various state. If needed, this uses either [[BTM_services|StartBleScanForPairedDevice]] or [[BTM_services|StopBleScanForPairedDevice]].
 
== PairPalma ==
Takes an input [[#PalmaConnectionHandle]], no output.
 
This eventually uses [[BTM_services#BlePairDevice|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 [[AM_services|AppletResourceUserId]], no output.
 
== GetPalmaBluetoothAddress ==
Takes an input [[#PalmaConnectionHandle]], returns an output [[Bluetooth_Driver_services#Address|Address]].
 
== SetDisallowedPalmaConnection ==
Takes a PID, an [[AM_services|AppletResourceUserId]], a type-0x9 input buffer containing an array of [[Bluetooth_Driver_services#Address|Address]], no output.
 
== Cmd550 ==
This is exclusive to S2.
 
Takes a PID, an u32, an u64, returns two output u8s.
 
== SetNpadCommunicationMode ==
Takes a PID, an [[AM_services|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 [[AM_services|AppletResourceUserId]], no output.
 
== IsFirmwareUpdateNeededForNotification ==
Takes a PID, a s32, an [[AM_services|AppletResourceUserId]], returns an output bool.
 
sdknso passes hard-coded value 1 for the s32.
 
== SetTouchScreenOutputRanges ==
Takes a PID, a s32 width, a s32 height, an [[AM_services|AppletResourceUserId]], no output.
 
This is used by user-processes prior to [[#ActivateTouchScreen|ActivateTouchScreen]], on newer versions.
 
User-processes can optionally specify input values for width/height during TouchScreen initiailization, with the default values being the relevant fixed width/height values for the platform which the user-process was built for.
 
== ActivateDigitizer ==
Takes a PID and an [[AM_services|AppletResourceUserId]]. No output.
 
== Cmd3110 ==
This is exclusive to S2.
 
Takes a PID, a handle, an u64, an u64, no output.
 
== Cmd3111 ==
This is exclusive to S2.
 
Takes a PID and an u64, no output.
 
== Cmd3112 ==
This is exclusive to S2.
 
Takes a PID, an u32, an u64, no output.
 
== Cmd3113 ==
This is exclusive to S2.
 
Takes a PID, an u32, an u64, no output.
 
== Cmd3130 ==
This is exclusive to S2.
 
Takes a PID, a handle, an u8, two u32s, two u64s, no output.
 
== Cmd3131 ==
This is exclusive to S2.
 
Takes a PID and an [[AM_services|AppletResourceUserId]], no output.
 
== Cmd3132 ==
This is exclusive to S2.
 
Takes a PID, an u32, an u32, an u64, no output.
 
== Cmd3133 ==
This is exclusive to S2.
 
Takes a PID, an u64, returns two output u32s.
 
== Cmd3135 ==
This is exclusive to S2.
 
Takes a PID, a bool, an [[AM_services|AppletResourceUserId]], no output.
 
== Cmd3136 ==
This is exclusive to S2.
 
Takes a PID, an u64, an u64, no output.
 
== Cmd3137 ==
This is exclusive to S2.
 
Takes a PID, an u64, an u64, no output.
 
== Cmd3138 ==
This is exclusive to S2.
 
Takes a PID, an u32, an [[AM_services|AppletResourceUserId]], no output.
 
Official sw masks the u32 with bitmask 0x6.
 
== Cmd3139 ==
This is exclusive to S2.
 
Takes a PID, a TransferMemory handle, an u8, an u32 width, an u32 height, an u32, an [[AM_services|AppletResourceUserId]], an u64 tmem_size, no output.
 
The input TransferMemory is created with permissions = R--. The user-process later reads from the buffer used with this.
 
Official sw always (?) passes value 1 for the last u32.
 
This and the related nearby cmds are likely (?) for Joy-Con 2 Mouse Mode.
 
== Cmd3140 ==
This is exclusive to S2.
 
Takes a PID, two u32s, two u64s, no output.
 
== Cmd3141 ==
This is exclusive to S2.
 
Takes a PID, a bool, an [[AM_services|AppletResourceUserId]], an u64, no output.
 
== Cmd3142 ==
This is exclusive to S2.
 
Takes a PID, 4 floats, an [[AM_services|AppletResourceUserId]], no output.
 
== Cmd3143 ==
This is exclusive to S2.
 
Takes a PID, two u64s, no output.
 
== IAppletResource ==
This is "nn::hid::IAppletResource".
 
{| class="wikitable" border="1"
|-
|-
| 148 || [8.0.0+] GetGyroscopeFsr
! Cmd || Name
|-
|-
| 149 || [8.0.0+] SetGyroscopeFsr
| 0 || [[#GetSharedMemoryHandle]]
|-
|}
| 150 || [8.0.0+] GetGyroscopeOdr
 
=== GetSharedMemoryHandle ===
No input. Returns a [[#SharedMemoryFormat|sharedmem]] handle.
 
== IActiveVibrationDeviceList ==
This is "nn::hid::IActiveVibrationDeviceList".
 
{| class="wikitable" border="1"
|-
|-
| 151 || [8.0.0+] SetGyroscopeOdr
! Cmd || Name
|-
|-
| 152 || [10.0.0+] GetWhoAmI
| 0 || [[#ActivateVibrationDevice]]
|}
 
=== ActivateVibrationDevice ===
Takes an input [[#VibrationDeviceHandle]]. No output.
 
= hid:dbg =
This is "nn::hid::IHidDebugServer".
 
{| class="wikitable" border="1"
|-
|-
| 201 || ActivateFirmwareUpdate
! Cmd || Name
|-
|-
| 202 || DeactivateFirmwareUpdate
| 0 || [[#DeactivateDebugPad]]
|-
|-
| 203 || [[#StartFirmwareUpdate]]
| 1 || [[#SetDebugPadAutoPilotState]]
|-
|-
| 204 || GetFirmwareUpdateStage
| 2 || [[#UnsetDebugPadAutoPilotState]]
|-
|-
| 205 || [[#GetFirmwareVersion]]
| 10 || [[#DeactivateTouchScreen]]
|-
|-
| 206 || [[#GetDestinationFirmwareVersion]]
| 11 || [[#SetTouchScreenAutoPilotState]]
|-
|-
| 207 || [[#DiscardFirmwareInfoCacheForRevert]]
| 12 || [[#UnsetTouchScreenAutoPilotState]]
|-
|-
| 208 || [3.0.0+] StartFirmwareUpdateForRevert
| 13 || [9.0.0+] GetTouchScreenConfiguration
|-
|-
| 209 || [3.0.0+] GetAvailableFirmwareVersionForRevert
| 14 || [11.0.0+] ProcessTouchScreenAutoTune
|-
|-
| 210 || [4.0.0+] IsFirmwareUpdatingDevice
| 15 || [13.0.0+] ForceStopTouchScreenManagement
|-
|-
| 211 || [6.0.0+] StartFirmwareUpdateIndividual
| 16 || [13.0.0+] ForceRestartTouchScreenManagement
|-
|-
| 215 || [6.0.0+] SetUsbFirmwareForceUpdateEnabled
| 17 || [13.0.0+] IsTouchScreenManaged
|-
|-
| 216 || [6.0.0+] SetAllKuinaDevicesToFirmwareUpdateMode
| 18 || [18.0.0+] SetTouchScreenAutoPilotStateWithAruid
|-
|-
| 221 || [3.0.0+] [[#UpdateControllerColor]]
| 20 || [[#DeactivateMouse]]
|-
|-
| 222 || [4.0.0+] ConnectUsbPadsAsync
| 21 || [[#SetMouseAutoPilotState]]
|-
|-
| 223 || [4.0.0+] DisconnectUsbPadsAsync
| 22 || [[#UnsetMouseAutoPilotState]]
|-
|-
| 224 || [5.0.0+] [[#UpdateDesignInfo]]
| 25 || [16.0.0+] SetDebugMouseAutoPilotState
|-
|-
| 225 || [5.0.0+] [[#GetUniquePadDriverState]]
| 26 || [16.0.0+] UnsetDebugMouseAutoPilotState
|-
|-
| 226 || [5.0.0+] [[#GetSixAxisSensorDriverStates]]
| 30 || [[#DeactivateKeyboard]]
|-
|-
| 227 || [5.0.0+] GetRxPacketHistory
| 31 || [[#SetKeyboardAutoPilotState]]
|-
|-
| 228 || [6.0.0+] [[#AcquireOperationEventHandle]]
| 32 || [[#UnsetKeyboardAutoPilotState]]
|-
|-
| 229 || [6.0.0+] [[#ReadSerialFlash]]
| 50 || [[#DeactivateXpad]]
|-
|-
| 230 || [6.0.0+] [[#WriteSerialFlash]]
| 51 || [1.0.0-9.2.0] SetXpadAutoPilotState
|-
|-
| 231 || [6.0.0+] [[#GetOperationResult]]
| 52 || [1.0.0-9.2.0] UnsetXpadAutoPilotState
|-
|-
| 232 || [6.0.0+] EnableShipmentMode
| 53 ([1.0.0-8.1.0] 60) || [1.0.0-9.2.0] [[#DeactivateJoyXpad]]
|-
|-
| 233 || [6.0.0+] ClearPairingInfo
| 60 || [9.0.0+] ClearNpadSystemCommonPolicy
|-
|-
| 234 || [6.0.0+] [[#GetUniquePadDeviceTypeSetInternal]]
| 61 || [10.0.0+] [[#DeactivateNpad_2|DeactivateNpad]]
|-
|-
| 235 || [7.0.0+] EnableAnalogStickPower
| 62 || [10.0.0+] ForceDisconnectNpad
|-
|-
| 236 || [9.0.0+] RequestKuinaUartClockCal
| 91 || DeactivateGesture
|-
|-
| 237 || [9.0.0+] GetKuinaUartClockCal
| 110 || DeactivateHomeButton
|-
|-
| 238 || [9.0.0+] SetKuinaUartClockTrim
| 111 || SetHomeButtonAutoPilotState
|-
|-
| 239 || [9.0.0+] KuinaLoopbackTest
| 112 || UnsetHomeButtonAutoPilotState
|-
|-
| 240 || [9.0.0+] RequestBatteryVoltage
| 120 || [[#DeactivateSleepButton]]
|-
|-
| 241 || [9.0.0+] GetBatteryVoltage
| 121 || [[#SetSleepButtonAutoPilotState]]
|-
|-
| 242 || [9.0.0+] GetUniquePadPowerInfo
| 122 || [[#UnsetSleepButtonAutoPilotState]]
|-
|-
| 243 || [9.0.0+] RebootUniquePad
| 123 || [1.0.0-9.2.0] DeactivateInputDetector
|-
|-
| 244 || [9.0.0+] RequestKuinaFirmwareVersion
| 130 || DeactivateCaptureButton
|-
|-
| 245 || [9.0.0+] GetKuinaFirmwareVersion
| 131 || SetCaptureButtonAutoPilotState
|-
|-
| 246 || [9.0.0+] GetVidPid
| 132 || UnsetCaptureButtonAutoPilotState
|-
|-
| 301 || [5.0.0-8.1.0] [[#GetAbstractedPadHandles]]
| 133 || [3.0.0+] SetShiftAccelerometerCalibrationValue
|-
|-
| 302 || [5.0.0-8.1.0] [[#GetAbstractedPadState]]
| 134 || [3.0.0+] GetShiftAccelerometerCalibrationValue
|-
|-
| 303 || [5.0.0-8.1.0] [[#GetAbstractedPadsState]]
| 135 || [3.0.0+] SetShiftGyroscopeCalibrationValue
|-
|-
| 321 || [5.0.0-8.1.0] [[#SetAutoPilotVirtualPadState]]
| 136 || [3.0.0+] GetShiftGyroscopeCalibrationValue
|-
|-
| 322 || [5.0.0-8.1.0] [[#UnsetAutoPilotVirtualPadState]]
| 137 || [15.0.0+] SetSixAxisSensorMode
|-
|-
| 323 || [5.0.0+] [[#UnsetAllAutoPilotVirtualPadState]]
| 140 || [3.0.0+] DeactivateConsoleSixAxisSensor
|-
|-
| 324 || [7.0.0+] [[#AttachHdlsWorkBuffer]]
| 141 || [5.0.0+] GetConsoleSixAxisSensorSamplingFrequency
|-
|-
| 325 || [7.0.0+] [[#ReleaseHdlsWorkBuffer]]
| 142 || [5.0.0+] DeactivateSevenSixAxisSensor
|-
|-
| 326 || [7.0.0+] [[#DumpHdlsNpadAssignmentState]]
| 143 || [5.0.0+] GetConsoleSixAxisSensorCountStates
|-
|-
| 327 || [7.0.0+] [[#DumpHdlsStates]]
| 144 || [8.0.0+] GetAccelerometerFsr
|-
|-
| 328 || [7.0.0+] [[#ApplyHdlsNpadAssignmentState]]
| 145 || [8.0.0+] SetAccelerometerFsr
|-
|-
| 329 || [7.0.0+] [[#ApplyHdlsStateList]]
| 146 || [8.0.0+] GetAccelerometerOdr
|-
|-
| 330 || [7.0.0+] [[#AttachHdlsVirtualDevice]]
| 147 || [8.0.0+] SetAccelerometerOdr
|-
|-
| 331 || [7.0.0+] [[#DetachHdlsVirtualDevice]]
| 148 || [8.0.0+] GetGyroscopeFsr
|-
|-
| 332 || [7.0.0+] [[#SetHdlsState]]
| 149 || [8.0.0+] SetGyroscopeFsr
|-
|-
| 350 || [5.0.0+] AddRegisteredDevice
| 150 || [8.0.0+] GetGyroscopeOdr
|-
|-
| 400 || [6.0.0+] DisableExternalMcuOnNxDevice
| 151 || [8.0.0+] SetGyroscopeOdr
|-
|-
| 401 || [6.0.0+] DisableRailDeviceFiltering
| 152 || [10.0.0+] GetWhoAmI
|-
|-
| 402 || [10.0.0+] EnableWiredPairing
| 160 || [S2]
|-
|-
| 403 || [10.0.0+] EnableShipmentModeAutoClear
| 161 || [S2]
|-
|-
| 500 || [8.0.0+] SetFactoryInt
| 162 || [S2]
|-
|-
| 501 || [8.0.0+] IsFactoryBootEnabled
| 170 || [S2]
|-
|-
| 550 || [9.0.0+] SetAnalogStickModelDataTemporarily
| 171 || [S2]
|-
|-
| 551 || [9.0.0+] GetAnalogStickModelData
| 172 || [S2]
|-
|-
| 552 || [9.0.0+] ResetAnalogStickModelData
| 201 || ActivateFirmwareUpdate
|-
|-
| 600 || [10.0.0+] ConvertPadState
| 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
|-
| 213 || [20.0.0+] GetFirmwareVersionStringForDevMenu
|-
| 214 || [20.1.0+] GetDestinationFirmwareVersionStringForDevMenu
|-
| 215 || [6.0.0+] SetUsbFirmwareForceUpdateEnabled
|-
| 216 || [6.0.0+] SetAllKuinaDevicesToFirmwareUpdateMode
|-
| 217 || [17.0.0+] StartFirmwareUpdateFromImageSet
|-
|-
| 2000 || [10.0.0+] DeactivateDigitizer
| 221 || [3.0.0+] [[#UpdateControllerColor]]
|-
|-
| 2001 || [10.0.0+] SetDigitizerAutoPilotState
| 222 || [4.0.0+] ConnectUsbPadsAsync
|-
|-
| 2002 || [10.0.0+] UnsetDigitizerAutoPilotState
| 223 || [4.0.0+] DisconnectUsbPadsAsync
|}
|-
 
| 224 || [5.0.0+] [[#UpdateDesignInfo]]
== StartFirmwareUpdate ==
|-
Takes a total of 0x20-bytes of input, 2 handles, and returns an output handle.
| 225 || [5.0.0+] [[#GetUniquePadDriverState]]
 
|-
[3.0.0+] Now takes a total of 8-bytes of input, and no longer uses any input/output handles.
| 226 || [5.0.0+] [[#GetSixAxisSensorDriverStates]]
 
|-
== GetFirmwareVersion ==
| 227 || [5.0.0+] GetRxPacketHistory
Takes a total of 8-bytes of input, and returns a total of 4-bytes of output.
|-
 
| 228 || [6.0.0+] [[#AcquireOperationEventHandle]]
[3.0.0+] Now returns an additional 0xC-bytes of output.
|-
 
| 229 || [6.0.0+] [[#ReadSerialFlash]]
== GetDestinationFirmwareVersion ==
|-
Takes a total of 8-bytes of input, and returns a total of 4-bytes of output.
| 230 || [6.0.0+] [[#WriteSerialFlash]]
 
|-
[3.0.0+] Now returns an additional 0xC-bytes of output.
| 231 || [6.0.0+] [[#GetOperationResult]]
 
|-
== DiscardFirmwareInfoCacheForRevert ==
| 232 || [6.0.0+] EnableShipmentMode
Takes a total of 8-bytes of input, and returns a total of 5-bytes of output.
|-
 
| 233 || [6.0.0+] ClearPairingInfo
[3.0.0+] No input/output.
|-
 
| 234 || [6.0.0+] [[#GetUniquePadDeviceTypeSetInternal]]
== UpdateControllerColor ==
|-
Takes two input u32s for the colors, an [[#UniquePadId]], and no output.
| 235 || [7.0.0+] EnableAnalogStickPower
 
|-
A state flag must be clear, otherwise an error is thrown. Afterwards, this flag is set.
| 236 || [9.0.0+] RequestKuinaUartClockCal
 
|-
Sends the spi-write subcommand to the specified controller, for writing the [[Joy-Con#Colors|color data]]. This writes to offset 0x6050 size 0x6, where the first 3-bytes are from the first u32 and the remaining 3-bytes are from the second u32.
| 237 || [9.0.0+] GetKuinaUartClockCal
 
|-
== UpdateDesignInfo ==
| 238 || [9.0.0+] SetKuinaUartClockTrim
Takes 4 input u32s for the colors, an input u8, an input [[#UniquePadId]], and no output.
|-
 
| 239 || [9.0.0+] KuinaLoopbackTest
A state flag must be clear (same as [[#UpdateControllerColor]]), otherwise an error is thrown. Afterwards, this flag is set.
|-
 
| 240 || [9.0.0+] RequestBatteryVoltage
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.
|-
 
| 241 || [9.0.0+] GetBatteryVoltage
== GetUniquePadDriverState ==
|-
Takes a total of 8-bytes of input, returns a total of 0x20-bytes of output.
| 242 || [9.0.0+] GetUniquePadPowerInfo
 
|-
[9.0.0+] Now takes a total of 8-bytes of input, returns a total of 0x18-bytes of output.
| 243 || [9.0.0+] RebootUniquePad
 
|-
== GetSixAxisSensorDriverStates ==
| 244 || [9.0.0+] RequestKuinaFirmwareVersion
Takes a total of 8-bytes of input and a type-0xA output buffer, returns a total of 8-bytes of output.
|-
 
| 245 || [9.0.0+] GetKuinaFirmwareVersion
[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.
|-
 
| 246 || [9.0.0+] GetVidPid
== AcquireOperationEventHandle ==
|-
Takes an input [[#UniquePadId]], returns an output Event handle. The EventClearMode used by official sw is user-specified.
| 247 || [11.0.0+] GetAnalogStickCalibrationValue
 
|-
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).
| 248 || [11.0.0+] GetUniquePadIdsFull
 
|-
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.
| 249 || [11.0.0+] ConnectUniquePad
 
|-
== ReadSerialFlash ==
| 250 || [12.0.0+] IsVirtual
Takes an input TransferMemory handle, an input u32 offset, an input u64 size, and an [[#UniquePadId]], no output.
|-
 
| 251 || [12.0.0+] GetAnalogStickModuleParam
Reads from the specified controller's spi-flash. The input size is the original size without page-alignment. The TransferMemory permissions is RW-.
|-
 
| 252 || [S2]
See also [[#AcquireOperationEventHandle]].
|-
 
| 253 || [19.0.0+] ClearStorageForShipment
With the sdk-nso for [9.0.0+] the wrapper funcs for this was removed (sdk-nso still has the actual cmd).
|-
 
| 254 || [S2]
== WriteSerialFlash ==
|-
Takes an input TransferMemory handle, an input u32 offset, an input u64 tmem_size, an input u64 size, and an [[#UniquePadId]], no output.
| 255 || [S2]
 
|-
Writes to the specified controller's spi-flash. The TransferMemory permissions is R--.
| 256 || [S2]
 
|-
See also [[#AcquireOperationEventHandle]].
| 301 || [5.0.0-8.1.0] [[#GetAbstractedPadHandles]]
 
|-
With the sdk-nso for [9.0.0+] the wrapper funcs for this was removed (sdk-nso still has the actual cmd).
| 302 || [5.0.0-8.1.0] [[#GetAbstractedPadState]]
 
|-
== GetOperationResult ==
| 303 || [5.0.0-8.1.0] [[#GetAbstractedPadsState]]
Takes an input [[#UniquePadId]], no output.
|-
 
| 321 || [5.0.0-8.1.0] [[#SetAutoPilotVirtualPadState]]
Get the Result for the Operation and handles cleanup, for the specified controller.
|-
 
| 322 || [5.0.0-8.1.0] [[#UnsetAutoPilotVirtualPadState]]
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).
|-
 
| 323 || [5.0.0+] [[#UnsetAllAutoPilotVirtualPadState]]
== GetUniquePadDeviceTypeSetInternal ==
|-
Takes an input [[#UniquePadId]], returns an [[#DeviceTypeInternal]].
| 324 || [7.0.0+] [[#AttachHdlsWorkBuffer]]
 
|-
== GetAbstractedPadHandles ==
| 325 || [7.0.0+] [[#ReleaseHdlsWorkBuffer]]
Takes a type-0xA output buffer containing an array of u64 '''AbstractedPadHandle''' and returns an output s32 for total entries.
|-
 
| 326 || [7.0.0+] [[#DumpHdlsNpadAssignmentState]]
Returns a handle for each controller detected by the system.
|-
 
| 327 || [7.0.0+] [[#DumpHdlsStates]]
== GetAbstractedPadState ==
|-
Takes an input u64 '''AbstractedPadHandle''', returns an output [[#AbstractedPadState]].
| 328 || [7.0.0+] [[#ApplyHdlsNpadAssignmentState]]
 
|-
== GetAbstractedPadsState ==
| 329 || [7.0.0+] [[#ApplyHdlsStateList]]
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.
|-
 
| 330 || [7.0.0+] [[#AttachHdlsVirtualDevice]]
== SetAutoPilotVirtualPadState ==
|-
Takes an input s8 '''AbstractedVirtualPadId''' and an input [[#AbstractedPadState]], no output.
| 331 || [7.0.0+] [[#DetachHdlsVirtualDevice]]
 
|-
== UnsetAutoPilotVirtualPadState ==
| 332 || [7.0.0+] [[#SetHdlsState]]
Takes an input s8 '''AbstractedVirtualPadId''', no output.
|-
 
| 350 || [5.0.0+] [[#AddRegisteredDevice]]
Clears AutoPilot state for the specified pad.
 
== UnsetAllAutoPilotVirtualPadState ==
No input/output.
 
Same as [[#UnsetAutoPilotVirtualPadState]] except this clears state for every pad.
 
== AttachHdlsWorkBuffer ==
Takes an input TransferMemory handle and an u64 for the TransferMemory size, no output.
 
Official user-processes use TransferMemory size=0x1000 and permissions=RW.
 
This TransferMemory is used as input/output by the other Hdls commands.
 
Hdls is for virtual HID controllers.
 
== ReleaseHdlsWorkBuffer ==
No input/output.
 
== DumpHdlsNpadAssignmentState ==
No input/output.
 
After using this cmd, the output [[#HdlsNpadAssignment]] is located at tmem+0.
 
== DumpHdlsStates ==
No input/output.
 
After using this cmd, the output [[#HdlsStateList]] struct is located at tmem+0.
 
== ApplyHdlsNpadAssignmentState ==
Takes an input u8 bool, no output.
 
Prior to using this cmd, the input [[#HdlsNpadAssignment]] is written to tmem+0 by the user-process.
 
== ApplyHdlsStateList ==
No input/output.
 
Prior to using this cmd, the input [[#HdlsStateList]] is written to tmem+0 by the user-process.
 
The [[#HdlsState]] will be applied for each [[#HdlsHandle]]. If a [[#HdlsHandle]] is not found, code similar to [[#AttachHdlsVirtualDevice]] will run with the [[#HdlsDeviceInfo]], then it will continue with applying state with the new device.
 
== AttachHdlsVirtualDevice ==
Takes an [[#HdlsDeviceInfo]], returns a [[#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.
 
= hid:sys =
This is "nn::hid::IHidSystemServer".
 
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
| 351 || [17.0.0-18.1.0] GetRegisteredDevicesCountDebug
|-
|-
| 31 || SendKeyboardLockKeyEvent
| 352 || [17.0.0-18.1.0] DeleteRegisteredDevicesDebug
|-
|-
| 101 || AcquireHomeButtonEventHandle
| 400 || [6.0.0+] DisableExternalMcuOnNxDevice
|-
|-
| 111 || ActivateHomeButton
| 401 || [6.0.0+] DisableRailDeviceFiltering
|-
|-
| 121 || AcquireSleepButtonEventHandle
| 402 || [10.0.0+] EnableWiredPairing
|-
|-
| 131 || ActivateSleepButton
| 403 || [10.0.0+] EnableShipmentModeAutoClear
|-
|-
| 141 || AcquireCaptureButtonEventHandle
| 404 || [11.0.0+] SetRailEnabled
|-
|-
| 151 || ActivateCaptureButton
| 500 || [8.0.0+] SetFactoryInt
|-
|-
| 161 || [7.0.0+] GetPlatformConfig
| 501 || [8.0.0+] IsFactoryBootEnabled
|-
|-
| 210 || AcquireNfcDeviceUpdateEventHandle
| 550 || [9.0.0+] SetAnalogStickModelDataTemporarily
|-
|-
| 211 || GetNpadsWithNfc
| 551 || [9.0.0+] GetAnalogStickModelData
|-
|-
| 212 || AcquireNfcActivateEventHandle
| 552 || [9.0.0+] ResetAnalogStickModelData
|-
|-
| 213 || ActivateNfc
| 600 || [10.0.0+] ConvertPadState
|-
|-
| 214 || [4.0.0+] GetXcdHandleForNpadWithNfc
| 601 || [18.0.0+] [[#IsButtonConfigSupported]]
|-
|-
| 215 || [4.0.0+] IsNfcActivated
| 602 || [18.0.0+] [[#IsButtonConfigEmbeddedSupported]]
|-
|-
| 230 || AcquireIrSensorEventHandle
| 603 || [18.0.0+] [[#DeleteButtonConfig]]
|-
|-
| 231 || ActivateIrSensor
| 604 || [18.0.0+] [[#DeleteButtonConfigEmbedded]]
|-
|-
| 232 || [10.0.0+] GetIrSensorState
| 605 || [18.0.0+] [[#SetButtonConfigEnabled]]
|-
|-
| 233 || [10.0.0+] GetXcdHandleForNpadWithIrSensor
| 606 || [18.0.0+] [[#SetButtonConfigEmbeddedEnabled]]
|-
|-
| 301 || ActivateNpadSystem
| 607 || [18.0.0+] [[#IsButtonConfigEnabled]]
|-
|-
| 303 || ApplyNpadSystemCommonPolicy
| 608 || [18.0.0+] [[#IsButtonConfigEmbeddedEnabled]]
|-
|-
| 304 || EnableAssigningSingleOnSlSrPress
| 609 || [18.0.0+] [[#SetButtonConfigEmbedded]]
|-
|-
| 305 || DisableAssigningSingleOnSlSrPress
| 610 || [18.0.0+] [[#SetButtonConfigFull]]
|-
|-
| 306 || GetLastActiveNpad
| 611 || [18.0.0+] [[#SetButtonConfigLeft]]
|-
|-
| 307 || GetNpadSystemExtStyle
| 612 || [18.0.0+] [[#SetButtonConfigRight]]
|-
|-
| 308 || [5.0.0+] ApplyNpadSystemCommonPolicyFull
| 613 || [18.0.0+] [[#GetButtonConfigEmbedded]]
|-
|-
| 309 || [5.0.0+] GetNpadFullKeyGripColor
| 614 || [18.0.0+] [[#GetButtonConfigFull]]
|-
|-
| 310 || [6.0.0+] [[#GetMaskedSupportedNpadStyleSet]]
| 615 || [18.0.0+] [[#GetButtonConfigLeft]]
|-
|-
| 311 || SetNpadPlayerLedBlinkingDevice
| 616 || [18.0.0+] [[#GetButtonConfigRight]]
|-
|-
| 312 || [6.0.0+] SetSupportedNpadStyleSetAll
| 617 || [S2]
|-
|-
| 313 || [9.0.0+] GetNpadCaptureButtonAssignment
| 618 || [S2]
|-
|-
| 314 || [9.0.0+] GetAppletFooterUiType
| 619 || [S2]
|-
|-
| 315 || [9.0.0+] GetAppletDetailedUiType
| 620 || [S2]
|-
|-
| 316 || [10.0.0+] [[#GetNpadInterfaceType]]
| 621 || [S2]
|-
|-
| 317 || [10.0.0+] [[#GetNpadLeftRightInterfaceType]]
| 622 || [S2]
|-
|-
| 318 || [10.0.0+] [[#HasBattery]]
| 650 || [12.0.0+] AddButtonPlayData
|-
|-
| 319 || [10.0.0+] [[#HasLeftRightBattery]]
| 651 || [12.0.0+] StartButtonPlayData
|-
|-
| 321 || [3.0.0+] [[#GetUniquePadsFromNpad]]
| 652 || [12.0.0+] StopButtonPlayData
|-
|-
| 322 || [10.0.0+] SetNpadSystemExtStateEnabled ([1.0.0-9.2.0] GetIrSensorState)
| 2000 || [10.0.0+] [[#DeactivateDigitizer]]
|-
|-
| 323 || [10.0.0+] GetLastActiveUniquePad ([1.0.0-9.2.0] GetXcdHandleForNpadWithIrSensor)
| 2001 || [10.0.0+] [[#SetDigitizerAutoPilotState]]
|-
|-
| 324 || [10.0.0+] GetUniquePadButtonSet
| 2002 || [10.0.0+] [[#UnsetDigitizerAutoPilotState]]
|-
|-
| 325 || [10.0.0+] GetUniquePadColor
| 3000 || [16.0.0+] ReloadFirmwareDebugSettings
|-
|}
| 326 || [10.0.0+] GetUniquePadAppletDetailedUiType
 
|-
== DeactivateDebugPad ==
| 500 || SetAppletResourceUserId
No input/output.
|-
 
| 501 || RegisterAppletResourceUserId
== SetDebugPadAutoPilotState ==
|-
Takes an input [[#DebugPadAutoPilotState]], no output.
| 502 || UnregisterAppletResourceUserId
 
|-
== UnsetDebugPadAutoPilotState ==
| 503 || EnableAppletToGetInput
No input/output.
|-
 
| 504 || SetAruidValidForVibration
== DeactivateTouchScreen ==
|-
No input/output.
| 505 || EnableAppletToGetSixAxisSensor
 
|-
== SetTouchScreenAutoPilotState ==
| 510 || [[#SetVibrationMasterVolume]]
Takes a type-0x5 input buffer containing an array of [[#TouchState]], no output.
|-
 
| 511 || GetVibrationMasterVolume
The max entries for the array is 16.
|-
 
| 512 || [3.0.0+] BeginPermitVibrationSession
== UnsetTouchScreenAutoPilotState ==
|-
No input/output.
| 513 || [3.0.0+] EndPermitVibrationSession
 
|-
== DeactivateMouse ==
| 520 || EnableHandheldHids
No input/output.
|-
 
| 521 || DisableHandheldHids
== SetMouseAutoPilotState ==
|-
Takes an input [[#MouseAutoPilotState]], no output.
| 522 || [9.0.0+] SetJoyConRailEnabled
 
|-
== UnsetMouseAutoPilotState ==
| 523 || [9.0.0+] IsJoyConRailEnabled
No input/output.
|-
 
| 524 || [10.0.0+] IsHandheldHidsEnabled
== DeactivateKeyboard ==
|-
No input/output.
| 540 || AcquirePlayReportControllerUsageUpdateEvent
 
|-
== SetKeyboardAutoPilotState ==
| 541 || GetPlayReportControllerUsages
Takes an input [[#KeyboardAutoPilotState]], no output.
|-
 
| 542 || AcquirePlayReportRegisteredDeviceUpdateEvent
== UnsetKeyboardAutoPilotState ==
|-
No input/output.
| 543 || GetRegisteredDevicesOld ([1.0.0-4.1.0] GetRegisteredDevices)
 
|-
== DeactivateXpad ==
| 544 || [3.0.0+] AcquireConnectionTriggerTimeoutEvent
Takes an input "nn::hid::BasicXpadId", no output.
|-
 
| 545 || [3.0.0+] SendConnectionTrigger
== DeactivateNpad ==
|-
Takes a PID and an [[AM_services|AppletResourceUserId]], no output.
| 546 || [3.0.0+] AcquireDeviceRegisteredEventForControllerSupport
 
|-
This just returns 0.
| 547 || [3.0.0+] GetAllowedBluetoothLinksCount
 
|-
== DeactivateSleepButton ==
| 548 || [5.0.0+] GetRegisteredDevices
No input/output.
|-
 
| 549 || [6.0.0+] GetConnectableRegisteredDevices
== SetSleepButtonAutoPilotState ==
|-
Takes an input [[#SleepButtonAutoPilotState]], no output.
| 700 || ActivateUniquePad
 
|-
== UnsetSleepButtonAutoPilotState ==
| 702 || AcquireUniquePadConnectionEventHandle
No input/output.
|-
 
| 703 || [[#GetUniquePadIds]]
== StartFirmwareUpdate ==
|-
Takes a total of 0x20-bytes of input, 2 handles, and returns an output handle.
| 751 || AcquireJoyDetachOnBluetoothOffEventHandle
 
|-
[3.0.0+] Now takes a total of 8-bytes of input, and no longer uses any input/output handles.
| 800 || ListSixAxisSensorHandles
 
|-
== GetFirmwareVersion ==
| 801 || IsSixAxisSensorUserCalibrationSupported
Takes an input [[#NpadIdType]] and an input [[#DeviceType]]. Returns an output [[#FirmwareVersion]].
|-
 
| 802 || ResetSixAxisSensorCalibrationValues
== GetDestinationFirmwareVersion ==
|-
Takes an input [[#NpadIdType]] and an input [[#DeviceType]]. Returns an output [[#FirmwareVersion]].
| 803 || StartSixAxisSensorUserCalibration
 
|-
== DiscardFirmwareInfoCacheForRevert ==
| 804 || CancelSixAxisSensorUserCalibration
Takes an input [[#NpadIdType]] and an input [[#DeviceType]]. Returns a total of 5-bytes of output.
|-
 
| 805 || [3.0.0+] GetUniquePadBluetoothAddress
[3.0.0+] No input/output.
|-
 
| 806 || [3.0.0+] DisconnectUniquePad
== UpdateControllerColor ==
|-
Takes two input u32s for the colors, an [[#UniquePadId]], and no output.
| 807 || [5.0.0+] [[#GetUniquePadType]]
 
|-
A state flag must be clear, otherwise an error is thrown. Afterwards, this flag is set.
| 808 || [5.0.0+] GetUniquePadInterface
 
|-
Sends the spi-write subcommand to the specified controller, for writing the [[Joy-Con#Colors|color data]]. This writes to offset 0x6050 size 0x6, where the first 3-bytes are from the first u32 and the remaining 3-bytes are from the second u32.
| 809 || [5.0.0+] [[#GetUniquePadSerialNumber]]
 
|-
== UpdateDesignInfo ==
| 810 || [5.0.0+] GetUniquePadControllerNumber
Takes 4 input u32s for the colors, an input u8, an input [[#UniquePadId]], and no output.
|-
 
| 811 || [5.0.0+] GetSixAxisSensorUserCalibrationStage
A state flag must be clear (same as [[#UpdateControllerColor]]), otherwise an error is thrown. Afterwards, this flag is set.
|-
 
| 812 || [8.0.0+] GetConsoleUniqueSixAxisSensorHandle
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.
|-
 
| 821 || StartAnalogStickManualCalibration
== GetUniquePadDriverState ==
|-
Takes a total of 8-bytes of input, returns a total of 0x20-bytes of output.
| 822 || RetryCurrentAnalogStickManualCalibrationStage
 
|-
[9.0.0+] Now takes a total of 8-bytes of input, returns a total of 0x18-bytes of output.
| 823 || CancelAnalogStickManualCalibration
 
|-
[18.0.0+] Now takes a total of 8-bytes of input, returns a total of 0x20-bytes of output.
| 824 || ResetAnalogStickManualCalibration
 
|-
== GetSixAxisSensorDriverStates ==
| 825 || [5.0.0+] GetAnalogStickState
Takes a total of 8-bytes of input and a type-0xA output buffer, returns a total of 8-bytes of output.
|-
 
| 826 || [5.0.0+] GetAnalogStickManualCalibrationStage
[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.
|-
 
| 827 || [5.0.0+] IsAnalogStickButtonPressed
== AcquireOperationEventHandle ==
|-
Takes an input [[#UniquePadId]], returns an output Event handle. The EventClearMode used by official sw is user-specified.
| 828 || [5.0.0+] IsAnalogStickInReleasePosition
 
|-
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).
| 829 || [5.0.0+] IsAnalogStickInCircumference
 
|-
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.
| 830 || [7.0.0+] [[#SetNotificationLedPattern]]
 
|-
== ReadSerialFlash ==
| 831 || [9.0.0+] [[#SetNotificationLedPatternWithTimeout]]
Takes an input TransferMemory handle, an input u32 offset, an input u64 size, and an [[#UniquePadId]], no output.
|-
 
| 832 || [9.0.0+] [[#PrepareHidsForNotificationWake]]
Reads from the specified controller's spi-flash. The input size is the original size without page-alignment. The TransferMemory permissions is RW-.
|-
 
| 850 || [3.0.0+] IsUsbFullKeyControllerEnabled
See also [[#AcquireOperationEventHandle]].
|-
 
| 851 || [3.0.0+] EnableUsbFullKeyController
With the sdk-nso for [9.0.0+] the wrapper funcs for this was removed (sdk-nso still has the actual cmd).
|-
 
| 852 || [3.0.0+] IsUsbConnected
== WriteSerialFlash ==
|-
Takes an input TransferMemory handle, an input u32 offset, an input u64 tmem_size, an input u64 size, and an [[#UniquePadId]], no output.
| 870 || [5.1.0+] IsHandheldButtonPressedOnConsoleMode
 
|-
Writes to the specified controller's spi-flash. The TransferMemory permissions is R--.
| 900 || [1.0.0-9.2.0] ActivateInputDetector
 
|-
See also [[#AcquireOperationEventHandle]].
| 901 || [1.0.0-9.2.0] [[#NotifyInputDetector]]
 
|-
With the sdk-nso for [9.0.0+] the wrapper funcs for this was removed (sdk-nso still has the actual cmd).
| 1000 || [3.0.0+] InitializeFirmwareUpdate
 
|-
== GetOperationResult ==
| 1001 || [3.0.0+] GetFirmwareVersion
Takes an input [[#UniquePadId]], no output.
|-
 
| 1002 || [3.0.0+] GetAvailableFirmwareVersion
Get the Result for the Operation and handles cleanup, for the specified controller.
|-
 
| 1003 || [3.0.0+] IsFirmwareUpdateAvailable
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).
|-
 
| 1004 || [3.0.0+] CheckFirmwareUpdateRequired
== GetUniquePadDeviceTypeSetInternal ==
|-
Takes an input [[#UniquePadId]], returns an [[#DeviceTypeInternal]].
| 1005 || [3.0.0+] StartFirmwareUpdate
 
|-
== GetAbstractedPadHandles ==
| 1006 || [3.0.0+] AbortFirmwareUpdate
Takes a type-0xA output buffer containing an array of u64 '''AbstractedPadHandle''' and returns an output s32 for total entries.
|-
 
| 1007 || [3.0.0+] GetFirmwareUpdateState
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".
 
{| class="wikitable" border="1"
|-
|-
| 1008 || [4.0.0+] ActivateAudioControl
! Cmd || Name
|-
|-
| 1009 || [4.0.0+] AcquireAudioControlEventHandle
| 31 || [[#SendKeyboardLockKeyEvent_2|SendKeyboardLockKeyEvent]]
|-
|-
| 1010 || [4.0.0+] GetAudioControlStates
| 32 || [15.0.0+] SetSystemKeyboardState
|-
|-
| 1011 || [4.0.0+] DeactivateAudioControl
| 33 || [15.0.0+] UnsetSystemKeyboardState
|-
|-
| 1050 || [5.0.0+] IsSixAxisSensorAccurateUserCalibrationSupported
| 101 || [[#AcquireHomeButtonEventHandle]]
|-
|-
| 1051 || [5.0.0+] StartSixAxisSensorAccurateUserCalibration
| 111 || [[#ActivateHomeButton]]
|-
|-
| 1052 || [5.0.0+] CancelSixAxisSensorAccurateUserCalibration
| 121 || [[#AcquireSleepButtonEventHandle]]
|-
|-
| 1053 || [5.0.0+] GetSixAxisSensorAccurateUserCalibrationState
| 131 || [[#ActivateSleepButton]]
|-
|-
| 1100 || [5.0.0+] [[#GetHidbusSystemServiceObject]]
| 141 || [[#AcquireCaptureButtonEventHandle]]
|-
|-
| 1120 || [6.0.0+] SetFirmwareHotfixUpdateSkipEnabled
| 151 || [[#ActivateCaptureButton]]
|-
|-
| 1130 || [6.0.0+] InitializeUsbFirmwareUpdate
| 161 || [7.0.0+] GetPlatformConfig
|-
|-
| 1131 || [6.0.0+] FinalizeUsbFirmwareUpdate
| 171 || [S2]
|-
|-
| 1132 || [6.0.0+] CheckUsbFirmwareUpdateRequired
| 181 || [S2]
|-
|-
| 1133 || [6.0.0+] StartUsbFirmwareUpdate
| 210 || AcquireNfcDeviceUpdateEventHandle
|-
|-
| 1134 || [6.0.0+] GetUsbFirmwareUpdateState
| 211 || GetNpadsWithNfc
|-
|-
| 1150 || [8.0.0+] SetTouchScreenMagnification
| 212 || AcquireNfcActivateEventHandle
|-
|-
| 1151 || [9.0.0+] GetTouchScreenFirmwareVersion
| 213 || ActivateNfc
|-
|-
| 1152 || [9.0.0+] SetTouchScreenDefaultConfiguration
| 214 || [4.0.0-18.1.0] GetXcdHandleForNpadWithNfc
|-
|-
| 1153 || [9.0.0+] GetTouchScreenDefaultConfiguration
| 215 || [4.0.0+] IsNfcActivated
|-
|-
| 1154 || [9.0.0+] IsFirmwareAvailableForNotification
| 216 || [19.0.0+] GetAbstractedPadIdForNpadWithNfc
|-
|-
| 1155 || [9.0.0+] SetForceHandheldStyleVibration
| 217 || [19.0.0+] [[#SetNfcEvent]]
|-
|-
| 1156 || [9.0.0+] SendConnectionTriggerWithoutTimeoutEvent
| 218 || [19.0.0+] [[#GetNfcInfo]]
|-
|-
| 1157 || [10.0.0+] [[#CancelConnectionTrigger]]
| 219 || [19.0.0+] StartNfcDiscovery
|-
|-
| 1200 || [10.0.0+] [[#IsButtonConfigSupported]]
| 220 || [19.0.0+] StopNfcDiscovery
|-
|-
| 1201 || [10.0.0+] [[#DeleteButtonConfig]]
| 221 || [19.0.0+] StartNtagRead
|-
|-
| 1202 || [10.0.0+] [[#SetButtonConfigEnabled]]
| 222 || [19.0.0+] StartNtagWrite
|-
|-
| 1203 || [10.0.0+] [[#IsButtonConfigEnabled]]
| 223 || [19.0.0+] SendNfcRawData
|-
|-
| 1204 || [10.0.0+] [[#SetButtonConfigEmbedded]]
| 224 || [19.0.0+] RegisterMifareKey
|-
|-
| 1205 || [10.0.0+] [[#SetButtonConfigFull]]
| 225 || [19.0.0+] ClearMifareKey
|-
|-
| 1206 || [10.0.0+] [[#SetButtonConfigLeft]]
| 226 || [19.0.0+] StartMifareRead
|-
|-
| 1207 || [10.0.0+] [[#SetButtonConfigRight]]
| 227 || [19.0.0+] StartMifareWrite
|-
|-
| 1208 || [10.0.0+] [[#GetButtonConfigEmbedded]]
| 230 || AcquireIrSensorEventHandle
|-
|-
| 1209 || [10.0.0+] [[#GetButtonConfigFull]]
| 231 || ActivateIrSensor
|-
|-
| 1210 || [10.0.0+] [[#GetButtonConfigLeft]]
| 232 || [10.0.0+] GetIrSensorState
|-
|-
| 1211 || [10.0.0+] [[#GetButtonConfigRight]]
| 233 || [10.0.0+] GetXcdHandleForNpadWithIrSensor
|-
|-
| 1250 || [10.0.0+] [[#IsCustomButtonConfigSupported]]
| 234 || [19.0.0+] GetNpadJoyHoldType
|-
|-
| 1251 || [10.0.0+] [[#IsDefaultButtonConfigEmbedded]]
| 241 || [19.0.0+] [[#GetDataFormat]]
|-
|-
| 1252 || [10.0.0+] [[#IsDefaultButtonConfigFull]]
| 242 || [19.0.0+] [[#SetDataFormat]]
|-
|-
| 1253 || [10.0.0+] [[#IsDefaultButtonConfigLeft]]
| 243 || [19.0.0+] [[#GetMcuState]]
|-
|-
| 1254 || [10.0.0+] [[#IsDefaultButtonConfigRight]]
| 244 || [19.0.0+] [[#SetMcuState]]
|-
|-
| 1255 || [10.0.0+] [[#IsButtonConfigStorageEmbeddedEmpty]]
| 245 || [19.0.0+] [[#GetMcuVersionForNfc]]
|-
|-
| 1256 || [10.0.0+] [[#IsButtonConfigStorageFullEmpty]]
| 246 || [19.0.0+] [[#CheckNfcDevicePower]]
|-
|-
| 1257 || [10.0.0+] [[#IsButtonConfigStorageLeftEmpty]]
| 247 || [19.0.0+] [[#SetMcuStateImmediate]]
|-
|-
| 1258 || [10.0.0+] [[#IsButtonConfigStorageRightEmpty]]
| 251 || [S2]
|-
|-
| 1259 || [10.0.0+] [[#GetButtonConfigStorageEmbedded]]
| 252 || [S2]
|-
|-
| 1260 || [10.0.0+] [[#GetButtonConfigStorageFull]]
| 253 || [S2]
|-
|-
| 1261 || [10.0.0+] [[#GetButtonConfigStorageLeft]]
| 301 || ActivateNpadSystem
|-
|-
| 1262 || [10.0.0+] [[#GetButtonConfigStorageRight]]
| 303 || ApplyNpadSystemCommonPolicy
|-
|-
| 1263 || [10.0.0+] [[#SetButtonConfigStorageEmbedded]]
| 304 || EnableAssigningSingleOnSlSrPress
|-
|-
| 1264 || [10.0.0+] [[#SetButtonConfigStorageFull]]
| 305 || DisableAssigningSingleOnSlSrPress
|-
|-
| 1265 || [10.0.0+] [[#SetButtonConfigStorageLeft]]
| 306 || GetLastActiveNpad
|-
|-
| 1266 || [10.0.0+] [[#SetButtonConfigStorageRight]]
| 307 || GetNpadSystemExtStyle
|-
|-
| 1267 || [10.0.0+] [[#DeleteButtonConfigStorageEmbedded]]
| 308 || [5.0.0+] ApplyNpadSystemCommonPolicyFull
|-
|-
| 1268 || [10.0.0+] [[#DeleteButtonConfigStorageFull]]
| 309 || [5.0.0+] GetNpadFullKeyGripColor
|-
|-
| 1269 || [10.0.0+] [[#DeleteButtonConfigStorageLeft]]
| 310 || [6.0.0+] [[#GetMaskedSupportedNpadStyleSet]]
|-
|-
| 1270 || [10.0.0+] [[#DeleteButtonConfigStorageRight]]
| 311 || SetNpadPlayerLedBlinkingDevice
|-
|-
| 1271 || [10.0.0+] [[#IsUsingCustomButtonConfig]]
| 312 || [6.0.0+] SetSupportedNpadStyleSetAll
|-
|-
| 1272 || [10.0.0+] [[#IsAnyCustomButtonConfigEnabled]]
| 313 || [9.0.0+] GetNpadCaptureButtonAssignment
|-
|-
| 1273 || [10.0.0+] [[#SetAllCustomButtonConfigEnabled]]
| 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
|-
|-
| 1274 || [10.0.0+] [[#SetDefaultButtonConfig]]
| 329 || [14.0.0+] DetachAbstractedPadAll
|-
|-
| 1275 || [10.0.0+] [[#SetAllDefaultButtonConfig]]
| 330 || [14.0.0+] CheckAbstractedPadConnection
|-
|-
| 1276 || [10.0.0+] [[#SetHidButtonConfigEmbedded]]
| 332 || [19.0.0+] ConvertAppletDetailedUiTypeFromPlayReportType
|-
|-
| 1277 || [10.0.0+] [[#SetHidButtonConfigFull]]
| 333 || [20.0.0+] SetNpadUserSpgApplet
|-
|-
| 1278 || [10.0.0+] [[#SetHidButtonConfigLeft]]
| 334 || [20.0.0+] AcquireUniquePadButtonStateChangedEventHandle
|-
|-
| 1279 || [10.0.0+] [[#SetHidButtonConfigRight]]
| 500 || SetAppletResourceUserId
|-
|-
| 1280 || [10.0.0+] [[#GetHidButtonConfigEmbedded]]
| 501 || RegisterAppletResourceUserId
|-
|-
| 1281 || [10.0.0+] [[#GetHidButtonConfigFull]]
| 502 || UnregisterAppletResourceUserId
|-
|-
| 1282 || [10.0.0+] [[#GetHidButtonConfigLeft]]
| 503 || EnableAppletToGetInput
|-
|-
| 1283 || [10.0.0+] [[#GetHidButtonConfigRight]]
| 504 || SetAruidValidForVibration
|}
|-
 
| 505 || EnableAppletToGetSixAxisSensor
== GetMaskedSupportedNpadStyleSet ==
|-
Takes an input u64 AppletResourceUserId, returns an output u32 [[#NpadStyleTag]].
| 506 || [14.0.0+] EnableAppletToGetPadInput
 
|-
Official sw uses the output from [[Applet_Manager_services|GetAppletResourceUserIdOfCallerApplet]] with this.
| 507 || [14.0.0+] EnableAppletToGetTouchScreen
 
|-
== GetUniquePadsFromNpad ==
| 510 || [[#SetVibrationMasterVolume]]
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).
|-
 
| 511 || GetVibrationMasterVolume
The output buffer contains an array of [[#UniquePadId]].
|-
 
| 512 || [3.0.0+] BeginPermitVibrationSession
== SetVibrationMasterVolume ==
|-
Takes an input 32bit float.
| 513 || [3.0.0+] EndPermitVibrationSession
 
|-
== GetUniquePadIds ==
| 514 || [12.0.0+] SendVibrationNotificationPattern
Takes a type-0xA output buffer, and returns an output s64 for total output entries (which is copied to a s32 by official sw).
|-
 
| 520 || EnableHandheldHids
The output buffer contains an array of [[#UniquePadId]].
|-
 
| 521 || DisableHandheldHids
== GetUniquePadType ==
|-
Takes an input [[#UniquePadId]] and returns an output u64 [[#UniquePadType]].
| 522 || [9.0.0+] SetJoyConRailEnabled
 
|-
== GetUniquePadSerialNumber ==
| 523 || [9.0.0+] IsJoyConRailEnabled
Takes an input [[#UniquePadId]] and returns an output [[#UniquePadSerialNumber]].
|-
 
| 524 || [10.0.0+] IsHandheldHidsEnabled
== SetNotificationLedPattern ==
|-
Takes an input [[#NotificationLedPattern]] and an [[#UniquePadId]], no output.
| 525 || [11.0.0+] IsJoyConAttachedOnAllRail
 
|-
The specified controller must have a HOME button.
| 526 || [19.0.0+] IsInvertedControllerConnectedOnRail
 
|-
This sends subcommand 0x38 to the specified controller, for setting the pattern for the HOME button notification LED. The input structure is converted to the format used by this [https://github.com/dekuNukem/Nintendo_Switch_Reverse_Engineering/blob/master/bluetooth_hid_subcommands_notes.md#subcommand-0x38-set-home-light subcommand].
| 540 || AcquirePlayReportControllerUsageUpdateEvent
 
|-
[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}).
| 541 || GetPlayReportControllerUsages
 
|-
== SetNotificationLedPatternWithTimeout ==
| 542 || AcquirePlayReportRegisteredDeviceUpdateEvent
Takes an input [[#NotificationLedPattern]], an [[#UniquePadId]], and an s64 TimeSpan, no output.
|-
 
| 543 || [5.0.0-18.1.0] GetRegisteredDevicesOld ([1.0.0-4.1.0] GetRegisteredDevices)
== PrepareHidsForNotificationWake ==
|-
Takes a type-0x9 input buffer containing an array of [[#UniquePadId]], no output.
| 544 || [3.0.0+] AcquireConnectionTriggerTimeoutEvent
 
|-
== NotifyInputDetector ==
| 545 || [3.0.0+] SendConnectionTrigger
Takes an input u32 bitmask InputSourceId, no output.
|-
 
| 546 || [3.0.0+] AcquireDeviceRegisteredEventForControllerSupport
This is the only hid:sys command used by USB-sysmodule (with value 0x40).
|-
 
| 547 || [3.0.0+] GetAllowedBluetoothLinksCount
== GetHidbusSystemServiceObject ==
|-
No input, returns an [[#IHidbusSystemServer]].
| 548 || [5.0.0+] GetRegisteredDevices
 
|-
== CancelConnectionTrigger ==
| 549 || [6.0.0+] GetConnectableRegisteredDevices
Takes an input "nn::bluetooth::Address", no output.
|-
 
| 550 || [S2]
== IsButtonConfigSupported ==
|-
Takes an input [[#UniquePadId]], returns an output bool.
| 551 || [20.0.0+] GetRegisteredDevicesForControllerSupport
 
|-
== DeleteButtonConfig ==
| 700 || ActivateUniquePad
Takes an input [[#UniquePadId]], no output.
|-
 
| 702 || AcquireUniquePadConnectionEventHandle
== SetButtonConfigEnabled ==
|-
Takes an input bool, an [[#UniquePadId]], no output.
| 703 || [[#GetUniquePadIds]]
 
|-
== IsButtonConfigEnabled ==
| 704 || [S2]
Takes an input [[#UniquePadId]], returns an output bool.
|-
 
| 705 || [S2]
== SetButtonConfigEmbedded ==
|-
Takes an input [[#UniquePadId]], a type-0x15 input buffer containing a [[#SystemButtonConfigEmbedded]], no output.
| 707 || [S2]
 
|-
== SetButtonConfigFull ==
| 711 || [20.0.0+] AcquireUniquePadConnectionOnHandheldForNsEventHandle
Takes an input [[#UniquePadId]], a type-0x15 input buffer containing a [[#SystemButtonConfigFull]], no output.
|-
 
| 712 || [20.0.0+] GetUniquePadColor12
== SetButtonConfigLeft ==
|-
Takes an input [[#UniquePadId]], a type-0x15 input buffer containing a [[#SystemButtonConfigLeft]], no output.
| 721 || [S2]
 
|-
== SetButtonConfigRight ==
| 722 || [S2]
Takes an input [[#UniquePadId]], a type-0x15 input buffer containing a [[#SystemButtonConfigRight]], no output.
|-
 
| 723 || [S2]
== GetButtonConfigEmbedded ==
|-
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#SystemButtonConfigEmbedded]].
| 724 || [S2]
 
|-
== GetButtonConfigFull ==
| 725 || [S2]
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#SystemButtonConfigFull]].
|-
 
| 726 || [S2]
== GetButtonConfigLeft ==
|-
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#SystemButtonConfigLeft]].
| 727 || [S2]
 
|-
== GetButtonConfigRight ==
| 728 || [S2]
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#SystemButtonConfigRight]].
|-
 
| 729 || [S2]
== IsCustomButtonConfigSupported ==
|-
Takes an input [[#UniquePadId]], returns an output bool.
| 730 || [S2]
 
|-
== IsDefaultButtonConfigEmbedded ==
| 731 || [S2]
Takes a type-0x15 input buffer containing a [[#ButtonConfigEmbedded]], returns an output bool.
|-
 
| 732 || [S2]
This compares the input config with config in state, sets the output bool to whether these match, then returns 0.
|-
 
| 733 || [S2]
== IsDefaultButtonConfigFull ==
|-
Takes a type-0x15 input buffer containing a [[#ButtonConfigFull]], returns an output bool.
| 734 || [S2]
 
|-
This compares the input config with config in state, sets the output bool to whether these match, then returns 0.
| 735 || [S2]
 
|-
== IsDefaultButtonConfigLeft ==
| 736 || [S2]
Takes a type-0x15 input buffer containing a [[#ButtonConfigLeft]], returns an output bool.
|-
 
| 737 || [S2]
This compares the input config with config in state, sets the output bool to whether these match, then returns 0.
|-
 
| 738 || [S2]
== IsDefaultButtonConfigRight ==
|-
Takes a type-0x15 input buffer containing a [[#ButtonConfigRight]], returns an output bool.
| 739 || [S2]
 
|-
This compares the input config with config in state, sets the output bool to whether these match, then returns 0.
| 740 || [S2]
 
|-
== IsButtonConfigStorageEmbeddedEmpty ==
| 741 || [S2]
Takes an input s32 entry-index, returns an output bool.
|-
 
| 742 || [S2]
[10.1.0+] This will now Abort if the s32 is negative or >=5.
|-
 
| 743 || [S2]
Uses [[Settings_services#GetButtonConfigSettingsEmbedded|GetButtonConfigSettingsEmbedded]] with count=5 (output s32 ignored). The input entry-index is used with this array. Then the output bool is set to [[Settings_services#ButtonConfigSettings|IsFull]] bit0 == 0. Then 0 is returned.
|-
 
| 744 || [S2]
== IsButtonConfigStorageFullEmpty ==
|-
Takes an input s32 entry-index, returns an output bool.
| 745 || [S2]
 
|-
Same as [[#IsButtonConfigStorageEmbeddedEmpty]] except with a different setsys cmd.
| 746 || [S2]
 
|-
== IsButtonConfigStorageLeftEmpty ==
| 751 || AcquireJoyDetachOnBluetoothOffEventHandle
Takes an input s32 entry-index, returns an output bool.
|-
 
| 800 || ListSixAxisSensorHandles
Same as [[#IsButtonConfigStorageEmbeddedEmpty]] except with a different setsys cmd.
|-
 
| 801 || IsSixAxisSensorUserCalibrationSupported
== IsButtonConfigStorageRightEmpty ==
|-
Takes an input s32 entry-index, returns an output bool.
| 802 || ResetSixAxisSensorCalibrationValues
 
|-
Same as [[#IsButtonConfigStorageEmbeddedEmpty]] except with a different setsys cmd.
| 803 || StartSixAxisSensorUserCalibration
 
|-
== GetButtonConfigStorageEmbedded ==
| 804 || CancelSixAxisSensorUserCalibration
Takes an input s32 entry-index, and a type-0x16 output buffer containing a [[#ButtonConfigEmbedded]].
|-
 
| 805 || [3.0.0+] GetUniquePadBluetoothAddress
[10.1.0+] This will now Abort if the s32 is negative or >=5.
|-
 
| 806 || [3.0.0+] DisconnectUniquePad
Uses [[Settings_services#GetButtonConfigSettingsEmbedded|GetButtonConfigSettingsEmbedded]] with count=5 (output s32 ignored). The input entry-index is used with this array. Then an error is thrown if [[Settings_services#ButtonConfigSettings|IsFull]] bit0 is clear. Then the data at +0x1C8 is converted to [[#ButtonConfigEmbedded]], copied to output, and returns 0.
|-
 
| 807 || [5.0.0+] [[#GetUniquePadType]]
== GetButtonConfigStorageFull ==
|-
Takes an input s32 entry-index, and a type-0x16 output buffer containing a [[#ButtonConfigFull]].
| 808 || [5.0.0+] GetUniquePadInterface
 
|-
Same as [[#GetButtonConfigStorageEmbedded]], except this uses a different setsys cmd, and uses a different conversion func / different output struct.
| 809 || [5.0.0+] [[#GetUniquePadSerialNumber]]
 
|-
== GetButtonConfigStorageLeft ==
| 810 || [5.0.0+] GetUniquePadControllerNumber
Takes an input s32 entry-index, and a type-0x16 output buffer containing a [[#ButtonConfigLeft]].
|-
 
| 811 || [5.0.0+] GetSixAxisSensorUserCalibrationStage
Same as [[#GetButtonConfigStorageEmbedded]], except this uses a different setsys cmd, and uses a different conversion func / different output struct.
|-
 
| 812 || [8.0.0+] GetConsoleUniqueSixAxisSensorHandle
== GetButtonConfigStorageRight ==
|-
Takes an input s32 entry-index, and a type-0x16 output buffer containing a [[#ButtonConfigRight]].
| 813 || [18.0.0+] GetDeviceType
 
|-
Same as [[#GetButtonConfigStorageEmbedded]], except this uses a different setsys cmd, and uses a different conversion func / different output struct.
| 821 || StartAnalogStickManualCalibration
 
|-
== SetButtonConfigStorageEmbedded ==
| 822 || RetryCurrentAnalogStickManualCalibrationStage
Takes an input s32 entry-index, and a type-0x15 input buffer containing a [[#ButtonConfigEmbedded]].
|-
 
| 823 || CancelAnalogStickManualCalibration
[10.1.0+] This will now Abort if the s32 is negative or >=5.
|-
 
| 824 || ResetAnalogStickManualCalibration
If the input config matches the [[#IsDefaultButtonConfigEmbedded|default]], this first does:
|-
* Uses [[Settings_services#GetButtonConfigSettingsEmbedded|GetButtonConfigSettingsEmbedded]] with count=5 (output s32 ignored). The input entry-index is used with this array. When [[Settings_services#ButtonConfigSettings|IsFull]] is set, the config is deleted the same way as [[#DeleteButtonConfigStorageEmbedded]] (following the IsFull check).
| 825 || [5.0.0+] GetAnalogStickState
 
|-
Afterwards, this uses [[Settings_services#GetButtonConfigSettingsEmbedded|GetButtonConfigSettingsEmbedded]] with count=5 (output s32 ignored). The input entry-index is used with this array. The input struct is converted, the output from that is copied to +0x1C8 size 0x3E0, IsFull is set, [[Settings_services#SetButtonConfigSettingsEmbedded|SetButtonConfigSettingsEmbedded]] is used with the updated array, and then returns 0.
| 826 || [5.0.0+] GetAnalogStickManualCalibrationStage
 
|-
== SetButtonConfigStorageFull ==
| 827 || [5.0.0+] IsAnalogStickButtonPressed
Takes an input s32 entry-index, and a type-0x15 input buffer containing a [[#ButtonConfigFull]].
|-
 
| 828 || [5.0.0+] IsAnalogStickInReleasePosition
Same as [[#SetButtonConfigStorageEmbedded]], except this uses different setsys cmds, and uses a different structs etc.
|-
 
| 829 || [5.0.0+] IsAnalogStickInCircumference
== SetButtonConfigStorageLeft ==
|-
Takes an input s32 entry-index, and a type-0x15 input buffer containing a [[#ButtonConfigLeft]].
| 830 || [7.0.0+] [[#SetNotificationLedPattern]]
 
|-
Same as [[#SetButtonConfigStorageEmbedded]], except this uses different setsys cmds, and uses a different structs etc.
| 831 || [9.0.0+] [[#SetNotificationLedPatternWithTimeout]]
 
|-
== SetButtonConfigStorageRight ==
| 832 || [9.0.0+] [[#PrepareHidsForNotificationWake]]
Takes an input s32 entry-index, and a type-0x15 input buffer containing a [[#ButtonConfigRight]].
|-
 
| 850 || [3.0.0+] [[#IsUsbFullKeyControllerEnabled]]
Same as [[#SetButtonConfigStorageEmbedded]], except this uses different setsys cmds, and uses a different structs etc.
|-
 
| 851 || [3.0.0+] [[#EnableUsbFullKeyController]]
== DeleteButtonConfigStorageEmbedded ==
|-
Takes an input s32 entry-index, no output.
| 852 || [3.0.0+] [[#IsUsbConnected]]
 
|-
[10.1.0+] This will now Abort if the s32 is negative or >=5.
| 870 || [5.1.0+] IsHandheldButtonPressedOnConsoleMode
 
|-
Uses [[Settings_services#GetButtonConfigSettingsEmbedded|GetButtonConfigSettingsEmbedded]] with count=5 (output s32 ignored). The input entry-index is used with this array. Then an error is thrown if [[Settings_services#ButtonConfigSettings|IsFull]] bit0 is clear. Then the data at +0x1C8 size 0x3E0 is cleared, IsFull bit0 is cleared, [[Settings_services#SetButtonConfigSettingsEmbedded|SetButtonConfigSettingsEmbedded]] is used with the updated array, and then returns 0.
| 900 || [1.0.0-9.2.0] ActivateInputDetector
 
|-
== DeleteButtonConfigStorageFull ==
| 901 || [1.0.0-9.2.0] [[#NotifyInputDetector]]
Takes an input s32 entry-index, no output.
|-
 
| 1000 || [3.0.0+] InitializeFirmwareUpdate
Same as [[#IsButtonConfigStorageEmbeddedEmpty]] except with different setsys cmds.
|-
 
| 1001 || [3.0.0+] GetFirmwareVersion
== DeleteButtonConfigStorageLeft ==
|-
Takes an input s32 entry-index, no output.
| 1002 || [3.0.0+] GetAvailableFirmwareVersion
 
|-
Same as [[#IsButtonConfigStorageEmbeddedEmpty]] except with different setsys cmds.
| 1003 || [3.0.0+] IsFirmwareUpdateAvailable
 
|-
== DeleteButtonConfigStorageRight ==
| 1004 || [3.0.0+] CheckFirmwareUpdateRequired
Takes an input s32 entry-index, no output.
|-
 
| 1005 || [3.0.0+] StartFirmwareUpdate
Same as [[#IsButtonConfigStorageEmbeddedEmpty]] except with different setsys cmds.
|-
 
| 1006 || [3.0.0+] AbortFirmwareUpdate
== IsUsingCustomButtonConfig ==
|-
Takes an input [[#UniquePadId]], returns an output bool.
| 1007 || [3.0.0+] GetFirmwareUpdateState
 
|-
== IsAnyCustomButtonConfigEnabled ==
| 1008 || [4.0.0+] ActivateAudioControl
No input, returns an output bool.
|-
 
| 1009 || [4.0.0+] AcquireAudioControlEventHandle
== SetAllCustomButtonConfigEnabled ==
|-
Takes an input bool and an AppletResourceUserId, no output.
| 1010 || [4.0.0+] GetAudioControlStates
 
|-
== SetDefaultButtonConfig ==
| 1011 || [4.0.0+] DeactivateAudioControl
Takes an input [[#UniquePadId]], no output.
|-
 
| 1012 || [20.0.0+] GetFirmwareVersionStringForUserSupportPage
== SetAllDefaultButtonConfig ==
|-
No input/output.
| 1050 || [5.0.0+] IsSixAxisSensorAccurateUserCalibrationSupported
 
|-
== SetHidButtonConfigEmbedded ==
| 1051 || [5.0.0+] StartSixAxisSensorAccurateUserCalibration
Takes an input [[#UniquePadId]] and a type-0x15 input buffer containing a [[#ButtonConfigEmbedded]], no output.
 
== SetHidButtonConfigFull ==
Takes an input [[#UniquePadId]] and a type-0x15 input buffer containing a [[#ButtonConfigFull]], no output.
 
== SetHidButtonConfigLeft ==
Takes an input [[#UniquePadId]] and a type-0x15 input buffer containing a [[#ButtonConfigLeft]], no output.
 
== SetHidButtonConfigRight ==
Takes an input [[#UniquePadId]] and a type-0x15 input buffer containing a [[#ButtonConfigRight]], no output.
 
== GetHidButtonConfigEmbedded ==
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#ButtonConfigEmbedded]].
 
== GetHidButtonConfigFull ==
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#ButtonConfigFull]].
 
== GetHidButtonConfigLeft ==
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#ButtonConfigLeft]].
 
== GetHidButtonConfigRight ==
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#ButtonConfigRight]].
 
== IHidbusSystemServer ==
This is "nn::hidbus::IHidbusSystemServer".
 
This was added with [5.0.0+].
 
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
| 1052 || [5.0.0+] CancelSixAxisSensorAccurateUserCalibration
|-
|-
| 500 || SetAppletResourceUserId
| 1053 || [5.0.0+] GetSixAxisSensorAccurateUserCalibrationState
|-
|-
| 501 || RegisterAppletResourceUserId
| 1100 || [5.0.0+] [[#GetHidbusSystemServiceObject]]
|-
|-
| 502 || UnregisterAppletResourceUserId
| 1120 || [6.0.0+] SetFirmwareHotfixUpdateSkipEnabled
|}
 
= hid:tmp =
This is "nn::hid::IHidTemporaryServer".
 
This service was added with [3.0.0+], then removed with [8.0.0+].
 
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
| 1130 || [6.0.0-15.0.1] InitializeUsbFirmwareUpdate
|-
|-
| 0 || GetConsoleSixAxisSensorCalibrationValues
| 1131 || [6.0.0+] FinalizeUsbFirmwareUpdate
|}
|-
 
| 1132 || [6.0.0+] CheckUsbFirmwareUpdateRequired
= irs =
This is "nn::irsensor::IIrSensorServer".
 
This was added to sdknso with 3.x.
 
With sdknso versions pre-4.x PointingProcessor used to be DpdProcessor. The [[#PackedPointingProcessorConfig|packed-config]] with DpdProcessor (besides RequiredMcuVersion) used to be initialized from user-specified config, now it's hard-coded.
 
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
| 1133 || [6.0.0+] StartUsbFirmwareUpdate
|-
|-
| 302 || [[#ActivateIrsensor]]
| 1134 || [6.0.0+] GetUsbFirmwareUpdateState
|-
|-
| 303 || [[#DeactivateIrsensor]]
| 1135 || [15.0.0+] InitializeUsbFirmwareUpdateWithoutMemory
|-
|-
| 304 || [[#GetIrsensorSharedMemoryHandle]]
| 1150 || [8.0.0+] SetTouchScreenMagnification
|-
|-
| 305 || [[#StopImageProcessor]]
| 1151 || [9.0.0+] [[#GetTouchScreenFirmwareVersion]]
|-
|-
| 306 || [[#RunMomentProcessor]]
| 1152 || [9.0.0+] SetTouchScreenDefaultConfiguration
|-
|-
| 307 || [[#RunClusteringProcessor]]
| 1153 || [9.0.0+] GetTouchScreenDefaultConfiguration
|-
|-
| 308 || [[#RunImageTransferProcessor]]
| 1154 || [9.0.0+] [[#IsFirmwareAvailableForNotification]]
|-
|-
| 309 || [[#GetImageTransferProcessorState]]
| 1155 || [9.0.0+] SetForceHandheldStyleVibration
|-
|-
| 310 || [[#RunTeraPluginProcessor]]
| 1156 || [9.0.0+] SendConnectionTriggerWithoutTimeoutEvent
|-
|-
| 311 || [[#GetNpadIrCameraHandle]]
| 1157 || [10.0.0+] [[#CancelConnectionTrigger]]
|-
|-
| 312 || [[#RunPointingProcessor]]
| 1158 || [20.1.0+] SetConnectionLimitForSplay
|-
|-
| 313 || [[#SuspendImageProcessor]]
| 1159 || [20.1.0+] ClearConnectionLimitForSplay
|-
|-
| 314 || [3.0.0+] [[#CheckFirmwareVersion]]
| 1200 || [10.0.0-17.0.1] [[#IsButtonConfigSupported]]
|-
|-
| 315 || [4.0.0+] [[#SetFunctionLevel]]
| 1201 || [11.0.0-17.0.1] [[#IsButtonConfigEmbeddedSupported]] ([10.0.0-10.2.0] [[#DeleteButtonConfig]])
|-
|-
| 316 || [4.0.0+] [[#RunImageTransferExProcessor]]
| 1202 || [11.0.0-17.0.1] [[#DeleteButtonConfig]] ([10.0.0-10.2.0] [[#SetButtonConfigEnabled]])
|-
|-
| 317 || [4.0.0+] [[#RunIrLedProcessor]]
| 1203 || [11.0.0-17.0.1] [[#DeleteButtonConfigEmbedded]] ([10.0.0-10.2.0] [[#IsButtonConfigEnabled]])
|-
|-
| 318 || [4.0.0+] [[#StopImageProcessorAsync]]
| 1204 || [11.0.0-17.0.1] [[#SetButtonConfigEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigEmbedded]])
|-
|-
| 319 || [4.0.0+] [[#ActivateIrsensorWithFunctionLevel]]
| 1205 || [11.0.0-17.0.1] [[#SetButtonConfigEmbeddedEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigFull]])
|}
 
== ActivateIrsensor ==
Takes a PID-descriptor and an [[AM_services|AppletResourceUserId]]. No output.
 
== DeactivateIrsensor ==
Takes a PID-descriptor and an [[AM_services|AppletResourceUserId]]. No output.
 
== GetIrsensorSharedMemoryHandle ==
Takes a PID-descriptor and an [[AM_services|AppletResourceUserId]]. Returns a SharedMemory handle.
 
The SharedMemory is "nn::irsensor::detail::StatusManager". It's mapped with permission read-only and size 0x8000.
 
It's structure is as follows:
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 1206 || [11.0.0-17.0.1] [[#IsButtonConfigEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigLeft]])
|-
|-
| 0x0 || 0x7FB0 || Array of [[#DeviceFormat]]
| 1207 || [11.0.0-17.0.1] [[#IsButtonConfigEmbeddedEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigRight]])
|-
|-
| 0x7FB0 || 0x50 || Array of [[#AruidFormat]]
| 1208 || [11.0.0-17.0.1] [[#SetButtonConfigEmbedded]] ([10.0.0-10.2.0] [[#GetButtonConfigEmbedded]])
|}
 
The array of [[#DeviceFormat]] is indexed by [[#IrCameraHandle|PlayerNumber]] and can hold up to 9 entries. The array of [[#AruidFormat]] can only hold up to 5 entries.
 
=== DeviceFormat ===
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 1209 || [11.0.0-17.0.1] [[#SetButtonConfigFull]] ([10.0.0-10.2.0] [[#GetButtonConfigFull]])
|-
|-
| 0x0 || 0x4 || [[#IrCameraStatus]]
| 1210 || [10.0.0-10.2.0] [[#GetButtonConfigLeft]]
|-
|-
| 0x4 || 0x4 || [[#IrCameraInternalStatus]]
| 1211 || [11.0.0-17.0.1] [[#SetButtonConfigRight]] ([10.0.0-10.2.0] [[#GetButtonConfigRight]])
|-
|-
| 0x8 || 0x8 || [[#IrSensorMode]]
| 1212 || [11.0.0-17.0.1] [[#GetButtonConfigEmbedded]]
|-
|-
| 0x10 || 0xE20 || [[#ProcessorStateRingLifo]]
| 1213 || [11.0.0-17.0.1] [[#GetButtonConfigFull]]
|}
 
==== 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).
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 1214 || [11.0.0-17.0.1] [[#GetButtonConfigLeft]]
|-
|-
| 0x0 || 0x8 || Start
| 1215 || [11.0.0-17.0.1] [[#GetButtonConfigRight]]
|-
|-
| 0x8 || 0x4 || Count
| 1250 || [10.0.0+] [[#IsCustomButtonConfigSupported]]
|-
|-
| 0xC || 0x4 || Padding
| 1251 || [10.0.0+] [[#IsDefaultButtonConfigEmbedded]]
|-
|-
| 0x10 || Variable || ProcessorState
| 1252 || [10.0.0+] [[#IsDefaultButtonConfigFull]]
|}
 
The maximum element count is 6 for [[#PointingProcessorMarkerState]] or 5 for any of the other states.
 
ProcessorState is specialized depending on the value of [[#IrSensorMode]].
 
===== MomentProcessorState =====
This is "nn::irsensor::MomentProcessorState".
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 1253 || [10.0.0+] [[#IsDefaultButtonConfigLeft]]
|-
|-
| 0x0 || 0x8 || SamplingNumber
| 1254 || [10.0.0+] [[#IsDefaultButtonConfigRight]]
|-
|-
| 0x8 || 0x8 || TimeStamp
| 1255 || [10.0.0+] [[#IsButtonConfigStorageEmbeddedEmpty]]
|-
|-
| 0x10 || 0x4 || AmbientNoiseLevel
| 1256 || [10.0.0+] [[#IsButtonConfigStorageFullEmpty]]
|-
|-
| 0x14 || 0x4 || Reserved
| 1257 || [10.0.0+] [[#IsButtonConfigStorageLeftEmpty]]
|-
|-
| 0x18 || 0x240 || Array of [[#MomentStatistic]]
| 1258 || [10.0.0+] [[#IsButtonConfigStorageRightEmpty]]
|}
 
The array of [[#MomentStatistic]] can hold up to 48 entries. This array can be accessed as [y + x*8] (this is a 6x8 array). region_x = image_x/6, region_y = image_y/8.
 
====== MomentStatistic ======
In sdknso GetMomentProcessorStates, this loops through each MomentProcessorState->MomentStatistic entry: <code>AverageIntensity *= scale;</code> The scale is calculated with: <code>scale = 76800.0f / (float)([[#PackedMomentProcessorConfig|WindowOfInterest]].width * [[#PackedMomentProcessorConfig|WindowOfInterest]].height);</code> Note that <code>76800 == 320*240</code>, hence with the default width/height the calculated scale is 1.0f.
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 1259 || [11.0.0-12.1.0] [[#GetButtonConfigStorageEmbeddedDeprecated]] ([10.0.0-10.2.0] [[#GetButtonConfigStorageEmbeddedDeprecated|GetButtonConfigStorageEmbedded]])
|-
|-
| 0x0 || 0x4 || float AverageIntensity
| 1260 || [11.0.0-12.1.0] [[#GetButtonConfigStorageFullDeprecated]] ([10.0.0-10.2.0] [[#GetButtonConfigStorageFullDeprecated|GetButtonConfigStorageFull]])
|-
|-
| 0x4 || 0x4 || float CentroidX
| 1261 || [11.0.0-12.1.0] [[#GetButtonConfigStorageLeftDeprecated]] ([10.0.0-10.2.0] [[#GetButtonConfigStorageLeftDeprecated|GetButtonConfigStorageLeft]])
|-
|-
| 0x8 || 0x4 || float CentroidY
| 1262 || [11.0.0-12.1.0] [[#GetButtonConfigStorageRightDeprecated]] ([10.0.0-10.2.0] [[#GetButtonConfigStorageRightDeprecated|GetButtonConfigStorageRight]])
|}
 
===== ClusteringProcessorState =====
This is "nn::irsensor::ClusteringProcessorState".
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 1263 || [11.0.0-12.1.0] [[#SetButtonConfigStorageEmbeddedDeprecated]] ([10.0.0-10.2.0] [[#SetButtonConfigStorageEmbeddedDeprecated|SetButtonConfigStorageEmbedded]])
|-
|-
| 0x0 || 0x8 || SamplingNumber
| 1264 || [11.0.0-12.1.0] [[#SetButtonConfigStorageFullDeprecated]] ([10.0.0-10.2.0] [[#SetButtonConfigStorageFullDeprecated|SetButtonConfigStorageFull]])
|-
|-
| 0x8 || 0x8 || TimeStamp
| 1265 || [11.0.0-12.1.0] [[#SetButtonConfigStorageLeftDeprecated]] ([10.0.0-10.2.0] [[#SetButtonConfigStorageLeftDeprecated|SetButtonConfigStorageLeft]])
|-
|-
| 0x10 || 0x1 || ObjectCount
| 1266 || [11.0.0-12.1.0] [[#SetButtonConfigStorageRightDeprecated]] ([10.0.0-10.2.0] [[#SetButtonConfigStorageRightDeprecated|SetButtonConfigStorageRight]])
|-
|-
| 0x11 || 0x3 || Reserved
| 1267 || [10.0.0+] [[#DeleteButtonConfigStorageEmbedded]]
|-
|-
| 0x14 || 0x4 || AmbientNoiseLevel
| 1268 || [10.0.0+] [[#DeleteButtonConfigStorageFull]]
|-
|-
| 0x18 || 0x180 || Array of [[#ClusteringData]]
| 1269 || [10.0.0+] [[#DeleteButtonConfigStorageLeft]]
|}
 
The array of [[#ClusteringData]] can hold up to 16 entries.
 
====== ClusteringData ======
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 1270 || [10.0.0+] [[#DeleteButtonConfigStorageRight]]
|-
|-
| 0x0 || 0x4 || float AverageIntensity
| 1271 || [10.0.0+] [[#IsUsingCustomButtonConfig]]
|-
|-
| 0x4 || 0x4 || float CentroidX
| 1272 || [10.0.0+] [[#IsAnyCustomButtonConfigEnabled]]
|-
|-
| 0x8 || 0x4 || float CentroidY
| 1273 || [10.0.0+] [[#SetAllCustomButtonConfigEnabled]]
|-
|-
| 0xC || 0x4 || PixelCount
| 1274 || [10.0.0+] [[#SetDefaultButtonConfig]]
|-
|-
| 0x10 || 0x2 || BoundX
| 1275 || [10.0.0+] [[#SetAllDefaultButtonConfig]]
|-
|-
| 0x12 || 0x2 || BoundY
| 1276 || [10.0.0+] [[#SetHidButtonConfigEmbedded]]
|-
|-
| 0x14 || 0x2 || BoundtWidth
| 1277 || [10.0.0+] [[#SetHidButtonConfigFull]]
|-
|-
| 0x16 || 0x2 || BoundHeight
| 1278 || [10.0.0+] [[#SetHidButtonConfigLeft]]
|}
 
===== PointingProcessorMarkerState =====
This is "nn::irsensor::PointingProcessorMarkerState".
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 1279 || [10.0.0+] [[#SetHidButtonConfigRight]]
|-
|-
| 0x0 || 0x8 || SamplingNumber
| 1280 || [10.0.0+] [[#GetHidButtonConfigEmbedded]]
|-
|-
| 0x8 || 0x8 || TimeStamp
| 1281 || [10.0.0+] [[#GetHidButtonConfigFull]]
|-
|-
| 0x10 || 0x1 || PointingStatus
| 1282 || [10.0.0+] [[#GetHidButtonConfigLeft]]
|-
|-
| 0x11 || 0x3 || Reserved
| 1283 || [10.0.0+] [[#GetHidButtonConfigRight]]
|-
|-
| 0x14 || 0x4 || Unknown
| 1284 || [11.0.0+] [[#GetButtonConfigStorageEmbedded]]
|-
| 1285 || [11.0.0+] [[#GetButtonConfigStorageFull]]
|-
|-
| 0x18 || 0x4 || float Unknown
| 1286 || [11.0.0+] [[#GetButtonConfigStorageLeft]]
|-
|-
| 0x1C || 0x4 || float PositionX
| 1287 || [11.0.0+] [[#GetButtonConfigStorageRight]]
|-
|-
| 0x20 || 0x4 || float PositionY
| 1288 || [11.0.0+] [[#SetButtonConfigStorageEmbedded]]
|-
|-
| 0x24 || 0x4 || float Unknown
| 1289 || [11.0.0+] [[#SetButtonConfigStorageFull]]
|-
|-
| 0x28 || 0x2 || WindowOfInterestX
| 1290 || [11.0.0+] [[#SetButtonConfigStorageLeft]]
|-
|-
| 0x2A || 0x2 || WindowOfInterestY
| 1291 || [11.0.0+] [[#SetButtonConfigStorageRight]]
|-
|-
| 0x2C || 0x2 || WindowOfInterestWidth
| 1292 || [S2]
|-
|-
| 0x2E || 0x2 || WindowOfInterestHeight
| 1293 || [S2]
|-
|-
| 0x30 || 0x1 || PointingStatus
| 1294 || [S2]
|-
|-
| 0x31 || 0x3 || Reserved
| 1295 || [S2]
|-
|-
| 0x34 || 0x4 || Unknown
| 1296 || [S2]
|-
|-
| 0x38 || 0x4 || float Unknown
| 1297 || [S2]
|-
|-
| 0x3C || 0x4 || float PositionX
| 1298 || [S2]
|-
|-
| 0x40 || 0x4 || float PositionY
| 1299 || [S2]
|-
|-
| 0x44 || 0x4 || float Unknown
| 1300 || [S2]
|-
|-
| 0x48 || 0x2 || WindowOfInterestX
| 1301 || [S2]
|-
|-
| 0x4A || 0x2 || WindowOfInterestY
| 1302 || [S2]
|-
|-
| 0x4C || 0x2 || WindowOfInterestWidth
| 1303 || [S2]
|-
|-
| 0x4E || 0x2 || WindowOfInterestHeight
| 1304 || [S2]
|-
|-
| 0x50 || 0x1 || PointingStatus
| 1305 || [S2]
|-
|-
| 0x51 || 0x3 || Reserved
| 1306 || [S2]
|-
|-
| 0x54 || 0x4 || Unknown
| 1307 || [S2]
|-
|-
| 0x58 || 0x4 || float Unknown
| 1308 || [18.0.0+] SetButtonConfigVisible
|-
|-
| 0x5C || 0x4 || float PositionX
| 1309 || [18.0.0+] IsButtonConfigVisible
|-
|-
| 0x60 || 0x4 || float PositionY
| 1310 || [S2]
|-
|-
| 0x64 || 0x4 || float Unknown
| 1320 || [17.0.0+] WakeTouchScreenUp
|-
|-
| 0x68 || 0x2 || WindowOfInterestX
| 1321 || [17.0.0+] PutTouchScreenToSleep
|-
|-
| 0x6A || 0x2 || WindowOfInterestY
| 1322 || [20.0.0+] AcquireTouchScreenAsyncWakeCompletedEvent
|-
|-
| 0x6C || 0x2 || WindowOfInterestWidth
| 1350 || [S2]
|-
|-
| 0x6E || 0x2 || WindowOfInterestHeight
| 1351 || [S2]
|}
 
===== PointingProcessorState =====
This is "nn::irsensor::PointingProcessorState".
 
This is created from [[#PointingProcessorMarkerState]].
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 1352 || [S2]
|-
|-
| 0x0 || 0x8 || SamplingNumber
| 1360 || [S2]
|-
|-
| 0x8 || 0x8 || TimeStamp
| 1361 || [S2]
|-
|-
| 0x10 || 0x4 || PointingStatus
| 1362 || [S2]
|-
|-
| 0x14 || 0x4 || float PositionX
| 1380 || [S2]
|-
|-
| 0x18 || 0x4 || float PositionY
| 1381 || [S2]
|-
|-
| 0x1C || 0x4 || Reserved
| 1382 || [S2]
|}
 
===== TeraPluginProcessorState =====
This is "nn::irsensor::TeraPluginProcessorState".
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 1383 || [S2]
|-
|-
| 0x0 || 0x8 || SamplingNumber
| 1384 || [S2]
|-
|-
| 0x8 || 0x8 || TimeStamp
| 1385 || [S2]
|-
|-
| 0x10 || 0x4 || AmbientNoiseLevel
| 1386 || [S2]
|-
|-
| 0x14 || 0x12C || PluginData
| 1387 || [S2]
|}
 
===== AdaptiveClusteringProcessorState =====
This is "nn::irsensor::AdaptiveClusteringProcessorState".
 
This is created from [[#TeraPluginProcessorState]].
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 1388 || [S2]
|-
|-
| 0x0 || 0x8 || SamplingNumber
| 1400 || [S2]
|-
|-
| 0x8 || 0x8 || TimeStamp
| 1401 || [S2]
|-
|-
| 0x10 || 0x4 || AmbientNoiseLevel
| 1420 || [19.0.0+] GetAppletResourceProperty
|-
|-
| 0x14 || 0x4 || AccuracyLevel
| 1445 || [S2]
|-
|-
| 0x18 || 0x1 || ObjectCount
| 1446 || [S2]
|-
|-
| 0x19 || 0x1 || BackgroundIntensity
| 1447 || [S2]
|-
|-
| 0x1A || 0x6 || Reserved
| 1448 || [S2]
|-
|-
| 0x20 || 0x200 || Array of [[#AdaptiveClusteringData]]
| 1449 || [S2]
|}
 
The array of [[#AdaptiveClusteringData]] can hold up to 16 entries.
 
====== AdaptiveClusteringData ======
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 1455 || [S2]
|-
|-
| 0x0 || 0x4 || float CentroidX
| 1456 || [S2]
|-
|-
| 0x4 || 0x4 || float CentroidY
| 1457 || [S2]
|-
|-
| 0x8 || 0x4 || float Area
| 1458 || [S2]
|-
|-
| 0xC || 0x4 || IsIncomplete
| 1459 || [S2]
|}
 
===== HandAnalysisImageState =====
This is "nn::irsensor::HandAnalysisImageState".
 
This is created from [[#TeraPluginProcessorState]].
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 1460 || [S2]
|-
|-
| 0x0 || 0x8 || SamplingNumber
| 1461 || [S2]
|-
|-
| 0x8 || 0x4 || AmbientNoiseLevel
| 1470 || [S2]
|-
|-
| 0xC || 0x960 || Image
| 1471 || [S2]
|-
|-
| 0x96C || 0x4 || Reserved
| 1472 || [S2]
|}
 
===== HandAnalysisSilhouetteState =====
This is "nn::irsensor::HandAnalysisSilhouetteState".
 
This is created from [[#TeraPluginProcessorState]].
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 1473 || [S2]
|-
|-
| 0x0 || 0x8 || SamplingNumber
| 1474 || [S2]
|-
|-
| 0x8 || 0x4 || AmbientNoiseLevel
| 1480 || [S2]
|-
|-
| 0xC || 0x1354 || Unknown
| 12010 || [11.0.0-17.0.1] [[#SetButtonConfigLeft]]
|}
|}


===== HandAnalysisSilhouetteStateWithFullFrameShape =====
== SendKeyboardLockKeyEvent ==
This is "nn::irsensor::HandAnalysisSilhouetteStateWithFullFrameShape".
Takes an u32 BitFlagSet [[#KeyboardLockKeyEvent]], no output.
 
== AcquireHomeButtonEventHandle ==
Takes a PID, an [[AM_services|AppletResourceUserId]], returns an output Event handle.


This is created from [[#TeraPluginProcessorState]].
The EventClearMode used by sdknso is user-specified. The Event is signaled when [[#HomeButtonState]] is updated.


{| class="wikitable" border="1"
This is used by [[AM_services|AM]].
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || SamplingNumber
|-
| 0x8 || 0x4 || AmbientNoiseLevel
|-
| 0xC || 0x156C || Unknown
|}


=== AruidFormat ===
== ActivateHomeButton ==
{| class="wikitable" border="1"
Takes a PID, an [[AM_services|AppletResourceUserId]], no output.
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || IrSensorAruid
|-
| 0x8 || 0x8 || IrSensorAruidStatus
|}


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


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


== RunClusteringProcessor ==
The EventClearMode used by sdknso is user-specified. The Event is signaled when [[#SleepButtonState]] is updated.
Takes a PID-descriptor, an [[#IrCameraHandle]], an [[AM_services|AppletResourceUserId]], and a [[#PackedClusteringProcessorConfig]]. No output.


== RunImageTransferProcessor ==
This is used by [[AM_services|AM]].
Takes a PID-descriptor, an [[#IrCameraHandle]], an [[AM_services|AppletResourceUserId]], a [[#PackedImageTransferProcessorConfig]], an u64 for the TransferMemory's size, and a TransferMemory handle. No output.


The TransferMemory is created with an user specified buffer and permission none.
== ActivateSleepButton ==
Takes a PID, an [[AM_services|AppletResourceUserId]], no output.


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


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


== GetNpadIrCameraHandle ==
The EventClearMode used by sdknso is user-specified. The Event is signaled when [[#CaptureButtonState]] is updated.
Takes an input [[#NpadIdType]]. Returns an output [[#IrCameraHandle]].


== RunPointingProcessor ==
This is used by [[AM_services|AM]].
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedPointingProcessorConfig]] (immediately after the previous word), and an [[AM_services|AppletResourceUserId]]. No output.


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


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


== CheckFirmwareVersion ==
== GetMaskedSupportedNpadStyleSet ==
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedMcuVersion]], and an [[AM_services|AppletResourceUserId]]. No output.
Takes an input u64 AppletResourceUserId, returns an output u32 [[#NpadStyleTag]].


sdknso didn't actually use this until 4.x (the RequiredMcuVersion was also updated with that version).
Official sw uses the output from [[Applet_Manager_services|GetAppletResourceUserIdOfCallerApplet]] with this.


== SetFunctionLevel ==
== GetUniquePadsFromNpad ==
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedFunctionLevel]], and an [[AM_services|AppletResourceUserId]]. No output.
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).


== RunImageTransferExProcessor ==
The output buffer contains an array of [[#UniquePadId]].
Takes a PID-descriptor, an [[#IrCameraHandle]], an [[AM_services|AppletResourceUserId]], a [[#PackedImageTransferProcessorExConfig]], an u64 for the TransferMemory's size, and a TransferMemory handle. No output.


The TransferMemory is created with an user specified buffer and permission none.
== SetVibrationMasterVolume ==
Takes an input 32bit float.


== RunIrLedProcessor ==
== GetUniquePadIds ==
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedIrLedProcessorConfig]] (immediately after the previous word), and an [[AM_services|AppletResourceUserId]]. No output.
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]].


== StopImageProcessorAsync ==
== SetNotificationLedPattern ==
Takes a PID-descriptor, an [[#IrCameraHandle]], and an [[AM_services|AppletResourceUserId]]. No output.
Takes an input [[#NotificationLedPattern]] and an [[#UniquePadId]], no output.


== ActivateIrsensorWithFunctionLevel ==
The specified controller must have a HOME button.
Takes a PID-descriptor, an [[#PackedFunctionLevel]], and an [[AM_services|AppletResourceUserId]]. No output.


= irs:sys =
This sends [https://github.com/dekuNukem/Nintendo_Switch_Reverse_Engineering/blob/master/bluetooth_hid_subcommands_notes.md#subcommand-0x38-set-home-light 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: <code>((u8*)cmd_argdata)[pos] = u8_in[pos2] | u8_in[pos3]<<4;</code> Hence, 4bits from pairs of 2-bytes of the input struct are combined to write to the subcommand. Only the low 4bits of each used byte in the struct is used. This is written to stack initially, then copied to the actual cmd_argdata (the data immediately following the subcommandID byte). There's a total of 0x1D-bytes of cmd_argdata initialized from this.
This is "nn::irsensor::IIrSensorSystemServer".


The layout of cmd_argdata is as follows:
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
! Offset || Size || Description
|-
| 0x0 || 0x1 || <nowiki>((TimeUnit & 0xF) | ((FrameCount & 0xF) << 4))</nowiki>
|-
| 0x1 || 0x1 || <nowiki>((CycleCount & 0xF) | ((InitialBrightness & 0xF) << 4))</nowiki>
|-
|-
| 500 || [[#SetAppletResourceUserId]]
| 0x2 || 0x1 || <nowiki>((Frame2Brightness & 0xF) | ((Frame1Brightness & 0xF) << 4))</nowiki>
|-
|-
| 501 || [[#RegisterAppletResourceUserId]]
| 0x3 || 0x1 || <nowiki>((Frame1TimeToHold & 0xF) | ((Frame1TimeTowards & 0xF) << 4))</nowiki>
|-
|-
| 502 || [[#UnregisterAppletResourceUserId]]
| 0x4 || 0x1 || <nowiki>((Frame2TimeToHold & 0xF) | ((Frame2TimeTowards & 0xF) << 4))</nowiki>
|-
|-
| 503 || [[#EnableAppletToGetInput]]
| 0x5 || 0x1 || <nowiki>((Frame4Brightness & 0xF) | ((Frame3Brightness & 0xF) << 4))</nowiki>
|}
 
== SetAppletResourceUserId ==
Takes an [[AM_services|AppletResourceUserId]]. No output.
 
== RegisterAppletResourceUserId ==
Takes a bool and an [[AM_services|AppletResourceUserId]]. No output.
 
== UnregisterAppletResourceUserId ==
Takes an [[AM_services|AppletResourceUserId]]. No output.
 
== EnableAppletToGetInput ==
Takes a bool and an [[AM_services|AppletResourceUserId]]. No output.
 
= ahid:cd =
This is "nn::ahid::IServerSession".
 
Used for USB HID devices.
 
This service no longer exists in [9.0.0+].
 
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
| 0x6 || 0x1 || <nowiki>((Frame3TimeToHold & 0xF) | ((Frame3TimeTowards & 0xF) << 4))</nowiki>
|-
|-
| 0 || [[#AcquireDevice]]
| 0x7 || 0x1 || <nowiki>((Frame4TimeToHold & 0xF) | ((Frame4TimeTowards & 0xF) << 4))</nowiki>
|-
|-
| 1 || [[#ReleaseDevice]]
| 0x8 || 0x1 || <nowiki>((Frame6Brightness & 0xF) | ((Frame5Brightness & 0xF) << 4))</nowiki>
|-
|-
| 2 || [[#GetCtrlSession]]
| 0x9 || 0x1 || <nowiki>((Frame5TimeToHold & 0xF) | ((Frame5TimeTowards & 0xF) << 4))</nowiki>
|-
|-
| 3 || [[#GetReadSession]]
| 0xA || 0x1 || <nowiki>((Frame6TimeToHold & 0xF) | ((Frame6TimeTowards & 0xF) << 4))</nowiki>
|-
|-
| 4 || [1.0.0-2.3.0] [[#GetWriteSession]]
| 0xB || 0x1 || <nowiki>((Frame8Brightness & 0xF) | ((Frame7Brightness & 0xF) << 4))</nowiki>
|}
|-
 
| 0xC || 0x1 || <nowiki>((Frame7TimeToHold & 0xF) | ((Frame7TimeTowards & 0xF) << 4))</nowiki>
== AcquireDevice ==
|-
Takes an input s32, no output.
| 0xD || 0x1 || <nowiki>((Frame8TimeToHold & 0xF) | ((Frame8TimeTowards & 0xF) << 4))</nowiki>
 
|-
== ReleaseDevice ==
| 0xE || 0x1 || <nowiki>((Frame10Brightness & 0xF) | ((Frame9Brightness & 0xF) << 4))</nowiki>
Takes an input s32, no output.
 
== GetCtrlSession ==
Takes an input u32, returns an [[#ICtrlSession]].
 
== GetReadSession ==
Takes an input u32, returns an [[#IReadSession]].
 
== GetWriteSession ==
Takes an input u32, returns an [[#IWriteSession]].
 
== ICtrlSession ==
This is "nn::ahid::ICtrlSession".
 
This no longer exists in [9.0.0+].
 
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
| 0xF || 0x1 || <nowiki>((Frame9TimeToHold & 0xF) | ((Frame9TimeTowards & 0xF) << 4))</nowiki>
|-
|-
| 0 || GetString
| 0x10 || 0x1 || <nowiki>((Frame10TimeToHold & 0xF) | ((Frame10TimeTowards & 0xF) << 4))</nowiki>
|-
|-
| 1 || GetCodeBook
| 0x11 || 0x1 || <nowiki>((Frame12Brightness & 0xF) | ((Frame11Brightness & 0xF) << 4))</nowiki>
|-
|-
| 2 || GetReport
| 0x12 || 0x1 || <nowiki>((Frame11TimeToHold & 0xF) | ((Frame11TimeTowards & 0xF) << 4))</nowiki>
|-
|-
| 3 || SetReport
| 0x13 || 0x1 || <nowiki>((Frame12TimeToHold & 0xF) | ((Frame12TimeTowards & 0xF) << 4))</nowiki>
|-
|-
| 4 || GetIdle
| 0x14 || 0x1 || <nowiki>((Frame14Brightness & 0xF) | ((Frame13Brightness & 0xF) << 4))</nowiki>
|-
|-
| 5 || SetIdle
| 0x15 || 0x1 || <nowiki>((Frame13TimeToHold & 0xF) | ((Frame13TimeTowards & 0xF) << 4))</nowiki>
|-
|-
| 6 || GetProtocol
| 0x16 || 0x1 || <nowiki>((Frame14TimeToHold & 0xF) | ((Frame14TimeTowards & 0xF) << 4))</nowiki>
|-
|-
| 7 || SetProtocol
| 0x17 || 0x1 || <nowiki>((Reserved & 0xF) | ((Frame15Brightness & 0xF) << 4))</nowiki>
|-
|-
| 8 || GetDescriptor
| 0x18 || 0x1 || <nowiki>((Frame15TimeToHold & 0xF) | ((Frame15TimeTowards & 0xF) << 4))</nowiki>
|-
|-
| 9 || SetDescriptor
| 0x19 || 0x1 || <nowiki>((Reserved & 0xF) | ((Reserved & 0xF) << 4))</nowiki>
|-
|-
| 10 || GetStateChangeEvent
| 0x1A || 0x1 || <nowiki>((TimeTowardsFinalBrightness & 0xF) | ((FinalBrightness & 0xF) << 4))</nowiki>
|-
|-
| 11 || SignalStateChangeEvent
| 0x1B || 0x1 || <nowiki>(Timeout & 0xFF)</nowiki>
|-
|-
| 12 || [3.0.0+] Write
| 0x1C || 0x1 || <nowiki>((Timeout >> 8) & 0xFF)</nowiki>
|}
|}


All of these use USB [[USB_services|CtrlXfer]], except for GetStateChangeEvent and SignalStateChangeEvent, and GetCodeBook which copies 0x4000-bytes from state to output.
[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}).


== IReadSession ==
== SetNotificationLedPatternWithTimeout ==
This is "nn::ahid::IReadSession".
Takes an input [[#NotificationLedPattern]], an [[#UniquePadId]], and an s64 TimeSpan, no output.


This no longer exists in [9.0.0+].
== PrepareHidsForNotificationWake ==
Takes a type-0x9 input buffer containing an array of [[#UniquePadId]], no output.


{| class="wikitable" border="1"
== IsUsbConnected ==
|-
Tales an input [[#UniquePadId]], returns an output bool.
! Cmd || Name
|-
| 0 || [[#Read]]
|}


=== Read ===
== NotifyInputDetector ==
Uses [[USB_services|PostBufferAsync]] etc with the INPUT endpoint. The size must be <=0x1000. The actual transfer size is returned in an output u64. The data is copied from the tmpbuf to the output buffer using the actual-transfer-size.
Takes an input u32 bitmask InputSourceId, no output.


[3.0.0+] Now takes a total of 8-bytes of input.
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;


== IWriteSession ==
== IsFirmwareAvailableForNotification ==
This is "nn::ahid::IWriteSession".
Takes a PID, a s32, an [[#UniquePadId]], an [[AM_services|AppletResourceUserId]], returns an output bool.


This was removed with [3.0.0+].
sdknso uses hard-coded value 1 for the s32.


{| class="wikitable" border="1"
== CancelConnectionTrigger ==
|-
Takes an input "nn::bluetooth::Address", no output.
! Cmd || Name
|-
| 0 || [[#Write]]
|}


=== Write ===
== IsButtonConfigSupported ==
This is the inverse of [[#IReadSession]] cmd0. Uses the OUTPUT endpoint with an input buffer.
Takes an input [[#UniquePadId]], returns an output bool.


= ahid:hdr =
[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], returns an output bool.
This is "nn::ahid::hdr::ISession".


Used internally for USB HID devices.
== IsButtonConfigEmbeddedSupported ==
No input, returns an output bool.


This service no longer exists in [9.0.0+].
== DeleteButtonConfig ==
Takes an input [[#UniquePadId]], no output.


{| class="wikitable" border="1"
[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], no output.
|-
! Cmd || Name
|-
| 0 || GetDeviceEntries
|-
| 1 || GetDeviceList
|-
| 2 || GetDeviceParameters
|-
| 3 || AttachDevice
|-
| 4 || DetachDevice
|-
| 5 || [6.0.0+] SetDeviceFilter
|}


= xcd:sys =
== DeleteButtonConfigEmbedded ==
This is "nn::xcd::detail::ISystemServer".
No input/output.


{| class="wikitable" border="1"
== SetButtonConfigEnabled ==
|-
Takes an input bool, an [[#UniquePadId]], no output.
! Cmd || Name
 
|-
[11.0.0+] Takes an input bool, an [[Bluetooth_Driver_services#Address|Address]], no output.
| 0 || GetDataFormat
 
|-
== SetButtonConfigEmbeddedEnabled ==
| 1 || SetDataFormat
Takes an input bool, no output.
|-
 
| 2 || GetMcuState
== IsButtonConfigEnabled ==
|-
Takes an input [[#UniquePadId]], returns an output bool.
| 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.
[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], returns an output bool.


[6.0.0+]: The buffer type used by GetNfcInfo is now 0x32 instead of 0x1A.
== IsButtonConfigEmbeddedEnabled ==
No input, returns an output bool.


= hidbus =
== SetButtonConfigEmbedded ==
This is "nn::hidbus::IHidbusServer".
Takes ([10.0.0-10.2.0] an input [[#UniquePadId]]), a type-0x15 input buffer containing a [[#SystemButtonConfigEmbedded]], no output.


This was added with [5.0.0+].
== SetButtonConfigFull ==
Takes an input [[#UniquePadId]], a type-0x15 input buffer containing a [[#SystemButtonConfigFull]], no output.


Official sw opens a temporary service-session for each func using this, with it being closed once done: no global session is kept open.
[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], a type-0x15 input buffer containing a [[#SystemButtonConfigFull]], no output.


{| class="wikitable" border="1"
== SetButtonConfigLeft ==
|-
Takes an input [[#UniquePadId]], a type-0x15 input buffer containing a [[#SystemButtonConfigLeft]], no output.
! 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.
[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], a type-0x15 input buffer containing a [[#SystemButtonConfigLeft]], no output.


== GetBusHandle ==
== SetButtonConfigRight ==
Takes an input u32 [[#NpadIdType]], an u64 [[#BusType]], an u64 [[AM_services|AppletResourceUserId]], returns an output u8 bool and a [[#BusHandle]].
Takes an input [[#UniquePadId]], a type-0x15 input buffer containing a [[#SystemButtonConfigRight]], no output.


The bool indicates whether the [[#BusHandle]] is valid.
[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], a type-0x15 input buffer containing a [[#SystemButtonConfigRight]], no output.


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.
== GetButtonConfigEmbedded ==
Takes ([10.0.0-10.2.0] an input [[#UniquePadId]]), and a type-0x16 output buffer containing a [[#SystemButtonConfigEmbedded]].


This cmd will throw an error when [[#BusType]] is invalid.
== GetButtonConfigFull ==
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#SystemButtonConfigFull]].


== IsExternalDeviceConnected ==
[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], and a type-0x16 output buffer containing a [[#SystemButtonConfigFull]].
Takes an input [[#BusHandle]], returns an output u8 bool.


This is not used by sdknso.
== GetButtonConfigLeft ==
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#SystemButtonConfigLeft]].


== Initialize ==
[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], and a type-0x16 output buffer containing a [[#SystemButtonConfigLeft]].
Takes an input [[#BusHandle]], an u64 [[AM_services|AppletResourceUserId]], no output.


Prior to using this cmd, sdknso handles [[#GetSharedMemoryHandle|sharedmem]] mapping if not done previously.
== GetButtonConfigRight ==
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#SystemButtonConfigRight]].


== Finalize ==
[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], and a type-0x16 output buffer containing a [[#SystemButtonConfigRight]].
Takes an input [[#BusHandle]], an u64 [[AM_services|AppletResourceUserId]], no output.


== EnableExternalDevice ==
== IsCustomButtonConfigSupported ==
Takes an input u8 bool, a [[#BusHandle]], an u64, an u64 [[AM_services|AppletResourceUserId]], no output.
Takes an input [[#UniquePadId]], returns an output bool.


sdknso passes value 0x38900050018 (0x3A600050018 with 7.x+) for the u64.
== IsDefaultButtonConfigEmbedded ==
Takes a type-0x15 input buffer containing a [[#ButtonConfigEmbedded]], returns an output bool.


The bool flag indicates whether to enable the device (true = enable, false = disable).  When false, this will use [[#DisableJoyPollingReceiveMode]] if needed.
This compares the input config with config in state, sets the output bool to whether these match, then returns 0.


== GetExternalDeviceId ==
== IsDefaultButtonConfigFull ==
Takes an input [[#BusHandle]], returns an output u32 ExternalDeviceId.
Takes a type-0x15 input buffer containing a [[#ButtonConfigFull]], returns an output bool.


== SendCommandAsync ==
This compares the input config with config in state, sets the output bool to whether these match, then returns 0.
Takes a type-0x21 input buffer and a [[#BusHandle]], no output.


== GetSendCommandAsynceResult ==
== IsDefaultButtonConfigLeft ==
Takes a type-0x22 output buffer and a [[#BusHandle]], returns an output u32.
Takes a type-0x15 input buffer containing a [[#ButtonConfigLeft]], returns an output bool.


Official sw copies the u32 to an output u64, for the actual output size.
This compares the input config with config in state, sets the output bool to whether these match, then returns 0.


== SetEventForSendCommandAsycResult ==
== IsDefaultButtonConfigRight ==
Takes an input [[#BusHandle]], returns an output Event handle with EventClearMode=0.
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.


Official sw with SendAndReceive clears this event (6.x+ sdknso), uses [[#SendCommandAsync]], waits on + clears this event, then uses [[#GetSendCommandAsynceResult]].
== IsButtonConfigStorageEmbeddedEmpty ==
Takes an input s32 entry-index, returns an output bool.


== GetSharedMemoryHandle ==
[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.
No input, returns an output SharedMemory handle.


The SharedMemory is mapped with size 0x1000 and permissions=R--.
Uses [[Settings_services#GetButtonConfigSettingsEmbedded|GetButtonConfigSettingsEmbedded]] with count=5 (output s32 ignored). The input entry-index is used with this array. Then the output bool is set to [[Settings_services#ButtonConfigSettings|IsFull]] bit0 == 0. Then 0 is returned.


See also [[#SetStatusManagerType]].
== IsButtonConfigStorageFullEmpty ==
Takes an input s32 entry-index, returns an output bool.


This sharedmem is the StatusManager. This sharedmem contains an array of 0x100-byte (0x80-byte with [[#SetStatusManagerType|[6.0.0+]]]) entries, with entry-count {max [[#GetBusHandle|BusHandles]]}.
Same as [[#IsButtonConfigStorageEmbeddedEmpty]] except with a different setsys cmd.


sdknso only uses the first 0x10-bytes of these entries, the rest is the ignored. Entry structure:
== IsButtonConfigStorageLeftEmpty ==
Takes an input s32 entry-index, returns an output bool.


{| class="wikitable" border="1"
Same as [[#IsButtonConfigStorageEmbeddedEmpty]] except with a different setsys cmd.
|-
! Offset || Size || Description
|-
| 0x0 || 0x1 || Bool flag
|-
| 0x1 || 0x3 || Padding
|-
| 0x4 || 0x4 || Result
|-
| 0x8 || 0x1 || DeviceEnabled. Bool flag indicating whether a device is [[#EnableExternalDevice|enabled]].
|-
| 0x9 || 0x1 || IsValid. Bool flag indicating whether this entry is valid.
|-
| 0xA || 0x1 || PollingEnabled. Bool flag indicating whether polling is [[#EnableJoyPollingReceiveMode|enabled]].
|-
| 0xB || 0x1 || Unknown / padding?
|-
| 0xC || 0x4 || [[#JoyPollingMode]]
|}


== EnableJoyPollingReceiveMode ==
== IsButtonConfigStorageRightEmpty ==
Takes a type-0x21 input buffer, a TransferMemory handle, an u32 tmem_size, an u32 [[#JoyPollingMode]], a [[#BusHandle]], no output.
Takes an input s32 entry-index, returns an output bool.


The TransferMemory is created with an user-specified output buffer, with permissions=R--.
Same as [[#IsButtonConfigStorageEmbeddedEmpty]] except with a different setsys cmd.


The content of the TransferMemory depends of the [[#JoyPollingMode]]. This is used by GetJoyPollingReceivedData. Structure of the TransferMemory (DisableSixAxisPollingDataAccessor, EnableSixAxisPollingDataAccessor, JoyButtonOnlyPollingDataAccessor):
== GetButtonConfigStorageEmbeddedDeprecated ==
Takes an input s32 entry-index, and a type-0x16 output buffer containing a [[#ButtonConfigEmbedded]].


{| class="wikitable" border="1"
[10.1.0-10.2.0] This will now Abort if the s32 is negative or >=5.
|-
! 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:
[11.0.0+] This now calls the same func internally as [[#GetButtonConfigStorageEmbedded]], except the [[#StorageName]] isn't exposed.


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


{| class="wikitable" border="1"
== GetButtonConfigStorageFullDeprecated ==
|-
Takes an input s32 entry-index, and a type-0x16 output buffer containing a [[#ButtonConfigFull]].
! Offset || Size || Description
 
|-
Same as [[#GetButtonConfigStorageEmbeddedDeprecated]], except this uses a different setsys cmd, and uses a different conversion func / different output struct.
| 0x0 || 0x26 || Data
 
|-
== GetButtonConfigStorageLeftDeprecated ==
| 0x26 || 0x1 || Size of data.
Takes an input s32 entry-index, and a type-0x16 output buffer containing a [[#ButtonConfigLeft]].
|-
 
| 0x27 || 0x1 || Padding
Same as [[#GetButtonConfigStorageEmbeddedDeprecated]], except this uses a different setsys cmd, and uses a different conversion func / different output struct.
|-
| 0x28 || 0x8 || Timestamp
|}


JoyEnableSixAxisPollingDataAccessor:
== GetButtonConfigStorageRightDeprecated ==
Takes an input s32 entry-index, and a type-0x16 output buffer containing a [[#ButtonConfigRight]].


{| class="wikitable" border="1"
Same as [[#GetButtonConfigStorageEmbeddedDeprecated]], except this uses a different setsys cmd, and uses a different conversion func / different output struct.
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || Data
|-
| 0x8 || 0x1 || Size of data.
|-
| 0x9 || 0x7 || Padding
|-
| 0x10 || 0x8 || Timestamp
|}


JoyButtonOnlyPollingDataAccessor:
== SetButtonConfigStorageEmbeddedDeprecated ==
Takes an input s32 entry-index, and a type-0x15 input buffer containing a [[#ButtonConfigEmbedded]].


{| class="wikitable" border="1"
[10.1.0-10.2.0] This will now Abort if the s32 is negative or >=5.
|-
! Offset || Size || Description
|-
| 0x0 || 0x2C || Data
|-
| 0x2C || 0x1 || Size of data.
|-
| 0x2D || 0x3 || Padding
|-
| 0x30 || 0x8 || Timestamp
|}


== DisableJoyPollingReceiveMode ==
[11.0.0+] This now calls the same func internally as [[#SetButtonConfigStorageEmbedded]], except the [[#StorageName]] isn't exposed.
Takes an input [[#BusHandle]], no output.


== SetStatusManagerType ==
If the input config matches the [[#IsDefaultButtonConfigEmbedded|default]], this first does:
Takes an input u32, no output.
* Uses [[Settings_services#GetButtonConfigSettingsEmbedded|GetButtonConfigSettingsEmbedded]] with count=5 (output s32 ignored). The input entry-index is used with this array. When [[Settings_services#ButtonConfigSettings|IsFull]] is set, the config is deleted the same way as [[#DeleteButtonConfigStorageEmbedded]] (following the IsFull check).


This is used by sdknso immediately after mapping [[#GetSharedMemoryHandle|sharedmem]] (before [[#Initialize]]) with hard-coded value 0x2.
Afterwards, this uses [[Settings_services#GetButtonConfigSettingsEmbedded|GetButtonConfigSettingsEmbedded]] with count=5 (output s32 ignored). The input entry-index is used with this array. The input struct is converted, the output from that is copied to +0x1C8 size 0x3E0, IsFull is set, [[Settings_services#SetButtonConfigSettingsEmbedded|SetButtonConfigSettingsEmbedded]] is used with the updated array, and then returns 0.


= SharedMemoryFormat =
== SetButtonConfigStorageFullDeprecated ==
This is "nn::hid::detail::SharedMemoryFormat".
Takes an input s32 entry-index, and a type-0x15 input buffer containing a [[#ButtonConfigFull]].


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.
Same as [[#SetButtonConfigStorageEmbeddedDeprecated]], except this uses different setsys cmds, and uses a different structs etc.


{| class="wikitable" border="1"
== SetButtonConfigStorageLeftDeprecated ==
|-
Takes an input s32 entry-index, and a type-0x15 input buffer containing a [[#ButtonConfigLeft]].
! Offset
! Size
! Description
|-
| 0x0
| 0x400
| [[#DebugPadSharedMemoryFormat|DebugPad]]
|-
| 0x400
| 0x3000
| [[#TouchScreenSharedMemoryFormat|TouchScreen]]
|-
| 0x3400
| 0x400
| [[#MouseSharedMemoryFormat|Mouse]]
|-
| 0x3800
| 0x400
| [[#KeyboardSharedMemoryFormat|Keyboard]]
|-
| 0x3C00
| 0x1000
| [[#DigitizerSharedMemoryFormat|Digitizer]] ([1.0.0-9.2.0] [[#BasicXpadSharedMemoryFormat|BasicXpad]])
|-
| 0x4C00
| 0x200
| [[#HomeButtonSharedMemoryFormat|HomeButton]]
|-
| 0x4E00
| 0x200
| [[#SleepButtonSharedMemoryFormat|SleepButton]]
|-
| 0x5000
| 0x200
| [[#CaptureButtonSharedMemoryFormat|CaptureButton]]
|-
| 0x5200
| 0x800
| [[#InputDetectorSharedMemoryFormat|InputDetector]]
|-
| 0x5A00
| 0x4000
| [1.0.0-4.1.0] [[#UniquePadSharedMemoryFormat|UniquePad]]
|-
| 0x9A00
| 0x32000
| [[#NpadSharedMemoryFormat|Npad]]
|-
| 0x3BA00
| 0x800
| [[#GestureSharedMemoryFormat|Gesture]]
|-
| 0x3C200
| 0x1C
| [5.0.0+] [[#ConsoleSixAxisSensorSharedMemoryFormat|ConsoleSixAxisSensor]]
|}


== DebugPadSharedMemoryFormat ==
Same as [[#SetButtonConfigStorageEmbeddedDeprecated]], except this uses different setsys cmds, and uses a different structs etc.
This is "nn::hid::detail::DebugPadSharedMemoryFormat".


{| class="wikitable" border="1"
== SetButtonConfigStorageRightDeprecated ==
|-
Takes an input s32 entry-index, and a type-0x15 input buffer containing a [[#ButtonConfigRight]].
! Offset
! Size
! Description
|-
| 0x0
| 0x2C8
| [[#DebugPadLifo]]
|}


=== DebugPadLifo ===
Same as [[#SetButtonConfigStorageEmbeddedDeprecated]], except this uses different setsys cmds, and uses a different structs etc.
This is "nn::hid::detail::DebugPadLifo". This is a RingLifo object.


{| class="wikitable" border="1"
== DeleteButtonConfigStorageEmbedded ==
|-
Takes an input s32 entry-index, no output.
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| RingLifoVptr
|-
| 0x8
| 0x8
| BufferCount
|-
| 0x10
| 0x8
| Tail
|-
| 0x18
| 0x8
| Count
|-
| 0x20
| 0x28 * 17
| Array of [[#DebugPadStateAtomicStorage]]
|}


==== DebugPadStateAtomicStorage ====
[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.
This is "nn::hid::detail::DebugPadStateAtomicStorage".


{| class="wikitable" border="1"
Uses [[Settings_services#GetButtonConfigSettingsEmbedded|GetButtonConfigSettingsEmbedded]] with count=5 (output s32 ignored). The input entry-index is used with this array. Then an error is thrown if [[Settings_services#ButtonConfigSettings|IsFull]] bit0 is clear. Then the data at +0x1C8 size 0x3E0 is cleared, IsFull bit0 is cleared, [[Settings_services#SetButtonConfigSettingsEmbedded|SetButtonConfigSettingsEmbedded]] is used with the updated array, and then returns 0.
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| SamplingNumber
|-
| 0x8
| 0x20
| [[#DebugPadState]]
|}


===== DebugPadState =====
== DeleteButtonConfigStorageFull ==
This is "nn::hid::DebugPadState".
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.


{| class="wikitable" border="1"
Same as [[#DeleteButtonConfigStorageEmbedded]] except with different setsys cmds.
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| SamplingNumber
|-
| 0x8
| 0x4
| [[#DebugPadAttributeSet|Attributes]]
|-
| 0xC
| 0x4
| [[#DebugPadButtonSet|Buttons]]
|-
| 0x10
| 0x8
| [[#AnalogStickState|AnalogStickR]]
|-
| 0x18
| 0x8
| [[#AnalogStickState|AnalogStickL]]
|}


== TouchScreenSharedMemoryFormat ==
== DeleteButtonConfigStorageRight ==
This is "nn::hid::detail::TouchScreenSharedMemoryFormat".
Takes an input s32 entry-index, no output.


{| class="wikitable" border="1"
Same as [[#DeleteButtonConfigStorageEmbedded]] except with different setsys cmds.
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x2C38
| [[#TouchScreenLifo]]
|}


=== TouchScreenLifo ===
== IsUsingCustomButtonConfig ==
This is "nn::hid::detail::TouchScreenLifo". This is a RingLifo object.
Takes an input [[#UniquePadId]], returns an output bool.


{| class="wikitable" border="1"
== IsAnyCustomButtonConfigEnabled ==
|-
No input, returns an output bool.
! Offset
 
! Size
== SetAllCustomButtonConfigEnabled ==
! Description
Takes an input bool and an AppletResourceUserId, no output.
|-
 
| 0x0
== SetDefaultButtonConfig ==
| 0x8
Takes an input [[#UniquePadId]], no output.
| RingLifoVptr
|-
| 0x8
| 0x8
| BufferCount
|-
| 0x10
| 0x8
| Tail
|-
| 0x18
| 0x8
| Count
|-
| 0x20
| 0x298 * 17
| Array of [[#TouchScreenStateAtomicStorage]]
|}


==== TouchScreenStateAtomicStorage ====
== SetAllDefaultButtonConfig ==
This is "nn::hid::detail::TouchScreenStateAtomicStorage".
No input/output.


{| class="wikitable" border="1"
== SetHidButtonConfigEmbedded ==
|-
Takes an input [[#UniquePadId]] and a type-0x15 input buffer containing a [[#ButtonConfigEmbedded]], no output.
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| SamplingNumber
|-
| 0x8
| 0x290
| [[#TouchScreenState]]
|}


===== TouchScreenState =====
== SetHidButtonConfigFull ==
This is "nn::hid::detail::TouchScreenState" / "nn::hid::TouchScreenState".
Takes an input [[#UniquePadId]] and a type-0x15 input buffer containing a [[#ButtonConfigFull]], no output.


{| class="wikitable" border="1"
== SetHidButtonConfigLeft ==
|-
Takes an input [[#UniquePadId]] and a type-0x15 input buffer containing a [[#ButtonConfigLeft]], no output.
! Offset
 
! Size
== SetHidButtonConfigRight ==
! Description
Takes an input [[#UniquePadId]] and a type-0x15 input buffer containing a [[#ButtonConfigRight]], no output.
|-
 
| 0x0
== GetHidButtonConfigEmbedded ==
| 0x8
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#ButtonConfigEmbedded]].
| SamplingNumber
 
|-
== GetHidButtonConfigFull ==
| 0x8
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#ButtonConfigFull]].
| 0x4
 
| s32 Count
== GetHidButtonConfigLeft ==
|-
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#ButtonConfigLeft]].
| 0xC
 
| 0x4
== GetHidButtonConfigRight ==
| Reserved
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#ButtonConfigRight]].
|-
| 0x10
| 0x28 * 16
| [[#TouchState|Touches]]
|}


== MouseSharedMemoryFormat ==
== GetButtonConfigStorageEmbedded ==
This is "nn::hid::detail::MouseSharedMemoryFormat".
Takes an input s32, a type-0x16 output buffer containing a [[#ButtonConfigEmbedded]], a type-0x1A output buffer containing a [[#StorageName]].


{| class="wikitable" border="1"
When the input s32 is larger than unsigned value 4, an error is returned.
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x350
| [[#MouseLifo]]
|}


=== MouseLifo ===
== GetButtonConfigStorageFull ==
This is "nn::hid::detail::MouseLifo". This is a RingLifo object.
Takes an input s32, a type-0x16 output buffer containing a [[#ButtonConfigFull]], a type-0x1A output buffer containing a [[#StorageName]].


{| class="wikitable" border="1"
== GetButtonConfigStorageLeft ==
|-
Takes an input s32, a type-0x16 output buffer containing a [[#ButtonConfigLeft]], a type-0x1A output buffer containing a [[#StorageName]].
! Offset
 
! Size
== GetButtonConfigStorageRight ==
! Description
Takes an input s32, a type-0x16 output buffer containing a [[#ButtonConfigRight]], a type-0x1A output buffer containing a [[#StorageName]].
|-
 
| 0x0
== SetButtonConfigStorageEmbedded ==
| 0x8
Takes an input s32, a type-0x15 input buffer containing a [[#ButtonConfigEmbedded]], a type-0x19 input buffer containing a [[#StorageName]].
| RingLifoVptr
 
|-
When the input s32 is larger than unsigned value 4, this will immediately return (this cmd always returns 0 regardless).
| 0x8
 
| 0x8
== SetButtonConfigStorageFull ==
| BufferCount
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]].
 
== Cmd1470 ==
This is exclusive to S2.
 
This is likely SetSelectorUiPresentationPolicy?
 
Takes a PID, an u8 SelectorUiPresentationPolicy, an [[AM_services|AppletResourceUserId]], no output.
 
== Cmd1471 ==
This is exclusive to S2.
 
This is likely GetSelectorUiPresentationPolicy?
 
Takes a PID, an [[AM_services|AppletResourceUserId]], returns an output u8 SelectorUiPresentationPolicy.
 
== IHidbusSystemServer ==
This is "nn::hidbus::IHidbusSystemServer".
 
This was added with [5.0.0+].
 
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
|-
| 0x10
| 500 || SetAppletResourceUserId
| 0x8
| Tail
|-
|-
| 0x18
| 501 || RegisterAppletResourceUserId
| 0x8
| Count
|-
|-
| 0x20
| 502 || UnregisterAppletResourceUserId
| 0x30 * 17
| Array of [[#MouseStateAtomicStorage]]
|}
|}


==== MouseStateAtomicStorage ====
= hid:tmp =
This is "nn::hid::detail::MouseStateAtomicStorage".
This is "nn::hid::IHidTemporaryServer".
 
This service was added with [3.0.0+], then removed with [8.0.0+].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Cmd || Name
! Size
! Description
|-
|-
| 0x0
| 0 || GetConsoleSixAxisSensorCalibrationValues
| 0x8
|}
| SamplingNumber
 
|-
= irs =
| 0x8
This is "nn::irsensor::IIrSensorServer".
| 0x28
 
| [[#MouseState]]
This was added to sdknso with 3.x.
|}


===== MouseState =====
With sdknso versions pre-4.x PointingProcessor used to be DpdProcessor. The [[#PackedPointingProcessorConfig|packed-config]] with DpdProcessor (besides RequiredMcuVersion) used to be initialized from user-specified config, now it's hard-coded.
This is "nn::hid::detail::MouseState".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Cmd || Name
! Size
! Description
|-
|-
| 0x0
| 302 || [[#ActivateIrsensor]]
| 0x8
| SamplingNumber
|-
|-
| 0x8
| 303 || [[#DeactivateIrsensor]]
| 0x4
| X
|-
|-
| 0xC
| 304 || [[#GetIrsensorSharedMemoryHandle]]
| 0x4
| Y
|-
|-
| 0x10
| 305 || [[#StopImageProcessor]]
| 0x4
| DeltaX
|-
|-
| 0x14
| 306 || [[#RunMomentProcessor]]
| 0x4
| DeltaY
|-
|-
| 0x18
| 307 || [[#RunClusteringProcessor]]
| 0x4
| WheelDeltaX
|-
|-
| 0x1C
| 308 || [[#RunImageTransferProcessor]]
| 0x4
| WheelDeltaY
|-
|-
| 0x20
| 309 || [[#GetImageTransferProcessorState]]
| 0x4
| [[#MouseButtonSet|Buttons]]
|-
|-
| 0x24
| 310 || [[#RunTeraPluginProcessor]]
| 0x4
| [[#MouseAttributeSet|Attributes]]
|}
 
== KeyboardSharedMemoryFormat ==
This is "nn::hid::detail::KeyboardSharedMemoryFormat".
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 311 || [[#GetNpadIrCameraHandle]]
! Size
|-
! Description
| 312 || [[#RunPointingProcessor]]
|-
|-
| 0x0
| 313 || [[#SuspendImageProcessor]]
| 0x3D8
| [[#KeyboardLifo]]
|}
 
=== KeyboardLifo ===
This is "nn::hid::detail::KeyboardLifo". This is a RingLifo object.
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 314 || [3.0.0+] [[#CheckFirmwareVersion]]
! Size
! Description
|-
|-
| 0x0
| 315 || [4.0.0+] [[#SetFunctionLevel]]
| 0x8
| RingLifoVptr
|-
|-
| 0x8
| 316 || [4.0.0+] [[#RunImageTransferExProcessor]]
| 0x8
| BufferCount
|-
|-
| 0x10
| 317 || [4.0.0+] [[#RunIrLedProcessor]]
| 0x8
| Tail
|-
|-
| 0x18
| 318 || [4.0.0+] [[#StopImageProcessorAsync]]
| 0x8
| Count
|-
|-
| 0x20
| 319 || [4.0.0+] [[#ActivateIrsensorWithFunctionLevel]]
| 0x38 * 17
| Array of [[#KeyboardStateAtomicStorage]]
|}
|}


==== KeyboardStateAtomicStorage ====
== ActivateIrsensor ==
This is "nn::hid::detail::KeyboardStateAtomicStorage".
Takes a PID-descriptor and an [[AM_services|AppletResourceUserId]]. No output.
 
== DeactivateIrsensor ==
Takes a PID-descriptor and an [[AM_services|AppletResourceUserId]]. No output.
 
== GetIrsensorSharedMemoryHandle ==
Takes a PID-descriptor and an [[AM_services|AppletResourceUserId]]. Returns a SharedMemory handle.
 
The SharedMemory is "nn::irsensor::detail::StatusManager". It's mapped with permission read-only and size 0x8000.
 
It's structure is as follows:


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Offset || Size || Description
! Size
! Description
|-
|-
| 0x0
| 0x0 || 0x7FB0 || Array of [[#DeviceFormat]]
| 0x8
| SamplingNumber
|-
|-
| 0x8
| 0x7FB0 || 0x50 || Array of [[#AruidFormat]]
| 0x30
| [[#KeyboardState]]
|}
|}


===== KeyboardState =====
The array of [[#DeviceFormat]] is indexed by [[#IrCameraHandle|PlayerNumber]] and can hold up to 9 entries. The array of [[#AruidFormat]] can only hold up to 5 entries.
This is "nn::hid::detail::KeyboardState".


=== DeviceFormat ===
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Offset || Size || Description
! Size
|-
! Description
| 0x0 || 0x4 || [[#IrCameraStatus]]
|-
|-
| 0x0
| 0x4 || 0x4 || [[#IrCameraInternalStatus]]
| 0x8
| SamplingNumber
|-
|-
| 0x8
| 0x8 || 0x8 || [[#IrSensorMode]]
| 0x8
| [[#KeyboardModifierSet|Modifiers]]
|-
|-
| 0x10
| 0x10 || 0xE20 || [[#ProcessorStateRingLifo]]
| 0x20
| [[#KeyboardKeySet|Keys]]
|}
|}


== BasicXpadSharedMemoryFormat ==
==== ProcessorStateRingLifo ====
This is "nn::hid::detail::BasicXpadSharedMemoryFormat".
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).


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Offset || Size || Description
! Size
|-
! Description
| 0x0 || 0x8 || Start
|-
| 0x8 || 0x4 || Count
|-
| 0xC || 0x4 || Padding
|-
|-
| 0x0
| 0x10 || Variable || ProcessorState
| 0x400 * 4
| Array of [[#BasicXpadSharedMemoryEntry]]
|}
|}


=== BasicXpadSharedMemoryEntry ===
The maximum element count is 6 for [[#PointingProcessorMarkerState]] or 5 for any of the other states.
This is "nn::hid::detail::BasicXpadSharedMemoryEntry".
 
ProcessorState is specialized depending on the value of [[#IrSensorMode]].
 
===== MomentProcessorState =====
This is "nn::irsensor::MomentProcessorState".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Offset || Size || Description
! Size
|-
! Description
| 0x0 || 0x8 || SamplingNumber
|-
| 0x8 || 0x8 || TimeStamp
|-
| 0x10 || 0x4 || AmbientNoiseLevel
|-
| 0x14 || 0x4 || Reserved
|-
|-
| 0x0
| 0x18 || 0x240 || Array of [[#MomentStatistic]]
| 0x2C8
| [[#BasicXpadLifo]]
|}
|}


==== BasicXpadLifo ====
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.
This is "nn::hid::detail::BasicXpadLifo". This is a RingLifo object.
 
====== MomentStatistic ======
In sdknso GetMomentProcessorStates, this loops through each MomentProcessorState->MomentStatistic entry: <code>AverageIntensity *= scale;</code> The scale is calculated with: <code>scale = 76800.0f / (float)([[#PackedMomentProcessorConfig|WindowOfInterest]].width * [[#PackedMomentProcessorConfig|WindowOfInterest]].height);</code> Note that <code>76800 == 320*240</code>, hence with the default width/height the calculated scale is 1.0f.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Offset || Size || Description
! Size
! Description
|-
|-
| 0x0
| 0x0 || 0x4 || float AverageIntensity
| 0x8
| RingLifoVptr
|-
|-
| 0x8
| 0x4 || 0x4 || float CentroidX
| 0x8
| BufferCount
|-
|-
| 0x10
| 0x8 || 0x4 || float CentroidY
| 0x8
| Tail
|-
| 0x18
| 0x8
| Count
|-
| 0x20
| 0x28 * 17
| Array of [[#BasicXpadStateAtomicStorage]]
|}
|}


===== BasicXpadStateAtomicStorage =====
===== ClusteringProcessorState =====
This is "nn::hid::detail::BasicXpadStateAtomicStorage".
This is "nn::irsensor::ClusteringProcessorState".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Offset || Size || Description
! Size
|-
! Description
| 0x0 || 0x8 || SamplingNumber
|-
|-
| 0x0
| 0x8 || 0x8 || TimeStamp
| 0x8
| SamplingNumber
|-
|-
| 0x8
| 0x10 || 0x1 || ObjectCount
| 0x20
|-
| [[#BasicXpadState]]
| 0x11 || 0x3 || Reserved
|-
| 0x14 || 0x4 || AmbientNoiseLevel
|-
| 0x18 || 0x180 || Array of [[#ClusteringData]]
|}
|}


====== BasicXpadState ======
The array of [[#ClusteringData]] can hold up to 16 entries.
This is "nn::hid::detail::BasicXpadState".


====== ClusteringData ======
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Offset || Size || Description
! Size
|-
! Description
| 0x0 || 0x4 || float AverageIntensity
|-
|-
| 0x0
| 0x4 || 0x4 || float CentroidX
| 0x8
| SamplingNumber
|-
|-
| 0x8
| 0x8 || 0x4 || float CentroidY
| 0x4
| [[#BasicXpadAttributeSet|Attributes]]
|-
|-
| 0xC
| 0xC || 0x4 || PixelCount
| 0x4
| [[#BasicXpadButtonSet|Buttons]]
|-
|-
| 0x10
| 0x10 || 0x2 || BoundX
| 0x8
| [[#AnalogStickState|AnalogStickL]]
|-
|-
| 0x18
| 0x12 || 0x2 || BoundY
| 0x8
| [[#AnalogStickState|AnalogStickR]]
|}
 
== DigitizerSharedMemoryFormat ==
This is "nn::hid::server::DigitizerSharedMemoryFormat".
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 0x14 || 0x2 || BoundtWidth
! Size
! Description
|-
|-
| 0x0
| 0x16 || 0x2 || BoundHeight
| 0x680
| [[#DigitizerLifo]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Offset || Size || Description
! Size
|-
! Description
| 0x0 || 0x8 || SamplingNumber
|-
|-
| 0x0
| 0x8 || 0x8 || TimeStamp
| 0x8
| RingLifoVptr
|-
|-
| 0x8
| 0x10 || 0x1 || PointingStatus
| 0x8
| BufferCount
|-
|-
| 0x10
| 0x11 || 0x3 || Reserved
| 0x8
| Tail
|-
|-
| 0x18
| 0x14 || 0x4 || Unknown
| 0x8
| Count
|-
|-
| 0x20
| 0x18 || 0x4 || float Unknown
| 0x60 * 17
| Array of [[#DigitizerStateAtomicStorage]]
|}
 
==== DigitizerStateAtomicStorage ====
This is "nn::hid::server::DigitizerStateAtomicStorage".
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 0x1C || 0x4 || float PositionX
! Size
! Description
|-
|-
| 0x0
| 0x20 || 0x4 || float PositionY
| 0x8
| SamplingNumber
|-
|-
| 0x8
| 0x24 || 0x4 || float Unknown
| 0x58
| [[#DigitizerState]]
|}
 
===== DigitizerState =====
This is "nn::hid::DigitizerState".
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 0x28 || 0x2 || WindowOfInterestX
! Size
! Description
|-
|-
| 0x0
| 0x2A || 0x2 || WindowOfInterestY
| 0x8
| SamplingNumber
|-
|-
| 0x8
| 0x2C || 0x2 || WindowOfInterestWidth
| 0x4
|-
|  
| 0x2E || 0x2 || WindowOfInterestHeight
|-
|-
| 0xC
| 0x30 || 0x1 || PointingStatus
| 0x4
|  
|-
|-
| 0x10
| 0x31 || 0x3 || Reserved
| 0x4
| [[#DigitizerAttributeSet|Attributes]]
|-
|-
| 0x14
| 0x34 || 0x4 || Unknown
| 0x4
| [[#DigitizerButtonSet|Buttons]]
|-
|-
| 0x18
| 0x38 || 0x4 || float Unknown
| 0x4
|  
|-
|-
| 0x1C
| 0x3C || 0x4 || float PositionX
| 0x4
|  
|-
|-
| 0x20
| 0x40 || 0x4 || float PositionY
| 0x4
|  
|-
|-
| 0x24
| 0x44 || 0x4 || float Unknown
| 0x4
|  
|-
|-
| 0x28
| 0x48 || 0x2 || WindowOfInterestX
| 0x4
|  
|-
|-
| 0x2C
| 0x4A || 0x2 || WindowOfInterestY
| 0x4
|  
|-
|-
| 0x30
| 0x4C || 0x2 || WindowOfInterestWidth
| 0x4
|  
|-
|-
| 0x34
| 0x4E || 0x2 || WindowOfInterestHeight
| 0x4
|  
|-
|-
| 0x38
| 0x50 || 0x1 || PointingStatus
| 0x4
|  
|-
|-
| 0x3C
| 0x51 || 0x3 || Reserved
| 0x4
|  
|-
|-
| 0x40
| 0x54 || 0x4 || Unknown
| 0x4
|-
|  
| 0x58 || 0x4 || float Unknown
|-
| 0x5C || 0x4 || float PositionX
|-
| 0x60 || 0x4 || float PositionY
|-
|-
| 0x44
| 0x64 || 0x4 || float Unknown
| 0x4
|  
|-
|-
| 0x48
| 0x68 || 0x2 || WindowOfInterestX
| 0x4
|  
|-
|-
| 0x4C
| 0x6A || 0x2 || WindowOfInterestY
| 0x4
|  
|-
|-
| 0x50
| 0x6C || 0x2 || WindowOfInterestWidth
| 0x4
|  
|-
|-
| 0x54
| 0x6E || 0x2 || WindowOfInterestHeight
| 0x4
|  
|}
|}


== HomeButtonSharedMemoryFormat ==
===== PointingProcessorState =====
This is "nn::hid::detail::HomeButtonSharedMemoryFormat".
This is "nn::irsensor::PointingProcessorState".
 
This is created from [[#PointingProcessorMarkerState]].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Offset || Size || Description
! Size
|-
! Description
| 0x0 || 0x8 || SamplingNumber
|-
| 0x8 || 0x8 || TimeStamp
|-
| 0x10 || 0x4 || PointingStatus
|-
| 0x14 || 0x4 || float PositionX
|-
| 0x18 || 0x4 || float PositionY
|-
|-
| 0x0
| 0x1C || 0x4 || Reserved
| 0x1B8
| [[#HomeButtonLifo]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Offset || Size || Description
! Size
! Description
|-
|-
| 0x0
| 0x0 || 0x8 || SamplingNumber
| 0x8
| RingLifoVptr
|-
|-
| 0x8
| 0x8 || 0x8 || TimeStamp
| 0x8
| BufferCount
|-
|-
| 0x10
| 0x10 || 0x4 || AmbientNoiseLevel
| 0x8
| Tail
|-
|-
| 0x18
| 0x14 || 0x12C || PluginData
| 0x8
| Count
|-
| 0x20
| 0x18 * 17
| Array of [[#HomeButtonStateAtomicStorage]]
|}
|}


==== HomeButtonStateAtomicStorage ====
===== AdaptiveClusteringProcessorState =====
This is "nn::hid::detail::HomeButtonStateAtomicStorage".
This is "nn::irsensor::AdaptiveClusteringProcessorState".
 
This is created from [[#TeraPluginProcessorState]].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Offset || Size || Description
! Size
|-
! Description
| 0x0 || 0x8 || SamplingNumber
|-
| 0x8 || 0x8 || TimeStamp
|-
| 0x10 || 0x4 || AmbientNoiseLevel
|-
| 0x14 || 0x4 || AccuracyLevel
|-
| 0x18 || 0x1 || ObjectCount
|-
| 0x19 || 0x1 || BackgroundIntensity
|-
|-
| 0x0
| 0x1A || 0x6 || Reserved
| 0x8
| SamplingNumber
|-
|-
| 0x8
| 0x20 || 0x200 || Array of [[#AdaptiveClusteringData]]
| 0x10
| [[#HomeButtonState]]
|}
|}


===== HomeButtonState =====
The array of [[#AdaptiveClusteringData]] can hold up to 16 entries.
This is "nn::hid::system::HomeButtonState".


====== AdaptiveClusteringData ======
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Offset || Size || Description
! Size
|-
! Description
| 0x0 || 0x4 || float CentroidX
|-
| 0x4 || 0x4 || float CentroidY
|-
|-
| 0x0
| 0x8 || 0x4 || float Area
| 0x8
| SamplingNumber
|-
|-
| 0x8
| 0xC || 0x4 || IsIncomplete
| 0x8
| [[#HomeButtonSet|Buttons]]
|}
|}


== SleepButtonSharedMemoryFormat ==
===== HandAnalysisImageState =====
This is "nn::hid::detail::SleepButtonSharedMemoryFormat".
This is "nn::irsensor::HandAnalysisImageState".
 
This is created from [[#TeraPluginProcessorState]].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Offset || Size || Description
! Size
|-
! Description
| 0x0 || 0x8 || SamplingNumber
|-
| 0x8 || 0x4 || AmbientNoiseLevel
|-
| 0xC || 0x960 || Image
|-
|-
| 0x0
| 0x96C || 0x4 || Reserved
| 0x1B8
| [[#SleepButtonLifo]]
|}
|}


=== SleepButtonLifo ===
===== HandAnalysisSilhouetteState =====
This is "nn::hid::detail::SleepButtonLifo". This is a RingLifo object.
This is "nn::irsensor::HandAnalysisSilhouetteState".
 
This is created from [[#TeraPluginProcessorState]].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Offset || Size || Description
! Size
! Description
|-
|-
| 0x0
| 0x0 || 0x8 || SamplingNumber
| 0x8
| RingLifoVptr
|-
|-
| 0x8
| 0x8 || 0x4 || AmbientNoiseLevel
| 0x8
| BufferCount
|-
|-
| 0x10
| 0xC || 0x1354 || Unknown
| 0x8
|}
| Tail
 
|-
===== HandAnalysisSilhouetteStateWithFullFrameShape =====
| 0x18
This is "nn::irsensor::HandAnalysisSilhouetteStateWithFullFrameShape".
| 0x8
| Count
|-
| 0x20
| 0x18 * 17
| Array of [[#SleepButtonStateAtomicStorage]]
|}


==== SleepButtonStateAtomicStorage ====
This is created from [[#TeraPluginProcessorState]].
This is "nn::hid::detail::SleepButtonStateAtomicStorage".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Offset || Size || Description
! Size
|-
! Description
| 0x0 || 0x8 || SamplingNumber
|-
|-
| 0x0
| 0x8 || 0x4 || AmbientNoiseLevel
| 0x8
| SamplingNumber
|-
|-
| 0x8
| 0xC || 0x156C || Unknown
| 0x10
| [[#SleepButtonState]]
|}
|}


===== SleepButtonState =====
=== AruidFormat ===
This is "nn::hid::system::SleepButtonState".
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Offset || Size || Description
! Size
! Description
|-
|-
| 0x0
| 0x0 || 0x8 || IrSensorAruid
| 0x8
| SamplingNumber
|-
|-
| 0x8
| 0x8 || 0x8 || IrSensorAruidStatus
| 0x8
| [[#SleepButtonSet|Buttons]]
|}
|}


== CaptureButtonSharedMemoryFormat ==
== StopImageProcessor ==
This is "nn::hid::detail::CaptureButtonSharedMemoryFormat".
Takes a PID-descriptor, an [[#IrCameraHandle]], and an [[AM_services|AppletResourceUserId]]. No output.
 
== RunMomentProcessor ==
Takes a PID-descriptor, an [[#IrCameraHandle]], an [[AM_services|AppletResourceUserId]], and a [[#PackedMomentProcessorConfig]]. No output.


{| class="wikitable" border="1"
== RunClusteringProcessor ==
|-
Takes a PID-descriptor, an [[#IrCameraHandle]], an [[AM_services|AppletResourceUserId]], and a [[#PackedClusteringProcessorConfig]]. No output.
! Offset
! Size
! Description
|-
| 0x0
| 0x1B8
| [[#CaptureButtonLifo]]
|}


=== CaptureButtonLifo ===
== RunImageTransferProcessor ==
This is "nn::hid::detail::CaptureButtonLifo". This is a RingLifo object.
Takes a PID-descriptor, an [[#IrCameraHandle]], an [[AM_services|AppletResourceUserId]], a [[#PackedImageTransferProcessorConfig]], an u64 for the TransferMemory's size, and a TransferMemory handle. No output.


{| class="wikitable" border="1"
The TransferMemory is created with an user specified buffer and permission none.
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| RingLifoVptr
|-
| 0x8
| 0x8
| BufferCount
|-
| 0x10
| 0x8
| Tail
|-
| 0x18
| 0x8
| Count
|-
| 0x20
| 0x18 * 17
| Array of [[#CaptureButtonStateAtomicStorage]]
|}


==== CaptureButtonStateAtomicStorage ====
== GetImageTransferProcessorState ==
This is "nn::hid::detail::CaptureButtonStateAtomicStorage".
Takes a PID-descriptor, a type-0x6 output buffer, an [[#IrCameraHandle]], and an [[AM_services|AppletResourceUserId]]. Returns an [[#ImageTransferProcessorState]]. No output.


{| class="wikitable" border="1"
== RunTeraPluginProcessor==
|-
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedTeraPluginProcessorConfig]] (immediately after the previous word), and an [[AM_services|AppletResourceUserId]]. No output.
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| SamplingNumber
|-
| 0x8
| 0x10
| [[#CaptureButtonState]]
|}


===== CaptureButtonState =====
== GetNpadIrCameraHandle ==
This is "nn::hid::system::CaptureButtonState".
Takes an input [[#NpadIdType]]. Returns an output [[#IrCameraHandle]].
 
== RunPointingProcessor ==
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedPointingProcessorConfig]] (immediately after the previous word), and an [[AM_services|AppletResourceUserId]]. No output.
 
== SuspendImageProcessor ==
Takes a PID-descriptor, an [[#IrCameraHandle]], and an [[AM_services|AppletResourceUserId]]. No output.
 
sdknso uses this from the Run*Processor funcs to suspend the current Processor when the current [[#PackedFunctionLevel|FunctionLevel]] is >= 0x1, prior to starting another Processor if needed (depending on  what Processor was already active via a state field). Hence, this cmd is only used with [4.0.0+].
 
== CheckFirmwareVersion ==
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedMcuVersion]], and an [[AM_services|AppletResourceUserId]]. No output.
 
sdknso didn't actually use this until 4.x (the RequiredMcuVersion was also updated with that version).
 
== SetFunctionLevel ==
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedFunctionLevel]], and an [[AM_services|AppletResourceUserId]]. No output.
 
== RunImageTransferExProcessor ==
Takes a PID-descriptor, an [[#IrCameraHandle]], an [[AM_services|AppletResourceUserId]], a [[#PackedImageTransferProcessorExConfig]], an u64 for the TransferMemory's size, and a TransferMemory handle. No output.
 
The TransferMemory is created with an user specified buffer and permission none.
 
== RunIrLedProcessor ==
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedIrLedProcessorConfig]] (immediately after the previous word), and an [[AM_services|AppletResourceUserId]]. No output.
 
== StopImageProcessorAsync ==
Takes a PID-descriptor, an [[#IrCameraHandle]], and an [[AM_services|AppletResourceUserId]]. No output.
 
== ActivateIrsensorWithFunctionLevel ==
Takes a PID-descriptor, an [[#PackedFunctionLevel]], and an [[AM_services|AppletResourceUserId]]. No output.
 
= irs:sys =
This is "nn::irsensor::IIrSensorSystemServer".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Cmd || Name
! Size
|-
! Description
| 500 || [[#SetAppletResourceUserId]]
|-
| 501 || [[#RegisterAppletResourceUserId]]
|-
|-
| 0x0
| 502 || [[#UnregisterAppletResourceUserId]]
| 0x8
| SamplingNumber
|-
|-
| 0x8
| 503 || [[#EnableAppletToGetInput]]
| 0x8
| [[#CaptureButtonSet|Buttons]]
|}
|}


== InputDetectorSharedMemoryFormat ==
== SetAppletResourceUserId ==
This is "nn::hid::detail::InputDetectorSharedMemoryFormat".
Takes an [[AM_services|AppletResourceUserId]]. No output.


{| class="wikitable" border="1"
== RegisterAppletResourceUserId ==
|-
Takes a bool and an [[AM_services|AppletResourceUserId]]. No output.
! Offset
 
! Size
== UnregisterAppletResourceUserId ==
! Description
Takes an [[AM_services|AppletResourceUserId]]. No output.
|-
 
| 0x0
== EnableAppletToGetInput ==
| 0x80 * 16
Takes a bool and an [[AM_services|AppletResourceUserId]]. No output.
| Array of [[#InputDetectorSharedMemoryEntry]]
|}


=== InputDetectorSharedMemoryEntry ===
= ahid:cd =
This is "nn::hid::detail::InputDetectorSharedMemoryEntry".
This is "nn::ahid::IServerSession".


{| class="wikitable" border="1"
Used for USB HID devices.
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x50
| [[#InputDetectorLifo]]
|}


==== InputDetectorLifo ====
This service no longer exists in [9.0.0+].
This is "nn::hid::detail::InputDetectorLifo". This is a RingLifo object.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Cmd || Name
! Size
! Description
|-
|-
| 0x0
| 0 || [[#AcquireDevice]]
| 0x8
| RingLifoVptr
|-
|-
| 0x8
| 1 || [[#ReleaseDevice]]
| 0x8
| BufferCount
|-
|-
| 0x10
| 2 || [[#GetCtrlSession]]
| 0x8
| Tail
|-
|-
| 0x18
| 3 || [[#GetReadSession]]
| 0x8
| Count
|-
|-
| 0x20
| 4 || [1.0.0-2.3.0] [[#GetWriteSession]]
| 0x18 * 2
| Array of [[#InputDetectorStateAtomicStorage]]
|}
|}


===== InputDetectorStateAtomicStorage =====
== AcquireDevice ==
This is "nn::hid::detail::InputDetectorStateAtomicStorage".
Takes an input s32, no output.
 
== ReleaseDevice ==
Takes an input s32, no output.


{| class="wikitable" border="1"
== GetCtrlSession ==
|-
Takes an input u32, returns an [[#ICtrlSession]].
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| SamplingNumber
|-
| 0x8
| 0x10
| [[#InputDetectorState]]
|}


====== InputDetectorState ======
== GetReadSession ==
This is "nn::hid::detail::InputDetectorState".
Takes an input u32, returns an [[#IReadSession]].


{| class="wikitable" border="1"
== GetWriteSession ==
|-
Takes an input u32, returns an [[#IWriteSession]].
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| [[#InputSourceState|InputSourceState]]
|-
| 0x8
| 0x8
| SamplingNumber
|}


== UniquePadSharedMemoryFormat ==
== ICtrlSession ==
This is "nn::hid::detail::UniquePadSharedMemoryFormat".
This is "nn::ahid::ICtrlSession".


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Cmd || Name
! Size
|-
! Description
| 0 || GetString
|-
|-
| 0x0
| 1 || GetCodeBook
| 0x400 * 16
|-
| Array of [[#UniquePadSharedMemoryEntry]]
| 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
|}
|}


== UniquePadSharedMemoryEntry ==
All of these use USB [[USB_services|CtrlXfer]], except for GetStateChangeEvent and SignalStateChangeEvent, and GetCodeBook which copies 0x4000-bytes from state to output.
This is "nn::hid::detail::UniquePadSharedMemoryEntry".
 
== IReadSession ==
This is "nn::ahid::IReadSession".
 
This no longer exists in [9.0.0+].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Cmd || Name
! Size
! Description
|-
|-
| 0x0
| 0 || [[#Read]]
| 0x1E0
| [[#UniquePadLifo]]
|}
|}


=== UniquePadLifo ===
=== Read ===
This is "nn::hid::detail::UniquePadLifo". This is a RingLifo object.
Uses [[USB_services|PostBufferAsync]] etc with the INPUT endpoint. The size must be <=0x1000. The actual transfer size is returned in an output u64. The data is copied from the tmpbuf to the output buffer using the actual-transfer-size.
 
[3.0.0+] Now takes a total of 8-bytes of input.
 
== IWriteSession ==
This is "nn::ahid::IWriteSession".
 
This was removed with [3.0.0+].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Cmd || Name
! Size
! Description
|-
|-
| 0x0
| 0 || [[#Write]]
| 0x80
| [[#UniquePadConfigLifo]]
|-
| 0x80
| 0x70 * 2
| Array of [[#AnalogStickCalibrationStateImplLifo]]
|-
| 0x160
| 0x40
| [[#SixAxisSensorUserCalibrationStateLifo]]
|-
| 0x1A0
| 0x40
| UniquePadConfigMutex
|}
|}


==== UniquePadConfigLifo ====
=== Write ===
This is "nn::hid::detail::UniquePadConfigLifo". This is a RingLifo object.
This is the inverse of [[#IReadSession]] cmd0. Uses the OUTPUT endpoint with an input buffer.
 
= ahid:hdr =
This is "nn::ahid::hdr::ISession".
 
Used internally for USB HID devices.
 
This service no longer exists in [9.0.0+].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Cmd || Name
! Size
|-
! Description
| 0 || GetDeviceEntries
|-
|-
| 0x0
| 1 || GetDeviceList
| 0x8
| RingLifoVptr
|-
|-
| 0x8
| 2 || GetDeviceParameters
| 0x8
| BufferCount
|-
|-
| 0x10
| 3 || AttachDevice
| 0x8
| Tail
|-
|-
| 0x18
| 4 || DetachDevice
| 0x8
| Count
|-
|-
| 0x20
| 5 || [6.0.0+] SetDeviceFilter
| 0x30 * 2
| Array of [[#UniquePadConfigAtomicStorage]]
|}
|}


===== UniquePadConfigAtomicStorage =====
= xcd:sys =
This is "nn::hid::detail::UniquePadConfigAtomicStorage".
This is "nn::xcd::detail::ISystemServer".
 
This was removed with [19.0.0+].  


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Cmd || Name
! Size
|-
! Description
| 0 || [[#GetDataFormat]]
|-
|-
| 0x0
| 1 || [[#SetDataFormat]]
| 0x8
| SamplingNumber
|-
|-
| 0x8
| 2 || [[#GetMcuState]]
| 0x28
| [[#UniquePadConfig]]
|}
 
====== UniquePadConfig ======
This is "nn::hid::detail::UniquePadConfig".
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 3 || [[#SetMcuState]]
! Size
! Description
|-
|-
| 0x0
| 4 || [[#GetMcuVersionForNfc]]
| 0x4
| [[#UniquePadType|Type]]
|-
|-
| 0x4
| 5 || [[#CheckNfcDevicePower]]
| 0x4
| [[#UniquePadInterface|Interface]]
|-
|-
| 0x8
| 6 || [5.0.0+] [[#SetMcuStateImmediate]]
| 0x10
| [[#UniquePadSerialNumber|SerialNumber]]
|-
|-
| 0x18
| 10 || [[#SetNfcEvent]]
| 0x4
| ControllerNumber
|-
|-
| 0x1C
| 11 || [[#GetNfcInfo]]
| 0x1
| IsActive
|-
|-
| 0x1D
| 12 || StartNfcDiscovery
| 0x3
| Reserved
|-
|-
| 0x20
| 13 || StopNfcDiscovery
| 0x8
| SamplingNumber
|}
 
==== AnalogStickCalibrationStateImplLifo ====
This is "nn::hid::detail::AnalogStickCalibrationStateImplLifo". This is a RingLifo object.
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 14 || StartNtagRead
! Size
! Description
|-
|-
| 0x0
| 15 || StartNtagWrite
| 0x8
| RingLifoVptr
|-
|-
| 0x8
| 16 || SendNfcRawData
| 0x8
| BufferCount
|-
|-
| 0x10
| 17 || RegisterMifareKey
| 0x8
|-
| Tail
| 18 || ClearMifareKey
|-
| 19 || StartMifareRead
|-
|-
| 0x18
| 20 || StartMifareWrite
| 0x8
| Count
|-
|-
| 0x20
| 101 || GetAwakeTriggerReasonForLeftRail
| 0x28 * 2
| Array of [[#AnalogStickCalibrationStateImplAtomicStorage]]
|}
 
===== AnalogStickCalibrationStateImplAtomicStorage =====
This is "nn::hid::detail::AnalogStickCalibrationStateImplAtomicStorage".
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 102 || GetAwakeTriggerReasonForRightRail
! Size
! Description
|-
|-
| 0x0
| 103 || [10.0.0+] GetAwakeTriggerBatteryLevelTransitionForLeftRail
| 0x8
| SamplingNumber
|-
|-
| 0x8
| 104 || [10.0.0+] GetAwakeTriggerBatteryLevelTransitionForRightRail
| 0x20
| [[#AnalogStickCalibrationStateImpl]]
|}
|}


====== AnalogStickCalibrationStateImpl ======
[5.0.0+] SetDataFormat, SetMcuState, and ClearMifareKey: now takes a total of 0xC-bytes of input instead of 0x10.
This is "nn::hid::detail::AnalogStickCalibrationStateImpl".
 
== 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.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Cmd || Name
! Size
! Description
|-
|-
| 0x0
| 1 || [[#GetBusHandle]]
| 0x8
|-
| [[#AnalogStickState|State]]
| 2 || [[#IsExternalDeviceConnected]]
|-
| 3 || [[#Initialize]]
|-
| 4 || [[#Finalize]]
|-
| 5 || [[#EnableExternalDevice]]
|-
|-
| 0x8
| 6 || [[#GetExternalDeviceId]]
| 0x8
| [[#AnalogStickCalibrationFlagsSet|Flags]]
|-
|-
| 0x10
| 7 || [[#SendCommandAsync]]
| 0x8
| [[#AnalogStickManualCalibrationStage|Stage]]
|-
|-
| 0x18
| 8 || [[#GetSendCommandAsynceResult]]
| 0x8
| SamplingNumber
|}
 
==== SixAxisSensorUserCalibrationStateLifo ====
This is "nn::hid::detail::SixAxisSensorUserCalibrationStateLifo". This is a RingLifo object.
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 9 || [[#SetEventForSendCommandAsycResult]]
! Size
! Description
|-
|-
| 0x0
| 10 || [[#GetSharedMemoryHandle]]
| 0x8
| RingLifoVptr
|-
|-
| 0x8
| 11 || [[#EnableJoyPollingReceiveMode]]
| 0x8
| BufferCount
|-
|-
| 0x10
| 12 || [[#DisableJoyPollingReceiveMode]]
| 0x8
| Tail
|-
|-
| 0x18
| 13 || [5.0.0-6.2.0] GetPollingData
| 0x8
| Count
|-
|-
| 0x20
| 14 || [6.0.0+] [[#SetStatusManagerType]]
| 0x20 * 2
| Array of [[#SixAxisSensorUserCalibrationStateAtomicStorage]]
|}
|}


===== SixAxisSensorUserCalibrationStateAtomicStorage =====
sdknso doesn't use the GetPollingData cmd.
This is "nn::hid::detail::SixAxisSensorUserCalibrationStateAtomicStorage".


{| class="wikitable" border="1"
== GetBusHandle ==
|-
Takes an input u32 [[#NpadIdType]], an u64 [[#BusType]] and an u64 [[AM_services|AppletResourceUserId]]. Returns an output bool '''HasHandle''' and a [[#BusHandle]].
! Offset
 
! Size
'''HasHandle''' indicates whether the [[#BusHandle]] is valid.
! Description
 
|-
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.
| 0x0
| 0x8
| SamplingNumber
|-
| 0x8
| 0x18
| [[#SixAxisSensorUserCalibrationState]]
|}


====== SixAxisSensorUserCalibrationState ======
This cmd will throw an error when [[#BusType]] is invalid.
This is "nn::hid::detail::UniquePadConfig".


{| class="wikitable" border="1"
== IsExternalDeviceConnected ==
|-
Takes an input [[#BusHandle]]. Returns an output bool '''IsAttached'''.
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| [[#SixAxisSensorUserCalibrationFlagsSet|Flags]]
|-
| 0x4
| 0x4
| Reserved
|-
| 0x8
| 0x8
| [[#SixAxisSensorUserCalibrationStage|Stage]]
|-
| 0x10
| 0x8
| SamplingNumber
|}


== NpadSharedMemoryFormat ==
This is not used by sdknso.
This is "nn::hid::detail::NpadSharedMemoryFormat".


{| class="wikitable" border="1"
== Initialize ==
|-
Takes an input [[#BusHandle]] and an u64 [[AM_services|AppletResourceUserId]]. No output.
! Offset
! Size
! Description
|-
| 0x0
| 0x5000 * 10
| Array of [[#NpadSharedMemoryEntry]]
|}


Each entry describes an available controller:
Prior to using this cmd, sdknso handles [[#GetSharedMemoryHandle|sharedmem]] mapping if not done previously.
{| class="wikitable" border="1"
 
== Finalize ==
Takes an input [[#BusHandle]] and an u64 [[AM_services|AppletResourceUserId]]. No output.
 
== EnableExternalDevice ==
Takes an input bool '''IsEnabled''', a [[#BusHandle]], an u64 '''Version''' and an u64 [[AM_services|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 [[#SetStatusManagerType|[6.0.0+]]]) entries, with entry-count {max [[#GetBusHandle|BusHandles]]}.
 
sdknso only uses the first 0x10-bytes of these entries, the rest is the ignored. Entry structure:
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x1 || IsConnected
|-
| 0x1 || 0x3 || Reserved
|-
| 0x4 || 0x4 || IsConnectedResult
|-
|-
! Entry
| 0x8 || 0x1 || IsEnabled. Bool flag indicating whether a device is [[#EnableExternalDevice|enabled]].
! Description
|-
| 0x9 || 0x1 || IsInFocus. Bool flag indicating whether this entry is valid.
|-
|-
| 0 to 7
| 0xA || 0x1 || IsPollingMode. Bool flag indicating whether polling is [[#EnableJoyPollingReceiveMode|enabled]].
| Players 1 to 8
|-
|-
| 8
| 0xB || 0x1 || Reserved
| Handheld Mode
|-
|-
| 9
| 0xC || 0x4 || [[#JoyPollingMode|PollingMode]]
| Other
|}
|}


== NpadSharedMemoryEntry ==
== EnableJoyPollingReceiveMode ==
This is "nn::hid::detail::NpadSharedMemoryEntry".
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):


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Offset || Size || Description
! Size
! Description
|-
|-
| 0x0
| 0x0 || 0x4 || Result.
| 0x43F0 ([1.0.0-8.1.0] 0x4410)
|-
| [[#NpadInternalState]]
| 0x0 || 0x4 || Padding.
|-
| 0x8 || 0x18 || Initialized sysmodule-side, not used by sdknso.
|-
| 0x20 || 0x8 || Latest entry.
|-
| 0x28 || 0x8 || Total entries.
|}
|}


=== NpadInternalState ===
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:
This is "nn::hid::detail::NpadInternalState".
 
DisableSixAxisPollingDataAccessor:


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Offset || Size || Description
! Size
! Description
|-
|-
| 0x0
| 0x0 || 0x26 || Data
| 0x4
| [[#NpadStyleSet|StyleSet]]
|-
|-
| 0x4
| 0x26 || 0x1 || Size of data.
| 0x4
| [[#NpadJoyAssignmentMode|JoyAssignmentMode]]
|-
|-
| 0x8
| 0x27 || 0x1 || Padding
| 0xC
| [[#NpadFullKeyColorState|FullKeyColor]]
|-
|-
| 0x14
| 0x28 || 0x8 || Timestamp
| 0x14
|}
| [[#NpadJoyColorState|JoyColor]]
 
JoyEnableSixAxisPollingDataAccessor:
 
{| class="wikitable" border="1"
|-
|-
| 0x28
! Offset || Size || Description
| 0x350
| [[#NpadFullKeyLifo|FullKeyLifo]]
|-
|-
| 0x378
| 0x0 || 0x8 || Data
| 0x350
| [[#NpadHandheldLifo|HandheldLifo]]
|-
|-
| 0x6C8
| 0x8 || 0x1 || Size of data.
| 0x350
| [[#NpadJoyDualLifo|JoyDualLifo]]
|-
|-
| 0xA18
| 0x9 || 0x7 || Padding
| 0x350
| [[#NpadJoyLeftLifo|JoyLeftLifo]]
|-
|-
| 0xD68
| 0x10 || 0x8 || Timestamp
| 0x350
|}
| [[#NpadJoyRightLifo|JoyRightLifo]]
 
JoyButtonOnlyPollingDataAccessor:
 
{| class="wikitable" border="1"
|-
|-
| 0x10B8
! Offset || Size || Description
| 0x350
| [[#NpadPalmaLifo|PalmaLifo]] ([1.0.0-3.0.2] [[#NpadSystemLifo|SystemLifo]])
|-
|-
| 0x1408
| 0x0 || 0x2C || Data
| 0x350
| [[#NpadSystemExtLifo|SystemExtLifo]] ([4.0.0+] also used for NpadSystem)
|-
|-
| 0x1758
| 0x2C || 0x1 || Size of data.
| 0x708
| [[#NpadSixAxisSensorLifo|FullKeySixAxisSensorLifo]]
|-
|-
| 0x1E60
| 0x2D || 0x3 || Padding
| 0x708
| [[#NpadSixAxisSensorLifo|HandheldSixAxisSensorLifo]]
|-
|-
| 0x2568
| 0x30 || 0x8 || Timestamp
| 0x708
|}
| [[#NpadSixAxisSensorLifo|JoyDualLeftSixAxisSensorLifo]]
 
== DisableJoyPollingReceiveMode ==
Takes an input [[#BusHandle]]. No output.
 
== SetStatusManagerType ==
Takes an input u32 [[#StatusManagerType]]. No output.
 
This is used by sdknso immediately after mapping [[#GetSharedMemoryHandle|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.
 
{| class="wikitable" border="1"
|-
|-
| 0x2C70
! Offset
| 0x708
! Size
| [[#NpadSixAxisSensorLifo|JoyDualRightSixAxisSensorLifo]]
! Description
|-
|-
| 0x3378
| 0x0
| 0x708
| 0x400
| [[#NpadSixAxisSensorLifo|JoyLeftSixAxisSensorLifo]]
| [[#DebugPadSharedMemoryFormat|DebugPad]]
|-
|-
| 0x3A80
| 0x400
| 0x708
| 0x3000
| [[#NpadSixAxisSensorLifo|JoyRightSixAxisSensorLifo]]
| [[#TouchScreenSharedMemoryFormat|TouchScreen]]
|-
|-
| 0x4188
| 0x3400
| 0x4
| 0x400
| [[#DeviceType|DeviceType]]
| [[#MouseSharedMemoryFormat|Mouse]]
|-
|-
| 0x418C
| 0x3800
| 0x4
| 0x400
| Reserved
| [[#KeyboardSharedMemoryFormat|Keyboard]]
|-
|-
| 0x4190
| 0x3C00
| 0x8
| 0x1000
| [[#NpadSystemProperties|SystemProperties]]
| [[#DigitizerSharedMemoryFormat|Digitizer]] ([1.0.0-9.2.0] [[#BasicXpadSharedMemoryFormat|BasicXpad]])
|-
|-
| 0x4198
| 0x4C00
| 0x4
| 0x200
| [[#NpadSystemButtonProperties|SystemButtonProperties]]
| [[#HomeButtonSharedMemoryFormat|HomeButton]]
|-
|-
| 0x419C
| 0x4E00
| 0x4
| 0x200
| [[#BatteryLevel|BatteryLevelJoyDual]]
| [[#SleepButtonSharedMemoryFormat|SleepButton]]
|-
|-
| 0x41A0
| 0x5000
| 0x4
| 0x200
| [[#BatteryLevel|BatteryLevelJoyLeft]]
| [[#CaptureButtonSharedMemoryFormat|CaptureButton]]
|-
|-
| 0x41A4
| 0x5200
| 0x4
| 0x800
| [[#BatteryLevel|BatteryLevelJoyRight]]
| [[#InputDetectorSharedMemoryFormat|InputDetector]]
|-
|-
| 0x41A8
| 0x5A00
| 0x60
| 0x4000
| [1.0.0-8.1.0] [[#NfcXcdDeviceHandleState|NfcXcdDeviceHandle]] (replaced by [[#GetXcdHandleForNpadWithNfc]])
| [1.0.0-4.1.0] [[#UniquePadSharedMemoryFormat|UniquePad]]
|-
|-
| 0x41A8
| 0x9A00
| 0x4
| 0x32000
| [9.0.0+] [[#AppletFooterUiAttribute|AppletFooterUiAttributes]]
| [[#NpadSharedMemoryFormat|Npad]]
|-
|-
| 0x41AC
| 0x3BA00
| 0x1
| 0x800
| [9.0.0+] [[#AppletFooterUiType|AppletFooterUiType]]
| [[#GestureSharedMemoryFormat|Gesture]]
|-
|-
| 0x41AD
| 0x3C200
| 0x7B
| 0x1C
| [9.0.0+] Reserved
| [5.0.0+] [[#ConsoleSixAxisSensorSharedMemoryFormat|ConsoleSixAxisSensor]]
|-
|-
| 0x4208
| 0x3DC00
| 0x40
| 0x400
| [1.0.0-8.1.0] Mutex
| [16.0.0+] [[#MouseSharedMemoryFormat|DebugMouse]]
|-
|-
| 0x4228 ([1.0.0-8.1.0] 0x4248)
| 0x3E200
| 0x1B8
| ?
| [[#NpadGcTriggerLifo|GcTriggerLifo]]
| [?+] NpadCondition
|}
 
== DebugPadSharedMemoryFormat ==
This is "nn::hid::detail::DebugPadSharedMemoryFormat".
 
{| class="wikitable" border="1"
|-
|-
| 0x43E0 ([1.0.0-8.1.0] 0x4400)
! Offset
| 0x4
! Size
| [[#NpadLarkType|LarkTypeLAndMain]]
! Description
|-
|-
| 0x43E4 ([1.0.0-8.1.0] 0x4404)
| 0x0
| 0x4
| 0x2C8
| [[#NpadLarkType|LarkTypeR]]
| [[#DebugPadLifo]]
|-
| 0x43E8 ([1.0.0-8.1.0] 0x4408)
| 0x4
| [[#NpadLuciaType|LuciaType]]
|-
| 0x43EC ([1.0.0-8.1.0] 0x440C)
| 0x4
|
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,076: Line 3,930:
|-
|-
| 0x20
| 0x20
| 0x30 * 17
| 0x28 * 17
| Array of [[#NpadFullKeyStateAtomicStorage]]
| Array of [[#DebugPadStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,094: Line 3,948:
|-
|-
| 0x8
| 0x8
| 0x28
| 0x20
| [[#NpadFullKeyState]]
| [[#DebugPadState]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,112: Line 3,966:
|-
|-
| 0x8
| 0x8
| 0x8
| 0x4
| [[#NpadButtonSet|Buttons]]
| [[#DebugPadAttributeSet|Attributes]]
|-
| 0xC
| 0x4
| [[#DebugPadButtonSet|Buttons]]
|-
|-
| 0x10
| 0x10
| 0x8
| 0x8
| [[#AnalogStickState|AnalogStickL]]
| [[#AnalogStickState|AnalogStickR]]
|-
|-
| 0x18
| 0x18
| 0x8
| 0x8
| [[#AnalogStickState|AnalogStickR]]
| [[#AnalogStickState|AnalogStickL]]
|}
 
== TouchScreenSharedMemoryFormat ==
This is "nn::hid::detail::TouchScreenSharedMemoryFormat".
 
{| class="wikitable" border="1"
|-
|-
| 0x20
! Offset
| 0x4
! Size
| [[#NpadAttributesSet|Attributes]]
! Description
|-
|-
| 0x24
| 0x0
| 0x4
| 0x2C38
| Reserved
| [[#TouchScreenLifo]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,158: Line 4,022:
|-
|-
| 0x20
| 0x20
| 0x30 * 17
| 0x298 * 17
| Array of [[#NpadHandheldStateAtomicStorage]]
| Array of [[#TouchScreenStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,176: Line 4,040:
|-
|-
| 0x8
| 0x8
| 0x28
| 0x290
| [[#NpadHandheldState]]
| [[#TouchScreenState]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,194: Line 4,058:
|-
|-
| 0x8
| 0x8
| 0x8
| 0x4
| [[#NpadButtonSet|Buttons]]
| s32 Count
|-
| 0xC
| 0x4
| Reserved
|-
|-
| 0x10
| 0x10
| 0x8
| 0x28 * 16
| [[#AnalogStickState|AnalogStickL]]
| [[#TouchState|Touches]]
|}
 
== MouseSharedMemoryFormat ==
This is "nn::hid::detail::MouseSharedMemoryFormat".
 
{| class="wikitable" border="1"
|-
|-
| 0x18
! Offset
| 0x8
! Size
| [[#AnalogStickState|AnalogStickR]]
! Description
|-
|-
| 0x20
| 0x0
| 0x4
| 0x350
| [[#NpadAttributesSet|Attributes]]
| [[#MouseLifo]]
|-
| 0x24
| 0x4
| Reserved
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,240: Line 4,110:
|-
|-
| 0x20
| 0x20
| 0x30 * 17
| 0x30 * 17
| Array of [[#NpadJoyDualStateAtomicStorage]]
| Array of [[#MouseStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,259: Line 4,129:
| 0x8
| 0x8
| 0x28
| 0x28
| [[#NpadJoyDualState]]
| [[#MouseState]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,276: Line 4,146:
|-
|-
| 0x8
| 0x8
| 0x8
| 0x4
| [[#NpadButtonSet|Buttons]]
| X
|-
| 0xC
| 0x4
| Y
|-
|-
| 0x10
| 0x10
| 0x8
| 0x4
| [[#AnalogStickState|AnalogStickL]]
| DeltaX
|-
| 0x14
| 0x4
| DeltaY
|-
|-
| 0x18
| 0x18
| 0x8
| 0x4
| [[#AnalogStickState|AnalogStickR]]
| WheelDeltaX
|-
| 0x1C
| 0x4
| WheelDeltaY
|-
|-
| 0x20
| 0x20
| 0x4
| 0x4
| [[#NpadAttributesSet|Attributes]]
| [[#MouseButtonSet|Buttons]]
|-
|-
| 0x24
| 0x24
| 0x4
| 0x4
| Reserved
| [[#MouseAttributeSet|Attributes]]
|}
 
== KeyboardSharedMemoryFormat ==
This is "nn::hid::detail::KeyboardSharedMemoryFormat".
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x3D8
| [[#KeyboardLifo]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,322: Line 4,218:
|-
|-
| 0x20
| 0x20
| 0x30 * 17
| 0x38 * 17
| Array of [[#NpadJoyLeftStateAtomicStorage]]
| Array of [[#KeyboardStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,340: Line 4,236:
|-
|-
| 0x8
| 0x8
| 0x28
| 0x30
| [[#NpadJoyLeftState]]
| [[#KeyboardState]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,359: Line 4,255:
| 0x8
| 0x8
| 0x8
| 0x8
| [[#NpadButtonSet|Buttons]]
| [[#KeyboardModifierSet|Modifiers]]
|-
|-
| 0x10
| 0x10
| 0x8
| 0x20
| [[#AnalogStickState|AnalogStickL]]
| [[#KeyboardKeySet|Keys]]
|}
 
== BasicXpadSharedMemoryFormat ==
This is "nn::hid::detail::BasicXpadSharedMemoryFormat".
 
{| class="wikitable" border="1"
|-
|-
| 0x18
! Offset
| 0x8
! Size
| [[#AnalogStickState|AnalogStickR]]
! Description
|-
| 0x0
| 0x400 * 4
| Array of [[#BasicXpadSharedMemoryEntry]]
|}
 
=== BasicXpadSharedMemoryEntry ===
This is "nn::hid::detail::BasicXpadSharedMemoryEntry".
 
{| class="wikitable" border="1"
|-
|-
| 0x20
! Offset
| 0x4
! Size
| [[#NpadAttributesSet|Attributes]]
! Description
|-
|-
| 0x24
| 0x0
| 0x4
| 0x2C8
| Reserved
| [[#BasicXpadLifo]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,404: Line 4,316:
|-
|-
| 0x20
| 0x20
| 0x30 * 17
| 0x28 * 17
| Array of [[#NpadJoyRightStateAtomicStorage]]
| Array of [[#BasicXpadStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,422: Line 4,334:
|-
|-
| 0x8
| 0x8
| 0x28
| 0x20
| [[#NpadJoyRightState]]
| [[#BasicXpadState]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,440: Line 4,352:
|-
|-
| 0x8
| 0x8
| 0x8
| 0x4
| [[#NpadButtonSet|Buttons]]
| [[#BasicXpadAttributeSet|Attributes]]
|-
| 0xC
| 0x4
| [[#BasicXpadButtonSet|Buttons]]
|-
|-
| 0x10
| 0x10
Line 4,450: Line 4,366:
| 0x8
| 0x8
| [[#AnalogStickState|AnalogStickR]]
| [[#AnalogStickState|AnalogStickR]]
|}
== DigitizerSharedMemoryFormat ==
This is "nn::hid::server::DigitizerSharedMemoryFormat".
{| class="wikitable" border="1"
|-
|-
| 0x20
! Offset
| 0x4
! Size
| [[#NpadAttributesSet|Attributes]]
! Description
|-
|-
| 0x24
| 0x0
| 0x4
| 0x680
| Reserved
| [[#DigitizerLifo]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,486: Line 4,408:
|-
|-
| 0x20
| 0x20
| 0x30 * 17
| 0x60 * 17
| Array of [[#NpadPalmaStateAtomicStorage]]
| Array of [[#DigitizerStateAtomicStorage]]
|}
|}


===== NpadPalmaStateAtomicStorage =====
==== DigitizerStateAtomicStorage ====
This is "nn::hid::detail::NpadPalmaStateAtomicStorage".
This is "nn::hid::server::DigitizerStateAtomicStorage".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,504: Line 4,426:
|-
|-
| 0x8
| 0x8
| 0x28
| 0x58
| [[#NpadPalmaState]]
| [[#DigitizerState]]
|}
|}


====== NpadPalmaState ======
===== DigitizerState =====
This is "nn::hid::NpadPalmaState".
This is "nn::hid::DigitizerState".
 
This is managed by the sysmodule "cs" (development only) through [[HID_services#hid:dbg|hid:dbg]] commands. No actual physical device is supported on NX.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,522: Line 4,446:
|-
|-
| 0x8
| 0x8
| 0x8
| 0x4
| [[#NpadButtonSet|Buttons]]
|  
|-
| 0xC
| 0x4
|  
|-
|-
| 0x10
| 0x10
| 0x8
| 0x4
| [[#AnalogStickState|AnalogStickL]]
| [[#DigitizerAttributeSet|Attributes]]
|-
| 0x14
| 0x4
| [[#DigitizerButtonSet|Buttons]]
|-
|-
| 0x18
| 0x18
| 0x8
| 0x4
| [[#AnalogStickState|AnalogStickR]]
|  
|-
| 0x1C
| 0x4
|  
|-
|-
| 0x20
| 0x20
| 0x4
| 0x4
| [[#NpadAttributesSet|Attributes]]
|  
|-
|-
| 0x24
| 0x24
| 0x4
| 0x4
| Reserved
|  
|}
|-
 
| 0x28
==== NpadSystemLifo ====
| 0x4
This is "nn::hid::detail::NpadSystemLifo". This is a RingLifo object.
|  
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 0x2C
! Size
| 0x4
! Description
|
|-
|-
| 0x0
| 0x30
| 0x8
| 0x4
| RingLifoVptr
|  
|-
|-
| 0x8
| 0x34
| 0x8
| 0x4
| BufferCount
|  
|-
|-
| 0x10
| 0x38
| 0x8
| 0x4
| Tail
|  
|-
|-
| 0x18
| 0x3C
| 0x8
| 0x4
| Count
|  
|-
|-
| 0x20
| 0x40
| 0x30 * 17
| 0x4
| Array of [[#NpadSystemStateAtomicStorage]]
|
|}
|-
 
| 0x44
===== NpadSystemStateAtomicStorage =====
| 0x4
This is "nn::hid::detail::NpadSystemStateAtomicStorage".
|
|-
| 0x48
| 0x4
|
|-
| 0x4C
| 0x4
|
|-
| 0x50
| 0x4
|
|-
| 0x54
| 0x4
|  
|}
 
== HomeButtonSharedMemoryFormat ==
This is "nn::hid::detail::HomeButtonSharedMemoryFormat".
 
This is used by [[AM_services|AM]].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,582: Line 4,538:
|-
|-
| 0x0
| 0x0
| 0x8
| 0x1B8
| SamplingNumber
| [[#HomeButtonLifo]]
|-
| 0x8
| 0x28
| [[#NpadSystemState]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,601: Line 4,553:
| 0x0
| 0x0
| 0x8
| 0x8
| SamplingNumber
| RingLifoVptr
|-
|-
| 0x8
| 0x8
| 0x8
| 0x8
| [[#NpadButtonSet|Buttons]]
| BufferCount
|-
|-
| 0x10
| 0x10
| 0x8
| 0x8
| [[#AnalogStickState|AnalogStickL]]
| Tail
|-
|-
| 0x18
| 0x18
| 0x8
| 0x8
| [[#AnalogStickState|AnalogStickR]]
| Count
|-
|-
| 0x20
| 0x20
| 0x4
| 0x18 * 17
| [[#NpadAttributesSet|Attributes]]
| Array of [[#HomeButtonStateAtomicStorage]]
|-
| 0x24
| 0x4
| Reserved
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,635: Line 4,583:
| 0x0
| 0x0
| 0x8
| 0x8
| RingLifoVptr
| SamplingNumber
|-
|-
| 0x8
| 0x8
| 0x8
| BufferCount
|-
| 0x10
| 0x10
| 0x8
| [[#HomeButtonState]]
| Tail
|-
| 0x18
| 0x8
| Count
|-
| 0x20
| 0x30 * 17
| Array of [[#NpadSystemExtStateAtomicStorage]]
|}
|}


===== NpadSystemExtStateAtomicStorage =====
===== HomeButtonState =====
This is "nn::hid::detail::NpadSystemExtStateAtomicStorage".
This is "nn::hid::system::HomeButtonState".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,668: Line 4,604:
|-
|-
| 0x8
| 0x8
| 0x28
| 0x8
| [[#NpadSystemExtState]]
| [[#HomeButtonSet|Buttons]]
|}
 
== SleepButtonSharedMemoryFormat ==
This is "nn::hid::detail::SleepButtonSharedMemoryFormat".
 
This is used by [[AM_services|AM]].
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x1B8
| [[#SleepButtonLifo]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,683: Line 4,635:
| 0x0
| 0x0
| 0x8
| 0x8
| SamplingNumber
| RingLifoVptr
|-
|-
| 0x8
| 0x8
| 0x8
| 0x8
| [[#NpadButtonSet|Buttons]]
| BufferCount
|-
|-
| 0x10
| 0x10
| 0x8
| 0x8
| [[#AnalogStickState|AnalogStickL]]
| Tail
|-
|-
| 0x18
| 0x18
| 0x8
| 0x8
| [[#AnalogStickState|AnalogStickR]]
| Count
|-
|-
| 0x20
| 0x20
| 0x4
| 0x18 * 17
| [[#NpadAttributesSet|Attributes]]
| Array of [[#SleepButtonStateAtomicStorage]]
|-
| 0x24
| 0x4
| Reserved
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,717: Line 4,665:
| 0x0
| 0x0
| 0x8
| 0x8
| RingLifoVptr
| SamplingNumber
|-
|-
| 0x8
| 0x8
| 0x8
| BufferCount
|-
| 0x10
| 0x10
| 0x8
| [[#SleepButtonState]]
| Tail
|-
| 0x18
| 0x8
| Count
|-
| 0x20
| 0x68 * 17
| Array of [[#SixAxisSensorStateAtomicStorage]]
|}
|}


===== SixAxisSensorStateAtomicStorage =====
===== SleepButtonState =====
This is "nn::hid::detail::SixAxisSensorStateAtomicStorage".
This is "nn::hid::system::SleepButtonState".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,750: Line 4,686:
|-
|-
| 0x8
| 0x8
| 0x60
| 0x8
| [[#SixAxisSensorState]]
| [[#SleepButtonSet|Buttons]]
|}
 
== CaptureButtonSharedMemoryFormat ==
This is "nn::hid::detail::CaptureButtonSharedMemoryFormat".
 
This is used by [[AM_services|AM]].
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x1B8
| [[#CaptureButtonLifo]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,765: Line 4,717:
| 0x0
| 0x0
| 0x8
| 0x8
| DeltaTime
| RingLifoVptr
|-
|-
| 0x8
| 0x8
| 0x8
| 0x8
| SamplingNumber
| BufferCount
|-
|-
| 0x10
| 0x10
| 0x4
| 0x8
| AccelerationX
| Tail
|-
| 0x14
| 0x4
| AccelerationY
|-
|-
| 0x18
| 0x18
| 0x4
| 0x8
| AccelerationZ
| Count
|-
| 0x1C
| 0x4
| AngularVelocityX
|-
|-
| 0x20
| 0x20
| 0x4
| 0x18 * 17
| AngularVelocityY
| Array of [[#CaptureButtonStateAtomicStorage]]
|-
| 0x24
| 0x4
| AngularVelocityZ
|-
| 0x28
| 0x4
| AngleX
|-
| 0x2C
| 0x4
| AngleY
|-
| 0x30
| 0x4
| AngleZ
|-
| 0x34
| 0x24
| [[#DirectionState|Direction]]
|-
| 0x58
| 0x4
| [[#SixAxisSensorAttributeSet|Attributes]]
|-
| 0x5C
| 0x4
| Reserved
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,831: Line 4,747:
| 0x0
| 0x0
| 0x8
| 0x8
| RingLifoVptr
| SamplingNumber
|-
|-
| 0x8
| 0x8
| 0x8
| BufferCount
|-
| 0x10
| 0x10
| 0x8
| [[#CaptureButtonState]]
| Tail
|}
|-
| 0x18
| 0x8
| Count
|-
| 0x20
| 0x20 * 2
| Array of [[#NfcXcdDeviceHandleStateImplAtomicStorage]]
|}


===== NfcXcdDeviceHandleStateImplAtomicStorage =====
===== CaptureButtonState =====
This is "nn::hid::detail::NfcXcdDeviceHandleStateImplAtomicStorage".
This is "nn::hid::system::CaptureButtonState".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,864: Line 4,768:
|-
|-
| 0x8
| 0x8
| 0x18
| 0x8
| [[#NfcXcdDeviceHandleStateImpl]]
| [[#CaptureButtonSet|Buttons]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,878: Line 4,782:
|-
|-
| 0x0
| 0x0
| 0x8
| 0x80 * 16
| [[#DeviceHandle|Handle]]
| Array of [[#InputDetectorSharedMemoryEntry]]
|}
 
=== InputDetectorSharedMemoryEntry ===
This is "nn::hid::detail::InputDetectorSharedMemoryEntry".
 
{| class="wikitable" border="1"
|-
|-
| 0x8
! Offset
| 0x1
! Size
| IsAvailable
! Description
|-
|-
| 0x9
| 0x0
| 0x1
| 0x50
| IsActivated
| [[#InputDetectorLifo]]
|-
| 0xA
| 0x6
| Reserved
|-
| 0x10
| 0x8
| SamplingNumber
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,924: Line 4,826:
|-
|-
| 0x20
| 0x20
| 0x18 * 17
| 0x18 * 2
| Array of [[#NpadGcTriggerStateAtomicStorage]]
| Array of [[#InputDetectorStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,943: Line 4,845:
| 0x8
| 0x8
| 0x10
| 0x10
| [[#NpadGcTriggerState]]
| [[#InputDetectorState]]
|}
|}


====== NpadGcTriggerState ======
====== InputDetectorState ======
This is "nn::hid::server::NpadGcTriggerState".
This is "nn::hid::detail::InputDetectorState".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,956: Line 4,858:
|-
|-
| 0x0
| 0x0
| 0x8
| [[#InputSourceState|InputSourceState]]
|-
| 0x8
| 0x8
| 0x8
| SamplingNumber
| 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]].
{| class="wikitable" border="1"
|-
|-
| 0x8
! Offset
| 0x4
! Size
| TriggerL
! Description
|-
|-
| 0xC
| 0x0
| 0x4
| 0x400 * 16
| TriggerR
| Array of [[#UniquePadSharedMemoryEntry]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,978: Line 4,892:
|-
|-
| 0x0
| 0x0
| 0x708
| 0x1E0
| [[#GestureLifo]]
| [[#UniquePadLifo]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,992: Line 4,906:
|-
|-
| 0x0
| 0x0
| 0x8
| 0x80
| RingLifoVptr
| [[#UniquePadConfigLifo]]
|-
|-
| 0x8
| 0x80
| 0x8
| 0x70 * 2
| BufferCount
| Array of [[#AnalogStickCalibrationStateImplLifo]]
|-
|-
| 0x10
| 0x160
| 0x60
| [[#SixAxisSensorUserCalibrationStateLifo]]
|-
| 0x1C0
| 0x20
| UniquePadConfigMutex
|}
 
==== UniquePadConfigLifo ====
This is "nn::hid::detail::UniquePadConfigLifo". This is a RingLifo object.
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| RingLifoVptr
|-
| 0x8
| 0x8
| BufferCount
|-
| 0x10
| 0x8
| 0x8
| Tail
| Tail
Line 5,008: Line 4,948:
|-
|-
| 0x20
| 0x20
| 0x68 * 17
| 0x30 * 2
| Array of [[#GestureDummyStateAtomicStorage]]
| Array of [[#UniquePadConfigAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,026: Line 4,966:
|-
|-
| 0x8
| 0x8
| 0x60
| 0x28
| [[#GestureDummyState]]
| [[#UniquePadConfig]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,040: Line 4,980:
|-
|-
| 0x0
| 0x0
| 0x8
| 0x4
| SamplingNumber
| [[#UniquePadType|Type]]
|-
| 0x4
| 0x4
| [[#UniquePadInterface|Interface]]
|-
|-
| 0x8
| 0x8
| 0x8
| ContextNumber
|-
| 0x10
| 0x10
| 0x4
| [[#UniquePadSerialNumber|SerialNumber]]
| [[#GestureType|Type]]
|-
|-
| 0x14
| 0x18
| 0x4
| 0x4
| [[#GestureDirection|Direction]]
| ControllerNumber
|-
|-
| 0x18
| 0x1C
| 0x4
| 0x1
| X
| IsActive
|-
|-
| 0x1C
| 0x1D
| 0x4
| 0x3
| Y
| Reserved
|-
|-
| 0x20
| 0x20
| 0x4
| 0x8
| s32 DeltaX
| SamplingNumber
|-
| 0x24
| 0x4
| s32 DeltaY
|-
| 0x28
| 0x4
| float VelocityX
|-
| 0x2C
| 0x4
| float VelocityY
|-
| 0x30
| 0x4
| [[#GestureAttributeSet|Attributes]]
|-
| 0x34
| 0x4
| Scale
|-
| 0x38
| 0x4
| RotationAngle
|-
| 0x3C
| 0x4
| s32 PointCount
|-
| 0x40
| 0x8 * 4
| [[#GesturePoint|Points]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,111: Line 5,019:
| 0x0
| 0x0
| 0x8
| 0x8
| SamplingNumber
| RingLifoVptr
|-
|-
| 0x8
| 0x8
| 0x1
| 0x8
| IsSevenSixAxisSensorAtRest
| BufferCount
|-
|-
| 0x9
| 0x10
| 0x3
| 0x8
| Padding
| Tail
|-
|-
| 0xC
| 0x18
| 0x4
| 0x8
| VerticalizationError
| Count
|-
|-
| 0x10
| 0x20
| 0xC
| 0x28 * 2
| GyroBias
| Array of [[#AnalogStickCalibrationStateImplAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,140: Line 5,048:
|-
|-
| 0x0
| 0x0
| 0x4
| 0x8
| X
| SamplingNumber
|-
|-
| 0x4
| 0x8
| 0x4
| 0x20
| Y
| [[#AnalogStickCalibrationStateImpl]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,159: Line 5,067:
| 0x0
| 0x0
| 0x8
| 0x8
| DeltaTime
| [[#AnalogStickState|State]]
|-
|-
| 0x8
| 0x8
| 0x4
| 0x8
| [[#TouchAttributeSet|Attributes]]
| [[#AnalogStickCalibrationFlagsSet|Flags]]
|-
| 0xC
| 0x4
| FingerId
|-
|-
| 0x10
| 0x10
| 0x4
| 0x8
| X
| [[#AnalogStickManualCalibrationStage|Stage]]
|-
| 0x14
| 0x4
| Y
|-
|-
| 0x18
| 0x18
| 0x4
| 0x8
| DiameterX
| SamplingNumber
|-
| 0x1C
| 0x4
| DiameterY
|-
| 0x20
| 0x4
| RotationAngle
|-
| 0x24
| 0x4
| Reserved
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,205: Line 5,093:
| 0x0
| 0x0
| 0x8
| 0x8
| Timestamp
| RingLifoVptr
|-
| 0x8
| 0x8
| BufferCount
|-
| 0x10
| 0x8
| Tail
|-
| 0x18
| 0x8
| Count
|-
| 0x20
| 0x20 * 2
| Array of [[#SixAxisSensorUserCalibrationStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,218: Line 5,122:
|-
|-
| 0x0
| 0x0
| 0x4
| 0x8
| Main
| SamplingNumber
|-
|-
| 0x4
| 0x8
| 0x4
| 0x18
| Sub
| [[#SixAxisSensorUserCalibrationState]]
|}
|}


= NpadFullKeyColorState =
====== SixAxisSensorUserCalibrationState ======
This is "nn::hid::detail::NpadFullKeyColorState".
This is "nn::hid::detail::UniquePadConfig".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,237: Line 5,141:
| 0x0
| 0x0
| 0x4
| 0x4
| [[#ColorAttribute|Attribute]]
| [[#SixAxisSensorUserCalibrationFlagsSet|Flags]]
|-
|-
| 0x4
| 0x4
| 0x8
| 0x4
| [[#NpadControllerColor|FullKey]]
| Reserved
|-
| 0x8
| 0x8
| [[#SixAxisSensorUserCalibrationStage|Stage]]
|-
| 0x10
| 0x8
| SamplingNumber
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,254: Line 5,166:
|-
|-
| 0x0
| 0x0
| 0x4
| 0x5000 * 10
| [[#ColorAttribute|Attribute]]
| Array of [[#NpadSharedMemoryEntry]]
|}
 
Each entry describes an available controller:
{| class="wikitable" border="1"
|-
! Entry
! Description
|-
| 0 to 7
| Players 1 to 8
|-
| 8
| Handheld Mode
|-
| 9
| Other
|}
 
== NpadSharedMemoryEntry ==
This is "nn::hid::detail::NpadSharedMemoryEntry".
 
{| class="wikitable" border="1"
|-
|-
| 0x4
! Offset
| 0x8
! Size
| [[#NpadControllerColor|Left]]
! Description
|-
|-
| 0xC
| 0x0
| 0x8
| 0x43F8 ([9.0.0-12.1.0] 0x43F0, [1.0.0-8.1.0] 0x4410)
| [[#NpadControllerColor|Right]]
| [[#NpadInternalState]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,277: Line 5,211:
| 0x0
| 0x0
| 0x4
| 0x4
| XX
| [[#NpadStyleSet|StyleSet]]
|-
|-
| 0x4
| 0x4
| 0x4
| 0x4
| XY
| [[#NpadJoyAssignmentMode|JoyAssignmentMode]]
|-
|-
| 0x8
| 0x8
| 0x4
| XZ
|-
| 0xC
| 0xC
| 0x4
| [[#NpadFullKeyColorState|FullKeyColor]]
| YX
|-
|-
| 0x10
| 0x14
| 0x4
| 0x14
| YY
| [[#NpadJoyColorState|JoyColor]]
|-
|-
| 0x14
| 0x28
| 0x4
| 0x350
| YZ
| [[#NpadFullKeyLifo|FullKeyLifo]]
|-
|-
| 0x18
| 0x378
| 0x4
| 0x350
| ZX
| [[#NpadHandheldLifo|HandheldLifo]]
|-
|-
| 0x1C
| 0x6C8
| 0x4
| 0x350
| ZY
| [[#NpadJoyDualLifo|JoyDualLifo]]
|-
|-
| 0x20
| 0xA18
| 0x4
| 0x350
| ZZ
| [[#NpadJoyLeftLifo|JoyLeftLifo]]
|}
 
= GesturePoint =
This is "nn::hid::GesturePoint".
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 0xD68
! Size
| 0x350
! Description
| [[#NpadJoyRightLifo|JoyRightLifo]]
|-
|-
| 0x0
| 0x10B8
| 0x4
| 0x350
| X
| [[#NpadPalmaLifo|PalmaLifo]] ([1.0.0-3.0.2] [[#NpadSystemLifo|SystemLifo]])
|-
|-
| 0x4
| 0x1408
| 0x4
| 0x350
| Y
| [[#NpadSystemExtLifo|SystemExtLifo]] ([4.0.0+] also used for NpadSystem)
|}
 
= ColorAttribute =
This is "nn::hid::detail::ColorAttribute".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Ok
| 0x1758
| 0x708
| [[#NpadSixAxisSensorLifo|FullKeySixAxisSensorLifo]]
|-
|-
| 1 || ReadError
| 0x1E60
| 0x708
| [[#NpadSixAxisSensorLifo|HandheldSixAxisSensorLifo]]
|-
|-
| 2 || NoController
| 0x2568
|}
| 0x708
 
| [[#NpadSixAxisSensorLifo|JoyDualLeftSixAxisSensorLifo]]
= 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.
 
{| class="wikitable" border="1"
|-
|-
! Bit
| 0x2C70
! Description
| 0x708
| [[#NpadSixAxisSensorLifo|JoyDualRightSixAxisSensorLifo]]
|-
|-
| 0
| 0x3378
| IsConnected
| 0x708
|}
| [[#NpadSixAxisSensorLifo|JoyLeftSixAxisSensorLifo]]
 
= 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.
 
{| class="wikitable" border="1"
|-
|-
! Bit
| 0x3A80
! Description
| 0x708
| [[#NpadSixAxisSensorLifo|JoyRightSixAxisSensorLifo]]
|-
|-
| 0
| 0x4188
| Start
| 0x4
| [[#DeviceType|DeviceType]]
|-
|-
| 1
| 0x418C
| End
| 0x4
|}
| Reserved
 
= 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.
 
{| class="wikitable" border="1"
|-
|-
! Bit
| 0x4190
! Description
| 0x8
| [[#NpadSystemProperties|SystemProperties]]
|-
|-
| 0
| 0x4198
| Transferable
| 0x4
| [[#NpadSystemButtonProperties|SystemButtonProperties]]
|-
|-
| 1
| 0x419C
| IsConnected
| 0x4
|}
| [[#BatteryLevel|BatteryLevelJoyDual]]
 
= 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.
 
{| class="wikitable" border="1"
|-
|-
! Bit
| 0x41A0
! Description
| 0x4
| [[#BatteryLevel|BatteryLevelJoyLeft]]
|-
|-
| 0
| 0x41A4
| IsConnected
| 0x4
| [[#BatteryLevel|BatteryLevelJoyRight]]
|-
|-
| 1
| 0x41A8
| IsWired
| 0x60
| [1.0.0-8.1.0] [[#NfcXcdDeviceHandleState|NfcXcdDeviceHandle]] (replaced by [[#GetXcdHandleForNpadWithNfc]])
|-
| 0x41A8
| 0x4
| [9.0.0+] [[#AppletFooterUiAttribute|AppletFooterUiAttributes]]
|-
|-
| 2
| 0x41AC
| IsLeftConnected
| 0x1
| [9.0.0+] [[#AppletFooterUiType|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
| [[#NpadGcTriggerLifo|GcTriggerLifo]]
|-
| 0x43E0 ([1.0.0-8.1.0] 0x4400)
| 0x4
| [[#NpadLarkType|LarkTypeLAndMain]]
|-
| 0x43E4 ([1.0.0-8.1.0] 0x4404)
| 0x4
| [[#NpadLarkType|LarkTypeR]]
|-
|-
| 3
| 0x43E8 ([1.0.0-8.1.0] 0x4408)
| IsLeftWired
| 0x4
| [[#NpadLuciaType|LuciaType]]
|-
|-
| 4
| 0x43EC ([1.0.0-8.1.0] 0x440C)
| IsRightConnected
| 0x4
| [[#NpadLagerType|LagerType]]
|-
|-
| 5
| 0x43F0
| IsRightWired
| 0x1 * 6
| [13.0.0+] Array of [[#SixAxisSensorProperties]]
|}
|}


= SixAxisSensorAttributeSet =
==== NpadFullKeyLifo ====
This is "nn::hid::SixAxisSensorAttributeSet". This is a BitFlagSet object for [[#SixAxisSensorAttribute]].
This is "nn::hid::detail::NpadFullKeyLifo". This is a RingLifo object.
 
= SixAxisSensorAttribute =
This is "nn::hid::SixAxisSensorAttribute". This is a 32-bit flag.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Bit
! Offset
! Size
! Description
! Description
|-
|-
| 0
| 0x0
| IsConnected
| 0x8
| RingLifoVptr
|-
|-
| 1
| 0x8
| IsInterpolated
| 0x8
| BufferCount
|-
| 0x10
| 0x8
| Tail
|-
| 0x18
| 0x8
| Count
|-
| 0x20
| 0x30 * 17
| Array of [[#NpadFullKeyStateAtomicStorage]]
|}
|}


= GestureAttributeSet =
===== NpadFullKeyStateAtomicStorage =====
This is "nn::hid::GestureAttributeSet". This is a BitFlagSet object for [[#GestureAttribute]].
This is "nn::hid::detail::NpadFullKeyStateAtomicStorage".
 
= GestureAttribute =
This is "nn::hid::GestureAttribute". This is a 32-bit flag.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Bit
! Offset
! Size
! Description
! Description
|-
|-
| 4
| 0x0
| IsNewTouch
| 0x8
| SamplingNumber
|-
|-
| 8
| 0x8
| IsDoubleTap
| 0x28
| [[#NpadFullKeyState]]
|}
|}


= DebugPadButtonSet =
====== NpadFullKeyState ======
This is "nn::hid::DebugPadButtonSet". This is a BitFlagSet object for [[#DebugPadButton]].
This is "nn::hid::NpadFullKeyState".
 
= DebugPadButton =
This is "nn::hid::DebugPadButton". This is a 32-bit flag.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Bit
! Offset
! Size
! Description
! Description
|-
|-
| 0
| 0x0
| A
| 0x8
| SamplingNumber
|-
|-
| 1
| 0x8
| B
| 0x8
| [[#NpadButtonSet|Buttons]]
|-
|-
| 2
| 0x10
| X
| 0x8
| [[#AnalogStickState|AnalogStickL]]
|-
|-
| 3
| 0x18
| Y
| 0x8
| [[#AnalogStickState|AnalogStickR]]
|-
|-
| 4
| 0x20
| L
| 0x4
| [[#NpadAttributesSet|Attributes]]
|-
|-
| 5
| 0x24
| R
| 0x4
|-
| Reserved
| 6
| ZL
|-
| 7
| ZR
|-
| 8
| Start
|-
| 9
| Select
|-
| 10
| Left
|-
| 11
| Up
|-
| 12
| Right
|-
| 13
| Down
|}
|}


= MouseButtonSet =
==== NpadHandheldLifo ====
This is "nn::hid::MouseButtonSet". This is a BitFlagSet object for [[#MouseButton]].
This is "nn::hid::detail::NpadHandheldLifo". This is a RingLifo object.
 
= MouseButton =
This is "nn::hid::MouseButton". This is a 32-bit flag.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Bit
! Offset
! Size
! Description
! Description
|-
|-
| 0
| 0x0
| Left
| 0x8
| RingLifoVptr
|-
|-
| 1
| 0x8
| Right
| 0x8
| BufferCount
|-
|-
| 2
| 0x10
| Middle
| 0x8
| Tail
|-
|-
| 3
| 0x18
| Forward
| 0x8
| Count
|-
|-
| 4
| 0x20
| Back
| 0x30 * 17
| Array of [[#NpadHandheldStateAtomicStorage]]
|}
|}


= KeyboardModifierSet =
===== NpadHandheldStateAtomicStorage =====
This is "nn::hid::KeyboardModifierSet". This is a BitFlagSet object for [[#KeyboardModifier]].
This is "nn::hid::detail::NpadHandheldStateAtomicStorage".
 
= KeyboardModifier =
This is "nn::hid::KeyboardModifier". This is a 32-bit flag.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Bit
! Offset
! Size
! Description
! Description
|-
|-
| 0
| 0x0
| Control
| 0x8
| SamplingNumber
|-
|-
| 1
| 0x8
| Shift
| 0x28
| [[#NpadHandheldState]]
|}
 
====== NpadHandheldState ======
This is "nn::hid::NpadHandheldState".
 
{| class="wikitable" border="1"
|-
|-
| 2
! Offset
| LeftAlt
! Size
! Description
|-
|-
| 3
| 0x0
| RightAlt
| 0x8
| SamplingNumber
|-
|-
| 4
| 0x8
| Gui
| 0x8
| [[#NpadButtonSet|Buttons]]
|-
|-
| 8
| 0x10
| CapsLock
| 0x8
| [[#AnalogStickState|AnalogStickL]]
|-
|-
| 9
| 0x18
| ScrollLock
| 0x8
| [[#AnalogStickState|AnalogStickR]]
|-
|-
| 10
| 0x20
| NumLock
| 0x4
| [[#NpadAttributesSet|Attributes]]
|-
|-
| 11
| 0x24
| Katakana
| 0x4
|-
| Reserved
| 12
| Hiragana
|}
|}


= KeyboardKeySet =
==== NpadJoyDualLifo ====
This is "nn::hid::KeyboardKeySet". This is a BitFlagSet object for [[#KeyboardKey]].
This is "nn::hid::detail::NpadJoyDualLifo". This is a RingLifo object.
 
= 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.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Bit
! Offset
! Size
! Description
! Description
|-
|-
| 0
| 0x0
| A
| 0x8
| RingLifoVptr
|-
|-
| 1
| 0x8
| B
| 0x8
| BufferCount
|-
|-
| 2
| 0x10
| X
| 0x8
| Tail
|-
|-
| 3
| 0x18
| Y
| 0x8
| Count
|-
|-
| 4
| 0x20
| StickL
| 0x30 * 17
| Array of [[#NpadJoyDualStateAtomicStorage]]
|}
 
===== NpadJoyDualStateAtomicStorage =====
This is "nn::hid::detail::NpadJoyDualStateAtomicStorage".
 
{| class="wikitable" border="1"
|-
|-
| 5
! Offset
| StickR
! Size
! Description
|-
|-
| 6
| 0x0
| L
| 0x8
| SamplingNumber
|-
|-
| 7
| 0x8
| R
| 0x28
| [[#NpadJoyDualState]]
|}
 
====== NpadJoyDualState ======
This is "nn::hid::NpadJoyDualState".
 
{| class="wikitable" border="1"
|-
|-
| 8
! Offset
| ZL
! Size
! Description
|-
|-
| 9
| 0x0
| ZR
| 0x8
| SamplingNumber
|-
|-
| 10
| 0x8
| Plus
| 0x8
| [[#NpadButtonSet|Buttons]]
|-
|-
| 11
| 0x10
| Minus
| 0x8
| [[#AnalogStickState|AnalogStickL]]
|-
|-
| 12
| 0x18
| Left
| 0x8
| [[#AnalogStickState|AnalogStickR]]
|-
|-
| 13
| 0x20
| Up
| 0x4
| [[#NpadAttributesSet|Attributes]]
|-
|-
| 14
| 0x24
| Right
| 0x4
| Reserved
|}
 
==== NpadJoyLeftLifo ====
This is "nn::hid::detail::NpadJoyLeftLifo". This is a RingLifo object.
 
{| class="wikitable" border="1"
|-
|-
| 15
! Offset
| Down
! Size
! Description
|-
|-
| 16
| 0x0
| StickLLeft
| 0x8
| RingLifoVptr
|-
|-
| 17
| 0x8
| StickLUp
| 0x8
| BufferCount
|-
|-
| 18
| 0x10
| StickLRight
| 0x8
| Tail
|-
|-
| 19
| 0x18
| StickLDown
| 0x8
| Count
|-
|-
| 20
| 0x20
| StickRLeft
| 0x30 * 17
|-
| Array of [[#NpadJoyLeftStateAtomicStorage]]
| 21
|}
| StickRUp
 
===== NpadJoyLeftStateAtomicStorage =====
This is "nn::hid::detail::NpadJoyLeftStateAtomicStorage".
 
{| class="wikitable" border="1"
|-
|-
| 22
! Offset
| StickRRight
! Size
! Description
|-
|-
| 23
| 0x0
| StickRDown
| 0x8
| SamplingNumber
|-
|-
| 24
| 0x8
| LeftSL
| 0x28
| [[#NpadJoyLeftState]]
|}
 
====== NpadJoyLeftState ======
This is "nn::hid::NpadJoyLeftState".
 
{| class="wikitable" border="1"
|-
|-
| 25
! Offset
| LeftSR
! Size
! Description
|-
|-
| 26
| 0x0
| RightSL
| 0x8
| SamplingNumber
|-
|-
| 27
| 0x8
| RightSR
| 0x8
| [[#NpadButtonSet|Buttons]]
|-
|-
| 28
| 0x10
| Palma
| 0x8
| [[#AnalogStickState|AnalogStickL]]
|-
|-
| 29
| 0x18
|  
| 0x8
| [[#AnalogStickState|AnalogStickR]]
|-
|-
| 30
| 0x20
| HandheldLeftB (Left B button on NES controllers in Handheld mode)
| 0x4
| [[#NpadAttributesSet|Attributes]]
|-
| 0x24
| 0x4
| Reserved
|}
|}


= AnalogStickCalibrationFlagsSet =
==== NpadJoyRightLifo ====
This is "nn::hid::detail::AnalogStickCalibrationFlagsSet". This is a BitFlagSet object for [[#AnalogStickCalibrationFlags]].
This is "nn::hid::detail::NpadJoyRightLifo". This is a RingLifo object.
 
= 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".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Bits
!  Description
!  Notes
|-
|-
| 0
! Offset
| NpadStyleFullKey
! Size
| Pro Controller
! Description
|-
|-
| 1
| 0x0
| NpadStyleHandheld
| 0x8
| Joy-Con controller in handheld mode
| RingLifoVptr
|-
|-
| 2
| 0x8
| NpadStyleJoyDual
| 0x8
| Joy-Con controller in dual mode
| BufferCount
|-
|-
| 3
| 0x10
| NpadStyleJoyLeft
| 0x8
| Joy-Con left controller in single mode
| Tail
|-
|-
| 4
| 0x18
| NpadStyleJoyRight
| 0x8
| Joy-Con right controller in single mode
| Count
|-
|-
| 5
| 0x20
| NpadStyleGc
| 0x30 * 17
| GameCube controller
| Array of [[#NpadJoyRightStateAtomicStorage]]
|}
 
===== NpadJoyRightStateAtomicStorage =====
This is "nn::hid::detail::NpadJoyRightStateAtomicStorage".
 
{| class="wikitable" border="1"
|-
|-
| 6
! Offset
| NpadStylePalma
! Size
| Poké Ball Plus controller
! Description
|-
|-
| 7
| 0x0
| NpadStyleLark
| 0x8
| NES/Famicom controller
| SamplingNumber
|-
|-
| 8
| 0x8
| NpadStyleHandheldLark
| 0x28
| NES/Famicom controller in handheld mode
| [[#NpadJoyRightState]]
|}
 
====== NpadJoyRightState ======
This is "nn::hid::NpadJoyRightState".
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| SamplingNumber
|-
|-
| 9
| 0x8
| NpadStyleLucia
| 0x8
| SNES controller
| [[#NpadButtonSet|Buttons]]
|-
|-
| 10-28
| 0x10
| Reserved
| 0x8
|
| [[#AnalogStickState|AnalogStickL]]
|-
|-
| 29
| 0x18
| NpadStyleSystemExt
| 0x8
| Generic external controller
| [[#AnalogStickState|AnalogStickR]]
|-
|-
| 30
| 0x20
| NpadStyleSystem
| 0x4
| Generic controller
| [[#NpadAttributesSet|Attributes]]
|-
|-
| 31
| 0x24
| 0x4
| Reserved
| Reserved
|
|}
|}


= NpadDeviceTypeSet =
==== NpadPalmaLifo ====
This is "nn::hid::system::NpadDeviceType". This is a BitFlagSet object for [[#NpadDeviceType]].
This is "nn::hid::detail::NpadPalmaLifo". This is a RingLifo object.
 
= NpadSystemPropertiesSet =
This is "nn::hid::detail::NpadSystemPropertiesSet". This is a BitFlagSet object for [[#NpadSystemProperties]].
 
= NpadSystemProperties =
This is "nn::hid::NpadSystemProperties". This is a 64-bit flag.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Bit
! Offset
! Size
! Description
! Description
|-
|-
| 0
| 0x0
| IsChargingJoyDual
| 0x8
| RingLifoVptr
|-
|-
| 1
| 0x8
| IsChargingJoyLeft
| 0x8
| BufferCount
|-
|-
| 2
| 0x10
| IsChargingJoyRight
| 0x8
| Tail
|-
|-
| 3
| 0x18
| IsPoweredJoyDual
| 0x8
| Count
|-
|-
| 4
| 0x20
| IsPoweredJoyLeft
| 0x30 * 17
|-
| Array of [[#NpadPalmaStateAtomicStorage]]
| 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 =
===== NpadPalmaStateAtomicStorage =====
This is "nn::hid::detail::NpadSystemButtonPropertiesSet". This is a BitFlagSet object for [[#NpadSystemButtonProperties]].
This is "nn::hid::detail::NpadPalmaStateAtomicStorage".
 
= NpadSystemButtonProperties =
This is "nn::hid::NpadSystemButtonProperties". This is a 32-bit flag.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Bit
! Offset
! Size
! Description
! Description
|-
|-
| 0
| 0x0
| IsUnintendedHomeButtonInputProtectionEnabled
| 0x8
|}
| SamplingNumber
|-
| 0x8
| 0x28
| [[#NpadPalmaState]]
|}


= AppletFooterUiAttributesSet =
====== NpadPalmaState ======
This is "nn::hid::system::AppletFooterUiAttributesSet". This is a BitFlagSet object for [[#AppletFooterUiAttribute]].
This is "nn::hid::NpadPalmaState".
 
= UniquePadType =
This is "nn::hid::system::UniquePadType".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Embedded
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| SamplingNumber
|-
| 0x8
| 0x8
| [[#NpadButtonSet|Buttons]]
|-
|-
| 1 || FullKeyController
| 0x10
| 0x8
| [[#AnalogStickState|AnalogStickL]]
|-
|-
| 2 || RightController
| 0x18
| 0x8
| [[#AnalogStickState|AnalogStickR]]
|-
|-
| 3 || LeftController
| 0x20
| 0x4
| [[#NpadAttributesSet|Attributes]]
|-
|-
| 4 || DebugPadController
| 0x24
| 0x4
| Reserved
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Embedded
! Offset
! Size
! Description
|-
|-
| 1 || Rail
| 0x0
| 0x8
| RingLifoVptr
|-
|-
| 2 || Bluetooth
| 0x8
| 0x8
| BufferCount
|-
| 0x10
| 0x8
| Tail
|-
|-
| 3 || Usb
| 0x18
| 0x8
| Count
|-
| 0x20
| 0x30 * 17
| Array of [[#NpadSystemStateAtomicStorage]]
|}
|}


= UniquePadSerialNumber =
===== NpadSystemStateAtomicStorage =====
This is "nn::hid::system::UniquePadSerialNumber". This is a 0x10 byte value.
This is "nn::hid::detail::NpadSystemStateAtomicStorage".
 
= UniquePadId =
This is "nn::hid::system::UniquePadId". This is a 8 byte value.
 
= AnalogStickManualCalibrationStage =
This is "nn::hid::system::AnalogStickManualCalibrationStage".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || ReleaseFromRight
! Offset
! Size
! Description
|-
|-
| 1 || ReleaseFromBottom
| 0x0
| 0x8
| SamplingNumber
|-
|-
| 2 || ReleaseFromLeft
| 0x8
|-
| 0x28
| 3 || ReleaseFromTop
| [[#NpadSystemState]]
|-
| 4 || Rotate
|-
| 5 || Update
|-
| 6 || Completed
|-
| 7 || Clear
|-
| 8 || ClearCompleted
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Measuring
! Offset
! Size
! Description
|-
|-
| 1 || Update
| 0x0
| 0x8
| SamplingNumber
|-
|-
| 2 || Completed
| 0x8
|}
| 0x8
 
| [[#NpadButtonSet|Buttons]]
= NpadJoyHoldType =
This is "nn::hid::NpadJoyHoldType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Vertical
| 0x10
| 0x8
| [[#AnalogStickState|AnalogStickL]]
|-
|-
| 1 || Horizontal
| 0x18
|}
| 0x8
 
| [[#AnalogStickState|AnalogStickR]]
= NpadJoyDeviceType =
This is "nn::hid::NpadJoyDeviceType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Left
| 0x20
| 0x4
| [[#NpadAttributesSet|Attributes]]
|-
|-
| 1 || Right
| 0x24
| 0x4
| Reserved
|}
|}


= NpadHandheldActivationMode =
==== NpadSystemExtLifo ====
This is "nn::hid::NpadHandheldActivationMode".
This is "nn::hid::detail::NpadSystemExtLifo". This is a RingLifo object.
 
This controls how many joycons must be attached for handheld mode to be triggered (Dual = 2, Single = 1, None = 0).


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Dual
! Offset
! Size
! Description
|-
|-
| 1 || Single
| 0x0
| 0x8
| RingLifoVptr
|-
|-
| 2 || None
| 0x8
| 0x8
| BufferCount
|-
| 0x10
| 0x8
| Tail
|-
| 0x18
| 0x8
| Count
|-
| 0x20
| 0x30 * 17
| Array of [[#NpadSystemExtStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Dual
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| SamplingNumber
|-
|-
| 1 || Single
| 0x8
| 0x28
| [[#NpadSystemExtState]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0x00000000 || None
! Offset
! Size
! Description
|-
|-
| 0x01000000 || HandheldNone
| 0x0
| 0x8
| SamplingNumber
|-
|-
| 0x02000000 || HandheldJoyConLeftOnly
| 0x8
| 0x8
| [[#NpadButtonSet|Buttons]]
|-
|-
| 0x02000001 || HandheldLarkHvc1Only
| 0x10
| 0x8
| [[#AnalogStickState|AnalogStickL]]
|-
|-
| 0x02000002 || HandheldLarkNesLeftOnly
| 0x18
| 0x8
| [[#AnalogStickState|AnalogStickR]]
|-
|-
| 0x03000000 || HandheldJoyConRightOnly
| 0x20
| 0x4
| [[#NpadAttributesSet|Attributes]]
|-
|-
| 0x03000001 || HandheldLarkHvc2Only
| 0x24
| 0x4
| Reserved
|}
 
==== NpadSixAxisSensorLifo ====
This is "nn::hid::detail::NpadSixAxisSensorLifo". This is a RingLifo object.
 
{| class="wikitable" border="1"
|-
|-
| 0x03000002 || HandheldLarkNesRightOnly
! Offset
! Size
! Description
|-
|-
| 0x04000000 || HandheldJoyConLeftJoyConRight
| 0x0
| 0x8
| RingLifoVptr
|-
|-
| 0x04000001 || HandheldJoyConLeftLarkHvc2
| 0x8
| 0x8
| BufferCount
|-
|-
| 0x04000002 || HandheldJoyConLeftLarkNesRight
| 0x10
| 0x8
| Tail
|-
|-
| 0x04000003 || HandheldLarkHvc1JoyConRight
| 0x18
| 0x8
| Count
|-
|-
| 0x04000004 || HandheldLarkHvc1LarkHvc2
| 0x20
| 0x68 * 17
| Array of [[#SixAxisSensorStateAtomicStorage]]
|}
 
===== SixAxisSensorStateAtomicStorage =====
This is "nn::hid::detail::SixAxisSensorStateAtomicStorage".
 
{| class="wikitable" border="1"
|-
|-
| 0x04000005 || HandheldLarkHvc1LarkNesRight
! Offset
! Size
! Description
|-
|-
| 0x04000006 || HandheldLarkNesLeftJoyConRight
| 0x0
| 0x8
| SamplingNumber
|-
|-
| 0x04000007 || HandheldLarkNesLeftLarkHvc2
| 0x8
|-
| 0x60
| 0x04000008 || HandheldLarkNesLeftLarkNesRight
| [[#SixAxisSensorState]]
|}
 
====== SixAxisSensorState ======
This is "nn::hid::SixAxisSensorState".
 
{| class="wikitable" border="1"
|-
|-
| 0x05000000 || JoyDual
! Offset
! Size
! Description
|-
|-
| 0x06000000 || JoyDualLeftOnly
| 0x0
| 0x8
| DeltaTime
|-
|-
| 0x07000000 || JoyDualRightOnly
| 0x8
| 0x8
| SamplingNumber
|-
|-
| 0x08000000 || JoyLeftHorizontal
| 0x10
| 0x4
| AccelerationX
|-
|-
| 0x09000000 || JoyLeftVertical
| 0x14
| 0x4
| AccelerationY
|-
|-
| 0x0A000000 || JoyRightHorizontal
| 0x18
| 0x4
| AccelerationZ
|-
|-
| 0x0B000000 || JoyRightVertical
| 0x1C
| 0x4
| AngularVelocityX
|-
|-
| 0x0C000000 || SwitchProController
| 0x20
| 0x4
| AngularVelocityY
|-
|-
| 0x0D000000 || CompatibleProController
| 0x24
| 0x4
| AngularVelocityZ
|-
|-
| 0x0E000000 || CompatibleJoyCon
| 0x28
| 0x4
| AngleX
|-
|-
| 0x0F000000 || LarkHvc1
| 0x2C
| 0x4
| AngleY
|-
|-
| 0x10000000 || LarkHvc2
| 0x30
| 0x4
| AngleZ
|-
|-
| 0x11000000 || LarkNesLeft
| 0x34
| 0x24
| [[#DirectionState|Direction]]
|-
|-
| 0x12000000 || LarkNesRight
| 0x58
| 0x4
| [[#SixAxisSensorAttributeSet|Attributes]]
|-
|-
| 0x13000000 || LuciaU
| 0x5C
|-
| 0x4
| 0x13000001 || LuciaJ
| Reserved
|-
| 0x13000002 || LuciaE
|-
| 0x14000000 || Verification
|-
| 0xFFFFFFFF || Unknown
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || None
! Offset
! Size
! Description
|-
|-
| 1 || HandheldNone
| 0x0
| 0x8
| RingLifoVptr
|-
|-
| 2 || HandheldJoyConLeftOnly
| 0x8
| 0x8
| BufferCount
|-
|-
| 3 || HandheldJoyConRightOnly
| 0x10
| 0x8
| Tail
|-
|-
| 4 || HandheldJoyConLeftJoyConRight
| 0x18
| 0x8
| Count
|-
|-
| 5 || JoyDual
| 0x20
| 0x20 * 2
| Array of [[#NfcXcdDeviceHandleStateImplAtomicStorage]]
|}
 
===== NfcXcdDeviceHandleStateImplAtomicStorage =====
This is "nn::hid::detail::NfcXcdDeviceHandleStateImplAtomicStorage".
 
{| class="wikitable" border="1"
|-
|-
| 6 || JoyDualLeftOnly
! Offset
! Size
! Description
|-
|-
| 7 || JoyDualRightOnly
| 0x0
| 0x8
| SamplingNumber
|-
|-
| 8 || JoyLeftHorizontal
| 0x8
| 0x18
| [[#NfcXcdDeviceHandleStateImpl]]
|}
 
====== NfcXcdDeviceHandleStateImpl ======
This is "nn::hid::detail::NfcXcdDeviceHandleStateImpl".
 
{| class="wikitable" border="1"
|-
|-
| 9 || JoyLeftVertical
! Offset
! Size
! Description
|-
|-
| 10 || JoyRightHorizontal
| 0x0
| 0x8
| [[#DeviceHandle|Handle]]
|-
|-
| 11 || JoyRightVertical
| 0x8
| 0x1
| IsAvailable
|-
|-
| 12 || SwitchProController
| 0x9
| 0x1
| IsActivated
|-
|-
| 13 || CompatibleProController
| 0xA
| 0x6
| Reserved
|-
|-
| 14 || CompatibleJoyCon
| 0x10
|-
| 0x8
| 15 || LarkHvc1
| SamplingNumber
|-
| 16 || LarkHvc2
|-
| 17 || LarkNesLeft
|-
| 18 || LarkNesRight
|-
| 19 || Lucia
|-
| 20 || Verification
|}
|}


= NpadIdType =
==== NpadGcTriggerLifo ====
This is "nn::hid::NpadIdType". This is the controller index used in [[#SharedMemoryFormat|sharedmem]].
This is "nn::hid::detail::NpadGcTriggerLifo". This is a RingLifo object.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0x0 || No1
! Offset
! Size
! Description
|-
|-
| 0x1 || No2
| 0x0
| 0x8
| RingLifoVptr
|-
|-
| 0x2 || No3
| 0x8
| 0x8
| BufferCount
|-
|-
| 0x3 || No4
| 0x10
| 0x8
| Tail
|-
|-
| 0x4 || No5
| 0x18
| 0x8
| Count
|-
|-
| 0x5 || No6
| 0x20
|-
| 0x18 * 17
| 0x6 || No7
| Array of [[#NpadGcTriggerStateAtomicStorage]]
|-
| 0x7 || No8
|-
| 0x10 || Other
|-
| 0x20 || Handheld
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 1 || Bluetooth
! Offset
! Size
! Description
|-
|-
| 2 || Rail
| 0x0
| 0x8
| SamplingNumber
|-
|-
| 3 || USB
| 0x8
|-
| 0x10
| 4 || Unknown
| [[#NpadGcTriggerState]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Invalid
! Offset
! Size
! Description
|-
|-
| 1 || H1
| 0x0
| 0x8
| SamplingNumber
|-
|-
| 2 || H2
| 0x8
| 0x4
| TriggerL
|-
|-
| 3 || NL
| 0xC
|-
| 0x4
| 4 || NR
| TriggerR
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Invalid
! Offset
! Size
! Description
|-
|-
| 1 || J
| 0x0
|-
| 0x708
| 2 || E
| [[#GestureLifo]]
|-
| 3 || U
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || None
! Offset
! Size
! Description
|-
|-
| 1 || Left
| 0x0
| 0x8
| RingLifoVptr
|-
|-
| 2 || Up
| 0x8
| 0x8
| BufferCount
|-
|-
| 3 || Right
| 0x10
| 0x8
| Tail
|-
|-
| 4 || Down
| 0x18
|}
| 0x8
| Count
|-
| 0x20
| 0x68 * 17
| Array of [[#GestureDummyStateAtomicStorage]]
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Idle
! Offset
! Size
! Description
|-
|-
| 1 || Complete
| 0x0
| 0x8
| SamplingNumber
|-
|-
| 2 || Cancel
| 0x8
| 0x60
| [[#GestureDummyState]]
|}
 
====== GestureDummyState ======
This is "nn::hid::detail::GestureDummyState" / "nn::hid::GestureState".
 
{| class="wikitable" border="1"
|-
|-
| 3 || Touch
! Offset
! Size
! Description
|-
|-
| 4 || Press
| 0x0
| 0x8
| SamplingNumber
|-
|-
| 5 || Tap
| 0x8
| 0x8
| ContextNumber
|-
|-
| 6 || Pan
| 0x10
| 0x4
| [[#GestureType|Type]]
|-
|-
| 7 || Swipe
| 0x14
| 0x4
| [[#GestureDirection|Direction]]
|-
|-
| 8 || Pinch
| 0x18
| 0x4
| X
|-
|-
| 9 || Rotate
| 0x1C
|}
| 0x4
 
| Y
= DeviceHandle =
This is "nn::xcd::DeviceHandle". This is a 8 byte value.
 
= DeviceType =
This is "nn::hid::system::DeviceType".
 
{| class="wikitable" border="1"
!  Bits
!  Description
|-
|-
| 0
| 0x20
| FullKey
| 0x4
| s32 DeltaX
|-
|-
| 1
| 0x24
| DebugPad
| 0x4
| s32 DeltaY
|-
|-
| 2
| 0x28
| HandheldLeft
| 0x4
| float VelocityX
|-
|-
| 3
| 0x2C
| HandheldRight
| 0x4
| float VelocityY
|-
|-
| 4
| 0x30
| JoyLeft
| 0x4
| [[#GestureAttributeSet|Attributes]]
|-
|-
| 5
| 0x34
| JoyRight
| 0x4
| Scale
|-
|-
| 6
| 0x38
| Palma
| 0x4
| RotationAngle
|-
|-
| 7
| 0x3C
| LarkHvcLeft
| 0x4
| s32 PointCount
|-
|-
| 8
| 0x40
| LarkHvcRight
| 0x8 * 4
|-
| [[#GesturePoint|Points]]
| 9
|}
| LarkNesLeft
 
== ConsoleSixAxisSensorSharedMemoryFormat ==
This is "nn::hid::detail::ConsoleSixAxisSensorSharedMemoryFormat".
 
{| class="wikitable" border="1"
|-
|-
| 10
! Offset
| LarkNesRight
! Size
! Description
|-
|-
| 11
| 0x0
| HandheldLarkHvcLeft
| 0x8
| SamplingNumber
|-
|-
| 12
| 0x8
| HandheldLarkHvcRight
| 0x1
| IsSevenSixAxisSensorAtRest
|-
|-
| 13
| 0x9
| HandheldLarkNesLeft
| 0x3
| Padding
|-
|-
| 14
| 0xC
| HandheldLarkNesRight
| 0x4
| VerticalizationError
|-
|-
| 15
| 0x10
| Lucia
| 0xC
|-
| GyroBias
| 16-30
| Reserved
|-
| 31
| System
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Bits
!  Description
|-
|-
| 0-7
! Offset
| 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.
! Size
! Description
|-
|-
| 8-10
| 0x0
| Pro Controller
| 0x4
| X
|-
|-
| 11
| 0x4
| Famicom left controller
| 0x4
|-
| Y
| 12
| Famicom right controller (with microphone)
|-
| 13
| NES left controller
|-
| 14
| NES right controller
|-
| 15-16
| Invalid
|-
| 17
| Generic external controller
|-
| 18-20
| Invalid
|-
| 21-23
| Generic controller
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  [[#DeviceType|DeviceType]]
!  [[#UniquePadType|UniquePadType]]
!  Description
|-
|-
| 1 || JoyRight, HandheldRight || JoyRight || Joy-Con right controller
! Offset
! Size
! Description
|-
|-
| 2 || JoyLeft, HandheldLeft || JoyLeft || Joy-Con left controller
| 0x0
| 0x8
| DeltaTime
|-
|-
| 3 || FullKey || FullKey || Pro Controller
| 0x8
| 0x4
| [[#TouchAttributeSet|Attributes]]
|-
|-
| 4 || JoyLeft || JoyLeft || Reserved
| 0xC
| 0x4
| FingerId
|-
|-
| 5 || JoyRight || JoyRight || Reserved
| 0x10
| 0x4
| X
|-
|-
| 6 || FullKey || FullKey || Reserved
| 0x14
| 0x4
| Y
|-
|-
| 7 || LarkHvcLeft, HandheldLarkHvcLeft || JoyLeft || Famicom left controller
| 0x18
| 0x4
| DiameterX
|-
|-
| 8 || LarkHvcRight, HandheldLarkHvcRight || JoyRight || Famicom right controller (with microphone)
| 0x1C
| 0x4
| DiameterY
|-
|-
| 9 || LarkNesLeft, HandheldLarkNesLeft || JoyLeft || NES left controller
| 0x20
| 0x4
| RotationAngle
|-
|-
| 10 || LarkNesRight, HandheldLarkNesRight || JoyRight || NES right controller
| 0x24
|-
| 0x4
| 11 || Lucia || FullKey || SNES controller
| Reserved
|-
| 12 || Palma || Other || Poké Ball Plus controller
|-
| 13 || FullKey || FullKey || Gc controller
|-
| 14 || HandheldLeft || JoyLeft || Reserved
|-
| 15 || FullKey || FullKey || Reserved
|-
| 16 || FullKey || FullKey || Reserved
|-
| 17 || DebugPad || DebugPad || Debug controller
|-
| 18 || HandheldRight || JoyRight || Reserved
|-
| 19 || System || Other || Unknown (has [[#NpadStyleTag|NpadFullKey]] style tag)
|-
| 20 || System || Other || Unknown (has [[#NpadStyleTag|NpadJoyDual]] style tag)
|-
| 21 || System || Other || Unknown (has [[#NpadStyleTag|NpadJoyDual]] style tag)
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 6,404: Line 6,505:
| 0x0
| 0x0
| 0x1
| 0x1
| IsPowered
| [[#TouchScreenModeForNx|Mode]]
|-
|-
| 0x1
| 0x8
| 0x1
| 0xF
| IsCharging
|-
| 0x2
| 0x6
| Reserved
| Reserved
|-
| 0x8
| 0x6
| [[#BatteryLevel|BatteryLevel]]
|}
|}


= BatteryLevel =
= TouchScreenModeForNx =
This is "nn::hid::system::NpadBatteryLevel". This is a 4 byte value.
This is "nn::hid::TouchScreenModeForNx".
 
= 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.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
! Offset || Size || Description
| 0 || UseSystemSetting
|-
|-
| 0x0 || 0x4 || TypeValue
| 1 || Finger
|-
| 0x0 || 0x1 ||  
|-
|-
| 0x1 || 0x1 ||  
| 2 || Heat2
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset
! Size
! Description
|-
|-
| 0x0 || 0x4 || TypeValue
| 0x0
|-
| 0x8
| 0x0 || 0x1 || NpadStyleIndex
| Timestamp
|-
| 0x1 || 0x1 || PlayerNumber / [[#NpadIdType]]
|-
| 0x2 || 0x1 || Idx
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset
! Size
! Description
|-
|-
| 0x0 || 0x4 || TypeValue
| 0x0
| 0x4
| Main
|-
|-
| 0x0 || 0x1 || NpadStyleIndex
| 0x4
|-
| 0x4
| 0x1 || 0x1 || [[#NpadIdType|PlayerNumber]]
| Sub
|-
| 0x2 || 0x1 || DeviceIdx
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset
! Size
! Description
|-
|-
| 0x0 || 0x4 || [[#VibrationDeviceType|DeviceType]]
| 0x0
| 0x4
| [[#ColorAttribute|Attribute]]
|-
|-
| 0x4 || 0x4 || [[#VibrationDevicePosition|Position]]
| 0x4
| 0x8
| [[#NpadControllerColor|FullKey]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Unknown
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| [[#ColorAttribute|Attribute]]
|-
|-
| 1 || LinearResonantActuator
| 0x4
| 0x8
| [[#NpadControllerColor|Left]]
|-
|-
| 2 || GcErm
| 0xC
| 0x8
| [[#NpadControllerColor|Right]]
|}
|}


= VibrationDevicePosition =
= DirectionState =
This is "nn::hid::VibrationDevicePosition".
This is "nn::hid::DirectionState".
 
{| class="wikitable" border="1"
!  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.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 6,521: Line 6,609:
| 0x0
| 0x0
| 0x4
| 0x4
| AmplitudeLow
| XX
|-
|-
| 0x4
| 0x4
| 0x4
| 0x4
| FrequencyLow
| XY
|-
|-
| 0x8
| 0x8
| 0x4
| 0x4
| AmplitudeHigh
| XZ
|-
|-
| 0xC
| 0xC
| 0x4
| 0x4
| FrequencyHigh
| YX
|-
| 0x10
| 0x4
| YY
|-
| 0x14
| 0x4
| YZ
|-
| 0x18
| 0x4
| ZX
|-
| 0x1C
| 0x4
| ZY
|-
| 0x20
| 0x4
| ZZ
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Name
!  Description
|-
|-
| 0 || Stop || Stops the vibration with a decay phase.
! Offset
! Size
! Description
|-
|-
| 1 || Start || Starts the vibration.
| 0x0
| 0x4
| X
|-
|-
| 2 || StopHard || Stops the vibration immediately, with no decay phase.
| 0x4
| 0x4
| Y
|}
|}


= AccelerometerPlayMode =
= ColorAttribute =
This is "nn::hid::debug::AccelerometerPlayMode" (pre-10.0.0 this is "nn::hid::AccelerometerPlayMode").
This is "nn::hid::detail::ColorAttribute".
 
= GyroscopeZeroDriftMode =
This is "nn::hid::GyroscopeZeroDriftMode".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 6,561: Line 6,669:
!  Description
!  Description
|-
|-
| 0 || Loose
| 0 || Ok
|-
|-
| 1 || Standard
| 1 || ReadError
|-
|-
| 2 || Tight
| 2 || NoController
|}
|}


= AbstractedPadState =
= 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.
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Bit
! Description
|-
|-
| 0x0 || 0x4 || Type, only 1 bit can be set. Converted to [[#HdlsDeviceInfo]]::type internally by [[#SetAutoPilotVirtualPadState]].
| 0
|-
| IsConnected
| 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.
= 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.


Type:
{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Bits
!  [[#HdlsDeviceInfo]]::type bits
!  Description
!  Notes
|-
|-
| 0 || 0 || ||
! Bit
! Description
|-
| 0
| Start
|-
|-
| 1 || 15 || || [[#DeviceType]] |= BIT(1)
| 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.
 
{| class="wikitable" border="1"
|-
|-
| 2 || 1 || ||
! Bit
! Description
|-
|-
| 3 || 2 || ||  
| 0
| Transferable
|-
|-
| 4 || 1 || ||
| 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.
 
{| class="wikitable" border="1"
|-
|-
| 5 || 2 || ||
! Bit
! Description
|-
|-
| 6 || 3 || ||  
| 0
| IsConnected
|-
|-
| 7 || 11 || || [[#DeviceType]] |= BIT(11)
| 1
| IsWired
|-
|-
| 8 || 12 || || [[#DeviceType]] |= BIT(12)
| 2
| IsLeftConnected
|-
|-
| 9 || 13 || || [[#DeviceType]] |= BIT(13)
| 3
| IsLeftWired
|-
|-
| 10 || 14 || || [[#DeviceType]] |= BIT(14)
| 4
| IsRightConnected
|-
|-
| 11 || 15 || || [[#DeviceType]] |= BIT(11)
| 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.
 
{| class="wikitable" border="1"
|-
|-
| 12 || 12 || || [[#DeviceType]] |= BIT(12)
! Bit
! Description
|-
|-
| 13 || 13 || || [[#DeviceType]] |= BIT(13)
| 0
|-
| IsConnected
| 14 || 14 || || [[#DeviceType]] |= BIT(14)
|-
| 15 || 17 || ||
|-
| 31 || 21 || || [[#DeviceType]] = BIT(31)
|-
|-
| 1
| IsInterpolated
|}
|}


The above "[[#DeviceType]] |=" notes only apply when type2 is 0x2.
= GestureAttributeSet =
This is "nn::hid::GestureAttributeSet". This is a BitFlagSet object for [[#GestureAttribute]].


= HdlsHandle =
= GestureAttribute =
This is "nn::hid::debug::HdlsHandle". This is a 0x8-byte struct with 8-byte alignment.
This is "nn::hid::GestureAttribute". This is a 32-bit flag.
 
= HdlsNpadAssignment =
This is a 0x208-byte struct.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Bit
! Description
|-
|-
| 0x0 || 0x4 || s32 Total entries
| 4
| IsNewTouch
|-
|-
| 0x4 || 0x4 || Padding
| 8
|-
| IsDoubleTap
| 0x8 || 0x200(0x20*0x10) || Array of [[#HdlsNpadAssignmentEntry]].
|}
|}


= HdlsNpadAssignmentEntry =
= DebugPadButtonSet =
This is a 0x20-byte struct.
This is "nn::hid::DebugPadButtonSet". This is a BitFlagSet object for [[#DebugPadButton]].
 
= DebugPadButton =
This is "nn::hid::DebugPadButton". This is a 32-bit flag.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Bit
! Description
|-
|-
| 0x0 || 0x8 || [[#HdlsHandle]]
| 0
| A
|-
| 1
| B
|-
| 2
| X
|-
| 3
| Y
|-
| 4
| L
|-
|-
| 0x8 || 0x4 || ?
| 5
| R
|-
|-
| 0xC || 0x4 || ?
| 6
| ZL
|-
|-
| 0x10 || 0x8 || ?
| 7
| ZR
|-
|-
| 0x18 || 0x1 || ?
| 8
| Start
|-
|-
| 0x19 || 0x7 || Padding
| 9
|}
| Select
 
= HdlsStateList =
This is a 0x408-byte struct.
 
[9.0.0+] This is a 0x488-byte struct.
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 10
| Left
|-
|-
| 0x0 || 0x4 || s32 Total entries
| 11
| Up
|-
|-
| 0x4 || 0x4 || Padding
| 12
| Right
|-
|-
| 0x8 || <[[#HdlsStateListEntry]] size>*0x10 || Array of [[#HdlsStateListEntry]].
| 13
| Down
|}
|}


This contains a list of all controllers, including non-virtual controllers.
= MouseButtonSet =
This is "nn::hid::MouseButtonSet". This is a BitFlagSet object for [[#MouseButton]].


= HdlsStateListEntry =
= MouseButton =
This is a 0x40-byte struct.
This is "nn::hid::MouseButton". This is a 32-bit flag.
 
[9.0.0+] This is a 0x48-byte struct.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Bit
! Description
|-
| 0
| Left
|-
|-
| 0x0 || 0x8 || [[#HdlsHandle]]
| 1
| Right
|-
|-
| 0x8 || [[#HdlsDeviceInfo]] size || [[#HdlsDeviceInfo]]. With [[#ApplyHdlsStateList]] this is only used when creating new devices.
| 2
| Middle
|-
|-
| 0x8 + [[#HdlsDeviceInfo]] size, with 8-byte alignment || 0x24 || [[#HdlsState]]
| 3
| Forward
|-
|-
| <Immediately following the above> || 0x4 || Padding
| 4
| Back
|}
|}


= HdlsDeviceInfo =
= KeyboardModifierSet =
This is a 0x10-byte struct.
This is "nn::hid::KeyboardModifierSet". This is a BitFlagSet object for [[#KeyboardModifier]].
 
= KeyboardModifier =
This is "nn::hid::KeyboardModifier". This is a 32-bit flag.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Bit
! Description
|-
|-
| 0x0 || 0x4 || [[#DeviceTypeInternal]]
| 0
| Control
|-
|-
| 0x4 || 0x4 || RGBA Single Body Color
| 1
| Shift
|-
|-
| 0x8 || 0x4 || RGBA Single Buttons Color
| 2
| LeftAlt
|-
|-
| 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.
| 3
| RightAlt
|-
|-
| 0xD || 0x3 || Padding
| 4
|}
| Gui
 
[9.0.0+] This is a 0x14-byte struct.
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 8
| CapsLock
|-
|-
| 0x0 || 0x1 || [[#DeviceTypeInternal]]
| 9
| ScrollLock
|-
|-
| 0x1 || 0x1 || [[#NpadInterfaceType]]. Similar to the field from the old struct.
| 10
| NumLock
|-
|-
| 0x2 || 0x2 || Padding
| 11
| Katakana
|-
|-
| 0x4 || 0x4 || RGBA Single Body Color
| 12
|-
| Hiragana
| 0x8 || 0x4 || RGBA Single Buttons Color
|-
| 0xC || 0x4 || RGBA Left Grip Color
|-
| 0x10 || 0x4 || RGBA Right Grip Color
|}
|}


= HdlsState =
= KeyboardKeySet =
This is a 0x24-byte struct.
This is "nn::hid::KeyboardKeySet". This is a BitFlagSet object for [[#KeyboardKey]].
 
= KeyboardKey =
This is "nn::hid::KeyboardKey". This is a 256-bit flag.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Bit
! Description
|-
|-
| 0x0 || 0x1 || IsPowered for the main PowerInfo.
| 4
| A
|-
|-
| 0x1 || 0x1 || ORRed with IsPowered to set the value of the first byte for the controller [[#NpadSystemProperties]].
| 5
| B
|-
|-
| 0x2 || 0x6 || Unknown
| 6
| C
|-
|-
| 0x8 || 0x4 || BatteryLevel for the main PowerInfo.
| 7
| D
|-
|-
| 0xC || 0x4 || [[#NpadButton|Buttons]]. Bit18 = HOME and bit19 = Capture.
| 8
| E
|-
|-
| 0x10 || 0x10(4*2*2) || Joystick data.
| 9
| F
|-
|-
| 0x20 || 0x1 || Unused for input. Set with output from [[#DumpHdlsStates]] (zero in some cases).
| 10
| G
|-
|-
| 0x21 || 0x3 || Padding
| 11
|}
| H
 
[9.0.0+]:
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 12
| I
|-
|-
| 0x0 || 0x4 || BatteryLevel for the main PowerInfo.
| 13
| J
|-
|-
| 0x4 || 0x4 || Flags. Used to set the main PowerInfo for [[#NpadSystemProperties]]. Bit0 -> IsPowered, bit1 -> IsCharging.
| 14
| K
|-
|-
| 0x8 || 0x8 || [[#NpadButton|Buttons]], masked with 0xfffffffff00fffff. See above table regarding HOME/Capture buttons.
| 15
| L
|-
|-
| 0x10 || 0x10(4*2*2) || Joystick data.
| 16
| M
|-
|-
| 0x20 || 0x1 || Unused for input. Set with output from [[#DumpHdlsStates]] (zero in some cases).
| 17
| N
|-
|-
| 0x21 || 0x3 || Padding
| 18
|}
| O
 
= NotificationLedPattern =
This is "nn::hid::system::NotificationLedPattern". This is a 0x48-byte struct.
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Subcommand argdata bytepos || Subcommand argdata nibble || Description
| 19
| P
|-
|-
| 0x0 || 0x1 || 0x0 || Low || Mini Cycle Base Duration. Value 0x1-0xF: 12.5ms - 187.5ms. Value 0x0 = 0ms/OFF.
| 20
| Q
|-
|-
| 0x1 || 0x1 || 0x0 || High || Number of Mini Cycles + 1. Value 0x0-0xF: 1 - 16 mini cycles.
| 21
| R
|-
|-
| 0x2 || 0x1 || 0x1 || Low || Number of Full Cycles. Value 0x1-0xF: 1 - 15 full cycles. Value 0x0 is repeat forever, but if Mini Cycle Base Duration is set to 0x0, it does the 1st Mini Cycle with a 12.5ms base duration and then the LED stays on with LED Start Intensity.
| 22
| S
|-
|-
| 0x3 || 0x1 || 0x1 || High || LED Start Intensity. Value 0x0-0xF: 0% - 100%. (In HW, 1 - 241 duty)
| 23
| T
|-
|-
| 0x4 || 0x1 || 0x2 || High || Mini Cycle 1 LED Intensity. Value 0x0-0xF: 0% - 100%. (In HW, 1 - 241 duty)
| 24
| U
|-
|-
| 0x5 || 0x1 || 0x3 || High || Fading Transition Steps to Mini Cycle 1 (Uses PWM). Value 0x0: Instant. Each step duration is based on Mini Cycle Step Duration Multiplier.
| 25
| V
|-
|-
| 0x6 || 0x1 || 0x3 || Low || Final Step Duration Multiplier of Mini Cycle 1. Value is a Multiplier of Mini Cycle Base Duration. Value 0x0: 12.5ms, 0x1 - xF: 1x - 15x.
| 26
| W
|-
|-
| 0x7 || 0x1 || || || Unused
| 27
| X
|-
|-
| 0x8 || 0x1 || 0x2 || Low || Mini Cycle 2 LED Intensity.
| 28
| Y
|-
|-
| 0x9 || 0x1 || 0x4 || High || Fading Transition Steps to Mini Cycle 2 (see above).
| 29
| Z
|-
|-
| 0xA || 0x1 || 0x4 || Low || Final Step Duration Multiplier of Mini Cycle 2 (see above).
| 30
| D1
|-
|-
| 0xB || 0x1 || || || Unused
| 31
| D2
|-
|-
| 0xC || 0x1 || 0x5 || High || Mini Cycle 3 LED Intensity.
| 32
| D3
|-
|-
| 0xD || 0x1 || 0x6 || High || Fading Transition Steps to Mini Cycle 3 (see above).
| 33
| D4
|-
|-
| 0xE || 0x1 || 0x6 || Low || Final Step Duration Multiplier of Mini Cycle 3 (see above).
| 34
| D5
|-
|-
| 0xF || 0x1 || || || Unused
| 35
| D6
|-
|-
| 0x10 || 0x1 || 0x5 || Low || Mini Cycle 4 LED Intensity.
| 36
| D7
|-
|-
| 0x11 || 0x1 || 0x7 || High || Fading Transition Duration to Mini Cycle 4 (see above).
| 37
| D8
|-
|-
| 0x12 || 0x1 || 0x7 || Low || Final Step Duration Multiplier of Mini Cycle 4 (see above).
| 38
| D9
|-
|-
| 0x13 || 0x1 || || || Unused
| 39
| D0
|-
|-
| 0x14 || 0x1 || 0x8 || High || Mini Cycle 5 LED Intensity.
| 40
| Return
|-
|-
| 0x15 || 0x1 || 0x9 || High || Fading Transition Steps to Mini Cycle 5 (see above).
| 41
| Escape
|-
|-
| 0x16 || 0x1 || 0x9 || Low || Final Step Duration Multiplier of Mini Cycle 5 (see above).
| 42
| Backspace
|-
|-
| 0x17 || 0x1 || || || Unused
| 43
| Tab
|-
|-
| 0x18 || 0x1 || 0x8 || Low || Mini Cycle 6 LED Intensity.
| 44
| Space
|-
|-
| 0x19 || 0x1 || 0xA || High || Fading Transition Steps to Mini Cycle 6 (see above).
| 45
| Minus
|-
|-
| 0x1A || 0x1 || 0xA || Low || Final Step Duration Multiplier of Mini Cycle 6 (see above).
| 46
| Plus
|-
|-
| 0x1B || 0x1 || || || Unused
| 47
| OpenBracket
|-
|-
| 0x1C || 0x1 || 0xB || High || Mini Cycle 7 LED Intensity.
| 48
| CloseBracket
|-
|-
| 0x1D || 0x1 || 0xC || High || Fading Transition Steps  to Mini Cycle 7 (see above).
| 49
| Pipe
|-
|-
| 0x1E || 0x1 || 0xC || Low || Final Step Duration Multiplier of Mini Cycle 7 (see above).
| 50
| Tilde
|-
|-
| 0x1F || 0x1 || || || Unused
| 51
| Semicolon
|-
|-
| 0x20 || 0x1 || 0xB || Low || Mini Cycle 8 LED Intensity.
| 52
| Quote
|-
|-
| 0x21 || 0x1 || 0xD || Low || Fading Transition Steps to Mini Cycle 8 (see above).
| 53
| Backquote
|-
|-
| 0x22 || 0x1 || 0xD || High || Final Step Duration Multiplier of Mini Cycle 8 (see above).
| 54
| Comma
|-
|-
| 0x23 || 0x1 || || || Unused
| 55
| Period
|-
|-
| 0x24 || 0x1 || 0xE || High || Mini Cycle 9 LED Intensity.
| 56
| Slash
|-
|-
| 0x25 || 0x1 || 0xF || High || Fading Transition Steps to Mini Cycle 9 (see above).
| 57
| CapsLock
|-
|-
| 0x26 || 0x1 || 0xF || Low || Final Step Duration Multiplier of Mini Cycle 9 (see above).
| 58
| F1
|-
|-
| 0x27 || 0x1 || || || Unused
| 59
| F2
|-
|-
| 0x28 || 0x1 || 0xE || Low || Mini Cycle 10 LED Intensity.
| 60
| F3
|-
|-
| 0x29 || 0x1 || 0x10 || High || Fading Transition Steps to Mini Cycle 10 (see above).
| 61
| F4
|-
|-
| 0x2A || 0x1 || 0x10 || Low || Final Step Duration Multiplier of Mini Cycle 10 (see above).
| 62
| F5
|-
|-
| 0x2B || 0x1 || || || Unused
| 63
| F6
|-
|-
| 0x2C || 0x1 || 0x11 || High || Mini Cycle 11 LED Intensity.
| 64
| F7
|-
|-
| 0x2D || 0x1 || 0x12 || High || Fading Transition Steps to Mini Cycle 11 (see above).
| 65
| F8
|-
|-
| 0x2E || 0x1 || 0x12 || Low || Final Step Duration Multiplier of Mini Cycle 11 (see above).
| 66
| F9
|-
|-
| 0x2F || 0x1 || || || Unused
| 67
| F10
|-
|-
| 0x30 || 0x1 || 0x11 || Low || Mini Cycle 12 LED Intensity.
| 68
| F11
|-
|-
| 0x31 || 0x1 || 0x13 || High || Fading Transition Steps to Mini Cycle 12 (see above).
| 69
| F12
|-
|-
| 0x32 || 0x1 || 0x13 || Low || Final Step Duration Multiplier of Mini Cycle 12 (see above).
| 70
| PrintScreen
|-
|-
| 0x33 || 0x1 || || || Unused
| 71
| ScrollLock
|-
|-
| 0x34 || 0x1 || 0x14 || High || Mini Cycle 13 LED Intensity.
| 72
| Pause
|-
|-
| 0x35 || 0x1 || 0x15 || High || Fading Transition Steps to Mini Cycle 13 (see above).
| 73
| Insert
|-
|-
| 0x36 || 0x1 || 0x15 || Low || Final Step Duration Multiplier of Mini Cycle 13 (see above).
| 74
| Home
|-
|-
| 0x37 || 0x1 || || || Unused
| 75
| PageUp
|-
|-
| 0x38 || 0x1 || 0x14 || Low || Mini Cycle 14 LED Intensity.
| 76
| Delete
|-
|-
| 0x39 || 0x1 || 0x16 || High || Fading Transition Steps to Mini Cycle 14 (see above).
| 77
| End
|-
|-
| 0x3A || 0x1 || 0x16 || Low || Final Step Duration Multiplier of Mini Cycle 14 (see above).
| 78
| PageDown
|-
|-
| 0x3B || 0x1 || || || Unused
| 79
| RightArrow
|-
|-
| 0x3C || 0x1 || 0x17 || High || Mini Cycle 15 LED Intensity.
| 80
| LeftArrow
|-
|-
| 0x3D || 0x1 || 0x18 || High || Fading Transition Steps to Mini Cycle 15 (see above).
| 81
| DownArrow
|-
|-
| 0x3E || 0x1 || 0x18 || Low || Final Step Duration Multiplier of Mini Cycle 15 (see above).
| 82
| UpArrow
|-
|-
| 0x3F || 0x1 || || || Unused
| 83
| NumLock
|-
|-
| 0x40 || 0x1 || 0x17 || Low || Mini Cycle 16 LED Intensity.
| 84
| NumPadDivide
|-
|-
| 0x41 || 0x1 || 0x19 || High || Fading Transition Steps to Mini Cycle 16 (see above). (Unused in older Joy-Con / Pro-Con FW. Unknown for new.)
| 85
| NumPadMultiply
|-
|-
| 0x42 || 0x1 || 0x19 || Low || Final Step Duration Multiplier of Mini Cycle 16 (see above). (Unused in older Joy-Con / Pro-Con FW. Unknown for new.)
| 86
| NumPadSubtract
|-
|-
| 0x43 || 0x1 || || || Unused
| 87
| NumPadAdd
|-
|-
| 0x44 || 0x1 || 0x1A || High || Unknown (Unused in older Joy-Con / Pro-Con FW. Unknown for new.)
| 88
| NumPadEnter
|-
|-
| 0x45 || 0x1 || 0x1A || Low || Unknown (Unused in older Joy-Con / Pro-Con FW. Unknown for new.)
| 89
| NumPad1
|-
|-
| 0x46 || 0x1 || || || Padding
| 90
| NumPad2
|-
|-
| 0x47 || 0x1 || || || Padding
| 91
| NumPad3
|-
|-
|}
| 92
 
| NumPad4
The above descriptions in the table are based on the info from [https://github.com/dekuNukem/Nintendo_Switch_Reverse_Engineering/blob/master/bluetooth_hid_subcommands_notes.md here].
 
argdata in the subcommand is initialized as follows: <code>((u8*)cmd_argdata)[pos] = u8_in[pos2] | u8_in[pos3]<<4;</code> Hence, 4bits from pairs of 2-bytes of the input struct are combined to write to the subcommand. Only the low 4bits of each used byte in the struct is used. This is written to stack initially, then copied to the actual cmd_argdata (the data immediately following the subcommandID byte). There's a total of 0x1B-bytes of cmd_argdata initialized from this.
 
The layout of cmd_argdata is as follows:
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 93
| NumPad5
|-
|-
| 0x0 || 0x1B || See above.
| 94
| NumPad6
|-
|-
| 0x1B || 0xB || Cleared to zero.
| 95
| NumPad7
|-
|-
| 0x26 || 0x5 || Unused
| 96
| NumPad8
|-
|-
| 0x2B || 0x8 || Set to an input value, which is hard-coded 0.
| 97
| NumPad9
|-
|-
| 0x33 || 0x2 || Set to value 0.
| 98
| NumPad0
|-
|-
| 0x35 || 0x1 || Set to value 1.
| 99
|}
| NumPadDot
 
= SystemButtonConfigEmbedded =
This is "nn::hid::system::ButtonConfigEmbedded". This is a 0x2C8-byte struct.
 
= SystemButtonConfigFull =
This is "nn::hid::system::ButtonConfigFull". This is a 0x2C8-byte struct.
 
= SystemButtonConfigLeft =
This is "nn::hid::system::ButtonConfigLeft". This is a 0x1C8-byte struct.
 
= SystemButtonConfigRight =
This is "nn::hid::system::ButtonConfigRight". This is a 0x1A0-byte struct.
 
= ButtonConfigEmbedded =
This is "nn::hidconfig::ButtonConfigEmbedded". This is a 0x54-byte struct.
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 100
| Backslash
|-
|-
| 0x0 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonLeft]]
| 101
| Application
|-
|-
| 0x4 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonUp]]
| 102
| Power
|-
|-
| 0x8 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonRight]]
| 103
| NumPadEquals
|-
|-
| 0xC || 0x4 || [[#DigitalButtonAssignment|HardwareButtonDown]]
| 104
| F13
|-
|-
| 0x10 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonA]]
| 105
| F14
|-
|-
| 0x14 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonB]]
| 106
| F15
|-
|-
| 0x18 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonX]]
| 107
| F16
|-
|-
| 0x1C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonY]]
| 108
| F17
|-
|-
| 0x20 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStickL]]
| 109
| F18
|-
|-
| 0x24 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStickR]]
| 110
| F19
|-
|-
| 0x28 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonL]]
| 111
| F20
|-
|-
| 0x2C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonR]]
| 112
| F21
|-
|-
| 0x30 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonZL]]
| 113
| F22
|-
|-
| 0x34 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonZR]]
| 114
| F23
|-
|-
| 0x38 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonSelect]]
| 115
| F24
|-
|-
| 0x3C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStart]]
| 133
| NumPadComma
|-
|-
| 0x40 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonCapture]]
| 135
| Ro
|-
|-
| 0x44 || 0x8 || [[#AnalogStickAssignment|HardwareStickL]]
| 136
| KatakanaHiragana
|-
|-
| 0x4C || 0x8 || [[#AnalogStickAssignment|HardwareStickR]]
| 137
|}
| Yen
 
== DigitalButtonAssignment ==
This is "nn::hidconfig::DigitalButtonAssignment".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || DigitalButtonAssignment_A
| 138
| Henkan
|-
|-
| 1 || DigitalButtonAssignment_B
| 139
| Muhenkan
|-
|-
| 2 || DigitalButtonAssignment_X
| 140
| NumPadCommaPc98
|-
|-
| 3 || DigitalButtonAssignment_Y
| 144
| HangulEnglish
|-
|-
| 4 || DigitalButtonAssignment_StickL
| 145
| Hanja
|-
|-
| 5 || DigitalButtonAssignment_StickR
| 146
| Katakana
|-
|-
| 6 || DigitalButtonAssignment_L
| 147
| Hiragana
|-
|-
| 7 || DigitalButtonAssignment_R
| 148
| ZenkakuHankaku
|-
|-
| 8 || DigitalButtonAssignment_ZL
| 224
| LeftControl
|-
|-
| 9 || DigitalButtonAssignment_ZR
| 225
| LeftShift
|-
|-
| 10 || DigitalButtonAssignment_Select
| 226
| LeftAlt
|-
|-
| 11 || DigitalButtonAssignment_Start
| 227
| LeftGui
|-
|-
| 12 || DigitalButtonAssignment_Left
| 228
| RightControl
|-
|-
| 13 || DigitalButtonAssignment_Up
| 229
| RightShift
|-
|-
| 14 || DigitalButtonAssignment_Right
| 230
| RightAlt
|-
|-
| 15 || DigitalButtonAssignment_Down
| 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.
 
{| class="wikitable" border="1"
|-
|-
| 16 || DigitalButtonAssignment_LeftSL
! Bit
! Description
|-
|-
| 17 || DigitalButtonAssignment_LeftSR
| 0
| NumLockOn
|-
|-
| 18 || DigitalButtonAssignment_RightSL
| 1
| NumLockOff
|-
|-
| 19 || DigitalButtonAssignment_RightSR
| 2
| NumLockToggle
|-
|-
| 20 || DigitalButtonAssignment_HomeButton
| 3
| CapsLockOn
|-
|-
| 21 || DigitalButtonAssignment_CaptureButton
| 4
| CapsLockOff
|-
|-
| 22 || DigitalButtonAssignment_Invalid
| 5
|}
| CapsLockToggle
 
== AnalogStickAssignment ==
This is "nn::hidconfig::AnalogStickAssignment".
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 6
| ScrollLockOn
|-
|-
| 0x0 || 0x4 || [[#AnalogStickRotation]]
| 7
| ScrollLockOff
|-
|-
| 0x4 || 0x1 || IsPairedStickAssigned
| 8
|-
| ScrollLockToggle
| 0x5 || 0x3 || Padding
|}
|}


== AnalogStickRotation ==
= BasicXpadButtonSet =
This is "nn::hidconfig::AnalogStickRotation".
This is "nn::hid::BasicXpadButtonSet". This is a BitFlagSet object for [[#BasicXpadButton]].


{| class="wikitable" border="1"
= HomeButtonSet =
!  Value
This is "nn::hid::system::HomeButtonSet". This is a BitFlagSet object for [[#HomeButton]].
!  Description
|-
| 0 || AnalogStickRotation_None
|-
| 1 || AnalogStickRotation_Clockwise90
|-
| 2 || AnalogStickRotation_Anticlockwise90
|}


= ButtonConfigFull =
= SleepButtonSet =
This is "nn::hidconfig::ButtonConfigFull". This is a 0x54-byte struct.
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]].


This is identical to [[#ButtonConfigEmbedded]].
= NpadButtonSet =
This is "nn::hid::NpadButtonSet". This is a BitFlagSet object for [[#NpadButton]].


= ButtonConfigLeft =
= NpadButton =
This is "nn::hidconfig::ButtonConfigLeft". This is a 0x34-byte struct.
This is "nn::hid::NpadButton". This is a 64-bit flag.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Bit
! Description
|-
| 0
| A
|-
|-
| 0x0 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonLeft]]
| 1
| B
|-
|-
| 0x4 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonUp]]
| 2
| X
|-
|-
| 0x8 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonRight]]
| 3
| Y
|-
|-
| 0xC || 0x4 || [[#DigitalButtonAssignment|HardwareButtonDown]]
| 4
| StickL
|-
|-
| 0x10 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStickL]]
| 5
| StickR
|-
|-
| 0x14 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonL]]
| 6
| L
|-
|-
| 0x18 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonZL]]
| 7
| R
|-
|-
| 0x1C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonSelect]]
| 8
| ZL
|-
|-
| 0x20 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonLeftSL]]
| 9
| ZR
|-
|-
| 0x24 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonLeftSR]]
| 10
| Plus
|-
|-
| 0x28 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonCapture]]
| 11
| Minus
|-
|-
| 0x2C || 0x8 || [[#AnalogStickAssignment|HardwareStickL]]
| 12
|}
| Left
 
= ButtonConfigRight =
This is "nn::hidconfig::ButtonConfigRight". This is a 0x30-byte struct.
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 13
| Up
|-
|-
| 0x0 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonA]]
| 14
| Right
|-
|-
| 0x4 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonB]]
| 15
| Down
|-
|-
| 0x8 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonX]]
| 16
| StickLLeft
|-
|-
| 0xC || 0x4 || [[#DigitalButtonAssignment|HardwareButtonY]]
| 17
| StickLUp
|-
|-
| 0x10 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStickR]]
| 18
| StickLRight
|-
|-
| 0x14 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonR]]
| 19
| StickLDown
|-
|-
| 0x18 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonZR]]
| 20
| StickRLeft
|-
|-
| 0x1C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStart]]
| 21
| StickRUp
|-
|-
| 0x20 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonRightSL]]
| 22
| StickRRight
|-
|-
| 0x24 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonRightSR]]
| 23
| StickRDown
|-
|-
| 0x28 || 0x8 || [[#AnalogStickAssignment|HardwareStickR]]
| 24
|}
| LeftSL
 
= IrCameraHandle =
This is "nn::irsensor::IrCameraHandle".
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 25
| LeftSR
|-
|-
| 0x0 || 0x1 || PlayerNumber
| 26
| RightSL
|-
|-
| 0x1 || 0x1 || DeviceType
| 27
| RightSR
|-
|-
| 0x2 || 0x2 || Reserved
| 28
|}
| Palma
 
|-
= IrCameraStatus =
| 29
This is "nn::irsensor::IrCameraStatus".
| Verification
 
|-
{| class="wikitable" border="1"
| 30
!  Value
| HandheldLeftB (Left B button on NES controllers in Handheld mode)
!  Description
|-
| 31
| [12.0.0+] LeftC (Left C button in N64 controller)
|-
|-
| 0 || Available
| 32
| [12.0.0+] UpC (Up C button in N64 controller)
|-
|-
| 1 || Unsupported
| 33
| [12.0.0+] RightC (Right C button in N64 controller)
|-
|-
| 2 || Unconnected
| 34
| [12.0.0+] DownC (Down C button in N64 controller)
|}
|}


= IrCameraInternalStatus =
= AnalogStickCalibrationFlagsSet =
This is "nn::irsensor::IrCameraInternalStatus".
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".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Bits
!  Description
!  Description
|-
|-
| 0 || Stopped
| 0
| NpadStyleFullKey (Pro Controller)
|-
| 1
| NpadStyleHandheld (Joy-Con controller in handheld mode)
|-
| 2
| NpadStyleJoyDual (Joy-Con controller in dual mode)
|-
|-
| 1 || FirmwareUpdateNeeded
| 3
| NpadStyleJoyLeft (Joy-Con left controller in single mode)
|-
|-
| 2 ||  
| 4
| NpadStyleJoyRight (Joy-Con right controller in single mode)
|-
|-
| 3 ||  
| 5
| NpadStyleGc (GameCube controller)
|-
|-
| 4 ||  
| 6
| NpadStylePalma (Poké Ball Plus controller)
|-
|-
| 5 || FirmwareVersionRequested
| 7
| NpadStyleLark (NES/Famicom controller)
|-
|-
| 6 || FirmwareVersionIsInvalid
| 8
| NpadStyleHandheldLark (NES/Famicom controller in handheld mode)
|-
|-
| 7 || [4.0.0+] Ready
| 9
| NpadStyleLucia (SNES controller)
|-
|-
| 8 || [4.0.0+] Setting
| 10
|}
| [12.0.0+] NpadStyleLagon (N64 controller)
 
= IrSensorMode =
This is "nn::irsensor::detail::StatusManager::IrSensorMode".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || None
| 11
| [13.0.0+] NpadStyleLager (Sega Genesis controller)
|-
|-
| 1 || [[#MomentProcessorState|MomentProcessor]]
| 12-28
| Reserved
|-
|-
| 2 || [[#ClusteringProcessorState|ClusteringProcessor]]
| 29
| NpadStyleSystemExt (generic external controller)
|-
|-
| 3 || [[#ImageTransferProcessorState|ImageTransferProcessor]]
| 30
| NpadStyleSystem (generic controller)
|-
|-
| 4 || [[#PointingProcessorMarkerState|PointingProcessorMarker]]
| 31
|-
| Reserved
| 5 || [[#TeraPluginProcessorState|TeraPluginProcessor]]
|-
| 6 || Unknown
|}
|}


= ImageProcessorStatus =
= NpadDeviceTypeSet =
This is "nn::irsensor::ImageProcessorStatus".
This is "nn::hid::system::NpadDeviceTypeSet". This is a BitFlagSet object for [[#DeviceType|NpadDeviceType]].


{| class="wikitable" border="1"
= NpadSystemPropertiesSet =
!  Value
This is "nn::hid::detail::NpadSystemPropertiesSet". This is a BitFlagSet object for [[#NpadSystemProperties]].
!  Description
|-
| 0 || Stopped
|-
| 1 || Running
|}


= ImageTransferProcessorFormat =
= NpadSystemProperties =
This is "nn::irsensor::ImageTransferProcessorFormat".
This is "nn::hid::detail::NpadSystemProperties". This is a 64-bit flag.
 
This controls the IR Sensor image resolution.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || 320x240
! Bit
! Description
|-
| 0
| IsChargingJoyDual
|-
|-
| 1 || 160x120
| 1
| IsChargingJoyLeft
|-
|-
| 2 || 80x60
| 2
| IsChargingJoyRight
|-
|-
| 3 || [4.0.0+] 40x30
| 3
| IsPoweredJoyDual
|-
|-
| 4 || [4.0.0+] 20x15
| 4
|}
| IsPoweredJoyLeft
 
= MomentProcessorConfig =
This is "nn::irsensor::MomentProcessorConfig".
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 5
| IsPoweredJoyRight
|-
|-
| 0x0 || 0x8 || ExposureTime (default is 0x493E0)
| 9
| IsUnsuportedButtonPressedOnNpadSystem
|-
|-
| 0x8 || 0x4 || LightTarget (default is 0)
| 10
| IsUnsuportedButtonPressedOnNpadSystemExt
|-
|-
| 0xC || 0x4 || Gain (default is 0x8)
| 11
| IsAbxyButtonOriented
|-
|-
| 0x10 || 0x1 || IsNegativeImageUsed (default is 0)
| 12
| IsSlSrButtonOriented
|-
|-
| 0x11 || 0x7 || Reserved
| 13
| [4.0.0+] IsPlusAvailable
|-
|-
| 0x18 || 0x2 || WindowOfInterestX (default is 0)
| 14
| [4.0.0+] IsMinusAvailable
|-
|-
| 0x1A || 0x2 || WindowOfInterestY (default is 0)
| 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.
 
{| class="wikitable" border="1"
|-
|-
| 0x1C || 0x2 || WindowOfInterestWidth (default is 0x140)
! Bit
! Description
|-
|-
| 0x1E || 0x2 || WindowOfInterestHeight (default is 0xF0)
| 0
|-
| IsUnintendedHomeButtonInputProtectionEnabled
| 0x20 || 0x4 || Preprocess (default is 0x1)
|-
| 0x24 || 0x4 || PreprocessIntensityThreshold (default is 0x50)
|}
|}


= PackedMomentProcessorConfig =
= AppletFooterUiAttributesSet =
This is "nn::irsensor::PackedMomentProcessorConfig".
This is "nn::hid::system::AppletFooterUiAttributesSet". This is a BitFlagSet object for [[#AppletFooterUiAttribute]].


This is converted from [[#MomentProcessorConfig]].
= UniquePadType =
This is "nn::hid::system::UniquePadType".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
! Offset || Size || Description
| 0 || Embedded
|-
|-
| 0x0 || 0x8 || ExposureTime (default is 0x493E0)
| 1 || FullKeyController
|-
|-
| 0x8 || 0x1 || LightTarget (default is 0)
| 2 || RightController
|-
|-
| 0x9 || 0x1 || Gain (default is 0x8)
| 3 || LeftController
|-
|-
| 0xA || 0x1 || IsNegativeImageUsed (default is 0)
| 4 || DebugPadController
|}
 
= UniquePadInterface =
This is "nn::hid::system::UniquePadInterface".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0xB || 0x5 || Reserved
| 0 || Embedded
|-
|-
| 0x10 || 0x2 || WindowOfInterestX (default is 0)
| 1 || Rail
|-
|-
| 0x12 || 0x2 || WindowOfInterestY (default is 0)
| 2 || Bluetooth
|-
|-
| 0x14 || 0x2 || WindowOfInterestWidth (default is 0x140)
| 3 || Usb
|-
| 0x16 || 0x2 || WindowOfInterestHeight (default is 0xF0)
|-
| 0x18 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
|-
| 0x1C || 0x1 || Preprocess (default is 0x1)
|-
| 0x1D || 0x1 || PreprocessIntensityThreshold (default is 0x50)
|-
| 0x1E || 0x2 || Reserved
|}
|}


= ClusteringProcessorConfig =
= UniquePadSerialNumber =
This is "nn::irsensor::ClusteringProcessorConfig".
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".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
! Offset || Size || Description
| 0 || ReleaseFromRight
|-
|-
| 0x0 || 0x8 || ExposureTime (default is 200000)
| 1 || ReleaseFromBottom
|-
|-
| 0x8 || 0x4 || LightTarget (default is 0)
| 2 || ReleaseFromLeft
|-
|-
| 0xC || 0x4 || Gain (default is 0x2)
| 3 || ReleaseFromTop
|-
|-
| 0x10 || 0x1 || IsNegativeImageUsed (default is 0)
| 4 || Rotate
|-
|-
| 0x11 || 0x7 || Reserved
| 5 || Update
|-
| 6 || Completed
|-
| 7 || Clear
|-
|-
| 0x18 || 0x2 || WindowOfInterestX (default is 0)
| 8 || ClearCompleted
|}
 
= SixAxisSensorUserCalibrationStage =
This is "nn::hid::system::SixAxisSensorUserCalibrationStage".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0x1A || 0x2 || WindowOfInterestY (default is 0)
| 0 || Measuring
|-
|-
| 0x1C || 0x2 || WindowOfInterestWidth (default is 320)
| 1 || Update
|-
|-
| 0x1E || 0x2 || WindowOfInterestHeight (default is 240)
| 2 || Completed
|}
 
= NpadJoyHoldType =
This is "nn::hid::NpadJoyHoldType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0x20 || 0x4 || ObjectPixelCountMin (default is 0x3)
| 0 || Vertical
|-
|-
| 0x24 || 0x4 || ObjectPixelCountMax (default is 0x12C00)
| 1 || Horizontal
|}
 
= NpadJoyDeviceType =
This is "nn::hid::NpadJoyDeviceType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0x28 || 0x4 || ObjectIntensityMin (default is 150)
| 0 || Left
|-
|-
| 0x2C || 0x1 || IsExternalLightFilterEnabled (default is 0x1)
| 1 || Right
|}
|}


= PackedClusteringProcessorConfig =
= NpadHandheldActivationMode =
This is "nn::irsensor::PackedClusteringProcessorConfig".
This is "nn::hid::NpadHandheldActivationMode".


This is converted from [[#ClusteringProcessorConfig]].
This controls how many joycons must be attached for handheld mode to be triggered (Dual = 2, Single = 1, None = 0).


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
! Offset || Size || Description
| 0 || Dual
|-
|-
| 0x0 || 0x8 || ExposureTime
| 1 || Single
|-
|-
| 0x8 || 0x1 || LightTarget
| 2 || None
|}
 
= NpadJoyAssignmentMode =
This is "nn::hid::NpadJoyAssignmentMode".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0x9 || 0x1 || Gain
| 0 || Dual
|-
|-
| 0xA || 0x1 || IsNegativeImageUsed
| 1 || Single
|}
 
= NpadCommunicationMode =
This is "nn::hid::NpadCommunicationMode".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0xB || 0x5 || Reserved
| 0 || 5ms
|-
|-
| 0x10 || 0x2 || WindowOfInterestX
| 1 || 10ms
|-
|-
| 0x12 || 0x2 || WindowOfInterestY
| 2 || 15ms
|-
|-
| 0x14 || 0x2 || WindowOfInterestWidth
| 3 || Default
|}
 
= FirmwareVersion =
This is "nn::hid::system::FirmwareVersion" ([1.0.0-2.3.0] "nn::hid::debug::FirmwareVersion").
 
{| class="wikitable" border="1"
|-
|-
| 0x16 || 0x2 || WindowOfInterestHeight
! Offset
! Size
! Description
|-
|-
| 0x18 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
| 0x0
| 0x1
| Major
|-
|-
| 0x1C || 0x4 || ObjectPixelCountMin
| 0x1
| 0x1
| Minor
|-
|-
| 0x20 || 0x4 || ObjectPixelCountMax
| 0x2
| 0x1
| Micro
|-
|-
| 0x24 || 0x1 || ObjectIntensityMin
| 0x3
| 0x1
| Revision
|-
|-
| 0x25 || 0x1 || IsExternalLightFilterEnabled
| 0x4
|-
| 0xC
| 0x26 || 0x2 || Reserved
| [3.0.0+] [[#DeviceIdentifier]]
|}
|}


= ImageTransferProcessorConfig =
== DeviceIdentifier ==
This is "nn::irsensor::ImageTransferProcessorConfig".
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
! Offset || Size || Description
| "JR" || Joy-Con right controller
|-
|-
| 0x0 || 0x8 || ExposureTime
| "JL" || Joy-Con left controller
|-
|-
| 0x8 || 0x4 || LightTarget
| "FK" || Pro Controller
|-
|-
| 0xC || 0x4 || Gain
| "MY" || MiyabiLeft and MiyabiRight
|-
|-
| 0x10 || 0x1 || IsNegativeImageUsed
| "LC" || Tarragon and Tarragon2
|-
|-
| 0x11 || 0x7 || Reserved
| "HL" || Famicom left controller
|-
|-
| 0x18 || 0x4 || [[#ImageTransferProcessorFormat|Format]]
| "HR" || Famicom right controller (with microphone)
|}
 
= PackedImageTransferProcessorConfig =
This is "nn::irsensor::PackedImageTransferProcessorConfig".
 
This is converted from [[#ImageTransferProcessorConfig]].
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| "NL" || NES left controller
|-
|-
| 0x0 || 0x8 || ExposureTime
| "NR" || NES right controller
|-
|-
| 0x8 || 0x1 || LightTarget
| "SN" || SNES controller
|-
|-
| 0x9 || 0x1 || Gain
| "LT" || N64 controller
|-
|-
| 0xA || 0x1 || IsNegativeImageUsed
| "LS" || Sega Genesis controller
|-
|-
| 0xB || 0x5 || Reserved
| "PB" || Poké Ball Plus controller
|-
|-
| 0x10 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
| "SH" || SioH
|-
|-
| 0x14 || 0x1 || [[#ImageTransferProcessorFormat|Format]]
| "TS" || TouchScreen
|-
| 0x15 || 0x3 || Reserved
|}
|}


= ImageTransferProcessorState =
= AppletDetailedUiType =
This is "nn::irsensor::ImageTransferProcessorState".
This is "nn::hid::system::AppletDetailedUiType".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0x00000000 || None
|-
| 0x01000000 || HandheldNone
|-
|-
! Offset || Size || Description
| 0x02000000 || HandheldJoyConLeftOnly
|-
|-
| 0x0 || 0x8 || SamplingNumber
| 0x02000001 || HandheldLarkHvc1Only
|-
|-
| 0x8 || 0x4 || AmbientNoiseLevel
| 0x02000002 || HandheldLarkNesLeftOnly
|-
|-
| 0xC || 0x4 || Reserved
| 0x03000000 || HandheldJoyConRightOnly
|}
 
= TeraPluginProcessorConfig =
This is "nn::irsensor::TeraPluginProcessorConfig".
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 0x03000001 || HandheldLarkHvc2Only
|-
|-
| 0x0 || 0x1 || Mode
| 0x03000002 || HandheldLarkNesRightOnly
|-
|-
| 0x1 || 0x1 ||  
| 0x04000000 || HandheldJoyConLeftJoyConRight
|-
|-
| 0x2 || 0x1 ||  
| 0x04000001 || HandheldJoyConLeftLarkHvc2
|-
|-
| 0x3 || 0x1 ||  
| 0x04000002 || HandheldJoyConLeftLarkNesRight
|}
|-
 
| 0x04000003 || HandheldLarkHvc1JoyConRight
= PackedTeraPluginProcessorConfig =
This is "nn::irsensor::PackedTeraPluginProcessorConfig".
 
This is converted from [[#TeraPluginProcessorConfig]]. The data starting at offset 0x5 is only initialized by the user-process with [6.0.0+].
 
[[#TeraPluginProcessorConfig]] +0x0, +0x2, and +0x3 are copied to +0x4, 0x6, and +0x7 here. +0x5 here is set to 0x2 | ([[#TeraPluginProcessorConfig]]+0x1 << 7).
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 0x04000004 || HandheldLarkHvc1LarkHvc2
|-
|-
| 0x0 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
| 0x04000005 || HandheldLarkHvc1LarkNesRight
|-
|-
| 0x4 || 0x1 || Mode
| 0x04000006 || HandheldLarkNesLeftJoyConRight
|-
|-
| 0x5 || 0x1 ||  
| 0x04000007 || HandheldLarkNesLeftLarkHvc2
|-
|-
| 0x6 || 0x1 ||  
| 0x04000008 || HandheldLarkNesLeftLarkNesRight
|-
|-
| 0x7 || 0x1 ||
| 0x05000000 || JoyDual
|}
 
= PointingProcessorConfig =
This is "nn::irsensor::PointingProcessorConfig".
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 0x06000000 || JoyDualLeftOnly
|-
|-
| 0x0 || 0x2 || WindowOfInterestX (default is 0)
| 0x07000000 || JoyDualRightOnly
|-
|-
| 0x2 || 0x2 || WindowOfInterestY (default is 0)
| 0x08000000 || JoyLeftHorizontal
|-
|-
| 0x4 || 0x2 || WindowOfInterestWidth (default is 320)
| 0x09000000 || JoyLeftVertical
|-
|-
| 0x6 || 0x2 || WindowOfInterestHeight (default is 240)
| 0x0A000000 || JoyRightHorizontal
|}
 
= PackedPointingProcessorConfig =
This is "nn::irsensor::PackedPointingProcessorConfig".
 
This is converted from [[#PointingProcessorConfig]].
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 0x0B000000 || JoyRightVertical
|-
|-
| 0x0 || 0x2 || WindowOfInterestX (default is 0)
| 0x0C000000 || SwitchProController
|-
|-
| 0x2 || 0x2 || WindowOfInterestY (default is 0)
| 0x0D000000 || CompatibleProController
|-
|-
| 0x4 || 0x2 || WindowOfInterestWidth (default is 320)
| 0x0E000000 || CompatibleJoyCon
|-
|-
| 0x6 || 0x2 || WindowOfInterestHeight (default is 240)
| 0x0F000000 || LarkHvc1
|-
|-
| 0x8 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
| 0x10000000 || LarkHvc2
|}
 
= PackedMcuVersion =
This is "nn::irsensor::PackedMcuVersion".
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 0x11000000 || LarkNesLeft
|-
|-
| 0x0 || 0x2 || MajorVersion
| 0x12000000 || LarkNesRight
|-
|-
| 0x2 || 0x2 || MinorVersion
| 0x13000000 || LuciaU
|}
 
== Versions ==
{| class="wikitable" border="1"
|-
|-
! MajorVersion || MinorVersion || SystemVersion
| 0x13000001 || LuciaJ
|-
|-
| 0x3 || 0xB || [1.0.0+]
| 0x13000002 || LuciaE
|-
|-
| 0x4 || 0x12 || [4.0.0+]
| 0x14000000 || Verification
|-
| 0x5 || 0x18 || [5.0.0+]
|-
|-
| 0x6 || 0x1A || [6.0.0+]
| 0x15000000 || [13.0.0+] Lagon
|-
|-
| 0x8 || 0x1B || [8.0.0+]
| 0xFFFFFFFF || Unknown
|}
|}


= PackedFunctionLevel =
= AppletFooterUiType =
This is nn::irsensor::PackedFunctionLevel.
This is "nn::hid::system::AppletFooterUiType".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || None
|-
|-
! Offset || Size || Description
| 1 || HandheldNone
|-
|-
| 0x0 || 0x1 || [[#IrSensorFunctionLevel]]
| 2 || HandheldJoyConLeftOnly
|-
|-
| 0x1 || 0x3 || Reserved
| 3 || HandheldJoyConRightOnly
|}
 
== IrSensorFunctionLevel ==
This is "nn::irsensor::IrSensorFunctionLevel".
 
{| class="wikitable" border="1"
|-
|-
! Value || SystemVersion
| 4 || HandheldJoyConLeftJoyConRight
|-
|-
| 0 || [1.0.0+]
| 5 || JoyDual
|-
|-
| 1 || [4.0.0+]
| 6 || JoyDualLeftOnly
|-
|-
| 2 || [5.0.0+]
| 7 || JoyDualRightOnly
|-
|-
| 3 || [6.0.0+]
| 8 || JoyLeftHorizontal
|-
|-
| 4 || [8.0.0+]
| 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
|}


= ImageTransferProcessorExConfig =
= NpadIdType =
This is "nn::irsensor::ImageTransferProcessorExConfig".
This is "nn::hid::NpadIdType". This is the controller index used in [[#SharedMemoryFormat|sharedmem]].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0x0 || No1
|-
| 0x1 || No2
|-
| 0x2 || No3
|-
|-
! Offset || Size || Description
| 0x3 || No4
|-
|-
| 0x0 || 0x8 || ExposureTime
| 0x4 || No5
|-
|-
| 0x8 || 0x4 || LightTarget
| 0x5 || No6
|-
|-
| 0xC || 0x4 || Gain
| 0x6 || No7
|-
|-
| 0x10 || 0x1 || IsNegativeImageUsed
| 0x7 || No8
|-
|-
| 0x11 || 0x7 || Reserved
| 0x10 || Other
|-
| 0x20 || Handheld
|}
 
= NpadInterfaceType =
This is "nn::hid::NpadInterfaceType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 1 || Bluetooth
|-
| 2 || Rail
|-
| 3 || Usb
|-
| 4 || Embedded
|}
 
= NpadLarkType =
This is "nn::hid::NpadLarkType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || Invalid
|-
| 1 || H1
|-
| 2 || H2
|-
| 3 || NL
|-
| 4 || NR
|}
 
= NpadLuciaType =
This is "nn::hid::NpadLuciaType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || Invalid
|-
| 1 || J
|-
| 2 || E
|-
| 3 || U
|}
 
= NpadLagerType =
This is "nn::hid::NpadLagerType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || Invalid
|-
| 1 || J
|-
| 2 || E
|-
| 3 || U
|}
 
= SixAxisSensorProperties =
This is "nn::hid::server::SixAxisSensorProperties".
 
{| class="wikitable" border="1"
|-
! Bit
! Description
|-
| 0
| IsSixAxisSensorDeviceNewlyAssigned
|-
| 1
| IsFirmwareUpdateAvailableForSixAxisSensor
|}
 
= GestureDirection =
This is "nn::hid::GestureDirection".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || None
|-
| 1 || Left
|-
| 2 || Up
|-
| 3 || Right
|-
| 4 || Down
|}
 
= GestureType =
This is "nn::hid::GestureType".
 
{| class="wikitable" border="1"
!  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".
 
{| class="wikitable" border="1"
!  Bits
!  Description
|-
| 0
| FullKey
|-
| 1
| DebugPad
|-
| 2
| HandheldLeft
|-
| 3
| HandheldRight
|-
| 4
| JoyLeft
|-
| 5
| JoyRight
|-
| 6
| Palma
|-
| 7
| LarkHvcLeft
|-
| 8
| LarkHvcRight
|-
| 9
| LarkNesLeft
|-
| 10
| LarkNesRight
|-
| 11
| HandheldLarkHvcLeft
|-
| 12
| HandheldLarkHvcRight
|-
| 13
| HandheldLarkNesLeft
|-
| 14
| HandheldLarkNesRight
|-
| 15
| Lucia
|-
| 16
| [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_2|DeviceType]].
 
{| class="wikitable" border="1"
!  Bits
!  Description
|-
| 0-7
| BIT(N*4+0) = Pro Controller, BIT(N*4+1) = Joy-Con Left, BIT(N*4+2) = Joy-Con Right, BIT(N*4+3) = invalid. Where N is 0-1.
|-
| 8-10
| Pro Controller
|-
| 11
| Famicom left controller
|-
| 12
| Famicom right controller (with microphone)
|-
| 13
| NES left controller
|-
| 14
| NES right controller
|-
| 15-16
| Invalid
|-
| 17
| Generic external controller
|-
| 18-20
| Invalid
|-
| 21-23
| Generic controller
|}
 
= DeviceType =
This is "nn::hidtypes::DeviceType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || Unknown
|-
| 1 || [[#JoyConRight|JoyConRight]]
|-
| 2 || [[#JoyConLeft|JoyConLeft]]
|-
| 3 || [[#SwitchProController|SwitchProController]]
|-
| 4 || MiyabiLeft
|-
| 5 || MiyabiRight
|-
| 6 || [[#Tarragon|Tarragon]]
|-
| 7 || [[#LarkH1|LarkH1]]
|-
| 8 || [[#LarkH2|LarkH2]]
|-
| 9 || [[#LarkNL|LarkNL]]
|-
| 10 || [[#LarkNR|LarkNR]]
|-
| 11 || [[#Lucia|Lucia]]
|-
| 12 || [[#Palma|Palma]]
|-
| 13 || [[#GcOnGggg|GcOnGggg]]
|-
| 14 || FiftyL
|-
| 15 || UsbPad
|-
| 16 || WinGenericPad
|-
| 17 || Sio
|-
| 18 || FiftyR
|-
| 19 || DebugSwitchProControllerCompatibleDevice
|-
| 20 || DebugJoyConLeftCompatibleDevice
|-
| 21 || DebugJoyConRightCompatibleDevice
|-
| 22 || [12.0.0+] [[#Lagon|Lagon]]
|-
| 23 || [12.0.0+] [[#ExternalGrip|ExternalGrip]]
|-
| 24 || [13.0.0+] [[#SwitchProControllerDfu|SwitchProControllerDfu]]
|-
| 25 || [13.0.0+] [[#ExternalGripDfu|ExternalGripDfu]]
|-
| 26 || [13.0.0+] [[#LuciaDfu|LuciaDfu]]
|-
| 27 || [13.0.0+] [[#LagonDfu|LagonDfu]]
|-
| 28 || [13.0.0+] [[#Lager|Lager]]
|-
| 29 || [14.0.0+] [[#LagerDfu|LagerDfu]]
|-
| 30 || [14.0.0+] [[#Tarragon2|Tarragon2]]
|}
 
== JoyConRight ==
[[Joy-Con|Joy-Con]] right controller.
 
== JoyConLeft ==
[[Joy-Con|Joy-Con]] left controller.
 
== SwitchProController ==
[[Pro_Controller|Pro Controller]].
 
== 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.
 
== Palma ==
Poké Ball Plus controller.
 
== GcOnGggg ==
GameCube controller.
 
== Lagon ==
N64 controller.
 
== ExternalGrip ==
Joy-Con Charging Grip.
 
== SwitchProControllerDfu ==
"Kotetsu" (Pro Controller MCU) in DFU mode.
 
== ExternalGripDfu ==
"Kuina" (Joy-Con Charging Grip MCU) in DFU mode.
 
== LuciaDfu ==
SNES controller MCU in DFU mode.
 
== LagonDfu ==
N64 controller MCU in DFU mode.
 
== Lager ==
Sega Genesis controller.
 
== LagerDfu ==
Sega Genesis controller MCU in DFU mode.
 
== Tarragon2 ==
Licensed Pro Controller.
 
= VidPidDefinition =
This is "nn::hidtypes::VidPidDefinition".
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x2
| Vid
|-
| 0x2
| 0x2
| PidRangeMax
|-
| 0x4
| 0x2
| PidRangeMin
|-
| 0x6
| 0x1
| [[#DeviceTypeInternal|DeviceType]]
|-
| 0x7
| 0x1
| Reserved
|}
 
= VidPidDefinitions =
This is "nn::hidtypes::detail::VidPidDefinitions". This is a list of [[#VidPidDefinition|VidPidDefinition]] objects maintained by the hid-sysmodule.
 
{| class="wikitable" border="1"
|-
! Vid || PidRangeMax || PidRangeMin || [[#DeviceTypeInternal|DeviceType]] || Description
|-
| 0x57E || 0x2006 || 0x2006 || 2 || Nintendo [[HID_services#JoyConLeft|JoyConLeft]]
|-
| 0x57E || 0x2007 || 0x2007 || 1 || Nintendo [[HID_services#JoyConRight|JoyConRight]]
|-
| 0x57E || 0x2009 || 0x2009 || 3 || Nintendo [[HID_services#SwitchProController|SwitchProController]]
|-
| 0x57E || 0x200F || 0x200F || 24 || Nintendo [[HID_services#SwitchProControllerDfu|SwitchProControllerDfu]]
|-
| 0x57E || 0x200E || 0x200E || 23 || Nintendo [[HID_services#ExternalGrip|ExternalGrip]]
|-
| 0x57E || 0x2008 || 0x2008 || 25 || Nintendo [[HID_services#ExternalGripDfu|ExternalGripDfu]]
|-
| 0x57E || 0x2017 || 0x2017 || 11 || Nintendo [[HID_services#Lucia|Lucia]]
|-
| 0x57E || 0x2018 || 0x2018 || 26 || Nintendo [[HID_services#LuciaDfu|LuciaDfu]]
|-
| 0x57E || 0x2019 || 0x2019 || 22 || Nintendo [[HID_services#Lagon|Lagon]]
|-
| 0x57E || 0x201A || 0x201A || 27 || Nintendo [[HID_services#LagonDfu|LagonDfu]]
|-
| 0x57E || 0x201E || 0x201E || 28 || Nintendo [[HID_services#Lager|Lager]]
|-
| 0x57E || 0x201F || 0x201F || 29 || Nintendo [[HID_services#LagerDfu|LagerDfu]]
|-
| 0x57E || 0x337 || 0x337 || 13 || Nintendo [[HID_services#GcOnGggg|GcOnGggg]]
|-
| 0x57E || 0x300E || 0x300E || [17.0.0+] 18 || Nintendo FiftyR
|-
| 0x57E || 0x300D || 0x300D || [17.0.0+] 14 || Nintendo FiftyL
|-
| 0xF0D || 0x92 || 0x92 || 15 || HORI Pokken Tournament DX Pro Pad
|-
| 0xF0D || 0xAB || 0xAA || 15 || HORI
|-
| 0xF0D || 0xC1 || 0xC1 || 15 || HORIPAD for Nintendo Switch
|-
| 0xF0D || 0xFF || 0xF0 || 15 || HORI
|-
| 0xF0D || 0x22F || 0x200 || [1.0.0-20.0.1] 15 || HORI
|-
| 0xF0D || 0x201 || 0x200 || [20.1.0+] 15 || HORI Split Pad Pro
|-
| 0xF0D || 0x202 || 0x202 || [20.1.0+] 15 || HORI
|-
| 0xF0D || 0x21F || 0x203 || [20.1.0+] 15 || HORI
|-
| 0xF0D || 0x25F || 0x220 || [20.1.0+] 15 || HORI
|-
| 0xF0D || 0x27F || 0x260 || [20.1.0+] 15 || HORI
|-
| 0xE6F || 0x193 || 0x180 || 15 || PDP
|-
| 0x20D6 || 0xA719 || 0xA710 || [1.0.0-20.0.1] 15 || PowerA
|-
| 0x20D6 || 0xA729 || 0xA720 || [1.0.0-20.0.1] 15 || PowerA
|-
| 0x20D6 || 0xA716 || 0xA710 || [20.1.0+] 15 || PowerA
|-
| 0x20D6 || 0xA717 || 0xA717 || [20.1.0+] 15 || PowerA
|-
| 0x20D6 || 0xA719 || 0xA718 || [20.1.0+] 15 || PowerA
|-
| 0x20D6 || 0xA720 || 0xA720 || [20.1.0+] 15 || PowerA
|-
| 0x20D6 || 0xA721 || 0xA721 || [20.1.0+] 15 || PowerA
|-
| 0x20D6 || 0xA726 || 0xA722 || [20.1.0+] 15 || PowerA
|-
| 0x20D6 || 0xA731 || 0xA727 || [20.1.0+] 15 || PowerA
|-
| 0x33DD || 0xB || 0x1 || 15 || ZUIKI
|}
 
= NpadPowerInfo =
This is "nn::hid::system::NpadPowerInfo".
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x1
| IsPowered
|-
| 0x1
| 0x1
| IsCharging
|-
| 0x2
| 0x6
| Reserved
|-
| 0x8
| 0x4
| [[#BatteryLevel|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.
 
{| class="wikitable" border="1"
|-
! 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.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || TypeValue
|-
| 0x0 || 0x1 || NpadStyleIndex
|-
| 0x1 || 0x1 || [[#NpadIdType|PlayerNumber]]
|-
| 0x2 || 0x1 || DeviceIdx
|}
 
= VibrationDeviceHandle =
This is "nn::hid::VibrationDeviceHandle". This is a 4-byte struct with 4-byte alignment.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || TypeValue
|-
| 0x0 || 0x1 || NpadStyleIndex
|-
| 0x1 || 0x1 || [[#NpadIdType|PlayerNumber]]
|-
| 0x2 || 0x1 || DeviceIdx
|}
 
= VibrationDeviceInfo =
This is "nn::hid::VibrationDeviceInfo" / "nn::hid::VibrationDeviceInfoForIpc". This is a 0x8-byte struct.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || [[#VibrationDeviceType|DeviceType]]
|-
| 0x4 || 0x4 || [[#VibrationDevicePosition|Position]]
|}
 
= VibrationDeviceType =
This is "nn::hid::VibrationDeviceType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || Unknown
|-
| 1 || LinearResonantActuator
|-
| 2 || GcErm
|-
| 3 || Erm
|}
 
= VibrationDevicePosition =
This is "nn::hid::VibrationDevicePosition".
 
{| class="wikitable" border="1"
!  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.
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| AmplitudeLow
|-
| 0x4
| 0x4
| FrequencyLow
|-
| 0x8
| 0x4
| AmplitudeHigh
|-
| 0xC
| 0x4
| FrequencyHigh
|}
 
= VibrationGcErmCommand =
This is "nn::hid::VibrationGcErmCommand".
 
{| class="wikitable" border="1"
!  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").
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || Loose
|-
| 1 || Tight
|}
 
= GyroscopeZeroDriftMode =
This is "nn::hid::GyroscopeZeroDriftMode".
 
{| class="wikitable" border="1"
!  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.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || [[#PalmaOperationType]]
|-
| 0x4 || 0x4 || Result
|-
| 0x8 || 0x140 || Buffer for [[#GetPalmaOperationInfo]].
|}
 
= PalmaOperationType =
This is "nn::hid::PalmaOperationType".
 
{| class="wikitable" border="1"
!  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".
 
{| class="wikitable" border="1"
!  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".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x2 || RgbLedPatternIndex.
|-
| 0x2 || 0x2 || Padding
|-
| 0x4 || 0x4 || [[#PalmaWaveSet|WaveSet]].
|-
| 0x8 || 0x2 || WaveIndex.
|}
 
= PalmaWaveSet =
This is "nn::hid::PalmaWaveSet".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || Small
|-
| 1 || Medium
|-
| 2 || Large
|}
 
= PalmaFeature =
This is "nn::hid::PalmaFeature".
 
{| class="wikitable" border="1"
|-
! Bit
! Description
|-
| 0
| FrMode
|-
| 1
| RumbleFeedback
|-
| 2
| Step
|-
| 3
| MuteSwitch
|-
|}
 
= AbstractedPadState =
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || Type, only 1 bit can be set. Converted to [[#HdlsDeviceInfo]]::type internally by [[#SetAutoPilotVirtualPadState]].
|-
| 0x4 || 0x1 || Flags. [[#SetAutoPilotVirtualPadState]] only uses bit0: when clear it will skip using the rest of the input and run [[#UnsetAutoPilotVirtualPadState]] internally.
|-
| 0x5 || 0x3 || Padding
|-
| 0x8 || 0x4 || RGBA Single Body Color
|-
| 0xC || 0x4 || RGBA Single Buttons Color
|-
| 0x10 || 0x1 || See [[#HiddbgHdlsDeviceInfo]]::[[#NpadInterfaceType]].
|-
| 0x11 || 0x3 || Padding
|-
| 0x14 || 0x24 || [[#HdlsState]]. Unknown if the last 4-bytes are included in this struct, [[#SetAutoPilotVirtualPadState]]/[[#hiddbgGetAbstractedPadsState]] only uses the first 0x20-bytes.
|-
| 0x38 || 0x60 || Unused with [[#SetAutoPilotVirtualPadState]]/[[#GetAbstractedPadsState]].
|}
 
Normally the input state is merged with an existing controller selected by Type. However in some cases (BIT(2-5) with type2!=0x2 and BIT(31)) it's detected as a dedicated controller.
 
Type:
{| class="wikitable" border="1"
!  Bits
!  [[#HdlsDeviceInfo]]::type bits
!  Description
!  Notes
|-
| 0 || 0 || ||
|-
| 1 || 15 || || [[#DeviceType]] |= BIT(1)
|-
| 2 || 1 || ||
|-
| 3 || 2 || ||
|-
| 4 || 1 || ||
|-
| 5 || 2 || ||
|-
| 6 || 3 || ||
|-
| 7 || 11 || || [[#DeviceType]] |= BIT(11)
|-
| 8 || 12 || || [[#DeviceType]] |= BIT(12)
|-
| 9 || 13 || || [[#DeviceType]] |= BIT(13)
|-
| 10 || 14 || || [[#DeviceType]] |= BIT(14)
|-
| 11 || 15 || || [[#DeviceType]] |= BIT(11)
|-
| 12 || 12 || || [[#DeviceType]] |= BIT(12)
|-
| 13 || 13 || || [[#DeviceType]] |= BIT(13)
|-
| 14 || 14 || || [[#DeviceType]] |= BIT(14)
|-
| 15 || 17 || ||
|-
| 31 || 21 || || [[#DeviceType]] = BIT(31)
|-
|}
 
The above "[[#DeviceType]] |=" notes only apply when type2 is 0x2.
 
= DebugPadAutoPilotState =
This is "nn::hid::debug::DebugPadAutoPilotState"
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| [[#DebugPadAttributeSet|Attributes]]
|-
| 0x4
| 0x4
| [[#DebugPadButtonSet|Buttons]]
|-
| 0x8
| 0x8
| [[#AnalogStickState|AnalogStickL]]
|-
| 0x10
| 0x8
| [[#AnalogStickState|AnalogStickR]]
|}
 
= MouseAutoPilotState =
This is "nn::hid::debug::MouseAutoPilotState".
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| X
|-
| 0x4
| 0x4
| Y
|-
| 0x8
| 0x4
| DeltaX
|-
| 0xC
| 0x4
| DeltaY
|-
| 0x10
| 0x4
| WheelDelta
|-
| 0x14
| 0x4
| [[#MouseButtonSet|Buttons]]
|-
| 0x18
| 0x4
| [[#MouseAttributeSet|Attributes]]
|}
 
= KeyboardAutoPilotState =
This is "nn::hid::debug::KeyboardAutoPilotState".
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| [[#KeyboardModifierSet|Modifiers]]
|-
| 0x8
| 0x20
| [[#KeyboardKeySet|Keys]]
|}
 
= SleepButtonAutoPilotState =
This is "nn::hid::debug::SleepButtonAutoPilotState". This is a 0x8-byte struct with 8-byte alignment.
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0 || 0x8 || Buttons (only bit0 is used)
|}
 
= DigitizerAutoPilotState =
This is "nn::hid::debug::DigitizerAutoPilotState".
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0 || 0x44 ||
|}
 
= PowerInfo =
This is "nn::hidtypes::PowerInfo".
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0 || 0x4 || BatteryLevel
|-
| 0x4 || 0x4 || [[#PowerAttribute]]
|}
 
= PowerAttribute =
This is "nn::hidtypes::PowerAttribute". This is a 32-bit flag.
 
{| class="wikitable" border="1"
!  Bits
!  Description
|-
| 0
| IsPowered
|-
| 1
| IsCharging
|}
 
= HdlsAttribute =
This is "nn::hidtypes::HdlsAttribute". This is a 32-bit flag.
 
{| class="wikitable" border="1"
!  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.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || s32 Total entries
|-
| 0x4 || 0x4 || Padding
|-
| 0x8 || 0x200(0x20*0x10) || Array of [[#HdlsNpadAssignmentEntry]].
|}
 
= HdlsNpadAssignmentEntry =
This is a 0x20-byte struct.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || [[#HdlsHandle]]
|-
| 0x8 || 0x4 || ?
|-
| 0xC || 0x4 || ?
|-
| 0x10 || 0x8 || ?
|-
| 0x18 || 0x1 || ?
|-
| 0x19 || 0x7 || Padding
|}
 
= HdlsStateList =
This is a 0x408-byte struct.
 
[9.0.0+] This is a 0x488-byte struct.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || s32 Total entries
|-
| 0x4 || 0x4 || Padding
|-
| 0x8 || <[[#HdlsStateListEntry]] size>*0x10 || Array of [[#HdlsStateListEntry]].
|}
 
This contains a list of all controllers, including non-virtual controllers.
 
= HdlsStateListEntry =
This is a 0x40-byte struct.
 
[9.0.0+] This is a 0x48-byte struct.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || [[#HdlsHandle]]
|-
| 0x8 || [[#HdlsDeviceInfo]] size || [[#HdlsDeviceInfo]]. With [[#ApplyHdlsStateList]] this is only used when creating new devices.
|-
| 0x8 + [[#HdlsDeviceInfo]] size, with 8-byte alignment || 0x24 || [[#HdlsState]]
|-
| <Immediately following the above> || 0x4 || Padding
|}
 
= HdlsDeviceInfo =
This is "nn::hid::debug::HdlsDeviceInfo". This is a 0x10-byte struct.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || [[#DeviceTypeInternal]]
|-
| 0x4 || 0x4 || RGBA Single Body Color
|-
| 0x8 || 0x4 || RGBA Single Buttons Color
|-
| 0xC || 0x1 || [[#NpadInterfaceType]]. Additional type field used with the above type field, if the value doesn't match one of the following a default is used. Type Pro-Controller: value 0x3 indicates that the controller is connected via USB. Type bit21: value 0x3 = unknown. When value is 0x2, state is merged with an existing controller (when the type value is compatible with this). Otherwise, it's a dedicated controller.
|-
| 0xD || 0x3 || Padding
|}
 
[9.0.0+] This is a 0x14-byte struct.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x1 || [[#DeviceTypeInternal]]
|-
| 0x1 || 0x1 || [[#NpadInterfaceType]]. Similar to the field from the old struct.
|-
| 0x2 || 0x2 || Padding
|-
| 0x4 || 0x4 || RGBA Single Body Color
|-
| 0x8 || 0x4 || RGBA Single Buttons Color
|-
| 0xC || 0x4 || RGBA Left Grip Color
|-
| 0x10 || 0x4 || RGBA Right Grip Color
|}
 
= HdlsState =
This is "nn::hid::debug::HdlsState". This is a 0x24-byte struct.
 
{| class="wikitable" border="1"
|-
! 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 || [[#NpadButton|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):
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || [[#PowerInfo]]
|-
| 0x8 || 0x8 || [[#NpadButton|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):
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || [[#PowerInfo]]
|-
| 0x8 || 0x8 || [[#NpadButton|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.
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x1
| TimeUnit
|-
| 0x1
| 0x1
| FrameCount
|-
| 0x2
| 0x1
| CycleCount
|-
| 0x3
| 0x1
| InitialBrightness
|-
| 0x4
| 0x4 * 15
| [[#Frame|Frames]]
|-
| 0x40
| 0x1
| FinalBrightness
|-
| 0x41
| 0x1
| TimeTowardsFinalBrightness
|-
| 0x42
| 0x6
| Reserved
|}
 
== Frame ==
{| class="wikitable" border="1"
|-
! 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.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonLeft]]
|-
| 0x4 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonUp]]
|-
| 0x8 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonRight]]
|-
| 0xC || 0x4 || [[#DigitalButtonAssignment|HardwareButtonDown]]
|-
| 0x10 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonA]]
|-
| 0x14 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonB]]
|-
| 0x18 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonX]]
|-
| 0x1C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonY]]
|-
| 0x20 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStickL]]
|-
| 0x24 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStickR]]
|-
| 0x28 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonL]]
|-
| 0x2C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonR]]
|-
| 0x30 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonZL]]
|-
| 0x34 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonZR]]
|-
| 0x38 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonSelect]]
|-
| 0x3C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStart]]
|-
| 0x40 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonCapture]]
|-
| 0x44 || 0x8 || [[#AnalogStickAssignment|HardwareStickL]]
|-
| 0x4C || 0x8 || [[#AnalogStickAssignment|HardwareStickR]]
|}
 
== DigitalButtonAssignment ==
This is "nn::hidconfig::DigitalButtonAssignment".
 
{| class="wikitable" border="1"
!  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".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || [[#AnalogStickRotation]]
|-
| 0x4 || 0x1 || IsPairedStickAssigned
|-
| 0x5 || 0x3 || Reserved
|}
 
== AnalogStickRotation ==
This is "nn::hidconfig::AnalogStickRotation".
 
{| class="wikitable" border="1"
!  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.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonLeft]]
|-
| 0x4 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonUp]]
|-
| 0x8 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonRight]]
|-
| 0xC || 0x4 || [[#DigitalButtonAssignment|HardwareButtonDown]]
|-
| 0x10 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStickL]]
|-
| 0x14 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonL]]
|-
| 0x18 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonZL]]
|-
| 0x1C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonSelect]]
|-
| 0x20 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonLeftSL]]
|-
| 0x24 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonLeftSR]]
|-
| 0x28 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonCapture]]
|-
| 0x2C || 0x8 || [[#AnalogStickAssignment|HardwareStickL]]
|}
 
= ButtonConfigRight =
This is "nn::hidconfig::ButtonConfigRight". This is a 0x30-byte struct.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonA]]
|-
| 0x4 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonB]]
|-
| 0x8 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonX]]
|-
| 0xC || 0x4 || [[#DigitalButtonAssignment|HardwareButtonY]]
|-
| 0x10 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStickR]]
|-
| 0x14 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonR]]
|-
| 0x18 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonZR]]
|-
| 0x1C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStart]]
|-
| 0x20 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonRightSL]]
|-
| 0x24 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonRightSR]]
|-
| 0x28 || 0x8 || [[#AnalogStickAssignment|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".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 1 || Bluetooth
|-
| 2 || Rail
|-
| 3 || Usb
|-
| 4 || Embedded
|}
 
= DigitalButton =
This is "nn::hidtypes::DigitalButton". This is a 64-bit flag.
 
{| class="wikitable" border="1"
|-
! 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.
 
{| class="wikitable" border="1"
|-
! 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.
 
{| class="wikitable" border="1"
|-
! 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".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || BodyColor
|-
| 0x4 || 0x4 || ButtonColor
|-
| 0x8 || 0x4 || LeftGripColor
|-
| 0xC || 0x4 || RightGripColor
|}
 
= DeviceDescriptorType =
This is "nn::hidtypes::DeviceDescriptorType".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x1 || [[#DeviceTypeInternal|DeviceType]]
|-
| 0x1 || 0x7 || Reserved
|-
| 0x8 || 0x8 || [[#FeatureType|FeatureType]]
|-
| 0x10 || 0x8 || [[#DigitalButton|DigitalButton]]
|-
| 0x18 || 0x4 || [[#AssignmentStyle|AssignmentStyle]]
|-
| 0x1C || 0x10 || [[#Color|DeviceColor]]
|-
| 0x2C || 0x4 || Reserved
|}
 
= DeviceDescriptionList =
This is "nn::hidtypes::detail::DeviceDescriptionList". This is a list of [[#DeviceDescriptorType|DeviceDescriptorType]] objects maintained by the hid-sysmodule.
 
{| class="wikitable" border="1"
|-
! [[#DeviceTypeInternal|DeviceType]] || [[#FeatureType|FeatureType]] || [[#DigitalButton|DigitalButton]] || [[#AssignmentStyle|AssignmentStyle]] || [[#Color|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".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x1 || [[#DeviceTypeInternal|DeviceType]]
|-
| 0x1 || 0x1 || [[#InterfaceType|InterfaceType]]
|-
| 0x2 || 0x6 || Reserved
|-
| 0x8 || 0x8 || [[#FeatureType|FeatureType]]
|}
 
= UnmaskFeatureDescriptorList =
This is "nn::hid::server::UnmaskFeatureDescriptorList". This is a list of [[#UnmaskFeatureDescriptorType|UnmaskFeatureDescriptorType]] objects maintained by the hid-sysmodule.
 
{| class="wikitable" border="1"
|-
! [[#DeviceTypeInternal|DeviceType]] || [[#InterfaceType|InterfaceType]] || [[#FeatureType|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".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || [[#FirmwareVersionAttribute|FirmwareVersionAttribute]]
|-
| 0x4 || 0x2 ||
|-
| 0x6 || 0x2 || MajorVersion
|-
| 0x8 || 0x2 || MinorVersion
|-
| 0xA || 0x2 ||
|}
 
= FirmwareVersionAttribute =
This is "nn::hidtypes::FirmwareVersionAttribute". This is a 32-bit flag.
 
{| class="wikitable" border="1"
|-
! Bit
! Description
|-
| 0
| IsCustomerCodeCorruption
|-
| 1
| IsIapCorrupted
|}
 
= IrCameraHandle =
This is "nn::irsensor::IrCameraHandle".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x1 || PlayerNumber
|-
| 0x1 || 0x1 || DeviceType
|-
| 0x2 || 0x2 || Reserved
|}
 
= IrCameraStatus =
This is "nn::irsensor::IrCameraStatus".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || Available
|-
| 1 || Unsupported
|-
| 2 || Unconnected
|}
 
= IrCameraInternalStatus =
This is "nn::irsensor::IrCameraInternalStatus".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || Stopped
|-
| 1 || FirmwareUpdateNeeded
|-
| 2 ||
|-
| 3 ||
|-
| 4 ||
|-
| 5 || FirmwareVersionRequested
|-
| 6 || FirmwareVersionIsInvalid
|-
| 7 || [4.0.0+] Ready
|-
| 8 || [4.0.0+] Setting
|}
 
= IrSensorMode =
This is "nn::irsensor::detail::StatusManager::IrSensorMode".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || None
|-
| 1 || [[#MomentProcessorState|MomentProcessor]]
|-
| 2 || [[#ClusteringProcessorState|ClusteringProcessor]]
|-
| 3 || [[#ImageTransferProcessorState|ImageTransferProcessor]]
|-
| 4 || [[#PointingProcessorMarkerState|PointingProcessorMarker]]
|-
| 5 || [[#TeraPluginProcessorState|TeraPluginProcessor]]
|-
| 6 || Unknown
|}
 
= ImageProcessorStatus =
This is "nn::irsensor::ImageProcessorStatus".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || Stopped
|-
| 1 || Running
|}
 
= ImageTransferProcessorFormat =
This is "nn::irsensor::ImageTransferProcessorFormat".
 
This controls the IR Sensor image resolution.
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || 320x240
|-
| 1 || 160x120
|-
| 2 || 80x60
|-
| 3 || [4.0.0+] 40x30
|-
| 4 || [4.0.0+] 20x15
|}
 
= MomentProcessorConfig =
This is "nn::irsensor::MomentProcessorConfig".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || ExposureTime (default is 0x493E0)
|-
| 0x8 || 0x4 || LightTarget (default is 0)
|-
| 0xC || 0x4 || Gain (default is 0x8)
|-
| 0x10 || 0x1 || IsNegativeImageUsed (default is 0)
|-
| 0x11 || 0x7 || Reserved
|-
| 0x18 || 0x2 || WindowOfInterestX (default is 0)
|-
| 0x1A || 0x2 || WindowOfInterestY (default is 0)
|-
| 0x1C || 0x2 || WindowOfInterestWidth (default is 0x140)
|-
| 0x1E || 0x2 || WindowOfInterestHeight (default is 0xF0)
|-
| 0x20 || 0x4 || Preprocess (default is 0x1)
|-
| 0x24 || 0x4 || PreprocessIntensityThreshold (default is 0x50)
|}
 
= PackedMomentProcessorConfig =
This is "nn::irsensor::PackedMomentProcessorConfig".
 
This is converted from [[#MomentProcessorConfig]].
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || ExposureTime (default is 0x493E0)
|-
| 0x8 || 0x1 || LightTarget (default is 0)
|-
| 0x9 || 0x1 || Gain (default is 0x8)
|-
| 0xA || 0x1 || IsNegativeImageUsed (default is 0)
|-
| 0xB || 0x5 || Reserved
|-
| 0x10 || 0x2 || WindowOfInterestX (default is 0)
|-
| 0x12 || 0x2 || WindowOfInterestY (default is 0)
|-
| 0x14 || 0x2 || WindowOfInterestWidth (default is 0x140)
|-
| 0x16 || 0x2 || WindowOfInterestHeight (default is 0xF0)
|-
| 0x18 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
|-
| 0x1C || 0x1 || Preprocess (default is 0x1)
|-
| 0x1D || 0x1 || PreprocessIntensityThreshold (default is 0x50)
|-
| 0x1E || 0x2 || Reserved
|}
 
= ClusteringProcessorConfig =
This is "nn::irsensor::ClusteringProcessorConfig".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || ExposureTime (default is 200000)
|-
| 0x8 || 0x4 || LightTarget (default is 0)
|-
| 0xC || 0x4 || Gain (default is 0x2)
|-
| 0x10 || 0x1 || IsNegativeImageUsed (default is 0)
|-
| 0x11 || 0x7 || Reserved
|-
| 0x18 || 0x2 || WindowOfInterestX (default is 0)
|-
| 0x1A || 0x2 || WindowOfInterestY (default is 0)
|-
| 0x1C || 0x2 || WindowOfInterestWidth (default is 320)
|-
| 0x1E || 0x2 || WindowOfInterestHeight (default is 240)
|-
| 0x20 || 0x4 || ObjectPixelCountMin (default is 0x3)
|-
| 0x24 || 0x4 || ObjectPixelCountMax (default is 0x12C00)
|-
| 0x28 || 0x4 || ObjectIntensityMin (default is 150)
|-
| 0x2C || 0x1 || IsExternalLightFilterEnabled (default is 0x1)
|}
 
= PackedClusteringProcessorConfig =
This is "nn::irsensor::PackedClusteringProcessorConfig".
 
This is converted from [[#ClusteringProcessorConfig]].
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || ExposureTime
|-
| 0x8 || 0x1 || LightTarget
|-
| 0x9 || 0x1 || Gain
|-
| 0xA || 0x1 || IsNegativeImageUsed
|-
| 0xB || 0x5 || Reserved
|-
| 0x10 || 0x2 || WindowOfInterestX
|-
| 0x12 || 0x2 || WindowOfInterestY
|-
| 0x14 || 0x2 || WindowOfInterestWidth
|-
| 0x16 || 0x2 || WindowOfInterestHeight
|-
| 0x18 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
|-
| 0x1C || 0x4 || ObjectPixelCountMin
|-
| 0x20 || 0x4 || ObjectPixelCountMax
|-
| 0x24 || 0x1 || ObjectIntensityMin
|-
| 0x25 || 0x1 || IsExternalLightFilterEnabled
|-
| 0x26 || 0x2 || Reserved
|}
 
= ImageTransferProcessorConfig =
This is "nn::irsensor::ImageTransferProcessorConfig".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || ExposureTime
|-
| 0x8 || 0x4 || LightTarget
|-
| 0xC || 0x4 || Gain
|-
| 0x10 || 0x1 || IsNegativeImageUsed
|-
| 0x11 || 0x7 || Reserved
|-
| 0x18 || 0x4 || [[#ImageTransferProcessorFormat|Format]]
|}
 
= PackedImageTransferProcessorConfig =
This is "nn::irsensor::PackedImageTransferProcessorConfig".
 
This is converted from [[#ImageTransferProcessorConfig]].
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || ExposureTime
|-
| 0x8 || 0x1 || LightTarget
|-
| 0x9 || 0x1 || Gain
|-
| 0xA || 0x1 || IsNegativeImageUsed
|-
| 0xB || 0x5 || Reserved
|-
| 0x10 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
|-
| 0x14 || 0x1 || [[#ImageTransferProcessorFormat|Format]]
|-
| 0x15 || 0x3 || Reserved
|}
 
= ImageTransferProcessorState =
This is "nn::irsensor::ImageTransferProcessorState".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || SamplingNumber
|-
| 0x8 || 0x4 || AmbientNoiseLevel
|-
| 0xC || 0x4 || Reserved
|}
 
= TeraPluginProcessorConfig =
This is "nn::irsensor::TeraPluginProcessorConfig".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x1 || Mode
|-
| 0x1 || 0x1 ||
|-
| 0x2 || 0x1 ||
|-
| 0x3 || 0x1 ||
|}
 
= PackedTeraPluginProcessorConfig =
This is "nn::irsensor::PackedTeraPluginProcessorConfig".
 
This is converted from [[#TeraPluginProcessorConfig]]. The data starting at offset 0x5 is only initialized by the user-process with [6.0.0+].
 
[[#TeraPluginProcessorConfig]] +0x0, +0x2, and +0x3 are copied to +0x4, 0x6, and +0x7 here. +0x5 here is set to 0x2 | ([[#TeraPluginProcessorConfig]]+0x1 << 7).
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
|-
| 0x4 || 0x1 || Mode
|-
| 0x5 || 0x1 ||
|-
| 0x6 || 0x1 ||
|-
| 0x7 || 0x1 ||
|}
 
= PointingProcessorConfig =
This is "nn::irsensor::PointingProcessorConfig".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x2 || WindowOfInterestX (default is 0)
|-
| 0x2 || 0x2 || WindowOfInterestY (default is 0)
|-
| 0x4 || 0x2 || WindowOfInterestWidth (default is 320)
|-
| 0x6 || 0x2 || WindowOfInterestHeight (default is 240)
|}
 
= PackedPointingProcessorConfig =
This is "nn::irsensor::PackedPointingProcessorConfig".
 
This is converted from [[#PointingProcessorConfig]].
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x2 || WindowOfInterestX (default is 0)
|-
| 0x2 || 0x2 || WindowOfInterestY (default is 0)
|-
| 0x4 || 0x2 || WindowOfInterestWidth (default is 320)
|-
| 0x6 || 0x2 || WindowOfInterestHeight (default is 240)
|-
| 0x8 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
|}
 
= PackedMcuVersion =
This is "nn::irsensor::PackedMcuVersion".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x2 || MajorVersion
|-
| 0x2 || 0x2 || MinorVersion
|}
 
== Versions ==
{| class="wikitable" border="1"
|-
! MajorVersion || MinorVersion || SystemVersion
|-
| 0x3 || 0xB || [1.0.0+]
|-
| 0x4 || 0x12 || [4.0.0+]
|-
| 0x5 || 0x18 || [5.0.0+]
|-
| 0x6 || 0x1A || [6.0.0+]
|-
| 0x8 || 0x1B || [8.0.0+]
|}
 
= PackedFunctionLevel =
This is nn::irsensor::PackedFunctionLevel.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x1 || [[#IrSensorFunctionLevel]]
|-
| 0x1 || 0x3 || Reserved
|}
 
== IrSensorFunctionLevel ==
This is "nn::irsensor::IrSensorFunctionLevel".
 
{| class="wikitable" border="1"
|-
! Value || SystemVersion
|-
| 0 || [1.0.0+]
|-
| 1 || [4.0.0+]
|-
| 2 || [5.0.0+]
|-
| 3 || [6.0.0+]
|-
| 4 || [8.0.0+]
|}
 
= ImageTransferProcessorExConfig =
This is "nn::irsensor::ImageTransferProcessorExConfig".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || ExposureTime
|-
| 0x8 || 0x4 || LightTarget
|-
| 0xC || 0x4 || Gain
|-
| 0x10 || 0x1 || IsNegativeImageUsed
|-
| 0x11 || 0x7 || Reserved
|-
|-
| 0x18 || 0x4 || [[#ImageTransferProcessorFormat|OrigFormat]]
| 0x18 || 0x4 || [[#ImageTransferProcessorFormat|OrigFormat]]
|-
|-
| 0x1C || 0x4 || [[#ImageTransferProcessorFormat|TrimmingFormat]]
| 0x1C || 0x4 || [[#ImageTransferProcessorFormat|TrimmingFormat]]
|-
|-
| 0x20 || 0x2 || TrimmingStartX
| 0x20 || 0x2 || TrimmingStartX
|-
|-
| 0x22 || 0x2 || TrimmingStartY
| 0x22 || 0x2 || TrimmingStartY
|-
|-
| 0x24 || 0x1 || IsExternalLightFilterEnabled
| 0x24 || 0x1 || IsExternalLightFilterEnabled
|}
|}
 
 
= PackedImageTransferProcessorExConfig =
= PackedImageTransferProcessorExConfig =
This is "nn::irsensor::PackedImageTransferProcessorExConfig".
This is "nn::irsensor::PackedImageTransferProcessorExConfig".
 
 
This is converted from [[#ImageTransferProcessorExConfig]].
This is converted from [[#ImageTransferProcessorExConfig]].
 
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || ExposureTime
|-
| 0x8 || 0x1 || LightTarget
|-
| 0x9 || 0x1 || Gain
|-
| 0xA || 0x1 || IsNegativeImageUsed
|-
| 0xB || 0x5 || Reserved
|-
| 0x10 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
|-
| 0x14 || 0x1 || [[#ImageTransferProcessorFormat|OrigFormat]]
|-
| 0x15 || 0x1 || [[#ImageTransferProcessorFormat|TrimmingFormat]]
|-
| 0x16 || 0x2 || TrimmingStartX
|-
| 0x18 || 0x2 || TrimmingStartY
|-
| 0x1A || 0x1 || IsExternalLightFilterEnabled
|-
| 0x1B || 0x5 || Reserved
|}
 
= IrLedProcessorConfig =
This is "nn::irsensor::IrLedProcessorConfig".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || LightTarget
|}
 
= PackedIrLedProcessorConfig =
This is "nn::irsensor::PackedIrLedProcessorConfig".
 
This is converted from [[#IrLedProcessorConfig]].
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
|-
| 0x4 || 0x1 || LightTarget
|-
| 0x5 || 0x3 || Padding
|}
 
= AdaptiveClusteringProcessorConfig =
This is "nn::irsensor::AdaptiveClusteringProcessorConfig".
 
AdaptiveClusteringProcessor was added with [5.0.0+].
 
This is converted to [[#TeraPluginProcessorConfig]] by the user-process. [[#TeraPluginProcessorConfig]]+0x3 is zero.
 
The default config is all-zero.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || [[#AdaptiveClusteringMode]]
|-
| 0x4 || 0x4 || [6.0.0+] [[#AdaptiveClusteringTargetDistance]]
|}
 
== AdaptiveClusteringMode ==
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || StaticFov
|-
| 1 || DynamicFov
|}
 
Controls the mode for [[#TeraPluginProcessorConfig]] (DynamicFov -> 0x10; StaticFov -> 0x0F).
 
== AdaptiveClusteringTargetDistance ==
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || Near
|-
| 1 || Middle
|-
| 2 || Far
|}
 
Controls the second and third bytes for [[#TeraPluginProcessorConfig]] (Near-> 0x00, 0x00; Middle -> 0x01, 0x03; Far -> 0x01, 0x08).
 
= HandAnalysisConfig =
This is "nn::irsensor::HandAnalysisConfig".
 
This is converted to [[#TeraPluginProcessorConfig]] by the user-process, which is all-zero except the mode.
* pre-4.0.0: [[#TeraPluginProcessorConfig]] mode = [[#HandAnalysisMode]] - 1.
* [4.0.0+]: Silhouette = 0x5, Image = 0x6, SilhouetteAndImage = 0x7, SilhouetteOnly = 0xA.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || [[#HandAnalysisMode]]
|}
 
== HandAnalysisMode ==
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || None (invalid)
|-
| 1 || Silhouette
|-
| 2 || Image
|-
| 3 || SilhouetteAndImage
|-
| 4 || [4.0.0+] SilhouetteOnly
|}
 
= BusHandle =
This is "nn::hidbus::BusHandle".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || AbstractedPadId
|-
| 0x4 || 0x1 || InternalIndex
|-
| 0x5 || 0x1 || PlayerNumber
|-
| 0x6 || 0x1 || BusTypeId
|-
| 0x7 || 0x1 || IsValid
|}
 
= JoyPollingReceivedData =
This is "nn::hidbus::JoyPollingReceivedData".
 
This is copied from the entries in [[#EnableJoyPollingReceiveMode|TransferMemory]] by GetJoyPollingReceivedData.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x30 || Data
|-
| 0x30 || 0x8 || OutSize
|-
| 0x38 || 0x8 || SamplingNumber
|}
 
= BusType =
This is "nn::hidbus::BusType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || LeftJoyRail
|-
| 1 || RightJoyRail
|-
| 2 || [6.0.0+] InternalBus (for Lark microphone)
|}
 
= JoyPollingMode =
This is "nn::hidbus::JoyPollingMode".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || SixAxisSensorDisable
|-
| 1 || SixAxisSensorEnable
|-
| 2 || ButtonOnly
|}
 
Other values causes [[#EnableJoyPollingReceiveMode]] to assert.
 
= StatusManagerType =
This is "nn::hidbus::detail::StatusManagerType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || None
|-
| 1 || 16
|-
| 2 || 32
|}
 
= ExternalDevices =
The following devices are used via hidbus:
* [[Ring-Con]]
** [[#BusType|BusType]] is 0 (LeftJoyRail) or 1 (RightJoyRail).
** [[#GetExternalDeviceId|DeviceId]] is 0x20 ("Ronde").
* Famicom right controller (with microphone)
** [[#BusType|BusType]] is 2 (InternalBus).
** [[#GetExternalDeviceId|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|BusType]] is 1 (RightJoyRail).
** [[#GetExternalDeviceId|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 <code>out_size==0x4 && data[0]==0x09 && (data[1] & 1 == 1)</code>.
 
= 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 [[Title_list|0100000000000822]].
 
= Firmware Update =
HID-sysmodule mounts the contents of title [[Title_list|0100000000000822]] as "systemData" or the contents of title [[Title_list|010000000000B22B]] as "systemDataD". Both titles contain the same files, but [[Title_list|0100000000000822]] is used on retail units while [[Title_list|010000000000B22B]] is used for development.
 
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.
* [S2] [20.1.1+] '''ExpectVersionInfo.json'''
* '''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.
* [S1] [8.1.1+] '''ExpectVersionInfo-platform.hoag.csv'''
** Same as "ExpectVersionInfo.csv" but for the Switch Lite platform.
* [S1] [8.1.1+] '''FirmwareInfo-platform.hoag.csv'''
** Same as "FirmwareInfo.csv" but for the Switch Lite platform.
* [S1] [8.1.1+] '''sioh.bin'''
** Switch Lite Joy-Con firmware.
* [S1] [8.1.1+] '''sioh_iap.bin'''
** Switch Lite Joy-Con (IAP profile) firmware.
* [S1] [10.0.0+] '''FTS_00120100.fts256'''
** Touch Screen controller firmware in FTS256 format.
* [S1] [10.0.0+] '''FTS_32000001.fts256'''
** Touch Screen controller firmware in FTS256 format for panel vendor "Nissha".
* [S1] [10.0.0+] '''FTS_32000102.fts256'''
** Touch Screen controller firmware in FTS256 format for panel vendor "GIS".
* [S1] [10.0.0+] '''FTS_32000302.fts256'''
** Touch Screen controller firmware in FTS256 format for panel vendor "Nissha_Hoag".
* [S1] [10.0.0+] '''FTS_32000402.fts256'''
** Touch Screen controller firmware in FTS256 format for panel vendor "GIS_Hoag".
* [S1] [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.
** With [S2] there's only a single hex-value field between "driver" and "file". "driver" is "Innolux" or "Sharp".
* [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".
* [S1] [14.0.0+] '''FTS_50000002.ftb'''
** Touch Screen controller firmware in FTB format for panel vendor "Nissha".
* [S2] [20.1.1+] '''JoyLeftImage1.json'''
* [S2] [20.1.1+] '''JoyLeftImage2.json'''
* [S2] [20.1.1+] '''JoyRightImage1.json'''
* [S2] [20.1.1+] '''JoyRightImage2.json'''
* [S2] '''NT36683_INX.bin'''
** Touch Screen controller firmware for panel vendor "Innolux".
* [S2] '''NT36683_SHP.bin'''
** Touch Screen controller firmware for panel vendor "Sharp".
* [S2] [20.1.1+] '''OunceJoyLeft.bin'''
* [S2] [20.1.1+] '''OunceJoyLeftBtPatch.bin'''
* [S2] [20.1.1+] '''OunceJoyRight.bin'''
* [S2] [20.1.1+] '''OunceJoyRightBtPatch.bin'''
* [S2] [20.1.1+] '''OunceProCon.bin'''
* [S2] [20.1.1+] '''OunceProConBtPatch.bin'''
* [S2] [20.1.1+] '''OunceProConDspFirmware.img'''
* [S2] [20.1.1+] '''ProConImage1.json'''
* [S2] [20.1.1+] '''ProConImage2.json'''
* [S2] [20.1.1+] '''ProConImage3.json'''
 
== Versions ==
=== Ukyosakyo ===
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! SystemVersion
|-
! FirmwareVersion
| 0x0 || 0x8 || ExposureTime
|-
| 0x8 || 0x1 || LightTarget
|-
| 0x9 || 0x1 || Gain
|-
| 0xA || 0x1 || IsNegativeImageUsed
|-
| 0xB || 0x5 || Reserved
|-
| 0x10 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
|-
| 0x14 || 0x1 || [[#ImageTransferProcessorFormat|OrigFormat]]
|-
|-
| 0x15 || 0x1 || [[#ImageTransferProcessorFormat|TrimmingFormat]]
| [1.0.0+]
| 0348
|-
|-
| 0x16 || 0x2 || TrimmingStartX
| [5.0.0+]
| 0389
|-
|-
| 0x18 || 0x2 || TrimmingStartY
| [6.0.0+]
| 038B
|-
|-
| 0x1A || 0x1 || IsExternalLightFilterEnabled
| [7.0.0+]
| 03A6
|-
|-
| 0x1B || 0x5 || Reserved
| [8.0.0+]
|}
| 03B5
 
= IrLedProcessorConfig =
This is "nn::irsensor::IrLedProcessorConfig".
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| [9.0.0+]
| 0400
|-
|-
| 0x0 || 0x4 || LightTarget
| [10.0.0+]
|}
| 0406
 
= PackedIrLedProcessorConfig =
This is "nn::irsensor::PackedIrLedProcessorConfig".
 
This is converted from [[#IrLedProcessorConfig]].
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| [11.0.0+]
| 0407
|-
|-
| 0x0 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
| [12.1.0+]
| 0410
|-
|-
| 0x4 || 0x1 || LightTarget
| [13.0.0+]
| 0417
|-
|-
| 0x5 || 0x3 || Padding
| [14.0.0+]
| 0419
|}
|}


= AdaptiveClusteringProcessorConfig =
=== Raizo ===
This is "nn::irsensor::AdaptiveClusteringProcessorConfig".
 
AdaptiveClusteringProcessor was added with [5.0.0+].
 
This is converted to [[#TeraPluginProcessorConfig]] by the user-process. [[#TeraPluginProcessorConfig]]+0x3 is zero.
 
The default config is all-zero.
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! SystemVersion
! FirmwareVersion
|-
|-
| 0x0 || 0x4 || [[#AdaptiveClusteringMode]]
| [1.0.0+]
| 0348
|-
|-
| 0x4 || 0x4 || [6.0.0+] [[#AdaptiveClusteringTargetDistance]]
| [15.0.0+]
| 0421
|}
|}


== AdaptiveClusteringMode ==
=== Tera ===
{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || StaticFov
! SystemVersion
! FirmwareVersion
|-
|-
| 1 || DynamicFov
| [1.0.0+]
|}
| 030B
 
Controls the mode for [[#TeraPluginProcessorConfig]] (DynamicFov -> 0x10; StaticFov -> 0x0F).
 
== AdaptiveClusteringTargetDistance ==
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || Near
|-
|-
| 1 || Middle
| [4.0.0+]
| 0412
|-
|-
| 2 || Far
| [5.0.0+]
|}
| 0518
 
Controls the second and third bytes for [[#TeraPluginProcessorConfig]] (Near-> 0x00, 0x00; Middle -> 0x01, 0x03; Far -> 0x01, 0x08).
 
= HandAnalysisConfig =
This is "nn::irsensor::HandAnalysisConfig".
 
This is converted to [[#TeraPluginProcessorConfig]] by the user-process, which is all-zero except the mode.
* pre-4.0.0: [[#TeraPluginProcessorConfig]] mode = [[#HandAnalysisMode]] - 1.
* [4.0.0+]: Silhouette = 0x5, Image = 0x6, SilhouetteAndImage = 0x7, SilhouetteOnly = 0xA.
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| [6.0.0+]
| 061A
|-
|-
| 0x0 || 0x4 || [[#HandAnalysisMode]]
| [8.0.0+]
| 081B
|}
|}


== HandAnalysisMode ==
=== TeraFullKey ===
{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || None (invalid)
! SystemVersion
! FirmwareVersion
|-
|-
| 1 || Silhouette
| [1.0.0+]
|-
| 0305
| 2 || Image
|-
| 3 || SilhouetteAndImage
|-
| 4 || [4.0.0+] SilhouetteOnly
|}
|}


= BusHandle =
=== ProController ===
This is "nn::hidbus::BusHandle".
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! SystemVersion
|-
! FirmwareVersion
| 0x0 || 0x4 || AbstractedPadId
|-
| 0x4 || 0x1 || InternalIndex
|-
| 0x5 || 0x1 || PlayerNumber
|-
|-
| 0x6 || 0x1 || BusTypeId
| -
| 010A0200
|-
|-
| 0x7 || 0x1 || IsValid
| [6.0.0+]
| 01100210
|}
|}


= JoyPollingReceivedData =
=== Palma ===
This is "nn::hidbus::JoyPollingReceivedData".
 
This is copied from the entries in [[#EnableJoyPollingReceiveMode|TransferMemory]] by GetJoyPollingReceivedData.
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! SystemVersion
! FirmwareVersion
|-
|-
| 0x0 || 0x30 || Data
| -
| 1100
|-
|-
| 0x30 || 0x8 || Size of data.
| [6.1.0+]
|-
| 1200
| 0x38 || 0x8 || Timestamp
|}
|}


= BusType =
=== SioH ===
This is "nn::hidbus::BusType".
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || JoyLeftRail
! SystemVersion
! FirmwareVersion
|-
|-
| 1 || JoyRightRail
| -
|-
| 000D
| 2 || [6.0.0+] LarkRightRail (for microphone)
|}
 
= JoyPollingMode =
This is "nn::hidbus::JoyPollingMode".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || JoyPollingMode_SixAxisSensorDisable
| [8.1.1+]
| 0200
|-
|-
| 1 || JoyPollingMode_SixAxisSensorEnable
| [10.0.0+]
| 0301
|-
|-
| 2 || JoyPollingMode_ButtonOnly
| [11.0.0+]
| 0304
|}
|}
Other values causes [[#EnableJoyPollingReceiveMode]] to assert.
= ExternalDevices =
The following devices are used via hidbus:
* [[Ring-Con]]
* Famicom right controller (with microphone)
= RomFS =
The hid-sysmodule RomFS contains:
  ftmFwUpdate
    ├── NTD_4CD_1801.fts256
    ├── NTD_4CD_2602.fts256
    ├── NTD_4CD_3801.fts256
    └── NTD_4CD_xxxx.fts256 [7.0.0+]
These are firmware files for the touchscreen controller.
[9.0.0+] The hid-sysmodule RomFS now contains:
  ftmFwUpdate
    ├── FTS_00120100.fts256
    ├── FTS_32000001.fts256
    ├── FTS_32000102.fts256
    ├── FTS_32000302.fts256
    └── FTS_32000402.fts256
= Firmware update =
HID-sysmodule mounts the contents of title [[Title_list|0100000000000822]] as "systemData" or the contents of title [[Title_list|010000000000B22B]] as "systemDataD". Both titles contain the same files, but [[Title_list|0100000000000822]] is used on retail units while [[Title_list|010000000000B22B]] is used for development.
[10.0.0+]: The RomFs for hid-sysmodule was removed, the data which used to be in that RomFs was moved into this SystemData (the below .fts256 files).
These titles contain the following files:
* '''ExpectVersionInfo.csv''' - List in the format "[device],[type],[version]" where "device" can be "JoyLeft", "JoyRight", "FullKey", "Palma" or "Handheld", "type" can be "BT", "MCU", "USB" or "SioH" and "version" is the hexadecimal representation of the firmware file's version.
* '''FirmwareInfo.csv''' - List in the format "[device],[type],[version],[file]" where "device", "type" and "version" should match the values from "ExpectVersionInfo" and "file" is the name of the firmware file.
* '''ukyosakyo_ep2_ota.bin''' - Left/Right Joy-Con BT firmware.
* '''raizo_ep2_ota.bin''' - Pro Controller BT firmware.
* '''tera_ota.bin''' - Right Joy-Con MCU firmware.
* '''tera_ota_iap.bin''' - Right Joy-Con MCU (IAP profile) firmware.
* '''tera_fullkey_ota.bin''' - Pro Controller MCU firmware.
* '''tera_fullkey_ota_iap.bin''' - Pro Controller MCU (IAP profile) firmware.
* [6.0.0+] '''ProController.dfu''' - Pro Controller USB firmware.
* [6.1.0+] '''PalmaFw.bin''' - Poké Ball Plus BT firmware.
* [9.0.0+] '''ExpectVersionInfo-platform.hoag.csv''' - Same as "ExpectVersionInfo.csv" but for the Switch Lite platform.
* [9.0.0+] '''FirmwareInfo-platform.hoag.csv''' - Same as "FirmwareInfo.csv" but for the Switch Lite platform.
* [9.0.0+] '''sioh.bin''' - Switch Lite Joy-Con firmware.
* [9.0.0+] '''sioh_iap.bin''' - Switch Lite Joy-Con (IAP profile) firmware.
* [10.0.0+] '''FTS_00120100.fts256'''
* [10.0.0+] '''FTS_32000001.fts256'''
* [10.0.0+] '''FTS_32000102.fts256'''
* [10.0.0+] '''FTS_32000302.fts256'''
* [10.0.0+] '''FTS_32000402.fts256'''
* [10.0.0+] '''TouchScreenConfiguration.csv'''
* [10.0.0+] '''TouchScreenFirmwareInfo.csv'''


[[Category:Services]]
[[Category:Services]]
Retrieved from "https://switchbrew.org/wiki/HID_services"