HID services: Difference between revisions

Masagrator (talk | contribs)
 
(76 intermediate revisions by 4 users not shown)
Line 13: Line 13:
|-
|-
| 21 || [[#ActivateMouse]]
| 21 || [[#ActivateMouse]]
|-
| 22 || [19.0.0+] AddMouseWheelDelta
|-
|-
| 26 || [16.0.0+] ActivateDebugMouse
| 26 || [16.0.0+] ActivateDebugMouse
Line 95: Line 97:
|-
|-
| 91 || [[#ActivateGesture]]
| 91 || [[#ActivateGesture]]
|-
| 92 || [18.0.0+] SetGestureOutputRanges
|-
|-
| 100 || [[#SetSupportedNpadStyleSet]]
| 100 || [[#SetSupportedNpadStyleSet]]
Line 147: Line 151:
|-
|-
| 136 || [8.0.0+] [[#ClearNpadCaptureButtonAssignment]]
| 136 || [8.0.0+] [[#ClearNpadCaptureButtonAssignment]]
|-
| 137 || [20.0.0+] SetNpadGcAnalogStick8bitRawValue
|-
| 138 || [S2] [20.0.0+] [[#SetSceneIdForPrivateApp|SetSceneIdForPrivateApp]]
|-
| 139 || [S2] [20.0.0+] [[#GetSceneIdForPrivateApp|GetSceneIdForPrivateApp]]
|-
|-
| 200 || [[#GetVibrationDeviceInfo]]
| 200 || [[#GetVibrationDeviceInfo]]
Line 173: Line 183:
|-
|-
| 212 || [11.0.0+] [[#SendVibrationValueInBool]]
| 212 || [11.0.0+] [[#SendVibrationValueInBool]]
|-
| 213 || [17.0.0+] SendVibrationValueInMode
|-
| 214 || [17.0.0+] SendVibrationValuesInMode
|-
| 220 || [S2] [20.0.0+] [[#IsOunceVibrationDeviceMounted|IsOunceVibrationDeviceMounted]]
|-
|-
| 300 || [3.0.0+] [[#ActivateConsoleSixAxisSensor]]
| 300 || [3.0.0+] [[#ActivateConsoleSixAxisSensor]]
Line 195: Line 211:
|-
|-
| 310 || [6.0.0+] [[#ResetSevenSixAxisSensorTimestamp]]
| 310 || [6.0.0+] [[#ResetSevenSixAxisSensorTimestamp]]
|-
| 311 || [17.0.0+] ForceActivateConsoleSixAxisSensor
|-
| 312 || [17.0.0+] ForceDeactivateConsoleSixAxisSensor
|-
| 320 || [21.0.0+] EnableNpadImu
|-
| 321 || [21.0.0+] DisableNpadImu
|-
|-
| 400 || [3.0.0+] [[#IsUsbFullKeyControllerEnabled]]
| 400 || [3.0.0+] [[#IsUsbFullKeyControllerEnabled]]
Line 273: Line 297:
|-
|-
| 529 || [8.0.0+] [[#SetDisallowedPalmaConnection]]
| 529 || [8.0.0+] [[#SetDisallowedPalmaConnection]]
|-
| 550 || [S2] [20.0.0+] [[#GetGlGrButtonConfigState|GetGlGrButtonConfigState]]
|-
|-
| 1000 || [[#SetNpadCommunicationMode]]
| 1000 || [[#SetNpadCommunicationMode]]
Line 281: Line 307:
|-
|-
| 1003 || [9.0.0+] [[#IsFirmwareUpdateNeededForNotification]]
| 1003 || [9.0.0+] [[#IsFirmwareUpdateNeededForNotification]]
|-
| 1004 || [20.0.0+] [[#SetTouchScreenOutputRanges|SetTouchScreenOutputRanges]] ([17.0.0-19.0.1] SetTouchScreenResolution)
|-
| 1005 || [20.0.0+] EnableNxTouchScreenEmulationForTouchEnter
|-
|-
| 2000 || [10.0.0+] [[#ActivateDigitizer]]
| 2000 || [10.0.0+] [[#ActivateDigitizer]]
Line 307: Line 337:
|-
|-
| 3011 || [15.0.0+] ResetFullKeyKeyboardMap
| 3011 || [15.0.0+] ResetFullKeyKeyboardMap
|-
| 3012 || [21.0.0+] GetDebugPadGenericPadMap
|-
| 3013 || [21.0.0+] SetDebugPadGenericPadMap
|-
| 3014 || [21.0.0+] GetDebugPadKeyboardMap
|-
| 3015 || [21.0.0+] SetDebugPadKeyboardMap
|-
| 3110 || [S2] [[#InitializeJcms|InitializeJcms]]
|-
| 3111 || [S2] [[#FinalizeJcms|FinalizeJcms]]
|-
| 3112 || [S2] [[#StartJcms|StartJcms]]
|-
| 3113 || [S2] [[#StopJcms|StopJcms]]
|-
| 3130 || [S2] [20.0.0+] [[#InitializeNmouse|InitializeNmouse]]
|-
| 3131 || [S2] [20.0.0+] [[#FinalizeNmouse|FinalizeNmouse]]
|-
| 3132 || [S2] [20.0.0+] [[#SetNmousePointerRanges|SetNmousePointerRanges]]
|-
| 3133 || [S2] [20.0.0+] [[#GetNmousePointerRanges|GetNmousePointerRanges]]
|-
| 3135 || [S2] [20.0.0+] [[#EnableShowingCursor|EnableShowingCursor]]
|-
| 3136 || [S2] [20.0.0+] [[#SetNmouseButtonConfigJoyLeftJcms|SetNmouseButtonConfigJoyLeftJcms]]
|-
| 3137 || [S2] [20.0.0+] [[#SetNmouseButtonConfigJoyRightJcms|SetNmouseButtonConfigJoyRightJcms]]
|-
| 3138 || [S2] [20.0.0+] [[#SetMergedNmouseSourceTypes|SetMergedNmouseSourceTypes]]
|-
| 3139 || [S2] [20.0.0+] [[#InitializeNmouse2|InitializeNmouse2]]
|-
| 3140 || [S2] [20.0.0+] [[#SetNmousePointerPosition|SetNmousePointerPosition]]
|-
| 3141 || [S2] [20.0.0+] [[#EnableNmousePointer|EnableNmousePointer]]
|-
| 3142 || [S2] [20.0.0+] [[#RestrictNmousePointer|RestrictNmousePointer]]
|-
| 3143 || [S2] [20.0.0+]
|-
| 3150 || [21.0.0+] SetMouseLibraryVersion
|}
|}


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


== ActivateDebugPad ==
== ActivateDebugPad ==
Takes a PID and an [[AM_services|AppletResourceUserId]], no output.
Takes a PID and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


== ActivateTouchScreen ==
== ActivateTouchScreen ==
Takes a PID and an [[AM_services|AppletResourceUserId]], no output.
Takes a PID and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


== ActivateMouse ==
== ActivateMouse ==
Takes a PID and an [[AM_services|AppletResourceUserId]], no output.
Takes a PID and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


== ActivateKeyboard ==
== ActivateKeyboard ==
Takes a PID and an [[AM_services|AppletResourceUserId]], no output.
Takes a PID and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


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


This is identical to the hidsys cmd.
This is identical to the hidsys cmd.
Line 340: Line 414:


== ActivateXpad ==
== ActivateXpad ==
Takes a PID, an u32 "nn::hid::BasicXpadId", an [[AM_services|AppletResourceUserId]], no output.
Takes a PID, an u32 "nn::hid::BasicXpadId", an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


[10.0.0+] Stubbed, just returns 0.
[10.0.0+] Stubbed, just returns 0.
Line 395: Line 469:


== StartSixAxisSensor ==
== StartSixAxisSensor ==
Takes a PID, a [[#SixAxisSensorHandle]], and an [[AM_services|AppletResourceUserId]], no output.
Takes a PID, a [[#SixAxisSensorHandle]], and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


== StopSixAxisSensor ==
== StopSixAxisSensor ==
Takes a PID, a [[#SixAxisSensorHandle]], and an [[AM_services|AppletResourceUserId]], no output.
Takes a PID, a [[#SixAxisSensorHandle]], and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


== IsSixAxisSensorFusionEnabled ==
== IsSixAxisSensorFusionEnabled ==
Takes a PID, a [[#SixAxisSensorHandle]], and an [[AM_services|AppletResourceUserId]], returns an output bool.
Takes a PID, a [[#SixAxisSensorHandle]], and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], returns an output bool.


== EnableSixAxisSensorFusion ==
== EnableSixAxisSensorFusion ==
Takes a PID, a bool, a [[#SixAxisSensorHandle]], and an [[AM_services|AppletResourceUserId]], no output.
Takes a PID, a bool, a [[#SixAxisSensorHandle]], and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


== SetSixAxisSensorFusionParameters ==
== SetSixAxisSensorFusionParameters ==
Takes a PID-descriptor, an u32 [[#SixAxisSensorHandle]], two floats, and an u64 [[AM_services|AppletResourceUserId]], no output.
Takes a PID-descriptor, an u32 [[#SixAxisSensorHandle]], two floats, and an u64 [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


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


== GetSixAxisSensorFusionParameters ==
== GetSixAxisSensorFusionParameters ==
Takes a PID-descriptor, an u32 [[#SixAxisSensorHandle]], and an u64 [[AM_services|AppletResourceUserId]], returns two output floats.
Takes a PID-descriptor, an u32 [[#SixAxisSensorHandle]], and an u64 [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], returns two output floats.


== ResetSixAxisSensorFusionParameters ==
== ResetSixAxisSensorFusionParameters ==
Takes a PID-descriptor, an u32 [[#SixAxisSensorHandle]], and an u64 [[AM_services|AppletResourceUserId]], no output.
Takes a PID-descriptor, an u32 [[#SixAxisSensorHandle]], and an u64 [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


== SetAccelerometerParameters ==
== SetAccelerometerParameters ==
Takes a PID, a [[#SixAxisSensorHandle]], two floats, and an [[AM_services|AppletResourceUserId]], no output.
Takes a PID, a [[#SixAxisSensorHandle]], two floats, and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


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


== GetAccelerometerParameters ==
== GetAccelerometerParameters ==
Takes a PID, a [[#SixAxisSensorHandle]], and an [[AM_services|AppletResourceUserId]], returns two output floats.
Takes a PID, a [[#SixAxisSensorHandle]], and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], returns two output floats.


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


== ResetAccelerometerParameters ==
== ResetAccelerometerParameters ==
Takes a PID, a [[#SixAxisSensorHandle]], and an [[AM_services|AppletResourceUserId]], no output.
Takes a PID, a [[#SixAxisSensorHandle]], and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


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


== SetAccelerometerPlayMode ==
== SetAccelerometerPlayMode ==
Takes a PID, a [[#SixAxisSensorHandle]], an u32 [[#AccelerometerPlayMode]], and an u64 [[AM_services|AppletResourceUserId]], no output.
Takes a PID, a [[#SixAxisSensorHandle]], an u32 [[#AccelerometerPlayMode]], and an u64 [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


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


== GetAccelerometerPlayMode ==
== GetAccelerometerPlayMode ==
Takes a PID, a [[#SixAxisSensorHandle]], and an [[AM_services|AppletResourceUserId]], returns an output u32 [[#AccelerometerPlayMode]].
Takes a PID, a [[#SixAxisSensorHandle]], and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], returns an output u32 [[#AccelerometerPlayMode]].


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


== ResetAccelerometerPlayMode ==
== ResetAccelerometerPlayMode ==
Takes a PID, a [[#SixAxisSensorHandle]], and an [[AM_services|AppletResourceUserId]], no output.
Takes a PID, a [[#SixAxisSensorHandle]], and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


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


== SetGyroscopeZeroDriftMode ==
== SetGyroscopeZeroDriftMode ==
Takes a PID-descriptor, an u32 [[#SixAxisSensorHandle]], an u32 [[#GyroscopeZeroDriftMode]], and an u64 [[AM_services|AppletResourceUserId]], no output.
Takes a PID-descriptor, an u32 [[#SixAxisSensorHandle]], an u32 [[#GyroscopeZeroDriftMode]], and an u64 [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


== GetGyroscopeZeroDriftMode ==
== GetGyroscopeZeroDriftMode ==
Takes a PID-descriptor, an u32 [[#SixAxisSensorHandle]], and an u64 [[AM_services|AppletResourceUserId]], returns an output u32 [[#GyroscopeZeroDriftMode]].
Takes a PID-descriptor, an u32 [[#SixAxisSensorHandle]], and an u64 [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], returns an output u32 [[#GyroscopeZeroDriftMode]].


Gets the value written by [[#SetGyroscopeZeroDriftMode]].
Gets the value written by [[#SetGyroscopeZeroDriftMode]].


== ResetGyroscopeZeroDriftMode ==
== ResetGyroscopeZeroDriftMode ==
Takes a PID-descriptor, an u32 [[#SixAxisSensorHandle]], and an u64 [[AM_services|AppletResourceUserId]], no output.
Takes a PID-descriptor, an u32 [[#SixAxisSensorHandle]], and an u64 [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


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


== IsSixAxisSensorAtRest ==
== IsSixAxisSensorAtRest ==
Takes a PID, a [[#SixAxisSensorHandle]], and an [[AM_services|AppletResourceUserId]], returns an output bool.
Takes a PID, a [[#SixAxisSensorHandle]], and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], returns an output bool.


== IsFirmwareUpdateAvailableForSixAxisSensor ==
== IsFirmwareUpdateAvailableForSixAxisSensor ==
Takes a PID, a [[#SixAxisSensorHandle]], and an [[AM_services|AppletResourceUserId]], returns an output bool.
Takes a PID, a [[#SixAxisSensorHandle]], and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], returns an output bool.


== EnableSixAxisSensorUnalteredPassthrough ==
== EnableSixAxisSensorUnalteredPassthrough ==
Takes a PID, a [[#SixAxisSensorHandle]], a bool, and an [[AM_services|AppletResourceUserId]], no output.
Takes a PID, a [[#SixAxisSensorHandle]], a bool, and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


== IsSixAxisSensorUnalteredPassthroughEnabled ==
== IsSixAxisSensorUnalteredPassthroughEnabled ==
Takes a PID, a [[#SixAxisSensorHandle]], and an [[AM_services|AppletResourceUserId]], returns an output bool.
Takes a PID, a [[#SixAxisSensorHandle]], and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], returns an output bool.


== StoreSixAxisSensorCalibrationParameter ==
== StoreSixAxisSensorCalibrationParameter ==
Takes a PID, a [[#SixAxisSensorHandle]], a SixAxisSensorCalibrationParameter, and an [[AM_services|AppletResourceUserId]], no output.
Takes a PID, a [[#SixAxisSensorHandle]], a SixAxisSensorCalibrationParameter, and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


== LoadSixAxisSensorCalibrationParameter ==
== LoadSixAxisSensorCalibrationParameter ==
Takes a PID, a [[#SixAxisSensorHandle]], and an [[AM_services|AppletResourceUserId]], returns a SixAxisSensorCalibrationParameter.
Takes a PID, a [[#SixAxisSensorHandle]], and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], returns a SixAxisSensorCalibrationParameter.


== GetSixAxisSensorIcInformation ==
== GetSixAxisSensorIcInformation ==
Takes a PID, a [[#SixAxisSensorHandle]], and an [[AM_services|AppletResourceUserId]], returns a SixAxisSensorIcInformation.
Takes a PID, a [[#SixAxisSensorHandle]], and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], returns a SixAxisSensorIcInformation.


== ResetIsSixAxisSensorDeviceNewlyAssigned ==
== ResetIsSixAxisSensorDeviceNewlyAssigned ==
Takes a PID, a [[#SixAxisSensorHandle]], and an [[AM_services|AppletResourceUserId]], no output.
Takes a PID, a [[#SixAxisSensorHandle]], and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


== ActivateGesture ==
== ActivateGesture ==
Takes a PID-descriptor, a s32, and an u64 [[AM_services|AppletResourceUserId]], no output.
Takes a PID-descriptor, a s32, and an u64 [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


sdknso passes hard-coded value 1 for the s32.
sdknso passes hard-coded value 1 for the s32.


== SetSupportedNpadStyleSet ==
== SetSupportedNpadStyleSet ==
Takes a PID-descriptor, an u32 [[#NpadStyleTag]], and an u64 [[AM_services|AppletResourceUserId]], no output.
Takes a PID-descriptor, an u32 [[#NpadStyleTag]], and an u64 [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


== GetSupportedNpadStyleSet ==
== GetSupportedNpadStyleSet ==
Takes a PID-descriptor and an u64 [[AM_services|AppletResourceUserId]], returns an u32 [[#NpadStyleTag]].
Takes a PID-descriptor and an u64 [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], returns an u32 [[#NpadStyleTag]].


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


The input buffer contains an array of [[#NpadIdType]]. The total entries in this array must be <=10.
The input buffer contains an array of [[#NpadIdType]]. The total entries in this array must be <=10.


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


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


== DeactivateNpad ==
== DeactivateNpad ==
Takes a PID and an [[AM_services|AppletResourceUserId]]. No output.
Takes a PID and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]]. No output.


This just returns 0.
This just returns 0.
Line 515: Line 589:


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


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


== DisconnectNpad ==
== DisconnectNpad ==
Takes a PID, an u32 [[#NpadIdType]], and an [[AM_services|AppletResourceUserId]]. No output.
Takes a PID, an u32 [[#NpadIdType]], and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]]. No output.


== GetPlayerLedPattern ==
== GetPlayerLedPattern ==
Line 526: Line 600:


== ActivateNpadWithRevision ==
== ActivateNpadWithRevision ==
Takes a PID-descriptor, a s32 revision, and an [[AM_services|AppletResourceUserId]]. No output.
Takes a PID-descriptor, a s32 revision, and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]]. No output.


Revisions:
Revisions:
Line 533: Line 607:
* 0x2: [6.0.0+]
* 0x2: [6.0.0+]
* 0x3: [8.0.0+]
* 0x3: [8.0.0+]
* 0x5: [18.0.0+]


== SetNpadJoyHoldType ==
== SetNpadJoyHoldType ==
Takes a PID-descriptor, an input [[#NpadJoyHoldType]], and an [[AM_services|AppletResourceUserId]]. No output.
Takes a PID-descriptor, an input [[#NpadJoyHoldType]], and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]]. No output.


== GetNpadJoyHoldType ==
== GetNpadJoyHoldType ==
Takes a PID-descriptor and an [[AM_services|AppletResourceUserId]]. Returns an output [[#NpadJoyHoldType]].
Takes a PID-descriptor and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]]. Returns an output [[#NpadJoyHoldType]].


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


== SetNpadJoyAssignmentModeSingleByDefault ==
== SetNpadJoyAssignmentModeSingleByDefault ==
Takes a PID-descriptor, an u32 [[#NpadIdType]], and an [[AM_services|AppletResourceUserId]]. No output.
Takes a PID-descriptor, an u32 [[#NpadIdType]], and an [[Applet_Manager_services#AppletResourceUserId|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 [[#NpadIdType]], [[AM_services|AppletResourceUserId]], and s64 [[#NpadJoyDeviceType]]. No output.
Takes a PID-descriptor, an u32 [[#NpadIdType]], [[Applet_Manager_services#AppletResourceUserId|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 [[#NpadIdType]], and an [[AM_services|AppletResourceUserId]]. No output.
Takes a PID-descriptor, an u32 [[#NpadIdType]], and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]]. No output.


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


== StartLrAssignmentMode ==
== StartLrAssignmentMode ==
Takes a PID and an [[AM_services|AppletResourceUserId]], no output.
Takes a PID and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


== StopLrAssignmentMode ==
== StopLrAssignmentMode ==
Takes a PID and an [[AM_services|AppletResourceUserId]], no output.
Takes a PID and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


== SetNpadHandheldActivationMode ==
== SetNpadHandheldActivationMode ==
Takes a PID, an [[AM_services|AppletResourceUserId]], a s64 [[#NpadHandheldActivationMode]], no output.
Takes a PID, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], a s64 [[#NpadHandheldActivationMode]], no output.


== GetNpadHandheldActivationMode ==
== GetNpadHandheldActivationMode ==
Takes a PID and an u64 [[AM_services|AppletResourceUserId]]. Returns an output s64 [[#NpadHandheldActivationMode]]. Official user-processes Abort if the output value is not 0-2.
Takes a PID and an u64 [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]]. Returns an output s64 [[#NpadHandheldActivationMode]]. Official user-processes Abort if the output value is not 0-2.


== SwapNpadAssignment ==
== SwapNpadAssignment ==
Takes a PID, two u32s [[#NpadIdType]], and an [[AM_services|AppletResourceUserId]]. No output.
Takes a PID, two u32s [[#NpadIdType]], and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]]. No output.


== IsUnintendedHomeButtonInputProtectionEnabled ==
== IsUnintendedHomeButtonInputProtectionEnabled ==
Takes a PID, an u32 [[#NpadIdType]], and an [[AM_services|AppletResourceUserId]]. Returns an output bool.
Takes a PID, an u32 [[#NpadIdType]], and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]]. Returns an output bool.


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


== EnableUnintendedHomeButtonInputProtection ==
== EnableUnintendedHomeButtonInputProtection ==
Takes a PID, a bool, an u32 [[#NpadIdType]], and an [[AM_services|AppletResourceUserId]]. No output.
Takes a PID, a bool, an u32 [[#NpadIdType]], and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]]. No output.


== SetNpadJoyAssignmentModeSingleWithDestination ==
== SetNpadJoyAssignmentModeSingleWithDestination ==
Takes a PID, an u32, an [[AM_services|AppletResourceUserId]], and s64 [[#NpadJoyDeviceType]]. Returns an output bool and u32 [[#NpadIdType]].
Takes a PID, an u32, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], and s64 [[#NpadJoyDeviceType]]. Returns an output bool and u32 [[#NpadIdType]].


The bool indicates whether the output [[#NpadIdType]] is set.
The bool indicates whether the output [[#NpadIdType]] is set.


== SetNpadAnalogStickUseCenterClamp ==
== SetNpadAnalogStickUseCenterClamp ==
Takes a PID, a bool, an [[AM_services|AppletResourceUserId]], no output.
Takes a PID, a bool, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


== SetNpadCaptureButtonAssignment ==
== SetNpadCaptureButtonAssignment ==
Takes a PID, a [[#NpadStyleSet]], an [[AM_services|AppletResourceUserId]], a [[#NpadButtonSet]], no output.
Takes a PID, a [[#NpadStyleSet]], an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], a [[#NpadButtonSet]], no output.


Exactly 1 bit must be set in the [[#NpadStyleSet]]. Multiple button bits can be set.
Exactly 1 bit must be set in the [[#NpadStyleSet]]. Multiple button bits can be set.
Line 597: Line 672:


== ClearNpadCaptureButtonAssignment ==
== ClearNpadCaptureButtonAssignment ==
Takes a PID, an [[AM_services|AppletResourceUserId]], no output.
Takes a PID, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.
 
== SetSceneIdForPrivateApp ==
This is exclusive to S2.
 
Takes a PID, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], an u64, no output.
 
The u64 is converted from a s32 by official sw.
 
== GetSceneIdForPrivateApp ==
This is exclusive to S2.
 
Takes a PID, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], returns an output u64.
 
The u64 is converted to a s32 by official sw.


== GetVibrationDeviceInfo ==
== GetVibrationDeviceInfo ==
Line 603: Line 692:


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


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


== CreateActiveVibrationDeviceList ==
== CreateActiveVibrationDeviceList ==
Line 620: Line 709:


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


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


== SendVibrationGcErmCommand ==
== SendVibrationGcErmCommand ==
Takes a PID, a [[#VibrationDeviceHandle]], [[AM_services|AppletResourceUserId]], an u64 [[#VibrationGcErmCommand]], no output.
Takes a PID, a [[#VibrationDeviceHandle]], [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], an u64 [[#VibrationGcErmCommand]], no output.


== GetActualVibrationGcErmCommand ==
== GetActualVibrationGcErmCommand ==
Takes a PID, a [[#VibrationDeviceHandle]], [[AM_services|AppletResourceUserId]], returns an output u64 [[#VibrationGcErmCommand]].
Takes a PID, a [[#VibrationDeviceHandle]], [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], returns an output u64 [[#VibrationGcErmCommand]].


== BeginPermitVibrationSession ==
== BeginPermitVibrationSession ==
Takes an input [[AM_services|AppletResourceUserId]], no output.
Takes an input [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


Begins a forced-permitted vibration session.
Begins a forced-permitted vibration session.
Line 641: Line 730:


== 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 [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], returns an output u8 bool.


== SendVibrationValueInBool ==
== SendVibrationValueInBool ==
Takes a PID, a bool, a [[#VibrationDeviceHandle]], and an [[AM_services|AppletResourceUserId]], no output.
Takes a PID, a bool, a [[#VibrationDeviceHandle]], and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


Stubbed, this just returns 0.
Stubbed, this just returns 0.


This is currently not exposed by sdknso.
This is currently not exposed by sdknso.
== IsOunceVibrationDeviceMounted ==
This is exclusive to S2.
Takes a PID, a [[#VibrationDeviceHandle]], an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], returns an output bool.


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


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


== StartConsoleSixAxisSensor ==
== StartConsoleSixAxisSensor ==
Takes a PID, a [[#ConsoleSixAxisSensorHandle]], and an [[AM_services|AppletResourceUserId]], no output.
Takes a PID, a [[#ConsoleSixAxisSensorHandle]], and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


== StopConsoleSixAxisSensor ==
== StopConsoleSixAxisSensor ==
Takes a PID, a [[#ConsoleSixAxisSensorHandle]], and an [[AM_services|AppletResourceUserId]], no output.
Takes a PID, a [[#ConsoleSixAxisSensorHandle]], and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


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


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


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


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


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


The size of the first TransferMemory is 0x1000 with MemoryPermission=read-only, while the second one has size 0x7F000 with MemoryPermission=none. sdknso uses an user-specified buffer for this, with the second tmem immediately following the first one. sdknso later uses data at buf+0 for loading SevenSixAxisSensor state.
The size of the first TransferMemory is 0x1000 with MemoryPermission=read-only, while the second one has size 0x7F000 with MemoryPermission=none. sdknso uses an user-specified buffer for this, with the second tmem immediately following the first one. sdknso later uses data at buf+0 for loading SevenSixAxisSensor state.
Line 739: Line 833:


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


== SetSevenSixAxisSensorFusionStrength ==
== SetSevenSixAxisSensorFusionStrength ==
Takes a PID, a float, and an u64 [[AM_services|AppletResourceUserId]], no output.
Takes a PID, a float, and an u64 [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


== GetSevenSixAxisSensorFusionStrength ==
== GetSevenSixAxisSensorFusionStrength ==
Takes a PID and an u64 [[AM_services|AppletResourceUserId]], returns an output float.
Takes a PID and an u64 [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], returns an output float.


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


== IsUsbFullKeyControllerEnabled ==
== IsUsbFullKeyControllerEnabled ==
Line 782: Line 876:


== GetNpadOfHighestBatteryLevel ==
== GetNpadOfHighestBatteryLevel ==
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 [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], returns an output u32 [[#NpadIdType]].


[[#NpadIdType|Handheld]] is ignored.
[[#NpadIdType|Handheld]] is ignored.


== GetPalmaConnectionHandle ==
== GetPalmaConnectionHandle ==
Takes a PID, an u32 [[#NpadIdType]], an [[AM_services|AppletResourceUserId]], returns an output [[#PalmaConnectionHandle]].
Takes a PID, an u32 [[#NpadIdType]], an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], returns an output [[#PalmaConnectionHandle]].


== InitializePalma ==
== InitializePalma ==
Line 911: Line 1,005:


== SetIsPalmaAllConnectable ==
== SetIsPalmaAllConnectable ==
Takes a PID, a bool, an [[AM_services|AppletResourceUserId]], no output.
Takes a PID, a bool, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


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


== SetIsPalmaPairedConnectable ==
== SetIsPalmaPairedConnectable ==
Takes a PID, a bool, an [[AM_services|AppletResourceUserId]], no output.
Takes a PID, a bool, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


The actual cmd impl ignores the PID/AppletResourceUserId.
The actual cmd impl ignores the PID/AppletResourceUserId.
Line 940: Line 1,034:


== EnablePalmaBoostMode ==
== EnablePalmaBoostMode ==
Takes a PID, a bool, an [[AM_services|AppletResourceUserId]], no output.
Takes a PID, a bool, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


== GetPalmaBluetoothAddress ==
== GetPalmaBluetoothAddress ==
Line 946: Line 1,040:


== SetDisallowedPalmaConnection ==
== SetDisallowedPalmaConnection ==
Takes a PID, an [[AM_services|AppletResourceUserId]], a type-0x9 input buffer containing an array of [[Bluetooth_Driver_services#Address|Address]], no output.
Takes a PID, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], a type-0x9 input buffer containing an array of [[Bluetooth_Driver_services#Address|Address]], no output.
 
== GetGlGrButtonConfigState ==
This is exclusive to S2.
 
Takes a PID, an u32, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], returns two output bools.


== SetNpadCommunicationMode ==
== SetNpadCommunicationMode ==
Takes a PID, an [[AM_services|AppletResourceUserId]], a s64 [[#NpadCommunicationMode]], no output.
Takes a PID, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], a s64 [[#NpadCommunicationMode]], no output.


[2.0.0+] Stubbed, just returns 0.
[2.0.0+] Stubbed, just returns 0.
Line 961: Line 1,060:


== SetTouchScreenConfiguration ==
== SetTouchScreenConfiguration ==
Takes a PID, a [[#TouchScreenConfigurationForNx]], an [[AM_services|AppletResourceUserId]], no output.
Takes a PID, a [[#TouchScreenConfigurationForNx]], an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


== IsFirmwareUpdateNeededForNotification ==
== IsFirmwareUpdateNeededForNotification ==
Takes a PID, a s32, an [[AM_services|AppletResourceUserId]], returns an output bool.
Takes a PID, a s32, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], returns an output bool.


sdknso passes hard-coded value 1 for the s32.
sdknso passes hard-coded value 1 for the s32.
== SetTouchScreenOutputRanges ==
Takes a PID, a s32 width, a s32 height, an [[Applet_Manager_services#AppletResourceUserId|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 ==
== ActivateDigitizer ==
Takes a PID and an [[AM_services|AppletResourceUserId]], no output.
Takes a PID and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]]. No output.


== IAppletResource ==
== InitializeJcms ==
This is "nn::hid::IAppletResource".
This is exclusive to S2.


{| class="wikitable" border="1"
Takes a PID, a TransferMemory handle, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], an u64 tmem_size, no output.
|-
! Cmd || Name
|-
| 0 || [[#GetSharedMemoryHandle]]
|}


=== GetSharedMemoryHandle ===
The input TransferMemory is created with permissions = R--. The user-process later reads from the buffer used with this to get the JcmsState for the specified [[#JcmsHandle|JcmsHandle]].
No input. Returns a [[#SharedMemoryFormat|sharedmem]] handle.


== IActiveVibrationDeviceList ==
== FinalizeJcms ==
This is "nn::hid::IActiveVibrationDeviceList".
This is exclusive to S2.
 
Takes a PID and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]]. No output.
 
== StartJcms ==
This is exclusive to S2.
 
Takes a PID, a [[#JcmsHandle|JcmsHandle]], an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.
 
== StopJcms ==
This is exclusive to S2.
 
Takes a PID, a [[#JcmsHandle|JcmsHandle]], an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.
 
== InitializeNmouse ==
This is exclusive to S2.
 
Takes a PID, a TransferMemory handle, an u8, two s32s (width/height), an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], an u64 tmem_size, no output.
 
Official sw converts the input [[#NmouseStateRange|NmouseStateRange]] to the relevant s32s (the s32s are not directly exposed).
 
Official sw passes value 0 for the u8.
 
After official sw finishes using this, it also uses [[#SetMergedNmouseSourceTypes|SetMergedNmouseSourceTypes]] with value 0x6.
 
The input TransferMemory is created with permissions = R--. The user-process later reads from the buffer used with this.
 
== FinalizeNmouse ==
This is exclusive to S2.
 
Takes a PID and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.
 
== SetNmousePointerRanges ==
This is exclusive to S2.
 
Takes a PID, two s32s (width/height), an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.
 
This is also exposed as SetNmouseStateRanges, with the input [[#NmouseStateRange|NmouseStateRange]] being converted to the relevant s32s.
 
== GetNmousePointerRanges ==
This is exclusive to S2.
 
Takes a PID, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], returns two output s32s (width/height).
 
This is also exposed as GetNmouseStateRanges, with the output data being compared to determine the output [[#NmouseStateRange|NmouseStateRange]].
 
== EnableShowingCursor ==
This is exclusive to S2.
 
Takes a PID, a bool, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.
 
== SetNmouseButtonConfigJoyLeftJcms ==
This is exclusive to S2.
 
Takes a PID, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], a [[#NmouseButtonConfigJoyLeftJcms|NmouseButtonConfigJoyLeftJcms]], no output.
 
== SetNmouseButtonConfigJoyRightJcms ==
This is exclusive to S2.
 
Takes a PID, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], a [[#NmouseButtonConfigJoyRightJcms|NmouseButtonConfigJoyRightJcms]], no output.
 
== SetMergedNmouseSourceTypes ==
This is exclusive to S2.
 
Takes a PID, an u32, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.
 
Official sw masks the u32 with bitmask 0x6.
 
The input u32 is a 32bit BitFlagSet of [[#NmouseType|NmouseType]].
 
== InitializeNmouse2 ==
Unofficial name.
 
This is exclusive to S2.
 
Takes a PID, a TransferMemory handle, a [[#NmousePointerType|NmousePointerType]], a s32 width, a s32 height, an u32, an [[Applet_Manager_services#AppletResourceUserId|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 (same as with [[#InitializeNmouse|InitializeNmouse]]).
 
Official sw passes value 1 for the last u32.
 
This and the related nearby cmds are for Joy-Con 2 Mouse Mode.
 
== SetNmousePointerPosition ==
This is exclusive to S2.
 
Takes a PID, two s32s, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], a [[#NmouseHandle|NmouseHandle]], no output.
 
== EnableNmousePointer ==
This is exclusive to S2.
 
Takes a PID, a bool, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], a [[#NmouseHandle|NmouseHandle]], no output.
 
== RestrictNmousePointer ==
This is exclusive to S2.
 
Takes a PID, 4 floats, an [[Applet_Manager_services#AppletResourceUserId|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"
|-
! Cmd || Name
|-
| 0 || [[#GetSharedMemoryHandle]]
|}
 
=== GetSharedMemoryHandle ===
No input. Returns a [[#SharedMemoryFormat|sharedmem]] handle.
 
== IActiveVibrationDeviceList ==
This is "nn::hid::IActiveVibrationDeviceList".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 1,025: Line 1,242:
|-
|-
| 17 || [13.0.0+] IsTouchScreenManaged
| 17 || [13.0.0+] IsTouchScreenManaged
|-
| 18 || [18.0.0+] SetTouchScreenAutoPilotStateWithAruid
|-
|-
| 20 || [[#DeactivateMouse]]
| 20 || [[#DeactivateMouse]]
Line 1,031: Line 1,250:
|-
|-
| 22 || [[#UnsetMouseAutoPilotState]]
| 22 || [[#UnsetMouseAutoPilotState]]
|-
| 23 || [21.0.0+] AddMouseSideWheelDelta
|-
|-
| 25 || [16.0.0+] SetDebugMouseAutoPilotState
| 25 || [16.0.0+] SetDebugMouseAutoPilotState
Line 1,114: Line 1,335:
| 152 || [10.0.0+] GetWhoAmI
| 152 || [10.0.0+] GetWhoAmI
|-
|-
| 201 || ActivateFirmwareUpdate
| 160 || [S2]
|-
| 161 || [S2]
|-
| 162 || [S2]
|-
| 170 || [S2]
|-
| 171 || [S2]
|-
| 172 || [S2]
|-
| 201 || ActivateFirmwareUpdate
|-
|-
| 202 || DeactivateFirmwareUpdate
| 202 || DeactivateFirmwareUpdate
Line 1,135: Line 1,368:
|-
|-
| 211 || [6.0.0+] StartFirmwareUpdateIndividual
| 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
| 215 || [6.0.0+] SetUsbFirmwareForceUpdateEnabled
|-
|-
| 216 || [6.0.0+] SetAllKuinaDevicesToFirmwareUpdateMode
| 216 || [6.0.0+] SetAllKuinaDevicesToFirmwareUpdateMode
|-
| 217 || [17.0.0+] StartFirmwareUpdateFromImageSet
|-
|-
| 221 || [3.0.0+] [[#UpdateControllerColor]]
| 221 || [3.0.0+] [[#UpdateControllerColor]]
Line 1,201: Line 1,442:
|-
|-
| 251 || [12.0.0+] GetAnalogStickModuleParam
| 251 || [12.0.0+] GetAnalogStickModuleParam
|-
| 252 || [S2]
|-
| 253 || [19.0.0+] ClearStorageForShipment
|-
| 254 || [S2]
|-
| 255 || [S2]
|-
| 256 || [S2]
|-
| 261 || [21.0.0+] UpdateDesignInfo12
|-
| 266 || [21.0.0+] GetUniquePadButtonCount
|-
| 267 || [21.0.0+] SetAnalogStickCalibration
|-
| 268 || [21.0.0+] ResetAnalogStickCalibration
|-
|-
| 301 || [5.0.0-8.1.0] [[#GetAbstractedPadHandles]]
| 301 || [5.0.0-8.1.0] [[#GetAbstractedPadHandles]]
Line 1,233: Line 1,492:
|-
|-
| 350 || [5.0.0+] [[#AddRegisteredDevice]]
| 350 || [5.0.0+] [[#AddRegisteredDevice]]
|-
| 351 || [17.0.0-18.1.0] GetRegisteredDevicesCountDebug
|-
| 352 || [17.0.0-18.1.0] DeleteRegisteredDevicesDebug
|-
|-
| 400 || [6.0.0+] DisableExternalMcuOnNxDevice
| 400 || [6.0.0+] DisableExternalMcuOnNxDevice
Line 1,255: Line 1,518:
|-
|-
| 600 || [10.0.0+] ConvertPadState
| 600 || [10.0.0+] ConvertPadState
|-
| 601 || [18.0.0+] [[#IsButtonConfigSupported]]
|-
| 602 || [18.0.0+] [[#IsButtonConfigEmbeddedSupported]]
|-
| 603 || [18.0.0+] [[#DeleteButtonConfig]]
|-
| 604 || [18.0.0+] [[#DeleteButtonConfigEmbedded]]
|-
| 605 || [18.0.0+] [[#SetButtonConfigEnabled]]
|-
| 606 || [18.0.0+] [[#SetButtonConfigEmbeddedEnabled]]
|-
| 607 || [18.0.0+] [[#IsButtonConfigEnabled]]
|-
| 608 || [18.0.0+] [[#IsButtonConfigEmbeddedEnabled]]
|-
| 609 || [18.0.0+] [[#SetButtonConfigEmbedded]]
|-
| 610 || [18.0.0+] [[#SetButtonConfigFull]]
|-
| 611 || [18.0.0+] [[#SetButtonConfigLeft]]
|-
| 612 || [18.0.0+] [[#SetButtonConfigRight]]
|-
| 613 || [18.0.0+] [[#GetButtonConfigEmbedded]]
|-
| 614 || [18.0.0+] [[#GetButtonConfigFull]]
|-
| 615 || [18.0.0+] [[#GetButtonConfigLeft]]
|-
| 616 || [18.0.0+] [[#GetButtonConfigRight]]
|-
| 617 || [S2]
|-
| 618 || [S2]
|-
| 619 || [S2]
|-
| 620 || [S2]
|-
| 621 || [S2]
|-
| 622 || [S2]
|-
|-
| 650 || [12.0.0+] AddButtonPlayData
| 650 || [12.0.0+] AddButtonPlayData
Line 1,262: Line 1,569:
| 652 || [12.0.0+] StopButtonPlayData
| 652 || [12.0.0+] StopButtonPlayData
|-
|-
| 2000 || [10.0.0+] DeactivateDigitizer
| 700 || [21.0.0+] GetRailAttachEventCount
|-
| 2000 || [10.0.0+] [[#DeactivateDigitizer]]
|-
|-
| 2001 || [10.0.0+] SetDigitizerAutoPilotState
| 2001 || [10.0.0+] [[#SetDigitizerAutoPilotState]]
|-
|-
| 2002 || [10.0.0+] UnsetDigitizerAutoPilotState
| 2002 || [10.0.0+] [[#UnsetDigitizerAutoPilotState]]
|-
|-
| 3000 || [16.0.0+] ReloadFirmwareDebugSettings
| 3000 || [16.0.0+] ReloadFirmwareDebugSettings
Line 1,313: Line 1,622:


== DeactivateNpad ==
== DeactivateNpad ==
Takes a PID and an [[AM_services|AppletResourceUserId]], no output.
Takes a PID and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


This just returns 0.
This just returns 0.
Line 1,360: Line 1,669:


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


== GetSixAxisSensorDriverStates ==
== GetSixAxisSensorDriverStates ==
Line 1,486: Line 1,797:


[11.0.0+] Takes an input [[#DebugRegisteredDevice]], no output.
[11.0.0+] Takes an input [[#DebugRegisteredDevice]], no output.
== DeactivateDigitizer ==
No input/output.
== SetDigitizerAutoPilotState ==
Takes an input [[#DigitizerAutoPilotState]]. No output.
== UnsetDigitizerAutoPilotState ==
No input/output.


= hid:sys =
= hid:sys =
Line 1,513: Line 1,833:
|-
|-
| 161 || [7.0.0+] GetPlatformConfig
| 161 || [7.0.0+] GetPlatformConfig
|-
| 171 || [S2]
|-
| 181 || [S2]
|-
|-
| 210 || AcquireNfcDeviceUpdateEventHandle
| 210 || AcquireNfcDeviceUpdateEventHandle
Line 1,522: Line 1,846:
| 213 || ActivateNfc
| 213 || ActivateNfc
|-
|-
| 214 || [4.0.0+] GetXcdHandleForNpadWithNfc
| 214 || [4.0.0-18.1.0] GetXcdHandleForNpadWithNfc
|-
|-
| 215 || [4.0.0+] IsNfcActivated
| 215 || [4.0.0+] IsNfcActivated
|-
|-
| 230 || AcquireIrSensorEventHandle
| 216 || [19.0.0+] GetAbstractedPadIdForNpadWithNfc
|-
|-
| 231 || ActivateIrSensor
| 217 || [19.0.0+] [[#SetNfcEvent]]
|-
|-
| 232 || [10.0.0+] GetIrSensorState
| 218 || [19.0.0+] [[#GetNfcInfo]]
|-
|-
| 233 || [10.0.0+] GetXcdHandleForNpadWithIrSensor
| 219 || [19.0.0+] StartNfcDiscovery
|-
|-
| 301 || ActivateNpadSystem
| 220 || [19.0.0+] StopNfcDiscovery
|-
|-
| 303 || ApplyNpadSystemCommonPolicy
| 221 || [19.0.0+] StartNtagRead
|-
|-
| 304 || EnableAssigningSingleOnSlSrPress
| 222 || [19.0.0+] StartNtagWrite
|-
|-
| 305 || DisableAssigningSingleOnSlSrPress
| 223 || [19.0.0+] SendNfcRawData
|-
|-
| 306 || GetLastActiveNpad
| 224 || [19.0.0+] RegisterMifareKey
|-
| 225 || [19.0.0+] ClearMifareKey
|-
| 226 || [19.0.0+] StartMifareRead
|-
| 227 || [19.0.0+] StartMifareWrite
|-
| 230 || AcquireIrSensorEventHandle
|-
| 231 || ActivateIrSensor
|-
| 232 || [10.0.0+] GetIrSensorState
|-
| 233 || [10.0.0+] GetXcdHandleForNpadWithIrSensor
|-
| 234 || [19.0.0+] GetNpadJoyHoldType
|-
| 241 || [19.0.0+] [[#GetDataFormat]]
|-
| 242 || [19.0.0+] [[#SetDataFormat]]
|-
| 243 || [19.0.0+] [[#GetMcuState]]
|-
| 244 || [19.0.0+] [[#SetMcuState]]
|-
| 245 || [19.0.0+] [[#GetMcuVersionForNfc]]
|-
| 246 || [19.0.0+] [[#CheckNfcDevicePower]]
|-
| 247 || [19.0.0+] [[#SetMcuStateImmediate]]
|-
| 251 || [S2]
|-
| 252 || [S2]
|-
| 253 || [S2]
|-
| 301 || ActivateNpadSystem
|-
| 303 || ApplyNpadSystemCommonPolicy
|-
| 304 || EnableAssigningSingleOnSlSrPress
|-
| 305 || DisableAssigningSingleOnSlSrPress
|-
| 306 || GetLastActiveNpad
|-
|-
| 307 || GetNpadSystemExtStyle
| 307 || GetNpadSystemExtStyle
Line 1,590: Line 1,960:
| 330 || [14.0.0+] CheckAbstractedPadConnection
| 330 || [14.0.0+] CheckAbstractedPadConnection
|-
|-
| 500 || SetAppletResourceUserId
| 332 || [19.0.0+] ConvertAppletDetailedUiTypeFromPlayReportType
|-
| 333 || [20.0.0+] SetNpadUserSpgApplet
|-
| 334 || [20.0.0+] AcquireUniquePadButtonStateChangedEventHandle
|-
| 500 || [[#SetAppletResourceUserId]]
|-
|-
| 501 || RegisterAppletResourceUserId
| 501 || [[#RegisterAppletResourceUserId]]
|-
|-
| 502 || UnregisterAppletResourceUserId
| 502 || [[#UnregisterAppletResourceUserId]]
|-
|-
| 503 || EnableAppletToGetInput
| 503 || [[#EnableAppletToGetInput]]
|-
|-
| 504 || SetAruidValidForVibration
| 504 || [[#SetAruidValidForVibration]]
|-
|-
| 505 || EnableAppletToGetSixAxisSensor
| 505 || [[#EnableAppletToGetSixAxisSensor]]
|-
|-
| 506 || [14.0.0+] EnableAppletToGetPadInput
| 506 || [14.0.0+] [[#EnableAppletToGetPadInput]]
|-
|-
| 507 || [14.0.0+] EnableAppletToGetTouchScreen
| 507 || [14.0.0+] [[#EnableAppletToGetTouchScreen]]
|-
|-
| 510 || [[#SetVibrationMasterVolume]]
| 510 || [[#SetVibrationMasterVolume]]
Line 1,627: Line 2,003:
|-
|-
| 525 || [11.0.0+] IsJoyConAttachedOnAllRail
| 525 || [11.0.0+] IsJoyConAttachedOnAllRail
|-
| 526 || [19.0.0+] IsInvertedControllerConnectedOnRail
|-
|-
| 540 || AcquirePlayReportControllerUsageUpdateEvent
| 540 || AcquirePlayReportControllerUsageUpdateEvent
Line 1,634: Line 2,012:
| 542 || AcquirePlayReportRegisteredDeviceUpdateEvent
| 542 || AcquirePlayReportRegisteredDeviceUpdateEvent
|-
|-
| 543 || GetRegisteredDevicesOld ([1.0.0-4.1.0] GetRegisteredDevices)
| 543 || [5.0.0-18.1.0] GetRegisteredDevicesOld ([1.0.0-4.1.0] GetRegisteredDevices)
|-
|-
| 544 || [3.0.0+] AcquireConnectionTriggerTimeoutEvent
| 544 || [3.0.0+] AcquireConnectionTriggerTimeoutEvent
Line 1,647: Line 2,025:
|-
|-
| 549 || [6.0.0+] GetConnectableRegisteredDevices
| 549 || [6.0.0+] GetConnectableRegisteredDevices
|-
| 550 || [S2]
|-
| 551 || [20.0.0+] GetRegisteredDevicesForControllerSupport
|-
|-
| 700 || ActivateUniquePad
| 700 || ActivateUniquePad
Line 1,654: Line 2,036:
| 703 || [[#GetUniquePadIds]]
| 703 || [[#GetUniquePadIds]]
|-
|-
| 751 || AcquireJoyDetachOnBluetoothOffEventHandle
| 704 || [S2]
|-
|-
| 800 || ListSixAxisSensorHandles
| 705 || [S2]
|-
|-
| 801 || IsSixAxisSensorUserCalibrationSupported
| 707 || [S2]
|-
|-
| 802 || ResetSixAxisSensorCalibrationValues
| 711 || [20.0.0+] AcquireUniquePadConnectionOnHandheldForNsEventHandle
|-
|-
| 803 || StartSixAxisSensorUserCalibration
| 712 || [20.0.0+] GetUniquePadColor12
|-
|-
| 804 || CancelSixAxisSensorUserCalibration
| 721 || [S2]
|-
|-
| 805 || [3.0.0+] GetUniquePadBluetoothAddress
| 722 || [S2]
|-
|-
| 806 || [3.0.0+] DisconnectUniquePad
| 723 || [S2]
|-
|-
| 807 || [5.0.0+] [[#GetUniquePadType]]
| 724 || [S2]
|-
|-
| 808 || [5.0.0+] GetUniquePadInterface
| 725 || [S2]
|-
|-
| 809 || [5.0.0+] [[#GetUniquePadSerialNumber]]
| 726 || [S2]
|-
|-
| 810 || [5.0.0+] GetUniquePadControllerNumber
| 727 || [S2]
|-
|-
| 811 || [5.0.0+] GetSixAxisSensorUserCalibrationStage
| 728 || [S2]
|-
|-
| 812 || [8.0.0+] GetConsoleUniqueSixAxisSensorHandle
| 729 || [S2]
|-
|-
| 821 || StartAnalogStickManualCalibration
| 730 || [S2]
|-
|-
| 822 || RetryCurrentAnalogStickManualCalibrationStage
| 731 || [S2]
|-
|-
| 823 || CancelAnalogStickManualCalibration
| 732 || [S2]
|-
|-
| 824 || ResetAnalogStickManualCalibration
| 733 || [S2]
|-
|-
| 825 || [5.0.0+] GetAnalogStickState
| 734 || [S2]
|-
|-
| 826 || [5.0.0+] GetAnalogStickManualCalibrationStage
| 735 || [S2]
|-
| 736 || [S2]
|-
| 737 || [S2]
|-
| 738 || [S2]
|-
| 739 || [S2]
|-
| 740 || [S2]
|-
| 741 || [S2]
|-
| 742 || [S2]
|-
| 743 || [S2]
|-
| 744 || [S2]
|-
| 745 || [S2]
|-
| 746 || [S2]
|-
| 751 || AcquireJoyDetachOnBluetoothOffEventHandle
|-
| 800 || ListSixAxisSensorHandles
|-
| 801 || IsSixAxisSensorUserCalibrationSupported
|-
| 802 || ResetSixAxisSensorCalibrationValues
|-
| 803 || StartSixAxisSensorUserCalibration
|-
| 804 || CancelSixAxisSensorUserCalibration
|-
| 805 || [3.0.0+] GetUniquePadBluetoothAddress
|-
| 806 || [3.0.0+] DisconnectUniquePad
|-
| 807 || [5.0.0+] [[#GetUniquePadType]]
|-
| 808 || [5.0.0+] GetUniquePadInterface
|-
| 809 || [5.0.0+] [[#GetUniquePadSerialNumber]]
|-
| 810 || [5.0.0+] GetUniquePadControllerNumber
|-
| 811 || [5.0.0+] GetSixAxisSensorUserCalibrationStage
|-
| 812 || [8.0.0+] GetConsoleUniqueSixAxisSensorHandle
|-
| 813 || [18.0.0+] GetDeviceType
|-
| 821 || StartAnalogStickManualCalibration
|-
| 822 || RetryCurrentAnalogStickManualCalibrationStage
|-
| 823 || CancelAnalogStickManualCalibration
|-
| 824 || ResetAnalogStickManualCalibration
|-
| 825 || [5.0.0+] GetAnalogStickState
|-
| 826 || [5.0.0+] GetAnalogStickManualCalibrationStage
|-
|-
| 827 || [5.0.0+] IsAnalogStickButtonPressed
| 827 || [5.0.0+] IsAnalogStickButtonPressed
Line 1,741: Line 2,187:
|-
|-
| 1011 || [4.0.0+] DeactivateAudioControl
| 1011 || [4.0.0+] DeactivateAudioControl
|-
| 1012 || [20.0.0+] GetFirmwareVersionStringForUserSupportPage
|-
|-
| 1050 || [5.0.0+] IsSixAxisSensorAccurateUserCalibrationSupported
| 1050 || [5.0.0+] IsSixAxisSensorAccurateUserCalibrationSupported
Line 1,782: Line 2,230:
| 1157 || [10.0.0+] [[#CancelConnectionTrigger]]
| 1157 || [10.0.0+] [[#CancelConnectionTrigger]]
|-
|-
| 1200 || [10.0.0+] [[#IsButtonConfigSupported]]
| 1158 || [20.1.0+] SetConnectionLimitForSplay
|-
| 1159 || [20.1.0+] ClearConnectionLimitForSplay
|-
|-
| 1201 || [11.0.0+] [[#IsButtonConfigEmbeddedSupported]] ([10.0.0-10.2.0] [[#DeleteButtonConfig]])
| 1200 || [10.0.0-17.0.1] [[#IsButtonConfigSupported]]
|-
|-
| 1202 || [11.0.0+] [[#DeleteButtonConfig]] ([10.0.0-10.2.0] [[#SetButtonConfigEnabled]])
| 1201 || [11.0.0-17.0.1] [[#IsButtonConfigEmbeddedSupported]] ([10.0.0-10.2.0] [[#DeleteButtonConfig]])
|-
|-
| 1203 || [11.0.0+] [[#DeleteButtonConfigEmbedded]] ([10.0.0-10.2.0] [[#IsButtonConfigEnabled]])
| 1202 || [11.0.0-17.0.1] [[#DeleteButtonConfig]] ([10.0.0-10.2.0] [[#SetButtonConfigEnabled]])
|-
|-
| 1204 || [11.0.0+] [[#SetButtonConfigEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigEmbedded]])
| 1203 || [11.0.0-17.0.1] [[#DeleteButtonConfigEmbedded]] ([10.0.0-10.2.0] [[#IsButtonConfigEnabled]])
|-
|-
| 1205 || [11.0.0+] [[#SetButtonConfigEmbeddedEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigFull]])
| 1204 || [11.0.0-17.0.1] [[#SetButtonConfigEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigEmbedded]])
|-
|-
| 1206 || [11.0.0+] [[#IsButtonConfigEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigLeft]])
| 1205 || [11.0.0-17.0.1] [[#SetButtonConfigEmbeddedEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigFull]])
|-
|-
| 1207 || [11.0.0+] [[#IsButtonConfigEmbeddedEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigRight]])
| 1206 || [11.0.0-17.0.1] [[#IsButtonConfigEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigLeft]])
|-
|-
| 1208 || [11.0.0+] [[#SetButtonConfigEmbedded]] ([10.0.0-10.2.0] [[#GetButtonConfigEmbedded]])
| 1207 || [11.0.0-17.0.1] [[#IsButtonConfigEmbeddedEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigRight]])
|-
|-
| 1209 || [11.0.0+] [[#SetButtonConfigFull]] ([10.0.0-10.2.0] [[#GetButtonConfigFull]])
| 1208 || [11.0.0-17.0.1] [[#SetButtonConfigEmbedded]] ([10.0.0-10.2.0] [[#GetButtonConfigEmbedded]])
|-
| 1209 || [11.0.0-17.0.1] [[#SetButtonConfigFull]] ([10.0.0-10.2.0] [[#GetButtonConfigFull]])
|-
|-
| 1210 || [10.0.0-10.2.0] [[#GetButtonConfigLeft]]
| 1210 || [10.0.0-10.2.0] [[#GetButtonConfigLeft]]
|-
|-
| 1211 || [11.0.0+] [[#SetButtonConfigRight]] ([10.0.0-10.2.0] [[#GetButtonConfigRight]])
| 1211 || [11.0.0-17.0.1] [[#SetButtonConfigRight]] ([10.0.0-10.2.0] [[#GetButtonConfigRight]])
|-
|-
| 1212 || [11.0.0+] [[#GetButtonConfigEmbedded]]
| 1212 || [11.0.0-17.0.1] [[#GetButtonConfigEmbedded]]
|-
|-
| 1213 || [11.0.0+] [[#GetButtonConfigFull]]
| 1213 || [11.0.0-17.0.1] [[#GetButtonConfigFull]]
|-
|-
| 1214 || [11.0.0+] [[#GetButtonConfigLeft]]
| 1214 || [11.0.0-17.0.1] [[#GetButtonConfigLeft]]
|-
|-
| 1215 || [11.0.0+] [[#GetButtonConfigRight]]
| 1215 || [11.0.0-17.0.1] [[#GetButtonConfigRight]]
|-
|-
| 1250 || [10.0.0+] [[#IsCustomButtonConfigSupported]]
| 1250 || [10.0.0+] [[#IsCustomButtonConfigSupported]]
Line 1,898: Line 2,350:
| 1291 || [11.0.0+] [[#SetButtonConfigStorageRight]]
| 1291 || [11.0.0+] [[#SetButtonConfigStorageRight]]
|-
|-
| 12010 || [11.0.0+] [[#SetButtonConfigLeft]]
| 1292 || [S2]
|}
|-
 
| 1293 || [S2]
== SendKeyboardLockKeyEvent ==
|-
Takes an u32 BitFlagSet [[#KeyboardLockKeyEvent]], no output.
| 1294 || [S2]
 
|-
== AcquireHomeButtonEventHandle ==
| 1295 || [S2]
Takes a PID, an [[AM_services|AppletResourceUserId]], returns an output Event handle.
|-
 
| 1296 || [S2]
The EventClearMode used by sdknso is user-specified. The Event is signaled when [[#HomeButtonState]] is updated.
|-
 
| 1297 || [S2]
This is used by [[AM_services|AM]].
|-
 
| 1298 || [S2]
== ActivateHomeButton ==
|-
Takes a PID, an [[AM_services|AppletResourceUserId]], no output.
| 1299 || [S2]
 
|-
Activates the [[#HomeButtonSharedMemoryFormat|HomeButton]] sharedmem.
| 1300 || [S2]
 
|-
== AcquireSleepButtonEventHandle ==
| 1301 || [S2]
Takes a PID, an [[AM_services|AppletResourceUserId]], returns an output Event handle.
|-
 
| 1302 || [S2]
The EventClearMode used by sdknso is user-specified. The Event is signaled when [[#SleepButtonState]] is updated.
|-
 
| 1303 || [S2]
This is used by [[AM_services|AM]].
|-
 
| 1304 || [S2]
== ActivateSleepButton ==
|-
Takes a PID, an [[AM_services|AppletResourceUserId]], no output.
| 1305 || [S2]
 
|-
Activates the [[#SleepButtonSharedMemoryFormat|SleepButton]] sharedmem.
| 1306 || [S2]
 
|-
== AcquireCaptureButtonEventHandle ==
| 1307 || [S2]
Takes a PID, an [[AM_services|AppletResourceUserId]], returns an output Event handle.
|-
 
| 1308 || [18.0.0+] SetButtonConfigVisible
The EventClearMode used by sdknso is user-specified. The Event is signaled when [[#CaptureButtonState]] is updated.
|-
 
| 1309 || [18.0.0+] IsButtonConfigVisible
This is used by [[AM_services|AM]].
|-
 
| 1310 || [S2]
== ActivateCaptureButton ==
|-
Takes a PID, an [[AM_services|AppletResourceUserId]], no output.
| 1320 || [17.0.0+] WakeTouchScreenUp
 
|-
Activates the [[#CaptureButtonSharedMemoryFormat|CaptureButton]] sharedmem.
| 1321 || [17.0.0+] PutTouchScreenToSleep
 
|-
== GetMaskedSupportedNpadStyleSet ==
| 1322 || [20.0.0+] AcquireTouchScreenAsyncWakeCompletedEvent
Takes an input u64 AppletResourceUserId, returns an output u32 [[#NpadStyleTag]].
|-
 
| 1323 || [21.0.0+] StartTouchScreenAutoTuneForSystemSettings
Official sw uses the output from [[Applet_Manager_services|GetAppletResourceUserIdOfCallerApplet]] with this.
|-
 
| 1324 || [21.0.0+] AcquireTouchScreenAutoTuneCompletedEvent
== GetUniquePadsFromNpad ==
|-
Takes an input u32 [[#NpadIdType]], a type-0xA output buffer, and returns an output s64 for total output entries (which is copied to a s32 by official sw).
| 1325 || [21.0.0+] IsTouchScreenAutoTuneRequiredForRepairProviderReplacement
 
|-
The output buffer contains an array of [[#UniquePadId]].
| 1326 || [21.0.0+] SetTouchScreenOffset
 
|-
== SetVibrationMasterVolume ==
| 1327 || [22.0.0+] SetTouchStateSuppressed
Takes an input 32bit float.
|-
 
| 1350 || [S2]
== GetUniquePadIds ==
|-
Takes a type-0xA output buffer, and returns an output s64 for total output entries (which is copied to a s32 by official sw).
| 1351 || [S2]
 
|-
The output buffer contains an array of [[#UniquePadId]].
| 1352 || [S2]
 
|-
== GetUniquePadType ==
| 1360 || [S2]
Takes an input [[#UniquePadId]] and returns an output u64 [[#UniquePadType]].
|-
 
| 1361 || [S2]
== GetUniquePadSerialNumber ==
|-
Takes an input [[#UniquePadId]] and returns an output [[#UniquePadSerialNumber]].
| 1362 || [S2]
 
|-
== SetNotificationLedPattern ==
| 1380 || [S2]
Takes an input [[#NotificationLedPattern]] and an [[#UniquePadId]], no output.
|-
 
| 1381 || [S2]
The specified controller must have a HOME button.
|-
 
| 1382 || [S2]
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.
 
The layout of cmd_argdata is as follows:
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 1383 || [S2]
|-
|-
| 0x0 || 0x1 || <nowiki>((TimeUnit & 0xF) | ((FrameCount & 0xF) << 4))</nowiki>
| 1384 || [S2]
|-
|-
| 0x1 || 0x1 || <nowiki>((CycleCount & 0xF) | ((InitialBrightness & 0xF) << 4))</nowiki>
| 1385 || [S2]
|-
|-
| 0x2 || 0x1 || <nowiki>((Frame2Brightness & 0xF) | ((Frame1Brightness & 0xF) << 4))</nowiki>
| 1386 || [S2]
|-
|-
| 0x3 || 0x1 || <nowiki>((Frame1TimeToHold & 0xF) | ((Frame1TimeTowards & 0xF) << 4))</nowiki>
| 1387 || [S2]
|-
|-
| 0x4 || 0x1 || <nowiki>((Frame2TimeToHold & 0xF) | ((Frame2TimeTowards & 0xF) << 4))</nowiki>
| 1388 || [S2]
|-
|-
| 0x5 || 0x1 || <nowiki>((Frame4Brightness & 0xF) | ((Frame3Brightness & 0xF) << 4))</nowiki>
| 1400 || [S2]
|-
|-
| 0x6 || 0x1 || <nowiki>((Frame3TimeToHold & 0xF) | ((Frame3TimeTowards & 0xF) << 4))</nowiki>
| 1401 || [S2]
|-
|-
| 0x7 || 0x1 || <nowiki>((Frame4TimeToHold & 0xF) | ((Frame4TimeTowards & 0xF) << 4))</nowiki>
| 1420 || [19.0.0+] GetAppletResourceProperty
|-
|-
| 0x8 || 0x1 || <nowiki>((Frame6Brightness & 0xF) | ((Frame5Brightness & 0xF) << 4))</nowiki>
| 1445 || [S2]
|-
|-
| 0x9 || 0x1 || <nowiki>((Frame5TimeToHold & 0xF) | ((Frame5TimeTowards & 0xF) << 4))</nowiki>
| 1446 || [S2]
|-
|-
| 0xA || 0x1 || <nowiki>((Frame6TimeToHold & 0xF) | ((Frame6TimeTowards & 0xF) << 4))</nowiki>
| 1447 || [S2]
|-
|-
| 0xB || 0x1 || <nowiki>((Frame8Brightness & 0xF) | ((Frame7Brightness & 0xF) << 4))</nowiki>
| 1448 || [S2]
|-
|-
| 0xC || 0x1 || <nowiki>((Frame7TimeToHold & 0xF) | ((Frame7TimeTowards & 0xF) << 4))</nowiki>
| 1449 || [S2]
|-
|-
| 0xD || 0x1 || <nowiki>((Frame8TimeToHold & 0xF) | ((Frame8TimeTowards & 0xF) << 4))</nowiki>
| 1455 || [S2]
|-
|-
| 0xE || 0x1 || <nowiki>((Frame10Brightness & 0xF) | ((Frame9Brightness & 0xF) << 4))</nowiki>
| 1456 || [S2]
|-
|-
| 0xF || 0x1 || <nowiki>((Frame9TimeToHold & 0xF) | ((Frame9TimeTowards & 0xF) << 4))</nowiki>
| 1457 || [S2]
|-
|-
| 0x10 || 0x1 || <nowiki>((Frame10TimeToHold & 0xF) | ((Frame10TimeTowards & 0xF) << 4))</nowiki>
| 1458 || [S2]
|-
|-
| 0x11 || 0x1 || <nowiki>((Frame12Brightness & 0xF) | ((Frame11Brightness & 0xF) << 4))</nowiki>
| 1459 || [S2]
|-
|-
| 0x12 || 0x1 || <nowiki>((Frame11TimeToHold & 0xF) | ((Frame11TimeTowards & 0xF) << 4))</nowiki>
| 1460 || [S2]
|-
|-
| 0x13 || 0x1 || <nowiki>((Frame12TimeToHold & 0xF) | ((Frame12TimeTowards & 0xF) << 4))</nowiki>
| 1461 || [S2]
|-
|-
| 0x14 || 0x1 || <nowiki>((Frame14Brightness & 0xF) | ((Frame13Brightness & 0xF) << 4))</nowiki>
| 1470 || [S2]
|-
|-
| 0x15 || 0x1 || <nowiki>((Frame13TimeToHold & 0xF) | ((Frame13TimeTowards & 0xF) << 4))</nowiki>
| 1471 || [S2]
|-
|-
| 0x16 || 0x1 || <nowiki>((Frame14TimeToHold & 0xF) | ((Frame14TimeTowards & 0xF) << 4))</nowiki>
| 1472 || [S2]
|-
|-
| 0x17 || 0x1 || <nowiki>((Reserved & 0xF) | ((Frame15Brightness & 0xF) << 4))</nowiki>
| 1473 || [S2]
|-
|-
| 0x18 || 0x1 || <nowiki>((Frame15TimeToHold & 0xF) | ((Frame15TimeTowards & 0xF) << 4))</nowiki>
| 1474 || [S2]
|-
|-
| 0x19 || 0x1 || <nowiki>((Reserved & 0xF) | ((Reserved & 0xF) << 4))</nowiki>
| 1480 || [S2]
|-
|-
| 0x1A || 0x1 || <nowiki>((TimeTowardsFinalBrightness & 0xF) | ((FinalBrightness & 0xF) << 4))</nowiki>
| 1490 || [22.0.0+] GetInteractiveArea
|-
|-
| 0x1B || 0x1 || <nowiki>(Timeout & 0xFF)</nowiki>
| 1491 || [22.0.0+] AcquireInteractiveAreaChangedEventHandle
|-
|-
| 0x1C || 0x1 || <nowiki>((Timeout >> 8) & 0xFF)</nowiki>
| 12010 || [11.0.0-17.0.1] [[#SetButtonConfigLeft]]
|}
|}


[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}).
== SendKeyboardLockKeyEvent ==
Takes an u32 BitFlagSet [[#KeyboardLockKeyEvent]], no output.
 
== AcquireHomeButtonEventHandle ==
Takes a PID, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], returns an output Event handle.
 
The EventClearMode used by sdknso is user-specified. The Event is signaled when [[#HomeButtonState]] is updated.
 
This is used by [[AM_services|AM]].
 
== ActivateHomeButton ==
Takes a PID, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.
 
Activates the [[#HomeButtonSharedMemoryFormat|HomeButton]] sharedmem.
 
== AcquireSleepButtonEventHandle ==
Takes a PID, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], returns an output Event handle.
 
The EventClearMode used by sdknso is user-specified. The Event is signaled when [[#SleepButtonState]] is updated.


== SetNotificationLedPatternWithTimeout ==
This is used by [[AM_services|AM]].
Takes an input [[#NotificationLedPattern]], an [[#UniquePadId]], and an s64 TimeSpan, no output.


== PrepareHidsForNotificationWake ==
== ActivateSleepButton ==
Takes a type-0x9 input buffer containing an array of [[#UniquePadId]], no output.
Takes a PID, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


== IsUsbConnected ==
Activates the [[#SleepButtonSharedMemoryFormat|SleepButton]] sharedmem.
Tales an input [[#UniquePadId]], returns an output bool.


== NotifyInputDetector ==
== AcquireCaptureButtonEventHandle ==
Takes an input u32 bitmask InputSourceId, no output.
Takes a PID, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], returns an output Event handle.


This is the only hid:sys command used by USB-sysmodule (with value 0x40).
The EventClearMode used by sdknso is user-specified. The Event is signaled when [[#CaptureButtonState]] is updated.


== GetHidbusSystemServiceObject ==
This is used by [[AM_services|AM]].
No input, returns an [[#IHidbusSystemServer]].


== GetTouchScreenFirmwareVersion ==
== ActivateCaptureButton ==
No input. Returns a [[#FirmwareVersion]].
Takes a PID, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


This requests the current firmware version from the touch screen IC.
Activates the [[#CaptureButtonSharedMemoryFormat|CaptureButton]] sharedmem.


It first ensures the touch screen IC's chip id is one of the following:
== GetMaskedSupportedNpadStyleSet ==
0x7036 - Ftm4cd60d (STMicroelectronics FingerTipS FT9CJ/FT9CF)
Takes an input u64 AppletResourceUserId, returns an output u32 [[#NpadStyleTag]].
0x4036 - Fst2ba61y


Then constructs the final firmware version as follows:
Official sw uses the output from [[Applet_Manager_services|GetAppletResourceUserIdOfCallerApplet]] with this.
uint32_t FtsVersion = GetFtsReleasedVer();    // Matches the xxxx value found in the FTS_xxxx.fts256 and FTS_xxxx.ftb firmware files.
uint8_t FtsVersionByte0 = (FtsVersion & 0xFF);
uint8_t FtsVersionByte1 = (FtsVersion & 0xFF00);
uint8_t FtsVersionByte2 = (FtsVersion & 0xFF0000);
uint8_t FtsVersionByte3 = (FtsVersion & 0xFF000000);
uint8_t FirmwareVersionByte0 = FtsVersionByte3;
uint8_t FirmwareVersionByte1 = FtsVersionByte2;
uint8_t FirmwareVersionByte2 = FtsVersionByte1;
uint8_t FirmwareVersionByte3 = FtsVersionByte0;
if (FtsVersionByte3 <= 0x31) {
    FirmwareVersionByte3 = 0;
    FirmwareVersionByte1 = 0;
    FirmwareVersionByte0 = 0x31;
    if (FtsVersionByte2 == 0x5) {
        FirmwareVersionByte2 = 2;
    } else if (FtsVersionByte2 == 0x12) {
        FirmwareVersionByte2 = 0;
    } else if (FtsVersionByte2 == 0x1A) {
        FirmwareVersionByte2 = 1;
    } else {
        // Throw error.
    }
}
uint8_t FirmwareVersion[0x10] = {0};
*(uint32_t *)FirmwareVersion = (FirmwareVersionByte3 << 24) | (FirmwareVersionByte2 << 16) | (FirmwareVersionByte1 << 8) | FirmwareVersionByte0;
*((uint32_t *)FirmwareVersion + 1) = 0x5354;  // "TS"
return FirmwareVersion;


== IsFirmwareAvailableForNotification ==
== GetUniquePadsFromNpad ==
Takes a PID, a s32, an [[#UniquePadId]], an [[AM_services|AppletResourceUserId]], returns an output bool.
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).


sdknso uses hard-coded value 1 for the s32.
The output buffer contains an array of [[#UniquePadId]].


== CancelConnectionTrigger ==
== SetAppletResourceUserId ==
Takes an input "nn::bluetooth::Address", no output.
Takes an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


== IsButtonConfigSupported ==
Passing 0 instead of [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]] results in process being tied to currently focused applet.
Takes an input [[#UniquePadId]], returns an output bool.


[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], returns an output bool.
== RegisterAppletResourceUserId ==
Takes an input bool, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


== IsButtonConfigEmbeddedSupported ==
If input bool is '''true''', inlined [[#SetAppletResourceUserId]] is executed after successful registration.  
No input, returns an output bool.


== DeleteButtonConfig ==
[20.4.0+] Takes an input bool, an u8 [[Applet_Manager_services|ApplicationSpec]], an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.
Takes an input [[#UniquePadId]], no output.


[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], no output.
== UnregisterAppletResourceUserId ==
Takes an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


== DeleteButtonConfigEmbedded ==
== EnableAppletToGetInput ==
No input/output.
Takes an input bool, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


== SetButtonConfigEnabled ==
== SetAruidValidForVibration ==
Takes an input bool, an [[#UniquePadId]], no output.
Takes an input bool, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


[11.0.0+] Takes an input bool, an [[Bluetooth_Driver_services#Address|Address]], no output.
== EnableAppletToGetSixAxisSensor ==
Takes an input bool, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


== SetButtonConfigEmbeddedEnabled ==
== EnableAppletToGetPadInput ==
Takes an input bool, no output.
Takes an input bool, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


== IsButtonConfigEnabled ==
== EnableAppletToGetTouchScreen ==
Takes an input [[#UniquePadId]], returns an output bool.
Takes an input bool, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.


[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], returns an output bool.
== SetVibrationMasterVolume ==
Takes an input 32bit float.


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


== SetButtonConfigEmbedded ==
The output buffer contains an array of [[#UniquePadId]].
Takes ([10.0.0-10.2.0] an input [[#UniquePadId]]), a type-0x15 input buffer containing a [[#SystemButtonConfigEmbedded]], no output.


== SetButtonConfigFull ==
== GetUniquePadType ==
Takes an input [[#UniquePadId]], a type-0x15 input buffer containing a [[#SystemButtonConfigFull]], no output.
Takes an input [[#UniquePadId]] and returns an output u64 [[#UniquePadType]].


[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], a type-0x15 input buffer containing a [[#SystemButtonConfigFull]], no output.
== GetUniquePadSerialNumber ==
Takes an input [[#UniquePadId]] and returns an output [[#UniquePadSerialNumber]].


== SetButtonConfigLeft ==
== SetNotificationLedPattern ==
Takes an input [[#UniquePadId]], a type-0x15 input buffer containing a [[#SystemButtonConfigLeft]], no output.
Takes an input [[#NotificationLedPattern]] and an [[#UniquePadId]], no output.


[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], a type-0x15 input buffer containing a [[#SystemButtonConfigLeft]], no output.
The specified controller must have a HOME button.


== SetButtonConfigRight ==
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.
Takes an input [[#UniquePadId]], a type-0x15 input buffer containing a [[#SystemButtonConfigRight]], no output.


[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], a type-0x15 input buffer containing a [[#SystemButtonConfigRight]], no output.
The layout of cmd_argdata is as follows:
 
{| class="wikitable" border="1"
== GetButtonConfigEmbedded ==
|-
Takes ([10.0.0-10.2.0] an input [[#UniquePadId]]), and a type-0x16 output buffer containing a [[#SystemButtonConfigEmbedded]].
! Offset || Size || Description
 
|-
== GetButtonConfigFull ==
| 0x0 || 0x1 || <nowiki>((TimeUnit & 0xF) | ((FrameCount & 0xF) << 4))</nowiki>
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#SystemButtonConfigFull]].
|-
 
| 0x1 || 0x1 || <nowiki>((CycleCount & 0xF) | ((InitialBrightness & 0xF) << 4))</nowiki>
[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], and a type-0x16 output buffer containing a [[#SystemButtonConfigFull]].
|-
 
| 0x2 || 0x1 || <nowiki>((Frame2Brightness & 0xF) | ((Frame1Brightness & 0xF) << 4))</nowiki>
== GetButtonConfigLeft ==
|-
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#SystemButtonConfigLeft]].
| 0x3 || 0x1 || <nowiki>((Frame1TimeToHold & 0xF) | ((Frame1TimeTowards & 0xF) << 4))</nowiki>
 
|-
[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], and a type-0x16 output buffer containing a [[#SystemButtonConfigLeft]].
| 0x4 || 0x1 || <nowiki>((Frame2TimeToHold & 0xF) | ((Frame2TimeTowards & 0xF) << 4))</nowiki>
 
|-
== GetButtonConfigRight ==
| 0x5 || 0x1 || <nowiki>((Frame4Brightness & 0xF) | ((Frame3Brightness & 0xF) << 4))</nowiki>
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#SystemButtonConfigRight]].
|-
 
| 0x6 || 0x1 || <nowiki>((Frame3TimeToHold & 0xF) | ((Frame3TimeTowards & 0xF) << 4))</nowiki>
[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], and a type-0x16 output buffer containing a [[#SystemButtonConfigRight]].
|-
 
| 0x7 || 0x1 || <nowiki>((Frame4TimeToHold & 0xF) | ((Frame4TimeTowards & 0xF) << 4))</nowiki>
== IsCustomButtonConfigSupported ==
|-
Takes an input [[#UniquePadId]], returns an output bool.
| 0x8 || 0x1 || <nowiki>((Frame6Brightness & 0xF) | ((Frame5Brightness & 0xF) << 4))</nowiki>
 
|-
== IsDefaultButtonConfigEmbedded ==
| 0x9 || 0x1 || <nowiki>((Frame5TimeToHold & 0xF) | ((Frame5TimeTowards & 0xF) << 4))</nowiki>
Takes a type-0x15 input buffer containing a [[#ButtonConfigEmbedded]], returns an output bool.
|-
 
| 0xA || 0x1 || <nowiki>((Frame6TimeToHold & 0xF) | ((Frame6TimeTowards & 0xF) << 4))</nowiki>
This compares the input config with config in state, sets the output bool to whether these match, then returns 0.
|-
| 0xB || 0x1 || <nowiki>((Frame8Brightness & 0xF) | ((Frame7Brightness & 0xF) << 4))</nowiki>
|-
| 0xC || 0x1 || <nowiki>((Frame7TimeToHold & 0xF) | ((Frame7TimeTowards & 0xF) << 4))</nowiki>
|-
| 0xD || 0x1 || <nowiki>((Frame8TimeToHold & 0xF) | ((Frame8TimeTowards & 0xF) << 4))</nowiki>
|-
| 0xE || 0x1 || <nowiki>((Frame10Brightness & 0xF) | ((Frame9Brightness & 0xF) << 4))</nowiki>
|-
| 0xF || 0x1 || <nowiki>((Frame9TimeToHold & 0xF) | ((Frame9TimeTowards & 0xF) << 4))</nowiki>
|-
| 0x10 || 0x1 || <nowiki>((Frame10TimeToHold & 0xF) | ((Frame10TimeTowards & 0xF) << 4))</nowiki>
|-
| 0x11 || 0x1 || <nowiki>((Frame12Brightness & 0xF) | ((Frame11Brightness & 0xF) << 4))</nowiki>
|-
| 0x12 || 0x1 || <nowiki>((Frame11TimeToHold & 0xF) | ((Frame11TimeTowards & 0xF) << 4))</nowiki>
|-
| 0x13 || 0x1 || <nowiki>((Frame12TimeToHold & 0xF) | ((Frame12TimeTowards & 0xF) << 4))</nowiki>
|-
| 0x14 || 0x1 || <nowiki>((Frame14Brightness & 0xF) | ((Frame13Brightness & 0xF) << 4))</nowiki>
|-
| 0x15 || 0x1 || <nowiki>((Frame13TimeToHold & 0xF) | ((Frame13TimeTowards & 0xF) << 4))</nowiki>
|-
| 0x16 || 0x1 || <nowiki>((Frame14TimeToHold & 0xF) | ((Frame14TimeTowards & 0xF) << 4))</nowiki>
|-
| 0x17 || 0x1 || <nowiki>((Reserved & 0xF) | ((Frame15Brightness & 0xF) << 4))</nowiki>
|-
| 0x18 || 0x1 || <nowiki>((Frame15TimeToHold & 0xF) | ((Frame15TimeTowards & 0xF) << 4))</nowiki>
|-
| 0x19 || 0x1 || <nowiki>((Reserved & 0xF) | ((Reserved & 0xF) << 4))</nowiki>
|-
| 0x1A || 0x1 || <nowiki>((TimeTowardsFinalBrightness & 0xF) | ((FinalBrightness & 0xF) << 4))</nowiki>
|-
| 0x1B || 0x1 || <nowiki>(Timeout & 0xFF)</nowiki>
|-
| 0x1C || 0x1 || <nowiki>((Timeout >> 8) & 0xFF)</nowiki>
|}


== IsDefaultButtonConfigFull ==
[9.0.0+] This runs code similar to [[#SetNotificationLedPatternWithTimeout]], except it passes the following param values to an internal func: flag=1 and TimeSpan=0 (with [[#SetNotificationLedPatternWithTimeout]] these are flag=0 and TimeSpan={input value}).
Takes a type-0x15 input buffer containing a [[#ButtonConfigFull]], returns an output bool.


This compares the input config with config in state, sets the output bool to whether these match, then returns 0.
== SetNotificationLedPatternWithTimeout ==
Takes an input [[#NotificationLedPattern]], an [[#UniquePadId]], and an s64 TimeSpan, no output.


== IsDefaultButtonConfigLeft ==
== PrepareHidsForNotificationWake ==
Takes a type-0x15 input buffer containing a [[#ButtonConfigLeft]], returns an output bool.
Takes a type-0x9 input buffer containing an array of [[#UniquePadId]], no output.


This compares the input config with config in state, sets the output bool to whether these match, then returns 0.
== IsUsbConnected ==
Tales an input [[#UniquePadId]], returns an output bool.


== IsDefaultButtonConfigRight ==
== NotifyInputDetector ==
Takes a type-0x15 input buffer containing a [[#ButtonConfigRight]], returns an output bool.
Takes an input u32 bitmask InputSourceId, no output.


This compares the input config with config in state, sets the output bool to whether these match, then returns 0.
This is the only hid:sys command used by USB-sysmodule (with value 0x40).


== IsButtonConfigStorageEmbeddedEmpty ==
== GetHidbusSystemServiceObject ==
Takes an input s32 entry-index, returns an output bool.
No input, returns an [[#IHidbusSystemServer]].


[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.
== GetTouchScreenFirmwareVersion ==
No input. Returns a [[#FirmwareVersion]].


Uses [[Settings_services#GetButtonConfigSettingsEmbedded|GetButtonConfigSettingsEmbedded]] with count=5 (output s32 ignored). The input entry-index is used with this array. Then the output bool is set to [[Settings_services#ButtonConfigSettings|IsFull]] bit0 == 0. Then 0 is returned.
This requests the current firmware version from the touch screen IC.


== IsButtonConfigStorageFullEmpty ==
It first ensures the touch screen IC's chip id is one of the following:
Takes an input s32 entry-index, returns an output bool.
0x7036 - Ftm4cd60d (STMicroelectronics FingerTipS FT9CJ/FT9CF)
0x4036 - Fst2ba61ya1


Same as [[#IsButtonConfigStorageEmbeddedEmpty]] except with a different setsys cmd.
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;


== IsButtonConfigStorageLeftEmpty ==
== IsFirmwareAvailableForNotification ==
Takes an input s32 entry-index, returns an output bool.
Takes a PID, a s32, an [[#UniquePadId]], an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], returns an output bool.


Same as [[#IsButtonConfigStorageEmbeddedEmpty]] except with a different setsys cmd.
sdknso uses hard-coded value 1 for the s32.


== IsButtonConfigStorageRightEmpty ==
== CancelConnectionTrigger ==
Takes an input s32 entry-index, returns an output bool.
Takes an input "nn::bluetooth::Address", no output.


Same as [[#IsButtonConfigStorageEmbeddedEmpty]] except with a different setsys cmd.
== IsButtonConfigSupported ==
Takes an input [[#UniquePadId]], returns an output bool.


== GetButtonConfigStorageEmbeddedDeprecated ==
[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], returns an output bool.
Takes an input s32 entry-index, and a type-0x16 output buffer containing a [[#ButtonConfigEmbedded]].


[10.1.0-10.2.0] This will now Abort if the s32 is negative or >=5.
== IsButtonConfigEmbeddedSupported ==
No input, returns an output bool.


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


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


== GetButtonConfigStorageFullDeprecated ==
== DeleteButtonConfigEmbedded ==
Takes an input s32 entry-index, and a type-0x16 output buffer containing a [[#ButtonConfigFull]].
No input/output.


Same as [[#GetButtonConfigStorageEmbeddedDeprecated]], except this uses a different setsys cmd, and uses a different conversion func / different output struct.
== SetButtonConfigEnabled ==
Takes an input bool, an [[#UniquePadId]], no output.


== GetButtonConfigStorageLeftDeprecated ==
[11.0.0+] Takes an input bool, an [[Bluetooth_Driver_services#Address|Address]], no output.
Takes an input s32 entry-index, and a type-0x16 output buffer containing a [[#ButtonConfigLeft]].


Same as [[#GetButtonConfigStorageEmbeddedDeprecated]], except this uses a different setsys cmd, and uses a different conversion func / different output struct.
== SetButtonConfigEmbeddedEnabled ==
Takes an input bool, no output.


== GetButtonConfigStorageRightDeprecated ==
== IsButtonConfigEnabled ==
Takes an input s32 entry-index, and a type-0x16 output buffer containing a [[#ButtonConfigRight]].
Takes an input [[#UniquePadId]], returns an output bool.


Same as [[#GetButtonConfigStorageEmbeddedDeprecated]], except this uses a different setsys cmd, and uses a different conversion func / different output struct.
[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], returns an output bool.


== SetButtonConfigStorageEmbeddedDeprecated ==
== IsButtonConfigEmbeddedEnabled ==
Takes an input s32 entry-index, and a type-0x15 input buffer containing a [[#ButtonConfigEmbedded]].
No input, returns an output bool.


[10.1.0-10.2.0] This will now Abort if the s32 is negative or >=5.
== SetButtonConfigEmbedded ==
Takes ([10.0.0-10.2.0] an input [[#UniquePadId]]), a type-0x15 input buffer containing a [[#SystemButtonConfigEmbedded]], no output.


[11.0.0+] This now calls the same func internally as [[#SetButtonConfigStorageEmbedded]], except the [[#StorageName]] isn't exposed.
== SetButtonConfigFull ==
Takes an input [[#UniquePadId]], a type-0x15 input buffer containing a [[#SystemButtonConfigFull]], no output.


If the input config matches the [[#IsDefaultButtonConfigEmbedded|default]], this first does:
[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], a type-0x15 input buffer containing a [[#SystemButtonConfigFull]], 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).


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.
== SetButtonConfigLeft ==
Takes an input [[#UniquePadId]], a type-0x15 input buffer containing a [[#SystemButtonConfigLeft]], no output.


== SetButtonConfigStorageFullDeprecated ==
[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], a type-0x15 input buffer containing a [[#SystemButtonConfigLeft]], no output.
Takes an input s32 entry-index, and a type-0x15 input buffer containing a [[#ButtonConfigFull]].


Same as [[#SetButtonConfigStorageEmbeddedDeprecated]], except this uses different setsys cmds, and uses a different structs etc.
== SetButtonConfigRight ==
Takes an input [[#UniquePadId]], a type-0x15 input buffer containing a [[#SystemButtonConfigRight]], no output.


== SetButtonConfigStorageLeftDeprecated ==
[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], a type-0x15 input buffer containing a [[#SystemButtonConfigRight]], no output.
Takes an input s32 entry-index, and a type-0x15 input buffer containing a [[#ButtonConfigLeft]].


Same as [[#SetButtonConfigStorageEmbeddedDeprecated]], except this uses different setsys cmds, and uses a different structs etc.
== GetButtonConfigEmbedded ==
Takes ([10.0.0-10.2.0] an input [[#UniquePadId]]), and a type-0x16 output buffer containing a [[#SystemButtonConfigEmbedded]].


== SetButtonConfigStorageRightDeprecated ==
== GetButtonConfigFull ==
Takes an input s32 entry-index, and a type-0x15 input buffer containing a [[#ButtonConfigRight]].
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#SystemButtonConfigFull]].


Same as [[#SetButtonConfigStorageEmbeddedDeprecated]], except this uses different setsys cmds, and uses a different structs etc.
[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], and a type-0x16 output buffer containing a [[#SystemButtonConfigFull]].


== DeleteButtonConfigStorageEmbedded ==
== GetButtonConfigLeft ==
Takes an input s32 entry-index, no output.
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#SystemButtonConfigLeft]].


[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.
[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], and a type-0x16 output buffer containing a [[#SystemButtonConfigLeft]].


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.
== GetButtonConfigRight ==
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#SystemButtonConfigRight]].


== DeleteButtonConfigStorageFull ==
[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], and a type-0x16 output buffer containing a [[#SystemButtonConfigRight]].
Takes an input s32 entry-index, no output.


Same as [[#DeleteButtonConfigStorageEmbedded]] except with different setsys cmds.
== IsCustomButtonConfigSupported ==
Takes an input [[#UniquePadId]], returns an output bool.


== DeleteButtonConfigStorageLeft ==
== IsDefaultButtonConfigEmbedded ==
Takes an input s32 entry-index, no output.
Takes a type-0x15 input buffer containing a [[#ButtonConfigEmbedded]], returns an output bool.


Same as [[#DeleteButtonConfigStorageEmbedded]] except with different setsys cmds.
This compares the input config with config in state, sets the output bool to whether these match, then returns 0.


== DeleteButtonConfigStorageRight ==
== IsDefaultButtonConfigFull ==
Takes an input s32 entry-index, no output.
Takes a type-0x15 input buffer containing a [[#ButtonConfigFull]], returns an output bool.


Same as [[#DeleteButtonConfigStorageEmbedded]] except with different setsys cmds.
This compares the input config with config in state, sets the output bool to whether these match, then returns 0.


== IsUsingCustomButtonConfig ==
== IsDefaultButtonConfigLeft ==
Takes an input [[#UniquePadId]], returns an output bool.
Takes a type-0x15 input buffer containing a [[#ButtonConfigLeft]], returns an output bool.


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


== SetAllCustomButtonConfigEnabled ==
== IsDefaultButtonConfigRight ==
Takes an input bool and an AppletResourceUserId, no output.
Takes a type-0x15 input buffer containing a [[#ButtonConfigRight]], returns an output bool.


== SetDefaultButtonConfig ==
This compares the input config with config in state, sets the output bool to whether these match, then returns 0.
Takes an input [[#UniquePadId]], no output.


== SetAllDefaultButtonConfig ==
== IsButtonConfigStorageEmbeddedEmpty ==
No input/output.
Takes an input s32 entry-index, returns an output bool.


== SetHidButtonConfigEmbedded ==
[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.
Takes an input [[#UniquePadId]] and a type-0x15 input buffer containing a [[#ButtonConfigEmbedded]], no output.


== SetHidButtonConfigFull ==
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.
Takes an input [[#UniquePadId]] and a type-0x15 input buffer containing a [[#ButtonConfigFull]], no output.


== SetHidButtonConfigLeft ==
== IsButtonConfigStorageFullEmpty ==
Takes an input [[#UniquePadId]] and a type-0x15 input buffer containing a [[#ButtonConfigLeft]], no output.
Takes an input s32 entry-index, returns an output bool.


== SetHidButtonConfigRight ==
Same as [[#IsButtonConfigStorageEmbeddedEmpty]] except with a different setsys cmd.
Takes an input [[#UniquePadId]] and a type-0x15 input buffer containing a [[#ButtonConfigRight]], no output.


== GetHidButtonConfigEmbedded ==
== IsButtonConfigStorageLeftEmpty ==
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#ButtonConfigEmbedded]].
Takes an input s32 entry-index, returns an output bool.


== GetHidButtonConfigFull ==
Same as [[#IsButtonConfigStorageEmbeddedEmpty]] except with a different setsys cmd.
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#ButtonConfigFull]].


== GetHidButtonConfigLeft ==
== IsButtonConfigStorageRightEmpty ==
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#ButtonConfigLeft]].
Takes an input s32 entry-index, returns an output bool.
 
Same as [[#IsButtonConfigStorageEmbeddedEmpty]] except with a different setsys cmd.


== GetHidButtonConfigRight ==
== GetButtonConfigStorageEmbeddedDeprecated ==
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#ButtonConfigRight]].
Takes an input s32 entry-index, and a type-0x16 output buffer containing a [[#ButtonConfigEmbedded]].


== GetButtonConfigStorageEmbedded ==
[10.1.0-10.2.0] This will now Abort if the s32 is negative or >=5.
Takes an input s32, a type-0x16 output buffer containing a [[#ButtonConfigEmbedded]], a type-0x1A output buffer containing a [[#StorageName]].


When the input s32 is larger than unsigned value 4, an error is returned.
[11.0.0+] This now calls the same func internally as [[#GetButtonConfigStorageEmbedded]], except the [[#StorageName]] isn't exposed.


== GetButtonConfigStorageFull ==
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.
Takes an input s32, a type-0x16 output buffer containing a [[#ButtonConfigFull]], a type-0x1A output buffer containing a [[#StorageName]].


== GetButtonConfigStorageLeft ==
== GetButtonConfigStorageFullDeprecated ==
Takes an input s32, a type-0x16 output buffer containing a [[#ButtonConfigLeft]], a type-0x1A output buffer containing a [[#StorageName]].
Takes an input s32 entry-index, and a type-0x16 output buffer containing a [[#ButtonConfigFull]].


== GetButtonConfigStorageRight ==
Same as [[#GetButtonConfigStorageEmbeddedDeprecated]], except this uses a different setsys cmd, and uses a different conversion func / different output struct.
Takes an input s32, a type-0x16 output buffer containing a [[#ButtonConfigRight]], a type-0x1A output buffer containing a [[#StorageName]].


== SetButtonConfigStorageEmbedded ==
== GetButtonConfigStorageLeftDeprecated ==
Takes an input s32, a type-0x15 input buffer containing a [[#ButtonConfigEmbedded]], a type-0x19 input buffer containing a [[#StorageName]].
Takes an input s32 entry-index, and a type-0x16 output buffer containing a [[#ButtonConfigLeft]].


When the input s32 is larger than unsigned value 4, this will immediately return (this cmd always returns 0 regardless).
Same as [[#GetButtonConfigStorageEmbeddedDeprecated]], except this uses a different setsys cmd, and uses a different conversion func / different output struct.


== SetButtonConfigStorageFull ==
== GetButtonConfigStorageRightDeprecated ==
Takes an input s32, a type-0x15 input buffer containing a [[#ButtonConfigFull]], a type-0x19 input buffer containing a [[#StorageName]].
Takes an input s32 entry-index, and a type-0x16 output buffer containing a [[#ButtonConfigRight]].


== SetButtonConfigStorageLeft ==
Same as [[#GetButtonConfigStorageEmbeddedDeprecated]], except this uses a different setsys cmd, and uses a different conversion func / different output struct.
Takes an input s32, a type-0x15 input buffer containing a [[#ButtonConfigLeft]], a type-0x19 input buffer containing a [[#StorageName]].


== SetButtonConfigStorageRight ==
== SetButtonConfigStorageEmbeddedDeprecated ==
Takes an input s32, a type-0x15 input buffer containing a [[#ButtonConfigRight]], a type-0x19 input buffer containing a [[#StorageName]].
Takes an input s32 entry-index, and a type-0x15 input buffer containing a [[#ButtonConfigEmbedded]].


== IHidbusSystemServer ==
[10.1.0-10.2.0] This will now Abort if the s32 is negative or >=5.
This is "nn::hidbus::IHidbusSystemServer".


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


{| class="wikitable" border="1"
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).
! Cmd || Name
|-
| 500 || SetAppletResourceUserId
|-
| 501 || RegisterAppletResourceUserId
|-
| 502 || UnregisterAppletResourceUserId
|}


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


This service was added with [3.0.0+], then removed with [8.0.0+].
== SetButtonConfigStorageFullDeprecated ==
Takes an input s32 entry-index, and a type-0x15 input buffer containing a [[#ButtonConfigFull]].


{| class="wikitable" border="1"
Same as [[#SetButtonConfigStorageEmbeddedDeprecated]], except this uses different setsys cmds, and uses a different structs etc.
|-
! Cmd || Name
|-
| 0 || GetConsoleSixAxisSensorCalibrationValues
|}


= irs =
== SetButtonConfigStorageLeftDeprecated ==
This is "nn::irsensor::IIrSensorServer".
Takes an input s32 entry-index, and a type-0x15 input buffer containing a [[#ButtonConfigLeft]].


This was added to sdknso with 3.x.
Same as [[#SetButtonConfigStorageEmbeddedDeprecated]], except this uses different setsys cmds, and uses a different structs etc.


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.
== SetButtonConfigStorageRightDeprecated ==
Takes an input s32 entry-index, and a type-0x15 input buffer containing a [[#ButtonConfigRight]].


{| class="wikitable" border="1"
Same as [[#SetButtonConfigStorageEmbeddedDeprecated]], except this uses different setsys cmds, and uses a different structs etc.
|-
! Cmd || Name
|-
| 302 || [[#ActivateIrsensor]]
|-
| 303 || [[#DeactivateIrsensor]]
|-
| 304 || [[#GetIrsensorSharedMemoryHandle]]
|-
| 305 || [[#StopImageProcessor]]
|-
| 306 || [[#RunMomentProcessor]]
|-
| 307 || [[#RunClusteringProcessor]]
|-
| 308 || [[#RunImageTransferProcessor]]
|-
| 309 || [[#GetImageTransferProcessorState]]
|-
| 310 || [[#RunTeraPluginProcessor]]
|-
| 311 || [[#GetNpadIrCameraHandle]]
|-
| 312 || [[#RunPointingProcessor]]
|-
| 313 || [[#SuspendImageProcessor]]
|-
| 314 || [3.0.0+] [[#CheckFirmwareVersion]]
|-
| 315 || [4.0.0+] [[#SetFunctionLevel]]
|-
| 316 || [4.0.0+] [[#RunImageTransferExProcessor]]
|-
| 317 || [4.0.0+] [[#RunIrLedProcessor]]
|-
| 318 || [4.0.0+] [[#StopImageProcessorAsync]]
|-
| 319 || [4.0.0+] [[#ActivateIrsensorWithFunctionLevel]]
|}


== ActivateIrsensor ==
== DeleteButtonConfigStorageEmbedded ==
Takes a PID-descriptor and an [[AM_services|AppletResourceUserId]]. No output.
Takes an input s32 entry-index, no output.


== DeactivateIrsensor ==
[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.
Takes a PID-descriptor and an [[AM_services|AppletResourceUserId]]. No output.


== GetIrsensorSharedMemoryHandle ==
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.
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.
== DeleteButtonConfigStorageFull ==
Takes an input s32 entry-index, no output.


It's structure is as follows:
Same as [[#DeleteButtonConfigStorageEmbedded]] except with different setsys cmds.


{| class="wikitable" border="1"
== DeleteButtonConfigStorageLeft ==
|-
Takes an input s32 entry-index, no output.
! Offset || Size || Description
|-
| 0x0 || 0x7FB0 || Array of [[#DeviceFormat]]
|-
| 0x7FB0 || 0x50 || Array of [[#AruidFormat]]
|}


The array of [[#DeviceFormat]] is indexed by [[#IrCameraHandle|PlayerNumber]] and can hold up to 9 entries. The array of [[#AruidFormat]] can only hold up to 5 entries.
Same as [[#DeleteButtonConfigStorageEmbedded]] except with different setsys cmds.


=== DeviceFormat ===
== DeleteButtonConfigStorageRight ==
{| class="wikitable" border="1"
Takes an input s32 entry-index, no output.
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || [[#IrCameraStatus]]
|-
| 0x4 || 0x4 || [[#IrCameraInternalStatus]]
|-
| 0x8 || 0x8 || [[#IrSensorMode]]
|-
| 0x10 || 0xE20 || [[#ProcessorStateRingLifo]]
|}


==== ProcessorStateRingLifo ====
Same as [[#DeleteButtonConfigStorageEmbedded]] except with different setsys cmds.
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"
== IsUsingCustomButtonConfig ==
|-
Takes an input [[#UniquePadId]], returns an output bool.
! Offset || Size || Description
|-
| 0x0 || 0x8 || Start
|-
| 0x8 || 0x4 || Count
|-
| 0xC || 0x4 || Padding
|-
| 0x10 || Variable || ProcessorState
|}


The maximum element count is 6 for [[#PointingProcessorMarkerState]] or 5 for any of the other states.
== IsAnyCustomButtonConfigEnabled ==
No input, returns an output bool.


ProcessorState is specialized depending on the value of [[#IrSensorMode]].
== SetAllCustomButtonConfigEnabled ==
Takes an input bool and an AppletResourceUserId, no output.


===== MomentProcessorState =====
== SetDefaultButtonConfig ==
This is "nn::irsensor::MomentProcessorState".
Takes an input [[#UniquePadId]], no output.


{| class="wikitable" border="1"
== SetAllDefaultButtonConfig ==
|-
No input/output.
! Offset || Size || Description
 
|-
== SetHidButtonConfigEmbedded ==
| 0x0 || 0x8 || SamplingNumber
Takes an input [[#UniquePadId]] and a type-0x15 input buffer containing a [[#ButtonConfigEmbedded]], no output.
|-
| 0x8 || 0x8 || TimeStamp
|-
| 0x10 || 0x4 || AmbientNoiseLevel
|-
| 0x14 || 0x4 || Reserved
|-
| 0x18 || 0x240 || Array of [[#MomentStatistic]]
|}


The array of [[#MomentStatistic]] can hold up to 48 entries. This array can be accessed as [y + x*8] (this is a 6x8 array). region_x = image_x/6, region_y = image_y/8.
== SetHidButtonConfigFull ==
Takes an input [[#UniquePadId]] and a type-0x15 input buffer containing a [[#ButtonConfigFull]], no output.


====== MomentStatistic ======
== SetHidButtonConfigLeft ==
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.
Takes an input [[#UniquePadId]] and a type-0x15 input buffer containing a [[#ButtonConfigLeft]], no output.


{| class="wikitable" border="1"
== SetHidButtonConfigRight ==
|-
Takes an input [[#UniquePadId]] and a type-0x15 input buffer containing a [[#ButtonConfigRight]], no output.
! Offset || Size || Description
|-
| 0x0 || 0x4 || float AverageIntensity
|-
| 0x4 || 0x4 || float CentroidX
|-
| 0x8 || 0x4 || float CentroidY
|}


===== ClusteringProcessorState =====
== GetHidButtonConfigEmbedded ==
This is "nn::irsensor::ClusteringProcessorState".
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#ButtonConfigEmbedded]].


{| class="wikitable" border="1"
== GetHidButtonConfigFull ==
|-
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#ButtonConfigFull]].
! Offset || Size || Description
|-
| 0x0 || 0x8 || SamplingNumber
|-
| 0x8 || 0x8 || TimeStamp
|-
| 0x10 || 0x1 || ObjectCount
|-
| 0x11 || 0x3 || Reserved
|-
| 0x14 || 0x4 || AmbientNoiseLevel
|-
| 0x18 || 0x180 || Array of [[#ClusteringData]]
|}


The array of [[#ClusteringData]] can hold up to 16 entries.
== GetHidButtonConfigLeft ==
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#ButtonConfigLeft]].


====== ClusteringData ======
== GetHidButtonConfigRight ==
{| class="wikitable" border="1"
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#ButtonConfigRight]].
 
== GetButtonConfigStorageEmbedded ==
Takes an input s32, a type-0x16 output buffer containing a [[#ButtonConfigEmbedded]], a type-0x1A output buffer containing a [[#StorageName]].
 
When the input s32 is larger than unsigned value 4, an error is returned.
 
== GetButtonConfigStorageFull ==
Takes an input s32, a type-0x16 output buffer containing a [[#ButtonConfigFull]], a type-0x1A output buffer containing a [[#StorageName]].
 
== GetButtonConfigStorageLeft ==
Takes an input s32, a type-0x16 output buffer containing a [[#ButtonConfigLeft]], a type-0x1A output buffer containing a [[#StorageName]].
 
== GetButtonConfigStorageRight ==
Takes an input s32, a type-0x16 output buffer containing a [[#ButtonConfigRight]], a type-0x1A output buffer containing a [[#StorageName]].
 
== SetButtonConfigStorageEmbedded ==
Takes an input s32, a type-0x15 input buffer containing a [[#ButtonConfigEmbedded]], a type-0x19 input buffer containing a [[#StorageName]].
 
When the input s32 is larger than unsigned value 4, this will immediately return (this cmd always returns 0 regardless).
 
== SetButtonConfigStorageFull ==
Takes an input s32, a type-0x15 input buffer containing a [[#ButtonConfigFull]], a type-0x19 input buffer containing a [[#StorageName]].
 
== SetButtonConfigStorageLeft ==
Takes an input s32, a type-0x15 input buffer containing a [[#ButtonConfigLeft]], a type-0x19 input buffer containing a [[#StorageName]].
 
== SetButtonConfigStorageRight ==
Takes an input s32, a type-0x15 input buffer containing a [[#ButtonConfigRight]], a type-0x19 input buffer containing a [[#StorageName]].
 
== Cmd1470 ==
This is exclusive to S2.
 
This is likely SetSelectorUiPresentationPolicy?
 
Takes a PID, an u8 SelectorUiPresentationPolicy, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.
 
== Cmd1471 ==
This is exclusive to S2.
 
This is likely GetSelectorUiPresentationPolicy?
 
Takes a PID, an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], returns an output u8 SelectorUiPresentationPolicy.
 
== IHidbusSystemServer ==
This is "nn::hidbus::IHidbusSystemServer".
 
This was added with [5.0.0+].
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Cmd || Name
|-
|-
| 0x0 || 0x4 || float AverageIntensity
| 500 || [[#SetAppletResourceUserId_2|#SetAppletResourceUserId]]
|-
|-
| 0x4 || 0x4 || float CentroidX
| 501 || [[#RegisterAppletResourceUserId_2|#RegisterAppletResourceUserId]]
|-
|-
| 0x8 || 0x4 || float CentroidY
| 502 || [[#UnregisterAppletResourceUserId_2|#UnregisterAppletResourceUserId]]
|-
| 0xC || 0x4 || PixelCount
|-
| 0x10 || 0x2 || BoundX
|-
| 0x12 || 0x2 || BoundY
|-
| 0x14 || 0x2 || BoundtWidth
|-
| 0x16 || 0x2 || BoundHeight
|}
|}


===== PointingProcessorMarkerState =====
== SetAppletResourceUserId ==
This is "nn::irsensor::PointingProcessorMarkerState".
 
Takes an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.
 
This function is called by [[AM_services|Applet Manager services]] after hid:sys [[#SetAppletResourceUserId|SetAppletResourceUserId]].
 
== RegisterAppletResourceUserId ==
 
Takes an u8 [[Applet_Manager_services#AppletId|AppletId]], an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.
 
This function is called by [[AM_services|Applet Manager services]] after hid:sys [[#RegisterAppletResourceUserId|RegisterAppletResourceUserId]].
 
== UnregisterAppletResourceUserId ==
 
Takes an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], no output.
 
This function is called by [[AM_services|Applet Manager services]] before hid:sys [[#UnregisterAppletResourceUserId|UnregisterAppletResourceUserId]].
 
= hid:tmp =
This is "nn::hid::IHidTemporaryServer".
 
This service was added with [3.0.0+], then removed with [8.0.0+].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Cmd || Name
|-
|-
| 0x0 || 0x8 || SamplingNumber
| 0 || GetConsoleSixAxisSensorCalibrationValues
|}
 
= irs =
This is "nn::irsensor::IIrSensorServer".
 
This was added to sdknso with 3.x.
 
With sdknso versions pre-4.x PointingProcessor used to be DpdProcessor. The [[#PackedPointingProcessorConfig|packed-config]] with DpdProcessor (besides RequiredMcuVersion) used to be initialized from user-specified config, now it's hard-coded.
 
{| class="wikitable" border="1"
|-
|-
| 0x8 || 0x8 || TimeStamp
! Cmd || Name
|-
|-
| 0x10 || 0x1 || PointingStatus
| 302 || [[#ActivateIrsensor]]
|-
|-
| 0x11 || 0x3 || Reserved
| 303 || [[#DeactivateIrsensor]]
|-
|-
| 0x14 || 0x4 || Unknown
| 304 || [[#GetIrsensorSharedMemoryHandle]]
|-
|-
| 0x18 || 0x4 || float Unknown
| 305 || [[#StopImageProcessor]]
|-
|-
| 0x1C || 0x4 || float PositionX
| 306 || [[#RunMomentProcessor]]
|-
|-
| 0x20 || 0x4 || float PositionY
| 307 || [[#RunClusteringProcessor]]
|-
|-
| 0x24 || 0x4 || float Unknown
| 308 || [[#RunImageTransferProcessor]]
|-
|-
| 0x28 || 0x2 || WindowOfInterestX
| 309 || [[#GetImageTransferProcessorState]]
|-
|-
| 0x2A || 0x2 || WindowOfInterestY
| 310 || [[#RunTeraPluginProcessor]]
|-
|-
| 0x2C || 0x2 || WindowOfInterestWidth
| 311 || [[#GetNpadIrCameraHandle]]
|-
|-
| 0x2E || 0x2 || WindowOfInterestHeight
| 312 || [[#RunPointingProcessor]]
|-
|-
| 0x30 || 0x1 || PointingStatus
| 313 || [[#SuspendImageProcessor]]
|-
|-
| 0x31 || 0x3 || Reserved
| 314 || [3.0.0+] [[#CheckFirmwareVersion]]
|-
|-
| 0x34 || 0x4 || Unknown
| 315 || [4.0.0+] [[#SetFunctionLevel]]
|-
|-
| 0x38 || 0x4 || float Unknown
| 316 || [4.0.0+] [[#RunImageTransferExProcessor]]
|-
|-
| 0x3C || 0x4 || float PositionX
| 317 || [4.0.0+] [[#RunIrLedProcessor]]
|-
|-
| 0x40 || 0x4 || float PositionY
| 318 || [4.0.0+] [[#StopImageProcessorAsync]]
|-
|-
| 0x44 || 0x4 || float Unknown
| 319 || [4.0.0+] [[#ActivateIrsensorWithFunctionLevel]]
|}
 
== ActivateIrsensor ==
Takes a PID-descriptor and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]]. No output.
 
== DeactivateIrsensor ==
Takes a PID-descriptor and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]]. No output.
 
== GetIrsensorSharedMemoryHandle ==
Takes a PID-descriptor and an [[Applet_Manager_services#AppletResourceUserId|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"
|-
|-
| 0x48 || 0x2 || WindowOfInterestX
! Offset || Size || Description
|-
|-
| 0x4A || 0x2 || WindowOfInterestY
| 0x0 || 0x7FB0 || Array of [[#DeviceFormat]]
|-
|-
| 0x4C || 0x2 || WindowOfInterestWidth
| 0x7FB0 || 0x50 || Array of [[#AruidFormat]]
|}
 
The array of [[#DeviceFormat]] is indexed by [[#IrCameraHandle|PlayerNumber]] and can hold up to 9 entries. The array of [[#AruidFormat]] can only hold up to 5 entries.
 
=== DeviceFormat ===
{| class="wikitable" border="1"
|-
|-
| 0x4E || 0x2 || WindowOfInterestHeight
! Offset || Size || Description
|-
|-
| 0x50 || 0x1 || PointingStatus
| 0x0 || 0x4 || [[#IrCameraStatus]]
|-
|-
| 0x51 || 0x3 || Reserved
| 0x4 || 0x4 || [[#IrCameraInternalStatus]]
|-
|-
| 0x54 || 0x4 || Unknown
| 0x8 || 0x8 || [[#IrSensorMode]]
|-
|-
| 0x58 || 0x4 || float Unknown
| 0x10 || 0xE20 || [[#ProcessorStateRingLifo]]
|-
| 0x5C || 0x4 || float PositionX
|-
| 0x60 || 0x4 || float PositionY
|-
| 0x64 || 0x4 || float Unknown
|-
| 0x68 || 0x2 || WindowOfInterestX
|-
| 0x6A || 0x2 || WindowOfInterestY
|-
| 0x6C || 0x2 || WindowOfInterestWidth
|-
| 0x6E || 0x2 || WindowOfInterestHeight
|}
|}


===== PointingProcessorState =====
==== ProcessorStateRingLifo ====
This is "nn::irsensor::PointingProcessorState".
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).
 
This is created from [[#PointingProcessorMarkerState]].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 2,658: Line 3,124:
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x8 || SamplingNumber
| 0x0 || 0x8 || Start
|-
|-
| 0x8 || 0x8 || TimeStamp
| 0x8 || 0x4 || Count
|-
|-
| 0x10 || 0x4 || PointingStatus
| 0xC || 0x4 || Padding
|-
|-
| 0x14 || 0x4 || float PositionX
| 0x10 || Variable || ProcessorState
|-
| 0x18 || 0x4 || float PositionY
|-
| 0x1C || 0x4 || Reserved
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 2,684: Line 3,150:
| 0x10 || 0x4 || AmbientNoiseLevel
| 0x10 || 0x4 || AmbientNoiseLevel
|-
|-
| 0x14 || 0x12C || PluginData
| 0x14 || 0x4 || Reserved
|-
| 0x18 || 0x240 || Array of [[#MomentStatistic]]
|}
|}


===== AdaptiveClusteringProcessorState =====
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::irsensor::AdaptiveClusteringProcessorState".
 
====== MomentStatistic ======
In sdknso GetMomentProcessorStates, this loops through each MomentProcessorState->MomentStatistic entry: <code>AverageIntensity *= scale;</code> The scale is calculated with: <code>scale = 76800.0f / (float)([[#PackedMomentProcessorConfig|WindowOfInterest]].width * [[#PackedMomentProcessorConfig|WindowOfInterest]].height);</code> Note that <code>76800 == 320*240</code>, hence with the default width/height the calculated scale is 1.0f.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || float AverageIntensity
|-
| 0x4 || 0x4 || float CentroidX
|-
| 0x8 || 0x4 || float CentroidY
|}


This is created from [[#TeraPluginProcessorState]].
===== ClusteringProcessorState =====
This is "nn::irsensor::ClusteringProcessorState".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 2,700: Line 3,182:
| 0x8 || 0x8 || TimeStamp
| 0x8 || 0x8 || TimeStamp
|-
|-
| 0x10 || 0x4 || AmbientNoiseLevel
| 0x10 || 0x1 || ObjectCount
|-
|-
| 0x14 || 0x4 || AccuracyLevel
| 0x11 || 0x3 || Reserved
|-
|-
| 0x18 || 0x1 || ObjectCount
| 0x14 || 0x4 || AmbientNoiseLevel
|-
|-
| 0x19 || 0x1 || BackgroundIntensity
| 0x18 || 0x180 || Array of [[#ClusteringData]]
|-
| 0x1A || 0x6 || Reserved
|-
| 0x20 || 0x200 || Array of [[#AdaptiveClusteringData]]
|}
|}


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


====== AdaptiveClusteringData ======
====== ClusteringData ======
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x4 || float CentroidX
| 0x0 || 0x4 || float AverageIntensity
|-
|-
| 0x4 || 0x4 || float CentroidY
| 0x4 || 0x4 || float CentroidX
|-
|-
| 0x8 || 0x4 || float Area
| 0x8 || 0x4 || float CentroidY
|-
|-
| 0xC || 0x4 || IsIncomplete
| 0xC || 0x4 || PixelCount
|}
 
===== HandAnalysisImageState =====
This is "nn::irsensor::HandAnalysisImageState".
 
This is created from [[#TeraPluginProcessorState]].
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 0x10 || 0x2 || BoundX
|-
|-
| 0x0 || 0x8 || SamplingNumber
| 0x12 || 0x2 || BoundY
|-
|-
| 0x8 || 0x4 || AmbientNoiseLevel
| 0x14 || 0x2 || BoundtWidth
|-
|-
| 0xC || 0x960 || Image
| 0x16 || 0x2 || BoundHeight
|-
| 0x96C || 0x4 || Reserved
|}
|}


===== HandAnalysisSilhouetteState =====
===== PointingProcessorMarkerState =====
This is "nn::irsensor::HandAnalysisSilhouetteState".
This is "nn::irsensor::PointingProcessorMarkerState".
 
This is created from [[#TeraPluginProcessorState]].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 2,758: Line 3,224:
| 0x0 || 0x8 || SamplingNumber
| 0x0 || 0x8 || SamplingNumber
|-
|-
| 0x8 || 0x4 || AmbientNoiseLevel
| 0x8 || 0x8 || TimeStamp
|-
| 0x10 || 0x1 || PointingStatus
|-
| 0x11 || 0x3 || Reserved
|-
|-
| 0xC || 0x1354 || Unknown
| 0x14 || 0x4 || Unknown
|}
 
===== HandAnalysisSilhouetteStateWithFullFrameShape =====
This is "nn::irsensor::HandAnalysisSilhouetteStateWithFullFrameShape".
 
This is created from [[#TeraPluginProcessorState]].
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 0x18 || 0x4 || float Unknown
|-
|-
| 0x0 || 0x8 || SamplingNumber
| 0x1C || 0x4 || float PositionX
|-
|-
| 0x8 || 0x4 || AmbientNoiseLevel
| 0x20 || 0x4 || float PositionY
|-
|-
| 0xC || 0x156C || Unknown
| 0x24 || 0x4 || float Unknown
|}
 
=== AruidFormat ===
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 0x28 || 0x2 || WindowOfInterestX
|-
|-
| 0x0 || 0x8 || IrSensorAruid
| 0x2A || 0x2 || WindowOfInterestY
|-
|-
| 0x8 || 0x8 || IrSensorAruidStatus
| 0x2C || 0x2 || WindowOfInterestWidth
|}
|-
 
| 0x2E || 0x2 || WindowOfInterestHeight
== StopImageProcessor ==
|-
Takes a PID-descriptor, an [[#IrCameraHandle]], and an [[AM_services|AppletResourceUserId]]. No output.
| 0x30 || 0x1 || PointingStatus
 
== RunMomentProcessor ==
Takes a PID-descriptor, an [[#IrCameraHandle]], an [[AM_services|AppletResourceUserId]], and a [[#PackedMomentProcessorConfig]]. No output.
 
== RunClusteringProcessor ==
Takes a PID-descriptor, an [[#IrCameraHandle]], an [[AM_services|AppletResourceUserId]], and a [[#PackedClusteringProcessorConfig]]. No output.
 
== RunImageTransferProcessor ==
Takes a PID-descriptor, an [[#IrCameraHandle]], an [[AM_services|AppletResourceUserId]], a [[#PackedImageTransferProcessorConfig]], an u64 for the TransferMemory's size, and a TransferMemory handle. No output.
 
The TransferMemory is created with an user specified buffer and permission none.
 
== GetImageTransferProcessorState ==
Takes a PID-descriptor, a type-0x6 output buffer, an [[#IrCameraHandle]], and an [[AM_services|AppletResourceUserId]]. Returns an [[#ImageTransferProcessorState]]. No output.
 
== RunTeraPluginProcessor==
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedTeraPluginProcessorConfig]] (immediately after the previous word), and an [[AM_services|AppletResourceUserId]]. No output.
 
== GetNpadIrCameraHandle ==
Takes an input [[#NpadIdType]]. Returns an output [[#IrCameraHandle]].
 
== RunPointingProcessor ==
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedPointingProcessorConfig]] (immediately after the previous word), and an [[AM_services|AppletResourceUserId]]. No output.
 
== SuspendImageProcessor ==
Takes a PID-descriptor, an [[#IrCameraHandle]], and an [[AM_services|AppletResourceUserId]]. No output.
 
sdknso uses this from the Run*Processor funcs to suspend the current Processor when the current [[#PackedFunctionLevel|FunctionLevel]] is >= 0x1, prior to starting another Processor if needed (depending on  what Processor was already active via a state field). Hence, this cmd is only used with [4.0.0+].
 
== CheckFirmwareVersion ==
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedMcuVersion]], and an [[AM_services|AppletResourceUserId]]. No output.
 
sdknso didn't actually use this until 4.x (the RequiredMcuVersion was also updated with that version).
 
== SetFunctionLevel ==
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedFunctionLevel]], and an [[AM_services|AppletResourceUserId]]. No output.
 
== RunImageTransferExProcessor ==
Takes a PID-descriptor, an [[#IrCameraHandle]], an [[AM_services|AppletResourceUserId]], a [[#PackedImageTransferProcessorExConfig]], an u64 for the TransferMemory's size, and a TransferMemory handle. No output.
 
The TransferMemory is created with an user specified buffer and permission none.
 
== RunIrLedProcessor ==
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedIrLedProcessorConfig]] (immediately after the previous word), and an [[AM_services|AppletResourceUserId]]. No output.
 
== StopImageProcessorAsync ==
Takes a PID-descriptor, an [[#IrCameraHandle]], and an [[AM_services|AppletResourceUserId]]. No output.
 
== ActivateIrsensorWithFunctionLevel ==
Takes a PID-descriptor, an [[#PackedFunctionLevel]], and an [[AM_services|AppletResourceUserId]]. No output.
 
= irs:sys =
This is "nn::irsensor::IIrSensorSystemServer".
 
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
| 0x31 || 0x3 || Reserved
|-
|-
| 500 || [[#SetAppletResourceUserId]]
| 0x34 || 0x4 || Unknown
|-
|-
| 501 || [[#RegisterAppletResourceUserId]]
| 0x38 || 0x4 || float Unknown
|-
|-
| 502 || [[#UnregisterAppletResourceUserId]]
| 0x3C || 0x4 || float PositionX
|-
|-
| 503 || [[#EnableAppletToGetInput]]
| 0x40 || 0x4 || float PositionY
|}
 
== 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
| 0x44 || 0x4 || float Unknown
|-
|-
| 0 || [[#AcquireDevice]]
| 0x48 || 0x2 || WindowOfInterestX
|-
|-
| 1 || [[#ReleaseDevice]]
| 0x4A || 0x2 || WindowOfInterestY
|-
|-
| 2 || [[#GetCtrlSession]]
| 0x4C || 0x2 || WindowOfInterestWidth
|-
|-
| 3 || [[#GetReadSession]]
| 0x4E || 0x2 || WindowOfInterestHeight
|-
|-
| 4 || [1.0.0-2.3.0] [[#GetWriteSession]]
| 0x50 || 0x1 || PointingStatus
|}
 
== AcquireDevice ==
Takes an input s32, no output.
 
== ReleaseDevice ==
Takes an input s32, no output.
 
== GetCtrlSession ==
Takes an input u32, returns an [[#ICtrlSession]].
 
== GetReadSession ==
Takes an input u32, returns an [[#IReadSession]].
 
== GetWriteSession ==
Takes an input u32, returns an [[#IWriteSession]].
 
== ICtrlSession ==
This is "nn::ahid::ICtrlSession".
 
This no longer exists in [9.0.0+].
 
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
| 0x51 || 0x3 || Reserved
|-
|-
| 0 || GetString
| 0x54 || 0x4 || Unknown
|-
|-
| 1 || GetCodeBook
| 0x58 || 0x4 || float Unknown
|-
|-
| 2 || GetReport
| 0x5C || 0x4 || float PositionX
|-
|-
| 3 || SetReport
| 0x60 || 0x4 || float PositionY
|-
|-
| 4 || GetIdle
| 0x64 || 0x4 || float Unknown
|-
|-
| 5 || SetIdle
| 0x68 || 0x2 || WindowOfInterestX
|-
| 0x6A || 0x2 || WindowOfInterestY
|-
| 0x6C || 0x2 || WindowOfInterestWidth
|-
| 0x6E || 0x2 || WindowOfInterestHeight
|}
 
===== PointingProcessorState =====
This is "nn::irsensor::PointingProcessorState".
 
This is created from [[#PointingProcessorMarkerState]].
 
{| class="wikitable" border="1"
|-
|-
| 6 || GetProtocol
! Offset || Size || Description
|-
|-
| 7 || SetProtocol
| 0x0 || 0x8 || SamplingNumber
|-
|-
| 8 || GetDescriptor
| 0x8 || 0x8 || TimeStamp
|-
|-
| 9 || SetDescriptor
| 0x10 || 0x4 || PointingStatus
|-
|-
| 10 || GetStateChangeEvent
| 0x14 || 0x4 || float PositionX
|-
|-
| 11 || SignalStateChangeEvent
| 0x18 || 0x4 || float PositionY
|-
|-
| 12 || [3.0.0+] Write
| 0x1C || 0x4 || Reserved
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
! Offset || Size || Description
|-
| 0x0 || 0x8 || SamplingNumber
|-
| 0x8 || 0x8 || TimeStamp
|-
| 0x10 || 0x4 || AmbientNoiseLevel
|-
|-
| 0 || [[#Read]]
| 0x14 || 0x12C || PluginData
|}
|}


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


[3.0.0+] Now takes a total of 8-bytes of input.
This is created from [[#TeraPluginProcessorState]].
 
== IWriteSession ==
This is "nn::ahid::IWriteSession".
 
This was removed with [3.0.0+].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
! Offset || Size || Description
|-
|-
| 0 || [[#Write]]
| 0x0 || 0x8 || SamplingNumber
|}
 
=== Write ===
This is the inverse of [[#IReadSession]] cmd0. Uses the OUTPUT endpoint with an input buffer.
 
= ahid:hdr =
This is "nn::ahid::hdr::ISession".
 
Used internally for USB HID devices.
 
This service no longer exists in [9.0.0+].
 
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
| 0x8 || 0x8 || TimeStamp
|-
|-
| 0 || GetDeviceEntries
| 0x10 || 0x4 || AmbientNoiseLevel
|-
|-
| 1 || GetDeviceList
| 0x14 || 0x4 || AccuracyLevel
|-
|-
| 2 || GetDeviceParameters
| 0x18 || 0x1 || ObjectCount
|-
|-
| 3 || AttachDevice
| 0x19 || 0x1 || BackgroundIntensity
|-
|-
| 4 || DetachDevice
| 0x1A || 0x6 || Reserved
|-
|-
| 5 || [6.0.0+] SetDeviceFilter
| 0x20 || 0x200 || Array of [[#AdaptiveClusteringData]]
|}
|}


= xcd:sys =
The array of [[#AdaptiveClusteringData]] can hold up to 16 entries.
This is "nn::xcd::detail::ISystemServer".


====== AdaptiveClusteringData ======
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
! Offset || Size || Description
|-
|-
| 0 || [[#GetDataFormat]]
| 0x0 || 0x4 || float CentroidX
|-
|-
| 1 || [[#SetDataFormat]]
| 0x4 || 0x4 || float CentroidY
|-
|-
| 2 || [[#GetMcuState]]
| 0x8 || 0x4 || float Area
|-
|-
| 3 || [[#SetMcuState]]
| 0xC || 0x4 || IsIncomplete
|}
 
===== HandAnalysisImageState =====
This is "nn::irsensor::HandAnalysisImageState".
 
This is created from [[#TeraPluginProcessorState]].
 
{| class="wikitable" border="1"
|-
|-
| 4 || [[#GetMcuVersionForNfc]]
! Offset || Size || Description
|-
|-
| 5 || [[#CheckNfcDevicePower]]
| 0x0 || 0x8 || SamplingNumber
|-
|-
| 6 || [5.0.0+] [[#SetMcuStateImmediate]]
| 0x8 || 0x4 || AmbientNoiseLevel
|-
|-
| 10 || [[#SetNfcEvent]]
| 0xC || 0x960 || Image
|-
|-
| 11 || [[#GetNfcInfo]]
| 0x96C || 0x4 || Reserved
|-
|}
| 12 || StartNfcDiscovery
 
===== HandAnalysisSilhouetteState =====
This is "nn::irsensor::HandAnalysisSilhouetteState".
 
This is created from [[#TeraPluginProcessorState]].
 
{| class="wikitable" border="1"
|-
|-
| 13 || StopNfcDiscovery
! Offset || Size || Description
|-
|-
| 14 || StartNtagRead
| 0x0 || 0x8 || SamplingNumber
|-
|-
| 15 || StartNtagWrite
| 0x8 || 0x4 || AmbientNoiseLevel
|-
|-
| 16 || SendNfcRawData
| 0xC || 0x1354 || Unknown
|}
 
===== HandAnalysisSilhouetteStateWithFullFrameShape =====
This is "nn::irsensor::HandAnalysisSilhouetteStateWithFullFrameShape".
 
This is created from [[#TeraPluginProcessorState]].
 
{| class="wikitable" border="1"
|-
|-
| 17 || RegisterMifareKey
! Offset || Size || Description
|-
|-
| 18 || ClearMifareKey
| 0x0 || 0x8 || SamplingNumber
|-
|-
| 19 || StartMifareRead
| 0x8 || 0x4 || AmbientNoiseLevel
|-
|-
| 20 || StartMifareWrite
| 0xC || 0x156C || Unknown
|}
 
=== AruidFormat ===
{| class="wikitable" border="1"
|-
|-
| 101 || GetAwakeTriggerReasonForLeftRail
! Offset || Size || Description
|-
|-
| 102 || GetAwakeTriggerReasonForRightRail
| 0x0 || 0x8 || IrSensorAruid
|-
|-
| 103 || [10.0.0+] GetAwakeTriggerBatteryLevelTransitionForLeftRail
| 0x8 || 0x8 || IrSensorAruidStatus
|-
| 104 || [10.0.0+] GetAwakeTriggerBatteryLevelTransitionForRightRail
|}
|}


[5.0.0+] SetDataFormat, SetMcuState, and ClearMifareKey: now takes a total of 0xC-bytes of input instead of 0x10.
== StopImageProcessor ==
Takes a PID-descriptor, an [[#IrCameraHandle]], and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]]. No output.


== GetDataFormat ==
== RunMomentProcessor ==
Takes an input 8-byte handle, returns an output u8.
Takes a PID-descriptor, an [[#IrCameraHandle]], an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], and a [[#PackedMomentProcessorConfig]]. No output.


== SetDataFormat ==
== RunClusteringProcessor ==
Takes an input u8 and a 8-byte handle (4-byte alignment), no output.
Takes a PID-descriptor, an [[#IrCameraHandle]], an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], and a [[#PackedClusteringProcessorConfig]]. No output.


== GetMcuState ==
== RunImageTransferProcessor ==
Takes an input 8-byte handle, returns an output u8.
Takes a PID-descriptor, an [[#IrCameraHandle]], an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], a [[#PackedImageTransferProcessorConfig]], an u64 for the TransferMemory's size, and a TransferMemory handle. No output.


== SetMcuState ==
The TransferMemory is created with an user specified buffer and permission none.
Takes an input u8 and a 8-byte handle (4-byte alignment), no output.


== GetMcuVersionForNfc ==
== GetImageTransferProcessorState ==
Takes an input 8-byte handle, returns an output 0x20-byte struct.
Takes a PID-descriptor, a type-0x6 output buffer, an [[#IrCameraHandle]], and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]]. Returns an [[#ImageTransferProcessorState]]. No output.


== CheckNfcDevicePower ==
== RunTeraPluginProcessor==
Takes an input 8-byte handle, no output.
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedTeraPluginProcessorConfig]] (immediately after the previous word), and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]]. No output.
 
== GetNpadIrCameraHandle ==
Takes an input [[#NpadIdType]]. Returns an output [[#IrCameraHandle]].
 
== RunPointingProcessor ==
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedPointingProcessorConfig]] (immediately after the previous word), and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]]. No output.
 
== SuspendImageProcessor ==
Takes a PID-descriptor, an [[#IrCameraHandle]], and an [[Applet_Manager_services#AppletResourceUserId|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 [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]]. No output.


== SetMcuStateImmediate ==
sdknso didn't actually use this until 4.x (the RequiredMcuVersion was also updated with that version).
Takes an input u8 and a 8-byte handle (4-byte alignment), no output.


== SetNfcEvent ==
== SetFunctionLevel ==
Takes an input 8-byte handle, returns 2 output Event handles.
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedFunctionLevel]], and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]]. No output.


== GetNfcInfo ==
== RunImageTransferExProcessor ==
Takes an input 8-byte handle and a type-0x1A output buffer.
Takes a PID-descriptor, an [[#IrCameraHandle]], an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]], a [[#PackedImageTransferProcessorExConfig]], an u64 for the TransferMemory's size, and a TransferMemory handle. No output.


[6.0.0+]: The buffer type is now 0x32 instead of 0x1A.
The TransferMemory is created with an user specified buffer and permission none.


This buffer contains a 0x804-byte struct, for the NFC data sent in response to the various other cmds.
== RunIrLedProcessor ==
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedIrLedProcessorConfig]] (immediately after the previous word), and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]]. No output.


= hidbus =
== StopImageProcessorAsync ==
This is "nn::hidbus::IHidbusServer".
Takes a PID-descriptor, an [[#IrCameraHandle]], and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]]. No output.


This was added with [5.0.0+].
== ActivateIrsensorWithFunctionLevel ==
Takes a PID-descriptor, an [[#PackedFunctionLevel]], and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]]. 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.
= irs:sys =
This is "nn::irsensor::IIrSensorSystemServer".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,097: Line 3,493:
! Cmd || Name
! Cmd || Name
|-
|-
| 1 || [[#GetBusHandle]]
| 500 || [[#SetAppletResourceUserId_3|#SetAppletResourceUserId]]
|-
|-
| 2 || [[#IsExternalDeviceConnected]]
| 501 || [[#RegisterAppletResourceUserId_3|#RegisterAppletResourceUserId]]
|-
|-
| 3 || [[#Initialize]]
| 502 || [[#UnregisterAppletResourceUserId_3|#UnregisterAppletResourceUserId]]
|-
|-
| 4 || [[#Finalize]]
| 503 || [[#EnableAppletToGetInput_2|#EnableAppletToGetInput]]
|}
 
== SetAppletResourceUserId ==
Takes an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]]. No output.
 
== RegisterAppletResourceUserId ==
Takes a bool and an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]]. No output.
 
== UnregisterAppletResourceUserId ==
Takes an [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]]. No output.
 
== EnableAppletToGetInput ==
Takes a bool and an [[Applet_Manager_services#AppletResourceUserId|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"
|-
|-
| 5 || [[#EnableExternalDevice]]
! Cmd || Name
|-
|-
| 6 || [[#GetExternalDeviceId]]
| 0 || [[#AcquireDevice]]
|-
|-
| 7 || [[#SendCommandAsync]]
| 1 || [[#ReleaseDevice]]
|-
|-
| 8 || [[#GetSendCommandAsynceResult]]
| 2 || [[#GetCtrlSession]]
|-
|-
| 9 || [[#SetEventForSendCommandAsycResult]]
| 3 || [[#GetReadSession]]
|-
|-
| 10 || [[#GetSharedMemoryHandle]]
| 4 || [1.0.0-2.3.0] [[#GetWriteSession]]
|-
| 11 || [[#EnableJoyPollingReceiveMode]]
|-
| 12 || [[#DisableJoyPollingReceiveMode]]
|-
| 13 || [5.0.0-6.2.0] GetPollingData
|-
| 14 || [6.0.0+] [[#SetStatusManagerType]]
|}
|}


sdknso doesn't use the GetPollingData cmd.
== AcquireDevice ==
Takes an input s32, no output.


== GetBusHandle ==
== ReleaseDevice ==
Takes an input u32 [[#NpadIdType]], an u64 [[#BusType]] and an u64 [[AM_services|AppletResourceUserId]]. Returns an output bool '''HasHandle''' and a [[#BusHandle]].
Takes an input s32, no output.


'''HasHandle''' indicates whether the [[#BusHandle]] is valid.
== GetCtrlSession ==
Takes an input u32, returns an [[#ICtrlSession]].


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.
== GetReadSession ==
Takes an input u32, returns an [[#IReadSession]].


This cmd will throw an error when [[#BusType]] is invalid.
== GetWriteSession ==
Takes an input u32, returns an [[#IWriteSession]].


== IsExternalDeviceConnected ==
== ICtrlSession ==
Takes an input [[#BusHandle]]. Returns an output bool '''IsAttached'''.
This is "nn::ahid::ICtrlSession".


This is not used by sdknso.
This no longer exists in [9.0.0+].


== Initialize ==
{| class="wikitable" border="1"
Takes an input [[#BusHandle]] and an u64 [[AM_services|AppletResourceUserId]]. No output.
|-
 
! Cmd || Name
Prior to using this cmd, sdknso handles [[#GetSharedMemoryHandle|sharedmem]] mapping if not done previously.
|-
 
| 0 || GetString
== Finalize ==
|-
Takes an input [[#BusHandle]] and an u64 [[AM_services|AppletResourceUserId]]. No output.
| 1 || GetCodeBook
 
|-
== EnableExternalDevice ==
| 2 || GetReport
Takes an input bool '''IsEnabled''', a [[#BusHandle]], an u64 '''Version''' and an u64 [[AM_services|AppletResourceUserId]]. No output.
|-
 
| 3 || SetReport
sdknso passes value 0x38900050018 (0x3A600050018 with 7.x+) for '''Version'''.
|-
 
| 4 || GetIdle
'''IsEnabled''' indicates whether to enable the device (true = enable, false = disable).  When false, this will use [[#DisableJoyPollingReceiveMode]] if needed.
|-
 
| 5 || SetIdle
== 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
| 6 || GetProtocol
|-
|-
| 0x0 || 0x1 || IsConnected
| 7 || SetProtocol
|-
|-
| 0x1 || 0x3 || Reserved
| 8 || GetDescriptor
|-
|-
| 0x4 || 0x4 || IsConnectedResult
| 9 || SetDescriptor
|-
|-
| 0x8 || 0x1 || IsEnabled. Bool flag indicating whether a device is [[#EnableExternalDevice|enabled]].
| 10 || GetStateChangeEvent
|-
|-
| 0x9 || 0x1 || IsInFocus. Bool flag indicating whether this entry is valid.
| 11 || SignalStateChangeEvent
|-
|-
| 0xA || 0x1 || IsPollingMode. Bool flag indicating whether polling is [[#EnableJoyPollingReceiveMode|enabled]].
| 12 || [3.0.0+] Write
|-
| 0xB || 0x1 || Reserved
|-
| 0xC || 0x4 || [[#JoyPollingMode|PollingMode]]
|}
|}


== EnableJoyPollingReceiveMode ==
All of these use USB [[USB_services|CtrlXfer]], except for GetStateChangeEvent and SignalStateChangeEvent, and GetCodeBook which copies 0x4000-bytes from state to output.
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--.
== IReadSession ==
This is "nn::ahid::IReadSession".


The content of the TransferMemory depends of the [[#JoyPollingMode]]. This is used by GetJoyPollingReceivedData. Structure of the TransferMemory (DisableSixAxisPollingDataAccessor, EnableSixAxisPollingDataAccessor, JoyButtonOnlyPollingDataAccessor):
This no longer exists in [9.0.0+].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Cmd || Name
|-
|-
| 0x0 || 0x4 || Result.
| 0 || [[#Read]]
|-
|}
| 0x0 || 0x4 || Padding.
 
|-
=== Read ===
| 0x8 || 0x18 || Initialized sysmodule-side, not used by sdknso.
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.
|-
 
| 0x20 || 0x8 || Latest entry.
[3.0.0+] Now takes a total of 8-bytes of input.
|-
| 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:
== IWriteSession ==
This is "nn::ahid::IWriteSession".


DisableSixAxisPollingDataAccessor:
This was removed with [3.0.0+].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Cmd || Name
|-
|-
| 0x0 || 0x26 || Data
| 0 || [[#Write]]
|-
| 0x26 || 0x1 || Size of data.
|-
| 0x27 || 0x1 || Padding
|-
| 0x28 || 0x8 || Timestamp
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Cmd || Name
|-
| 0 || GetDeviceEntries
|-
| 1 || GetDeviceList
|-
|-
| 0x0 || 0x8 || Data
| 2 || GetDeviceParameters
|-
|-
| 0x8 || 0x1 || Size of data.
| 3 || AttachDevice
|-
|-
| 0x9 || 0x7 || Padding
| 4 || DetachDevice
|-
|-
| 0x10 || 0x8 || Timestamp
| 5 || [6.0.0+] SetDeviceFilter
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Cmd || Name
|-
|-
| 0x0 || 0x2C || Data
| 0 || [[#GetDataFormat]]
|-
|-
| 0x2C || 0x1 || Size of data.
| 1 || [[#SetDataFormat]]
|-
|-
| 0x2D || 0x3 || Padding
| 2 || [[#GetMcuState]]
|-
|-
| 0x30 || 0x8 || Timestamp
| 3 || [[#SetMcuState]]
|}
 
== 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"
|-
|-
! Offset
| 4 || [[#GetMcuVersionForNfc]]
! Size
! Description
|-
|-
| 0x0
| 5 || [[#CheckNfcDevicePower]]
| 0x400
| [[#DebugPadSharedMemoryFormat|DebugPad]]
|-
|-
| 0x400
| 6 || [5.0.0+] [[#SetMcuStateImmediate]]
| 0x3000
| [[#TouchScreenSharedMemoryFormat|TouchScreen]]
|-
|-
| 0x3400
| 10 || [[#SetNfcEvent]]
| 0x400
| [[#MouseSharedMemoryFormat|Mouse]]
|-
|-
| 0x3800
| 11 || [[#GetNfcInfo]]
| 0x400
| [[#KeyboardSharedMemoryFormat|Keyboard]]
|-
|-
| 0x3C00
| 12 || StartNfcDiscovery
| 0x1000
| [[#DigitizerSharedMemoryFormat|Digitizer]] ([1.0.0-9.2.0] [[#BasicXpadSharedMemoryFormat|BasicXpad]])
|-
|-
| 0x4C00
| 13 || StopNfcDiscovery
| 0x200
| [[#HomeButtonSharedMemoryFormat|HomeButton]]
|-
|-
| 0x4E00
| 14 || StartNtagRead
| 0x200
| [[#SleepButtonSharedMemoryFormat|SleepButton]]
|-
|-
| 0x5000
| 15 || StartNtagWrite
| 0x200
| [[#CaptureButtonSharedMemoryFormat|CaptureButton]]
|-
|-
| 0x5200
| 16 || SendNfcRawData
| 0x800
| [[#InputDetectorSharedMemoryFormat|InputDetector]]
|-
|-
| 0x5A00
| 17 || RegisterMifareKey
| 0x4000
| [1.0.0-4.1.0] [[#UniquePadSharedMemoryFormat|UniquePad]]
|-
|-
| 0x9A00
| 18 || ClearMifareKey
| 0x32000
|-
| [[#NpadSharedMemoryFormat|Npad]]
| 19 || StartMifareRead
|-
|-
| 0x3BA00
| 20 || StartMifareWrite
| 0x800
| [[#GestureSharedMemoryFormat|Gesture]]
|-
|-
| 0x3C200
| 101 || GetAwakeTriggerReasonForLeftRail
| 0x1C
| [5.0.0+] [[#ConsoleSixAxisSensorSharedMemoryFormat|ConsoleSixAxisSensor]]
|-
|-
| 0x3DC00
| 102 || GetAwakeTriggerReasonForRightRail
| 0x400
| [16.0.0+] [[#MouseSharedMemoryFormat|DebugMouse]]
|}
 
== DebugPadSharedMemoryFormat ==
This is "nn::hid::detail::DebugPadSharedMemoryFormat".
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 103 || [10.0.0+] GetAwakeTriggerBatteryLevelTransitionForLeftRail
! Size
! Description
|-
|-
| 0x0
| 104 || [10.0.0+] GetAwakeTriggerBatteryLevelTransitionForRightRail
| 0x2C8
| [[#DebugPadLifo]]
|}
|}


=== DebugPadLifo ===
[5.0.0+] SetDataFormat, SetMcuState, and ClearMifareKey: now takes a total of 0xC-bytes of input instead of 0x10.
This is "nn::hid::detail::DebugPadLifo". This is a RingLifo object.


{| class="wikitable" border="1"
== GetDataFormat ==
|-
Takes an input 8-byte handle, returns an output u8.
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| RingLifoVptr
|-
| 0x8
| 0x8
| BufferCount
|-
| 0x10
| 0x8
| Tail
|-
| 0x18
| 0x8
| Count
|-
| 0x20
| 0x28 * 17
| Array of [[#DebugPadStateAtomicStorage]]
|}


==== DebugPadStateAtomicStorage ====
== SetDataFormat ==
This is "nn::hid::detail::DebugPadStateAtomicStorage".
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.
 
[S2] Official sw no longer supports this (this service still exists for S1-compat however).


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Cmd || Name
! Size
! Description
|-
|-
| 0x0
| 1 || [[#GetBusHandle]]
| 0x8
| SamplingNumber
|-
|-
| 0x8
| 2 || [[#IsExternalDeviceConnected]]
| 0x20
| [[#DebugPadState]]
|}
 
===== DebugPadState =====
This is "nn::hid::DebugPadState".
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 3 || [[#Initialize]]
! Size
! Description
|-
|-
| 0x0
| 4 || [[#Finalize]]
| 0x8
| SamplingNumber
|-
|-
| 0x8
| 5 || [[#EnableExternalDevice]]
| 0x4
| [[#DebugPadAttributeSet|Attributes]]
|-
|-
| 0xC
| 6 || [[#GetExternalDeviceId]]
| 0x4
| [[#DebugPadButtonSet|Buttons]]
|-
|-
| 0x10
| 7 || [[#SendCommandAsync]]
| 0x8
| [[#AnalogStickState|AnalogStickR]]
|-
|-
| 0x18
| 8 || [[#GetSendCommandAsynceResult]]
| 0x8
| [[#AnalogStickState|AnalogStickL]]
|}
 
== TouchScreenSharedMemoryFormat ==
This is "nn::hid::detail::TouchScreenSharedMemoryFormat".
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 9 || [[#SetEventForSendCommandAsycResult]]
! Size
! Description
|-
|-
| 0x0
| 10 || [[#GetSharedMemoryHandle]]
| 0x2C38
| [[#TouchScreenLifo]]
|}
 
=== TouchScreenLifo ===
This is "nn::hid::detail::TouchScreenLifo". This is a RingLifo object.
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 11 || [[#EnableJoyPollingReceiveMode]]
! Size
! Description
|-
|-
| 0x0
| 12 || [[#DisableJoyPollingReceiveMode]]
| 0x8
| RingLifoVptr
|-
|-
| 0x8
| 13 || [5.0.0-6.2.0] GetPollingData
| 0x8
| BufferCount
|-
|-
| 0x10
| 14 || [6.0.0+] [[#SetStatusManagerType]]
| 0x8
| Tail
|-
| 0x18
| 0x8
| Count
|-
| 0x20
| 0x298 * 17
| Array of [[#TouchScreenStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
== GetBusHandle ==
|-
Takes an input u32 [[#NpadIdType]], an u64 [[#BusType]] and an u64 [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]]. Returns an output bool '''HasHandle''' and a [[#BusHandle]].
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| SamplingNumber
|-
| 0x8
| 0x290
| [[#TouchScreenState]]
|}


===== TouchScreenState =====
'''HasHandle''' indicates whether the [[#BusHandle]] is valid.
This is "nn::hid::detail::TouchScreenState" / "nn::hid::TouchScreenState".


{| class="wikitable" border="1"
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.
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| SamplingNumber
|-
| 0x8
| 0x4
| s32 Count
|-
| 0xC
| 0x4
| Reserved
|-
| 0x10
| 0x28 * 16
| [[#TouchState|Touches]]
|}


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


{| class="wikitable" border="1"
== IsExternalDeviceConnected ==
|-
Takes an input [[#BusHandle]]. Returns an output bool '''IsAttached'''.
! Offset
! Size
! Description
|-
| 0x0
| 0x350
| [[#MouseLifo]]
|}


=== MouseLifo ===
This is not used by sdknso.
This is "nn::hid::detail::MouseLifo". This is a RingLifo object.
 
== Initialize ==
Takes an input [[#BusHandle]] and an u64 [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]]. No output.
 
Prior to using this cmd, sdknso handles [[#GetSharedMemoryHandle|sharedmem]] mapping if not done previously.
 
== Finalize ==
Takes an input [[#BusHandle]] and an u64 [[Applet_Manager_services#AppletResourceUserId|AppletResourceUserId]]. No output.
 
== EnableExternalDevice ==
Takes an input bool '''IsEnabled''', a [[#BusHandle]], an u64 '''Version''' and an u64 [[Applet_Manager_services#AppletResourceUserId|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"
{| class="wikitable" border="1"
|-
|-
! Offset
! Offset || Size || Description
! Size
|-
! Description
| 0x0 || 0x1 || IsConnected
|-
|-
| 0x0
| 0x1 || 0x3 || Reserved
| 0x8
| RingLifoVptr
|-
|-
| 0x8
| 0x4 || 0x4 || IsConnectedResult
| 0x8
| BufferCount
|-
|-
| 0x10
| 0x8 || 0x1 || IsEnabled. Bool flag indicating whether a device is [[#EnableExternalDevice|enabled]].
| 0x8
| Tail
|-
|-
| 0x18
| 0x9 || 0x1 || IsInFocus. Bool flag indicating whether this entry is valid.
| 0x8
| Count
|-
|-
| 0x20
| 0xA || 0x1 || IsPollingMode. Bool flag indicating whether polling is [[#EnableJoyPollingReceiveMode|enabled]].
| 0x30 * 17
|-
| Array of [[#MouseStateAtomicStorage]]
| 0xB || 0x1 || Reserved
|-
| 0xC || 0x4 || [[#JoyPollingMode|PollingMode]]
|}
|}


==== MouseStateAtomicStorage ====
== EnableJoyPollingReceiveMode ==
This is "nn::hid::detail::MouseStateAtomicStorage".
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 || 0x4 || Result.
|-
| 0x0 || 0x4 || Padding.
|-
| 0x8 || 0x18 || Initialized sysmodule-side, not used by sdknso.
|-
|-
| 0x0
| 0x20 || 0x8 || Latest entry.
| 0x8
| SamplingNumber
|-
|-
| 0x8
| 0x28 || 0x8 || Total entries.
| 0x28
| [[#MouseState]]
|}
|}


===== MouseState =====
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::MouseState".
 
DisableSixAxisPollingDataAccessor:


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Offset || Size || Description
! Size
! Description
|-
|-
| 0x0
| 0x0 || 0x26 || Data
| 0x8
| SamplingNumber
|-
|-
| 0x8
| 0x26 || 0x1 || Size of data.
| 0x4
| X
|-
|-
| 0xC
| 0x27 || 0x1 || Padding
| 0x4
| Y
|-
|-
| 0x10
| 0x28 || 0x8 || Timestamp
| 0x4
|}
| DeltaX
 
JoyEnableSixAxisPollingDataAccessor:
 
{| class="wikitable" border="1"
|-
|-
| 0x14
! Offset || Size || Description
| 0x4
| DeltaY
|-
|-
| 0x18
| 0x0 || 0x8 || Data
| 0x4
| WheelDeltaX
|-
|-
| 0x1C
| 0x8 || 0x1 || Size of data.
| 0x4
| WheelDeltaY
|-
|-
| 0x20
| 0x9 || 0x7 || Padding
| 0x4
| [[#MouseButtonSet|Buttons]]
|-
|-
| 0x24
| 0x10 || 0x8 || Timestamp
| 0x4
| [[#MouseAttributeSet|Attributes]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Offset || Size || Description
! Size
|-
! Description
| 0x0 || 0x2C || Data
|-
| 0x2C || 0x1 || Size of data.
|-
| 0x2D || 0x3 || Padding
|-
|-
| 0x0
| 0x30 || 0x8 || Timestamp
| 0x3D8
| [[#KeyboardLifo]]
|}
|}


=== KeyboardLifo ===
== DisableJoyPollingReceiveMode ==
This is "nn::hid::detail::KeyboardLifo". This is a RingLifo object.
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"
{| class="wikitable" border="1"
Line 3,662: Line 3,942:
|-
|-
| 0x0
| 0x0
| 0x8
| 0x400
| RingLifoVptr
| [[#DebugPadSharedMemoryFormat|DebugPad]]
|-
|-
| 0x8
| 0x400
| 0x8
| 0x3000
| BufferCount
| [[#TouchScreenSharedMemoryFormat|TouchScreen]]
|-
|-
| 0x10
| 0x3400
| 0x8
| 0x400
| Tail
| [[#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]]
|-
|-
| 0x18
| 0x3DC00
| 0x8
| 0x400
| Count
| [16.0.0+] [[#MouseSharedMemoryFormat|DebugMouse]]
|-
|-
| 0x20
| 0x3E200
| 0x38 * 17
| ?
| Array of [[#KeyboardStateAtomicStorage]]
| [?+] NpadCondition
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,692: Line 4,012:
|-
|-
| 0x0
| 0x0
| 0x8
| 0x2C8
| SamplingNumber
| [[#DebugPadLifo]]
|-
| 0x8
| 0x30
| [[#KeyboardState]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,711: Line 4,027:
| 0x0
| 0x0
| 0x8
| 0x8
| SamplingNumber
| RingLifoVptr
|-
|-
| 0x8
| 0x8
| 0x8
| 0x8
| [[#KeyboardModifierSet|Modifiers]]
| BufferCount
|-
|-
| 0x10
| 0x10
| 0x8
| Tail
|-
| 0x18
| 0x8
| Count
|-
| 0x20
| 0x20
| [[#KeyboardKeySet|Keys]]
| 0x28 * 17
| Array of [[#DebugPadStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,732: Line 4,056:
|-
|-
| 0x0
| 0x0
| 0x400 * 4
| 0x8
| Array of [[#BasicXpadSharedMemoryEntry]]
| SamplingNumber
|-
| 0x8
| 0x20
| [[#DebugPadState]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,746: Line 4,074:
|-
|-
| 0x0
| 0x0
| 0x2C8
| 0x8
| [[#BasicXpadLifo]]
| SamplingNumber
|-
| 0x8
| 0x4
| [[#DebugPadAttributeSet|Attributes]]
|-
| 0xC
| 0x4
| [[#DebugPadButtonSet|Buttons]]
|-
| 0x10
| 0x8
| [[#AnalogStickState|AnalogStickR]]
|-
| 0x18
| 0x8
| [[#AnalogStickState|AnalogStickL]]
|}
|}


==== BasicXpadLifo ====
== TouchScreenSharedMemoryFormat ==
This is "nn::hid::detail::BasicXpadLifo". This is a RingLifo object.
This is "nn::hid::detail::TouchScreenSharedMemoryFormat".
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x2C38
| [[#TouchScreenLifo]]
|}
 
=== TouchScreenLifo ===
This is "nn::hid::detail::TouchScreenLifo". This is a RingLifo object.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,776: Line 4,134:
|-
|-
| 0x20
| 0x20
| 0x28 * 17
| 0x298 * 17
| Array of [[#BasicXpadStateAtomicStorage]]
| Array of [[#TouchScreenStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,794: Line 4,152:
|-
|-
| 0x8
| 0x8
| 0x20
| 0x290
| [[#BasicXpadState]]
| [[#TouchScreenState]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,813: Line 4,171:
| 0x8
| 0x8
| 0x4
| 0x4
| [[#BasicXpadAttributeSet|Attributes]]
| s32 Count
|-
|-
| 0xC
| 0xC
| 0x4
| 0x4
| [[#BasicXpadButtonSet|Buttons]]
| Reserved
|-
|-
| 0x10
| 0x10
| 0x8
| 0x28 * 16
| [[#AnalogStickState|AnalogStickL]]
| [[#TouchState|Touches]]
|-
| 0x18
| 0x8
| [[#AnalogStickState|AnalogStickR]]
|}
|}


== DigitizerSharedMemoryFormat ==
== MouseSharedMemoryFormat ==
This is "nn::hid::server::DigitizerSharedMemoryFormat".
This is "nn::hid::detail::MouseSharedMemoryFormat".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,838: Line 4,192:
|-
|-
| 0x0
| 0x0
| 0x680
| 0x350
| [[#DigitizerLifo]]
| [[#MouseLifo]]
|}
|}


=== DigitizerLifo ===
=== MouseLifo ===
This is "nn::hid::server::DigitizerLifo". 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 3,868: Line 4,222:
|-
|-
| 0x20
| 0x20
| 0x60 * 17
| 0x30 * 17
| Array of [[#DigitizerStateAtomicStorage]]
| Array of [[#MouseStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,886: Line 4,240:
|-
|-
| 0x8
| 0x8
| 0x58
| 0x28
| [[#DigitizerState]]
| [[#MouseState]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,905: Line 4,259:
| 0x8
| 0x8
| 0x4
| 0x4
|  
| X
|-
|-
| 0xC
| 0xC
| 0x4
| 0x4
|  
| Y
|-
|-
| 0x10
| 0x10
| 0x4
| 0x4
| [[#DigitizerAttributeSet|Attributes]]
| DeltaX
|-
|-
| 0x14
| 0x14
| 0x4
| 0x4
| [[#DigitizerButtonSet|Buttons]]
| DeltaY
|-
|-
| 0x18
| 0x18
| 0x4
| 0x4
|  
| WheelDeltaX
|-
|-
| 0x1C
| 0x1C
| 0x4
| 0x4
|  
| WheelDeltaY
|-
|-
| 0x20
| 0x20
| 0x4
| 0x4
|  
| [[#MouseButtonSet|Buttons]]
|-
|-
| 0x24
| 0x24
| 0x4
| 0x4
|  
| [[#MouseAttributeSet|Attributes]]
|}
 
== KeyboardSharedMemoryFormat ==
This is "nn::hid::detail::KeyboardSharedMemoryFormat".
 
{| class="wikitable" border="1"
|-
|-
| 0x28
! Offset
| 0x4
! Size
|
! Description
|-
|-
| 0x2C
| 0x0
| 0x4
| 0x3D8
|  
| [[#KeyboardLifo]]
|}
 
=== KeyboardLifo ===
This is "nn::hid::detail::KeyboardLifo". This is a RingLifo object.
 
{| class="wikitable" border="1"
|-
|-
| 0x30
! Offset
| 0x4
! Size
|
! Description
|-
|-
| 0x34
| 0x0
| 0x4
| 0x8
|  
| RingLifoVptr
|-
|-
| 0x38
| 0x8
| 0x4
| 0x8
|  
| BufferCount
|-
|-
| 0x3C
| 0x10
| 0x4
| 0x8
|  
| Tail
|-
|-
| 0x40
| 0x18
| 0x4
| 0x8
|  
| Count
|-
|-
| 0x44
| 0x20
| 0x4
| 0x38 * 17
|
| Array of [[#KeyboardStateAtomicStorage]]
|-
| 0x48
| 0x4
|
|-
| 0x4C
| 0x4
|
|-
| 0x50
| 0x4
|
|-
| 0x54
| 0x4
|  
|}
|}


== HomeButtonSharedMemoryFormat ==
==== KeyboardStateAtomicStorage ====
This is "nn::hid::detail::HomeButtonSharedMemoryFormat".
This is "nn::hid::detail::KeyboardStateAtomicStorage".
 
This is used by [[AM_services|AM]].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,996: Line 4,344:
|-
|-
| 0x0
| 0x0
| 0x1B8
| 0x8
| [[#HomeButtonLifo]]
| SamplingNumber
|-
| 0x8
| 0x30
| [[#KeyboardState]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,011: Line 4,363:
| 0x0
| 0x0
| 0x8
| 0x8
| RingLifoVptr
| SamplingNumber
|-
|-
| 0x8
| 0x8
| 0x8
| 0x8
| BufferCount
| [[#KeyboardModifierSet|Modifiers]]
|-
|-
| 0x10
| 0x10
| 0x8
| 0x20
| Tail
| [[#KeyboardKeySet|Keys]]
|-
| 0x18
| 0x8
| Count
|-
| 0x20
| 0x18 * 17
| Array of [[#HomeButtonStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,040: Line 4,384:
|-
|-
| 0x0
| 0x0
| 0x8
| 0x400 * 4
| SamplingNumber
| Array of [[#BasicXpadSharedMemoryEntry]]
|-
| 0x8
| 0x10
| [[#HomeButtonState]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,058: Line 4,398:
|-
|-
| 0x0
| 0x0
| 0x8
| 0x2C8
| SamplingNumber
| [[#BasicXpadLifo]]
|-
| 0x8
| 0x8
| [[#HomeButtonSet|Buttons]]
|}
|}


== SleepButtonSharedMemoryFormat ==
==== BasicXpadLifo ====
This is "nn::hid::detail::SleepButtonSharedMemoryFormat".
This is "nn::hid::detail::BasicXpadLifo". This is a RingLifo object.
 
This is used by [[AM_services|AM]].
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x1B8
| [[#SleepButtonLifo]]
|}
 
=== SleepButtonLifo ===
This is "nn::hid::detail::SleepButtonLifo". This is a RingLifo object.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,108: Line 4,428:
|-
|-
| 0x20
| 0x20
| 0x18 * 17
| 0x28 * 17
| Array of [[#SleepButtonStateAtomicStorage]]
| Array of [[#BasicXpadStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,126: Line 4,446:
|-
|-
| 0x8
| 0x8
| 0x10
| 0x20
| [[#SleepButtonState]]
| [[#BasicXpadState]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,144: Line 4,464:
|-
|-
| 0x8
| 0x8
| 0x4
| [[#BasicXpadAttributeSet|Attributes]]
|-
| 0xC
| 0x4
| [[#BasicXpadButtonSet|Buttons]]
|-
| 0x10
| 0x8
| 0x8
| [[#SleepButtonSet|Buttons]]
| [[#AnalogStickState|AnalogStickL]]
|-
| 0x18
| 0x8
| [[#AnalogStickState|AnalogStickR]]
|}
|}


== CaptureButtonSharedMemoryFormat ==
== DigitizerSharedMemoryFormat ==
This is "nn::hid::detail::CaptureButtonSharedMemoryFormat".
This is "nn::hid::server::DigitizerSharedMemoryFormat".
 
This is used by [[AM_services|AM]].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,160: Line 4,490:
|-
|-
| 0x0
| 0x0
| 0x1B8
| 0x680
| [[#CaptureButtonLifo]]
| [[#DigitizerLifo]]
|}
|}


=== CaptureButtonLifo ===
=== DigitizerLifo ===
This is "nn::hid::detail::CaptureButtonLifo". 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,190: Line 4,520:
|-
|-
| 0x20
| 0x20
| 0x18 * 17
| 0x60 * 17
| Array of [[#CaptureButtonStateAtomicStorage]]
| Array of [[#DigitizerStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,208: Line 4,538:
|-
|-
| 0x8
| 0x8
| 0x10
| 0x58
| [[#CaptureButtonState]]
| [[#DigitizerState]]
|}
|}


===== CaptureButtonState =====
===== DigitizerState =====
This is "nn::hid::system::CaptureButtonState".
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,226: Line 4,558:
|-
|-
| 0x8
| 0x8
| 0x8
| 0x4
| [[#CaptureButtonSet|Buttons]]
|  
|}
|-
 
| 0xC
== InputDetectorSharedMemoryFormat ==
| 0x4
This is "nn::hid::detail::InputDetectorSharedMemoryFormat".
|  
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 0x10
! Size
| 0x4
! Description
| [[#DigitizerAttributeSet|Attributes]]
|-
|-
| 0x0
| 0x14
| 0x80 * 16
| 0x4
| Array of [[#InputDetectorSharedMemoryEntry]]
| [[#DigitizerButtonSet|Buttons]]
|}
 
=== InputDetectorSharedMemoryEntry ===
This is "nn::hid::detail::InputDetectorSharedMemoryEntry".
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 0x18
! Size
| 0x4
! Description
|
|-
|-
| 0x0
| 0x1C
| 0x50
| 0x4
| [[#InputDetectorLifo]]
|  
|}
 
==== InputDetectorLifo ====
This is "nn::hid::detail::InputDetectorLifo". This is a RingLifo object.
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 0x20
! Size
| 0x4
! Description
|
|-
|-
| 0x0
| 0x24
| 0x8
| 0x4
| RingLifoVptr
|  
|-
|-
| 0x8
| 0x28
| 0x8
| 0x4
| BufferCount
|  
|-
|-
| 0x10
| 0x2C
| 0x8
| 0x4
| Tail
|
|-
| 0x30
| 0x4
|
|-
| 0x34
| 0x4
|
|-
| 0x38
| 0x4
|
|-
| 0x3C
| 0x4
|
|-
| 0x40
| 0x4
|
|-
| 0x44
| 0x4
|
|-
| 0x48
| 0x4
|
|-
| 0x4C
| 0x4
|  
|-
|-
| 0x18
| 0x50
| 0x8
| 0x4
| Count
|  
|-
|-
| 0x20
| 0x54
| 0x18 * 2
| 0x4
| Array of [[#InputDetectorStateAtomicStorage]]
|  
|}
|}


===== InputDetectorStateAtomicStorage =====
== HomeButtonSharedMemoryFormat ==
This is "nn::hid::detail::InputDetectorStateAtomicStorage".
This is "nn::hid::detail::HomeButtonSharedMemoryFormat".
 
This is used by [[AM_services|AM]].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,298: Line 4,650:
|-
|-
| 0x0
| 0x0
| 0x8
| 0x1B8
| SamplingNumber
| [[#HomeButtonLifo]]
|-
| 0x8
| 0x10
| [[#InputDetectorState]]
|}
|}


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


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


== UniquePadSharedMemoryFormat ==
==== HomeButtonStateAtomicStorage ====
This is "nn::hid::detail::UniquePadSharedMemoryFormat".
This is "nn::hid::detail::HomeButtonStateAtomicStorage".
 
[5.0.0+] This section has been removed from [[#SharedMemoryFormat]]. [[#UniquePadSharedMemoryFormat]] is now a specialization of [[#NpadSharedMemoryFormat]].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,336: Line 4,694:
|-
|-
| 0x0
| 0x0
| 0x400 * 16
| 0x8
| Array of [[#UniquePadSharedMemoryEntry]]
| SamplingNumber
|-
| 0x8
| 0x10
| [[#HomeButtonState]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,350: Line 4,712:
|-
|-
| 0x0
| 0x0
| 0x1E0
| 0x8
| [[#UniquePadLifo]]
| SamplingNumber
|-
| 0x8
| 0x8
| [[#HomeButtonSet|Buttons]]
|}
|}


=== UniquePadLifo ===
== SleepButtonSharedMemoryFormat ==
This is "nn::hid::detail::UniquePadLifo". This is a RingLifo object.
This is "nn::hid::detail::SleepButtonSharedMemoryFormat".
 
This is used by [[AM_services|AM]].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,364: Line 4,732:
|-
|-
| 0x0
| 0x0
| 0x80
| 0x1B8
| [[#UniquePadConfigLifo]]
| [[#SleepButtonLifo]]
|}
 
=== SleepButtonLifo ===
This is "nn::hid::detail::SleepButtonLifo". This is a RingLifo object.
 
{| class="wikitable" border="1"
|-
|-
| 0x80
! Offset
| 0x70 * 2
| Array of [[#AnalogStickCalibrationStateImplLifo]]
|-
| 0x160
| 0x40
| [[#SixAxisSensorUserCalibrationStateLifo]]
|-
| 0x1A0
| 0x40
| UniquePadConfigMutex
|}
 
==== UniquePadConfigLifo ====
This is "nn::hid::detail::UniquePadConfigLifo". This is a RingLifo object.
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Size
! Description
! Description
Line 4,406: Line 4,762:
|-
|-
| 0x20
| 0x20
| 0x30 * 2
| 0x18 * 17
| Array of [[#UniquePadConfigAtomicStorage]]
| Array of [[#SleepButtonStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,424: Line 4,780:
|-
|-
| 0x8
| 0x8
| 0x28
| 0x10
| [[#UniquePadConfig]]
| [[#SleepButtonState]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,438: Line 4,794:
|-
|-
| 0x0
| 0x0
| 0x4
| 0x8
| [[#UniquePadType|Type]]
| SamplingNumber
|-
| 0x4
| 0x4
| [[#UniquePadInterface|Interface]]
|-
|-
| 0x8
| 0x8
| 0x10
| [[#UniquePadSerialNumber|SerialNumber]]
|-
| 0x18
| 0x4
| ControllerNumber
|-
| 0x1C
| 0x1
| IsActive
|-
| 0x1D
| 0x3
| Reserved
|-
| 0x20
| 0x8
| 0x8
| SamplingNumber
| [[#SleepButtonSet|Buttons]]
|}
|}


==== AnalogStickCalibrationStateImplLifo ====
== CaptureButtonSharedMemoryFormat ==
This is "nn::hid::detail::AnalogStickCalibrationStateImplLifo". This is a RingLifo object.
This is "nn::hid::detail::CaptureButtonSharedMemoryFormat".
 
This is used by [[AM_services|AM]].
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x1B8
| [[#CaptureButtonLifo]]
|}
 
=== CaptureButtonLifo ===
This is "nn::hid::detail::CaptureButtonLifo". This is a RingLifo object.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,492: Line 4,844:
|-
|-
| 0x20
| 0x20
| 0x28 * 2
| 0x18 * 17
| Array of [[#AnalogStickCalibrationStateImplAtomicStorage]]
| Array of [[#CaptureButtonStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,510: Line 4,862:
|-
|-
| 0x8
| 0x8
| 0x20
| 0x10
| [[#AnalogStickCalibrationStateImpl]]
| [[#CaptureButtonState]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,525: Line 4,877:
| 0x0
| 0x0
| 0x8
| 0x8
| [[#AnalogStickState|State]]
| SamplingNumber
|-
|-
| 0x8
| 0x8
| 0x8
| 0x8
| [[#AnalogStickCalibrationFlagsSet|Flags]]
| [[#CaptureButtonSet|Buttons]]
|}
 
== InputDetectorSharedMemoryFormat ==
This is "nn::hid::detail::InputDetectorSharedMemoryFormat".
 
{| class="wikitable" border="1"
|-
|-
| 0x10
! Offset
| 0x8
! Size
| [[#AnalogStickManualCalibrationStage|Stage]]
! Description
|-
|-
| 0x18
| 0x0
| 0x8
| 0x80 * 16
| SamplingNumber
| Array of [[#InputDetectorSharedMemoryEntry]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,550: Line 4,908:
|-
|-
| 0x0
| 0x0
| 0x8
| 0x50
| [[#InputDetectorLifo]]
|}
 
==== InputDetectorLifo ====
This is "nn::hid::detail::InputDetectorLifo". This is a RingLifo object.
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| RingLifoVptr
| RingLifoVptr
|-
|-
Line 4,566: Line 4,938:
|-
|-
| 0x20
| 0x20
| 0x20 * 2
| 0x18 * 2
| Array of [[#SixAxisSensorUserCalibrationStateAtomicStorage]]
| Array of [[#InputDetectorStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,584: Line 4,956:
|-
|-
| 0x8
| 0x8
| 0x18
| 0x10
| [[#SixAxisSensorUserCalibrationState]]
| [[#InputDetectorState]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,598: Line 4,970:
|-
|-
| 0x0
| 0x0
| 0x4
| 0x8
| [[#SixAxisSensorUserCalibrationFlagsSet|Flags]]
| [[#InputSourceState|InputSourceState]]
|-
| 0x4
| 0x4
| Reserved
|-
|-
| 0x8
| 0x8
| 0x8
| [[#SixAxisSensorUserCalibrationStage|Stage]]
|-
| 0x10
| 0x8
| 0x8
| SamplingNumber
| SamplingNumber
|}
|}


== NpadSharedMemoryFormat ==
== UniquePadSharedMemoryFormat ==
This is "nn::hid::detail::NpadSharedMemoryFormat".
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"
{| class="wikitable" border="1"
Line 4,624: Line 4,990:
|-
|-
| 0x0
| 0x0
| 0x5000 * 10
| 0x400 * 16
| Array of [[#NpadSharedMemoryEntry]]
| Array of [[#UniquePadSharedMemoryEntry]]
|}
|}


Each entry describes an available controller:
== UniquePadSharedMemoryEntry ==
This is "nn::hid::detail::UniquePadSharedMemoryEntry".
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Entry
! Offset
! Size
! Description
! Description
|-
|-
| 0 to 7
| 0x0
| Players 1 to 8
| 0x1E0
|-
| [[#UniquePadLifo]]
| 8
| Handheld Mode
|-
| 9
| Other
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,654: Line 5,018:
|-
|-
| 0x0
| 0x0
| 0x43F8 ([9.0.0-12.1.0] 0x43F0, [1.0.0-8.1.0] 0x4410)
| 0x80
| [[#NpadInternalState]]
| [[#UniquePadConfigLifo]]
|-
| 0x80
| 0x70 * 2
| Array of [[#AnalogStickCalibrationStateImplLifo]]
|-
| 0x160
| 0x60
| [[#SixAxisSensorUserCalibrationStateLifo]]
|-
| 0x1C0
| 0x20
| UniquePadConfigMutex
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,668: Line 5,044:
|-
|-
| 0x0
| 0x0
| 0x4
| 0x8
| [[#NpadStyleSet|StyleSet]]
| RingLifoVptr
|-
|-
| 0x4
| 0x8
| 0x4
| 0x8
| [[#NpadJoyAssignmentMode|JoyAssignmentMode]]
| BufferCount
|-
|-
| 0x10
| 0x8
| 0x8
| 0xC
| Tail
| [[#NpadFullKeyColorState|FullKeyColor]]
|-
|-
| 0x14
| 0x18
| 0x14
| 0x8
| [[#NpadJoyColorState|JoyColor]]
| Count
|-
|-
| 0x28
| 0x20
| 0x350
| 0x30 * 2
| [[#NpadFullKeyLifo|FullKeyLifo]]
| Array of [[#UniquePadConfigAtomicStorage]]
|-
|}
| 0x378
 
| 0x350
===== UniquePadConfigAtomicStorage =====
| [[#NpadHandheldLifo|HandheldLifo]]
This is "nn::hid::detail::UniquePadConfigAtomicStorage".
 
{| class="wikitable" border="1"
|-
|-
| 0x6C8
! Offset
| 0x350
! Size
| [[#NpadJoyDualLifo|JoyDualLifo]]
! Description
|-
|-
| 0xA18
| 0x0
| 0x350
| 0x8
| [[#NpadJoyLeftLifo|JoyLeftLifo]]
| SamplingNumber
|-
|-
| 0xD68
| 0x8
| 0x350
| 0x28
| [[#NpadJoyRightLifo|JoyRightLifo]]
| [[#UniquePadConfig]]
|}
 
====== UniquePadConfig ======
This is "nn::hid::detail::UniquePadConfig".
 
{| class="wikitable" border="1"
|-
|-
| 0x10B8
! Offset
| 0x350
! Size
| [[#NpadPalmaLifo|PalmaLifo]] ([1.0.0-3.0.2] [[#NpadSystemLifo|SystemLifo]])
! Description
|-
|-
| 0x1408
| 0x0
| 0x350
| 0x4
| [[#NpadSystemExtLifo|SystemExtLifo]] ([4.0.0+] also used for NpadSystem)
| [[#UniquePadType|Type]]
|-
|-
| 0x1758
| 0x4
| 0x708
| 0x4
| [[#NpadSixAxisSensorLifo|FullKeySixAxisSensorLifo]]
| [[#UniquePadInterface|Interface]]
|-
|-
| 0x1E60
| 0x8
| 0x708
| 0x10
| [[#NpadSixAxisSensorLifo|HandheldSixAxisSensorLifo]]
| [[#UniquePadSerialNumber|SerialNumber]]
|-
|-
| 0x2568
| 0x18
| 0x708
| 0x4
| [[#NpadSixAxisSensorLifo|JoyDualLeftSixAxisSensorLifo]]
| ControllerNumber
|-
|-
| 0x2C70
| 0x1C
| 0x708
| 0x1
| [[#NpadSixAxisSensorLifo|JoyDualRightSixAxisSensorLifo]]
| IsActive
|-
|-
| 0x3378
| 0x1D
| 0x708
| 0x3
| [[#NpadSixAxisSensorLifo|JoyLeftSixAxisSensorLifo]]
|-
| 0x3A80
| 0x708
| [[#NpadSixAxisSensorLifo|JoyRightSixAxisSensorLifo]]
|-
| 0x4188
| 0x4
| [[#DeviceType|DeviceType]]
|-
| 0x418C
| 0x4
| Reserved
| Reserved
|-
|-
| 0x4190
| 0x20
| 0x8
| 0x8
| [[#NpadSystemProperties|SystemProperties]]
| SamplingNumber
|}
 
==== AnalogStickCalibrationStateImplLifo ====
This is "nn::hid::detail::AnalogStickCalibrationStateImplLifo". This is a RingLifo object.
 
{| class="wikitable" border="1"
|-
|-
| 0x4198
! Offset
| 0x4
! Size
| [[#NpadSystemButtonProperties|SystemButtonProperties]]
! Description
|-
|-
| 0x419C
| 0x0
| 0x4
| 0x8
| [[#BatteryLevel|BatteryLevelJoyDual]]
| RingLifoVptr
|-
|-
| 0x41A0
| 0x8
| 0x4
| 0x8
| [[#BatteryLevel|BatteryLevelJoyLeft]]
| BufferCount
|-
|-
| 0x41A4
| 0x10
| 0x4
| 0x8
| [[#BatteryLevel|BatteryLevelJoyRight]]
| Tail
|-
|-
| 0x41A8
| 0x18
| 0x60
| 0x8
| [1.0.0-8.1.0] [[#NfcXcdDeviceHandleState|NfcXcdDeviceHandle]] (replaced by [[#GetXcdHandleForNpadWithNfc]])
| Count
|-
|-
| 0x41A8
| 0x20
| 0x4
| 0x28 * 2
| [9.0.0+] [[#AppletFooterUiAttribute|AppletFooterUiAttributes]]
| Array of [[#AnalogStickCalibrationStateImplAtomicStorage]]
|}
 
===== AnalogStickCalibrationStateImplAtomicStorage =====
This is "nn::hid::detail::AnalogStickCalibrationStateImplAtomicStorage".
 
{| class="wikitable" border="1"
|-
|-
| 0x41AC
! Offset
| 0x1
! Size
| [9.0.0+] [[#AppletFooterUiType|AppletFooterUiType]]
! Description
|-
|-
| 0x41AD
| 0x0
| 0x7B
| 0x8
| [9.0.0+] Reserved
| SamplingNumber
|-
|-
| 0x4208
| 0x8
| 0x40
| 0x20
| [1.0.0-8.1.0] Mutex
| [[#AnalogStickCalibrationStateImpl]]
|-
| 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]]
|-
| 0x43E8 ([1.0.0-8.1.0] 0x4408)
| 0x4
| [[#NpadLuciaType|LuciaType]]
|-
| 0x43EC ([1.0.0-8.1.0] 0x440C)
| 0x4
| [[#NpadLagerType|LagerType]]
|-
| 0x43F0
| 0x1 * 6
| [13.0.0+] Array of [[#SixAxisSensorProperties]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,819: Line 5,179:
| 0x0
| 0x0
| 0x8
| 0x8
| RingLifoVptr
| [[#AnalogStickState|State]]
|-
|-
| 0x8
| 0x8
| 0x8
| 0x8
| BufferCount
| [[#AnalogStickCalibrationFlagsSet|Flags]]
|-
|-
| 0x10
| 0x10
| 0x8
| 0x8
| Tail
| [[#AnalogStickManualCalibrationStage|Stage]]
|-
|-
| 0x18
| 0x18
| 0x8
| 0x8
| Count
| SamplingNumber
|-
| 0x20
| 0x30 * 17
| Array of [[#NpadFullKeyStateAtomicStorage]]
|}
|}


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


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


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,870: Line 5,238:
|-
|-
| 0x8
| 0x8
| 0x8
| [[#NpadButtonSet|Buttons]]
|-
| 0x10
| 0x8
| [[#AnalogStickState|AnalogStickL]]
|-
| 0x18
| 0x18
| 0x8
| [[#SixAxisSensorUserCalibrationState]]
| [[#AnalogStickState|AnalogStickR]]
|-
| 0x20
| 0x4
| [[#NpadAttributesSet|Attributes]]
|-
| 0x24
| 0x4
| Reserved
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,900: Line 5,252:
|-
|-
| 0x0
| 0x0
| 0x8
| 0x4
| RingLifoVptr
| [[#SixAxisSensorUserCalibrationFlagsSet|Flags]]
|-
| 0x4
| 0x4
| Reserved
|-
|-
| 0x8
| 0x8
| 0x8
| 0x8
| BufferCount
| [[#SixAxisSensorUserCalibrationStage|Stage]]
|-
|-
| 0x10
| 0x10
| 0x8
| 0x8
| Tail
| SamplingNumber
|-
| 0x18
| 0x8
| Count
|-
| 0x20
| 0x30 * 17
| Array of [[#NpadHandheldStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,930: Line 5,278:
|-
|-
| 0x0
| 0x0
| 0x8
| 0x5000 * 10
| SamplingNumber
| Array of [[#NpadSharedMemoryEntry]]
|-
| 0x8
| 0x28
| [[#NpadHandheldState]]
|}
|}


====== NpadHandheldState ======
Each entry describes an available controller:
This is "nn::hid::NpadHandheldState".
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Entry
! Size
! Description
! Description
|-
|-
| 0x0
| 0 to 7
| 0x8
| Players 1 to 8
| SamplingNumber
|-
|-
| 0x8
| 8
| 0x8
| Handheld Mode
| [[#NpadButtonSet|Buttons]]
|-
|-
| 0x10
| 9
| 0x8
| Other
| [[#AnalogStickState|AnalogStickL]]
|-
| 0x18
| 0x8
| [[#AnalogStickState|AnalogStickR]]
|-
| 0x20
| 0x4
| [[#NpadAttributesSet|Attributes]]
|-
| 0x24
| 0x4
| Reserved
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 4,982: Line 5,308:
|-
|-
| 0x0
| 0x0
| 0x8
| 0x43F8 ([9.0.0-12.1.0] 0x43F0, [1.0.0-8.1.0] 0x4410)
| RingLifoVptr
| [[#NpadInternalState]]
|-
| 0x8
| 0x8
| BufferCount
|-
| 0x10
| 0x8
| Tail
|-
| 0x18
| 0x8
| Count
|-
| 0x20
| 0x30 * 17
| Array of [[#NpadJoyDualStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,012: Line 5,322:
|-
|-
| 0x0
| 0x0
| 0x8
| 0x4
| SamplingNumber
| [[#NpadStyleSet|StyleSet]]
|-
| 0x4
| 0x4
| [[#NpadJoyAssignmentMode|JoyAssignmentMode]]
|-
|-
| 0x8
| 0x8
| 0x28
| 0xC
| [[#NpadJoyDualState]]
| [[#NpadFullKeyColorState|FullKeyColor]]
|}
 
====== NpadJoyDualState ======
This is "nn::hid::NpadJoyDualState".
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 0x14
! Size
| 0x14
! Description
| [[#NpadJoyColorState|JoyColor]]
|-
|-
| 0x0
| 0x28
| 0x8
| 0x350
| SamplingNumber
| [[#NpadFullKeyLifo|FullKeyLifo]]
|-
|-
| 0x8
| 0x378
| 0x8
| 0x350
| [[#NpadButtonSet|Buttons]]
| [[#NpadHandheldLifo|HandheldLifo]]
|-
|-
| 0x10
| 0x6C8
| 0x8
| 0x350
| [[#AnalogStickState|AnalogStickL]]
| [[#NpadJoyDualLifo|JoyDualLifo]]
|-
|-
| 0x18
| 0xA18
| 0x8
| 0x350
| [[#AnalogStickState|AnalogStickR]]
| [[#NpadJoyLeftLifo|JoyLeftLifo]]
|-
|-
| 0x20
| 0xD68
| 0x4
| 0x350
| [[#NpadAttributesSet|Attributes]]
| [[#NpadJoyRightLifo|JoyRightLifo]]
|-
|-
| 0x24
| 0x10B8
| 0x4
| 0x350
| Reserved
| [[#NpadPalmaLifo|PalmaLifo]] ([1.0.0-3.0.2] [[#NpadSystemLifo|SystemLifo]])
|}
 
==== NpadJoyLeftLifo ====
This is "nn::hid::detail::NpadJoyLeftLifo". This is a RingLifo object.
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 0x1408
! Size
| 0x350
! Description
| [[#NpadSystemExtLifo|SystemExtLifo]] ([4.0.0+] also used for NpadSystem)
|-
|-
| 0x0
| 0x1758
| 0x8
| 0x708
| RingLifoVptr
| [[#NpadSixAxisSensorLifo|FullKeySixAxisSensorLifo]]
|-
|-
| 0x8
| 0x1E60
| 0x8
| 0x708
| BufferCount
| [[#NpadSixAxisSensorLifo|HandheldSixAxisSensorLifo]]
|-
|-
| 0x10
| 0x2568
| 0x8
| 0x708
| Tail
| [[#NpadSixAxisSensorLifo|JoyDualLeftSixAxisSensorLifo]]
|-
|-
| 0x18
| 0x2C70
| 0x8
| 0x708
| Count
| [[#NpadSixAxisSensorLifo|JoyDualRightSixAxisSensorLifo]]
|-
|-
| 0x20
| 0x3378
| 0x30 * 17
| 0x708
| Array of [[#NpadJoyLeftStateAtomicStorage]]
| [[#NpadSixAxisSensorLifo|JoyLeftSixAxisSensorLifo]]
|}
 
===== NpadJoyLeftStateAtomicStorage =====
This is "nn::hid::detail::NpadJoyLeftStateAtomicStorage".
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 0x3A80
! Size
| 0x708
! Description
| [[#NpadSixAxisSensorLifo|JoyRightSixAxisSensorLifo]]
|-
|-
| 0x0
| 0x4188
| 0x8
| 0x4
| SamplingNumber
| [[#DeviceType|DeviceType]]
|-
|-
| 0x8
| 0x418C
| 0x28
| 0x4
| [[#NpadJoyLeftState]]
| Reserved
|}
 
====== NpadJoyLeftState ======
This is "nn::hid::NpadJoyLeftState".
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 0x4190
! Size
! Description
|-
| 0x0
| 0x8
| 0x8
| SamplingNumber
| [[#NpadSystemProperties|SystemProperties]]
|-
|-
| 0x8
| 0x4198
| 0x8
| 0x4
| [[#NpadButtonSet|Buttons]]
| [[#NpadSystemButtonProperties|SystemButtonProperties]]
|-
|-
| 0x10
| 0x419C
| 0x8
| 0x4
| [[#AnalogStickState|AnalogStickL]]
| [[#BatteryLevel|BatteryLevelJoyDual]]
|-
|-
| 0x18
| 0x41A0
| 0x8
| 0x4
| [[#AnalogStickState|AnalogStickR]]
| [[#BatteryLevel|BatteryLevelJoyLeft]]
|-
|-
| 0x20
| 0x41A4
| 0x4
| 0x4
| [[#NpadAttributesSet|Attributes]]
| [[#BatteryLevel|BatteryLevelJoyRight]]
|-
|-
| 0x24
| 0x41A8
| 0x60
| [1.0.0-8.1.0] [[#NfcXcdDeviceHandleState|NfcXcdDeviceHandle]] (replaced by [[#GetXcdHandleForNpadWithNfc]])
|-
| 0x41A8
| 0x4
| [9.0.0+] [[#AppletFooterUiAttribute|AppletFooterUiAttributes]]
|-
| 0x41AC
| 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]]
|-
| 0x43E8 ([1.0.0-8.1.0] 0x4408)
| 0x4
| [[#NpadLuciaType|LuciaType]]
|-
| 0x43EC ([1.0.0-8.1.0] 0x440C)
| 0x4
| 0x4
| Reserved
| [[#NpadLagerType|LagerType]]
|-
| 0x43F0
| 0x1 * 6
| [13.0.0+] Array of [[#SixAxisSensorProperties]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,163: Line 5,489:
| 0x20
| 0x20
| 0x30 * 17
| 0x30 * 17
| Array of [[#NpadJoyRightStateAtomicStorage]]
| Array of [[#NpadFullKeyStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,181: Line 5,507:
| 0x8
| 0x8
| 0x28
| 0x28
| [[#NpadJoyRightState]]
| [[#NpadFullKeyState]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,218: Line 5,544:
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,245: Line 5,571:
| 0x20
| 0x20
| 0x30 * 17
| 0x30 * 17
| Array of [[#NpadPalmaStateAtomicStorage]]
| Array of [[#NpadHandheldStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,263: Line 5,589:
| 0x8
| 0x8
| 0x28
| 0x28
| [[#NpadPalmaState]]
| [[#NpadHandheldState]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,300: Line 5,626:
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,327: Line 5,653:
| 0x20
| 0x20
| 0x30 * 17
| 0x30 * 17
| Array of [[#NpadSystemStateAtomicStorage]]
| Array of [[#NpadJoyDualStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,345: Line 5,671:
| 0x8
| 0x8
| 0x28
| 0x28
| [[#NpadSystemState]]
| [[#NpadJoyDualState]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,382: Line 5,708:
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,409: Line 5,735:
| 0x20
| 0x20
| 0x30 * 17
| 0x30 * 17
| Array of [[#NpadSystemExtStateAtomicStorage]]
| Array of [[#NpadJoyLeftStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,427: Line 5,753:
| 0x8
| 0x8
| 0x28
| 0x28
| [[#NpadSystemExtState]]
| [[#NpadJoyLeftState]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,464: Line 5,790:
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,490: Line 5,816:
|-
|-
| 0x20
| 0x20
| 0x68 * 17
| 0x30 * 17
| Array of [[#SixAxisSensorStateAtomicStorage]]
| Array of [[#NpadJoyRightStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,508: Line 5,834:
|-
|-
| 0x8
| 0x8
| 0x60
| 0x28
| [[#SixAxisSensorState]]
| [[#NpadJoyRightState]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,523: Line 5,849:
| 0x0
| 0x0
| 0x8
| 0x8
| DeltaTime
| SamplingNumber
|-
|-
| 0x8
| 0x8
| 0x8
| 0x8
| SamplingNumber
| [[#NpadButtonSet|Buttons]]
|-
|-
| 0x10
| 0x10
| 0x4
| 0x8
| AccelerationX
| [[#AnalogStickState|AnalogStickL]]
|-
| 0x14
| 0x4
| AccelerationY
|-
|-
| 0x18
| 0x18
| 0x4
| 0x8
| AccelerationZ
| [[#AnalogStickState|AnalogStickR]]
|-
| 0x1C
| 0x4
| AngularVelocityX
|-
|-
| 0x20
| 0x20
| 0x4
| 0x4
| AngularVelocityY
| [[#NpadAttributesSet|Attributes]]
|-
| 0x24
| 0x4
| AngularVelocityZ
|-
| 0x28
| 0x4
| AngleX
|-
| 0x2C
| 0x4
| AngleY
|-
| 0x30
| 0x4
| AngleZ
|-
|-
| 0x34
| 0x24
| 0x24
| [[#DirectionState|Direction]]
|-
| 0x58
| 0x4
| [[#SixAxisSensorAttributeSet|Attributes]]
|-
| 0x5C
| 0x4
| 0x4
| Reserved
| Reserved
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,604: Line 5,898:
|-
|-
| 0x20
| 0x20
| 0x20 * 2
| 0x30 * 17
| Array of [[#NfcXcdDeviceHandleStateImplAtomicStorage]]
| Array of [[#NpadPalmaStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,622: Line 5,916:
|-
|-
| 0x8
| 0x8
| 0x18
| 0x28
| [[#NfcXcdDeviceHandleStateImpl]]
| [[#NpadPalmaState]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,637: Line 5,931:
| 0x0
| 0x0
| 0x8
| 0x8
| [[#DeviceHandle|Handle]]
| SamplingNumber
|-
| 0x8
| 0x8
| [[#NpadButtonSet|Buttons]]
|-
| 0x10
| 0x8
| [[#AnalogStickState|AnalogStickL]]
|-
|-
| 0x18
| 0x8
| 0x8
| 0x1
| [[#AnalogStickState|AnalogStickR]]
| IsAvailable
|-
|-
| 0x9
| 0x20
| 0x1
| 0x4
| IsActivated
| [[#NpadAttributesSet|Attributes]]
|-
|-
| 0xA
| 0x24
| 0x6
| 0x4
| Reserved
| Reserved
|-
| 0x10
| 0x8
| SamplingNumber
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,682: Line 5,980:
|-
|-
| 0x20
| 0x20
| 0x18 * 17
| 0x30 * 17
| Array of [[#NpadGcTriggerStateAtomicStorage]]
| Array of [[#NpadSystemStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,700: Line 5,998:
|-
|-
| 0x8
| 0x8
| 0x10
| 0x28
| [[#NpadGcTriggerState]]
| [[#NpadSystemState]]
|}
|}


====== NpadGcTriggerState ======
====== NpadSystemState ======
This is "nn::hid::server::NpadGcTriggerState".
This is "nn::hid::system::NpadSystemState".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,718: Line 6,016:
|-
|-
| 0x8
| 0x8
| 0x4
| 0x8
| TriggerL
| [[#NpadButtonSet|Buttons]]
|-
|-
| 0xC
| 0x10
| 0x8
| [[#AnalogStickState|AnalogStickL]]
|-
| 0x18
| 0x8
| [[#AnalogStickState|AnalogStickR]]
|-
| 0x20
| 0x4
| 0x4
| TriggerR
| [[#NpadAttributesSet|Attributes]]
|}
 
== GestureSharedMemoryFormat ==
This is "nn::hid::detail::GestureSharedMemoryFormat".
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 0x24
! Size
| 0x4
! Description
| Reserved
|-
| 0x0
| 0x708
| [[#GestureLifo]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,766: Line 6,062:
|-
|-
| 0x20
| 0x20
| 0x68 * 17
| 0x30 * 17
| Array of [[#GestureDummyStateAtomicStorage]]
| Array of [[#NpadSystemExtStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,784: Line 6,080:
|-
|-
| 0x8
| 0x8
| 0x60
| 0x28
| [[#GestureDummyState]]
| [[#NpadSystemExtState]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,803: Line 6,099:
| 0x8
| 0x8
| 0x8
| 0x8
| ContextNumber
| [[#NpadButtonSet|Buttons]]
|-
|-
| 0x10
| 0x10
| 0x4
| 0x8
| [[#GestureType|Type]]
| [[#AnalogStickState|AnalogStickL]]
|-
|-
| 0x14
| 0x18
| 0x4
| 0x8
| [[#GestureDirection|Direction]]
| [[#AnalogStickState|AnalogStickR]]
|-
|-
| 0x18
| 0x20
| 0x4
| 0x4
| X
| [[#NpadAttributesSet|Attributes]]
|-
|-
| 0x1C
| 0x24
| 0x4
| 0x4
| Y
| Reserved
|}
 
==== NpadSixAxisSensorLifo ====
This is "nn::hid::detail::NpadSixAxisSensorLifo". This is a RingLifo object.
 
{| class="wikitable" border="1"
|-
|-
| 0x20
! Offset
| 0x4
! Size
| s32 DeltaX
! Description
|-
|-
| 0x24
| 0x0
| 0x4
| 0x8
| s32 DeltaY
| RingLifoVptr
|-
|-
| 0x28
| 0x8
| 0x4
| 0x8
| float VelocityX
| BufferCount
|-
|-
| 0x2C
| 0x10
| 0x4
| 0x8
| float VelocityY
| Tail
|-
|-
| 0x30
| 0x18
| 0x4
| 0x8
| [[#GestureAttributeSet|Attributes]]
| Count
|-
|-
| 0x34
| 0x20
| 0x4
| 0x68 * 17
| Scale
| Array of [[#SixAxisSensorStateAtomicStorage]]
|-
| 0x38
| 0x4
| RotationAngle
|-
| 0x3C
| 0x4
| s32 PointCount
|-
| 0x40
| 0x8 * 4
| [[#GesturePoint|Points]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,872: Line 6,162:
|-
|-
| 0x8
| 0x8
| 0x1
| 0x60
| IsSevenSixAxisSensorAtRest
| [[#SixAxisSensorState]]
|-
| 0x9
| 0x3
| Padding
|-
| 0xC
| 0x4
| VerticalizationError
|-
| 0x10
| 0xC
| GyroBias
|}
|}


= AnalogStickState =
====== SixAxisSensorState ======
This is "nn::hid::AnalogStickState".
This is "nn::hid::SixAxisSensorState".
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| X
|-
| 0x4
| 0x4
| Y
|}
 
= TouchState =
This is "nn::hid::TouchState".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,920: Line 6,180:
|-
|-
| 0x8
| 0x8
| 0x4
| 0x8
| [[#TouchAttributeSet|Attributes]]
| SamplingNumber
|-
| 0xC
| 0x4
| FingerId
|-
|-
| 0x10
| 0x10
| 0x4
| 0x4
| X
| AccelerationX
|-
|-
| 0x14
| 0x14
| 0x4
| 0x4
| Y
| AccelerationY
|-
|-
| 0x18
| 0x18
| 0x4
| 0x4
| DiameterX
| AccelerationZ
|-
|-
| 0x1C
| 0x1C
| 0x4
| 0x4
| DiameterY
| AngularVelocityX
|-
|-
| 0x20
| 0x20
| 0x4
| 0x4
| RotationAngle
| AngularVelocityY
|-
|-
| 0x24
| 0x24
| 0x4
| 0x4
| Reserved
| AngularVelocityZ
|}
|-
 
| 0x28
= TouchScreenConfigurationForNx =
| 0x4
This is "nn::hid::TouchScreenConfigurationForNx".
| AngleX
|-
| 0x2C
| 0x4
| AngleY
|-
| 0x30
| 0x4
| AngleZ
|-
| 0x34
| 0x24
| [[#DirectionState|Direction]]
|-
| 0x58
| 0x4
| [[#SixAxisSensorAttributeSet|Attributes]]
|-
| 0x5C
| 0x4
| Reserved
|}
 
==== NfcXcdDeviceHandleState ====
This is "nn::hid::detail::NfcXcdDeviceHandleState". This is a RingLifo object.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,962: Line 6,242:
|-
|-
| 0x0
| 0x0
| 0x1
| 0x8
| [[#TouchScreenModeForNx|Mode]]
| RingLifoVptr
|-
|-
| 0x8
| 0x8
| 0xF
| 0x8
| Reserved
| BufferCount
|}
 
= TouchScreenModeForNx =
This is "nn::hid::TouchScreenModeForNx".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || UseSystemSetting
| 0x10
| 0x8
| Tail
|-
|-
| 1 || Finger
| 0x18
| 0x8
| Count
|-
|-
| 2 || Heat2
| 0x20
| 0x20 * 2
| Array of [[#NfcXcdDeviceHandleStateImplAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,995: Line 6,273:
| 0x0
| 0x0
| 0x8
| 0x8
| Timestamp
| SamplingNumber
|-
| 0x8
| 0x18
| [[#NfcXcdDeviceHandleStateImpl]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 6,008: Line 6,290:
|-
|-
| 0x0
| 0x0
| 0x4
| 0x8
| Main
| [[#DeviceHandle|Handle]]
|-
| 0x8
| 0x1
| IsAvailable
|-
| 0x9
| 0x1
| IsActivated
|-
| 0xA
| 0x6
| Reserved
|-
|-
| 0x4
| 0x10
| 0x4
| 0x8
| Sub
| SamplingNumber
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 6,026: Line 6,320:
|-
|-
| 0x0
| 0x0
| 0x4
| 0x8
| [[#ColorAttribute|Attribute]]
| RingLifoVptr
|-
| 0x8
| 0x8
| BufferCount
|-
| 0x10
| 0x8
| Tail
|-
|-
| 0x4
| 0x18
| 0x8
| 0x8
| [[#NpadControllerColor|FullKey]]
| Count
|-
| 0x20
| 0x18 * 17
| Array of [[#NpadGcTriggerStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 6,044: Line 6,350:
|-
|-
| 0x0
| 0x0
| 0x4
| 0x8
| [[#ColorAttribute|Attribute]]
| SamplingNumber
|-
|-
| 0x4
| 0x8
| 0x8
| [[#NpadControllerColor|Left]]
| 0x10
|-
| [[#NpadGcTriggerState]]
| 0xC
| 0x8
| [[#NpadControllerColor|Right]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 6,066: Line 6,368:
|-
|-
| 0x0
| 0x0
| 0x4
| 0x8
| XX
| SamplingNumber
|-
| 0x4
| 0x4
| XY
|-
|-
| 0x8
| 0x8
| 0x4
| 0x4
| XZ
| TriggerL
|-
|-
| 0xC
| 0xC
| 0x4
| 0x4
| YX
| TriggerR
|-
| 0x10
| 0x4
| YY
|-
| 0x14
| 0x4
| YZ
|-
| 0x18
| 0x4
| ZX
|-
| 0x1C
| 0x4
| ZY
|-
| 0x20
| 0x4
| ZZ
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 6,112: Line 6,390:
|-
|-
| 0x0
| 0x0
| 0x4
| 0x708
| X
| [[#GestureLifo]]
|-
| 0x4
| 0x4
| Y
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Ok
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| RingLifoVptr
|-
| 0x8
| 0x8
| BufferCount
|-
| 0x10
| 0x8
| Tail
|-
|-
| 1 || ReadError
| 0x18
| 0x8
| Count
|-
|-
| 2 || NoController
| 0x20
| 0x68 * 17
| Array of [[#GestureDummyStateAtomicStorage]]
|}
|}


= DebugPadAttributeSet =
===== GestureDummyStateAtomicStorage =====
This is "nn::hid::DebugPadAttributeSet". This is a BitFlagSet object for [[#DebugPadAttribute]].
This is "nn::hid::detail::GestureDummyStateAtomicStorage".
 
= DebugPadAttribute =
This is "nn::hid::DebugPadAttribute". This is a 32-bit flag.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Bit
! Offset
! Size
! Description
! Description
|-
|-
| 0
| 0x0
| IsConnected
| 0x8
| SamplingNumber
|-
| 0x8
| 0x60
| [[#GestureDummyState]]
|}
|}


= TouchAttributeSet =
====== GestureDummyState ======
This is "nn::hid::TouchAttributeSet". This is a BitFlagSet object for [[#TouchAttribute]].
This is "nn::hid::detail::GestureDummyState" / "nn::hid::GestureState".
 
= TouchAttribute =
This is "nn::hid::TouchAttribute". This is a 32-bit flag.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Bit
! Offset
! Size
! Description
! Description
|-
|-
| 0
| 0x0
| Start
| 0x8
| SamplingNumber
|-
|-
| 1
| 0x8
| End
| 0x8
|}
| ContextNumber
 
= 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
| 0x10
! Description
| 0x4
| [[#GestureType|Type]]
|-
|-
| 0
| 0x14
| Transferable
| 0x4
| [[#GestureDirection|Direction]]
|-
|-
| 1
| 0x18
| IsConnected
| 0x4
|}
| X
 
= 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
| 0x1C
! Description
| 0x4
| Y
|-
|-
| 0
| 0x20
| IsConnected
| 0x4
| s32 DeltaX
|-
|-
| 1
| 0x24
| IsWired
| 0x4
| s32 DeltaY
|-
|-
| 2
| 0x28
| IsLeftConnected
| 0x4
| float VelocityX
|-
|-
| 3
| 0x2C
| IsLeftWired
| 0x4
| float VelocityY
|-
|-
| 4
| 0x30
| IsRightConnected
| 0x4
| [[#GestureAttributeSet|Attributes]]
|-
| 0x34
| 0x4
| Scale
|-
| 0x38
| 0x4
| RotationAngle
|-
| 0x3C
| 0x4
| s32 PointCount
|-
|-
| 5
| 0x40
| IsRightWired
| 0x8 * 4
| [[#GesturePoint|Points]]
|}
|}


= SixAxisSensorAttributeSet =
== ConsoleSixAxisSensorSharedMemoryFormat ==
This is "nn::hid::SixAxisSensorAttributeSet". This is a BitFlagSet object for [[#SixAxisSensorAttribute]].
This is "nn::hid::detail::ConsoleSixAxisSensorSharedMemoryFormat".
 
= 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
| SamplingNumber
|-
| 0x8
| 0x1
| IsSevenSixAxisSensorAtRest
|-
| 0x9
| 0x3
| Padding
|-
| 0xC
| 0x4
| VerticalizationError
|-
|-
| 1
| 0x10
| IsInterpolated
| 0xC
| GyroBias
|}
|}


= GestureAttributeSet =
= AnalogStickState =
This is "nn::hid::GestureAttributeSet". This is a BitFlagSet object for [[#GestureAttribute]].
This is "nn::hid::AnalogStickState".
 
= 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
| 0x4
| X
|-
|-
| 8
| 0x4
| IsDoubleTap
| 0x4
| Y
|}
|}


= DebugPadButtonSet =
= TouchState =
This is "nn::hid::DebugPadButtonSet". This is a BitFlagSet object for [[#DebugPadButton]].
This is "nn::hid::TouchState".
 
= 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
| DeltaTime
|-
| 0x8
| 0x4
| [[#TouchAttributeSet|Attributes]]
|-
|-
| 1
| 0xC
| B
| 0x4
| FingerId
|-
|-
| 2
| 0x10
| 0x4
| X
| X
|-
|-
| 3
| 0x14
| 0x4
| Y
| Y
|-
|-
| 4
| 0x18
| L
| 0x4
| DiameterX
|-
|-
| 5
| 0x1C
| R
| 0x4
| DiameterY
|-
|-
| 6
| 0x20
| ZL
| 0x4
| RotationAngle
|-
|-
| 7
| 0x24
| ZR
| 0x4
|-
| Reserved
| 8
| Start
|-
| 9
| Select
|-
| 10
| Left
|-
| 11
| Up
|-
| 12
| Right
|-
| 13
| Down
|}
|}


= MouseButtonSet =
= TouchScreenConfigurationForNx =
This is "nn::hid::MouseButtonSet". This is a BitFlagSet object for [[#MouseButton]].
This is "nn::hid::TouchScreenConfigurationForNx".
 
= 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
| 0x1
| [[#TouchScreenModeForNx|Mode]]
|-
|-
| 1
| 0x8
| Right
| 0xF
| Reserved
|}
 
= TouchScreenModeForNx =
This is "nn::hid::TouchScreenModeForNx".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 2
| 0 || UseSystemSetting
| Middle
|-
|-
| 3
| 1 || Finger
| Forward
|-
|-
| 4
| 2 || Heat2
| Back
|}
|}


= KeyboardModifierSet =
= InputSourceState =
This is "nn::hid::KeyboardModifierSet". This is a BitFlagSet object for [[#KeyboardModifier]].
This is "nn::hid::system::InputSourceState".
 
= 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
| Timestamp
|}
 
= NpadControllerColor =
This is "nn::hid::NpadControllerColor".
 
{| class="wikitable" border="1"
|-
|-
| 1
! Offset
| Shift
! Size
! Description
|-
|-
| 2
| 0x0
| LeftAlt
| 0x4
| Main
|-
|-
| 3
| 0x4
| RightAlt
| 0x4
|-
| Sub
| 4
| Gui
|-
| 8
| CapsLock
|-
| 9
| ScrollLock
|-
| 10
| NumLock
|-
| 11
| Katakana
|-
| 12
| Hiragana
|}
|}


= KeyboardKeySet =
= NpadFullKeyColorState =
This is "nn::hid::KeyboardKeySet". This is a BitFlagSet object for [[#KeyboardKey]].
This is "nn::hid::detail::NpadFullKeyColorState".
 
= KeyboardKey =
This is "nn::hid::KeyboardKey". This is a 256-bit flag.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Bit
! Offset
! Size
! Description
! Description
|-
|-
| 4
| 0x0
| A
| 0x4
| [[#ColorAttribute|Attribute]]
|-
|-
| 5
| 0x4
| B
| 0x8
| [[#NpadControllerColor|FullKey]]
|}
 
= NpadJoyColorState =
This is "nn::hid::detail::NpadJoyColorState".
 
{| class="wikitable" border="1"
|-
|-
| 6
! Offset
| C
! Size
! Description
|-
|-
| 7
| 0x0
| D
| 0x4
| [[#ColorAttribute|Attribute]]
|-
|-
| 8
| 0x4
| E
| 0x8
| [[#NpadControllerColor|Left]]
|-
|-
| 9
| 0xC
| F
| 0x8
| [[#NpadControllerColor|Right]]
|}
 
= DirectionState =
This is "nn::hid::DirectionState".
 
{| class="wikitable" border="1"
|-
|-
| 10
! Offset
| G
! Size
! Description
|-
|-
| 11
| 0x0
| H
| 0x4
| XX
|-
|-
| 12
| 0x4
| I
| 0x4
| XY
|-
|-
| 13
| 0x8
| J
| 0x4
| XZ
|-
|-
| 14
| 0xC
| K
| 0x4
| YX
|-
|-
| 15
| 0x10
| L
| 0x4
| YY
|-
|-
| 16
| 0x14
| M
| 0x4
| YZ
|-
|-
| 17
| 0x18
| N
| 0x4
| ZX
|-
|-
| 18
| 0x1C
| O
| 0x4
| ZY
|-
|-
| 19
| 0x20
| P
| 0x4
| ZZ
|}
 
= GesturePoint =
This is "nn::hid::GesturePoint".
 
{| class="wikitable" border="1"
|-
|-
| 20
! Offset
| Q
! Size
! Description
|-
|-
| 21
| 0x0
| R
| 0x4
| X
|-
|-
| 22
| 0x4
| S
| 0x4
| Y
|}
 
= ColorAttribute =
This is "nn::hid::detail::ColorAttribute".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 23
| 0 || Ok
| T
|-
|-
| 24
| 1 || ReadError
| U
|-
|-
| 25
| 2 || NoController
| V
|}
 
= 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"
|-
|-
| 26
! Bit
| W
! Description
|-
|-
| 27
| 0
| X
| IsConnected
|}
 
= TouchAttributeSet =
This is "nn::hid::TouchAttributeSet". This is a BitFlagSet object for [[#TouchAttribute]].
 
= TouchAttribute =
This is "nn::hid::TouchAttribute". This is a 32-bit flag.
 
{| class="wikitable" border="1"
|-
|-
| 28
! Bit
| Y
! Description
|-
|-
| 29
| 0
| Z
| Start
|-
|-
| 30
| 1
| D1
| 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"
|-
|-
| 31
! Bit
| D2
! Description
|-
|-
| 32
| 0
| D3
| Transferable
|-
|-
| 33
| 1
| D4
| IsConnected
|-
|}
| 34
 
| D5
= 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"
|-
|-
| 35
! Bit
| D6
! Description
|-
|-
| 36
| 0
| D7
| IsConnected
|-
|-
| 37
| 1
| D8
| IsWired
|-
|-
| 38
| 2
| D9
| IsLeftConnected
|-
|-
| 39
| 3
| D0
| IsLeftWired
|-
|-
| 40
| 4
| Return
| IsRightConnected
|-
|-
| 41
| 5
| Escape
| 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"
|-
|-
| 42
! Bit
| Backspace
! Description
|-
|-
| 43
| 0
| Tab
| IsConnected
|-
|-
| 44
| 1
| Space
| IsInterpolated
|}
 
= GestureAttributeSet =
This is "nn::hid::GestureAttributeSet". This is a BitFlagSet object for [[#GestureAttribute]].
 
= GestureAttribute =
This is "nn::hid::GestureAttribute". This is a 32-bit flag.
 
{| class="wikitable" border="1"
|-
|-
| 45
! Bit
| Minus
! Description
|-
|-
| 46
| 4
| Plus
| IsNewTouch
|-
|-
| 47
| 8
| OpenBracket
| IsDoubleTap
|}
 
= DebugPadButtonSet =
This is "nn::hid::DebugPadButtonSet". This is a BitFlagSet object for [[#DebugPadButton]].
 
= DebugPadButton =
This is "nn::hid::DebugPadButton". This is a 32-bit flag.
 
{| class="wikitable" border="1"
|-
|-
| 48
! Bit
| CloseBracket
! Description
|-
|-
| 49
| 0
| Pipe
| A
|-
|-
| 50
| 1
| Tilde
| B
|-
|-
| 51
| 2
| Semicolon
| X
|-
|-
| 52
| 3
| Quote
| Y
|-
|-
| 53
| 4
| Backquote
| L
|-
|-
| 54
| 5
| Comma
| R
|-
|-
| 55
| 6
| Period
| ZL
|-
|-
| 56
| 7
| Slash
| ZR
|-
|-
| 57
| 8
| CapsLock
| Start
|-
|-
| 58
| 9
| F1
| Select
|-
|-
| 59
| 10
| F2
| Left
|-
|-
| 60
| 11
| F3
| Up
|-
|-
| 61
| 12
| F4
| Right
|-
|-
| 62
| 13
| F5
| Down
|}
 
= MouseButtonSet =
This is "nn::hid::MouseButtonSet". This is a BitFlagSet object for [[#MouseButton]].
 
= MouseButton =
This is "nn::hid::MouseButton". This is a 32-bit flag.
 
{| class="wikitable" border="1"
|-
|-
| 63
! Bit
| F6
! Description
|-
|-
| 64
| 0
| F7
| Left
|-
|-
| 65
| 1
| F8
| Right
|-
|-
| 66
| 2
| F9
| Middle
|-
|-
| 67
| 3
| F10
| Forward
|-
|-
| 68
| 4
| F11
| Back
|-
|}
| 69
 
| F12
= KeyboardModifierSet =
This is "nn::hid::KeyboardModifierSet". This is a BitFlagSet object for [[#KeyboardModifier]].
 
= KeyboardModifier =
This is "nn::hid::KeyboardModifier". This is a 32-bit flag.
 
{| class="wikitable" border="1"
|-
|-
| 70
! Bit
| PrintScreen
! Description
|-
|-
| 71
| 0
| ScrollLock
| Control
|-
|-
| 72
| 1
| Pause
| Shift
|-
|-
| 73
| 2
| Insert
| LeftAlt
|-
|-
| 74
| 3
| Home
| RightAlt
|-
|-
| 75
| 4
| PageUp
| Gui
|-
|-
| 76
| 8
| Delete
| CapsLock
|-
|-
| 77
| 9
| End
| ScrollLock
|-
|-
| 78
| 10
| PageDown
| NumLock
|-
|-
| 79
| 11
| RightArrow
| Katakana
|-
|-
| 80
| 12
| LeftArrow
| Hiragana
|-
|}
| 81
 
| DownArrow
= KeyboardKeySet =
|-
This is "nn::hid::KeyboardKeySet". This is a BitFlagSet object for [[#KeyboardKey]].
| 82
 
| UpArrow
= KeyboardKey =
This is "nn::hid::KeyboardKey". This is a 256-bit flag.
 
{| class="wikitable" border="1"
|-
|-
| 83
! Bit
| NumLock
! Description
|-
|-
| 84
| 4
| NumPadDivide
| A
|-
|-
| 85
| 5
| NumPadMultiply
| B
|-
|-
| 86
| 6
| NumPadSubtract
| C
|-
|-
| 87
| 7
| NumPadAdd
| D
|-
|-
| 88
| 8
| NumPadEnter
| E
|-
|-
| 89
| 9
| NumPad1
| F
|-
|-
| 90
| 10
| NumPad2
| G
|-
|-
| 91
| 11
| NumPad3
| H
|-
|-
| 92
| 12
| NumPad4
| I
|-
|-
| 93
| 13
| NumPad5
| J
|-
|-
| 94
| 14
| NumPad6
| K
|-
|-
| 95
| 15
| NumPad7
| L
|-
|-
| 96
| 16
| NumPad8
| M
|-
|-
| 97
| 17
| NumPad9
| N
|-
|-
| 98
| 18
| NumPad0
| O
|-
|-
| 99
| 19
| NumPadDot
| P
|-
|-
| 100
| 20
| Backslash
| Q
|-
|-
| 101
| 21
| Application
| R
|-
|-
| 102
| 22
| Power
| S
|-
|-
| 103
| 23
| NumPadEquals
| T
|-
|-
| 104
| 24
| F13
| U
|-
|-
| 105
| 25
| F14
| V
|-
|-
| 106
| 26
| F15
| W
|-
|-
| 107
| 27
| F16
| X
|-
|-
| 108
| 28
| F17
| Y
|-
|-
| 109
| 29
| F18
| Z
|-
|-
| 110
| 30
| F19
| D1
|-
|-
| 111
| 31
| F20
| D2
|-
|-
| 112
| 32
| F21
| D3
|-
|-
| 113
| 33
| F22
| D4
|-
|-
| 114
| 34
| F23
| D5
|-
|-
| 115
| 35
| F24
| D6
|-
|-
| 133
| 36
| NumPadComma
| D7
|-
|-
| 135
| 37
| Ro
| D8
|-
|-
| 136
| 38
| KatakanaHiragana
| D9
|-
|-
| 137
| 39
| Yen
| D0
|-
|-
| 138
| 40
| Henkan
| Return
|-
|-
| 139
| 41
| Muhenkan
| Escape
|-
|-
| 140
| 42
| NumPadCommaPc98
| Backspace
|-
|-
| 144
| 43
| HangulEnglish
| Tab
|-
|-
| 145
| 44
| Hanja
| Space
|-
|-
| 146
| 45
| Katakana
| Minus
|-
|-
| 147
| 46
| Hiragana
| Plus
|-
|-
| 148
| 47
| ZenkakuHankaku
| OpenBracket
|-
|-
| 224
| 48
| LeftControl
| CloseBracket
|-
|-
| 225
| 49
| LeftShift
| Pipe
|-
|-
| 226
| 50
| LeftAlt
| Tilde
|-
|-
| 227
| 51
| LeftGui
| Semicolon
|-
|-
| 228
| 52
| RightControl
| Quote
|-
|-
| 229
| 53
| RightShift
| Backquote
|-
|-
| 230
| 54
| RightAlt
| Comma
|-
|-
| 231
| 55
| RightGui
| Period
|}
 
= 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"
|-
|-
! Bit
| 56
! Description
| Slash
|-
|-
| 0
| 57
| NumLockOn
| CapsLock
|-
|-
| 1
| 58
| NumLockOff
| F1
|-
|-
| 2
| 59
| NumLockToggle
| F2
|-
|-
| 3
| 60
| CapsLockOn
| F3
|-
|-
| 4
| 61
| CapsLockOff
| F4
|-
|-
| 5
| 62
| CapsLockToggle
| F5
|-
|-
| 6
| 63
| ScrollLockOn
| F6
|-
|-
| 7
| 64
| ScrollLockOff
| F7
|-
|-
| 8
| 65
| ScrollLockToggle
| F8
|}
 
= 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"
|-
|-
! Bit
| 66
! Description
| F9
|-
|-
| 0
| 67
| A
| F10
|-
|-
| 1
| 68
| B
| F11
|-
|-
| 2
| 69
| X
| F12
|-
|-
| 3
| 70
| Y
| PrintScreen
|-
|-
| 4
| 71
| StickL
| ScrollLock
|-
|-
| 5
| 72
| StickR
| Pause
|-
|-
| 6
| 73
| L
| Insert
|-
|-
| 7
| 74
| R
| Home
|-
|-
| 8
| 75
| ZL
| PageUp
|-
|-
| 9
| 76
| ZR
| Delete
|-
|-
| 10
| 77
| Plus
| End
|-
|-
| 11
| 78
| Minus
| PageDown
|-
|-
| 12
| 79
| Left
| RightArrow
|-
|-
| 13
| 80
| Up
| LeftArrow
|-
|-
| 14
| 81
| Right
| DownArrow
|-
|-
| 15
| 82
| Down
| UpArrow
|-
|-
| 16
| 83
| StickLLeft
| NumLock
|-
|-
| 17
| 84
| StickLUp
| NumPadDivide
|-
|-
| 18
| 85
| StickLRight
| NumPadMultiply
|-
|-
| 19
| 86
| StickLDown
| NumPadSubtract
|-
| 87
| NumPadAdd
|-
|-
| 20
| 88
| StickRLeft
| NumPadEnter
|-
|-
| 21
| 89
| StickRUp
| NumPad1
|-
|-
| 22
| 90
| StickRRight
| NumPad2
|-
|-
| 23
| 91
| StickRDown
| NumPad3
|-
|-
| 24
| 92
| LeftSL
| NumPad4
|-
|-
| 25
| 93
| LeftSR
| NumPad5
|-
|-
| 26
| 94
| RightSL
| NumPad6
|-
|-
| 27
| 95
| RightSR
| NumPad7
|-
|-
| 28
| 96
| Palma
| NumPad8
|-
|-
| 29
| 97
| Verification
| NumPad9
|-
|-
| 30
| 98
| HandheldLeftB (Left B button on NES controllers in Handheld mode)
| NumPad0
|-
|-
| 31
| 99
| [12.0.0+] LeftC (Left C button in N64 controller)
| NumPadDot
|-
|-
| 32
| 100
| [12.0.0+] UpC (Up C button in N64 controller)
| Backslash
|-
|-
| 33
| 101
| [12.0.0+] RightC (Right C button in N64 controller)
| Application
|-
|-
| 34
| 102
| [12.0.0+] DownC (Down C button in N64 controller)
| Power
|}
 
= AnalogStickCalibrationFlagsSet =
This is "nn::hid::detail::AnalogStickCalibrationFlagsSet". This is a BitFlagSet object for [[#AnalogStickCalibrationFlags]].
 
= SixAxisSensorUserCalibrationFlagsSet =
This is "nn::hid::detail::SixAxisSensorUserCalibrationFlagsSet". This is a BitFlagSet object for [[#SixAxisSensorUserCalibrationFlags]].
 
= NpadStyleSet =
This is "nn::hid::NpadStyleSet". This is a BitFlagSet object for [[#NpadStyleTag]].
 
= NpadStyleTag =
This is "nn::hid::NpadStyleTag".
 
{| class="wikitable" border="1"
!  Bits
!  Description
|-
|-
| 0
| 103
| NpadStyleFullKey (Pro Controller)
| NumPadEquals
|-
|-
| 1
| 104
| NpadStyleHandheld (Joy-Con controller in handheld mode)
| F13
|-
|-
| 2
| 105
| NpadStyleJoyDual (Joy-Con controller in dual mode)
| F14
|-
|-
| 3
| 106
| NpadStyleJoyLeft (Joy-Con left controller in single mode)
| F15
|-
|-
| 4
| 107
| NpadStyleJoyRight (Joy-Con right controller in single mode)
| F16
|-
|-
| 5
| 108
| NpadStyleGc (GameCube controller)
| F17
|-
|-
| 6
| 109
| NpadStylePalma (Poké Ball Plus controller)
| F18
|-
|-
| 7
| 110
| NpadStyleLark (NES/Famicom controller)
| F19
|-
|-
| 8
| 111
| NpadStyleHandheldLark (NES/Famicom controller in handheld mode)
| F20
|-
|-
| 9
| 112
| NpadStyleLucia (SNES controller)
| F21
|-
|-
| 10
| 113
| [12.0.0+] NpadStyleLagon (N64 controller)
| F22
|-
|-
| 11
| 114
| [13.0.0+] NpadStyleLager (Sega Genesis controller)
| F23
|-
|-
| 12-28
| 115
| Reserved
| F24
|-
|-
| 29
| 133
| NpadStyleSystemExt (generic external controller)
| NumPadComma
|-
|-
| 30
| 135
| NpadStyleSystem (generic controller)
| Ro
|-
|-
| 31
| 136
| Reserved
| KatakanaHiragana
|}
 
= NpadDeviceTypeSet =
This is "nn::hid::system::NpadDeviceTypeSet". This is a BitFlagSet object for [[#DeviceType|NpadDeviceType]].
 
= NpadSystemPropertiesSet =
This is "nn::hid::detail::NpadSystemPropertiesSet". This is a BitFlagSet object for [[#NpadSystemProperties]].
 
= NpadSystemProperties =
This is "nn::hid::detail::NpadSystemProperties". This is a 64-bit flag.
 
{| class="wikitable" border="1"
|-
|-
! Bit
| 137
! Description
| Yen
|-
|-
| 0
| 138
| IsChargingJoyDual
| Henkan
|-
|-
| 1
| 139
| IsChargingJoyLeft
| Muhenkan
|-
|-
| 2
| 140
| IsChargingJoyRight
| NumPadCommaPc98
|-
|-
| 3
| 144
| IsPoweredJoyDual
| HangulEnglish
|-
|-
| 4
| 145
| IsPoweredJoyLeft
| Hanja
|-
|-
| 5
| 146
| IsPoweredJoyRight
| Katakana
|-
|-
| 9
| 147
| IsUnsuportedButtonPressedOnNpadSystem
| Hiragana
|-
| 148
| ZenkakuHankaku
|-
| 224
| LeftControl
|-
| 225
| LeftShift
|-
|-
| 10
| 226
| IsUnsuportedButtonPressedOnNpadSystemExt
| LeftAlt
|-
|-
| 11
| 227
| IsAbxyButtonOriented
| LeftGui
|-
|-
| 12
| 228
| IsSlSrButtonOriented
| RightControl
|-
|-
| 13
| 229
| [4.0.0+] IsPlusAvailable
| RightShift
|-
|-
| 14
| 230
| [4.0.0+] IsMinusAvailable
| RightAlt
|-
|-
| 15
| 231
| [8.0.0+] IsDirectionalButtonsAvailable
| RightGui
|}
|}


= NpadSystemButtonPropertiesSet =
= KeyboardLockKeyEventSet =
This is "nn::hid::detail::NpadSystemButtonPropertiesSet". This is a BitFlagSet object for [[#NpadSystemButtonProperties]].
This is "nn::hid::system::KeyboardLockKeyEventSet". This is a BitFlagSet object for [[#KeyboardLockKeyEvent]].


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 7,084: Line 7,451:
|-
|-
| 0
| 0
| IsUnintendedHomeButtonInputProtectionEnabled
| NumLockOn
|}
 
= AppletFooterUiAttributesSet =
This is "nn::hid::system::AppletFooterUiAttributesSet". This is a BitFlagSet object for [[#AppletFooterUiAttribute]].
 
= UniquePadType =
This is "nn::hid::system::UniquePadType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Embedded
| 1
| NumLockOff
|-
|-
| 1 || FullKeyController
| 2
| NumLockToggle
|-
|-
| 2 || RightController
| 3
| CapsLockOn
|-
|-
| 3 || LeftController
| 4
| CapsLockOff
|-
|-
| 4 || DebugPadController
| 5
|}
| CapsLockToggle
 
= UniquePadInterface =
This is "nn::hid::system::UniquePadInterface".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Embedded
| 6
| ScrollLockOn
|-
|-
| 1 || Rail
| 7
| ScrollLockOff
|-
|-
| 2 || Bluetooth
| 8
|-
| ScrollLockToggle
| 3 || Usb
|}
|}


= UniquePadSerialNumber =
= BasicXpadButtonSet =
This is "nn::hid::system::UniquePadSerialNumber". This is a 0x10 byte value.
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]].


= UniquePadId =
= NpadButtonSet =
This is "nn::hid::system::UniquePadId". This is a 8 byte value.
This is "nn::hid::NpadButtonSet". This is a BitFlagSet object for [[#NpadButton]].


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || ReleaseFromRight
! Bit
! Description
|-
|-
| 1 || ReleaseFromBottom
| 0
| A
|-
|-
| 2 || ReleaseFromLeft
| 1
| B
|-
|-
| 3 || ReleaseFromTop
| 2
| X
|-
|-
| 4 || Rotate
| 3
| Y
|-
|-
| 5 || Update
| 4
| StickL
|-
|-
| 6 || Completed
| 5
| StickR
|-
|-
| 7 || Clear
| 6
| L
|-
|-
| 8 || ClearCompleted
| 7
|}
| R
 
= SixAxisSensorUserCalibrationStage =
This is "nn::hid::system::SixAxisSensorUserCalibrationStage".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Measuring
| 8
| ZL
|-
|-
| 1 || Update
| 9
| ZR
|-
|-
| 2 || Completed
| 10
|}
| Plus
 
= NpadJoyHoldType =
This is "nn::hid::NpadJoyHoldType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Vertical
| 11
| Minus
|-
|-
| 1 || Horizontal
| 12
|}
| Left
 
= NpadJoyDeviceType =
This is "nn::hid::NpadJoyDeviceType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Left
| 13
| Up
|-
|-
| 1 || Right
| 14
|}
| Right
 
= NpadHandheldActivationMode =
This is "nn::hid::NpadHandheldActivationMode".
 
This controls how many joycons must be attached for handheld mode to be triggered (Dual = 2, Single = 1, None = 0).
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Dual
| 15
| Down
|-
|-
| 1 || Single
| 16
| StickLLeft
|-
|-
| 2 || None
| 17
|}
| StickLUp
 
= NpadJoyAssignmentMode =
This is "nn::hid::NpadJoyAssignmentMode".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Dual
| 18
| StickLRight
|-
|-
| 1 || Single
| 19
|}
| StickLDown
 
= NpadCommunicationMode =
This is "nn::hid::NpadCommunicationMode".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || 5ms
| 20
| StickRLeft
|-
|-
| 1 || 10ms
| 21
| StickRUp
|-
|-
| 2 || 15ms
| 22
| StickRRight
|-
|-
| 3 || Default
| 23
|}
| StickRDown
 
= FirmwareVersion =
This is "nn::hid::system::FirmwareVersion" ([1.0.0-2.3.0] "nn::hid::debug::FirmwareVersion").
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 24
! Size
| LeftSL
! Description
|-
| 25
| LeftSR
|-
| 26
| RightSL
|-
| 27
| RightSR
|-
| 28
| Palma
|-
| 29
| Verification
|-
|-
| 0x0
| 30
| 0x1
| HandheldLeftB (Left B button on NES controllers in Handheld mode)
| Major
|-
|-
| 0x1
| 31
| 0x1
| [12.0.0+] LeftC (Left C button in N64 controller)
| Minor
|-
|-
| 0x2
| 32
| 0x1
| [12.0.0+] UpC (Up C button in N64 controller)
| Micro
|-
|-
| 0x3
| 33
| 0x1
| [12.0.0+] RightC (Right C button in N64 controller)
| Revision
|-
|-
| 0x4
| 34
| 0xC
| [12.0.0+] DownC (Down C button in N64 controller)
| [3.0.0+] [[#DeviceIdentifier]]
|}
|}


== DeviceIdentifier ==
= AnalogStickCalibrationFlagsSet =
This is "nn::hid::detail::AnalogStickCalibrationFlagsSet". This is a BitFlagSet object for [[#AnalogStickCalibrationFlags]].
 
= SixAxisSensorUserCalibrationFlagsSet =
This is "nn::hid::detail::SixAxisSensorUserCalibrationFlagsSet". This is a BitFlagSet object for [[#SixAxisSensorUserCalibrationFlags]].
 
= NpadStyleSet =
This is "nn::hid::NpadStyleSet". This is a BitFlagSet object for [[#NpadStyleTag]].
 
= NpadStyleTag =
This is "nn::hid::NpadStyleTag".
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
Value
Bits
!  Description
!  Description
|-
|-
| "JR" || Joy-Con right controller
| 0
| NpadStyleFullKey (Pro Controller)
|-
|-
| "JL" || Joy-Con left controller
| 1
| NpadStyleHandheld (Joy-Con controller in handheld mode)
|-
| 2
| NpadStyleJoyDual (Joy-Con controller in dual mode)
|-
|-
| "FK" || Pro Controller
| 3
| NpadStyleJoyLeft (Joy-Con left controller in single mode)
|-
|-
| "MY" || [[#DeviceTypeInternal|DeviceType]] 4 and [[#DeviceTypeInternal|DeviceType]] 5
| 4
| NpadStyleJoyRight (Joy-Con right controller in single mode)
|-
|-
| "LC" || [[#DeviceTypeInternal|DeviceType]] 6 and [[#DeviceTypeInternal|DeviceType]] 30
| 5
| NpadStyleGc (GameCube controller)
|-
|-
| "HL" || Famicom left controller
| 6
| NpadStylePalma (Poké Ball Plus controller)
|-
|-
| "HR" || Famicom right controller (with microphone)
| 7
| NpadStyleLark (NES/Famicom controller)
|-
|-
| "NL" || NES left controller
| 8
| NpadStyleHandheldLark (NES/Famicom controller in handheld mode)
|-
|-
| "NR" || NES right controller
| 9
| NpadStyleLucia (SNES controller)
|-
|-
| "SN" || SNES controller
| 10
| [12.0.0+] NpadStyleLagon (N64 controller)
|-
|-
| "LT" || N64 controller
| 11
| [13.0.0+] NpadStyleLager (Sega Genesis controller)
|-
|-
| "LS" || Sega Genesis controller
| 12-28
| Reserved
|-
|-
| "PB" || Poké Ball Plus controller
| 29
| NpadStyleSystemExt (generic external controller)
|-
|-
| "SH" || SioH
| 30
| NpadStyleSystem (generic controller)
|-
|-
| "TS" || TouchScreen
| 31
| Reserved
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0x00000000 || None
! Bit
! Description
|-
|-
| 0x01000000 || HandheldNone
| 0
| IsChargingJoyDual
|-
|-
| 0x02000000 || HandheldJoyConLeftOnly
| 1
| IsChargingJoyLeft
|-
|-
| 0x02000001 || HandheldLarkHvc1Only
| 2
| IsChargingJoyRight
|-
|-
| 0x02000002 || HandheldLarkNesLeftOnly
| 3
| IsPoweredJoyDual
|-
|-
| 0x03000000 || HandheldJoyConRightOnly
| 4
| IsPoweredJoyLeft
|-
|-
| 0x03000001 || HandheldLarkHvc2Only
| 5
| IsPoweredJoyRight
|-
|-
| 0x03000002 || HandheldLarkNesRightOnly
| 9
| IsUnsuportedButtonPressedOnNpadSystem
|-
|-
| 0x04000000 || HandheldJoyConLeftJoyConRight
| 10
| IsUnsuportedButtonPressedOnNpadSystemExt
|-
|-
| 0x04000001 || HandheldJoyConLeftLarkHvc2
| 11
| IsAbxyButtonOriented
|-
|-
| 0x04000002 || HandheldJoyConLeftLarkNesRight
| 12
| IsSlSrButtonOriented
|-
|-
| 0x04000003 || HandheldLarkHvc1JoyConRight
| 13
| [4.0.0+] IsPlusAvailable
|-
|-
| 0x04000004 || HandheldLarkHvc1LarkHvc2
| 14
| [4.0.0+] IsMinusAvailable
|-
|-
| 0x04000005 || HandheldLarkHvc1LarkNesRight
| 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"
|-
|-
| 0x04000006 || HandheldLarkNesLeftJoyConRight
! Bit
! Description
|-
|-
| 0x04000007 || HandheldLarkNesLeftLarkHvc2
| 0
| IsUnintendedHomeButtonInputProtectionEnabled
|}
 
= AppletFooterUiAttributesSet =
This is "nn::hid::system::AppletFooterUiAttributesSet". This is a BitFlagSet object for [[#AppletFooterUiAttribute]].
 
= UniquePadType =
This is "nn::hid::system::UniquePadType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0x04000008 || HandheldLarkNesLeftLarkNesRight
| 0 || Embedded
|-
|-
| 0x05000000 || JoyDual
| 1 || FullKeyController
|-
|-
| 0x06000000 || JoyDualLeftOnly
| 2 || RightController
|-
|-
| 0x07000000 || JoyDualRightOnly
| 3 || LeftController
|-
|-
| 0x08000000 || JoyLeftHorizontal
| 4 || DebugPadController
|}
 
= UniquePadInterface =
This is "nn::hid::system::UniquePadInterface".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0x09000000 || JoyLeftVertical
| 0 || Embedded
|-
|-
| 0x0A000000 || JoyRightHorizontal
| 1 || Rail
|-
|-
| 0x0B000000 || JoyRightVertical
| 2 || Bluetooth
|-
|-
| 0x0C000000 || SwitchProController
| 3 || Usb
|}
 
= UniquePadSerialNumber =
This is "nn::hid::system::UniquePadSerialNumber". This is a 0x10 byte value.
 
= UniquePadId =
This is "nn::hid::system::UniquePadId". This is a 8 byte value.
 
= AnalogStickManualCalibrationStage =
This is "nn::hid::system::AnalogStickManualCalibrationStage".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0x0D000000 || CompatibleProController
| 0 || ReleaseFromRight
|-
|-
| 0x0E000000 || CompatibleJoyCon
| 1 || ReleaseFromBottom
|-
|-
| 0x0F000000 || LarkHvc1
| 2 || ReleaseFromLeft
|-
|-
| 0x10000000 || LarkHvc2
| 3 || ReleaseFromTop
|-
|-
| 0x11000000 || LarkNesLeft
| 4 || Rotate
|-
|-
| 0x12000000 || LarkNesRight
| 5 || Update
|-
|-
| 0x13000000 || LuciaU
| 6 || Completed
|-
|-
| 0x13000001 || LuciaJ
| 7 || Clear
|-
|-
| 0x13000002 || LuciaE
| 8 || ClearCompleted
|-
| 0x14000000 || Verification
|-
| 0x15000000 || [13.0.0+] Lagon
|-
| 0xFFFFFFFF || Unknown
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 7,393: Line 7,817:
!  Description
!  Description
|-
|-
| 0 || None
| 0 || Measuring
|-
|-
| 1 || HandheldNone
| 1 || Update
|-
|-
| 2 || HandheldJoyConLeftOnly
| 2 || Completed
|}
 
= NpadJoyHoldType =
This is "nn::hid::NpadJoyHoldType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 3 || HandheldJoyConRightOnly
| 0 || Vertical
|-
|-
| 4 || HandheldJoyConLeftJoyConRight
| 1 || Horizontal
|-
| 5 || JoyDual
|-
| 6 || JoyDualLeftOnly
|-
| 7 || JoyDualRightOnly
|-
| 8 || JoyLeftHorizontal
|-
| 9 || JoyLeftVertical
|-
| 10 || JoyRightHorizontal
|-
| 11 || JoyRightVertical
|-
| 12 || SwitchProController
|-
| 13 || CompatibleProController
|-
| 14 || CompatibleJoyCon
|-
| 15 || LarkHvc1
|-
| 16 || LarkHvc2
|-
| 17 || LarkNesLeft
|-
| 18 || LarkNesRight
|-
| 19 || Lucia
|-
| 20 || Verification
|-
| 21 || [13.0.0+] Lagon
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 7,445: Line 7,843:
!  Description
!  Description
|-
|-
| 0x0 || No1
| 0 || Left
|-
|-
| 0x1 || No2
| 1 || Right
|-
| 0x2 || No3
|-
| 0x3 || No4
|-
| 0x4 || No5
|-
| 0x5 || No6
|-
| 0x6 || No7
|-
| 0x7 || No8
|-
| 0x10 || Other
|-
| 0x20 || Handheld
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 7,473: Line 7,857:
!  Description
!  Description
|-
|-
| 1 || Bluetooth
| 0 || Dual
|-
|-
| 2 || Rail
| 1 || Single
|-
|-
| 3 || USB
| 2 || None
|-
| 4 || Embedded
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 7,489: Line 7,871:
!  Description
!  Description
|-
|-
| 0 || Invalid
| 0 || Dual
|-
|-
| 1 || H1
| 1 || Single
|-
| 2 || H2
|-
| 3 || NL
|-
| 4 || NR
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 7,507: Line 7,883:
!  Description
!  Description
|-
|-
| 0 || Invalid
| 0 || 5ms
|-
|-
| 1 || J
| 1 || 10ms
|-
|-
| 2 || E
| 2 || 15ms
|-
|-
| 3 || U
| 3 || Default
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Invalid
! Offset
! Size
! Description
|-
|-
| 1 || J
| 0x0
| 0x1
| Major
|-
|-
| 2 || E
| 0x1
| 0x1
| Minor
|-
|-
| 3 || U
| 0x2
|}
| 0x1
 
| Micro
= SixAxisSensorProperties =
This is "nn::hid::server::SixAxisSensorProperties".
 
{| class="wikitable" border="1"
|-
|-
! Bit
| 0x3
! Description
| 0x1
| Revision
|-
|-
| 0
| 0x4
| IsSixAxisSensorDeviceNewlyAssigned
| 0xC
|-
| [3.0.0+] [[#DeviceIdentifier]]
| 1
| IsFirmwareUpdateAvailableForSixAxisSensor
|}
|}


= GestureDirection =
== DeviceIdentifier ==
This is "nn::hid::GestureDirection".
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Value
!  Description
!  Description
|-
|-
| 0 || None
| "JR" || Joy-Con right controller
|-
|-
| 1 || Left
| "JL" || Joy-Con left controller
|-
|-
| 2 || Up
| "FK" || Pro Controller
|-
|-
| 3 || Right
| "MY" || MiyabiLeft and MiyabiRight
|-
|-
| 4 || Down
| "LC" || Tarragon and Tarragon2
|}
 
= GestureType =
This is "nn::hid::GestureType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Idle
| "HL" || Famicom left controller
|-
|-
| 1 || Complete
| "HR" || Famicom right controller (with microphone)
|-
|-
| 2 || Cancel
| "NL" || NES left controller
|-
|-
| 3 || Touch
| "NR" || NES right controller
|-
|-
| 4 || Press
| "SN" || SNES controller
|-
|-
| 5 || Tap
| "LT" || N64 controller
|-
|-
| 6 || Pan
| "LS" || Sega Genesis controller
|-
|-
| 7 || Swipe
| "PB" || Poké Ball Plus controller
|-
|-
| 8 || Pinch
| "SH" || SioH
|-
|-
| 9 || Rotate
| "TS" || TouchScreen
|}
|}


= DeviceHandle =
= AppletDetailedUiType =
This is "nn::xcd::DeviceHandle". This is a 8 byte value.
This is "nn::hid::system::AppletDetailedUiType".
 
= DeviceType =
This is "nn::hid::system::DeviceType".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Bits
Value
!  Description
!  Description
|-
|-
| 0
| 0x00000000 || None
| FullKey
|-
|-
| 1
| 0x01000000 || HandheldNone
| DebugPad
|-
|-
| 2
| 0x02000000 || HandheldJoyConLeftOnly
| HandheldLeft
|-
|-
| 3
| 0x02000001 || HandheldLarkHvc1Only
| HandheldRight
|-
|-
| 4
| 0x02000002 || HandheldLarkNesLeftOnly
| JoyLeft
|-
|-
| 5
| 0x03000000 || HandheldJoyConRightOnly
| JoyRight
|-
|-
| 6
| 0x03000001 || HandheldLarkHvc2Only
| Palma
|-
|-
| 7
| 0x03000002 || HandheldLarkNesRightOnly
| LarkHvcLeft
|-
|-
| 8
| 0x04000000 || HandheldJoyConLeftJoyConRight
| LarkHvcRight
|-
|-
| 9
| 0x04000001 || HandheldJoyConLeftLarkHvc2
| LarkNesLeft
|-
|-
| 10
| 0x04000002 || HandheldJoyConLeftLarkNesRight
| LarkNesRight
|-
|-
| 11
| 0x04000003 || HandheldLarkHvc1JoyConRight
| HandheldLarkHvcLeft
|-
|-
| 12
| 0x04000004 || HandheldLarkHvc1LarkHvc2
| HandheldLarkHvcRight
|-
|-
| 13
| 0x04000005 || HandheldLarkHvc1LarkNesRight
| HandheldLarkNesLeft
|-
| 0x04000006 || HandheldLarkNesLeftJoyConRight
|-
| 0x04000007 || HandheldLarkNesLeftLarkHvc2
|-
|-
| 14
| 0x04000008 || HandheldLarkNesLeftLarkNesRight
| HandheldLarkNesRight
|-
|-
| 15
| 0x05000000 || JoyDual
| Lucia
|-
|-
| 16
| 0x06000000 || JoyDualLeftOnly
| [12.0.0+] Lagon
|-
|-
| 17
| 0x07000000 || JoyDualRightOnly
| [13.0.0+] Lager
|-
|-
| 18-30
| 0x08000000 || JoyLeftHorizontal
| Reserved
|-
|-
| 31
| 0x09000000 || JoyLeftVertical
| System
|}
 
= DeviceTypeInternal =
This is "nn::hid::detail::DeviceTypeInternal".
 
{| class="wikitable" border="1"
!  Bits
!  Description
|-
|-
| 0-7
| 0x0A000000 || JoyRightHorizontal
| 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
| 0x0B000000 || JoyRightVertical
| Pro Controller
|-
|-
| 11
| 0x0C000000 || SwitchProController
| Famicom left controller
|-
|-
| 12
| 0x0D000000 || CompatibleProController
| Famicom right controller (with microphone)
|-
|-
| 13
| 0x0E000000 || CompatibleJoyCon
| NES left controller
|-
|-
| 14
| 0x0F000000 || LarkHvc1
| NES right controller
|-
|-
| 15-16
| 0x10000000 || LarkHvc2
| Invalid
|-
|-
| 17
| 0x11000000 || LarkNesLeft
| Generic external controller
|-
|-
| 18-20
| 0x12000000 || LarkNesRight
| Invalid
|-
|-
| 21-23
| 0x13000000 || LuciaU
| Generic controller
|-
|}
| 0x13000001 || LuciaJ
|-
| 0x13000002 || LuciaE
|-
| 0x14000000 || Verification
|-
| 0x15000000 || [13.0.0+] Lagon
|-
| 0xFFFFFFFF || Unknown
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Value
!  [[#DeviceType|DeviceType]]
!  [[#UniquePadType|UniquePadType]]
!  [[#AppletDetailedUiType|AppletDetailedUiType]]
!  Description
!  Description
|-
|-
| 0 || || || || Invalid
| 0 || None
|-
|-
| 1 || JoyRight, HandheldRight || RightController || JoyDual, JoyRightHorizontal, JoyRightVertical, JoyDualRightOnly, HandheldJoyConRightOnly, HandheldJoyConLeftJoyConRight, HandheldLarkHvc1JoyConRight, HandheldLarkNesLeftJoyConRight, HandheldNone || Joy-Con right controller (USB PID 0x2007)
| 1 || HandheldNone
|-
|-
| 2 || JoyLeft, HandheldLeft || LeftController || JoyDual, JoyLeftHorizontal, JoyLeftVertical, JoyDualLeftOnly, HandheldJoyConLeftOnly, HandheldJoyConLeftJoyConRight, HandheldJoyConLeftLarkHvc2, HandheldJoyConLeftLarkNesRight, HandheldNone || Joy-Con left controller (USB PID 0x2006)
| 2 || HandheldJoyConLeftOnly
|-
|-
| 3 || FullKey || FullKeyController || SwitchProController || Pro Controller (USB PID 0x2009)
| 3 || HandheldJoyConRightOnly
|-
|-
| 4 || JoyLeft || LeftController || ||
| 4 || HandheldJoyConLeftJoyConRight
|-
|-
| 5 || JoyRight || RightController || ||
| 5 || JoyDual
|-
|-
| 6 || FullKey || FullKeyController || ||
| 6 || JoyDualLeftOnly
|-
|-
| 7 || LarkHvcLeft, HandheldLarkHvcLeft || LeftController || LarkHvc1, HandheldLarkHvc1Only, HandheldLarkHvc1JoyConRight, HandheldLarkHvc1LarkHvc2, HandheldLarkHvc1LarkNesRight, HandheldNone || Famicom left controller
| 7 || JoyDualRightOnly
|-
|-
| 8 || LarkHvcRight, HandheldLarkHvcRight || RightController || LarkHvc2, HandheldLarkHvc2Only, HandheldJoyConLeftLarkHvc2, HandheldLarkHvc1LarkHvc2, HandheldLarkNesLeftLarkHvc2, HandheldNone || Famicom right controller (with microphone)
| 8 || JoyLeftHorizontal
|-
|-
| 9 || LarkNesLeft, HandheldLarkNesLeft || LeftController || LarkNesLeft, HandheldLarkNesLeftOnly, HandheldLarkNesLeftJoyConRight, HandheldLarkNesLeftLarkHvc2, HandheldLarkNesLeftLarkNesRight, HandheldNone || NES left controller
| 9 || JoyLeftVertical
|-
|-
| 10 || LarkNesRight, HandheldLarkNesRight || RightController || LarkNesRight, HandheldLarkNesRightOnly, HandheldJoyConLeftLarkNesRight, HandheldLarkHvc1LarkNesRight, HandheldLarkNesLeftLarkNesRight, HandheldNone || NES right controller
| 10 || JoyRightHorizontal
|-
|-
| 11 || Lucia || FullKeyController || LuciaU, LuciaJ, LuciaE || SNES controller (USB PID 0x2017)
| 11 || JoyRightVertical
|-
|-
| 12 || Palma || Embedded || Unknown || Poké Ball Plus controller
| 12 || SwitchProController
|-
|-
| 13 || FullKey || FullKeyController || || Gc controller
| 13 || CompatibleProController
|-
|-
| 14 || HandheldLeft || LeftController || || "Fifty" left controller
| 14 || CompatibleJoyCon
|-
| 15 || LarkHvc1
|-
|-
| 15 || FullKey || FullKeyController || ||
| 16 || LarkHvc2
|-
|-
| 16 || FullKey || FullKeyController || ||
| 17 || LarkNesLeft
|-
|-
| 17 || DebugPad || DebugPadController || Verification || Debug controller
| 18 || LarkNesRight
|-
|-
| 18 || HandheldRight || RightController || || "Fifty" right controller
| 19 || Lucia
|-
|-
| 19 || System || Embedded || CompatibleProController || Third party Pro Controller
| 20 || Verification
|-
|-
| 20 || System || Embedded || CompatibleJoyCon, HandheldNone || Third party Joy-Con right controller
| 21 || [13.0.0+] Lagon
|}
 
= NpadIdType =
This is "nn::hid::NpadIdType". This is the controller index used in [[#SharedMemoryFormat|sharedmem]].
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 21 || System || Embedded || CompatibleJoyCon, HandheldNone || Third party Joy-Con left controller
| 0x0 || No1
|-
|-
| [12.0.0+] 22 || Lagon || FullKeyController || Lagon || N64 controller (USB PID 0x2019)
| 0x1 || No2
|-
|-
| [12.0.0+] 23 || || || || Joy-Con Charging Grip (USB PID 0x200E)
| 0x2 || No3
|-
|-
| [13.0.0+] 24 || || || || "Kotetsu" (Pro Controller MCU) in DFU mode (USB PID 0x200F)
| 0x3 || No4
|-
|-
| [13.0.0+] 25 || || || || "Kuina" (Joy-Con Charging Grip MCU) in DFU mode (USB PID 0x2008)
| 0x4 || No5
|-
|-
| [13.0.0+] 26 || || || || SNES controller MCU in DFU mode (USB PID 0x2018)
| 0x5 || No6
|-
|-
| [13.0.0+] 27 || || || || N64 controller MCU in DFU mode (USB PID 0x201A)
| 0x6 || No7
|-
|-
| [13.0.0+] 28 || Lager || FullKeyController || || Sega Genesis controller (USB PID 0x201E)
| 0x7 || No8
|-
|-
| [14.0.0+] 29 || || || || Sega Genesis controller MCU in DFU mode (USB PID 0x201F)
| 0x10 || Other
|-
|-
| [14.0.0+] 30 || FullKey || FullKeyController || ||
| 0x20 || Handheld
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
! Offset
| 1 || Bluetooth
! Size
! Description
|-
|-
| 0x0
| 2 || Rail
| 0x1
| IsPowered
|-
|-
| 0x1
| 3 || Usb
| 0x1
| IsCharging
|-
|-
| 0x2
| 4 || Embedded
| 0x6
| Reserved
|-
| 0x8
| 0x6
| [[#BatteryLevel|BatteryLevel]]
|}
|}


= BatteryLevel =
= NpadLarkType =
This is "nn::hid::system::NpadBatteryLevel". This is a 4 byte value.
This is "nn::hid::NpadLarkType".
 
= 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
|-
| 0 || Invalid
|-
|-
! Offset || Size || Description
| 1 || H1
|-
|-
| 0x0 || 0x4 || TypeValue
| 2 || H2
|-
|-
| 0x0 || 0x1 ||  
| 3 || NL
|-
|-
| 0x1 || 0x1 ||  
| 4 || NR
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
! Offset || Size || Description
| 0 || Invalid
|-
|-
| 0x0 || 0x4 || TypeValue
| 1 || J
|-
|-
| 0x0 || 0x1 || NpadStyleIndex
| 2 || E
|-
|-
| 0x1 || 0x1 || [[#NpadIdType|PlayerNumber]]
| 3 || U
|-
| 0x2 || 0x1 || DeviceIdx
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
! Offset || Size || Description
| 0 || Invalid
|-
|-
| 0x0 || 0x4 || TypeValue
| 1 || J
|-
|-
| 0x0 || 0x1 || NpadStyleIndex
| 2 || E
|-
|-
| 0x1 || 0x1 || [[#NpadIdType|PlayerNumber]]
| 3 || U
|-
| 0x2 || 0x1 || DeviceIdx
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Bit
! Description
|-
|-
| 0x0 || 0x4 || [[#VibrationDeviceType|DeviceType]]
| 0
| IsSixAxisSensorDeviceNewlyAssigned
|-
|-
| 0x4 || 0x4 || [[#VibrationDevicePosition|Position]]
| 1
| IsFirmwareUpdateAvailableForSixAxisSensor
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 7,870: Line 8,208:
!  Description
!  Description
|-
|-
| 0 || Unknown
| 0 || None
|-
| 1 || Left
|-
|-
| 1 || LinearResonantActuator
| 2 || Up
|-
|-
| 2 || GcErm
| 3 || Right
|-
|-
| 3 || Erm
| 4 || Down
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 7,886: Line 8,226:
!  Description
!  Description
|-
|-
| 0 || None
| 0 || Idle
|-
|-
| 1 || Left
| 1 || Complete
|-
|-
| 2 || Right
| 2 || Cancel
|}
 
= VibrationValue =
This is "nn::hid::VibrationValue". This is a 0x10-byte struct, which contains 4 float values.
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 3 || Touch
! Size
! Description
|-
|-
| 0x0
| 4 || Press
| 0x4
| AmplitudeLow
|-
|-
| 0x4
| 5 || Tap
| 0x4
|-
| FrequencyLow
| 6 || Pan
|-
| 7 || Swipe
|-
|-
| 0x8
| 8 || Pinch
| 0x4
| AmplitudeHigh
|-
|-
| 0xC
| 9 || Rotate
| 0x4
| FrequencyHigh
|}
|}


= VibrationGcErmCommand =
= DeviceHandle =
This is "nn::hid::VibrationGcErmCommand".
This is "nn::xcd::DeviceHandle". This is a 8 byte value.
 
= DeviceType =
This is "nn::hid::system::DeviceType".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Value
Bits
!  Name
!  Description
!  Description
|-
|-
| 0 || Stop || Stops the vibration with a decay phase.
| 0
| FullKey
|-
|-
| 1 || Start || Starts the vibration.
| 1
| DebugPad
|-
|-
| 2 || StopHard || Stops the vibration immediately, with no decay phase.
| 2
|}
| HandheldLeft
 
= AccelerometerPlayMode =
This is "nn::hid::debug::AccelerometerPlayMode" (pre-10.0.0 this is "nn::hid::AccelerometerPlayMode").
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Loose
| 3
| HandheldRight
|-
|-
| 1 || Tight
| 4
|}
| JoyLeft
 
= GyroscopeZeroDriftMode =
This is "nn::hid::GyroscopeZeroDriftMode".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Loose
| 5
| JoyRight
|-
|-
| 1 || Standard
| 6
| Palma
|-
|-
| 2 || Tight
| 7
|}
| LarkHvcLeft
 
= 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
| 8
| LarkHvcRight
|-
|-
| 0x0 || 0x4 || [[#PalmaOperationType]]
| 9
| LarkNesLeft
|-
|-
| 0x4 || 0x4 || Result
| 10
| LarkNesRight
|-
|-
| 0x8 || 0x140 || Buffer for [[#GetPalmaOperationInfo]].
| 11
|}
| HandheldLarkHvcLeft
 
= PalmaOperationType =
This is "nn::hid::PalmaOperationType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || PlayActivity
| 12
| HandheldLarkHvcRight
|-
|-
| 1 || SetFrModeType
| 13
| HandheldLarkNesLeft
|-
|-
| 2 || ReadStep
| 14
| HandheldLarkNesRight
|-
|-
| 3 || EnableStep
| 15
| Lucia
|-
|-
| 4 || ResetStep
| 16
| [12.0.0+] Lagon
|-
|-
| 5 || ReadApplicationSection
| 17
| [13.0.0+] Lager
|-
|-
| 6 || WriteApplicationSection
| 18-30
| Reserved
|-
|-
| 7 || ReadUniqueCode
| 31
|-
| System
| 8 || SetUniqueCodeInvalid
|}
 
= 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
|-
|-
| 9 || WriteActivityEntry
| 11
| Famicom left controller
|-
|-
| 10 || WriteRgbLedPatternEntry
| 12
| Famicom right controller (with microphone)
|-
|-
| 11 || WriteWaveEntry
| 13
| NES left controller
|-
|-
| 12 || ReadDataBaseIdentificationVersion
| 14
| NES right controller
|-
|-
| 13 || WriteDataBaseIdentificationVersion
| 15-16
| Invalid
|-
|-
| 14 || SuspendFeature
| 17
| Generic external controller
|-
|-
| 15 || [5.1.0+] ReadPlayLog
| 18-20
| Invalid
|-
|-
| 16 || [5.1.0+] ResetPlayLog
| 21-23
| Generic controller
|}
|}


= PalmaFrModeType =
= DeviceType =
This is "nn::hid::PalmaFrModeType".
This is "nn::hidtypes::DeviceType".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 8,026: Line 8,365:
!  Description
!  Description
|-
|-
| 0 || Off
| 0 || Unknown
|-
| 1 || [[#JoyConRight|JoyConRight]]
|-
| 2 || [[#JoyConLeft|JoyConLeft]]
|-
| 3 || [[#SwitchProController|SwitchProController]]
|-
|-
| 1 || B01
| 4 || MiyabiLeft
|-
|-
| 2 || B02
| 5 || MiyabiRight
|-
|-
| 3 || B03
| 6 || [[#Tarragon|Tarragon]]
|-
|-
| 4 || Downloaded
| 7 || [[#LarkH1|LarkH1]]
|}
 
= 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
| 8 || [[#LarkH2|LarkH2]]
|-
|-
| 0x0 || 0x2 || RgbLedPatternIndex.
| 9 || [[#LarkNL|LarkNL]]
|-
|-
| 0x2 || 0x2 || Padding
| 10 || [[#LarkNR|LarkNR]]
|-
|-
| 0x4 || 0x4 || [[#PalmaWaveSet|WaveSet]].
| 11 || [[#Lucia|Lucia]]
|-
|-
| 0x8 || 0x2 || WaveIndex.
| 12 || [[#Palma|Palma]]
|}
 
= PalmaWaveSet =
This is "nn::hid::PalmaWaveSet".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Small
| 13 || [[#GcOnGggg|GcOnGggg]]
|-
|-
| 1 || Medium
| 14 || FiftyL
|-
|-
| 2 || Large
| 15 || UsbPad
|}
 
= PalmaFeature =
This is "nn::hid::PalmaFeature".
 
{| class="wikitable" border="1"
|-
|-
! Bit
| 16 || WinGenericPad
! Description
|-
|-
| 0
| 17 || Sio
| FrMode
|-
|-
| 1
| 18 || FiftyR
| RumbleFeedback
|-
|-
| 2
| 19 || DebugSwitchProControllerCompatibleDevice
| Step
|-
|-
| 3
| 20 || DebugJoyConLeftCompatibleDevice
| MuteSwitch
|-
|}
 
= AbstractedPadState =
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 21 || DebugJoyConRightCompatibleDevice
|-
|-
| 0x0 || 0x4 || Type, only 1 bit can be set. Converted to [[#HdlsDeviceInfo]]::type internally by [[#SetAutoPilotVirtualPadState]].
| 22 || [12.0.0+] [[#Lagon|Lagon]]
|-
|-
| 0x4 || 0x1 || Flags. [[#SetAutoPilotVirtualPadState]] only uses bit0: when clear it will skip using the rest of the input and run [[#UnsetAutoPilotVirtualPadState]] internally.
| 23 || [12.0.0+] [[#ExternalGrip|ExternalGrip]]
|-
|-
| 0x5 || 0x3 || Padding
| 24 || [13.0.0+] [[#SwitchProControllerDfu|SwitchProControllerDfu]]
|-
|-
| 0x8 || 0x4 || RGBA Single Body Color
| 25 || [13.0.0+] [[#ExternalGripDfu|ExternalGripDfu]]
|-
|-
| 0xC || 0x4 || RGBA Single Buttons Color
| 26 || [13.0.0+] [[#LuciaDfu|LuciaDfu]]
|-
|-
| 0x10 || 0x1 || See [[#HiddbgHdlsDeviceInfo]]::[[#NpadInterfaceType]].
| 27 || [13.0.0+] [[#LagonDfu|LagonDfu]]
|-
|-
| 0x11 || 0x3 || Padding
| 28 || [13.0.0+] [[#Lager|Lager]]
|-
|-
| 0x14 || 0x24 || [[#HdlsState]]. Unknown if the last 4-bytes are included in this struct, [[#SetAutoPilotVirtualPadState]]/[[#hiddbgGetAbstractedPadsState]] only uses the first 0x20-bytes.
| 29 || [14.0.0+] [[#LagerDfu|LagerDfu]]
|-
|-
| 0x38 || 0x60 || Unused with [[#SetAutoPilotVirtualPadState]]/[[#GetAbstractedPadsState]].
| 30 || [14.0.0+] [[#Tarragon2|Tarragon2]]
|}
|}


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


Type:
== Lagon ==
{| class="wikitable" border="1"
N64 controller.
! Bits
 
! [[#HdlsDeviceInfo]]::type bits
== ExternalGrip ==
! Description
Joy-Con Charging Grip.
!  Notes
 
|-
== SwitchProControllerDfu ==
| 0 || 0 || ||
"Kotetsu" (Pro Controller MCU) in DFU mode.
|-
 
| 1 || 15 || || [[#DeviceType]] |= BIT(1)
== 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
|-
|-
| 2 || 1 || ||  
| 0x0
| 0x2
| Vid
|-
|-
| 3 || 2 || ||  
| 0x2
| 0x2
| PidRangeMax
|-
|-
| 4 || 1 || ||  
| 0x4
| 0x2
| PidRangeMin
|-
|-
| 5 || 2 || ||  
| 0x6
| 0x1
| [[#DeviceTypeInternal|DeviceType]]
|-
|-
| 6 || 3 || ||  
| 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"
|-
|-
| 7 || 11 || || [[#DeviceType]] |= BIT(11)
! Vid || PidRangeMax || PidRangeMin || [[#DeviceTypeInternal|DeviceType]] || Description
|-
|-
| 8 || 12 || || [[#DeviceType]] |= BIT(12)
| 0x57E || 0x2006 || 0x2006 || 2 || Nintendo [[HID_services#JoyConLeft|JoyConLeft]]
|-
|-
| 9 || 13 || || [[#DeviceType]] |= BIT(13)
| 0x57E || 0x2007 || 0x2007 || 1 || Nintendo [[HID_services#JoyConRight|JoyConRight]]
|-
|-
| 10 || 14 || || [[#DeviceType]] |= BIT(14)
| 0x57E || 0x2009 || 0x2009 || 3 || Nintendo [[HID_services#SwitchProController|SwitchProController]]
|-
|-
| 11 || 15 || || [[#DeviceType]] |= BIT(11)
| 0x57E || 0x200F || 0x200F || 24 || Nintendo [[HID_services#SwitchProControllerDfu|SwitchProControllerDfu]]
|-
|-
| 12 || 12 || || [[#DeviceType]] |= BIT(12)
| 0x57E || 0x200E || 0x200E || 23 || Nintendo [[HID_services#ExternalGrip|ExternalGrip]]
|-
|-
| 13 || 13 || || [[#DeviceType]] |= BIT(13)
| 0x57E || 0x2008 || 0x2008 || 25 || Nintendo [[HID_services#ExternalGripDfu|ExternalGripDfu]]
|-
|-
| 14 || 14 || || [[#DeviceType]] |= BIT(14)
| 0x57E || 0x2017 || 0x2017 || 11 || Nintendo [[HID_services#Lucia|Lucia]]
|-
|-
| 15 || 17 || ||  
| 0x57E || 0x2018 || 0x2018 || 26 || Nintendo [[HID_services#LuciaDfu|LuciaDfu]]
|-
|-
| 31 || 21 || || [[#DeviceType]] = BIT(31)
| 0x57E || 0x2019 || 0x2019 || 22 || Nintendo [[HID_services#Lagon|Lagon]]
|-
|-
|}
| 0x57E || 0x201A || 0x201A || 27 || Nintendo [[HID_services#LagonDfu|LagonDfu]]
 
The above "[[#DeviceType]] |=" notes only apply when type2 is 0x2.
 
= DebugPadAutoPilotState =
This is "nn::hid::debug::DebugPadAutoPilotState"
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 0x57E || 0x201E || 0x201E || 28 || Nintendo [[HID_services#Lager|Lager]]
! Size
! Description
|-
|-
| 0x0
| 0x57E || 0x201F || 0x201F || 29 || Nintendo [[HID_services#LagerDfu|LagerDfu]]
| 0x4
| [[#DebugPadAttributeSet|Attributes]]
|-
|-
| 0x4
| 0x57E || 0x337 || 0x337 || 13 || Nintendo [[HID_services#GcOnGggg|GcOnGggg]]
| 0x4
| [[#DebugPadButtonSet|Buttons]]
|-
|-
| 0x8
| 0x57E || 0x300E || 0x300E || [17.0.0+] 18 || Nintendo FiftyR
| 0x8
|-
| [[#AnalogStickState|AnalogStickL]]
| 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
|-
|-
| 0x10
| 0x20D6 || 0xA729 || 0xA720 || [1.0.0-20.0.1] 15 || PowerA
| 0x8
| [[#AnalogStickState|AnalogStickR]]
|}
 
= MouseAutoPilotState =
This is "nn::hid::debug::MouseAutoPilotState".
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 0x20D6 || 0xA716 || 0xA710 || [20.1.0+] 15 || PowerA
! Size
! Description
|-
|-
| 0x0
| 0x20D6 || 0xA717 || 0xA717 || [20.1.0+] 15 || PowerA
| 0x4
| X
|-
|-
| 0x4
| 0x20D6 || 0xA719 || 0xA718 || [20.1.0+] 15 || PowerA
| 0x4
| Y
|-
|-
| 0x8
| 0x20D6 || 0xA720 || 0xA720 || [20.1.0+] 15 || PowerA
| 0x4
| DeltaX
|-
|-
| 0xC
| 0x20D6 || 0xA721 || 0xA721 || [20.1.0+] 15 || PowerA
| 0x4
| DeltaY
|-
|-
| 0x10
| 0x20D6 || 0xA726 || 0xA722 || [20.1.0+] 15 || PowerA
| 0x4
| WheelDelta
|-
|-
| 0x14
| 0x20D6 || 0xA731 || 0xA727 || [20.1.0+] 15 || PowerA
| 0x4
| [[#MouseButtonSet|Buttons]]
|-
|-
| 0x18
| 0x33DD || 0xB || 0x1 || 15 || ZUIKI
| 0x4
| [[#MouseAttributeSet|Attributes]]
|}
|}


= KeyboardAutoPilotState =
= NpadPowerInfo =
This is "nn::hid::debug::KeyboardAutoPilotState".
This is "nn::hid::system::NpadPowerInfo".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 8,237: Line 8,608:
|-
|-
| 0x0
| 0x0
| 0x8
| 0x1
| [[#KeyboardModifierSet|Modifiers]]
| IsPowered
|-
|-
| 0x8
| 0x1
| 0x20
| 0x1
| [[#KeyboardKeySet|Keys]]
| IsCharging
|-
| 0x2
| 0x6
| Reserved
|-
| 0x8
| 0x4
| [[#BatteryLevel|BatteryLevel]]
|}
|}


= SleepButtonAutoPilotState =
= BatteryLevel =
This is "nn::hid::debug::SleepButtonAutoPilotState". This is a 0x8-byte struct with 8-byte alignment.
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"
{| class="wikitable" border="1"
|-
|-
! Offset
! Offset || Size || Description
! Size
|-
! Description
| 0x0 || 0x4 || TypeValue
|-
| 0x0 || 0x1 ||
|-
|-
| 0x0 || 0x8 || Buttons (only bit0 is used)
| 0x1 || 0x1 ||  
|}
|}


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


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


= PowerAttribute =
= VibrationDeviceHandle =
This is "nn::hidtypes::PowerAttribute". This is a 32-bit flag.
This is "nn::hid::VibrationDeviceHandle". This is a 4-byte struct with 4-byte alignment.


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


= HdlsAttribute =
= VibrationDeviceInfo =
This is "nn::hidtypes::HdlsAttribute". This is a 32-bit flag.
This is "nn::hid::VibrationDeviceInfo" / "nn::hid::VibrationDeviceInfoForIpc". This is a 0x8-byte struct.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Bits
!  Description
|-
|-
| 0
! Offset || Size || Description
| HasVirtualSixAxisSensorAcceleration
|-
| 0x0 || 0x4 || [[#VibrationDeviceType|DeviceType]]
|-
|-
| 1
| 0x4 || 0x4 || [[#VibrationDevicePosition|Position]]
| HasVirtualSixAxisSensorAngle
|}
|}


= HdlsHandle =
= VibrationDeviceType =
This is "nn::hid::debug::HdlsHandle". This is a 0x8-byte struct with 8-byte alignment.
This is "nn::hid::VibrationDeviceType".
 
= 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"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
! Offset || Size || Description
| 0 || Unknown
|-
|-
| 0x0 || 0x4 || s32 Total entries
| 1 || LinearResonantActuator
|-
|-
| 0x4 || 0x4 || Padding
| 2 || GcErm
|-
|-
| 0x8 || 0x200(0x20*0x10) || Array of [[#HdlsNpadAssignmentEntry]].
| 3 || Erm
|}
|}


= HdlsNpadAssignmentEntry =
= VibrationDevicePosition =
This is a 0x20-byte struct.
This is "nn::hid::VibrationDevicePosition".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
! Offset || Size || Description
| 0 || None
|-
|-
| 0x0 || 0x8 || [[#HdlsHandle]]
| 1 || Left
|-
|-
| 0x8 || 0x4 || ?
| 2 || Right
|-
| 0xC || 0x4 || ?
|-
| 0x10 || 0x8 || ?
|-
| 0x18 || 0x1 || ?
|-
| 0x19 || 0x7 || Padding
|}
|}


= HdlsStateList =
= VibrationValue =
This is a 0x408-byte struct.
This is "nn::hid::VibrationValue". This is a 0x10-byte struct, which contains 4 float values.
 
[9.0.0+] This is a 0x488-byte struct.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| AmplitudeLow
|-
|-
| 0x0 || 0x4 || s32 Total entries
| 0x4
| 0x4
| FrequencyLow
|-
|-
| 0x4 || 0x4 || Padding
| 0x8
| 0x4
| AmplitudeHigh
|-
|-
| 0x8 || <[[#HdlsStateListEntry]] size>*0x10 || Array of [[#HdlsStateListEntry]].
| 0xC
| 0x4
| FrequencyHigh
|}
|}


This contains a list of all controllers, including non-virtual controllers.
= VibrationGcErmCommand =
 
This is "nn::hid::VibrationGcErmCommand".
= HdlsStateListEntry =
This is a 0x40-byte struct.
 
[9.0.0+] This is a 0x48-byte struct.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Name
!  Description
|-
|-
! Offset || Size || Description
| 0 || Stop || Stops the vibration with a decay phase.
|-
|-
| 0x0 || 0x8 || [[#HdlsHandle]]
| 1 || Start || Starts the vibration.
|-
|-
| 0x8 || [[#HdlsDeviceInfo]] size || [[#HdlsDeviceInfo]]. With [[#ApplyHdlsStateList]] this is only used when creating new devices.
| 2 || StopHard || Stops the vibration immediately, with no decay phase.
|-
| 0x8 + [[#HdlsDeviceInfo]] size, with 8-byte alignment || 0x24 || [[#HdlsState]]
|-
| <Immediately following the above> || 0x4 || Padding
|}
|}


= HdlsDeviceInfo =
= AccelerometerPlayMode =
This is "nn::hid::debug::HdlsDeviceInfo". This is a 0x10-byte struct.
This is "nn::hid::debug::AccelerometerPlayMode" (pre-10.0.0 this is "nn::hid::AccelerometerPlayMode").


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
! Offset || Size || Description
| 0 || Loose
|-
|-
| 0x0 || 0x4 || [[#DeviceTypeInternal]]
| 1 || Tight
|-
| 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.
= GyroscopeZeroDriftMode =
This is "nn::hid::GyroscopeZeroDriftMode".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
! Offset || Size || Description
| 0 || Loose
|-
|-
| 0x0 || 0x1 || [[#DeviceTypeInternal]]
| 1 || Standard
|-
|-
| 0x1 || 0x1 || [[#NpadInterfaceType]]. Similar to the field from the old struct.
| 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"
|-
|-
| 0x2 || 0x2 || Padding
! Offset || Size || Description
|-
|-
| 0x4 || 0x4 || RGBA Single Body Color
| 0x0 || 0x4 || [[#PalmaOperationType]]
|-
|-
| 0x8 || 0x4 || RGBA Single Buttons Color
| 0x4 || 0x4 || Result
|-
|-
| 0xC || 0x4 || RGBA Left Grip Color
| 0x8 || 0x140 || Buffer for [[#GetPalmaOperationInfo]].
|-
| 0x10 || 0x4 || RGBA Right Grip Color
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
! Offset || Size || Description
| 0 || PlayActivity
|-
|-
| 0x0 || 0x1 || IsPowered for the main PowerInfo.
| 1 || SetFrModeType
|-
|-
| 0x1 || 0x1 || ORRed with IsPowered to set the value of the first byte for the controller [[#NpadSystemProperties]].
| 2 || ReadStep
|-
|-
| 0x2 || 0x6 || Unknown
| 3 || EnableStep
|-
|-
| 0x8 || 0x4 || BatteryLevel for the main PowerInfo.
| 4 || ResetStep
|-
|-
| 0xC || 0x4 || [[#NpadButton|Buttons]]. Bit18 = HOME and bit19 = Capture.
| 5 || ReadApplicationSection
|-
|-
| 0x10 || 0x10(4*2*2) || Joystick data.
| 6 || WriteApplicationSection
|-
|-
| 0x20 || 0x1 || Indicator. Unused for input. Set with output from [[#DumpHdlsStates]] (zero in some cases).
| 7 || ReadUniqueCode
|-
|-
| 0x21 || 0x3 || Padding
| 8 || SetUniqueCodeInvalid
|}
 
[9.0.0+] (0x28-bytes):
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 9 || WriteActivityEntry
|-
|-
| 0x0 || 0x8 || [[#PowerInfo]]
| 10 || WriteRgbLedPatternEntry
|-
|-
| 0x8 || 0x8 || [[#NpadButton|Buttons]], masked with 0xfffffffff00fffff. See above table regarding HOME/Capture buttons.
| 11 || WriteWaveEntry
|-
|-
| 0x10 || 0x10(4*2*2) || Joystick data.
| 12 || ReadDataBaseIdentificationVersion
|-
|-
| 0x20 || 0x1 || Indicator. Unused for input. Set with output from [[#DumpHdlsStates]] (zero in some cases).
| 13 || WriteDataBaseIdentificationVersion
|-
|-
| 0x21 || 0x7 || Padding
| 14 || SuspendFeature
|-
| 15 || [5.1.0+] ReadPlayLog
|-
| 16 || [5.1.0+] ResetPlayLog
|}
|}


[12.0.0+] (0x40-bytes):
= PalmaFrModeType =
This is "nn::hid::PalmaFrModeType".
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || Off
|-
|-
! Offset || Size || Description
| 1 || B01
|-
|-
| 0x0 || 0x8 || [[#PowerInfo]]
| 2 || B02
|-
|-
| 0x8 || 0x8 || [[#NpadButton|Buttons]], masked with 0xfffffffff00fffff. See above table regarding HOME/Capture buttons.
| 3 || B03
|-
|-
| 0x10 || 0x10(4*2*2) || Joystick data.
| 4 || Downloaded
|}
 
= PalmaApplicationSectionAccessBuffer =
This is "nn::hid::PalmaApplicationSectionAccessBuffer". This is a 0x100-byte struct.
 
= PalmaActivityEntry =
This is "nn::hid::PalmaActivityEntry".
 
{| class="wikitable" border="1"
|-
|-
| 0x20 || 0xC || VirtualSixAxisSensorAcceleration
! Offset || Size || Description
|-
|-
| 0x2C || 0xC || VirtualSixAxisSensorAngle
| 0x0 || 0x2 || RgbLedPatternIndex.
|-
|-
| 0x38 || 0x4 || [[#HdlsAttribute]]
| 0x2 || 0x2 || Padding
|-
|-
| 0x3C || 0x1 || Indicator. Unused for input.
| 0x4 || 0x4 || [[#PalmaWaveSet|WaveSet]].
|-
|-
| 0x3D || 0x3 || Padding
| 0x8 || 0x2 || WaveIndex.
|}
|}


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


= RegisteredDevice =
{| class="wikitable" border="1"
This is "nn::hid::system::RegisteredDevice". This is a 0x68-byte struct with 4-byte alignment.
!  Value
!  Description
|-
| 0 || Small
|-
| 1 || Medium
|-
| 2 || Large
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Bit
! Size
! Description
! Description
|-
|-
| 0x0
| 0
| 0x1
| FrMode
| TimeUnit
|-
|-
| 0x1
| 1
| 0x1
| RumbleFeedback
| FrameCount
|-
|-
| 0x2
| 2
| 0x1
| Step
| CycleCount
|-
|-
| 0x3
| 3
| 0x1
| MuteSwitch
| InitialBrightness
|-
|-
| 0x4
|}
| 0x4 * 15
 
| [[#Frame|Frames]]
= JcmsHandle =
This is "nn::hid::JcmsHandle".
 
This is a 0x4-byte struct.
 
This is exclusive to S2.
 
{| class="wikitable" border="1"
|-
|-
| 0x40
! Offset || Size || Description
| 0x1
| FinalBrightness
|-
|-
| 0x41
| 0x0 || 0x1 || [[#NpadIdType|NpadIdType]] (must be <8)
| 0x1
| TimeTowardsFinalBrightness
|-
|-
| 0x42
| 0x1 || 0x1 || [[#JcmsType|JcmsType]]
| 0x6
| Reserved
|}
|}


== Frame ==
= JcmsType =
This is "nn::hid::JcmsType".
 
This is exclusive to S2.
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
! Offset
| 0 ||
! Size
! Description
|-
|-
| 0x0
| 1 ||
| 0x1
|}
| Brightness
 
= NmouseHandle =
This is "nn::hid::NmouseHandle".
 
This is a 0x8-byte struct.
 
This is exclusive to S2.
 
{| class="wikitable" border="1"
|-
|-
| 0x1
! Offset || Size || Description
| 0x1
| TimeTowards
|-
|-
| 0x2
|}
| 0x1
 
| TimeToHold
= NmousePointerType =
This is u8 enum "nn::hid::NmousePointerType".
 
This is exclusive to S2.
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0x3
| 0x1
| Reserved
|}
|}


= SystemButtonConfigEmbedded =
= NmouseType =
This is "nn::hid::system::ButtonConfigEmbedded". This is a 0x2C8-byte struct.
This is "nn::hid::NmouseType".
 
This is exclusive to S2.


= SystemButtonConfigFull =
{| class="wikitable" border="1"
This is "nn::hid::system::ButtonConfigFull". This is a 0x2C8-byte struct.
|-
! Bit
! Description
|-
| 1 ||
|-
| 2 ||
|}


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


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


= ButtonConfigEmbedded =
This is exclusive to S2.
This is "nn::hidconfig::ButtonConfigEmbedded". This is a 0x54-byte struct.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 8,567: Line 8,996:
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonLeft]]
|}
 
= NmouseButtonConfigJoyRightJcms =
This is "nn::hid::NmouseButtonConfigJoyRightJcms".
 
This is a 0x8-byte struct.
 
This is exclusive to S2.
 
{| class="wikitable" border="1"
|-
|-
| 0x4 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonUp]]
! Offset || Size || Description
|-
|-
| 0x8 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonRight]]
|}
 
= NmouseStateRange =
This is u8 enum "nn::hid::NmouseStateRange".
 
This is exclusive to S2.
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0xC || 0x4 || [[#DigitalButtonAssignment|HardwareButtonDown]]
| 0 || 1280x720
|-
|-
| 0x10 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonA]]
| 1 || 1920x1080
|-
|-
| 0x14 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonB]]
| 2 || 2560x1440
|-
|-
| 0x18 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonX]]
| 3 || 3840x2160
|}
 
= AbstractedPadState =
{| class="wikitable" border="1"
|-
|-
| 0x1C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonY]]
! Offset || Size || Description
|-
|-
| 0x20 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStickL]]
| 0x0 || 0x4 || Type, only 1 bit can be set. Converted to [[#HdlsDeviceInfo]]::type internally by [[#SetAutoPilotVirtualPadState]].
|-
|-
| 0x24 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStickR]]
| 0x4 || 0x1 || Flags. [[#SetAutoPilotVirtualPadState]] only uses bit0: when clear it will skip using the rest of the input and run [[#UnsetAutoPilotVirtualPadState]] internally.
|-
|-
| 0x28 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonL]]
| 0x5 || 0x3 || Padding
|-
|-
| 0x2C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonR]]
| 0x8 || 0x4 || RGBA Single Body Color
|-
|-
| 0x30 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonZL]]
| 0xC || 0x4 || RGBA Single Buttons Color
|-
|-
| 0x34 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonZR]]
| 0x10 || 0x1 || See [[#HiddbgHdlsDeviceInfo]]::[[#NpadInterfaceType]].
|-
|-
| 0x38 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonSelect]]
| 0x11 || 0x3 || Padding
|-
|-
| 0x3C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStart]]
| 0x14 || 0x24 || [[#HdlsState]]. Unknown if the last 4-bytes are included in this struct, [[#SetAutoPilotVirtualPadState]]/[[#hiddbgGetAbstractedPadsState]] only uses the first 0x20-bytes.
|-
|-
| 0x40 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonCapture]]
| 0x38 || 0x60 || Unused with [[#SetAutoPilotVirtualPadState]]/[[#GetAbstractedPadsState]].
|-
| 0x44 || 0x8 || [[#AnalogStickAssignment|HardwareStickL]]
|-
| 0x4C || 0x8 || [[#AnalogStickAssignment|HardwareStickR]]
|}
|}


== DigitalButtonAssignment ==
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.
This is "nn::hidconfig::DigitalButtonAssignment".


Type:
{| class="wikitable" border="1"
{| class="wikitable" border="1"
Value
Bits
!  [[#HdlsDeviceInfo]]::type bits
!  Description
!  Description
!  Notes
|-
|-
| 0 || A
| 0 || 0 || ||
|-
|-
| 1 || B
| 1 || 15 || || [[#DeviceType]] |= BIT(1)
|-
|-
| 2 || X
| 2 || 1 || ||
|-
|-
| 3 || Y
| 3 || 2 || ||
|-
|-
| 4 || StickL
| 4 || 1 || ||
|-
|-
| 5 || StickR
| 5 || 2 || ||
|-
|-
| 6 || L
| 6 || 3 || ||
|-
|-
| 7 || R
| 7 || 11 || || [[#DeviceType]] |= BIT(11)
|-
|-
| 8 || ZL
| 8 || 12 || || [[#DeviceType]] |= BIT(12)
|-
|-
| 9 || ZR
| 9 || 13 || || [[#DeviceType]] |= BIT(13)
|-
|-
| 10 || Select
| 10 || 14 || || [[#DeviceType]] |= BIT(14)
|-
|-
| 11 || Start
| 11 || 15 || || [[#DeviceType]] |= BIT(11)
|-
|-
| 12 || Left
| 12 || 12 || || [[#DeviceType]] |= BIT(12)
|-
|-
| 13 || Up
| 13 || 13 || || [[#DeviceType]] |= BIT(13)
|-
|-
| 14 || Right
| 14 || 14 || || [[#DeviceType]] |= BIT(14)
|-
|-
| 15 || Down
| 15 || 17 || ||
|-
|-
| 16 || LeftSL
| 31 || 21 || || [[#DeviceType]] = BIT(31)
|-
|-
| 17 || LeftSR
|}
 
The above "[[#DeviceType]] |=" notes only apply when type2 is 0x2.
 
= DebugPadAutoPilotState =
This is "nn::hid::debug::DebugPadAutoPilotState"
 
{| class="wikitable" border="1"
|-
|-
| 18 || RightSL
! Offset
! Size
! Description
|-
|-
| 19 || RightSR
| 0x0
| 0x4
| [[#DebugPadAttributeSet|Attributes]]
|-
|-
| 20 || HomeButton
| 0x4
| 0x4
| [[#DebugPadButtonSet|Buttons]]
|-
|-
| 21 || CaptureButton
| 0x8
| 0x8
| [[#AnalogStickState|AnalogStickL]]
|-
|-
| 22 || Invalid
| 0x10
| 0x8
| [[#AnalogStickState|AnalogStickR]]
|}
|}


== AnalogStickAssignment ==
= MouseAutoPilotState =
This is "nn::hidconfig::AnalogStickAssignment".
This is "nn::hid::debug::MouseAutoPilotState".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset
! Size
! Description
|-
|-
| 0x0 || 0x4 || [[#AnalogStickRotation]]
| 0x0
| 0x4
| X
|-
|-
| 0x4 || 0x1 || IsPairedStickAssigned
| 0x4
| 0x4
| Y
|-
|-
| 0x5 || 0x3 || Reserved
| 0x8
|}
| 0x4
 
| DeltaX
== AnalogStickRotation ==
This is "nn::hidconfig::AnalogStickRotation".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || None
| 0xC
| 0x4
| DeltaY
|-
|-
| 1 || Clockwise90
| 0x10
| 0x4
| WheelDelta
|-
| 0x14
| 0x4
| [[#MouseButtonSet|Buttons]]
|-
|-
| 2 || Anticlockwise90
| 0x18
| 0x4
| [[#MouseAttributeSet|Attributes]]
|}
|}


= ButtonConfigFull =
= KeyboardAutoPilotState =
This is "nn::hidconfig::ButtonConfigFull". This is a 0x54-byte struct.
This is "nn::hid::debug::KeyboardAutoPilotState".
 
This is identical to [[#ButtonConfigEmbedded]].
 
= ButtonConfigLeft =
This is "nn::hidconfig::ButtonConfigLeft". This is a 0x34-byte struct.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset
! Size
! Description
|-
|-
| 0x0 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonLeft]]
| 0x0
| 0x8
| [[#KeyboardModifierSet|Modifiers]]
|-
|-
| 0x4 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonUp]]
| 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"
|-
|-
| 0x8 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonRight]]
! Offset
! Size
! Description
|-
|-
| 0xC || 0x4 || [[#DigitalButtonAssignment|HardwareButtonDown]]
| 0x0 || 0x8 || Buttons (only bit0 is used)
|-
| 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 =
= DigitizerAutoPilotState =
This is "nn::hidconfig::ButtonConfigRight". This is a 0x30-byte struct.
This is "nn::hid::debug::DigitizerAutoPilotState".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset
! Size
! Description
|-
|-
| 0x0 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonA]]
| 0x0 || 0x44 ||  
|}
 
= PowerInfo =
This is "nn::hidtypes::PowerInfo".
 
{| class="wikitable" border="1"
|-
|-
| 0x4 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonB]]
! Offset
! Size
! Description
|-
|-
| 0x8 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonX]]
| 0x0 || 0x4 || BatteryLevel
|-
|-
| 0xC || 0x4 || [[#DigitalButtonAssignment|HardwareButtonY]]
| 0x4 || 0x4 || [[#PowerAttribute]]
|-
| 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 =
= PowerAttribute =
This is "nn::hidconfig::StorageName". This is a 0x81-byte struct.
This is "nn::hidtypes::PowerAttribute". This is a 32-bit flag.
 
This is an UTF-8 NUL-terminated name string.
 
= InterfaceType =
This is "nn::hidtypes::InterfaceType".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Value
Bits
!  Description
!  Description
|-
|-
| 1 || Bluetooth
| 0
| IsPowered
|-
|-
| 2 || Rail
| 1
|-
| IsCharging
| 3 || USB
|-
| 4 || Embedded
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
! Bits
! Bit
! Description
! Description
|-
|-
| 0
| 0
| A
| HasVirtualSixAxisSensorAcceleration
|-
|-
| 1
| 1
| B
| 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"
|-
|-
| 2
! Offset || Size || Description
| X
|-
|-
| 3
| 0x0 || 0x4 || s32 Total entries
| Y
|-
|-
| 4
| 0x4 || 0x4 || Padding
| StickL
|-
|-
| 5
| 0x8 || 0x200(0x20*0x10) || Array of [[#HdlsNpadAssignmentEntry]].
| StickR
|}
 
= HdlsNpadAssignmentEntry =
This is a 0x20-byte struct.
 
{| class="wikitable" border="1"
|-
|-
| 6
! Offset || Size || Description
| L
|-
|-
| 7
| 0x0 || 0x8 || [[#HdlsHandle]]
| R
|-
|-
| 8
| 0x8 || 0x4 || ?
| ZL
|-
|-
| 9
| 0xC || 0x4 || ?
| ZR
|-
|-
| 10
| 0x10 || 0x8 || ?
| Start
|-
|-
| 11
| 0x18 || 0x1 || ?
| Select
|-
|-
| 12
| 0x19 || 0x7 || Padding
| Left
|}
 
= HdlsStateList =
This is a 0x408-byte struct.
 
[9.0.0+] This is a 0x488-byte struct.
 
{| class="wikitable" border="1"
|-
|-
| 13
! Offset || Size || Description
| Up
|-
|-
| 14
| 0x0 || 0x4 || s32 Total entries
| Right
|-
|-
| 15
| 0x4 || 0x4 || Padding
| Down
|-
|-
| 16
| 0x8 || <[[#HdlsStateListEntry]] size>*0x10 || Array of [[#HdlsStateListEntry]].
| SL
|}
 
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"
|-
|-
| 17
! Offset || Size || Description
| SR
|-
|-
| 18
| 0x0 || 0x8 || [[#HdlsHandle]]
| Home
|-
|-
| 19
| 0x8 || [[#HdlsDeviceInfo]] size || [[#HdlsDeviceInfo]]. With [[#ApplyHdlsStateList]] this is only used when creating new devices.
| Shot
|-
|-
| 20
| 0x8 + [[#HdlsDeviceInfo]] size, with 8-byte alignment || 0x24 || [[#HdlsState]]
| StickLLeft
|-
|-
| 21
| <Immediately following the above> || 0x4 || Padding
| StickLUp
|}
 
= HdlsDeviceInfo =
This is "nn::hid::debug::HdlsDeviceInfo". This is a 0x10-byte struct.
 
{| class="wikitable" border="1"
|-
|-
| 22
! Offset || Size || Description
| StickLRight
|-
|-
| 23
| 0x0 || 0x4 || [[#DeviceTypeInternal]]
| StickLDown
|-
|-
| 24
| 0x4 || 0x4 || RGBA Single Body Color
| StickRLeft
|-
|-
| 25
| 0x8 || 0x4 || RGBA Single Buttons Color
| StickRUp
|-
|-
| 26
| 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.
| StickRRight
|-
|-
| 27
| 0xD || 0x3 || Padding
| StickRDown
|}
 
[9.0.0+] This is a 0x14-byte struct.
 
{| class="wikitable" border="1"
|-
|-
| 28
! Offset || Size || Description
| Palma
|-
|-
| 29
| 0x0 || 0x1 || [[#DeviceTypeInternal]]
| HandheldLeftB
|-
|-
| 30
| 0x1 || 0x1 || [[#NpadInterfaceType]]. Similar to the field from the old struct.
| Plus
|-
|-
| 31
| 0x2 || 0x2 || Padding
| Minus
|-
|-
| 32
| 0x4 || 0x4 || RGBA Single Body Color
| Z
|-
|-
| 33
| 0x8 || 0x4 || RGBA Single Buttons Color
| LeftSL
|-
|-
| 34
| 0xC || 0x4 || RGBA Left Grip Color
| LeftSR
|-
|-
| 35
| 0x10 || 0x4 || RGBA Right Grip Color
| RightSL
|-
| 36
| RightSR
|-
| 37
| LeftC
|-
| 38
| UpC
|-
| 39
| RightC
|-
| 40
| DownC
|}
|}


= AssignmentStyle =
= HdlsState =
This is "nn::hidtypes::AssignmentStyle". This is a 32-bit flag.
This is "nn::hid::debug::HdlsState". This is a 0x24-byte struct.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Bit
! Offset || Size || Description
! Description
|-
|-
| 0
| 0x0 || 0x1 || IsPowered for the main PowerInfo.
| IsExternalAssigned
|-
|-
| 1
| 0x1 || 0x1 || ORRed with IsPowered to set the value of the first byte for the controller [[#NpadSystemProperties]].
| IsExternalLeftAssigned
|-
|-
| 2
| 0x2 || 0x6 || Unknown
| IsExternalRightAssigned
|-
|-
| 3
| 0x8 || 0x4 || BatteryLevel for the main PowerInfo.
| IsHandheldAssigned
|-
|-
| 4
| 0xC || 0x4 || [[#NpadButton|Buttons]]. Bit18 = HOME and bit19 = Capture.
| IsHandheldLeftAssigned
|-
| 0x10 || 0x10(4*2*2) || Joystick data.
|-
| 0x20 || 0x1 || Indicator. Unused for input. Set with output from [[#DumpHdlsStates]] (zero in some cases).
|-
|-
| 5
| 0x21 || 0x3 || Padding
| IsHandheldRightAssigned
|}
|}


= FeatureType =
[9.0.0+] (0x28-bytes):
This is "nn::hidtypes::FeatureType". This is a 64-bit flag.
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Bit
! Offset || Size || Description
! Description
|-
|-
| 0
| 0x0 || 0x8 || [[#PowerInfo]]
| HasLeftAnalogStick
|-
|-
| 1
| 0x8 || 0x8 || [[#NpadButton|Buttons]], masked with 0xfffffffff00fffff. See above table regarding HOME/Capture buttons.
| HasRightAnalogStick
|-
|-
| 2
| 0x10 || 0x10(4*2*2) || Joystick data.
| HasLeftSixAxisSensor
|-
|-
| 3
| 0x20 || 0x1 || Indicator. Unused for input. Set with output from [[#DumpHdlsStates]] (zero in some cases).
| HasRightSixAxisSensor
|-
|-
| 4
| 0x21 || 0x7 || Padding
| HasExternalSixAxisSensor
|}
 
[12.0.0+] (0x40-bytes):
{| class="wikitable" border="1"
|-
|-
| 5
! Offset || Size || Description
| HasLeftLraVibrationDevice
|-
|-
| 6
| 0x0 || 0x8 || [[#PowerInfo]]
| HasRightLraVibrationDevice
|-
|-
| 7
| 0x8 || 0x8 || [[#NpadButton|Buttons]], masked with 0xfffffffff00fffff. See above table regarding HOME/Capture buttons.
| HasGcVibrationDevice
|-
|-
| 8
| 0x10 || 0x10(4*2*2) || Joystick data.
| HasErmVibrationDevice
|-
|-
| 9
| 0x20 || 0xC || VirtualSixAxisSensorAcceleration
| HasLeftJoyRailBus
|-
|-
| 10
| 0x2C || 0xC || VirtualSixAxisSensorAngle
| HasRightJoyRailBus
|-
|-
| 11
| 0x38 || 0x4 || [[#HdlsAttribute]]
| HasInternalBus
|-
|-
| 12
| 0x3C || 0x1 || Indicator. Unused for input.
| HasPalmaIc
|-
|-
| 13
| 0x3D || 0x3 || Padding
| HasNfc
|}
|-
 
| 14
= DebugRegisteredDevice =
| HasIrSensor
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"
|-
|-
| 15
! Offset
| IsAnalogStickCalibrationSupported
! Size
! Description
|-
|-
| 16
| 0x0
| IsSixAxisSensorUserCalibrationSupported
| 0x1
| TimeUnit
|-
|-
| 17
| 0x1
| HasLeftRightBattery
| 0x1
| FrameCount
|-
|-
| 18
| 0x2
| HasStandardBattery
| 0x1
| CycleCount
|-
|-
| 19
| 0x3
| HasBattery
| 0x1
| InitialBrightness
|-
|-
| 20
| 0x4
| HasMainColor
| 0x4 * 15
| [[#Frame|Frames]]
|-
|-
| 21
| 0x40
| HasSubColor
| 0x1
| FinalBrightness
|-
|-
| 22
| 0x41
| HasIdentificationCode
| 0x1
| TimeTowardsFinalBrightness
|-
|-
| 23
| 0x42
| HasBluetoothAddress
| 0x6
| Reserved
|}
 
== Frame ==
{| class="wikitable" border="1"
|-
|-
| 24
! Offset
| HasMcu
! Size
! Description
|-
|-
| 25
| 0x0
| HasNotificationLed
| 0x1
| Brightness
|-
|-
| 26
| 0x1
| HasDirectionalButtons
| 0x1
| TimeTowards
|-
|-
| 27
| 0x2
| HasIndicatorLed
| 0x1
| TimeToHold
|-
|-
| 28
| 0x3
| IsEmbeddedController
| 0x1
|-
| Reserved
| 29
| IsFullController
|-
| 30
| IsLeftController
|-
| 31
| IsRightController
|-
| 32
| IsUsbHidDevice
|-
| 33
| IsKuinaDevice
|-
| 34
| IsDirectUsbToBtSwitchingDevice
|-
| 35
| NormalizeAnalogStickWithInnerCross
|}
|}


= Color =
= SystemButtonConfigEmbedded =
This is "nn::hidtypes::Color".
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"
{| class="wikitable" border="1"
Line 9,059: Line 9,516:
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x4 || BodyColor
| 0x0 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonLeft]]
|-
| 0x4 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonUp]]
|-
|-
| 0x4 || 0x4 || ButtonColor
| 0x8 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonRight]]
|-
|-
| 0x8 || 0x4 || LeftGripColor
| 0xC || 0x4 || [[#DigitalButtonAssignment|HardwareButtonDown]]
|-
|-
| 0xC || 0x4 || RightGripColor
| 0x10 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonA]]
|}
|-
 
| 0x14 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonB]]
= DeviceDescriptorType =
This is "nn::hidtypes::DeviceDescriptorType".
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 0x18 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonX]]
|-
|-
| 0x0 || 0x1 || [[#DeviceTypeInternal|DeviceType]]
| 0x1C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonY]]
|-
|-
| 0x1 || 0x7 || Reserved
| 0x20 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStickL]]
|-
|-
| 0x8 || 0x8 || [[#FeatureType|FeatureType]]
| 0x24 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStickR]]
|-
|-
| 0x10 || 0x8 || [[#DigitalButton|DigitalButton]]
| 0x28 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonL]]
|-
|-
| 0x18 || 0x4 || [[#AssignmentStyle|AssignmentStyle]]
| 0x2C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonR]]
|-
|-
| 0x1C || 0x10 || [[#Color|DeviceColor]]
| 0x30 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonZL]]
|-
|-
| 0x2C || 0x4 || Reserved
| 0x34 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonZR]]
|}
 
= UnmaskFeatureDescriptorType =
This is "nn::hid::server::UnmaskFeatureDescriptorType".
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 0x38 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonSelect]]
|-
|-
| 0x0 || 0x1 || [[#DeviceTypeInternal|DeviceType]]
| 0x3C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStart]]
|-
|-
| 0x1 || 0x1 || [[#InterfaceType|InterfaceType]]
| 0x40 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonCapture]]
|-
|-
| 0x2 || 0x6 || Reserved
| 0x44 || 0x8 || [[#AnalogStickAssignment|HardwareStickL]]
|-
|-
| 0x8 || 0x8 || [[#FeatureType|FeatureType]]
| 0x4C || 0x8 || [[#AnalogStickAssignment|HardwareStickR]]
|}
|}


= FirmwareVersionInfo =
== DigitalButtonAssignment ==
This is "nn::hidtypes::FirmwareVersionInfo".
This is "nn::hidconfig::DigitalButtonAssignment".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || A
|-
|-
! Offset || Size || Description
| 1 || B
|-
| 2 || X
|-
|-
| 0x0 || 0x4 || [[#FirmwareVersionAttribute|FirmwareVersionAttribute]]
| 3 || Y
|-
|-
| 0x4 || 0x2 ||
| 4 || StickL
|-
|-
| 0x6 || 0x2 || MajorVersion
| 5 || StickR
|-
|-
| 0x8 || 0x2 || MinorVersion
| 6 || L
|-
|-
| 0xA || 0x2 ||
| 7 || R
|}
|-
 
| 8 || ZL
= FirmwareVersionAttribute =
|-
This is "nn::hidtypes::FirmwareVersionAttribute". This is a 32-bit flag.
| 9 || ZR
 
|-
{| class="wikitable" border="1"
| 10 || Select
|-
| 11 || Start
|-
| 12 || Left
|-
| 13 || Up
|-
| 14 || Right
|-
| 15 || Down
|-
| 16 || LeftSL
|-
| 17 || LeftSR
|-
| 18 || RightSL
|-
| 19 || RightSR
|-
|-
! Bit
| 20 || HomeButton
! Description
|-
|-
| 0
| 21 || CaptureButton
| IsCustomerCodeCorruption
|-
|-
| 1
| 22 || Invalid
| IsIapCorrupted
|}
|}


= IrCameraHandle =
== AnalogStickAssignment ==
This is "nn::irsensor::IrCameraHandle".
This is "nn::hidconfig::AnalogStickAssignment".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 9,146: Line 9,616:
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x1 || PlayerNumber
| 0x0 || 0x4 || [[#AnalogStickRotation]]
|-
|-
| 0x1 || 0x1 || DeviceType
| 0x4 || 0x1 || IsPairedStickAssigned
|-
|-
| 0x2 || 0x2 || Reserved
| 0x5 || 0x3 || Reserved
|}
|}


= IrCameraStatus =
== AnalogStickRotation ==
This is "nn::irsensor::IrCameraStatus".
This is "nn::hidconfig::AnalogStickRotation".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 9,160: Line 9,630:
!  Description
!  Description
|-
|-
| 0 || Available
| 0 || None
|-
|-
| 1 || Unsupported
| 1 || Clockwise90
|-
|-
| 2 || Unconnected
| 2 || Anticlockwise90
|}
|}


= IrCameraInternalStatus =
= ButtonConfigFull =
This is "nn::irsensor::IrCameraInternalStatus".
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"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Stopped
! Offset || Size || Description
|-
| 0x0 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonLeft]]
|-
| 0x4 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonUp]]
|-
| 0x8 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonRight]]
|-
| 0xC || 0x4 || [[#DigitalButtonAssignment|HardwareButtonDown]]
|-
|-
| 1 || FirmwareUpdateNeeded
| 0x10 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStickL]]
|-
|-
| 2 ||  
| 0x14 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonL]]
|-
|-
| 3 ||  
| 0x18 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonZL]]
|-
|-
| 4 ||  
| 0x1C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonSelect]]
|-
|-
| 5 || FirmwareVersionRequested
| 0x20 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonLeftSL]]
|-
|-
| 6 || FirmwareVersionIsInvalid
| 0x24 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonLeftSR]]
|-
|-
| 7 || [4.0.0+] Ready
| 0x28 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonCapture]]
|-
|-
| 8 || [4.0.0+] Setting
| 0x2C || 0x8 || [[#AnalogStickAssignment|HardwareStickL]]
|}
|}


= IrSensorMode =
= ButtonConfigRight =
This is "nn::irsensor::detail::StatusManager::IrSensorMode".
This is "nn::hidconfig::ButtonConfigRight". This is a 0x30-byte struct.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || None
! Offset || Size || Description
|-
|-
| 1 || [[#MomentProcessorState|MomentProcessor]]
| 0x0 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonA]]
|-
|-
| 2 || [[#ClusteringProcessorState|ClusteringProcessor]]
| 0x4 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonB]]
|-
|-
| 3 || [[#ImageTransferProcessorState|ImageTransferProcessor]]
| 0x8 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonX]]
|-
|-
| 4 || [[#PointingProcessorMarkerState|PointingProcessorMarker]]
| 0xC || 0x4 || [[#DigitalButtonAssignment|HardwareButtonY]]
|-
|-
| 5 || [[#TeraPluginProcessorState|TeraPluginProcessor]]
| 0x10 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStickR]]
|-
|-
| 6 || Unknown
| 0x14 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonR]]
|}
 
= ImageProcessorStatus =
This is "nn::irsensor::ImageProcessorStatus".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Stopped
| 0x18 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonZR]]
|-
| 0x1C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStart]]
|-
| 0x20 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonRightSL]]
|-
| 0x24 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonRightSR]]
|-
|-
| 1 || Running
| 0x28 || 0x8 || [[#AnalogStickAssignment|HardwareStickR]]
|}
|}


= ImageTransferProcessorFormat =
= StorageName =
This is "nn::irsensor::ImageTransferProcessorFormat".
This is "nn::hidconfig::StorageName". This is a 0x81-byte struct.
 
This is an UTF-8 NUL-terminated name string.


This controls the IR Sensor image resolution.
= InterfaceType =
This is "nn::hidtypes::InterfaceType".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 9,236: Line 9,716:
!  Description
!  Description
|-
|-
| 0 || 320x240
| 1 || Bluetooth
|-
|-
| 1 || 160x120
| 2 || Rail
|-
|-
| 2 || 80x60
| 3 || Usb
|-
|-
| 3 || [4.0.0+] 40x30
| 4 || Embedded
|-
| 4 || [4.0.0+] 20x15
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Bit
! Description
|-
|-
| 0x0 || 0x8 || ExposureTime (default is 0x493E0)
| 0
| A
|-
|-
| 0x8 || 0x4 || LightTarget (default is 0)
| 1
| B
|-
|-
| 0xC || 0x4 || Gain (default is 0x8)
| 2
| X
|-
|-
| 0x10 || 0x1 || IsNegativeImageUsed (default is 0)
| 3
| Y
|-
|-
| 0x11 || 0x7 || Reserved
| 4
| StickL
|-
|-
| 0x18 || 0x2 || WindowOfInterestX (default is 0)
| 5
| StickR
|-
|-
| 0x1A || 0x2 || WindowOfInterestY (default is 0)
| 6
| L
|-
|-
| 0x1C || 0x2 || WindowOfInterestWidth (default is 0x140)
| 7
| R
|-
|-
| 0x1E || 0x2 || WindowOfInterestHeight (default is 0xF0)
| 8
| ZL
|-
|-
| 0x20 || 0x4 || Preprocess (default is 0x1)
| 9
| ZR
|-
|-
| 0x24 || 0x4 || PreprocessIntensityThreshold (default is 0x50)
| 10
|}
| Start
 
= PackedMomentProcessorConfig =
This is "nn::irsensor::PackedMomentProcessorConfig".
 
This is converted from [[#MomentProcessorConfig]].
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 11
| Select
|-
|-
| 0x0 || 0x8 || ExposureTime (default is 0x493E0)
| 12
| Left
|-
|-
| 0x8 || 0x1 || LightTarget (default is 0)
| 13
| Up
|-
|-
| 0x9 || 0x1 || Gain (default is 0x8)
| 14
| Right
|-
|-
| 0xA || 0x1 || IsNegativeImageUsed (default is 0)
| 15
| Down
|-
|-
| 0xB || 0x5 || Reserved
| 16
| SL
|-
|-
| 0x10 || 0x2 || WindowOfInterestX (default is 0)
| 17
| SR
|-
|-
| 0x12 || 0x2 || WindowOfInterestY (default is 0)
| 18
| Home
|-
|-
| 0x14 || 0x2 || WindowOfInterestWidth (default is 0x140)
| 19
| Shot
|-
|-
| 0x16 || 0x2 || WindowOfInterestHeight (default is 0xF0)
| 20
| StickLLeft
|-
|-
| 0x18 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
| 21
| StickLUp
|-
|-
| 0x1C || 0x1 || Preprocess (default is 0x1)
| 22
| StickLRight
|-
|-
| 0x1D || 0x1 || PreprocessIntensityThreshold (default is 0x50)
| 23
| StickLDown
|-
|-
| 0x1E || 0x2 || Reserved
| 24
|}
| StickRLeft
 
= ClusteringProcessorConfig =
This is "nn::irsensor::ClusteringProcessorConfig".
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 25
| StickRUp
|-
| 26
| StickRRight
|-
| 27
| StickRDown
|-
|-
| 0x0 || 0x8 || ExposureTime (default is 200000)
| 28
| Palma
|-
|-
| 0x8 || 0x4 || LightTarget (default is 0)
| 29
| HandheldLeftB
|-
|-
| 0xC || 0x4 || Gain (default is 0x2)
| 30
| Plus
|-
|-
| 0x10 || 0x1 || IsNegativeImageUsed (default is 0)
| 31
| Minus
|-
|-
| 0x11 || 0x7 || Reserved
| 32
| Z
|-
|-
| 0x18 || 0x2 || WindowOfInterestX (default is 0)
| 33
| LeftSL
|-
|-
| 0x1A || 0x2 || WindowOfInterestY (default is 0)
| 34
| LeftSR
|-
|-
| 0x1C || 0x2 || WindowOfInterestWidth (default is 320)
| 35
| RightSL
|-
|-
| 0x1E || 0x2 || WindowOfInterestHeight (default is 240)
| 36
| RightSR
|-
|-
| 0x20 || 0x4 || ObjectPixelCountMin (default is 0x3)
| 37
| LeftC
|-
|-
| 0x24 || 0x4 || ObjectPixelCountMax (default is 0x12C00)
| 38
| UpC
|-
|-
| 0x28 || 0x4 || ObjectIntensityMin (default is 150)
| 39
| RightC
|-
|-
| 0x2C || 0x1 || IsExternalLightFilterEnabled (default is 0x1)
| 40
| DownC
|}
|}


= PackedClusteringProcessorConfig =
= AssignmentStyle =
This is "nn::irsensor::PackedClusteringProcessorConfig".
This is "nn::hidtypes::AssignmentStyle". This is a 32-bit flag.
 
This is converted from [[#ClusteringProcessorConfig]].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Bit
! Description
|-
|-
| 0x0 || 0x8 || ExposureTime
| 0
| IsExternalAssigned
|-
|-
| 0x8 || 0x1 || LightTarget
| 1
| IsExternalLeftAssigned
|-
|-
| 0x9 || 0x1 || Gain
| 2
| IsExternalRightAssigned
|-
|-
| 0xA || 0x1 || IsNegativeImageUsed
| 3
| IsHandheldAssigned
|-
|-
| 0xB || 0x5 || Reserved
| 4
| IsHandheldLeftAssigned
|-
|-
| 0x10 || 0x2 || WindowOfInterestX
| 5
| IsHandheldRightAssigned
|}
 
= FeatureType =
This is "nn::hidtypes::FeatureType". This is a 64-bit flag.
 
{| class="wikitable" border="1"
|-
|-
| 0x12 || 0x2 || WindowOfInterestY
! Bit
! Description
|-
|-
| 0x14 || 0x2 || WindowOfInterestWidth
| 0
| HasLeftAnalogStick
|-
|-
| 0x16 || 0x2 || WindowOfInterestHeight
| 1
| HasRightAnalogStick
|-
|-
| 0x18 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
| 2
| HasLeftJoySixAxisSensor
|-
|-
| 0x1C || 0x4 || ObjectPixelCountMin
| 3
| HasRightJoySixAxisSensor
|-
|-
| 0x20 || 0x4 || ObjectPixelCountMax
| 4
| HasFullKeySixAxisSensor
|-
|-
| 0x24 || 0x1 || ObjectIntensityMin
| 5
| HasLeftLraVibrationDevice
|-
|-
| 0x25 || 0x1 || IsExternalLightFilterEnabled
| 6
| HasRightLraVibrationDevice
|-
|-
| 0x26 || 0x2 || Reserved
| 7
|}
| HasGcVibrationDevice
 
= ImageTransferProcessorConfig =
This is "nn::irsensor::ImageTransferProcessorConfig".
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 8
| HasErmVibrationDevice
|-
|-
| 0x0 || 0x8 || ExposureTime
| 9
| HasLeftJoyRailBus
|-
|-
| 0x8 || 0x4 || LightTarget
| 10
| HasRightJoyRailBus
|-
|-
| 0xC || 0x4 || Gain
| 11
| HasInternalBus
|-
|-
| 0x10 || 0x1 || IsNegativeImageUsed
| 12
| IsPalma
|-
|-
| 0x11 || 0x7 || Reserved
| 13
| HasNfc
|-
|-
| 0x18 || 0x4 || [[#ImageTransferProcessorFormat|Format]]
| 14
|}
| HasIrSensor
 
= PackedImageTransferProcessorConfig =
This is "nn::irsensor::PackedImageTransferProcessorConfig".
 
This is converted from [[#ImageTransferProcessorConfig]].
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 15
| IsAnalogStickCalibrationSupported
|-
|-
| 0x0 || 0x8 || ExposureTime
| 16
| IsSixAxisSensorUserCalibrationSupported
|-
|-
| 0x8 || 0x1 || LightTarget
| 17
| HasLeftJoyRightJoyBattery
|-
|-
| 0x9 || 0x1 || Gain
| 18
| HasFullKeyBattery
|-
|-
| 0xA || 0x1 || IsNegativeImageUsed
| 19
| IsDisconnectControllerIfBatteryNone
|-
|-
| 0xB || 0x5 || Reserved
| 20
| HasControllerColor
|-
|-
| 0x10 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
| 21
| HasGripColor
|-
|-
| 0x14 || 0x1 || [[#ImageTransferProcessorFormat|Format]]
| 22
| HasIdentificationCode
|-
|-
| 0x15 || 0x3 || Reserved
| 23
|}
| HasBluetoothAddress
 
= ImageTransferProcessorState =
This is "nn::irsensor::ImageTransferProcessorState".
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 24
| HasMcu
|-
|-
| 0x0 || 0x8 || SamplingNumber
| 25
| HasNotificationLed
|-
|-
| 0x8 || 0x4 || AmbientNoiseLevel
| 26
| HasDirectionalButtons
|-
|-
| 0xC || 0x4 || Reserved
| 27
|}
| HasIndicatorLed
 
= TeraPluginProcessorConfig =
This is "nn::irsensor::TeraPluginProcessorConfig".
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 28
| IsButtonConfigEmbeddedSupported
|-
| 29
| IsButtonConfigFullSupported
|-
| 30
| IsButtonConfigLeftSupported
|-
| 31
| IsButtonConfigRightSupported
|-
|-
| 0x0 || 0x1 || Mode
| 32
| IsUsbHidDevice
|-
|-
| 0x1 || 0x1 ||  
| 33
| IsKuinaDevice
|-
|-
| 0x2 || 0x1 ||  
| 34
| IsDirectUsbToBtSwitchingDevice
|-
|-
| 0x3 || 0x1 ||  
| 35
| IsNormalizeAnalogStickWithInnerCross
|}
|}


= PackedTeraPluginProcessorConfig =
= Color =
This is "nn::irsensor::PackedTeraPluginProcessorConfig".
This is "nn::hidtypes::Color".


This is converted from [[#TeraPluginProcessorConfig]]. The data starting at offset 0x5 is only initialized by the user-process with [6.0.0+].
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || BodyColor
|-
| 0x4 || 0x4 || ButtonColor
|-
| 0x8 || 0x4 || LeftGripColor
|-
| 0xC || 0x4 || RightGripColor
|}


[[#TeraPluginProcessorConfig]] +0x0, +0x2, and +0x3 are copied to +0x4, 0x6, and +0x7 here. +0x5 here is set to 0x2 | ([[#TeraPluginProcessorConfig]]+0x1 << 7).
= DeviceDescriptorType =
This is "nn::hidtypes::DeviceDescriptorType".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 9,474: Line 10,024:
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
| 0x0 || 0x1 || [[#DeviceTypeInternal|DeviceType]]
|-
| 0x1 || 0x7 || Reserved
|-
| 0x8 || 0x8 || [[#FeatureType|FeatureType]]
|-
|-
| 0x4 || 0x1 || Mode
| 0x10 || 0x8 || [[#DigitalButton|DigitalButton]]
|-
|-
| 0x5 || 0x1 ||  
| 0x18 || 0x4 || [[#AssignmentStyle|AssignmentStyle]]
|-
|-
| 0x6 || 0x1 ||  
| 0x1C || 0x10 || [[#Color|DeviceColor]]
|-
|-
| 0x7 || 0x1 ||  
| 0x2C || 0x4 || Reserved
|}
|}


= PointingProcessorConfig =
= 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".
This is "nn::irsensor::PointingProcessorConfig".
 
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x2 || WindowOfInterestX (default is 0)
| 0x0 || 0x2 || WindowOfInterestX (default is 0)
|-
|-
| 0x2 || 0x2 || WindowOfInterestY (default is 0)
| 0x2 || 0x2 || WindowOfInterestY (default is 0)
|-
|-
| 0x4 || 0x2 || WindowOfInterestWidth (default is 320)
| 0x4 || 0x2 || WindowOfInterestWidth (default is 320)
|-
|-
| 0x6 || 0x2 || WindowOfInterestHeight (default is 240)
| 0x6 || 0x2 || WindowOfInterestHeight (default is 240)
|}
|}
 
 
= PackedPointingProcessorConfig =
= PackedPointingProcessorConfig =
This is "nn::irsensor::PackedPointingProcessorConfig".
This is "nn::irsensor::PackedPointingProcessorConfig".
 
 
This is converted from [[#PointingProcessorConfig]].
This is converted from [[#PointingProcessorConfig]].
 
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x2 || WindowOfInterestX (default is 0)
| 0x0 || 0x2 || WindowOfInterestX (default is 0)
|-
|-
| 0x2 || 0x2 || WindowOfInterestY (default is 0)
| 0x2 || 0x2 || WindowOfInterestY (default is 0)
|-
|-
| 0x4 || 0x2 || WindowOfInterestWidth (default is 320)
| 0x4 || 0x2 || WindowOfInterestWidth (default is 320)
|-
|-
| 0x6 || 0x2 || WindowOfInterestHeight (default is 240)
| 0x6 || 0x2 || WindowOfInterestHeight (default is 240)
|-
|-
| 0x8 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
| 0x8 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
|}
|}
 
 
= PackedMcuVersion =
= PackedMcuVersion =
This is "nn::irsensor::PackedMcuVersion".
This is "nn::irsensor::PackedMcuVersion".
 
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x2 || MajorVersion
| 0x0 || 0x2 || MajorVersion
|-
|-
| 0x2 || 0x2 || MinorVersion
| 0x2 || 0x2 || MinorVersion
|}
|}
 
== Versions ==
{| class="wikitable" border="1"
|-
! MajorVersion || MinorVersion || SystemVersion
|-
| 0x3 || 0xB || [1.0.0+]
|-
| 0x4 || 0x12 || [4.0.0+]
|-
| 0x5 || 0x18 || [5.0.0+]
|-
| 0x6 || 0x1A || [6.0.0+]
|-
| 0x8 || 0x1B || [8.0.0+]
|}
 
= PackedFunctionLevel =
This is nn::irsensor::PackedFunctionLevel.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x1 || [[#IrSensorFunctionLevel]]
|-
| 0x1 || 0x3 || Reserved
|}
 
== IrSensorFunctionLevel ==
This is "nn::irsensor::IrSensorFunctionLevel".
 
{| class="wikitable" border="1"
|-
! Value || SystemVersion
|-
| 0 || [1.0.0+]
|-
| 1 || [4.0.0+]
|-
| 2 || [5.0.0+]
|-
| 3 || [6.0.0+]
|-
| 4 || [8.0.0+]
|}
 
= ImageTransferProcessorExConfig =
This is "nn::irsensor::ImageTransferProcessorExConfig".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || ExposureTime
|-
| 0x8 || 0x4 || LightTarget
|-
| 0xC || 0x4 || Gain
|-
| 0x10 || 0x1 || IsNegativeImageUsed
|-
| 0x11 || 0x7 || Reserved
|-
| 0x18 || 0x4 || [[#ImageTransferProcessorFormat|OrigFormat]]
|-
| 0x1C || 0x4 || [[#ImageTransferProcessorFormat|TrimmingFormat]]
|-
| 0x20 || 0x2 || TrimmingStartX
|-
| 0x22 || 0x2 || TrimmingStartY
|-
| 0x24 || 0x1 || IsExternalLightFilterEnabled
|}
 
= PackedImageTransferProcessorExConfig =
This is "nn::irsensor::PackedImageTransferProcessorExConfig".
 
This is converted from [[#ImageTransferProcessorExConfig]].
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || ExposureTime
|-
| 0x8 || 0x1 || LightTarget
|-
| 0x9 || 0x1 || Gain
|-
| 0xA || 0x1 || IsNegativeImageUsed
|-
| 0xB || 0x5 || Reserved
|-
| 0x10 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
|-
| 0x14 || 0x1 || [[#ImageTransferProcessorFormat|OrigFormat]]
|-
| 0x15 || 0x1 || [[#ImageTransferProcessorFormat|TrimmingFormat]]
|-
| 0x16 || 0x2 || TrimmingStartX
|-
| 0x18 || 0x2 || TrimmingStartY
|-
| 0x1A || 0x1 || IsExternalLightFilterEnabled
|-
| 0x1B || 0x5 || Reserved
|}
 
= IrLedProcessorConfig =
This is "nn::irsensor::IrLedProcessorConfig".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || LightTarget
|}
 
= PackedIrLedProcessorConfig =
This is "nn::irsensor::PackedIrLedProcessorConfig".
 
This is converted from [[#IrLedProcessorConfig]].
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
|-
| 0x4 || 0x1 || LightTarget
|-
| 0x5 || 0x3 || Padding
|}
 
= AdaptiveClusteringProcessorConfig =
This is "nn::irsensor::AdaptiveClusteringProcessorConfig".
 
AdaptiveClusteringProcessor was added with [5.0.0+].
 
This is converted to [[#TeraPluginProcessorConfig]] by the user-process. [[#TeraPluginProcessorConfig]]+0x3 is zero.
 
The default config is all-zero.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || [[#AdaptiveClusteringMode]]
|-
| 0x4 || 0x4 || [6.0.0+] [[#AdaptiveClusteringTargetDistance]]
|}
 
== AdaptiveClusteringMode ==
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || StaticFov
|-
| 1 || DynamicFov
|}
 
Controls the mode for [[#TeraPluginProcessorConfig]] (DynamicFov -> 0x10; StaticFov -> 0x0F).
 
== AdaptiveClusteringTargetDistance ==
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || Near
|-
| 1 || Middle
|-
| 2 || Far
|}
 
Controls the second and third bytes for [[#TeraPluginProcessorConfig]] (Near-> 0x00, 0x00; Middle -> 0x01, 0x03; Far -> 0x01, 0x08).
 
= HandAnalysisConfig =
This is "nn::irsensor::HandAnalysisConfig".
 
This is converted to [[#TeraPluginProcessorConfig]] by the user-process, which is all-zero except the mode.
* pre-4.0.0: [[#TeraPluginProcessorConfig]] mode = [[#HandAnalysisMode]] - 1.
* [4.0.0+]: Silhouette = 0x5, Image = 0x6, SilhouetteAndImage = 0x7, SilhouetteOnly = 0xA.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || [[#HandAnalysisMode]]
|}
 
== HandAnalysisMode ==
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || None (invalid)
|-
| 1 || Silhouette
|-
| 2 || Image
|-
| 3 || SilhouetteAndImage
|-
| 4 || [4.0.0+] SilhouetteOnly
|}
 
= BusHandle =
This is "nn::hidbus::BusHandle".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || AbstractedPadId
|-
| 0x4 || 0x1 || InternalIndex
|-
| 0x5 || 0x1 || PlayerNumber
|-
| 0x6 || 0x1 || BusTypeId
|-
| 0x7 || 0x1 || IsValid
|}
 
= JoyPollingReceivedData =
This is "nn::hidbus::JoyPollingReceivedData".
 
This is copied from the entries in [[#EnableJoyPollingReceiveMode|TransferMemory]] by GetJoyPollingReceivedData.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x30 || Data
|-
| 0x30 || 0x8 || 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 ==
== Versions ==
=== Ukyosakyo ===
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! MajorVersion || MinorVersion || SystemVersion
! SystemVersion
|-
! FirmwareVersion
| 0x3 || 0xB || [1.0.0+]
|-
| 0x4 || 0x12 || [4.0.0+]
|-
| 0x5 || 0x18 || [5.0.0+]
|-
| 0x6 || 0x1A || [6.0.0+]
|-
| 0x8 || 0x1B || [8.0.0+]
|}
 
= PackedFunctionLevel =
This is nn::irsensor::PackedFunctionLevel.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x1 || [[#IrSensorFunctionLevel]]
|-
| 0x1 || 0x3 || Reserved
|}
 
== IrSensorFunctionLevel ==
This is "nn::irsensor::IrSensorFunctionLevel".
 
{| class="wikitable" border="1"
|-
! Value || SystemVersion
|-
| 0 || [1.0.0+]
|-
| 1 || [4.0.0+]
|-
| 2 || [5.0.0+]
|-
| 3 || [6.0.0+]
|-
| 4 || [8.0.0+]
|}
 
= ImageTransferProcessorExConfig =
This is "nn::irsensor::ImageTransferProcessorExConfig".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || ExposureTime
|-
| 0x8 || 0x4 || LightTarget
|-
| 0xC || 0x4 || Gain
|-
| 0x10 || 0x1 || IsNegativeImageUsed
|-
| 0x11 || 0x7 || Reserved
|-
| 0x18 || 0x4 || [[#ImageTransferProcessorFormat|OrigFormat]]
|-
| 0x1C || 0x4 || [[#ImageTransferProcessorFormat|TrimmingFormat]]
|-
| 0x20 || 0x2 || TrimmingStartX
|-
| 0x22 || 0x2 || TrimmingStartY
|-
| 0x24 || 0x1 || IsExternalLightFilterEnabled
|}
 
= PackedImageTransferProcessorExConfig =
This is "nn::irsensor::PackedImageTransferProcessorExConfig".
 
This is converted from [[#ImageTransferProcessorExConfig]].
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || ExposureTime
|-
| 0x8 || 0x1 || LightTarget
|-
| 0x9 || 0x1 || Gain
|-
| 0xA || 0x1 || IsNegativeImageUsed
|-
| 0xB || 0x5 || Reserved
|-
| 0x10 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
|-
| 0x14 || 0x1 || [[#ImageTransferProcessorFormat|OrigFormat]]
|-
|-
| 0x15 || 0x1 || [[#ImageTransferProcessorFormat|TrimmingFormat]]
| [1.0.0+]
| 0348
|-
|-
| 0x16 || 0x2 || TrimmingStartX
| [5.0.0+]
| 0389
|-
|-
| 0x18 || 0x2 || TrimmingStartY
| [6.0.0+]
|-
| 038B
| 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
| [7.0.0+]
| 03A6
|-
|-
| 0x0 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
| [8.0.0+]
| 03B5
|-
|-
| 0x4 || 0x1 || LightTarget
| [9.0.0+]
| 0400
|-
|-
| 0x5 || 0x3 || Padding
| [10.0.0+]
|}
| 0406
 
= 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
| [11.0.0+]
| 0407
|-
|-
| 0x0 || 0x4 || [[#AdaptiveClusteringMode]]
| [12.1.0+]
| 0410
|-
|-
| 0x4 || 0x4 || [6.0.0+] [[#AdaptiveClusteringTargetDistance]]
| [13.0.0+]
|}
| 0417
 
== AdaptiveClusteringMode ==
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || StaticFov
| [14.0.0+]
| 0419
|-
|-
| 1 || DynamicFov
| [21.0.0+]
| 0420
|}
|}


Controls the mode for [[#TeraPluginProcessorConfig]] (DynamicFov -> 0x10; StaticFov -> 0x0F).
=== Raizo ===
 
== AdaptiveClusteringTargetDistance ==
{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Near
! SystemVersion
! FirmwareVersion
|-
|-
| 1 || Middle
| [1.0.0+]
| 0348
|-
|-
| 2 || Far
| [15.0.0+]
| 0421
|}
|}


Controls the second and third bytes for [[#TeraPluginProcessorConfig]] (Near-> 0x00, 0x00; Middle -> 0x01, 0x03; Far -> 0x01, 0x08).
=== Tera ===
 
= 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"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! SystemVersion
! FirmwareVersion
|-
|-
| 0x0 || 0x4 || [[#HandAnalysisMode]]
| [1.0.0+]
|}
| 030B
 
== HandAnalysisMode ==
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || None (invalid)
| [4.0.0+]
| 0412
|-
|-
| 1 || Silhouette
| [5.0.0+]
| 0518
|-
|-
| 2 || Image
| [6.0.0+]
| 061A
|-
|-
| 3 || SilhouetteAndImage
| [8.0.0+]
| 081B
|-
|-
| 4 || [4.0.0+] SilhouetteOnly
| [20.1.0+]
| 0920
|}
|}


= BusHandle =
=== TeraFullKey ===
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
| [1.0.0+]
| 0305
|-
|-
| 0x7 || 0x1 || IsValid
| [20.1.0+]
| 0403
|}
|}


= JoyPollingReceivedData =
=== ProController ===
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
|-
|-
| 0x30 || 0x8 || OutSize
| -
| 010A0200
|-
|-
| 0x38 || 0x8 || SamplingNumber
| [6.0.0+]
| 01100210
|}
|}


= BusType =
=== Palma ===
This is "nn::hidbus::BusType".
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || LeftJoyRail
! SystemVersion
! FirmwareVersion
|-
|-
| 1 || RightJoyRail
| -
| 1100
|-
|-
| 2 || [6.0.0+] InternalBus (for Lark microphone)
| [6.1.0+]
| 1200
|}
|}


= JoyPollingMode =
=== SioH ===
This is "nn::hidbus::JoyPollingMode".
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || SixAxisSensorDisable
! SystemVersion
! FirmwareVersion
|-
|-
| 1 || SixAxisSensorEnable
| -
| 000D
|-
|-
| 2 || ButtonOnly
| [8.1.1+]
|}
| 0200
 
Other values causes [[#EnableJoyPollingReceiveMode]] to assert.
 
= StatusManagerType =
This is "nn::hidbus::detail::StatusManagerType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || None
|-
|-
| 1 || 16
| [10.0.0+]
| 0301
|-
|-
| 2 || 32
| [11.0.0+]
| 0304
|}
|}
= 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.
* '''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''' - Touch Screen controller firmware in FTS256 format.
* [10.0.0+] '''FTS_32000001.fts256''' - Touch Screen controller firmware in FTS256 format for panel vendor "Nissha".
* [10.0.0+] '''FTS_32000102.fts256''' - Touch Screen controller firmware in FTS256 format for panel vendor "GIS".
* [10.0.0+] '''FTS_32000302.fts256''' - Touch Screen controller firmware in FTS256 format for panel vendor "Nissha_Hoag".
* [10.0.0+] '''FTS_32000402.fts256''' - Touch Screen controller firmware in FTS256 format for panel vendor "GIS_Hoag".
* [10.0.0+] '''TouchScreenConfiguration.csv''' - List in the format "[gpio],[gpio],[gpio],[config],[config]" where "gpio" can be "0" or "1" and "config" is an integer number.
* [10.0.0+] '''TouchScreenFirmwareInfo.csv''' - List in the format "[driver],[gpio],[gpio],[gpio],[version],[file]" where "driver" can be "FTM" or "FST2", "gpio" can be "0" or "1", "version" is the hexadecimal representation of the firmware file's version and "file" is the name of the firmware file.
* [13.0.0+] '''FTS_33000510.fts256''' - Touch Screen controller firmware in FTS256 format for panel vendor "Samsung_Aula".
* [13.0.0] '''FTS_98000004.ftb''' - Touch Screen controller firmware in FTB format.
* [13.1.0-13.2.1] '''FTS_50000001.ftb''' - Touch Screen controller firmware in FTB format for panel vendor "Nissha".
* [14.0.0+] '''FTS_50000002.ftb''' - Touch Screen controller firmware in FTB format for panel vendor "Nissha".


[[Category:Services]]
[[Category:Services]]