Nintendo Switch Brew

HID services: Difference between revisions

← Older edit
 
(47 intermediate revisions by 3 users not shown)
Line 13: Line 13:
|-
|-
| 21 || [[#ActivateMouse]]
| 21 || [[#ActivateMouse]]
|-
| 22 || [19.0.0+] AddMouseWheelDelta
|-
| 26 || [16.0.0+] ActivateDebugMouse
|-
|-
| 31 || [[#ActivateKeyboard]]
| 31 || [[#ActivateKeyboard]]
Line 80: Line 84:
| 83 || [6.0.0+] [[#IsFirmwareUpdateAvailableForSixAxisSensor]]
| 83 || [6.0.0+] [[#IsFirmwareUpdateAvailableForSixAxisSensor]]
|-
|-
| 84 || [13.0.0+] EnableSixAxisSensorUnalteredPassthrough
| 84 || [13.0.0+] [[#EnableSixAxisSensorUnalteredPassthrough]]
|-
|-
| 85 || [13.0.0+] IsSixAxisSensorUnalteredPassthroughEnabled
| 85 || [13.0.0+] [[#IsSixAxisSensorUnalteredPassthroughEnabled]]
|-
|-
| 86 || [13.0.0+] StoreSixAxisSensorCalibrationParameter
| 86 || [13.0.0+] [[#StoreSixAxisSensorCalibrationParameter]]
|-
|-
| 87 || [13.0.0+] LoadSixAxisSensorCalibrationParameter
| 87 || [13.0.0+] [[#LoadSixAxisSensorCalibrationParameter]]
|-
|-
| 88 || [13.0.0+] GetSixAxisSensorIcInformation
| 88 || [13.0.0+] [[#GetSixAxisSensorIcInformation]]
|-
|-
| 89 || [13.0.0+] ResetIsSixAxisSensorDeviceNewlyAssigned
| 89 || [13.0.0+] [[#ResetIsSixAxisSensorDeviceNewlyAssigned]]
|-
|-
| 91 || [[#ActivateGesture]]
| 91 || [[#ActivateGesture]]
|-
| 92 || [18.0.0+] SetGestureOutputRanges
|-
|-
| 100 || [[#SetSupportedNpadStyleSet]]
| 100 || [[#SetSupportedNpadStyleSet]]
Line 145: Line 151:
|-
|-
| 136 || [8.0.0+] [[#ClearNpadCaptureButtonAssignment]]
| 136 || [8.0.0+] [[#ClearNpadCaptureButtonAssignment]]
|-
| 137 || [20.0.0+] SetNpadGcAnalogStick8bitRawValue
|-
|-
| 200 || [[#GetVibrationDeviceInfo]]
| 200 || [[#GetVibrationDeviceInfo]]
Line 171: Line 179:
|-
|-
| 212 || [11.0.0+] [[#SendVibrationValueInBool]]
| 212 || [11.0.0+] [[#SendVibrationValueInBool]]
|-
| 213 || [17.0.0+] SendVibrationValueInMode
|-
| 214 || [17.0.0+] SendVibrationValuesInMode
|-
|-
| 300 || [3.0.0+] [[#ActivateConsoleSixAxisSensor]]
| 300 || [3.0.0+] [[#ActivateConsoleSixAxisSensor]]
Line 193: Line 205:
|-
|-
| 310 || [6.0.0+] [[#ResetSevenSixAxisSensorTimestamp]]
| 310 || [6.0.0+] [[#ResetSevenSixAxisSensorTimestamp]]
|-
| 311 || [17.0.0+] ForceActivateConsoleSixAxisSensor
|-
| 312 || [17.0.0+] ForceDeactivateConsoleSixAxisSensor
|-
|-
| 400 || [3.0.0+] [[#IsUsbFullKeyControllerEnabled]]
| 400 || [3.0.0+] [[#IsUsbFullKeyControllerEnabled]]
Line 279: Line 295:
|-
|-
| 1003 || [9.0.0+] [[#IsFirmwareUpdateNeededForNotification]]
| 1003 || [9.0.0+] [[#IsFirmwareUpdateNeededForNotification]]
|-
| 1004 || [20.0.0+] SetTouchScreenOutputRanges ([17.0.0-19.0.1] SetTouchScreenResolution)
|-
| 1005 || [20.0.0+] EnableNxTouchScreenEmulationForTouchEnter
|-
|-
| 2000 || [10.0.0+] [[#ActivateDigitizer]]
| 2000 || [10.0.0+] [[#ActivateDigitizer]]
|-
| 3000 || [15.0.0+] GetDebugPadGenericPadMap
|-
| 3001 || [15.0.0+] SetDebugPadGenericPadMap
|-
| 3002 || [15.0.0+] ResetDebugPadGenericPadMap
|-
| 3003 || [15.0.0+] GetDebugPadKeyboardMap
|-
| 3004 || [15.0.0+] SetDebugPadKeyboardMap
|-
| 3005 || [15.0.0+] ResetDebugPadKeyboardMap
|-
| 3006 || [15.0.0+] GetFullKeyGenericPadMap
|-
| 3007 || [15.0.0+] SetFullKeyGenericPadMap
|-
| 3008 || [15.0.0+] ResetFullKeyGenericPadMap
|-
| 3009 || [15.0.0+] GetFullKeyKeyboardMap
|-
| 3010 || [15.0.0+] SetFullKeyKeyboardMap
|-
| 3011 || [15.0.0+] ResetFullKeyKeyboardMap
|}
|}


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


== ActivateGesture ==
== ActivateGesture ==
Line 489: Line 551:
* 0x2: [6.0.0+]
* 0x2: [6.0.0+]
* 0x3: [8.0.0+]
* 0x3: [8.0.0+]
* 0x5: [18.0.0+]


== SetNpadJoyHoldType ==
== SetNpadJoyHoldType ==
Line 499: Line 562:


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


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


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


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


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


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


== StartLrAssignmentMode ==
== StartLrAssignmentMode ==
Line 671: Line 734:
| 0x8 || 0x8 || Second timestamp (in samples).
| 0x8 || 0x8 || Second timestamp (in samples).
|-
|-
| 0x10 || 0x8 || ?
| 0x10 || 0x8 || ? (Increased every sleep cicle)
|-
| 0x18 || 0x4 || float AccelerationX
|-
| 0x1C || 0x4 || float AccelerationY
|-
| 0x20 || 0x4 || float AccelerationZ
|-
| 0x24 || 0x4 || float AngularVelocityX
|-
| 0x28 || 0x4 || float AngularVelocityY
|-
| 0x2C || 0x4 || float AngularVelocityZ
|-
| 0x30 || 0x4 || float QuaternionX
|-
| 0x34 || 0x4 || float QuaternionY
|-
| 0x38 || 0x4 || float QuaternionZ
|-
|-
| 0x18 || 0x28 || float data
| 0x3C || 0x4 || float QuaternionW
|}
|}


Line 907: Line 988:


== ActivateDigitizer ==
== ActivateDigitizer ==
Takes a PID and an [[AM_services|AppletResourceUserId]], no output.
Takes a PID and an [[AM_services|AppletResourceUserId]]. No output.


== IAppletResource ==
== IAppletResource ==
Line 963: Line 1,044:
|-
|-
| 17 || [13.0.0+] IsTouchScreenManaged
| 17 || [13.0.0+] IsTouchScreenManaged
|-
| 18 || [18.0.0+] SetTouchScreenAutoPilotStateWithAruid
|-
|-
| 20 || [[#DeactivateMouse]]
| 20 || [[#DeactivateMouse]]
Line 969: Line 1,052:
|-
|-
| 22 || [[#UnsetMouseAutoPilotState]]
| 22 || [[#UnsetMouseAutoPilotState]]
|-
| 25 || [16.0.0+] SetDebugMouseAutoPilotState
|-
| 26 || [16.0.0+] UnsetDebugMouseAutoPilotState
|-
|-
| 30 || [[#DeactivateKeyboard]]
| 30 || [[#DeactivateKeyboard]]
Line 1,019: Line 1,106:
|-
|-
| 136 || [3.0.0+] GetShiftGyroscopeCalibrationValue
| 136 || [3.0.0+] GetShiftGyroscopeCalibrationValue
|-
| 137 || [15.0.0+] SetSixAxisSensorMode
|-
|-
| 140 || [3.0.0+] DeactivateConsoleSixAxisSensor
| 140 || [3.0.0+] DeactivateConsoleSixAxisSensor
Line 1,067: Line 1,156:
|-
|-
| 211 || [6.0.0+] StartFirmwareUpdateIndividual
| 211 || [6.0.0+] StartFirmwareUpdateIndividual
|-
| 212 || [19.0.0+] GetDetailFirmwareVersion
|-
| 213 || [20.0.0+] GetFirmwareVersionStringForDevMenu
|-
| 214 || [20.1.0+]
|-
|-
| 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,133: Line 1,230:
|-
|-
| 251 || [12.0.0+] GetAnalogStickModuleParam
| 251 || [12.0.0+] GetAnalogStickModuleParam
|-
| 253 || [19.0.0+] ClearStorageForShipment
|-
|-
| 301 || [5.0.0-8.1.0] [[#GetAbstractedPadHandles]]
| 301 || [5.0.0-8.1.0] [[#GetAbstractedPadHandles]]
Line 1,165: Line 1,264:
|-
|-
| 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,188: Line 1,291:
| 600 || [10.0.0+] ConvertPadState
| 600 || [10.0.0+] ConvertPadState
|-
|-
| 650 || [12.0.0+] AddButtonPlayData
| 601 || [18.0.0+] [[#IsButtonConfigSupported]]
|-
| 602 || [18.0.0+] [[#IsButtonConfigEmbeddedSupported]]
|-
| 603 || [18.0.0+] [[#DeleteButtonConfig]]
|-
| 604 || [18.0.0+] [[#DeleteButtonConfigEmbedded]]
|-
|-
| 651 || [12.0.0+] StartButtonPlayData
| 605 || [18.0.0+] [[#SetButtonConfigEnabled]]
|-
|-
| 652 || [12.0.0+] StopButtonPlayData
| 606 || [18.0.0+] [[#SetButtonConfigEmbeddedEnabled]]
|-
|-
| 2000 || [10.0.0+] DeactivateDigitizer
| 607 || [18.0.0+] [[#IsButtonConfigEnabled]]
|-
|-
| 2001 || [10.0.0+] SetDigitizerAutoPilotState
| 608 || [18.0.0+] [[#IsButtonConfigEmbeddedEnabled]]
|-
|-
| 2002 || [10.0.0+] UnsetDigitizerAutoPilotState
| 609 || [18.0.0+] [[#SetButtonConfigEmbedded]]
|}
|-
 
| 610 || [18.0.0+] [[#SetButtonConfigFull]]
== DeactivateDebugPad ==
|-
| 611 || [18.0.0+] [[#SetButtonConfigLeft]]
|-
| 612 || [18.0.0+] [[#SetButtonConfigRight]]
|-
| 613 || [18.0.0+] [[#GetButtonConfigEmbedded]]
|-
| 614 || [18.0.0+] [[#GetButtonConfigFull]]
|-
| 615 || [18.0.0+] [[#GetButtonConfigLeft]]
|-
| 616 || [18.0.0+] [[#GetButtonConfigRight]]
|-
| 650 || [12.0.0+] AddButtonPlayData
|-
| 651 || [12.0.0+] StartButtonPlayData
|-
| 652 || [12.0.0+] StopButtonPlayData
|-
| 2000 || [10.0.0+] [[#DeactivateDigitizer]]
|-
| 2001 || [10.0.0+] [[#SetDigitizerAutoPilotState]]
|-
| 2002 || [10.0.0+] [[#UnsetDigitizerAutoPilotState]]
|-
| 3000 || [16.0.0+] ReloadFirmwareDebugSettings
|}
 
== DeactivateDebugPad ==
No input/output.
No input/output.


Line 1,290: Line 1,427:


[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,416: Line 1,555:


[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,425: Line 1,573:
|-
|-
| 31 || [[#SendKeyboardLockKeyEvent_2|SendKeyboardLockKeyEvent]]
| 31 || [[#SendKeyboardLockKeyEvent_2|SendKeyboardLockKeyEvent]]
|-
| 32 || [15.0.0+] SetSystemKeyboardState
|-
| 33 || [15.0.0+] UnsetSystemKeyboardState
|-
|-
| 101 || [[#AcquireHomeButtonEventHandle]]
| 101 || [[#AcquireHomeButtonEventHandle]]
Line 1,448: Line 1,600:
| 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
|-
| 216 || [19.0.0+] GetAbstractedPadIdForNpadWithNfc
|-
| 217 || [19.0.0+] [[#SetNfcEvent]]
|-
| 218 || [19.0.0+] [[#GetNfcInfo]]
|-
| 219 || [19.0.0+] StartNfcDiscovery
|-
| 220 || [19.0.0+] StopNfcDiscovery
|-
| 221 || [19.0.0+] StartNtagRead
|-
| 222 || [19.0.0+] StartNtagWrite
|-
| 223 || [19.0.0+] SendNfcRawData
|-
| 224 || [19.0.0+] RegisterMifareKey
|-
| 225 || [19.0.0+] ClearMifareKey
|-
| 226 || [19.0.0+] StartMifareRead
|-
| 227 || [19.0.0+] StartMifareWrite
|-
|-
| 230 || AcquireIrSensorEventHandle
| 230 || AcquireIrSensorEventHandle
Line 1,459: Line 1,635:
|-
|-
| 233 || [10.0.0+] GetXcdHandleForNpadWithIrSensor
| 233 || [10.0.0+] GetXcdHandleForNpadWithIrSensor
|-
| 234 || [19.0.0+] GetNpadJoyHoldType
|-
| 241 || [19.0.0+] [[#GetDataFormat]]
|-
| 242 || [19.0.0+] [[#SetDataFormat]]
|-
| 243 || [19.0.0+] [[#GetMcuState]]
|-
| 244 || [19.0.0+] [[#SetMcuState]]
|-
| 245 || [19.0.0+] [[#GetMcuVersionForNfc]]
|-
| 246 || [19.0.0+] [[#CheckNfcDevicePower]]
|-
| 247 || [19.0.0+] [[#SetMcuStateImmediate]]
|-
|-
| 301 || ActivateNpadSystem
| 301 || ActivateNpadSystem
Line 1,515: Line 1,707:
|-
|-
| 330 || [14.0.0+] CheckAbstractedPadConnection
| 330 || [14.0.0+] CheckAbstractedPadConnection
|-
| 332 || [19.0.0+] ConvertAppletDetailedUiTypeFromPlayReportType
|-
| 333 || [20.0.0+] SetNpadUserSpgApplet
|-
| 334 || [20.0.0+] AcquireUniquePadButtonStateChangedEventHandle
|-
|-
| 500 || SetAppletResourceUserId
| 500 || SetAppletResourceUserId
Line 1,553: Line 1,751:
|-
|-
| 525 || [11.0.0+] IsJoyConAttachedOnAllRail
| 525 || [11.0.0+] IsJoyConAttachedOnAllRail
|-
| 526 || [19.0.0+] IsInvertedControllerConnectedOnRail
|-
|-
| 540 || AcquirePlayReportControllerUsageUpdateEvent
| 540 || AcquirePlayReportControllerUsageUpdateEvent
Line 1,560: Line 1,760:
| 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,573: Line 1,773:
|-
|-
| 549 || [6.0.0+] GetConnectableRegisteredDevices
| 549 || [6.0.0+] GetConnectableRegisteredDevices
|-
| 551 || [20.0.0+] GetRegisteredDevicesForControllerSupport
|-
|-
| 700 || ActivateUniquePad
| 700 || ActivateUniquePad
Line 1,579: Line 1,781:
|-
|-
| 703 || [[#GetUniquePadIds]]
| 703 || [[#GetUniquePadIds]]
|-
| 711 || [20.0.0+] AcquireUniquePadConnectionOnHandheldForNsEventHandle
|-
| 712 || [20.0.0+] GetUniquePadColor12
|-
|-
| 751 || AcquireJoyDetachOnBluetoothOffEventHandle
| 751 || AcquireJoyDetachOnBluetoothOffEventHandle
Line 1,607: Line 1,813:
|-
|-
| 812 || [8.0.0+] GetConsoleUniqueSixAxisSensorHandle
| 812 || [8.0.0+] GetConsoleUniqueSixAxisSensorHandle
|-
| 813 || [18.0.0+] GetDeviceType
|-
|-
| 821 || StartAnalogStickManualCalibration
| 821 || StartAnalogStickManualCalibration
Line 1,667: Line 1,875:
|-
|-
| 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,680: Line 1,890:
| 1120 || [6.0.0+] SetFirmwareHotfixUpdateSkipEnabled
| 1120 || [6.0.0+] SetFirmwareHotfixUpdateSkipEnabled
|-
|-
| 1130 || [6.0.0+] InitializeUsbFirmwareUpdate
| 1130 || [6.0.0-15.0.1] InitializeUsbFirmwareUpdate
|-
|-
| 1131 || [6.0.0+] FinalizeUsbFirmwareUpdate
| 1131 || [6.0.0+] FinalizeUsbFirmwareUpdate
Line 1,689: Line 1,899:
|-
|-
| 1134 || [6.0.0+] GetUsbFirmwareUpdateState
| 1134 || [6.0.0+] GetUsbFirmwareUpdateState
|-
| 1135 || [15.0.0+] InitializeUsbFirmwareUpdateWithoutMemory
|-
|-
| 1150 || [8.0.0+] SetTouchScreenMagnification
| 1150 || [8.0.0+] SetTouchScreenMagnification
Line 1,706: Line 1,918:
| 1157 || [10.0.0+] [[#CancelConnectionTrigger]]
| 1157 || [10.0.0+] [[#CancelConnectionTrigger]]
|-
|-
| 1200 || [10.0.0+] [[#IsButtonConfigSupported]]
| 1158 || [20.1.0+]
|-
|-
| 1201 || [11.0.0+] [[#IsButtonConfigEmbeddedSupported]] ([10.0.0-10.2.0] [[#DeleteButtonConfig]])
| 1159 || [20.1.0+]
|-
|-
| 1202 || [11.0.0+] [[#DeleteButtonConfig]] ([10.0.0-10.2.0] [[#SetButtonConfigEnabled]])
| 1200 || [10.0.0-17.0.1] [[#IsButtonConfigSupported]]
|-
|-
| 1203 || [11.0.0+] [[#DeleteButtonConfigEmbedded]] ([10.0.0-10.2.0] [[#IsButtonConfigEnabled]])
| 1201 || [11.0.0-17.0.1] [[#IsButtonConfigEmbeddedSupported]] ([10.0.0-10.2.0] [[#DeleteButtonConfig]])
|-
|-
| 1204 || [11.0.0+] [[#SetButtonConfigEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigEmbedded]])
| 1202 || [11.0.0-17.0.1] [[#DeleteButtonConfig]] ([10.0.0-10.2.0] [[#SetButtonConfigEnabled]])
|-
|-
| 1205 || [11.0.0+] [[#SetButtonConfigEmbeddedEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigFull]])
| 1203 || [11.0.0-17.0.1] [[#DeleteButtonConfigEmbedded]] ([10.0.0-10.2.0] [[#IsButtonConfigEnabled]])
|-
|-
| 1206 || [11.0.0+] [[#IsButtonConfigEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigLeft]])
| 1204 || [11.0.0-17.0.1] [[#SetButtonConfigEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigEmbedded]])
|-
|-
| 1207 || [11.0.0+] [[#IsButtonConfigEmbeddedEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigRight]])
| 1205 || [11.0.0-17.0.1] [[#SetButtonConfigEmbeddedEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigFull]])
|-
|-
| 1208 || [11.0.0+] [[#SetButtonConfigEmbedded]] ([10.0.0-10.2.0] [[#GetButtonConfigEmbedded]])
| 1206 || [11.0.0-17.0.1] [[#IsButtonConfigEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigLeft]])
|-
|-
| 1209 || [11.0.0+] [[#SetButtonConfigFull]] ([10.0.0-10.2.0] [[#GetButtonConfigFull]])
| 1207 || [11.0.0-17.0.1] [[#IsButtonConfigEmbeddedEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigRight]])
|-
| 1208 || [11.0.0-17.0.1] [[#SetButtonConfigEmbedded]] ([10.0.0-10.2.0] [[#GetButtonConfigEmbedded]])
|-
| 1209 || [11.0.0-17.0.1] [[#SetButtonConfigFull]] ([10.0.0-10.2.0] [[#GetButtonConfigFull]])
|-
|-
| 1210 || [10.0.0-10.2.0] [[#GetButtonConfigLeft]]
| 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,822: Line 2,038:
| 1291 || [11.0.0+] [[#SetButtonConfigStorageRight]]
| 1291 || [11.0.0+] [[#SetButtonConfigStorageRight]]
|-
|-
| 12010 || [11.0.0+] [[#SetButtonConfigLeft]]
| 1308 || [18.0.0+] SetButtonConfigVisible
|}
|-
| 1309 || [18.0.0+] IsButtonConfigVisible
|-
| 1320 || [17.0.0+] WakeTouchScreenUp
|-
| 1321 || [17.0.0+] PutTouchScreenToSleep
|-
| 1322 || [20.0.0+] AcquireTouchScreenAsyncWakeCompletedEvent
|-
| 1420 || [19.0.0+] GetAppletResourceProperty
|-
| 12010 || [11.0.0-17.0.1] [[#SetButtonConfigLeft]]
|}


== SendKeyboardLockKeyEvent ==
== SendKeyboardLockKeyEvent ==
Line 1,984: Line 2,212:


It first ensures the touch screen IC's chip id is one of the following:
It first ensures the touch screen IC's chip id is one of the following:
  0x7036 - STMicroelectronics FingerTipS FT9CJ/FT9CF
  0x7036 - Ftm4cd60d (STMicroelectronics FingerTipS FT9CJ/FT9CF)
  0x4036 - ?
  0x4036 - Fst2ba61ya1


Then constructs the final firmware version as follows:
Then constructs the final firmware version as follows:
Line 2,927: Line 3,155:
= xcd:sys =
= xcd:sys =
This is "nn::xcd::detail::ISystemServer".
This is "nn::xcd::detail::ISystemServer".
This was removed with [19.0.0+].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,268: Line 3,498:
| 0x1C
| 0x1C
| [5.0.0+] [[#ConsoleSixAxisSensorSharedMemoryFormat|ConsoleSixAxisSensor]]
| [5.0.0+] [[#ConsoleSixAxisSensorSharedMemoryFormat|ConsoleSixAxisSensor]]
|-
| 0x3DC00
| 0x400
| [16.0.0+] [[#MouseSharedMemoryFormat|DebugMouse]]
|}
|}


Line 3,812: Line 4,046:
===== DigitizerState =====
===== DigitizerState =====
This is "nn::hid::DigitizerState".
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,292: Line 4,528:
|-
|-
| 0x160
| 0x160
| 0x40
| 0x60
| [[#SixAxisSensorUserCalibrationStateLifo]]
| [[#SixAxisSensorUserCalibrationStateLifo]]
|-
|-
| 0x1A0
| 0x1C0
| 0x40
| 0x20
| UniquePadConfigMutex
| UniquePadConfigMutex
|}
|}
Line 4,700: Line 4,936:
|-
|-
| 0x4208
| 0x4208
| 0x40
| 0x20
| [1.0.0-8.1.0] Mutex
| [1.0.0-8.1.0] Mutex
|-
|-
Line 7,199: Line 7,435:
| "FK" || Pro Controller
| "FK" || Pro Controller
|-
|-
| "MY" || [[#DeviceTypeInternal|DeviceType]] 4 and [[#DeviceTypeInternal|DeviceType]] 5
| "MY" || MiyabiLeft and MiyabiRight
|-
|-
| "LC" || [[#DeviceTypeInternal|DeviceType]] 6 and [[#DeviceTypeInternal|DeviceType]] 30
| "LC" || Tarragon and Tarragon2
|-
|-
| "HL" || Famicom left controller
| "HL" || Famicom left controller
Line 7,397: Line 7,633:
| 2 || Rail
| 2 || Rail
|-
|-
| 3 || USB
| 3 || Usb
|-
|-
| 4 || Embedded
| 4 || Embedded
Line 7,586: Line 7,822:
= DeviceTypeInternal =
= DeviceTypeInternal =
This is "nn::hid::detail::DeviceTypeInternal".
This is "nn::hid::detail::DeviceTypeInternal".
[9.0.0+] This has been superseded by [[#DeviceType_2|DeviceType]].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 7,622: Line 7,860:
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Value
!  [[#DeviceType|DeviceType]]
!  [[#UniquePadType|UniquePadType]]
!  [[#AppletDetailedUiType|AppletDetailedUiType]]
!  Description
!  Description
|-
|-
| 0 || || || || Invalid
| 0 || Unknown
|-
|-
| 1 || JoyRight, HandheldRight || RightController || JoyDual, JoyRightHorizontal, JoyRightVertical, JoyDualRightOnly, HandheldJoyConRightOnly, HandheldJoyConLeftJoyConRight, HandheldLarkHvc1JoyConRight, HandheldLarkNesLeftJoyConRight, HandheldNone || Joy-Con right controller (USB PID 0x2007)
| 1 || [[#JoyConRight|JoyConRight]]
|-
|-
| 2 || JoyLeft, HandheldLeft || LeftController || JoyDual, JoyLeftHorizontal, JoyLeftVertical, JoyDualLeftOnly, HandheldJoyConLeftOnly, HandheldJoyConLeftJoyConRight, HandheldJoyConLeftLarkHvc2, HandheldJoyConLeftLarkNesRight, HandheldNone || Joy-Con left controller (USB PID 0x2006)
| 2 || [[#JoyConLeft|JoyConLeft]]
|-
|-
| 3 || FullKey || FullKeyController || SwitchProController || Pro Controller (USB PID 0x2009)
| 3 || [[#SwitchProController|SwitchProController]]
|-
|-
| 4 || JoyLeft || LeftController || ||
| 4 || MiyabiLeft
|-
|-
| 5 || JoyRight || RightController || ||
| 5 || MiyabiRight
|-
|-
| 6 || FullKey || FullKeyController || ||
| 6 || [[#Tarragon|Tarragon]]
|-
|-
| 7 || LarkHvcLeft, HandheldLarkHvcLeft || LeftController || LarkHvc1, HandheldLarkHvc1Only, HandheldLarkHvc1JoyConRight, HandheldLarkHvc1LarkHvc2, HandheldLarkHvc1LarkNesRight, HandheldNone || Famicom left controller
| 7 || [[#LarkH1|LarkH1]]
|-
|-
| 8 || LarkHvcRight, HandheldLarkHvcRight || RightController || LarkHvc2, HandheldLarkHvc2Only, HandheldJoyConLeftLarkHvc2, HandheldLarkHvc1LarkHvc2, HandheldLarkNesLeftLarkHvc2, HandheldNone || Famicom right controller (with microphone)
| 8 || [[#LarkH2|LarkH2]]
|-
|-
| 9 || LarkNesLeft, HandheldLarkNesLeft || LeftController || LarkNesLeft, HandheldLarkNesLeftOnly, HandheldLarkNesLeftJoyConRight, HandheldLarkNesLeftLarkHvc2, HandheldLarkNesLeftLarkNesRight, HandheldNone || NES left controller
| 9 || [[#LarkNL|LarkNL]]
|-
|-
| 10 || LarkNesRight, HandheldLarkNesRight || RightController || LarkNesRight, HandheldLarkNesRightOnly, HandheldJoyConLeftLarkNesRight, HandheldLarkHvc1LarkNesRight, HandheldLarkNesLeftLarkNesRight, HandheldNone || NES right controller
| 10 || [[#LarkNR|LarkNR]]
|-
|-
| 11 || Lucia || FullKeyController || LuciaU, LuciaJ, LuciaE || SNES controller (USB PID 0x2017)
| 11 || [[#Lucia|Lucia]]
|-
|-
| 12 || Palma || Embedded || Unknown || Poké Ball Plus controller
| 12 || [[#Palma|Palma]]
|-
|-
| 13 || FullKey || FullKeyController || || Gc controller
| 13 || [[#GcOnGggg|GcOnGggg]]
|-
|-
| 14 || HandheldLeft || LeftController || || "Fifty" left controller
| 14 || FiftyL
|-
|-
| 15 || FullKey || FullKeyController || ||
| 15 || UsbPad
|-
|-
| 16 || FullKey || FullKeyController || ||
| 16 || WinGenericPad
|-
|-
| 17 || DebugPad || DebugPadController || Verification || Debug controller
| 17 || Sio
|-
|-
| 18 || HandheldRight || RightController || || "Fifty" right controller
| 18 || FiftyR
|-
|-
| 19 || System || Embedded || CompatibleProController || Third party Pro Controller
| 19 || DebugSwitchProControllerCompatibleDevice
|-
|-
| 20 || System || Embedded || CompatibleJoyCon, HandheldNone || Third party Joy-Con right controller
| 20 || DebugJoyConLeftCompatibleDevice
|-
|-
| 21 || System || Embedded || CompatibleJoyCon, HandheldNone || Third party Joy-Con left controller
| 21 || DebugJoyConRightCompatibleDevice
|-
|-
| [12.0.0+] 22 || Lagon || FullKeyController || Lagon || N64 controller (USB PID 0x2019)
| 22 || [12.0.0+] [[#Lagon|Lagon]]
|-
|-
| [12.0.0+] 23 || || || || Joy-Con Charging Grip (USB PID 0x200E)
| 23 || [12.0.0+] [[#ExternalGrip|ExternalGrip]]
|-
|-
| [13.0.0+] 24 || || || || "Kotetsu" (Pro Controller MCU) in DFU mode (USB PID 0x200F)
| 24 || [13.0.0+] [[#SwitchProControllerDfu|SwitchProControllerDfu]]
|-
|-
| [13.0.0+] 25 || || || || "Kuina" (Joy-Con Charging Grip MCU) in DFU mode (USB PID 0x2008)
| 25 || [13.0.0+] [[#ExternalGripDfu|ExternalGripDfu]]
|-
|-
| [13.0.0+] 26 || || || || SNES controller MCU in DFU mode (USB PID 0x2018)
| 26 || [13.0.0+] [[#LuciaDfu|LuciaDfu]]
|-
|-
| [13.0.0+] 27 || || || || N64 controller MCU in DFU mode (USB PID 0x201A)
| 27 || [13.0.0+] [[#LagonDfu|LagonDfu]]
|-
|-
| [13.0.0+] 28 || Lager || FullKeyController || || Sega Genesis controller (USB PID 0x201E)
| 28 || [13.0.0+] [[#Lager|Lager]]
|-
|-
| [14.0.0+] 29 || || || || Sega Genesis controller MCU in DFU mode (USB PID 0x201F)
| 29 || [14.0.0+] [[#LagerDfu|LagerDfu]]
|-
|-
| [14.0.0+] 30 || FullKey || FullKeyController || ||
| 30 || [14.0.0+] [[#Tarragon2|Tarragon2]]
|}
|}


= NpadPowerInfo =
== JoyConRight ==
This is "nn::hid::system::NpadPowerInfo".
[[Joy-Con|Joy-Con]] right controller.
 
== JoyConLeft ==
[[Joy-Con|Joy-Con]] left controller.
 
== SwitchProController ==
[[Pro_Controller|Pro Controller]].
 
== Tarragon ==
Licensed Pro Controller.
 
== LarkH1 ==
Famicom left controller.
 
== LarkH2 ==
Famicom right controller (with microphone).
 
== LarkNL ==
NES left controller.
 
== LarkNR ==
NES right controller.
 
== Lucia ==
SNES controller.
 
== Palma ==
Poké Ball Plus controller.
 
== GcOnGggg ==
GameCube controller.
 
== Lagon ==
N64 controller.
 
== ExternalGrip ==
Joy-Con Charging Grip.
 
== SwitchProControllerDfu ==
"Kotetsu" (Pro Controller MCU) in DFU mode.
 
== ExternalGripDfu ==
"Kuina" (Joy-Con Charging Grip MCU) in DFU mode.
 
== LuciaDfu ==
SNES controller MCU in DFU mode.
 
== LagonDfu ==
N64 controller MCU in DFU mode.
 
== Lager ==
Sega Genesis controller.
 
== LagerDfu ==
Sega Genesis controller MCU in DFU mode.
 
== Tarragon2 ==
Licensed Pro Controller.
 
= VidPidDefinition =
This is "nn::hidtypes::VidPidDefinition".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 7,704: Line 8,000:
|-
|-
| 0x0
| 0x0
| 0x1
| 0x2
| IsPowered
| Vid
|-
|-
| 0x1
| 0x2
| 0x1
| 0x2
| IsCharging
| PidRangeMax
|-
|-
| 0x4
| 0x2
| 0x2
| PidRangeMin
|-
| 0x6
| 0x6
| 0x1
| [[#DeviceTypeInternal|DeviceType]]
|-
| 0x7
| 0x1
| Reserved
| Reserved
|-
| 0x8
| 0x6
| [[#BatteryLevel|BatteryLevel]]
|}
|}


= BatteryLevel =
= VidPidDefinitions =
This is "nn::hid::system::NpadBatteryLevel". This is a 4 byte value.
This is "nn::hidtypes::detail::VidPidDefinitions". This is a list of [[#VidPidDefinition|VidPidDefinition]] objects maintained by the hid-sysmodule.


= ConsoleSixAxisSensorHandle =
{| class="wikitable" border="1"
This is "nn::hid::ConsoleSixAxisSensorHandle". This is a 4-byte struct with 4-byte alignment.
 
sdknso GetConsoleSixAxisSensorHandle always returns a handle with value 0x13.
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Vid || PidRangeMax || PidRangeMin || [[#DeviceTypeInternal|DeviceType]] || Description
|-
|-
| 0x0 || 0x4 || TypeValue
| 0x57E || 0x2006 || 0x2006 || 2 || Nintendo [[HID_services#JoyConLeft|JoyConLeft]]
|-
|-
| 0x0 || 0x1 ||  
| 0x57E || 0x2007 || 0x2007 || 1 || Nintendo [[HID_services#JoyConRight|JoyConRight]]
|-
|-
| 0x1 || 0x1 ||  
| 0x57E || 0x2009 || 0x2009 || 3 || Nintendo [[HID_services#SwitchProController|SwitchProController]]
|}
 
= SixAxisSensorHandle =
This is "nn::hid::SixAxisSensorHandle". This is a 4-byte struct with 4-byte alignment.
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 0x57E || 0x200F || 0x200F || 24 || Nintendo [[HID_services#SwitchProControllerDfu|SwitchProControllerDfu]]
|-
|-
| 0x0 || 0x4 || TypeValue
| 0x57E || 0x200E || 0x200E || 23 || Nintendo [[HID_services#ExternalGrip|ExternalGrip]]
|-
|-
| 0x0 || 0x1 || NpadStyleIndex
| 0x57E || 0x2008 || 0x2008 || 25 || Nintendo [[HID_services#ExternalGripDfu|ExternalGripDfu]]
|-
|-
| 0x1 || 0x1 || [[#NpadIdType|PlayerNumber]]
| 0x57E || 0x2017 || 0x2017 || 11 || Nintendo [[HID_services#Lucia|Lucia]]
|-
|-
| 0x2 || 0x1 || DeviceIdx
| 0x57E || 0x2018 || 0x2018 || 26 || Nintendo [[HID_services#LuciaDfu|LuciaDfu]]
|}
 
= VibrationDeviceHandle =
This is "nn::hid::VibrationDeviceHandle". This is a 4-byte struct with 4-byte alignment.
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 0x57E || 0x2019 || 0x2019 || 22 || Nintendo [[HID_services#Lagon|Lagon]]
|-
|-
| 0x0 || 0x4 || TypeValue
| 0x57E || 0x201A || 0x201A || 27 || Nintendo [[HID_services#LagonDfu|LagonDfu]]
|-
|-
| 0x0 || 0x1 || NpadStyleIndex
| 0x57E || 0x201E || 0x201E || 28 || Nintendo [[HID_services#Lager|Lager]]
|-
|-
| 0x1 || 0x1 || [[#NpadIdType|PlayerNumber]]
| 0x57E || 0x201F || 0x201F || 29 || Nintendo [[HID_services#LagerDfu|LagerDfu]]
|-
|-
| 0x2 || 0x1 || DeviceIdx
| 0x57E || 0x337 || 0x337 || 13 || Nintendo [[HID_services#GcOnGggg|GcOnGggg]]
|}
 
= VibrationDeviceInfo =
This is "nn::hid::VibrationDeviceInfo" / "nn::hid::VibrationDeviceInfoForIpc". This is a 0x8-byte struct.
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 0x57E || 0x300E || 0x300E || [17.0.0+] 18 || Nintendo FiftyR
|-
|-
| 0x0 || 0x4 || [[#VibrationDeviceType|DeviceType]]
| 0x57E || 0x300D || 0x300D || [17.0.0+] 14 || Nintendo FiftyL
|-
|-
| 0x4 || 0x4 || [[#VibrationDevicePosition|Position]]
| 0xF0D || 0x92 || 0x92 || 15 || HORI Pokken Tournament DX Pro Pad
|}
 
= VibrationDeviceType =
This is "nn::hid::VibrationDeviceType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Unknown
| 0xF0D || 0xAB || 0xAA || 15 || HORI
|-
|-
| 1 || LinearResonantActuator
| 0xF0D || 0xC1 || 0xC1 || 15 || HORIPAD for Nintendo Switch
|-
|-
| 2 || GcErm
| 0xF0D || 0xFF || 0xF0 || 15 || HORI
|-
|-
| 3 || Erm
| 0xF0D || 0x22F || 0x200 || [1.0.0-20.0.1] 15 || HORI
|}
 
= VibrationDevicePosition =
This is "nn::hid::VibrationDevicePosition".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || None
| 0xF0D || 0x201 || 0x200 || [20.1.0+] 15 || HORI Split Pad Pro
|-
|-
| 1 || Left
| 0xF0D || 0x202 || 0x202 || [20.1.0+] 15 || HORI
|-
| 0xF0D || 0x21F || 0x203 || [20.1.0+] 15 || HORI
|-
| 0xF0D || 0x25F || 0x220 || [20.1.0+] 15 || HORI
|-
| 0xF0D || 0x27F || 0x260 || [20.1.0+] 15 || HORI
|-
| 0xE6F || 0x193 || 0x180 || 15 || PDP
|-
| 0x20D6 || 0xA719 || 0xA710 || [1.0.0-20.0.1] 15 || PowerA
|-
| 0x20D6 || 0xA729 || 0xA720 || [1.0.0-20.0.1] 15 || PowerA
|-
| 0x20D6 || 0xA716 || 0xA710 || [20.1.0+] 15 || PowerA
|-
| 0x20D6 || 0xA717 || 0xA717 || [20.1.0+] 15 || PowerA
|-
| 0x20D6 || 0xA719 || 0xA718 || [20.1.0+] 15 || PowerA
|-
| 0x20D6 || 0xA720 || 0xA720 || [20.1.0+] 15 || PowerA
|-
| 0x20D6 || 0xA721 || 0xA721 || [20.1.0+] 15 || PowerA
|-
| 0x20D6 || 0xA726 || 0xA722 || [20.1.0+] 15 || PowerA
|-
| 0x20D6 || 0xA731 || 0xA727 || [20.1.0+] 15 || PowerA
|-
|-
| 2 || Right
| 0x33DD || 0xB || 0x1 || 15 || ZUIKI
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 7,823: Line 8,110:
|-
|-
| 0x0
| 0x0
| 0x4
| 0x1
| AmplitudeLow
| IsPowered
|-
| 0x1
| 0x1
| IsCharging
|-
|-
| 0x4
| 0x2
| 0x4
| 0x6
| FrequencyLow
| Reserved
|-
|-
| 0x8
| 0x8
| 0x4
| 0x4
| AmplitudeHigh
| [[#BatteryLevel|BatteryLevel]]
|-
| 0xC
| 0x4
| FrequencyHigh
|}
|}


= VibrationGcErmCommand =
= BatteryLevel =
This is "nn::hid::VibrationGcErmCommand".
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"
!  Value
!  Name
!  Description
|-
|-
| 0 || Stop || Stops the vibration with a decay phase.
! Offset || Size || Description
|-
| 0x0 || 0x4 || TypeValue
|-
|-
| 1 || Start || Starts the vibration.
| 0x0 || 0x1 ||  
|-
|-
| 2 || StopHard || Stops the vibration immediately, with no decay phase.
| 0x1 || 0x1 ||  
|}
|}


= AccelerometerPlayMode =
= SixAxisSensorHandle =
This is "nn::hid::debug::AccelerometerPlayMode" (pre-10.0.0 this is "nn::hid::AccelerometerPlayMode").
This is "nn::hid::SixAxisSensorHandle". This is a 4-byte struct with 4-byte alignment.


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


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Loose
! Offset || Size || Description
|-
| 0x0 || 0x4 || TypeValue
|-
| 0x0 || 0x1 || NpadStyleIndex
|-
|-
| 1 || Standard
| 0x1 || 0x1 || [[#NpadIdType|PlayerNumber]]
|-
|-
| 2 || Tight
| 0x2 || 0x1 || DeviceIdx
|}
|}


= PalmaConnectionHandle =
= VibrationDeviceInfo =
This is "nn::hid::PalmaConnectionHandle". This is a 0x8-byte struct with 8-byte alignment.
This is "nn::hid::VibrationDeviceInfo" / "nn::hid::VibrationDeviceInfoForIpc". This is a 0x8-byte struct.
 
= PalmaOperationInfo =
This is "nn::hid::PalmaOperationInfo". This is a 0x148-byte struct.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 7,890: Line 8,184:
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x4 || [[#PalmaOperationType]]
| 0x0 || 0x4 || [[#VibrationDeviceType|DeviceType]]
|-
|-
| 0x4 || 0x4 || Result
| 0x4 || 0x4 || [[#VibrationDevicePosition|Position]]
|-
| 0x8 || 0x140 || Buffer for [[#GetPalmaOperationInfo]].
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 7,904: Line 8,196:
!  Description
!  Description
|-
|-
| 0 || PlayActivity
| 0 || Unknown
|-
|-
| 1 || SetFrModeType
| 1 || LinearResonantActuator
|-
|-
| 2 || ReadStep
| 2 || GcErm
|-
|-
| 3 || EnableStep
| 3 || Erm
|}
 
= VibrationDevicePosition =
This is "nn::hid::VibrationDevicePosition".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 4 || ResetStep
| 0 || None
|-
|-
| 5 || ReadApplicationSection
| 1 || Left
|-
|-
| 6 || WriteApplicationSection
| 2 || Right
|}
 
= VibrationValue =
This is "nn::hid::VibrationValue". This is a 0x10-byte struct, which contains 4 float values.
 
{| class="wikitable" border="1"
|-
|-
| 7 || ReadUniqueCode
! Offset
! Size
! Description
|-
|-
| 8 || SetUniqueCodeInvalid
| 0x0
| 0x4
| AmplitudeLow
|-
|-
| 9 || WriteActivityEntry
| 0x4
| 0x4
| FrequencyLow
|-
|-
| 10 || WriteRgbLedPatternEntry
| 0x8
| 0x4
| AmplitudeHigh
|-
|-
| 11 || WriteWaveEntry
| 0xC
|-
| 0x4
| 12 || ReadDataBaseIdentificationVersion
| FrequencyHigh
|-
| 13 || WriteDataBaseIdentificationVersion
|-
| 14 || SuspendFeature
|-
| 15 || [5.1.0+] ReadPlayLog
|-
| 16 || [5.1.0+] ResetPlayLog
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Value
!  Name
!  Description
!  Description
|-
|-
| 0 || Off
| 0 || Stop || Stops the vibration with a decay phase.
|-
|-
| 1 || B01
| 1 || Start || Starts the vibration.
|-
|-
| 2 || B02
| 2 || StopHard || Stops the vibration immediately, with no decay phase.
|-
| 3 || B03
|-
| 4 || Downloaded
|}
|}


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


= PalmaActivityEntry =
{| class="wikitable" border="1"
This is "nn::hid::PalmaActivityEntry".
!  Value
 
!  Description
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 0 || Loose
|-
|-
| 0x0 || 0x2 || RgbLedPatternIndex.
| 1 || Tight
|-
| 0x2 || 0x2 || Padding
|-
| 0x4 || 0x4 || [[#PalmaWaveSet|WaveSet]].
|-
| 0x8 || 0x2 || WaveIndex.
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 7,983: Line 8,279:
!  Description
!  Description
|-
|-
| 0 || Small
| 0 || Loose
|-
|-
| 1 || Medium
| 1 || Standard
|-
|-
| 2 || Large
| 2 || Tight
|}
|}


= PalmaFeature =
= PalmaConnectionHandle =
This is "nn::hid::PalmaFeature".
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"
{| class="wikitable" border="1"
|-
|-
! Bit
! Offset || Size || Description
! Description
|-
|-
| 0
| 0x0 || 0x4 || [[#PalmaOperationType]]
| FrMode
|-
|-
| 1
| 0x4 || 0x4 || Result
| RumbleFeedback
|-
| 2
| Step
|-
| 3
| MuteSwitch
|-
|-
| 0x8 || 0x140 || Buffer for [[#GetPalmaOperationInfo]].
|}
|}


= AbstractedPadState =
= PalmaOperationType =
This is "nn::hid::PalmaOperationType".
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
! Offset || Size || Description
| 0 || PlayActivity
|-
|-
| 0x0 || 0x4 || Type, only 1 bit can be set. Converted to [[#HdlsDeviceInfo]]::type internally by [[#SetAutoPilotVirtualPadState]].
| 1 || SetFrModeType
|-
|-
| 0x4 || 0x1 || Flags. [[#SetAutoPilotVirtualPadState]] only uses bit0: when clear it will skip using the rest of the input and run [[#UnsetAutoPilotVirtualPadState]] internally.
| 2 || ReadStep
|-
|-
| 0x5 || 0x3 || Padding
| 3 || EnableStep
|-
| 4 || ResetStep
|-
| 5 || ReadApplicationSection
|-
| 6 || WriteApplicationSection
|-
| 7 || ReadUniqueCode
|-
| 8 || SetUniqueCodeInvalid
|-
| 9 || WriteActivityEntry
|-
| 10 || WriteRgbLedPatternEntry
|-
|-
| 0x8 || 0x4 || RGBA Single Body Color
| 11 || WriteWaveEntry
|-
|-
| 0xC || 0x4 || RGBA Single Buttons Color
| 12 || ReadDataBaseIdentificationVersion
|-
|-
| 0x10 || 0x1 || See [[#HiddbgHdlsDeviceInfo]]::[[#NpadInterfaceType]].
| 13 || WriteDataBaseIdentificationVersion
|-
|-
| 0x11 || 0x3 || Padding
| 14 || SuspendFeature
|-
|-
| 0x14 || 0x24 || [[#HdlsState]]. Unknown if the last 4-bytes are included in this struct, [[#SetAutoPilotVirtualPadState]]/[[#hiddbgGetAbstractedPadsState]] only uses the first 0x20-bytes.
| 15 || [5.1.0+] ReadPlayLog
|-
|-
| 0x38 || 0x60 || Unused with [[#SetAutoPilotVirtualPadState]]/[[#GetAbstractedPadsState]].
| 16 || [5.1.0+] ResetPlayLog
|}
|}


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


Type:
{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Bits
!  Value
!  [[#HdlsDeviceInfo]]::type bits
!  Description
!  Description
!  Notes
|-
|-
| 0 || 0 || ||
| 0 || Off
|-
|-
| 1 || 15 || || [[#DeviceType]] |= BIT(1)
| 1 || B01
|-
|-
| 2 || 1 || ||
| 2 || B02
|-
|-
| 3 || 2 || ||
| 3 || B03
|-
|-
| 4 || 1 || ||  
| 4 || Downloaded
|}
 
= PalmaApplicationSectionAccessBuffer =
This is "nn::hid::PalmaApplicationSectionAccessBuffer". This is a 0x100-byte struct.
 
= PalmaActivityEntry =
This is "nn::hid::PalmaActivityEntry".
 
{| class="wikitable" border="1"
|-
|-
| 5 || 2 || ||  
! Offset || Size || Description
|-
|-
| 6 || 3 || ||  
| 0x0 || 0x2 || RgbLedPatternIndex.
|-
|-
| 7 || 11 || || [[#DeviceType]] |= BIT(11)
| 0x2 || 0x2 || Padding
|-
|-
| 8 || 12 || || [[#DeviceType]] |= BIT(12)
| 0x4 || 0x4 || [[#PalmaWaveSet|WaveSet]].
|-
|-
| 9 || 13 || || [[#DeviceType]] |= BIT(13)
| 0x8 || 0x2 || WaveIndex.
|}
 
= PalmaWaveSet =
This is "nn::hid::PalmaWaveSet".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 10 || 14 || || [[#DeviceType]] |= BIT(14)
| 0 || Small
|-
|-
| 11 || 15 || || [[#DeviceType]] |= BIT(11)
| 1 || Medium
|-
| 12 || 12 || || [[#DeviceType]] |= BIT(12)
|-
| 13 || 13 || || [[#DeviceType]] |= BIT(13)
|-
| 14 || 14 || || [[#DeviceType]] |= BIT(14)
|-
| 15 || 17 || ||
|-
| 31 || 21 || || [[#DeviceType]] = BIT(31)
|-
|-
| 2 || Large
|}
|}


The above "[[#DeviceType]] |=" notes only apply when type2 is 0x2.
= PalmaFeature =
 
This is "nn::hid::PalmaFeature".
= DebugPadAutoPilotState =
This is "nn::hid::debug::DebugPadAutoPilotState"


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Bit
! Size
! Description
! Description
|-
|-
| 0x0
| 0
| 0x4
| FrMode
| [[#DebugPadAttributeSet|Attributes]]
|-
| 1
| RumbleFeedback
|-
|-
| 0x4
| 2
| 0x4
| Step
| [[#DebugPadButtonSet|Buttons]]
|-
|-
| 0x8
| 3
| 0x8
| MuteSwitch
| [[#AnalogStickState|AnalogStickL]]
|-
|-
| 0x10
| 0x8
| [[#AnalogStickState|AnalogStickR]]
|}
|}


= MouseAutoPilotState =
= AbstractedPadState =
This is "nn::hid::debug::MouseAutoPilotState".
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Offset || Size || Description
! Size
|-
! Description
| 0x0 || 0x4 || Type, only 1 bit can be set. Converted to [[#HdlsDeviceInfo]]::type internally by [[#SetAutoPilotVirtualPadState]].
|-
| 0x4 || 0x1 || Flags. [[#SetAutoPilotVirtualPadState]] only uses bit0: when clear it will skip using the rest of the input and run [[#UnsetAutoPilotVirtualPadState]] internally.
|-
|-
| 0x0
| 0x5 || 0x3 || Padding
| 0x4
| X
|-
|-
| 0x4
| 0x8 || 0x4 || RGBA Single Body Color
| 0x4
| Y
|-
|-
| 0x8
| 0xC || 0x4 || RGBA Single Buttons Color
| 0x4
| DeltaX
|-
|-
| 0xC
| 0x10 || 0x1 || See [[#HiddbgHdlsDeviceInfo]]::[[#NpadInterfaceType]].
| 0x4
| DeltaY
|-
|-
| 0x10
| 0x11 || 0x3 || Padding
| 0x4
| WheelDelta
|-
|-
| 0x14
| 0x14 || 0x24 || [[#HdlsState]]. Unknown if the last 4-bytes are included in this struct, [[#SetAutoPilotVirtualPadState]]/[[#hiddbgGetAbstractedPadsState]] only uses the first 0x20-bytes.
| 0x4
| [[#MouseButtonSet|Buttons]]
|-
|-
| 0x18
| 0x38 || 0x60 || Unused with [[#SetAutoPilotVirtualPadState]]/[[#GetAbstractedPadsState]].
| 0x4
| [[#MouseAttributeSet|Attributes]]
|}
|}


= KeyboardAutoPilotState =
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::hid::debug::KeyboardAutoPilotState".


Type:
{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Bits
!  [[#HdlsDeviceInfo]]::type bits
!  Description
!  Notes
|-
| 0 || 0 || ||
|-
|-
! Offset
| 1 || 15 || || [[#DeviceType]] |= BIT(1)
! Size
! Description
|-
|-
| 0x0
| 2 || 1 || ||  
| 0x8
| [[#KeyboardModifierSet|Modifiers]]
|-
|-
| 0x8
| 3 || 2 || ||  
| 0x20
| [[#KeyboardKeySet|Keys]]
|}
 
= SleepButtonAutoPilotState =
This is "nn::hid::debug::SleepButtonAutoPilotState". This is a 0x8-byte struct with 8-byte alignment.
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 4 || 1 || ||
! Size
|-
! Description
| 5 || 2 || ||
|-
| 6 || 3 || ||
|-
| 7 || 11 || || [[#DeviceType]] |= BIT(11)
|-
| 8 || 12 || || [[#DeviceType]] |= BIT(12)
|-
| 9 || 13 || || [[#DeviceType]] |= BIT(13)
|-
| 10 || 14 || || [[#DeviceType]] |= BIT(14)
|-
| 11 || 15 || || [[#DeviceType]] |= BIT(11)
|-
| 12 || 12 || || [[#DeviceType]] |= BIT(12)
|-
| 13 || 13 || || [[#DeviceType]] |= BIT(13)
|-
| 14 || 14 || || [[#DeviceType]] |= BIT(14)
|-
| 15 || 17 || ||
|-
| 31 || 21 || || [[#DeviceType]] = BIT(31)
|-
|-
| 0x0 || 0x8 || Buttons (only bit0 is used)
|}
|}


= PowerInfo =
The above "[[#DeviceType]] |=" notes only apply when type2 is 0x2.
This is "nn::hidtypes::PowerInfo".
 
= DebugPadAutoPilotState =
This is "nn::hid::debug::DebugPadAutoPilotState"


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 8,186: Line 8,498:
! Description
! Description
|-
|-
| 0x0 || 0x4 || BatteryLevel
| 0x0
| 0x4
| [[#DebugPadAttributeSet|Attributes]]
|-
| 0x4
| 0x4
| [[#DebugPadButtonSet|Buttons]]
|-
| 0x8
| 0x8
| [[#AnalogStickState|AnalogStickL]]
|-
|-
| 0x4 || 0x4 || [[#PowerAttribute]]
| 0x10
| 0x8
| [[#AnalogStickState|AnalogStickR]]
|}
|}


= PowerAttribute =
= MouseAutoPilotState =
This is "nn::hidtypes::PowerAttribute". This is a 32-bit flag.
This is "nn::hid::debug::MouseAutoPilotState".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Bits
!  Description
|-
|-
| 0
! Offset
| IsPowered
! Size
! Description
|-
|-
| 1
| 0x0
| IsCharging
| 0x4
|}
| X
 
= HdlsAttribute =
This is "nn::hidtypes::HdlsAttribute". This is a 32-bit flag.
 
{| class="wikitable" border="1"
!  Bits
!  Description
|-
|-
| 0
| 0x4
| HasVirtualSixAxisSensorAcceleration
| 0x4
| Y
|-
|-
| 1
| 0x8
| HasVirtualSixAxisSensorAngle
| 0x4
|}
| DeltaX
 
= HdlsHandle =
This is "nn::hid::debug::HdlsHandle". This is a 0x8-byte struct with 8-byte alignment.
 
= HdlsSessionId =
This is "nn::hid::debug::detail::HdlsSessionId". This is a 0x8-byte struct with 8-byte alignment.
 
= HdlsNpadAssignment =
This is a 0x208-byte struct.
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 0xC
| 0x4
| DeltaY
|-
|-
| 0x0 || 0x4 || s32 Total entries
| 0x10
| 0x4
| WheelDelta
|-
|-
| 0x4 || 0x4 || Padding
| 0x14
| 0x4
| [[#MouseButtonSet|Buttons]]
|-
|-
| 0x8 || 0x200(0x20*0x10) || Array of [[#HdlsNpadAssignmentEntry]].
| 0x18
| 0x4
| [[#MouseAttributeSet|Attributes]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset
! Size
! Description
|-
|-
| 0x0 || 0x8 || [[#HdlsHandle]]
| 0x0
| 0x8
| [[#KeyboardModifierSet|Modifiers]]
|-
|-
| 0x8 || 0x4 || ?
| 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"
|-
|-
| 0xC || 0x4 || ?
! Offset
! Size
! Description
|-
|-
| 0x10 || 0x8 || ?
| 0x0 || 0x8 || Buttons (only bit0 is used)
|-
| 0x18 || 0x1 || ?
|-
| 0x19 || 0x7 || Padding
|}
|}


= HdlsStateList =
= DigitizerAutoPilotState =
This is a 0x408-byte struct.
This is "nn::hid::debug::DigitizerAutoPilotState".
 
[9.0.0+] This is a 0x488-byte struct.


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


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


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


= HdlsDeviceInfo =
= PowerAttribute =
This is "nn::hid::debug::HdlsDeviceInfo". This is a 0x10-byte struct.
This is "nn::hidtypes::PowerAttribute". This is a 32-bit flag.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Bits
!  Description
|-
|-
! Offset || Size || Description
| 0
| IsPowered
|-
|-
| 0x0 || 0x4 || [[#DeviceTypeInternal]]
| 1
| IsCharging
|}
 
= HdlsAttribute =
This is "nn::hidtypes::HdlsAttribute". This is a 32-bit flag.
 
{| class="wikitable" border="1"
!  Bits
!  Description
|-
| 0
| HasVirtualSixAxisSensorAcceleration
|-
| 1
| HasVirtualSixAxisSensorAngle
|}
 
= HdlsHandle =
This is "nn::hid::debug::HdlsHandle". This is a 0x8-byte struct with 8-byte alignment.
 
= HdlsSessionId =
This is "nn::hid::debug::detail::HdlsSessionId". This is a 0x8-byte struct with 8-byte alignment.
 
= HdlsNpadAssignment =
This is a 0x208-byte struct.
 
{| class="wikitable" border="1"
|-
|-
| 0x4 || 0x4 || RGBA Single Body Color
! Offset || Size || Description
|-
|-
| 0x8 || 0x4 || RGBA Single Buttons Color
| 0x0 || 0x4 || s32 Total entries
|-
|-
| 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.
| 0x4 || 0x4 || Padding
|-
|-
| 0xD || 0x3 || Padding
| 0x8 || 0x200(0x20*0x10) || Array of [[#HdlsNpadAssignmentEntry]].
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 8,319: Line 8,664:
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x1 || [[#DeviceTypeInternal]]
| 0x0 || 0x8 || [[#HdlsHandle]]
|-
|-
| 0x1 || 0x1 || [[#NpadInterfaceType]]. Similar to the field from the old struct.
| 0x8 || 0x4 || ?
|-
|-
| 0x2 || 0x2 || Padding
| 0xC || 0x4 || ?
|-
|-
| 0x4 || 0x4 || RGBA Single Body Color
| 0x10 || 0x8 || ?
|-
|-
| 0x8 || 0x4 || RGBA Single Buttons Color
| 0x18 || 0x1 || ?
|-
|-
| 0xC || 0x4 || RGBA Left Grip Color
| 0x19 || 0x7 || Padding
|-
| 0x10 || 0x4 || RGBA Right Grip Color
|}
|}


= HdlsState =
= HdlsStateList =
This is "nn::hid::debug::HdlsState". This is a 0x24-byte struct.
This is a 0x408-byte struct.
 
[9.0.0+] This is a 0x488-byte struct.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 8,341: Line 8,686:
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x1 || IsPowered for the main PowerInfo.
| 0x0 || 0x4 || s32 Total entries
|-
|-
| 0x1 || 0x1 || ORRed with IsPowered to set the value of the first byte for the controller [[#NpadSystemProperties]].
| 0x4 || 0x4 || Padding
|-
|-
| 0x2 || 0x6 || Unknown
| 0x8 || <[[#HdlsStateListEntry]] size>*0x10 || Array of [[#HdlsStateListEntry]].
|}
 
This contains a list of all controllers, including non-virtual controllers.
 
= HdlsStateListEntry =
This is a 0x40-byte struct.
 
[9.0.0+] This is a 0x48-byte struct.
 
{| class="wikitable" border="1"
|-
|-
| 0x8 || 0x4 || BatteryLevel for the main PowerInfo.
! Offset || Size || Description
|-
|-
| 0xC || 0x4 || [[#NpadButton|Buttons]]. Bit18 = HOME and bit19 = Capture.
| 0x0 || 0x8 || [[#HdlsHandle]]
|-
|-
| 0x10 || 0x10(4*2*2) || Joystick data.
| 0x8 || [[#HdlsDeviceInfo]] size || [[#HdlsDeviceInfo]]. With [[#ApplyHdlsStateList]] this is only used when creating new devices.
|-
|-
| 0x20 || 0x1 || Indicator. Unused for input. Set with output from [[#DumpHdlsStates]] (zero in some cases).
| 0x8 + [[#HdlsDeviceInfo]] size, with 8-byte alignment || 0x24 || [[#HdlsState]]
|-
|-
| 0x21 || 0x3 || Padding
| <Immediately following the above> || 0x4 || Padding
|}
|}


[9.0.0+] (0x28-bytes):
= HdlsDeviceInfo =
This is "nn::hid::debug::HdlsDeviceInfo". This is a 0x10-byte struct.
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x8 || [[#PowerInfo]]
| 0x0 || 0x4 || [[#DeviceTypeInternal]]
|-
|-
| 0x8 || 0x8 || [[#NpadButton|Buttons]], masked with 0xfffffffff00fffff. See above table regarding HOME/Capture buttons.
| 0x4 || 0x4 || RGBA Single Body Color
|-
|-
| 0x10 || 0x10(4*2*2) || Joystick data.
| 0x8 || 0x4 || RGBA Single Buttons Color
|-
|-
| 0x20 || 0x1 || Indicator. Unused for input. Set with output from [[#DumpHdlsStates]] (zero in some cases).
| 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.
|-
|-
| 0x21 || 0x7 || Padding
| 0xD || 0x3 || Padding
|}
|}


[12.0.0+] (0x40-bytes):
[9.0.0+] This is a 0x14-byte struct.
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x8 || [[#PowerInfo]]
| 0x0 || 0x1 || [[#DeviceTypeInternal]]
|-
|-
| 0x8 || 0x8 || [[#NpadButton|Buttons]], masked with 0xfffffffff00fffff. See above table regarding HOME/Capture buttons.
| 0x1 || 0x1 || [[#NpadInterfaceType]]. Similar to the field from the old struct.
|-
|-
| 0x10 || 0x10(4*2*2) || Joystick data.
| 0x2 || 0x2 || Padding
|-
|-
| 0x20 || 0xC || VirtualSixAxisSensorAcceleration
| 0x4 || 0x4 || RGBA Single Body Color
|-
|-
| 0x2C || 0xC || VirtualSixAxisSensorAngle
| 0x8 || 0x4 || RGBA Single Buttons Color
|-
|-
| 0x38 || 0x4 || [[#HdlsAttribute]]
| 0xC || 0x4 || RGBA Left Grip Color
|-
|-
| 0x3C || 0x1 || Indicator. Unused for input.
| 0x10 || 0x4 || RGBA Right Grip Color
|-
| 0x3D || 0x3 || Padding
|}
|}


= DebugRegisteredDevice =
= HdlsState =
This is "nn::hid::debug::RegisteredDevice". This is a 0x58-byte struct with 2-byte alignment.
This is "nn::hid::debug::HdlsState". This is a 0x24-byte struct.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x1 || IsPowered for the main PowerInfo.
|-
| 0x1 || 0x1 || ORRed with IsPowered to set the value of the first byte for the controller [[#NpadSystemProperties]].
|-
| 0x2 || 0x6 || Unknown
|-
| 0x8 || 0x4 || BatteryLevel for the main PowerInfo.
|-
| 0xC || 0x4 || [[#NpadButton|Buttons]]. Bit18 = HOME and bit19 = Capture.
|-
| 0x10 || 0x10(4*2*2) || Joystick data.
|-
| 0x20 || 0x1 || Indicator. Unused for input. Set with output from [[#DumpHdlsStates]] (zero in some cases).
|-
| 0x21 || 0x3 || Padding
|}
 
[9.0.0+] (0x28-bytes):
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || [[#PowerInfo]]
|-
| 0x8 || 0x8 || [[#NpadButton|Buttons]], masked with 0xfffffffff00fffff. See above table regarding HOME/Capture buttons.
|-
| 0x10 || 0x10(4*2*2) || Joystick data.
|-
| 0x20 || 0x1 || Indicator. Unused for input. Set with output from [[#DumpHdlsStates]] (zero in some cases).
|-
| 0x21 || 0x7 || Padding
|}
 
[12.0.0+] (0x40-bytes):
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || [[#PowerInfo]]
|-
| 0x8 || 0x8 || [[#NpadButton|Buttons]], masked with 0xfffffffff00fffff. See above table regarding HOME/Capture buttons.
|-
| 0x10 || 0x10(4*2*2) || Joystick data.
|-
| 0x20 || 0xC || VirtualSixAxisSensorAcceleration
|-
| 0x2C || 0xC || VirtualSixAxisSensorAngle
|-
| 0x38 || 0x4 || [[#HdlsAttribute]]
|-
| 0x3C || 0x1 || Indicator. Unused for input.
|-
| 0x3D || 0x3 || Padding
|}
 
= DebugRegisteredDevice =
This is "nn::hid::debug::RegisteredDevice". This is a 0x58-byte struct with 2-byte alignment.


= RegisteredDevice =
= RegisteredDevice =
Line 8,691: Line 9,109:
| 2 || Rail
| 2 || Rail
|-
|-
| 3 || USB
| 3 || Usb
|-
|-
| 4 || Embedded
| 4 || Embedded
Line 8,870: Line 9,288:
|-
|-
| 2
| 2
| HasLeftSixAxisSensor
| HasLeftJoySixAxisSensor
|-
|-
| 3
| 3
| HasRightSixAxisSensor
| HasRightJoySixAxisSensor
|-
|-
| 4
| 4
| HasExternalSixAxisSensor
| HasFullKeySixAxisSensor
|-
|-
| 5
| 5
Line 8,900: Line 9,318:
|-
|-
| 12
| 12
| HasPalmaIc
| IsPalma
|-
|-
| 13
| 13
Line 8,915: Line 9,333:
|-
|-
| 17
| 17
| HasLeftRightBattery
| HasLeftJoyRightJoyBattery
|-
|-
| 18
| 18
| HasStandardBattery
| HasFullKeyBattery
|-
|-
| 19
| 19
| HasBattery
| IsDisconnectControllerIfBatteryNone
|-
|-
| 20
| 20
| HasMainColor
| HasControllerColor
|-
|-
| 21
| 21
| HasSubColor
| HasGripColor
|-
|-
| 22
| 22
Line 8,948: Line 9,366:
|-
|-
| 28
| 28
| IsEmbeddedController
| IsButtonConfigEmbeddedSupported
|-
|-
| 29
| 29
| IsFullController
| IsButtonConfigFullSupported
|-
|-
| 30
| 30
| IsLeftController
| IsButtonConfigLeftSupported
|-
|-
| 31
| 31
| IsRightController
| IsButtonConfigRightSupported
|-
|-
| 32
| 32
Line 8,969: Line 9,387:
|-
|-
| 35
| 35
| NormalizeAnalogStickWithInnerCross
| IsNormalizeAnalogStickWithInnerCross
|}
|}


Line 9,008: Line 9,426:
|-
|-
| 0x2C || 0x4 || Reserved
| 0x2C || 0x4 || Reserved
|}
= DeviceDescriptionList =
This is "nn::hidtypes::detail::DeviceDescriptionList". This is a list of [[#DeviceDescriptorType|DeviceDescriptorType]] objects maintained by the hid-sysmodule.
{| class="wikitable" border="1"
|-
! [[#DeviceTypeInternal|DeviceType]] || [[#FeatureType|FeatureType]] || [[#DigitalButton|DigitalButton]] || [[#AssignmentStyle|AssignmentStyle]] || [[#Color|DeviceColor]]
|-
| 1 || 0x18BDBE44A || 0x18F0406AF || 0x24 || 0xFF828282, 0xFF0F0F0F, 0x00000000, 0x00000000
|-
| 2 || 0x14CDB8225 || 0x6F8F950 || 0x12 || 0xFF828282, 0xFF0F0F0F, 0x00000000, 0x00000000
|-
| 3 || 0x72BBDA073 || 0xFFCFFFF || 0x1 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|-
| 4 || 0x108000025 || 0x6F8F950 || 0x2 || 0xFF828282, 0xFF0F0F0F, 0x00000000, 0x00000000
|-
| 5 || 0x10800004A || 0x18F0406AF || 0x4 || 0xFF828282, 0xFF0F0F0F, 0x00000000, 0x00000000
|-
| 6 || 0x108800013 || 0xFFCFFFF || 0x1 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|-
| 7 || 0x108CA0000 || 0x2008FCC3 || 0x11 || 0xFF322891, 0xFFFFFFFF, 0x00000000, 0x00000000
|-
| 8 || 0x108CA0800 || 0x4F0C3 || 0x21 || 0xFF322891, 0xFFFFFFFF, 0x00000000, 0x00000000
|-
| 9 || 0x108CA0000 || 0x2008FCC3 || 0x11 || 0xFFD9D7D7, 0xFFFFFFFF, 0x00000000, 0x00000000
|-
| 10 || 0x108CA0000 || 0x4FCC3 || 0x21 || 0xFFD9D7D7, 0xFFFFFFFF, 0x00000000, 0x00000000
|-
| 11 || 0x700CC0000 || 0xFFCF || 0x0 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|-
| 12 || 0x841011 || 0x10000010 || 0x1 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|-
| 13 || 0x83 || 0xFF0F6CF || 0x1 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|-
| 14 || 0x1 || 0xF8F950 || 0x10 || 0xFF828282, 0xFF0F0F0F, 0x00000000, 0x00000000
|-
| 15 || 0x3 || 0xFFCFFFF || 0x1 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|-
| 16 || 0x3 || 0xFFCFFFF || 0x1 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|-
| 17 || 0x1001A013 || 0xFFCFFFF || 0x8 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|-
| 18 || 0x2 || 0xF0406AF || 0x20 || 0xFF828282, 0xFF0F0F0F, 0x00000000, 0x00000000
|-
| 19 || 0x1088DA073 || 0xFFCF3FF || 0x1 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|-
| 20 || 0x108CA0025 || 0x6F8F150 || 0x12 || 0xFF828282, 0xFF0F0F0F, 0x00000000, 0x00000000
|-
| 21 || 0x108CA604A || 0x18F0402AF || 0x24 || 0xFF828282, 0xFF0F0F0F, 0x00000000, 0x00000000
|-
| [12.0.0+] 22 || 0xF00CC8101 || 0x1E1FCF6C3 || 0x1 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|-
| [12.0.0+] 23 || 0x100000000 || 0x0 || 0x0 || 0x00000000, 0x00000000, 0x00000000, 0x00000000
|-
| [13.0.0+] 28 || 0x700CC0000 || 0xCF6CF || 0x1 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|-
| [14.0.0+] 30 || 0x108800003 || 0xFFCFFFF || 0x1 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|}
|}


Line 9,024: Line 9,500:
|-
|-
| 0x8 || 0x8 || [[#FeatureType|FeatureType]]
| 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
|}
|}


Line 9,598: Line 10,094:
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! 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.
* '''FirmwareInfo.csv'''
** List in the format "[device],[type],[version],[file]" where "device", "type" and "version" should match the values from "ExpectVersionInfo" and "file" is the name of the firmware file.
* '''ukyosakyo_ep2_ota.bin'''
** Left/Right Joy-Con BT firmware.
* '''raizo_ep2_ota.bin'''
** Pro Controller BT firmware.
* '''tera_ota.bin'''
** Right Joy-Con MCU firmware.
* '''tera_ota_iap.bin'''
** Right Joy-Con MCU (IAP profile) firmware.
* '''tera_fullkey_ota.bin'''
** Pro Controller MCU firmware.
* '''tera_fullkey_ota_iap.bin'''
** Pro Controller MCU (IAP profile) firmware.
* [6.0.0+] '''ProController.dfu'''
** Pro Controller USB firmware.
* [6.1.0+] '''PalmaFw.bin'''
** Poké Ball Plus BT firmware.
* [8.1.1+] '''ExpectVersionInfo-platform.hoag.csv'''
** Same as "ExpectVersionInfo.csv" but for the Switch Lite platform.
* [8.1.1+] '''FirmwareInfo-platform.hoag.csv'''
** Same as "FirmwareInfo.csv" but for the Switch Lite platform.
* [8.1.1+] '''sioh.bin'''
** Switch Lite Joy-Con firmware.
* [8.1.1+] '''sioh_iap.bin'''
** Switch Lite Joy-Con (IAP profile) firmware.
* [10.0.0+] '''FTS_00120100.fts256'''
** Touch Screen controller firmware in FTS256 format.
* [10.0.0+] '''FTS_32000001.fts256'''
** Touch Screen controller firmware in FTS256 format for panel vendor "Nissha".
* [10.0.0+] '''FTS_32000102.fts256'''
** Touch Screen controller firmware in FTS256 format for panel vendor "GIS".
* [10.0.0+] '''FTS_32000302.fts256'''
** Touch Screen controller firmware in FTS256 format for panel vendor "Nissha_Hoag".
* [10.0.0+] '''FTS_32000402.fts256'''
** Touch Screen controller firmware in FTS256 format for panel vendor "GIS_Hoag".
* [10.0.0+] '''TouchScreenConfiguration.csv'''
** List in the format "[gpio],[gpio],[gpio],[config],[config]" where "gpio" can be "0" or "1" and "config" is an integer number.
* [10.0.0+] '''TouchScreenFirmwareInfo.csv'''
** List in the format "[driver],[gpio],[gpio],[gpio],[version],[file]" where "driver" can be "FTM" or "FST2", "gpio" can be "0" or "1", "version" is the hexadecimal representation of the firmware file's version and "file" is the name of the firmware file.
* [13.0.0+] '''FTS_33000510.fts256'''
** Touch Screen controller firmware in FTS256 format for panel vendor "Samsung_Aula".
* [13.0.0] '''FTS_98000004.ftb'''
** Touch Screen controller firmware in FTB format.
* [13.1.0-13.2.1] '''FTS_50000001.ftb'''
** Touch Screen controller firmware in FTB format for panel vendor "Nissha".
* [14.0.0+] '''FTS_50000002.ftb'''
** Touch Screen controller firmware in FTB format for panel vendor "Nissha".
 
== Versions ==
=== Ukyosakyo ===
{| class="wikitable" border="1"
|-
! SystemVersion
! FirmwareVersion
|-
| [1.0.0+]
| 0348
|-
| [5.0.0+]
| 0389
|-
| [6.0.0+]
| 038B
|-
| [7.0.0+]
| 03A6
|-
| [8.0.0+]
| 03B5
|-
| [9.0.0+]
| 0400
|-
| [10.0.0+]
| 0406
|-
|-
| 0x0 || 0x4 || [[#AdaptiveClusteringMode]]
| [11.0.0+]
| 0407
|-
|-
| 0x4 || 0x4 || [6.0.0+] [[#AdaptiveClusteringTargetDistance]]
| [12.1.0+]
|}
| 0410
 
== AdaptiveClusteringMode ==
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || StaticFov
| [13.0.0+]
| 0417
|-
|-
| 1 || DynamicFov
| [14.0.0+]
| 0419
|}
|}


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]]
|}
 
== HandAnalysisMode ==
{| class="wikitable" border="1"
!  Value
! Description
|-
|-
| 0 || None (invalid)
| [1.0.0+]
| 030B
|-
|-
| 1 || Silhouette
| [4.0.0+]
| 0412
|-
|-
| 2 || Image
| [5.0.0+]
| 0518
|-
|-
| 3 || SilhouetteAndImage
| [6.0.0+]
| 061A
|-
|-
| 4 || [4.0.0+] SilhouetteOnly
| [8.0.0+]
| 081B
|}
|}


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


= 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]]
* Famicom right controller (with microphone)
** [[#BusType]] is 2, ExternalDeviceId is 0x21. 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.
* Used by Starlink: Battle For Atlas.
** [[#BusType]] is 1, ExternalDeviceId is 0x28. 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".
* [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]]
Retrieved from "https://switchbrew.org/wiki/HID_services"