Nintendo Switch Brew

HID services: Difference between revisions

← Older edit
 
(140 intermediate revisions by 5 users not shown)
Line 13: Line 13:
|-
|-
| 21 || [[#ActivateMouse]]
| 21 || [[#ActivateMouse]]
|-
| 22 || [19.0.0+] AddMouseWheelDelta
|-
| 26 || [16.0.0+] ActivateDebugMouse
|-
|-
| 31 || [[#ActivateKeyboard]]
| 31 || [[#ActivateKeyboard]]
Line 79: Line 83:
|-
|-
| 83 || [6.0.0+] [[#IsFirmwareUpdateAvailableForSixAxisSensor]]
| 83 || [6.0.0+] [[#IsFirmwareUpdateAvailableForSixAxisSensor]]
|-
| 84 || [13.0.0+] [[#EnableSixAxisSensorUnalteredPassthrough]]
|-
| 85 || [13.0.0+] [[#IsSixAxisSensorUnalteredPassthroughEnabled]]
|-
| 86 || [13.0.0+] [[#StoreSixAxisSensorCalibrationParameter]]
|-
| 87 || [13.0.0+] [[#LoadSixAxisSensorCalibrationParameter]]
|-
| 88 || [13.0.0+] [[#GetSixAxisSensorIcInformation]]
|-
| 89 || [13.0.0+] [[#ResetIsSixAxisSensorDeviceNewlyAssigned]]
|-
|-
| 91 || [[#ActivateGesture]]
| 91 || [[#ActivateGesture]]
|-
| 92 || [18.0.0+] SetGestureOutputRanges
|-
|-
| 100 || [[#SetSupportedNpadStyleSet]]
| 100 || [[#SetSupportedNpadStyleSet]]
Line 133: Line 151:
|-
|-
| 136 || [8.0.0+] [[#ClearNpadCaptureButtonAssignment]]
| 136 || [8.0.0+] [[#ClearNpadCaptureButtonAssignment]]
|-
| 137 || [20.0.0+] SetNpadGcAnalogStick8bitRawValue
|-
|-
| 200 || [[#GetVibrationDeviceInfo]]
| 200 || [[#GetVibrationDeviceInfo]]
Line 157: Line 177:
|-
|-
| 211 || [7.0.0+] [[#IsVibrationDeviceMounted]]
| 211 || [7.0.0+] [[#IsVibrationDeviceMounted]]
|-
| 212 || [11.0.0+] [[#SendVibrationValueInBool]]
|-
| 213 || [17.0.0+] SendVibrationValueInMode
|-
| 214 || [17.0.0+] SendVibrationValuesInMode
|-
|-
| 300 || [3.0.0+] [[#ActivateConsoleSixAxisSensor]]
| 300 || [3.0.0+] [[#ActivateConsoleSixAxisSensor]]
Line 179: 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 265: 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 427: 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 475: 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 485: 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 584: Line 661:
== IsVibrationDeviceMounted ==
== IsVibrationDeviceMounted ==
Takes a PID, an [[#VibrationDeviceHandle]], and an u64 [[AM_services|AppletResourceUserId]], returns an output u8 bool.
Takes a PID, an [[#VibrationDeviceHandle]], and an u64 [[AM_services|AppletResourceUserId]], returns an output u8 bool.
== SendVibrationValueInBool ==
Takes a PID, a bool, a [[#VibrationDeviceHandle]], and an [[AM_services|AppletResourceUserId]], no output.
Stubbed, this just returns 0.
This is currently not exposed by sdknso.


== ActivateConsoleSixAxisSensor ==
== ActivateConsoleSixAxisSensor ==
Line 650: 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 713: Line 815:


sdknso uses an user-specified EventClearMode.
sdknso uses an user-specified EventClearMode.
The Event is signaled when data is available with [[#GetPalmaOperationInfo]].


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


sdknso passes [[#PalmaOperationInfo]]+0x8 size 0x140 for the output buffer. [5.1.0+] After using the cmd successfully, [[#GetPalmaOperationResult]] is used.
sdknso passes [[#PalmaOperationInfo]]+0x8 size 0x140 for the output buffer. [5.1.0+] After using the cmd successfully, [[#GetPalmaOperationResult]] is used.
This must be used at some point following using any of the other Palma cmds which trigger an Operation, once the [[#AcquirePalmaOperationCompleteEvent|Event]] is signaled. Up to 4 Operations can be queued at once, the other cmds will throw an error once there's too many operations.


== PlayPalmaActivity ==
== PlayPalmaActivity ==
Takes an input [[#PalmaConnectionHandle]], an u64 (exposed by sdknso as an u16), no output.
Takes an input [[#PalmaConnectionHandle]], an u64 (exposed by sdknso as an u16), no output.
See [[#GetPalmaOperationInfo]].


== SetPalmaFrModeType ==
== SetPalmaFrModeType ==
Takes an input [[#PalmaConnectionHandle]], an u64 [[#PalmaFrModeType]], no output.
Takes an input [[#PalmaConnectionHandle]], an u64 [[#PalmaFrModeType]], no output.
See [[#GetPalmaOperationInfo]].


== ReadPalmaStep ==
== ReadPalmaStep ==
Takes an input [[#PalmaConnectionHandle]], no output.
Takes an input [[#PalmaConnectionHandle]], no output.
See [[#GetPalmaOperationInfo]].
[[#EnablePalmaStep]] should be used before this.


== EnablePalmaStep ==
== EnablePalmaStep ==
Takes an input bool, a [[#PalmaConnectionHandle]], no output.
Takes an input bool, a [[#PalmaConnectionHandle]], no output.
See [[#GetPalmaOperationInfo]].


== ResetPalmaStep ==
== ResetPalmaStep ==
Takes an input [[#PalmaConnectionHandle]], no output.
Takes an input [[#PalmaConnectionHandle]], no output.
See [[#GetPalmaOperationInfo]].


== ReadPalmaApplicationSection ==
== ReadPalmaApplicationSection ==
Takes an input [[#PalmaConnectionHandle]], an u64, an u64, no output.
Takes an input [[#PalmaConnectionHandle]], an u64, an u64 size, no output.


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


== WritePalmaApplicationSection ==
== WritePalmaApplicationSection ==
Line 743: Line 863:


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


== ReadPalmaUniqueCode ==
== ReadPalmaUniqueCode ==
Takes an input [[#PalmaConnectionHandle]], no output.
Takes an input [[#PalmaConnectionHandle]], no output.
See [[#GetPalmaOperationInfo]].


== SetPalmaUniqueCodeInvalid ==
== SetPalmaUniqueCodeInvalid ==
Takes an input [[#PalmaConnectionHandle]], no output.
Takes an input [[#PalmaConnectionHandle]], no output.
See [[#GetPalmaOperationInfo]].


== WritePalmaActivityEntry ==
== WritePalmaActivityEntry ==
Line 754: Line 880:


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


== WritePalmaRgbLedPatternEntry ==
== WritePalmaRgbLedPatternEntry ==
Line 759: Line 887:


sdknso exposes the u64 as an u16.
sdknso exposes the u64 as an u16.
See [[#GetPalmaOperationInfo]].


== WritePalmaWaveEntry ==
== WritePalmaWaveEntry ==
Line 764: Line 894:


The TransferMemory is created from an user-specified buffer with permissions=R--.
The TransferMemory is created from an user-specified buffer with permissions=R--.
Note that the sysmodule will not properly close the TransferMemory handle if the [[#PalmaConnectionHandle]] is invalid.
See [[#GetPalmaOperationInfo]].


== SetPalmaDataBaseIdentificationVersion ==
== SetPalmaDataBaseIdentificationVersion ==
Takes an input s32, a [[#PalmaConnectionHandle]], no output.
Takes an input s32, a [[#PalmaConnectionHandle]], no output.
See [[#GetPalmaOperationInfo]].


== GetPalmaDataBaseIdentificationVersion ==
== GetPalmaDataBaseIdentificationVersion ==
Takes an input [[#PalmaConnectionHandle]], no output.
Takes an input [[#PalmaConnectionHandle]], no output.
See [[#GetPalmaOperationInfo]].


== SuspendPalmaFeature ==
== SuspendPalmaFeature ==
Takes an input "nn::util::BitFlagSet<32, [[#PalmaFeature]]>", a [[#PalmaConnectionHandle]], no output.
Takes an input "nn::util::BitFlagSet<32, [[#PalmaFeature]]>", a [[#PalmaConnectionHandle]], no output.
See [[#GetPalmaOperationInfo]].


== GetPalmaOperationResult ==
== GetPalmaOperationResult ==
Line 781: Line 921:
== ReadPalmaPlayLog ==
== ReadPalmaPlayLog ==
Takes an input u16, a [[#PalmaConnectionHandle]], no output.
Takes an input u16, a [[#PalmaConnectionHandle]], no output.
See [[#GetPalmaOperationInfo]].


== ResetPalmaPlayLog ==
== ResetPalmaPlayLog ==
Takes an input u16, a [[#PalmaConnectionHandle]], no output.
Takes an input u16, a [[#PalmaConnectionHandle]], no output.
See [[#GetPalmaOperationInfo]].


== SetIsPalmaAllConnectable ==
== SetIsPalmaAllConnectable ==
Takes a PID, a bool, an [[AM_services|AppletResourceUserId]], no output.
Takes a PID, a bool, an [[AM_services|AppletResourceUserId]], no output.
The sysmodule also calls the code which eventually runs from this, from various other funcs internally (bool value varies).
This updates various state. If needed, this uses either [[BTM_services|StartBleScanForGeneral]] or [[BTM_services|StopBleScanForGeneral]].


== SetIsPalmaPairedConnectable ==
== SetIsPalmaPairedConnectable ==
Takes a PID, a bool, an [[AM_services|AppletResourceUserId]], no output.
Takes a PID, a bool, an [[AM_services|AppletResourceUserId]], no output.
The actual cmd impl ignores the PID/AppletResourceUserId.
This code is also called by another func internally by the sysmodule, where flag = {whether bit6 in a field is set} (presumably [[#NpadStyleSet]]). This is eventually called from various funcs, including [[#SetSupportedNpadStyleSet]].
This updates various state. If needed, this uses either [[BTM_services|StartBleScanForPairedDevice]] or [[BTM_services|StopBleScanForPairedDevice]].


== PairPalma ==
== PairPalma ==
Takes an input [[#PalmaConnectionHandle]], no output.
Takes an input [[#PalmaConnectionHandle]], no output.
This eventually uses [[BTM_services#BlePairDevice|BlePairDevice]] if needed, and updates state.


== SetPalmaBoostMode ==
== SetPalmaBoostMode ==
Line 813: Line 969:
== SetNpadCommunicationMode ==
== SetNpadCommunicationMode ==
Takes a PID, an [[AM_services|AppletResourceUserId]], a s64 [[#NpadCommunicationMode]], no output.
Takes a PID, an [[AM_services|AppletResourceUserId]], a s64 [[#NpadCommunicationMode]], no output.
[2.0.0+] Stubbed, just returns 0.


== GetNpadCommunicationMode ==
== GetNpadCommunicationMode ==
Line 818: Line 976:


sdknso uses a switch-statement to determine the value to write to the output [[#NpadCommunicationMode]], with the s64 (written value is the same as the s64). sdknso will Abort if the s64 is not 0-3.
sdknso uses a switch-statement to determine the value to write to the output [[#NpadCommunicationMode]], with the s64 (written value is the same as the s64). sdknso will Abort if the s64 is not 0-3.
[2.0.0+] Stubbed, just returns hard-coded output mode=3.


== SetTouchScreenConfiguration ==
== SetTouchScreenConfiguration ==
Line 828: 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 ==
This is "nn::hid::IAppletResource".
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
Line 874: Line 1,036:
|-
|-
| 13 || [9.0.0+] GetTouchScreenConfiguration
| 13 || [9.0.0+] GetTouchScreenConfiguration
|-
| 14 || [11.0.0+] ProcessTouchScreenAutoTune
|-
| 15 || [13.0.0+] ForceStopTouchScreenManagement
|-
| 16 || [13.0.0+] ForceRestartTouchScreenManagement
|-
| 17 || [13.0.0+] IsTouchScreenManaged
|-
| 18 || [18.0.0+] SetTouchScreenAutoPilotStateWithAruid
|-
|-
| 20 || [[#DeactivateMouse]]
| 20 || [[#DeactivateMouse]]
Line 880: Line 1,052:
|-
|-
| 22 || [[#UnsetMouseAutoPilotState]]
| 22 || [[#UnsetMouseAutoPilotState]]
|-
| 25 || [16.0.0+] SetDebugMouseAutoPilotState
|-
| 26 || [16.0.0+] UnsetDebugMouseAutoPilotState
|-
|-
| 30 || [[#DeactivateKeyboard]]
| 30 || [[#DeactivateKeyboard]]
Line 909: Line 1,085:
| 112 || UnsetHomeButtonAutoPilotState
| 112 || UnsetHomeButtonAutoPilotState
|-
|-
| 120 || DeactivateSleepButton
| 120 || [[#DeactivateSleepButton]]
|-
|-
| 121 || SetSleepButtonAutoPilotState
| 121 || [[#SetSleepButtonAutoPilotState]]
|-
|-
| 122 || UnsetSleepButtonAutoPilotState
| 122 || [[#UnsetSleepButtonAutoPilotState]]
|-
|-
| 123 || [1.0.0-9.2.0] DeactivateInputDetector
| 123 || [1.0.0-9.2.0] DeactivateInputDetector
Line 930: 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 978: 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,034: Line 1,220:
|-
|-
| 246 || [9.0.0+] GetVidPid
| 246 || [9.0.0+] GetVidPid
|-
| 247 || [11.0.0+] GetAnalogStickCalibrationValue
|-
| 248 || [11.0.0+] GetUniquePadIdsFull
|-
| 249 || [11.0.0+] ConnectUniquePad
|-
| 250 || [12.0.0+] IsVirtual
|-
| 251 || [12.0.0+] GetAnalogStickModuleParam
|-
| 253 || [19.0.0+] ClearStorageForShipment
|-
|-
| 301 || [5.0.0-8.1.0] [[#GetAbstractedPadHandles]]
| 301 || [5.0.0-8.1.0] [[#GetAbstractedPadHandles]]
Line 1,065: Line 1,263:
| 332 || [7.0.0+] [[#SetHdlsState]]
| 332 || [7.0.0+] [[#SetHdlsState]]
|-
|-
| 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,074: Line 1,276:
|-
|-
| 403 || [10.0.0+] EnableShipmentModeAutoClear
| 403 || [10.0.0+] EnableShipmentModeAutoClear
|-
| 404 || [11.0.0+] SetRailEnabled
|-
|-
| 500 || [8.0.0+] SetFactoryInt
| 500 || [8.0.0+] SetFactoryInt
Line 1,087: Line 1,291:
| 600 || [10.0.0+] ConvertPadState
| 600 || [10.0.0+] ConvertPadState
|-
|-
| 2000 || [10.0.0+] DeactivateDigitizer
| 601 || [18.0.0+] [[#IsButtonConfigSupported]]
|-
|-
| 2001 || [10.0.0+] SetDigitizerAutoPilotState
| 602 || [18.0.0+] [[#IsButtonConfigEmbeddedSupported]]
|-
|-
| 2002 || [10.0.0+] UnsetDigitizerAutoPilotState
| 603 || [18.0.0+] [[#DeleteButtonConfig]]
|}
|-
 
| 604 || [18.0.0+] [[#DeleteButtonConfigEmbedded]]
== DeactivateDebugPad ==
|-
No input/output.
| 605 || [18.0.0+] [[#SetButtonConfigEnabled]]
 
|-
== SetDebugPadAutoPilotState ==
| 606 || [18.0.0+] [[#SetButtonConfigEmbeddedEnabled]]
Takes an input [[#DebugPadAutoPilotState]], no output.
|-
| 607 || [18.0.0+] [[#IsButtonConfigEnabled]]
|-
| 608 || [18.0.0+] [[#IsButtonConfigEmbeddedEnabled]]
|-
| 609 || [18.0.0+] [[#SetButtonConfigEmbedded]]
|-
| 610 || [18.0.0+] [[#SetButtonConfigFull]]
|-
| 611 || [18.0.0+] [[#SetButtonConfigLeft]]
|-
| 612 || [18.0.0+] [[#SetButtonConfigRight]]
|-
| 613 || [18.0.0+] [[#GetButtonConfigEmbedded]]
|-
| 614 || [18.0.0+] [[#GetButtonConfigFull]]
|-
| 615 || [18.0.0+] [[#GetButtonConfigLeft]]
|-
| 616 || [18.0.0+] [[#GetButtonConfigRight]]
|-
| 650 || [12.0.0+] AddButtonPlayData
|-
| 651 || [12.0.0+] StartButtonPlayData
|-
| 652 || [12.0.0+] StopButtonPlayData
|-
| 2000 || [10.0.0+] [[#DeactivateDigitizer]]
|-
| 2001 || [10.0.0+] [[#SetDigitizerAutoPilotState]]
|-
| 2002 || [10.0.0+] [[#UnsetDigitizerAutoPilotState]]
|-
| 3000 || [16.0.0+] ReloadFirmwareDebugSettings
|}
 
== DeactivateDebugPad ==
No input/output.
 
== SetDebugPadAutoPilotState ==
Takes an input [[#DebugPadAutoPilotState]], no output.


== UnsetDebugPadAutoPilotState ==
== UnsetDebugPadAutoPilotState ==
Line 1,139: Line 1,383:


This just returns 0.
This just returns 0.
== DeactivateSleepButton ==
No input/output.
== SetSleepButtonAutoPilotState ==
Takes an input [[#SleepButtonAutoPilotState]], no output.
== UnsetSleepButtonAutoPilotState ==
No input/output.


== StartFirmwareUpdate ==
== StartFirmwareUpdate ==
Line 1,146: Line 1,399:


== GetFirmwareVersion ==
== GetFirmwareVersion ==
Takes a total of 8-bytes of input, and returns a total of 4-bytes of output.
Takes an input [[#NpadIdType]] and an input [[#DeviceType]]. Returns an output [[#FirmwareVersion]].
 
[3.0.0+] Now returns an additional 0xC-bytes of output.


== GetDestinationFirmwareVersion ==
== GetDestinationFirmwareVersion ==
Takes a total of 8-bytes of input, and returns a total of 4-bytes of output.
Takes an input [[#NpadIdType]] and an input [[#DeviceType]]. Returns an output [[#FirmwareVersion]].
 
[3.0.0+] Now returns an additional 0xC-bytes of output.


== DiscardFirmwareInfoCacheForRevert ==
== DiscardFirmwareInfoCacheForRevert ==
Takes a total of 8-bytes of input, and returns a total of 5-bytes of output.
Takes an input [[#NpadIdType]] and an input [[#DeviceType]]. Returns a total of 5-bytes of output.


[3.0.0+] No input/output.
[3.0.0+] No input/output.
Line 1,178: 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,245: Line 1,496:
== AttachHdlsWorkBuffer ==
== AttachHdlsWorkBuffer ==
Takes an input TransferMemory handle and an u64 for the TransferMemory size, no output.
Takes an input TransferMemory handle and an u64 for the TransferMemory size, no output.
[13.0.0+] Now additionally returns an output [[#HdlsSessionId]].


Official user-processes use TransferMemory size=0x1000 and permissions=RW.
Official user-processes use TransferMemory size=0x1000 and permissions=RW.
Line 1,254: Line 1,507:
== ReleaseHdlsWorkBuffer ==
== ReleaseHdlsWorkBuffer ==
No input/output.
No input/output.
[13.0.0+] Takes an input [[#HdlsSessionId]], no output.


== DumpHdlsNpadAssignmentState ==
== DumpHdlsNpadAssignmentState ==
No input/output.
No input/output.
[13.0.0+] Takes an input [[#HdlsSessionId]], no output.


After using this cmd, the output [[#HdlsNpadAssignment]] is located at tmem+0.
After using this cmd, the output [[#HdlsNpadAssignment]] is located at tmem+0.
Line 1,262: Line 1,519:
== DumpHdlsStates ==
== DumpHdlsStates ==
No input/output.
No input/output.
[13.0.0+] Takes an input [[#HdlsSessionId]], no output.


After using this cmd, the output [[#HdlsStateList]] struct is located at tmem+0.
After using this cmd, the output [[#HdlsStateList]] struct is located at tmem+0.
Line 1,267: Line 1,526:
== ApplyHdlsNpadAssignmentState ==
== ApplyHdlsNpadAssignmentState ==
Takes an input u8 bool, no output.
Takes an input u8 bool, no output.
[13.0.0+] Takes an input bool and a [[#HdlsSessionId]], no output.


Prior to using this cmd, the input [[#HdlsNpadAssignment]] is written to tmem+0 by the user-process.
Prior to using this cmd, the input [[#HdlsNpadAssignment]] is written to tmem+0 by the user-process.
Line 1,272: Line 1,533:
== ApplyHdlsStateList ==
== ApplyHdlsStateList ==
No input/output.
No input/output.
[13.0.0+] Takes an input [[#HdlsSessionId]], no output.


Prior to using this cmd, the input [[#HdlsStateList]] is written to tmem+0 by the user-process.
Prior to using this cmd, the input [[#HdlsStateList]] is written to tmem+0 by the user-process.
Line 1,287: Line 1,550:


[9.0.0+] Input order was swapped: now takes an input [[#HdlsHandle]] and a [[#HdlsState]], no output.
[9.0.0+] Input order was swapped: now takes an input [[#HdlsHandle]] and a [[#HdlsState]], no output.
== AddRegisteredDevice ==
Takes an input [[#RegisteredDevice]], no output.
[11.0.0+] Takes an input [[#DebugRegisteredDevice]], no output.
== DeactivateDigitizer ==
No input/output.
== SetDigitizerAutoPilotState ==
Takes an input [[#DigitizerAutoPilotState]]. No output.
== UnsetDigitizerAutoPilotState ==
No input/output.


= hid:sys =
= hid:sys =
Line 1,296: 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,319: 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
|-
|-
| 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
|-
|-
| 307 || GetNpadSystemExtStyle
| 225 || [19.0.0+] ClearMifareKey
|-
|-
| 308 || [5.0.0+] ApplyNpadSystemCommonPolicyFull
| 226 || [19.0.0+] StartMifareRead
|-
|-
| 309 || [5.0.0+] GetNpadFullKeyGripColor
| 227 || [19.0.0+] StartMifareWrite
|-
|-
| 310 || [6.0.0+] [[#GetMaskedSupportedNpadStyleSet]]
| 230 || AcquireIrSensorEventHandle
|-
|-
| 311 || SetNpadPlayerLedBlinkingDevice
| 231 || ActivateIrSensor
|-
| 232 || [10.0.0+] GetIrSensorState
|-
| 233 || [10.0.0+] GetXcdHandleForNpadWithIrSensor
|-
| 234 || [19.0.0+] GetNpadJoyHoldType
|-
| 241 || [19.0.0+] [[#GetDataFormat]]
|-
| 242 || [19.0.0+] [[#SetDataFormat]]
|-
| 243 || [19.0.0+] [[#GetMcuState]]
|-
| 244 || [19.0.0+] [[#SetMcuState]]
|-
| 245 || [19.0.0+] [[#GetMcuVersionForNfc]]
|-
| 246 || [19.0.0+] [[#CheckNfcDevicePower]]
|-
| 247 || [19.0.0+] [[#SetMcuStateImmediate]]
|-
| 301 || ActivateNpadSystem
|-
| 303 || ApplyNpadSystemCommonPolicy
|-
| 304 || EnableAssigningSingleOnSlSrPress
|-
| 305 || DisableAssigningSingleOnSlSrPress
|-
| 306 || GetLastActiveNpad
|-
| 307 || GetNpadSystemExtStyle
|-
| 308 || [5.0.0+] ApplyNpadSystemCommonPolicyFull
|-
| 309 || [5.0.0+] GetNpadFullKeyGripColor
|-
| 310 || [6.0.0+] [[#GetMaskedSupportedNpadStyleSet]]
|-
| 311 || SetNpadPlayerLedBlinkingDevice
|-
|-
| 312 || [6.0.0+] SetSupportedNpadStyleSetAll
| 312 || [6.0.0+] SetSupportedNpadStyleSetAll
Line 1,378: Line 1,699:
|-
|-
| 326 || [10.0.0+] GetUniquePadAppletDetailedUiType
| 326 || [10.0.0+] GetUniquePadAppletDetailedUiType
|-
| 327 || [14.0.0+] GetAbstractedPadIdDataFromNpad
|-
| 328 || [14.0.0+] AttachAbstractedPadToNpad
|-
| 329 || [14.0.0+] DetachAbstractedPadAll
|-
| 330 || [14.0.0+] CheckAbstractedPadConnection
|-
| 332 || [19.0.0+] ConvertAppletDetailedUiTypeFromPlayReportType
|-
| 333 || [20.0.0+] SetNpadUserSpgApplet
|-
| 334 || [20.0.0+] AcquireUniquePadButtonStateChangedEventHandle
|-
|-
| 500 || SetAppletResourceUserId
| 500 || SetAppletResourceUserId
Line 1,390: Line 1,725:
|-
|-
| 505 || EnableAppletToGetSixAxisSensor
| 505 || EnableAppletToGetSixAxisSensor
|-
| 506 || [14.0.0+] EnableAppletToGetPadInput
|-
| 507 || [14.0.0+] EnableAppletToGetTouchScreen
|-
|-
| 510 || [[#SetVibrationMasterVolume]]
| 510 || [[#SetVibrationMasterVolume]]
Line 1,398: Line 1,737:
|-
|-
| 513 || [3.0.0+] EndPermitVibrationSession
| 513 || [3.0.0+] EndPermitVibrationSession
|-
| 514 || [12.0.0+] SendVibrationNotificationPattern
|-
|-
| 520 || EnableHandheldHids
| 520 || EnableHandheldHids
Line 1,408: Line 1,749:
|-
|-
| 524 || [10.0.0+] IsHandheldHidsEnabled
| 524 || [10.0.0+] IsHandheldHidsEnabled
|-
| 525 || [11.0.0+] IsJoyConAttachedOnAllRail
|-
| 526 || [19.0.0+] IsInvertedControllerConnectedOnRail
|-
|-
| 540 || AcquirePlayReportControllerUsageUpdateEvent
| 540 || AcquirePlayReportControllerUsageUpdateEvent
Line 1,415: 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,428: Line 1,773:
|-
|-
| 549 || [6.0.0+] GetConnectableRegisteredDevices
| 549 || [6.0.0+] GetConnectableRegisteredDevices
|-
| 551 || [20.0.0+] GetRegisteredDevicesForControllerSupport
|-
|-
| 700 || ActivateUniquePad
| 700 || ActivateUniquePad
Line 1,434: Line 1,781:
|-
|-
| 703 || [[#GetUniquePadIds]]
| 703 || [[#GetUniquePadIds]]
|-
| 711 || [20.0.0+] AcquireUniquePadConnectionOnHandheldForNsEventHandle
|-
| 712 || [20.0.0+] GetUniquePadColor12
|-
|-
| 751 || AcquireJoyDetachOnBluetoothOffEventHandle
| 751 || AcquireJoyDetachOnBluetoothOffEventHandle
Line 1,462: Line 1,813:
|-
|-
| 812 || [8.0.0+] GetConsoleUniqueSixAxisSensorHandle
| 812 || [8.0.0+] GetConsoleUniqueSixAxisSensorHandle
|-
| 813 || [18.0.0+] GetDeviceType
|-
|-
| 821 || StartAnalogStickManualCalibration
| 821 || StartAnalogStickManualCalibration
Line 1,522: 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,535: 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,544: 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
|-
|-
| 1151 || [9.0.0+] GetTouchScreenFirmwareVersion
| 1151 || [9.0.0+] [[#GetTouchScreenFirmwareVersion]]
|-
|-
| 1152 || [9.0.0+] SetTouchScreenDefaultConfiguration
| 1152 || [9.0.0+] SetTouchScreenDefaultConfiguration
Line 1,561: Line 1,918:
| 1157 || [10.0.0+] [[#CancelConnectionTrigger]]
| 1157 || [10.0.0+] [[#CancelConnectionTrigger]]
|-
|-
| 1200 || [10.0.0+] [[#IsButtonConfigSupported]]
| 1158 || [20.1.0+]
|-
| 1159 || [20.1.0+]
|-
| 1200 || [10.0.0-17.0.1] [[#IsButtonConfigSupported]]
|-
| 1201 || [11.0.0-17.0.1] [[#IsButtonConfigEmbeddedSupported]] ([10.0.0-10.2.0] [[#DeleteButtonConfig]])
|-
| 1202 || [11.0.0-17.0.1] [[#DeleteButtonConfig]] ([10.0.0-10.2.0] [[#SetButtonConfigEnabled]])
|-
| 1203 || [11.0.0-17.0.1] [[#DeleteButtonConfigEmbedded]] ([10.0.0-10.2.0] [[#IsButtonConfigEnabled]])
|-
| 1204 || [11.0.0-17.0.1] [[#SetButtonConfigEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigEmbedded]])
|-
|-
| 1201 || [10.0.0+] [[#DeleteButtonConfig]]
| 1205 || [11.0.0-17.0.1] [[#SetButtonConfigEmbeddedEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigFull]])
|-
|-
| 1202 || [10.0.0+] [[#SetButtonConfigEnabled]]
| 1206 || [11.0.0-17.0.1] [[#IsButtonConfigEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigLeft]])
|-
|-
| 1203 || [10.0.0+] [[#IsButtonConfigEnabled]]
| 1207 || [11.0.0-17.0.1] [[#IsButtonConfigEmbeddedEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigRight]])
|-
|-
| 1204 || [10.0.0+] [[#SetButtonConfigEmbedded]]
| 1208 || [11.0.0-17.0.1] [[#SetButtonConfigEmbedded]] ([10.0.0-10.2.0] [[#GetButtonConfigEmbedded]])
|-
|-
| 1205 || [10.0.0+] [[#SetButtonConfigFull]]
| 1209 || [11.0.0-17.0.1] [[#SetButtonConfigFull]] ([10.0.0-10.2.0] [[#GetButtonConfigFull]])
|-
|-
| 1206 || [10.0.0+] [[#SetButtonConfigLeft]]
| 1210 || [10.0.0-10.2.0] [[#GetButtonConfigLeft]]
|-
|-
| 1207 || [10.0.0+] [[#SetButtonConfigRight]]
| 1211 || [11.0.0-17.0.1] [[#SetButtonConfigRight]] ([10.0.0-10.2.0] [[#GetButtonConfigRight]])
|-
|-
| 1208 || [10.0.0+] [[#GetButtonConfigEmbedded]]
| 1212 || [11.0.0-17.0.1] [[#GetButtonConfigEmbedded]]
|-
|-
| 1209 || [10.0.0+] [[#GetButtonConfigFull]]
| 1213 || [11.0.0-17.0.1] [[#GetButtonConfigFull]]
|-
|-
| 1210 || [10.0.0+] [[#GetButtonConfigLeft]]
| 1214 || [11.0.0-17.0.1] [[#GetButtonConfigLeft]]
|-
|-
| 1211 || [10.0.0+] [[#GetButtonConfigRight]]
| 1215 || [11.0.0-17.0.1] [[#GetButtonConfigRight]]
|-
|-
| 1250 || [10.0.0+] [[#IsCustomButtonConfigSupported]]
| 1250 || [10.0.0+] [[#IsCustomButtonConfigSupported]]
Line 1,603: Line 1,972:
| 1258 || [10.0.0+] [[#IsButtonConfigStorageRightEmpty]]
| 1258 || [10.0.0+] [[#IsButtonConfigStorageRightEmpty]]
|-
|-
| 1259 || [10.0.0+] [[#GetButtonConfigStorageEmbedded]]
| 1259 || [11.0.0-12.1.0] [[#GetButtonConfigStorageEmbeddedDeprecated]] ([10.0.0-10.2.0] [[#GetButtonConfigStorageEmbeddedDeprecated|GetButtonConfigStorageEmbedded]])
|-
|-
| 1260 || [10.0.0+] [[#GetButtonConfigStorageFull]]
| 1260 || [11.0.0-12.1.0] [[#GetButtonConfigStorageFullDeprecated]] ([10.0.0-10.2.0] [[#GetButtonConfigStorageFullDeprecated|GetButtonConfigStorageFull]])
|-
|-
| 1261 || [10.0.0+] [[#GetButtonConfigStorageLeft]]
| 1261 || [11.0.0-12.1.0] [[#GetButtonConfigStorageLeftDeprecated]] ([10.0.0-10.2.0] [[#GetButtonConfigStorageLeftDeprecated|GetButtonConfigStorageLeft]])
|-
|-
| 1262 || [10.0.0+] [[#GetButtonConfigStorageRight]]
| 1262 || [11.0.0-12.1.0] [[#GetButtonConfigStorageRightDeprecated]] ([10.0.0-10.2.0] [[#GetButtonConfigStorageRightDeprecated|GetButtonConfigStorageRight]])
|-
|-
| 1263 || [10.0.0+] [[#SetButtonConfigStorageEmbedded]]
| 1263 || [11.0.0-12.1.0] [[#SetButtonConfigStorageEmbeddedDeprecated]] ([10.0.0-10.2.0] [[#SetButtonConfigStorageEmbeddedDeprecated|SetButtonConfigStorageEmbedded]])
|-
|-
| 1264 || [10.0.0+] [[#SetButtonConfigStorageFull]]
| 1264 || [11.0.0-12.1.0] [[#SetButtonConfigStorageFullDeprecated]] ([10.0.0-10.2.0] [[#SetButtonConfigStorageFullDeprecated|SetButtonConfigStorageFull]])
|-
|-
| 1265 || [10.0.0+] [[#SetButtonConfigStorageLeft]]
| 1265 || [11.0.0-12.1.0] [[#SetButtonConfigStorageLeftDeprecated]] ([10.0.0-10.2.0] [[#SetButtonConfigStorageLeftDeprecated|SetButtonConfigStorageLeft]])
|-
|-
| 1266 || [10.0.0+] [[#SetButtonConfigStorageRight]]
| 1266 || [11.0.0-12.1.0] [[#SetButtonConfigStorageRightDeprecated]] ([10.0.0-10.2.0] [[#SetButtonConfigStorageRightDeprecated|SetButtonConfigStorageRight]])
|-
|-
| 1267 || [10.0.0+] [[#DeleteButtonConfigStorageEmbedded]]
| 1267 || [10.0.0+] [[#DeleteButtonConfigStorageEmbedded]]
Line 1,652: Line 2,021:
|-
|-
| 1283 || [10.0.0+] [[#GetHidButtonConfigRight]]
| 1283 || [10.0.0+] [[#GetHidButtonConfigRight]]
|}
|-
 
| 1284 || [11.0.0+] [[#GetButtonConfigStorageEmbedded]]
|-
| 1285 || [11.0.0+] [[#GetButtonConfigStorageFull]]
|-
| 1286 || [11.0.0+] [[#GetButtonConfigStorageLeft]]
|-
| 1287 || [11.0.0+] [[#GetButtonConfigStorageRight]]
|-
| 1288 || [11.0.0+] [[#SetButtonConfigStorageEmbedded]]
|-
| 1289 || [11.0.0+] [[#SetButtonConfigStorageFull]]
|-
| 1290 || [11.0.0+] [[#SetButtonConfigStorageLeft]]
|-
| 1291 || [11.0.0+] [[#SetButtonConfigStorageRight]]
|-
| 1308 || [18.0.0+] SetButtonConfigVisible
|-
| 1309 || [18.0.0+] IsButtonConfigVisible
|-
| 1320 || [17.0.0+] WakeTouchScreenUp
|-
| 1321 || [17.0.0+] PutTouchScreenToSleep
|-
| 1322 || [20.0.0+] AcquireTouchScreenAsyncWakeCompletedEvent
|-
| 1420 || [19.0.0+] GetAppletResourceProperty
|-
| 12010 || [11.0.0-17.0.1] [[#SetButtonConfigLeft]]
|}
 
== SendKeyboardLockKeyEvent ==
== SendKeyboardLockKeyEvent ==
Takes an u32 BitFlagSet [[#KeyboardLockKeyEvent]], no output.
Takes an u32 BitFlagSet [[#KeyboardLockKeyEvent]], no output.
Line 1,722: Line 2,121:
The specified controller must have a HOME button.
The specified controller must have a HOME button.


This sends subcommand 0x38 to the specified controller, for setting the pattern for the HOME button notification LED. The input structure is converted to the format used by this [https://github.com/dekuNukem/Nintendo_Switch_Reverse_Engineering/blob/master/bluetooth_hid_subcommands_notes.md#subcommand-0x38-set-home-light subcommand].
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
|-
| 0x0 || 0x1 || <nowiki>((TimeUnit & 0xF) | ((FrameCount & 0xF) << 4))</nowiki>
|-
| 0x1 || 0x1 || <nowiki>((CycleCount & 0xF) | ((InitialBrightness & 0xF) << 4))</nowiki>
|-
| 0x2 || 0x1 || <nowiki>((Frame2Brightness & 0xF) | ((Frame1Brightness & 0xF) << 4))</nowiki>
|-
| 0x3 || 0x1 || <nowiki>((Frame1TimeToHold & 0xF) | ((Frame1TimeTowards & 0xF) << 4))</nowiki>
|-
| 0x4 || 0x1 || <nowiki>((Frame2TimeToHold & 0xF) | ((Frame2TimeTowards & 0xF) << 4))</nowiki>
|-
| 0x5 || 0x1 || <nowiki>((Frame4Brightness & 0xF) | ((Frame3Brightness & 0xF) << 4))</nowiki>
|-
| 0x6 || 0x1 || <nowiki>((Frame3TimeToHold & 0xF) | ((Frame3TimeTowards & 0xF) << 4))</nowiki>
|-
| 0x7 || 0x1 || <nowiki>((Frame4TimeToHold & 0xF) | ((Frame4TimeTowards & 0xF) << 4))</nowiki>
|-
| 0x8 || 0x1 || <nowiki>((Frame6Brightness & 0xF) | ((Frame5Brightness & 0xF) << 4))</nowiki>
|-
| 0x9 || 0x1 || <nowiki>((Frame5TimeToHold & 0xF) | ((Frame5TimeTowards & 0xF) << 4))</nowiki>
|-
| 0xA || 0x1 || <nowiki>((Frame6TimeToHold & 0xF) | ((Frame6TimeTowards & 0xF) << 4))</nowiki>
|-
| 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>
|}


[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}).
[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}).
Line 1,742: Line 2,205:
== GetHidbusSystemServiceObject ==
== GetHidbusSystemServiceObject ==
No input, returns an [[#IHidbusSystemServer]].
No input, returns an [[#IHidbusSystemServer]].
== GetTouchScreenFirmwareVersion ==
No input. Returns a [[#FirmwareVersion]].
This requests the current firmware version from the touch screen IC.
It first ensures the touch screen IC's chip id is one of the following:
0x7036 - Ftm4cd60d (STMicroelectronics FingerTipS FT9CJ/FT9CF)
0x4036 - Fst2ba61ya1
Then constructs the final firmware version as follows:
uint32_t FtsVersion = GetFtsReleasedVer();    // Matches the xxxx value found in the FTS_xxxx.fts256 and FTS_xxxx.ftb firmware files.
uint8_t FtsVersionByte0 = (FtsVersion & 0xFF);
uint8_t FtsVersionByte1 = (FtsVersion & 0xFF00);
uint8_t FtsVersionByte2 = (FtsVersion & 0xFF0000);
uint8_t FtsVersionByte3 = (FtsVersion & 0xFF000000);
uint8_t FirmwareVersionByte0 = FtsVersionByte3;
uint8_t FirmwareVersionByte1 = FtsVersionByte2;
uint8_t FirmwareVersionByte2 = FtsVersionByte1;
uint8_t FirmwareVersionByte3 = FtsVersionByte0;
if (FtsVersionByte3 <= 0x31) {
    FirmwareVersionByte3 = 0;
    FirmwareVersionByte1 = 0;
    FirmwareVersionByte0 = 0x31;
    if (FtsVersionByte2 == 0x5) {
        FirmwareVersionByte2 = 2;
    } else if (FtsVersionByte2 == 0x12) {
        FirmwareVersionByte2 = 0;
    } else if (FtsVersionByte2 == 0x1A) {
        FirmwareVersionByte2 = 1;
    } else {
        // Throw error.
    }
}
uint8_t FirmwareVersion[0x10] = {0};
*(uint32_t *)FirmwareVersion = (FirmwareVersionByte3 << 24) | (FirmwareVersionByte2 << 16) | (FirmwareVersionByte1 << 8) | FirmwareVersionByte0;
*((uint32_t *)FirmwareVersion + 1) = 0x5354;  // "TS"
return FirmwareVersion;


== IsFirmwareAvailableForNotification ==
== IsFirmwareAvailableForNotification ==
Line 1,753: Line 2,260:
== IsButtonConfigSupported ==
== IsButtonConfigSupported ==
Takes an input [[#UniquePadId]], returns an output bool.
Takes an input [[#UniquePadId]], returns an output bool.
[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], returns an output bool.
== IsButtonConfigEmbeddedSupported ==
No input, returns an output bool.


== DeleteButtonConfig ==
== DeleteButtonConfig ==
Takes an input [[#UniquePadId]], no output.
Takes an input [[#UniquePadId]], no output.


== SetButtonConfigEnabled ==
[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], no output.
Takes an input bool, an [[#UniquePadId]], no output.
 
== DeleteButtonConfigEmbedded ==
No input/output.
 
== SetButtonConfigEnabled ==
Takes an input bool, an [[#UniquePadId]], no output.
 
[11.0.0+] Takes an input bool, an [[Bluetooth_Driver_services#Address|Address]], no output.
 
== SetButtonConfigEmbeddedEnabled ==
Takes an input bool, no output.


== IsButtonConfigEnabled ==
== IsButtonConfigEnabled ==
Takes an input [[#UniquePadId]], returns an output bool.
Takes an input [[#UniquePadId]], returns an output bool.
[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], returns an output bool.
== IsButtonConfigEmbeddedEnabled ==
No input, returns an output bool.


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


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


== SetButtonConfigLeft ==
== SetButtonConfigLeft ==
Takes an input [[#UniquePadId]], a type-0x15 input buffer containing a [[#SystemButtonConfigLeft]], no output.
Takes an input [[#UniquePadId]], a type-0x15 input buffer containing a [[#SystemButtonConfigLeft]], no output.
[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], a type-0x15 input buffer containing a [[#SystemButtonConfigLeft]], no output.


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


== GetButtonConfigEmbedded ==
== GetButtonConfigEmbedded ==
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#SystemButtonConfigEmbedded]].
Takes ([10.0.0-10.2.0] an input [[#UniquePadId]]), and a type-0x16 output buffer containing a [[#SystemButtonConfigEmbedded]].


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


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


== GetButtonConfigRight ==
== GetButtonConfigRight ==
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#SystemButtonConfigRight]].
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#SystemButtonConfigRight]].
[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], and a type-0x16 output buffer containing a [[#SystemButtonConfigRight]].


== IsCustomButtonConfigSupported ==
== IsCustomButtonConfigSupported ==
Line 1,813: Line 2,352:
Takes an input s32 entry-index, returns an output bool.
Takes an input s32 entry-index, returns an output bool.


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


Uses [[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.
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.
Line 1,832: Line 2,371:
Same as [[#IsButtonConfigStorageEmbeddedEmpty]] except with a different setsys cmd.
Same as [[#IsButtonConfigStorageEmbeddedEmpty]] except with a different setsys cmd.


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


[10.1.0+] This will now Abort if the s32 is negative or >=5.
[10.1.0-10.2.0] This will now Abort if the s32 is negative or >=5.
 
[11.0.0+] This now calls the same func internally as [[#GetButtonConfigStorageEmbedded]], except the [[#StorageName]] isn't exposed.


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


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


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


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


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


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


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


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


[10.1.0+] This will now Abort if the s32 is negative or >=5.
[10.1.0-10.2.0] This will now Abort if the s32 is negative or >=5.
 
[11.0.0+] This now calls the same func internally as [[#SetButtonConfigStorageEmbedded]], except the [[#StorageName]] isn't exposed.


If the input config matches the [[#IsDefaultButtonConfigEmbedded|default]], this first does:  
If the input config matches the [[#IsDefaultButtonConfigEmbedded|default]], this first does:  
Line 1,864: Line 2,407:
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.
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.


== SetButtonConfigStorageFull ==
== SetButtonConfigStorageFullDeprecated ==
Takes an input s32 entry-index, and a type-0x15 input buffer containing a [[#ButtonConfigFull]].
Takes an input s32 entry-index, and a type-0x15 input buffer containing a [[#ButtonConfigFull]].


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


== SetButtonConfigStorageLeft ==
== SetButtonConfigStorageLeftDeprecated ==
Takes an input s32 entry-index, and a type-0x15 input buffer containing a [[#ButtonConfigLeft]].
Takes an input s32 entry-index, and a type-0x15 input buffer containing a [[#ButtonConfigLeft]].


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


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


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


== DeleteButtonConfigStorageEmbedded ==
== DeleteButtonConfigStorageEmbedded ==
Takes an input s32 entry-index, no output.
Takes an input s32 entry-index, no output.


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


Uses [[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.
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.
Line 1,889: Line 2,432:
Takes an input s32 entry-index, no output.
Takes an input s32 entry-index, no output.


Same as [[#IsButtonConfigStorageEmbeddedEmpty]] except with different setsys cmds.
Same as [[#DeleteButtonConfigStorageEmbedded]] except with different setsys cmds.


== DeleteButtonConfigStorageLeft ==
== DeleteButtonConfigStorageLeft ==
Takes an input s32 entry-index, no output.
Takes an input s32 entry-index, no output.


Same as [[#IsButtonConfigStorageEmbeddedEmpty]] except with different setsys cmds.
Same as [[#DeleteButtonConfigStorageEmbedded]] except with different setsys cmds.


== DeleteButtonConfigStorageRight ==
== DeleteButtonConfigStorageRight ==
Takes an input s32 entry-index, no output.
Takes an input s32 entry-index, no output.


Same as [[#IsButtonConfigStorageEmbeddedEmpty]] except with different setsys cmds.
Same as [[#DeleteButtonConfigStorageEmbedded]] except with different setsys cmds.


== IsUsingCustomButtonConfig ==
== IsUsingCustomButtonConfig ==
Line 1,939: Line 2,482:
== GetHidButtonConfigRight ==
== GetHidButtonConfigRight ==
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#ButtonConfigRight]].
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#ButtonConfigRight]].
== GetButtonConfigStorageEmbedded ==
Takes an input s32, a type-0x16 output buffer containing a [[#ButtonConfigEmbedded]], a type-0x1A output buffer containing a [[#StorageName]].
When the input s32 is larger than unsigned value 4, an error is returned.
== GetButtonConfigStorageFull ==
Takes an input s32, a type-0x16 output buffer containing a [[#ButtonConfigFull]], a type-0x1A output buffer containing a [[#StorageName]].
== GetButtonConfigStorageLeft ==
Takes an input s32, a type-0x16 output buffer containing a [[#ButtonConfigLeft]], a type-0x1A output buffer containing a [[#StorageName]].
== GetButtonConfigStorageRight ==
Takes an input s32, a type-0x16 output buffer containing a [[#ButtonConfigRight]], a type-0x1A output buffer containing a [[#StorageName]].
== SetButtonConfigStorageEmbedded ==
Takes an input s32, a type-0x15 input buffer containing a [[#ButtonConfigEmbedded]], a type-0x19 input buffer containing a [[#StorageName]].
When the input s32 is larger than unsigned value 4, this will immediately return (this cmd always returns 0 regardless).
== SetButtonConfigStorageFull ==
Takes an input s32, a type-0x15 input buffer containing a [[#ButtonConfigFull]], a type-0x19 input buffer containing a [[#StorageName]].
== SetButtonConfigStorageLeft ==
Takes an input s32, a type-0x15 input buffer containing a [[#ButtonConfigLeft]], a type-0x19 input buffer containing a [[#StorageName]].
== SetButtonConfigStorageRight ==
Takes an input s32, a type-0x15 input buffer containing a [[#ButtonConfigRight]], a type-0x19 input buffer containing a [[#StorageName]].


== IHidbusSystemServer ==
== IHidbusSystemServer ==
Line 2,584: 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 2,589: Line 3,162:
! Cmd || Name
! Cmd || Name
|-
|-
| 0 || GetDataFormat
| 0 || [[#GetDataFormat]]
|-
|-
| 1 || SetDataFormat
| 1 || [[#SetDataFormat]]
|-
|-
| 2 || GetMcuState
| 2 || [[#GetMcuState]]
|-
|-
| 3 || SetMcuState
| 3 || [[#SetMcuState]]
|-
|-
| 4 || GetMcuVersionForNfc
| 4 || [[#GetMcuVersionForNfc]]
|-
|-
| 5 || CheckNfcDevicePower
| 5 || [[#CheckNfcDevicePower]]
|-
|-
| 6 || [5.0.0+] SetMcuStateImmediate
| 6 || [5.0.0+] [[#SetMcuStateImmediate]]
|-
|-
| 10 || SetNfcEvent
| 10 || [[#SetNfcEvent]]
|-
|-
| 11 || GetNfcInfo
| 11 || [[#GetNfcInfo]]
|-
|-
| 12 || StartNfcDiscovery
| 12 || StartNfcDiscovery
Line 2,636: Line 3,209:
[5.0.0+] SetDataFormat, SetMcuState, and ClearMifareKey: now takes a total of 0xC-bytes of input instead of 0x10.
[5.0.0+] SetDataFormat, SetMcuState, and ClearMifareKey: now takes a total of 0xC-bytes of input instead of 0x10.


[6.0.0+]: The buffer type used by GetNfcInfo is now 0x32 instead of 0x1A.
== GetDataFormat ==
Takes an input 8-byte handle, returns an output u8.
 
== SetDataFormat ==
Takes an input u8 and a 8-byte handle (4-byte alignment), no output.
 
== GetMcuState ==
Takes an input 8-byte handle, returns an output u8.
 
== SetMcuState ==
Takes an input u8 and a 8-byte handle (4-byte alignment), no output.
 
== GetMcuVersionForNfc ==
Takes an input 8-byte handle, returns an output 0x20-byte struct.
 
== CheckNfcDevicePower ==
Takes an input 8-byte handle, no output.
 
== SetMcuStateImmediate ==
Takes an input u8 and a 8-byte handle (4-byte alignment), no output.
 
== SetNfcEvent ==
Takes an input 8-byte handle, returns 2 output Event handles.
 
== GetNfcInfo ==
Takes an input 8-byte handle and a type-0x1A output buffer.
 
[6.0.0+]: The buffer type is now 0x32 instead of 0x1A.
 
This buffer contains a 0x804-byte struct, for the NFC data sent in response to the various other cmds.


= hidbus =
= hidbus =
Line 2,681: Line 3,283:


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


The bool indicates whether the [[#BusHandle]] is valid.
'''HasHandle''' indicates whether the [[#BusHandle]] is valid.


Official sw will assert when [[#BusHandle]] InternalIndex is >=0x11 (>=0x13 with [6.0.0+]). This same check is also done for all funcs using [[#BusHandle]] as input.
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.
Line 2,690: Line 3,292:


== IsExternalDeviceConnected ==
== IsExternalDeviceConnected ==
Takes an input [[#BusHandle]], returns an output u8 bool.
Takes an input [[#BusHandle]]. Returns an output bool '''IsAttached'''.


This is not used by sdknso.
This is not used by sdknso.


== Initialize ==
== Initialize ==
Takes an input [[#BusHandle]], an u64 [[AM_services|AppletResourceUserId]], no output.
Takes an input [[#BusHandle]] and an u64 [[AM_services|AppletResourceUserId]]. No output.


Prior to using this cmd, sdknso handles [[#GetSharedMemoryHandle|sharedmem]] mapping if not done previously.
Prior to using this cmd, sdknso handles [[#GetSharedMemoryHandle|sharedmem]] mapping if not done previously.


== Finalize ==
== Finalize ==
Takes an input [[#BusHandle]], an u64 [[AM_services|AppletResourceUserId]], no output.
Takes an input [[#BusHandle]] and an u64 [[AM_services|AppletResourceUserId]]. No output.


== EnableExternalDevice ==
== EnableExternalDevice ==
Takes an input u8 bool, a [[#BusHandle]], an u64, an u64 [[AM_services|AppletResourceUserId]], no output.
Takes an input bool '''IsEnabled''', a [[#BusHandle]], an u64 '''Version''' and an u64 [[AM_services|AppletResourceUserId]]. No output.


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


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


== GetExternalDeviceId ==
== GetExternalDeviceId ==
Takes an input [[#BusHandle]], returns an output u32 ExternalDeviceId.
Takes an input [[#BusHandle]]. Returns an output u32 '''DeviceId'''.


== SendCommandAsync ==
== SendCommandAsync ==
Takes a type-0x21 input buffer and a [[#BusHandle]], no output.
Takes a type-0x21 input buffer and a [[#BusHandle]]. No output.


== GetSendCommandAsynceResult ==
== GetSendCommandAsynceResult ==
Takes a type-0x22 output buffer and a [[#BusHandle]], returns an output u32.
Takes a type-0x22 output buffer and a [[#BusHandle]]. Returns an output u32 '''OutSize'''.


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


== SetEventForSendCommandAsycResult ==
== SetEventForSendCommandAsycResult ==
Takes an input [[#BusHandle]], returns an output Event handle with EventClearMode=0.
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]].
Official sw with SendAndReceive clears this event (6.x+ sdknso), uses [[#SendCommandAsync]], waits on + clears this event, then uses [[#GetSendCommandAsynceResult]].


== GetSharedMemoryHandle ==
== GetSharedMemoryHandle ==
No input, returns an output SharedMemory handle.
No input. Returns an output SharedMemory handle.


The SharedMemory is mapped with size 0x1000 and permissions=R--.
The SharedMemory is mapped with size 0x1000 and permissions=R--.
Line 2,758: Line 3,360:


== EnableJoyPollingReceiveMode ==
== EnableJoyPollingReceiveMode ==
Takes a type-0x21 input buffer, a TransferMemory handle, an u32 tmem_size, an u32 [[#JoyPollingMode]], a [[#BusHandle]], no 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--.
The TransferMemory is created with an user-specified output buffer, with permissions=R--.
Line 2,827: Line 3,429:


== DisableJoyPollingReceiveMode ==
== DisableJoyPollingReceiveMode ==
Takes an input [[#BusHandle]], no output.
Takes an input [[#BusHandle]]. No output.


== SetStatusManagerType ==
== SetStatusManagerType ==
Takes an input u32, no output.
Takes an input u32 [[#StatusManagerType]]. No output.


This is used by sdknso immediately after mapping [[#GetSharedMemoryHandle|sharedmem]] (before [[#Initialize]]) with hard-coded value 0x2.
This is used by sdknso immediately after mapping [[#GetSharedMemoryHandle|sharedmem]] (before [[#Initialize]]) with hard-coded value 0x2.
Line 2,896: Line 3,498:
| 0x1C
| 0x1C
| [5.0.0+] [[#ConsoleSixAxisSensorSharedMemoryFormat|ConsoleSixAxisSensor]]
| [5.0.0+] [[#ConsoleSixAxisSensorSharedMemoryFormat|ConsoleSixAxisSensor]]
|-
| 0x3DC00
| 0x400
| [16.0.0+] [[#MouseSharedMemoryFormat|DebugMouse]]
|}
|}


Line 3,440: 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 3,920: Line 4,528:
|-
|-
| 0x160
| 0x160
| 0x40
| 0x60
| [[#SixAxisSensorUserCalibrationStateLifo]]
| [[#SixAxisSensorUserCalibrationStateLifo]]
|-
|-
| 0x1A0
| 0x1C0
| 0x40
| 0x20
| UniquePadConfigMutex
| UniquePadConfigMutex
|}
|}
Line 4,202: Line 4,810:
|-
|-
| 0x0
| 0x0
| 0x43F0 ([1.0.0-8.1.0] 0x4410)
| 0x43F8 ([9.0.0-12.1.0] 0x43F0, [1.0.0-8.1.0] 0x4410)
| [[#NpadInternalState]]
| [[#NpadInternalState]]
|}
|}
Line 4,328: Line 4,936:
|-
|-
| 0x4208
| 0x4208
| 0x40
| 0x20
| [1.0.0-8.1.0] Mutex
| [1.0.0-8.1.0] Mutex
|-
|-
Line 4,349: Line 4,957:
| 0x43EC ([1.0.0-8.1.0] 0x440C)
| 0x43EC ([1.0.0-8.1.0] 0x440C)
| 0x4
| 0x4
|  
| [[#NpadLagerType|LagerType]]
|-
| 0x43F0
| 0x1 * 6
| [13.0.0+] Array of [[#SixAxisSensorProperties]]
|}
|}


Line 5,924: Line 6,536:
This is "nn::hid::KeyboardKeySet". This is a BitFlagSet object for [[#KeyboardKey]].
This is "nn::hid::KeyboardKeySet". This is a BitFlagSet object for [[#KeyboardKey]].


= KeyboardLockKeyEventSet =
= KeyboardKey =
This is "nn::hid::system::KeyboardLockKeyEventSet". This is a BitFlagSet object for [[#KeyboardLockKeyEvent]].
This is "nn::hid::KeyboardKey". This is a 256-bit flag.
 
= KeyboardLockKeyEvent =
This is "nn::hid::system::KeyboardLockKeyEvent". This is a 32-bit flag.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 5,934: Line 6,543:
! Bit
! Bit
! Description
! Description
|-
| 0
| NumLockOn
|-
| 1
| NumLockOff
|-
| 2
| NumLockToggle
|-
| 3
| CapsLockOn
|-
|-
| 4
| 4
| CapsLockOff
| A
|-
|-
| 5
| 5
| CapsLockToggle
| B
|-
|-
| 6
| 6
| ScrollLockOn
| C
|-
|-
| 7
| 7
| ScrollLockOff
| D
|-
|-
| 8
| 8
| ScrollLockToggle
| E
|}
 
= 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
| 9
! Description
| F
|-
|-
| 0
| 10
| A
| G
|-
| 1
| B
|-
| 2
| X
|-
| 3
| Y
|-
| 4
| StickL
|-
| 5
| StickR
|-
| 6
| L
|-
| 7
| R
|-
| 8
| ZL
|-
| 9
| ZR
|-
| 10
| Plus
|-
|-
| 11
| 11
| Minus
| H
|-
|-
| 12
| 12
| Left
| I
|-
|-
| 13
| 13
| Up
| J
|-
|-
| 14
| 14
| Right
| K
|-
|-
| 15
| 15
| Down
| L
|-
|-
| 16
| 16
| StickLLeft
| M
|-
|-
| 17
| 17
| StickLUp
| N
|-
|-
| 18
| 18
| StickLRight
| O
|-
|-
| 19
| 19
| StickLDown
| P
|-
|-
| 20
| 20
| StickRLeft
| Q
|-
|-
| 21
| 21
| StickRUp
| R
|-
|-
| 22
| 22
| StickRRight
| S
|-
|-
| 23
| 23
| StickRDown
| T
|-
|-
| 24
| 24
| LeftSL
| U
|-
|-
| 25
| 25
| LeftSR
| V
|-
|-
| 26
| 26
| RightSL
| W
|-
|-
| 27
| 27
| RightSR
| X
|-
|-
| 28
| 28
| Palma
| Y
|-
|-
| 29
| 29
|  
| Z
|-
|-
| 30
| 30
| HandheldLeftB (Left B button on NES controllers in Handheld mode)
| D1
|}
|-
 
| 31
= AnalogStickCalibrationFlagsSet =
| D2
This is "nn::hid::detail::AnalogStickCalibrationFlagsSet". This is a BitFlagSet object for [[#AnalogStickCalibrationFlags]].
|-
 
| 32
= SixAxisSensorUserCalibrationFlagsSet =
| D3
This is "nn::hid::detail::SixAxisSensorUserCalibrationFlagsSet". This is a BitFlagSet object for [[#SixAxisSensorUserCalibrationFlags]].
|-
 
| 33
= NpadStyleSet =
| D4
This is "nn::hid::NpadStyleSet". This is a BitFlagSet object for [[#NpadStyleTag]].
 
= NpadStyleTag =
This is "nn::hid::NpadStyleTag".
 
{| class="wikitable" border="1"
!  Bits
!  Description
!  Notes
|-
|-
| 0
| 34
| NpadStyleFullKey
| D5
| Pro Controller
|-
|-
| 1
| 35
| NpadStyleHandheld
| D6
| Joy-Con controller in handheld mode
|-
|-
| 2
| 36
| NpadStyleJoyDual
| D7
| Joy-Con controller in dual mode
|-
|-
| 3
| 37
| NpadStyleJoyLeft
| D8
| Joy-Con left controller in single mode
|-
|-
| 4
| 38
| NpadStyleJoyRight
| D9
| Joy-Con right controller in single mode
|-
|-
| 5
| 39
| NpadStyleGc
| D0
| GameCube controller
|-
|-
| 6
| 40
| NpadStylePalma
| Return
| Poké Ball Plus controller
|-
|-
| 7
| 41
| NpadStyleLark
| Escape
| NES/Famicom controller
|-
|-
| 8
| 42
| NpadStyleHandheldLark
| Backspace
| NES/Famicom controller in handheld mode
|-
|-
| 9
| 43
| NpadStyleLucia
| Tab
| SNES controller
|-
|-
| 10-28
| 44
| Reserved
| Space
|
|-
|-
| 29
| 45
| NpadStyleSystemExt
| Minus
| Generic external controller
|-
|-
| 30
| 46
| NpadStyleSystem
| Plus
| Generic controller
|-
|-
| 31
| 47
| Reserved
| OpenBracket
|
|}
 
= NpadDeviceTypeSet =
This is "nn::hid::system::NpadDeviceType". This is a BitFlagSet object for [[#NpadDeviceType]].
 
= NpadSystemPropertiesSet =
This is "nn::hid::detail::NpadSystemPropertiesSet". This is a BitFlagSet object for [[#NpadSystemProperties]].
 
= NpadSystemProperties =
This is "nn::hid::NpadSystemProperties". This is a 64-bit flag.
 
{| class="wikitable" border="1"
|-
|-
! Bit
| 48
! Description
| CloseBracket
|-
|-
| 0
| 49
| IsChargingJoyDual
| Pipe
|-
|-
| 1
| 50
| IsChargingJoyLeft
| Tilde
|-
|-
| 2
| 51
| IsChargingJoyRight
| Semicolon
|-
|-
| 3
| 52
| IsPoweredJoyDual
| Quote
|-
|-
| 4
| 53
| IsPoweredJoyLeft
| Backquote
|-
|-
| 5
| 54
| IsPoweredJoyRight
| Comma
|-
| 55
| Period
|-
|-
| 9
| 56
| IsUnsuportedButtonPressedOnNpadSystem
| Slash
|-
|-
| 10
| 57
| IsUnsuportedButtonPressedOnNpadSystemExt
| CapsLock
|-
|-
| 11
| 58
| IsAbxyButtonOriented
| F1
|-
|-
| 12
| 59
| IsSlSrButtonOriented
| F2
|-
|-
| 13
| 60
| [4.0.0+] IsPlusAvailable
| F3
|-
|-
| 14
| 61
| [4.0.0+] IsMinusAvailable
| F4
|-
|-
| 15
| 62
| [8.0.0+] IsDirectionalButtonsAvailable
| F5
|}
 
= 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"
|-
|-
! Bit
| 63
! Description
| F6
|-
|-
| 0
| 64
| IsUnintendedHomeButtonInputProtectionEnabled
| F7
|}
 
= 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
| 65
| F8
|-
|-
| 1 || FullKeyController
| 66
| F9
|-
|-
| 2 || RightController
| 67
| F10
|-
|-
| 3 || LeftController
| 68
| F11
|-
|-
| 4 || DebugPadController
| 69
|}
| F12
 
= UniquePadInterface =
This is "nn::hid::system::UniquePadInterface".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Embedded
| 70
| PrintScreen
|-
|-
| 1 || Rail
| 71
| ScrollLock
|-
|-
| 2 || Bluetooth
| 72
| Pause
|-
|-
| 3 || Usb
| 73
|}
| Insert
 
|-
= UniquePadSerialNumber =
| 74
This is "nn::hid::system::UniquePadSerialNumber". This is a 0x10 byte value.
| Home
 
|-
= UniquePadId =
| 75
This is "nn::hid::system::UniquePadId". This is a 8 byte value.
| PageUp
 
= AnalogStickManualCalibrationStage =
This is "nn::hid::system::AnalogStickManualCalibrationStage".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || ReleaseFromRight
| 76
| Delete
|-
|-
| 1 || ReleaseFromBottom
| 77
| End
|-
|-
| 2 || ReleaseFromLeft
| 78
| PageDown
|-
|-
| 3 || ReleaseFromTop
| 79
| RightArrow
|-
|-
| 4 || Rotate
| 80
| LeftArrow
|-
|-
| 5 || Update
| 81
| DownArrow
|-
|-
| 6 || Completed
| 82
| UpArrow
|-
|-
| 7 || Clear
| 83
| NumLock
|-
|-
| 8 || ClearCompleted
| 84
|}
| NumPadDivide
 
= SixAxisSensorUserCalibrationStage =
This is "nn::hid::system::SixAxisSensorUserCalibrationStage".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Measuring
| 85
| NumPadMultiply
|-
|-
| 1 || Update
| 86
| NumPadSubtract
|-
|-
| 2 || Completed
| 87
|}
| NumPadAdd
 
= NpadJoyHoldType =
This is "nn::hid::NpadJoyHoldType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Vertical
| 88
| NumPadEnter
|-
|-
| 1 || Horizontal
| 89
|}
| NumPad1
 
= NpadJoyDeviceType =
This is "nn::hid::NpadJoyDeviceType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Left
| 90
| NumPad2
|-
|-
| 1 || Right
| 91
|}
| NumPad3
 
= 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
| 92
| NumPad4
|-
|-
| 1 || Single
| 93
| NumPad5
|-
|-
| 2 || None
| 94
|}
| NumPad6
 
= NpadJoyAssignmentMode =
This is "nn::hid::NpadJoyAssignmentMode".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Dual
| 95
| NumPad7
|-
|-
| 1 || Single
| 96
|}
| NumPad8
 
= NpadCommunicationMode =
This is "nn::hid::NpadCommunicationMode".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || 5ms
| 97
| NumPad9
|-
|-
| 1 || 10ms
| 98
| NumPad0
|-
|-
| 2 || 15ms
| 99
| NumPadDot
|-
|-
| 3 || Default
| 100
|}
| Backslash
 
= AppletDetailedUiType =
This is "nn::hid::system::AppletDetailedUiType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0x00000000 || None
| 101
| Application
|-
|-
| 0x01000000 || HandheldNone
| 102
| Power
|-
|-
| 0x02000000 || HandheldJoyConLeftOnly
| 103
| NumPadEquals
|-
|-
| 0x02000001 || HandheldLarkHvc1Only
| 104
| F13
|-
|-
| 0x02000002 || HandheldLarkNesLeftOnly
| 105
| F14
|-
|-
| 0x03000000 || HandheldJoyConRightOnly
| 106
| F15
|-
|-
| 0x03000001 || HandheldLarkHvc2Only
| 107
| F16
|-
|-
| 0x03000002 || HandheldLarkNesRightOnly
| 108
| F17
|-
|-
| 0x04000000 || HandheldJoyConLeftJoyConRight
| 109
| F18
|-
|-
| 0x04000001 || HandheldJoyConLeftLarkHvc2
| 110
| F19
|-
|-
| 0x04000002 || HandheldJoyConLeftLarkNesRight
| 111
| F20
|-
|-
| 0x04000003 || HandheldLarkHvc1JoyConRight
| 112
| F21
|-
|-
| 0x04000004 || HandheldLarkHvc1LarkHvc2
| 113
| F22
|-
|-
| 0x04000005 || HandheldLarkHvc1LarkNesRight
| 114
| F23
|-
|-
| 0x04000006 || HandheldLarkNesLeftJoyConRight
| 115
| F24
|-
|-
| 0x04000007 || HandheldLarkNesLeftLarkHvc2
| 133
| NumPadComma
|-
|-
| 0x04000008 || HandheldLarkNesLeftLarkNesRight
| 135
| Ro
|-
|-
| 0x05000000 || JoyDual
| 136
| KatakanaHiragana
|-
|-
| 0x06000000 || JoyDualLeftOnly
| 137
| Yen
|-
|-
| 0x07000000 || JoyDualRightOnly
| 138
| Henkan
|-
|-
| 0x08000000 || JoyLeftHorizontal
| 139
| Muhenkan
|-
|-
| 0x09000000 || JoyLeftVertical
| 140
| NumPadCommaPc98
|-
|-
| 0x0A000000 || JoyRightHorizontal
| 144
| HangulEnglish
|-
|-
| 0x0B000000 || JoyRightVertical
| 145
| Hanja
|-
|-
| 0x0C000000 || SwitchProController
| 146
| Katakana
|-
|-
| 0x0D000000 || CompatibleProController
| 147
| Hiragana
|-
|-
| 0x0E000000 || CompatibleJoyCon
| 148
|-
| ZenkakuHankaku
| 0x0F000000 || LarkHvc1
|-
|-
| 0x10000000 || LarkHvc2
| 224
| LeftControl
|-
|-
| 0x11000000 || LarkNesLeft
| 225
| LeftShift
|-
|-
| 0x12000000 || LarkNesRight
| 226
| LeftAlt
|-
|-
| 0x13000000 || LuciaU
| 227
| LeftGui
|-
|-
| 0x13000001 || LuciaJ
| 228
| RightControl
|-
|-
| 0x13000002 || LuciaE
| 229
| RightShift
|-
|-
| 0x14000000 || Verification
| 230
| RightAlt
|-
|-
| 0xFFFFFFFF || Unknown
| 231
| RightGui
|}
|}


= AppletFooterUiType =
= KeyboardLockKeyEventSet =
This is "nn::hid::system::AppletFooterUiType".
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"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || None
! Bit
! Description
|-
|-
| 1 || HandheldNone
| 0
| NumLockOn
|-
|-
| 2 || HandheldJoyConLeftOnly
| 1
| NumLockOff
|-
|-
| 3 || HandheldJoyConRightOnly
| 2
| NumLockToggle
|-
|-
| 4 || HandheldJoyConLeftJoyConRight
| 3
| CapsLockOn
|-
|-
| 5 || JoyDual
| 4
| CapsLockOff
|-
|-
| 6 || JoyDualLeftOnly
| 5
| CapsLockToggle
|-
|-
| 7 || JoyDualRightOnly
| 6
| ScrollLockOn
|-
|-
| 8 || JoyLeftHorizontal
| 7
| ScrollLockOff
|-
|-
| 9 || JoyLeftVertical
| 8
| ScrollLockToggle
|}
 
= BasicXpadButtonSet =
This is "nn::hid::BasicXpadButtonSet". This is a BitFlagSet object for [[#BasicXpadButton]].
 
= HomeButtonSet =
This is "nn::hid::system::HomeButtonSet". This is a BitFlagSet object for [[#HomeButton]].
 
= SleepButtonSet =
This is "nn::hid::system::SleepButtonSet". This is a BitFlagSet object for [[#SleepButton]].
 
= CaptureButtonSet =
This is "nn::hid::system::CaptureButtonSet". This is a BitFlagSet object for [[#CaptureButton]].
 
= NpadButtonSet =
This is "nn::hid::NpadButtonSet". This is a BitFlagSet object for [[#NpadButton]].
 
= NpadButton =
This is "nn::hid::NpadButton". This is a 64-bit flag.
 
{| class="wikitable" border="1"
|-
|-
| 10 || JoyRightHorizontal
! Bit
! Description
|-
|-
| 11 || JoyRightVertical
| 0
| A
|-
|-
| 12 || SwitchProController
| 1
| B
|-
|-
| 13 || CompatibleProController
| 2
| X
|-
|-
| 14 || CompatibleJoyCon
| 3
| Y
|-
|-
| 15 || LarkHvc1
| 4
| StickL
|-
|-
| 16 || LarkHvc2
| 5
| StickR
|-
|-
| 17 || LarkNesLeft
| 6
| L
|-
|-
| 18 || LarkNesRight
| 7
| R
|-
|-
| 19 || Lucia
| 8
| ZL
|-
|-
| 20 || Verification
| 9
|}
| ZR
 
|-
= NpadIdType =
| 10
This is "nn::hid::NpadIdType". This is the controller index used in [[#SharedMemoryFormat|sharedmem]].
| Plus
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0x0 || No1
| 11
| Minus
|-
|-
| 0x1 || No2
| 12
| Left
|-
|-
| 0x2 || No3
| 13
| Up
|-
|-
| 0x3 || No4
| 14
| Right
|-
|-
| 0x4 || No5
| 15
| Down
|-
|-
| 0x5 || No6
| 16
| StickLLeft
|-
|-
| 0x6 || No7
| 17
| StickLUp
|-
|-
| 0x7 || No8
| 18
| StickLRight
|-
|-
| 0x10 || Other
| 19
| StickLDown
|-
|-
| 0x20 || Handheld
| 20
|}
| StickRLeft
 
= NpadInterfaceType =
This is "nn::hid::NpadInterfaceType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 1 || Bluetooth
| 21
| StickRUp
|-
|-
| 2 || Rail
| 22
| StickRRight
|-
|-
| 3 || USB
| 23
| StickRDown
|-
|-
| 4 || Unknown
| 24
|}
| LeftSL
 
|-
= NpadLarkType =
| 25
This is "nn::hid::NpadLarkType".
| LeftSR
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Invalid
| 26
| RightSL
|-
|-
| 1 || H1
| 27
| RightSR
|-
|-
| 2 || H2
| 28
| Palma
|-
|-
| 3 || NL
| 29
| Verification
|-
|-
| 4 || NR
| 30
|}
| HandheldLeftB (Left B button on NES controllers in Handheld mode)
 
= NpadLuciaType =
This is "nn::hid::NpadLuciaType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Invalid
| 31
| [12.0.0+] LeftC (Left C button in N64 controller)
|-
|-
| 1 || J
| 32
| [12.0.0+] UpC (Up C button in N64 controller)
|-
|-
| 2 || E
| 33
| [12.0.0+] RightC (Right C button in N64 controller)
|-
|-
| 3 || U
| 34
| [12.0.0+] DownC (Down C button in N64 controller)
|}
|}


= GestureDirection =
= AnalogStickCalibrationFlagsSet =
This is "nn::hid::GestureDirection".
This is "nn::hid::detail::AnalogStickCalibrationFlagsSet". This is a BitFlagSet object for [[#AnalogStickCalibrationFlags]].
 
= SixAxisSensorUserCalibrationFlagsSet =
This is "nn::hid::detail::SixAxisSensorUserCalibrationFlagsSet". This is a BitFlagSet object for [[#SixAxisSensorUserCalibrationFlags]].
 
= NpadStyleSet =
This is "nn::hid::NpadStyleSet". This is a BitFlagSet object for [[#NpadStyleTag]].
 
= NpadStyleTag =
This is "nn::hid::NpadStyleTag".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Bits
!  Description
!  Description
|-
|-
| 0 || None
| 0
| NpadStyleFullKey (Pro Controller)
|-
|-
| 1 || Left
| 1
| NpadStyleHandheld (Joy-Con controller in handheld mode)
|-
|-
| 2 || Up
| 2
| NpadStyleJoyDual (Joy-Con controller in dual mode)
|-
|-
| 3 || Right
| 3
| NpadStyleJoyLeft (Joy-Con left controller in single mode)
|-
| 4
| NpadStyleJoyRight (Joy-Con right controller in single mode)
|-
|-
| 4 || Down
| 5
|}
| NpadStyleGc (GameCube controller)
 
= GestureType =
This is "nn::hid::GestureType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Idle
| 6
| NpadStylePalma (Poké Ball Plus controller)
|-
|-
| 1 || Complete
| 7
| NpadStyleLark (NES/Famicom controller)
|-
|-
| 2 || Cancel
| 8
| NpadStyleHandheldLark (NES/Famicom controller in handheld mode)
|-
|-
| 3 || Touch
| 9
| NpadStyleLucia (SNES controller)
|-
|-
| 4 || Press
| 10
| [12.0.0+] NpadStyleLagon (N64 controller)
|-
|-
| 5 || Tap
| 11
| [13.0.0+] NpadStyleLager (Sega Genesis controller)
|-
|-
| 6 || Pan
| 12-28
| Reserved
|-
|-
| 7 || Swipe
| 29
| NpadStyleSystemExt (generic external controller)
|-
|-
| 8 || Pinch
| 30
| NpadStyleSystem (generic controller)
|-
|-
| 9 || Rotate
| 31
| Reserved
|}
|}


= DeviceHandle =
= NpadDeviceTypeSet =
This is "nn::xcd::DeviceHandle". This is a 8 byte value.
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]].


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
! Bits
|-
! Description
! Bit
! Description
|-
|-
| 0
| 0
| FullKey
| IsChargingJoyDual
|-
|-
| 1
| 1
| DebugPad
| IsChargingJoyLeft
|-
|-
| 2
| 2
| HandheldLeft
| IsChargingJoyRight
|-
|-
| 3
| 3
| HandheldRight
| IsPoweredJoyDual
|-
|-
| 4
| 4
| JoyLeft
| IsPoweredJoyLeft
|-
|-
| 5
| 5
| JoyRight
| IsPoweredJoyRight
|-
| 6
| Palma
|-
| 7
| LarkHvcLeft
|-
| 8
| LarkHvcRight
|-
|-
| 9
| 9
| LarkNesLeft
| IsUnsuportedButtonPressedOnNpadSystem
|-
|-
| 10
| 10
| LarkNesRight
| IsUnsuportedButtonPressedOnNpadSystemExt
|-
|-
| 11
| 11
| HandheldLarkHvcLeft
| IsAbxyButtonOriented
|-
|-
| 12
| 12
| HandheldLarkHvcRight
| IsSlSrButtonOriented
|-
|-
| 13
| 13
| HandheldLarkNesLeft
| [4.0.0+] IsPlusAvailable
|-
|-
| 14
| 14
| HandheldLarkNesRight
| [4.0.0+] IsMinusAvailable
|-
|-
| 15
| 15
| Lucia
| [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"
|-
|-
| 16-30
! Bit
| Reserved
! Description
|-
|-
| 31
| 0
| System
| IsUnintendedHomeButtonInputProtectionEnabled
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Bits
!  Value
!  Description
!  Description
|-
|-
| 0-7
| 0 || Embedded
| 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
| 1 || FullKeyController
| Pro Controller
|-
|-
| 11
| 2 || RightController
| Famicom left controller
|-
|-
| 12
| 3 || LeftController
| Famicom right controller (with microphone)
|-
|-
| 13
| 4 || DebugPadController
| NES left controller
|}
 
= UniquePadInterface =
This is "nn::hid::system::UniquePadInterface".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 14
| 0 || Embedded
| NES right controller
|-
|-
| 15-16
| 1 || Rail
| Invalid
|-
|-
| 17
| 2 || Bluetooth
| Generic external controller
|-
|-
| 18-20
| 3 || Usb
| Invalid
|-
| 21-23
| Generic controller
|}
|}


[9.0.0+] This is "nn::hidtypes::DeviceType".
= 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"
{| class="wikitable" border="1"
!  Value
!  Value
!  [[#DeviceType|DeviceType]]
!  [[#UniquePadType|UniquePadType]]
!  Description
!  Description
|-
|-
| 1 || JoyRight, HandheldRight || JoyRight || Joy-Con right controller
| 0 || ReleaseFromRight
|-
|-
| 2 || JoyLeft, HandheldLeft || JoyLeft || Joy-Con left controller
| 1 || ReleaseFromBottom
|-
|-
| 3 || FullKey || FullKey || Pro Controller
| 2 || ReleaseFromLeft
|-
|-
| 4 || JoyLeft || JoyLeft || Reserved
| 3 || ReleaseFromTop
|-
|-
| 5 || JoyRight || JoyRight || Reserved
| 4 || Rotate
|-
|-
| 6 || FullKey || FullKey || Reserved
| 5 || Update
|-
|-
| 7 || LarkHvcLeft, HandheldLarkHvcLeft || JoyLeft || Famicom left controller
| 6 || Completed
|-
|-
| 8 || LarkHvcRight, HandheldLarkHvcRight || JoyRight || Famicom right controller (with microphone)
| 7 || Clear
|-
|-
| 9 || LarkNesLeft, HandheldLarkNesLeft || JoyLeft || NES left controller
| 8 || ClearCompleted
|}
 
= SixAxisSensorUserCalibrationStage =
This is "nn::hid::system::SixAxisSensorUserCalibrationStage".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 10 || LarkNesRight, HandheldLarkNesRight || JoyRight || NES right controller
| 0 || Measuring
|-
|-
| 11 || Lucia || FullKey || SNES controller
| 1 || Update
|-
|-
| 12 || Palma || Other || Poké Ball Plus controller
| 2 || Completed
|-
|}
| 13 || FullKey || FullKey || Gc controller
 
= NpadJoyHoldType =
This is "nn::hid::NpadJoyHoldType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 14 || HandheldLeft || JoyLeft || Reserved
| 0 || Vertical
|-
|-
| 15 || FullKey || FullKey || Reserved
| 1 || Horizontal
|-
| 16 || FullKey || FullKey || Reserved
|-
| 17 || DebugPad || DebugPad || Debug controller
|-
| 18 || HandheldRight || JoyRight || Reserved
|-
| 19 || System || Other || Unknown (has [[#NpadStyleTag|NpadFullKey]] style tag)
|-
| 20 || System || Other || Unknown (has [[#NpadStyleTag|NpadJoyDual]] style tag)
|-
| 21 || System || Other || Unknown (has [[#NpadStyleTag|NpadJoyDual]] style tag)
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
! Offset
| 0 || Left
! Size
! Description
|-
|-
| 0x0
| 1 || Right
| 0x1
| IsPowered
|-
| 0x1
| 0x1
| IsCharging
|-
| 0x2
| 0x6
| Reserved
|-
| 0x8
| 0x6
| [[#BatteryLevel|BatteryLevel]]
|}
|}


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


= ConsoleSixAxisSensorHandle =
This controls how many joycons must be attached for handheld mode to be triggered (Dual = 2, Single = 1, None = 0).
This is "nn::hid::ConsoleSixAxisSensorHandle". This is a 4-byte struct with 4-byte alignment.
 
sdknso GetConsoleSixAxisSensorHandle always returns a handle with value 0x13.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
! Offset || Size || Description
| 0 || Dual
|-
|-
| 0x0 || 0x4 || TypeValue
| 1 || Single
|-
|-
| 0x0 || 0x1 ||
| 2 || None
|-
|}
| 0x1 || 0x1 ||  
|}


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


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


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
! Offset || Size || Description
| 0 || 5ms
|-
|-
| 0x0 || 0x4 || TypeValue
| 1 || 10ms
|-
|-
| 0x0 || 0x1 || NpadStyleIndex
| 2 || 15ms
|-
|-
| 0x1 || 0x1 || [[#NpadIdType|PlayerNumber]]
| 3 || Default
|-
| 0x2 || 0x1 || DeviceIdx
|}
|}


= VibrationDeviceInfo =
= FirmwareVersion =
This is "nn::hid::VibrationDeviceInfo" / "nn::hid::VibrationDeviceInfoForIpc". This is a 0x8-byte struct.
This is "nn::hid::system::FirmwareVersion" ([1.0.0-2.3.0] "nn::hid::debug::FirmwareVersion").


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset
! Size
! Description
|-
| 0x0
| 0x1
| Major
|-
| 0x1
| 0x1
| Minor
|-
| 0x2
| 0x1
| Micro
|-
|-
| 0x0 || 0x4 || [[#VibrationDeviceType|DeviceType]]
| 0x3
| 0x1
| Revision
|-
|-
| 0x4 || 0x4 || [[#VibrationDevicePosition|Position]]
| 0x4
| 0xC
| [3.0.0+] [[#DeviceIdentifier]]
|}
|}


= VibrationDeviceType =
== DeviceIdentifier ==
This is "nn::hid::VibrationDeviceType".
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Value
!  Description
!  Description
|-
|-
| 0 || Unknown
| "JR" || Joy-Con right controller
|-
| "JL" || Joy-Con left controller
|-
|-
| 1 || LinearResonantActuator
| "FK" || Pro Controller
|-
|-
| 2 || GcErm
| "MY" || MiyabiLeft and MiyabiRight
|}
 
= VibrationDevicePosition =
This is "nn::hid::VibrationDevicePosition".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || None
| "LC" || Tarragon and Tarragon2
|-
|-
| 1 || Left
| "HL" || Famicom left controller
|-
|-
| 2 || Right
| "HR" || Famicom right controller (with microphone)
|}
 
= VibrationValue =
This is "nn::hid::VibrationValue". This is a 0x10-byte struct, which contains 4 float values.
 
{| class="wikitable" border="1"
|-
|-
! Offset
| "NL" || NES left controller
! Size
! Description
|-
|-
| 0x0
| "NR" || NES right controller
| 0x4
| AmplitudeLow
|-
|-
| 0x4
| "SN" || SNES controller
| 0x4
| FrequencyLow
|-
|-
| 0x8
| "LT" || N64 controller
| 0x4
| AmplitudeHigh
|-
|-
| 0xC
| "LS" || Sega Genesis controller
| 0x4
| FrequencyHigh
|}
 
= VibrationGcErmCommand =
This is "nn::hid::VibrationGcErmCommand".
 
{| class="wikitable" border="1"
!  Value
!  Name
!  Description
|-
|-
| 0 || Stop || Stops the vibration with a decay phase.
| "PB" || Poké Ball Plus controller
|-
|-
| 1 || Start || Starts the vibration.
| "SH" || SioH
|-
|-
| 2 || StopHard || Stops the vibration immediately, with no decay phase.
| "TS" || TouchScreen
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 6,947: Line 7,467:
!  Description
!  Description
|-
|-
| 0 || Loose
| 0x00000000 || None
|-
| 0x01000000 || HandheldNone
|-
|-
| 1 || Tight
| 0x02000000 || HandheldJoyConLeftOnly
|}
 
= GyroscopeZeroDriftMode =
This is "nn::hid::GyroscopeZeroDriftMode".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Loose
| 0x02000001 || HandheldLarkHvc1Only
|-
|-
| 1 || Standard
| 0x02000002 || HandheldLarkNesLeftOnly
|-
|-
| 2 || Tight
| 0x03000000 || HandheldJoyConRightOnly
|}
 
= 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
| 0x03000001 || HandheldLarkHvc2Only
|-
|-
| 0x0 || 0x4 || sdknso sets this to the output value from [[#GetPalmaOperationInfo]], sdknso will Abort if it's larger than 0x10 ([5.0.0-5.0.2] 0xE).
| 0x03000002 || HandheldLarkNesRightOnly
|-
|-
| 0x4 || 0x4 || Result
| 0x04000000 || HandheldJoyConLeftJoyConRight
|-
|-
| 0x8 || 0x140 || Buffer for [[#GetPalmaOperationInfo]].
| 0x04000001 || HandheldJoyConLeftLarkHvc2
|}
 
= PalmaFrModeType =
This is "nn::hid::PalmaFrModeType".
 
= 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
| 0x04000002 || HandheldJoyConLeftLarkNesRight
|-
|-
| 0x0 || 0x2 || Passed for the second u64 for [[#WritePalmaActivityEntry]].
| 0x04000003 || HandheldLarkHvc1JoyConRight
|-
|-
| 0x2 || 0x2 || Padding
| 0x04000004 || HandheldLarkHvc1LarkHvc2
|-
|-
| 0x4 || 0x4 || Passed for the third u64 for [[#WritePalmaActivityEntry]].
| 0x04000005 || HandheldLarkHvc1LarkNesRight
|-
|-
| 0x8 || 0x2 || Passed for the fourth u64 for [[#WritePalmaActivityEntry]].
| 0x04000006 || HandheldLarkNesLeftJoyConRight
|}
 
= PalmaWaveSet =
This is "nn::hid::PalmaWaveSet".
 
= PalmaFeature =
This is "nn::hid::PalmaFeature".
 
= AbstractedPadState =
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 0x04000007 || HandheldLarkNesLeftLarkHvc2
|-
|-
| 0x0 || 0x4 || Type, only 1 bit can be set. Converted to [[#HdlsDeviceInfo]]::type internally by [[#SetAutoPilotVirtualPadState]].
| 0x04000008 || HandheldLarkNesLeftLarkNesRight
|-
|-
| 0x4 || 0x1 || Flags. [[#SetAutoPilotVirtualPadState]] only uses bit0: when clear it will skip using the rest of the input and run [[#UnsetAutoPilotVirtualPadState]] internally.
| 0x05000000 || JoyDual
|-
|-
| 0x5 || 0x3 || Padding
| 0x06000000 || JoyDualLeftOnly
|-
|-
| 0x8 || 0x4 || RGBA Single Body Color
| 0x07000000 || JoyDualRightOnly
|-
|-
| 0xC || 0x4 || RGBA Single Buttons Color
| 0x08000000 || JoyLeftHorizontal
|-
|-
| 0x10 || 0x1 || See [[#HiddbgHdlsDeviceInfo]]::[[#NpadInterfaceType]].
| 0x09000000 || JoyLeftVertical
|-
|-
| 0x11 || 0x3 || Padding
| 0x0A000000 || JoyRightHorizontal
|-
|-
| 0x14 || 0x24 || [[#HdlsState]]. Unknown if the last 4-bytes are included in this struct, [[#SetAutoPilotVirtualPadState]]/[[#hiddbgGetAbstractedPadsState]] only uses the first 0x20-bytes.
| 0x0B000000 || JoyRightVertical
|-
|-
| 0x38 || 0x60 || Unused with [[#SetAutoPilotVirtualPadState]]/[[#GetAbstractedPadsState]].
| 0x0C000000 || SwitchProController
|}
 
Normally the input state is merged with an existing controller selected by Type. However in some cases (BIT(2-5) with type2!=0x2 and BIT(31)) it's detected as a dedicated controller.
 
Type:
{| class="wikitable" border="1"
!  Bits
!  [[#HdlsDeviceInfo]]::type bits
!  Description
!  Notes
|-
|-
| 0 || 0 || ||  
| 0x0D000000 || CompatibleProController
|-
|-
| 1 || 15 || || [[#DeviceType]] |= BIT(1)
| 0x0E000000 || CompatibleJoyCon
|-
|-
| 2 || 1 || ||  
| 0x0F000000 || LarkHvc1
|-
|-
| 3 || 2 || ||  
| 0x10000000 || LarkHvc2
|-
|-
| 4 || 1 || ||  
| 0x11000000 || LarkNesLeft
|-
|-
| 5 || 2 || ||  
| 0x12000000 || LarkNesRight
|-
|-
| 6 || 3 || ||  
| 0x13000000 || LuciaU
|-
|-
| 7 || 11 || || [[#DeviceType]] |= BIT(11)
| 0x13000001 || LuciaJ
|-
|-
| 8 || 12 || || [[#DeviceType]] |= BIT(12)
| 0x13000002 || LuciaE
|-
|-
| 9 || 13 || || [[#DeviceType]] |= BIT(13)
| 0x14000000 || Verification
|-
|-
| 10 || 14 || || [[#DeviceType]] |= BIT(14)
| 0x15000000 || [13.0.0+] Lagon
|-
|-
| 11 || 15 || || [[#DeviceType]] |= BIT(11)
| 0xFFFFFFFF || Unknown
|-
|}
| 12 || 12 || || [[#DeviceType]] |= BIT(12)
 
|-
= AppletFooterUiType =
| 13 || 13 || || [[#DeviceType]] |= BIT(13)
This is "nn::hid::system::AppletFooterUiType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 14 || 14 || || [[#DeviceType]] |= BIT(14)
| 0 || None
|-
|-
| 15 || 17 || ||  
| 1 || HandheldNone
|-
|-
| 31 || 21 || || [[#DeviceType]] = BIT(31)
| 2 || HandheldJoyConLeftOnly
|-
|-
|}
| 3 || HandheldJoyConRightOnly
 
The above "[[#DeviceType]] |=" notes only apply when type2 is 0x2.
 
= DebugPadAutoPilotState =
This is "nn::hid::debug::DebugPadAutoPilotState"
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 4 || HandheldJoyConLeftJoyConRight
! Size
! Description
|-
|-
| 0x0
| 5 || JoyDual
| 0x4
| [[#DebugPadAttributeSet|Attributes]]
|-
|-
| 0x4
| 6 || JoyDualLeftOnly
| 0x4
| [[#DebugPadButtonSet|Buttons]]
|-
|-
| 0x8
| 7 || JoyDualRightOnly
| 0x8
| [[#AnalogStickState|AnalogStickL]]
|-
|-
| 0x10
| 8 || JoyLeftHorizontal
| 0x8
| [[#AnalogStickState|AnalogStickR]]
|}
 
= MouseAutoPilotState =
This is "nn::hid::debug::MouseAutoPilotState".
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 9 || JoyLeftVertical
! Size
! Description
|-
|-
| 0x0
| 10 || JoyRightHorizontal
| 0x4
| X
|-
|-
| 0x4
| 11 || JoyRightVertical
| 0x4
| Y
|-
|-
| 0x8
| 12 || SwitchProController
| 0x4
|-
| DeltaX
| 13 || CompatibleProController
|-
| 14 || CompatibleJoyCon
|-
|-
| 0xC
| 15 || LarkHvc1
| 0x4
| DeltaY
|-
|-
| 0x10
| 16 || LarkHvc2
| 0x4
| WheelDelta
|-
|-
| 0x14
| 17 || LarkNesLeft
| 0x4
| [[#MouseButtonSet|Buttons]]
|-
|-
| 0x18
| 18 || LarkNesRight
| 0x4
| [[#MouseAttributeSet|Attributes]]
|}
 
= KeyboardAutoPilotState =
This is "nn::hid::debug::KeyboardAutoPilotState".
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 19 || Lucia
! Size
! Description
|-
|-
| 0x0
| 20 || Verification
| 0x8
| [[#KeyboardModifierSet|Modifiers]]
|-
|-
| 0x8
| 21 || [13.0.0+] Lagon
| 0x20
| [[#KeyboardKeySet|Keys]]
|}
|}


= HdlsHandle =
= NpadIdType =
This is "nn::hid::debug::HdlsHandle". This is a 0x8-byte struct with 8-byte alignment.
This is "nn::hid::NpadIdType". This is the controller index used in [[#SharedMemoryFormat|sharedmem]].
 
= HdlsNpadAssignment =
This is a 0x208-byte struct.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
! Offset || Size || Description
| 0x0 || No1
|-
| 0x1 || No2
|-
|-
| 0x0 || 0x4 || s32 Total entries
| 0x2 || No3
|-
|-
| 0x4 || 0x4 || Padding
| 0x3 || No4
|-
|-
| 0x8 || 0x200(0x20*0x10) || Array of [[#HdlsNpadAssignmentEntry]].
| 0x4 || No5
|}
 
= HdlsNpadAssignmentEntry =
This is a 0x20-byte struct.
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 0x5 || No6
|-
|-
| 0x0 || 0x8 || [[#HdlsHandle]]
| 0x6 || No7
|-
|-
| 0x8 || 0x4 || ?
| 0x7 || No8
|-
|-
| 0xC || 0x4 || ?
| 0x10 || Other
|-
|-
| 0x10 || 0x8 || ?
| 0x20 || Handheld
|-
| 0x18 || 0x1 || ?
|-
| 0x19 || 0x7 || Padding
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
! Offset || Size || Description
| 1 || Bluetooth
|-
|-
| 0x0 || 0x4 || s32 Total entries
| 2 || Rail
|-
|-
| 0x4 || 0x4 || Padding
| 3 || Usb
|-
|-
| 0x8 || <[[#HdlsStateListEntry]] size>*0x10 || Array of [[#HdlsStateListEntry]].
| 4 || Embedded
|}
|}


This contains a list of all controllers, including non-virtual controllers.
= NpadLarkType =
 
This is "nn::hid::NpadLarkType".
= 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
!  Description
|-
|-
! Offset || Size || Description
| 0 || Invalid
|-
|-
| 0x0 || 0x8 || [[#HdlsHandle]]
| 1 || H1
|-
|-
| 0x8 || [[#HdlsDeviceInfo]] size || [[#HdlsDeviceInfo]]. With [[#ApplyHdlsStateList]] this is only used when creating new devices.
| 2 || H2
|-
|-
| 0x8 + [[#HdlsDeviceInfo]] size, with 8-byte alignment || 0x24 || [[#HdlsState]]
| 3 || NL
|-
|-
| <Immediately following the above> || 0x4 || Padding
| 4 || NR
|}
|}


= HdlsDeviceInfo =
= NpadLuciaType =
This is a 0x10-byte struct.
This is "nn::hid::NpadLuciaType".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
! Offset || Size || Description
| 0 || Invalid
|-
|-
| 0x0 || 0x4 || [[#DeviceTypeInternal]]
| 1 || J
|-
|-
| 0x4 || 0x4 || RGBA Single Body Color
| 2 || E
|-
|-
| 0x8 || 0x4 || RGBA Single Buttons Color
| 3 || U
|-
| 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.
= NpadLagerType =
This is "nn::hid::NpadLagerType".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
! Offset || Size || Description
| 0 || Invalid
|-
|-
| 0x0 || 0x1 || [[#DeviceTypeInternal]]
| 1 || J
|-
|-
| 0x1 || 0x1 || [[#NpadInterfaceType]]. Similar to the field from the old struct.
| 2 || E
|-
|-
| 0x2 || 0x2 || Padding
| 3 || U
|}
 
= SixAxisSensorProperties =
This is "nn::hid::server::SixAxisSensorProperties".
 
{| class="wikitable" border="1"
|-
|-
| 0x4 || 0x4 || RGBA Single Body Color
! Bit
! Description
|-
|-
| 0x8 || 0x4 || RGBA Single Buttons Color
| 0
| IsSixAxisSensorDeviceNewlyAssigned
|-
|-
| 0xC || 0x4 || RGBA Left Grip Color
| 1
|-
| IsFirmwareUpdateAvailableForSixAxisSensor
| 0x10 || 0x4 || RGBA Right Grip Color
|}
|}


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


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


[9.0.0+]:
= GestureType =
This is "nn::hid::GestureType".
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || Idle
|-
|-
! Offset || Size || Description
| 1 || Complete
|-
| 2 || Cancel
|-
| 3 || Touch
|-
|-
| 0x0 || 0x4 || BatteryLevel for the main PowerInfo.
| 4 || Press
|-
|-
| 0x4 || 0x4 || Flags. Used to set the main PowerInfo for [[#NpadSystemProperties]]. Bit0 -> IsPowered, bit1 -> IsCharging.
| 5 || Tap
|-
|-
| 0x8 || 0x8 || [[#NpadButton|Buttons]], masked with 0xfffffffff00fffff. See above table regarding HOME/Capture buttons.
| 6 || Pan
|-
|-
| 0x10 || 0x10(4*2*2) || Joystick data.
| 7 || Swipe
|-
|-
| 0x20 || 0x1 || Unused for input. Set with output from [[#DumpHdlsStates]] (zero in some cases).
| 8 || Pinch
|-
|-
| 0x21 || 0x3 || Padding
| 9 || Rotate
|}
|}


= NotificationLedPattern =
= DeviceHandle =
This is "nn::hid::system::NotificationLedPattern". This is a 0x48-byte struct.
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"
!  Bits
!  Description
|-
|-
! Offset || Size || Subcommand argdata bytepos || Subcommand argdata nibble || Description
| 0
| FullKey
|-
|-
| 0x0 || 0x1 || 0x0 || Low || Mini Cycle Base Duration. Value 0x1-0xF: 12.5ms - 187.5ms. Value 0x0 = 0ms/OFF.
| 1
| DebugPad
|-
|-
| 0x1 || 0x1 || 0x0 || High || Number of Mini Cycles + 1. Value 0x0-0xF: 1 - 16 mini cycles.
| 2
| HandheldLeft
|-
|-
| 0x2 || 0x1 || 0x1 || Low || Number of Full Cycles. Value 0x1-0xF: 1 - 15 full cycles. Value 0x0 is repeat forever, but if Mini Cycle Base Duration is set to 0x0, it does the 1st Mini Cycle with a 12.5ms base duration and then the LED stays on with LED Start Intensity.
| 3
| HandheldRight
|-
|-
| 0x3 || 0x1 || 0x1 || High || LED Start Intensity. Value 0x0-0xF: 0% - 100%. (In HW, 1 - 241 duty)
| 4
| JoyLeft
|-
|-
| 0x4 || 0x1 || 0x2 || High || Mini Cycle 1 LED Intensity. Value 0x0-0xF: 0% - 100%. (In HW, 1 - 241 duty)
| 5
| JoyRight
|-
|-
| 0x5 || 0x1 || 0x3 || High || Fading Transition Steps to Mini Cycle 1 (Uses PWM). Value 0x0: Instant. Each step duration is based on Mini Cycle Step Duration Multiplier.
| 6
| Palma
|-
|-
| 0x6 || 0x1 || 0x3 || Low || Final Step Duration Multiplier of Mini Cycle 1. Value is a Multiplier of Mini Cycle Base Duration. Value 0x0: 12.5ms, 0x1 - xF: 1x - 15x.
| 7
| LarkHvcLeft
|-
|-
| 0x7 || 0x1 || || || Unused
| 8
| LarkHvcRight
|-
|-
| 0x8 || 0x1 || 0x2 || Low || Mini Cycle 2 LED Intensity.
| 9
| LarkNesLeft
|-
|-
| 0x9 || 0x1 || 0x4 || High || Fading Transition Steps to Mini Cycle 2 (see above).
| 10
| LarkNesRight
|-
|-
| 0xA || 0x1 || 0x4 || Low || Final Step Duration Multiplier of Mini Cycle 2 (see above).
| 11
| HandheldLarkHvcLeft
|-
|-
| 0xB || 0x1 || || || Unused
| 12
| HandheldLarkHvcRight
|-
|-
| 0xC || 0x1 || 0x5 || High || Mini Cycle 3 LED Intensity.
| 13
| HandheldLarkNesLeft
|-
|-
| 0xD || 0x1 || 0x6 || High || Fading Transition Steps to Mini Cycle 3 (see above).
| 14
| HandheldLarkNesRight
|-
|-
| 0xE || 0x1 || 0x6 || Low || Final Step Duration Multiplier of Mini Cycle 3 (see above).
| 15
| Lucia
|-
|-
| 0xF || 0x1 || || || Unused
| 16
| [12.0.0+] Lagon
|-
|-
| 0x10 || 0x1 || 0x5 || Low || Mini Cycle 4 LED Intensity.
| 17
| [13.0.0+] Lager
|-
|-
| 0x11 || 0x1 || 0x7 || High || Fading Transition Duration to Mini Cycle 4 (see above).
| 18-30
| Reserved
|-
|-
| 0x12 || 0x1 || 0x7 || Low || Final Step Duration Multiplier of Mini Cycle 4 (see above).
| 31
| System
|}
 
= DeviceTypeInternal =
This is "nn::hid::detail::DeviceTypeInternal".
 
[9.0.0+] This has been superseded by [[#DeviceType_2|DeviceType]].
 
{| class="wikitable" border="1"
!  Bits
!  Description
|-
|-
| 0x13 || 0x1 || || || Unused
| 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.
|-
|-
| 0x14 || 0x1 || 0x8 || High || Mini Cycle 5 LED Intensity.
| 8-10
| Pro Controller
|-
|-
| 0x15 || 0x1 || 0x9 || High || Fading Transition Steps to Mini Cycle 5 (see above).
| 11
| Famicom left controller
|-
|-
| 0x16 || 0x1 || 0x9 || Low || Final Step Duration Multiplier of Mini Cycle 5 (see above).
| 12
| Famicom right controller (with microphone)
|-
|-
| 0x17 || 0x1 || || || Unused
| 13
| NES left controller
|-
|-
| 0x18 || 0x1 || 0x8 || Low || Mini Cycle 6 LED Intensity.
| 14
| NES right controller
|-
|-
| 0x19 || 0x1 || 0xA || High || Fading Transition Steps to Mini Cycle 6 (see above).
| 15-16
| Invalid
|-
|-
| 0x1A || 0x1 || 0xA || Low || Final Step Duration Multiplier of Mini Cycle 6 (see above).
| 17
| Generic external controller
|-
|-
| 0x1B || 0x1 || || || Unused
| 18-20
| Invalid
|-
|-
| 0x1C || 0x1 || 0xB || High || Mini Cycle 7 LED Intensity.
| 21-23
| Generic controller
|}
 
= DeviceType =
This is "nn::hidtypes::DeviceType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0x1D || 0x1 || 0xC || High || Fading Transition Steps  to Mini Cycle 7 (see above).
| 0 || Unknown
|-
| 0x1E || 0x1 || 0xC || Low || Final Step Duration Multiplier of Mini Cycle 7 (see above).
|-
| 0x1F || 0x1 || || || Unused
|-
| 0x20 || 0x1 || 0xB || Low || Mini Cycle 8 LED Intensity.
|-
| 0x21 || 0x1 || 0xD || Low || Fading Transition Steps to Mini Cycle 8 (see above).
|-
| 0x22 || 0x1 || 0xD || High || Final Step Duration Multiplier of Mini Cycle 8 (see above).
|-
| 0x23 || 0x1 || || || Unused
|-
| 0x24 || 0x1 || 0xE || High || Mini Cycle 9 LED Intensity.
|-
| 0x25 || 0x1 || 0xF || High || Fading Transition Steps to Mini Cycle 9 (see above).
|-
| 0x26 || 0x1 || 0xF || Low || Final Step Duration Multiplier of Mini Cycle 9 (see above).
|-
|-
| 0x27 || 0x1 || || || Unused
| 1 || [[#JoyConRight|JoyConRight]]
|-
|-
| 0x28 || 0x1 || 0xE || Low || Mini Cycle 10 LED Intensity.
| 2 || [[#JoyConLeft|JoyConLeft]]
|-
|-
| 0x29 || 0x1 || 0x10 || High || Fading Transition Steps to Mini Cycle 10 (see above).
| 3 || [[#SwitchProController|SwitchProController]]
|-
|-
| 0x2A || 0x1 || 0x10 || Low || Final Step Duration Multiplier of Mini Cycle 10 (see above).
| 4 || MiyabiLeft
|-
|-
| 0x2B || 0x1 || || || Unused
| 5 || MiyabiRight
|-
|-
| 0x2C || 0x1 || 0x11 || High || Mini Cycle 11 LED Intensity.
| 6 || [[#Tarragon|Tarragon]]
|-
|-
| 0x2D || 0x1 || 0x12 || High || Fading Transition Steps to Mini Cycle 11 (see above).
| 7 || [[#LarkH1|LarkH1]]
|-
|-
| 0x2E || 0x1 || 0x12 || Low || Final Step Duration Multiplier of Mini Cycle 11 (see above).
| 8 || [[#LarkH2|LarkH2]]
|-
|-
| 0x2F || 0x1 || || || Unused
| 9 || [[#LarkNL|LarkNL]]
|-
|-
| 0x30 || 0x1 || 0x11 || Low || Mini Cycle 12 LED Intensity.
| 10 || [[#LarkNR|LarkNR]]
|-
|-
| 0x31 || 0x1 || 0x13 || High || Fading Transition Steps to Mini Cycle 12 (see above).
| 11 || [[#Lucia|Lucia]]
|-
|-
| 0x32 || 0x1 || 0x13 || Low || Final Step Duration Multiplier of Mini Cycle 12 (see above).
| 12 || [[#Palma|Palma]]
|-
|-
| 0x33 || 0x1 || || || Unused
| 13 || [[#GcOnGggg|GcOnGggg]]
|-
|-
| 0x34 || 0x1 || 0x14 || High || Mini Cycle 13 LED Intensity.
| 14 || FiftyL
|-
|-
| 0x35 || 0x1 || 0x15 || High || Fading Transition Steps to Mini Cycle 13 (see above).
| 15 || UsbPad
|-
|-
| 0x36 || 0x1 || 0x15 || Low || Final Step Duration Multiplier of Mini Cycle 13 (see above).
| 16 || WinGenericPad
|-
|-
| 0x37 || 0x1 || || || Unused
| 17 || Sio
|-
|-
| 0x38 || 0x1 || 0x14 || Low || Mini Cycle 14 LED Intensity.
| 18 || FiftyR
|-
|-
| 0x39 || 0x1 || 0x16 || High || Fading Transition Steps to Mini Cycle 14 (see above).
| 19 || DebugSwitchProControllerCompatibleDevice
|-
|-
| 0x3A || 0x1 || 0x16 || Low || Final Step Duration Multiplier of Mini Cycle 14 (see above).
| 20 || DebugJoyConLeftCompatibleDevice
|-
|-
| 0x3B || 0x1 || || || Unused
| 21 || DebugJoyConRightCompatibleDevice
|-
|-
| 0x3C || 0x1 || 0x17 || High || Mini Cycle 15 LED Intensity.
| 22 || [12.0.0+] [[#Lagon|Lagon]]
|-
|-
| 0x3D || 0x1 || 0x18 || High || Fading Transition Steps to Mini Cycle 15 (see above).
| 23 || [12.0.0+] [[#ExternalGrip|ExternalGrip]]
|-
|-
| 0x3E || 0x1 || 0x18 || Low || Final Step Duration Multiplier of Mini Cycle 15 (see above).
| 24 || [13.0.0+] [[#SwitchProControllerDfu|SwitchProControllerDfu]]
|-
|-
| 0x3F || 0x1 || || || Unused
| 25 || [13.0.0+] [[#ExternalGripDfu|ExternalGripDfu]]
|-
|-
| 0x40 || 0x1 || 0x17 || Low || Mini Cycle 16 LED Intensity.
| 26 || [13.0.0+] [[#LuciaDfu|LuciaDfu]]
|-
|-
| 0x41 || 0x1 || 0x19 || High || Fading Transition Steps to Mini Cycle 16 (see above). (Unused in older Joy-Con / Pro-Con FW. Unknown for new.)
| 27 || [13.0.0+] [[#LagonDfu|LagonDfu]]
|-
|-
| 0x42 || 0x1 || 0x19 || Low || Final Step Duration Multiplier of Mini Cycle 16 (see above). (Unused in older Joy-Con / Pro-Con FW. Unknown for new.)
| 28 || [13.0.0+] [[#Lager|Lager]]
|-
|-
| 0x43 || 0x1 || || || Unused
| 29 || [14.0.0+] [[#LagerDfu|LagerDfu]]
|-
| 0x44 || 0x1 || 0x1A || High || Unknown (Unused in older Joy-Con / Pro-Con FW. Unknown for new.)
|-
| 0x45 || 0x1 || 0x1A || Low || Unknown (Unused in older Joy-Con / Pro-Con FW. Unknown for new.)
|-
| 0x46 || 0x1 || || || Padding
|-
| 0x47 || 0x1 || || || Padding
|-
|-
| 30 || [14.0.0+] [[#Tarragon2|Tarragon2]]
|}
|}


The above descriptions in the table are based on the info from [https://github.com/dekuNukem/Nintendo_Switch_Reverse_Engineering/blob/master/bluetooth_hid_subcommands_notes.md here].
== JoyConRight ==
[[Joy-Con|Joy-Con]] right controller.


argdata in the subcommand is initialized as follows: <code>((u8*)cmd_argdata)[pos] = u8_in[pos2] | u8_in[pos3]<<4;</code> Hence, 4bits from pairs of 2-bytes of the input struct are combined to write to the subcommand. Only the low 4bits of each used byte in the struct is used. This is written to stack initially, then copied to the actual cmd_argdata (the data immediately following the subcommandID byte). There's a total of 0x1B-bytes of cmd_argdata initialized from this.
== 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".


The layout of cmd_argdata is as follows:
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset
! Size
! Description
|-
|-
| 0x0 || 0x1B || See above.
| 0x0
| 0x2
| Vid
|-
|-
| 0x1B || 0xB || Cleared to zero.
| 0x2
| 0x2
| PidRangeMax
|-
|-
| 0x26 || 0x5 || Unused
| 0x4
| 0x2
| PidRangeMin
|-
|-
| 0x2B || 0x8 || Set to an input value, which is hard-coded 0.
| 0x6
| 0x1
| [[#DeviceTypeInternal|DeviceType]]
|-
|-
| 0x33 || 0x2 || Set to value 0.
| 0x7
|-
| 0x1
| 0x35 || 0x1 || Set to value 1.
| Reserved
|}
|}


= SystemButtonConfigEmbedded =
= VidPidDefinitions =
This is "nn::hid::system::ButtonConfigEmbedded". This is a 0x2C8-byte struct.
This is "nn::hidtypes::detail::VidPidDefinitions". This is a list of [[#VidPidDefinition|VidPidDefinition]] objects maintained by the hid-sysmodule.
 
= 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"
|-
|-
! Offset || Size || Description
! Vid || PidRangeMax || PidRangeMin || [[#DeviceTypeInternal|DeviceType]] || Description
|-
|-
| 0x0 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonLeft]]
| 0x57E || 0x2006 || 0x2006 || 2 || Nintendo [[HID_services#JoyConLeft|JoyConLeft]]
|-
|-
| 0x4 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonUp]]
| 0x57E || 0x2007 || 0x2007 || 1 || Nintendo [[HID_services#JoyConRight|JoyConRight]]
|-
|-
| 0x8 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonRight]]
| 0x57E || 0x2009 || 0x2009 || 3 || Nintendo [[HID_services#SwitchProController|SwitchProController]]
|-
|-
| 0xC || 0x4 || [[#DigitalButtonAssignment|HardwareButtonDown]]
| 0x57E || 0x200F || 0x200F || 24 || Nintendo [[HID_services#SwitchProControllerDfu|SwitchProControllerDfu]]
|-
|-
| 0x10 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonA]]
| 0x57E || 0x200E || 0x200E || 23 || Nintendo [[HID_services#ExternalGrip|ExternalGrip]]
|-
|-
| 0x14 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonB]]
| 0x57E || 0x2008 || 0x2008 || 25 || Nintendo [[HID_services#ExternalGripDfu|ExternalGripDfu]]
|-
|-
| 0x18 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonX]]
| 0x57E || 0x2017 || 0x2017 || 11 || Nintendo [[HID_services#Lucia|Lucia]]
|-
|-
| 0x1C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonY]]
| 0x57E || 0x2018 || 0x2018 || 26 || Nintendo [[HID_services#LuciaDfu|LuciaDfu]]
|-
|-
| 0x20 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStickL]]
| 0x57E || 0x2019 || 0x2019 || 22 || Nintendo [[HID_services#Lagon|Lagon]]
|-
|-
| 0x24 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStickR]]
| 0x57E || 0x201A || 0x201A || 27 || Nintendo [[HID_services#LagonDfu|LagonDfu]]
|-
|-
| 0x28 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonL]]
| 0x57E || 0x201E || 0x201E || 28 || Nintendo [[HID_services#Lager|Lager]]
|-
|-
| 0x2C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonR]]
| 0x57E || 0x201F || 0x201F || 29 || Nintendo [[HID_services#LagerDfu|LagerDfu]]
|-
|-
| 0x30 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonZL]]
| 0x57E || 0x337 || 0x337 || 13 || Nintendo [[HID_services#GcOnGggg|GcOnGggg]]
|-
|-
| 0x34 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonZR]]
| 0x57E || 0x300E || 0x300E || [17.0.0+] 18 || Nintendo FiftyR
|-
|-
| 0x38 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonSelect]]
| 0x57E || 0x300D || 0x300D || [17.0.0+] 14 || Nintendo FiftyL
|-
|-
| 0x3C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStart]]
| 0xF0D || 0x92 || 0x92 || 15 || HORI Pokken Tournament DX Pro Pad
|-
|-
| 0x40 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonCapture]]
| 0xF0D || 0xAB || 0xAA || 15 || HORI
|-
|-
| 0x44 || 0x8 || [[#AnalogStickAssignment|HardwareStickL]]
| 0xF0D || 0xC1 || 0xC1 || 15 || HORIPAD for Nintendo Switch
|-
|-
| 0x4C || 0x8 || [[#AnalogStickAssignment|HardwareStickR]]
| 0xF0D || 0xFF || 0xF0 || 15 || HORI
|}
 
== DigitalButtonAssignment ==
This is "nn::hidconfig::DigitalButtonAssignment".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || A
| 0xF0D || 0x22F || 0x200 || [1.0.0-20.0.1] 15 || HORI
|-
|-
| 1 || B
| 0xF0D || 0x201 || 0x200 || [20.1.0+] 15 || HORI Split Pad Pro
|-
|-
| 2 || X
| 0xF0D || 0x202 || 0x202 || [20.1.0+] 15 || HORI
|-
|-
| 3 || Y
| 0xF0D || 0x21F || 0x203 || [20.1.0+] 15 || HORI
|-
|-
| 4 || StickL
| 0xF0D || 0x25F || 0x220 || [20.1.0+] 15 || HORI
|-
|-
| 5 || StickR
| 0xF0D || 0x27F || 0x260 || [20.1.0+] 15 || HORI
|-
|-
| 6 || L
| 0xE6F || 0x193 || 0x180 || 15 || PDP
|-
|-
| 7 || R
| 0x20D6 || 0xA719 || 0xA710 || [1.0.0-20.0.1] 15 || PowerA
|-
|-
| 8 || ZL
| 0x20D6 || 0xA729 || 0xA720 || [1.0.0-20.0.1] 15 || PowerA
|-
|-
| 9 || ZR
| 0x20D6 || 0xA716 || 0xA710 || [20.1.0+] 15 || PowerA
|-
|-
| 10 || Select
| 0x20D6 || 0xA717 || 0xA717 || [20.1.0+] 15 || PowerA
|-
|-
| 11 || Start
| 0x20D6 || 0xA719 || 0xA718 || [20.1.0+] 15 || PowerA
|-
|-
| 12 || Left
| 0x20D6 || 0xA720 || 0xA720 || [20.1.0+] 15 || PowerA
|-
| 13 || Up
|-
| 14 || Right
|-
|-
| 15 || Down
| 0x20D6 || 0xA721 || 0xA721 || [20.1.0+] 15 || PowerA
|-
|-
| 16 || LeftSL
| 0x20D6 || 0xA726 || 0xA722 || [20.1.0+] 15 || PowerA
|-
|-
| 17 || LeftSR
| 0x20D6 || 0xA731 || 0xA727 || [20.1.0+] 15 || PowerA
|-
|-
| 18 || RightSL
| 0x33DD || 0xB || 0x1 || 15 || ZUIKI
|-
| 19 || RightSR
|-
| 20 || HomeButton
|-
| 21 || CaptureButton
|-
| 22 || Invalid
|}
|}


== AnalogStickAssignment ==
= NpadPowerInfo =
This is "nn::hidconfig::AnalogStickAssignment".
This is "nn::hid::system::NpadPowerInfo".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset
! Size
! Description
|-
|-
| 0x0 || 0x4 || [[#AnalogStickRotation]]
| 0x0
| 0x1
| IsPowered
|-
|-
| 0x4 || 0x1 || IsPairedStickAssigned
| 0x1
| 0x1
| IsCharging
|-
| 0x2
| 0x6
| Reserved
|-
|-
| 0x5 || 0x3 || Reserved
| 0x8
| 0x4
| [[#BatteryLevel|BatteryLevel]]
|}
|}


== AnalogStickRotation ==
= BatteryLevel =
This is "nn::hidconfig::AnalogStickRotation".
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
!  Description
|-
|-
| 0 || None
! Offset || Size || Description
|-
| 0x0 || 0x4 || TypeValue
|-
|-
| 1 || Clockwise90
| 0x0 || 0x1 ||  
|-
|-
| 2 || Anticlockwise90
| 0x1 || 0x1 ||  
|}
|}


= ButtonConfigFull =
= SixAxisSensorHandle =
This is "nn::hidconfig::ButtonConfigFull". This is a 0x54-byte struct.
This is "nn::hid::SixAxisSensorHandle". This is a 4-byte struct with 4-byte alignment.
 
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"
Line 7,645: Line 8,152:
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonLeft]]
| 0x0 || 0x4 || TypeValue
|-
|-
| 0x4 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonUp]]
| 0x0 || 0x1 || NpadStyleIndex
|-
|-
| 0x8 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonRight]]
| 0x1 || 0x1 || [[#NpadIdType|PlayerNumber]]
|-
|-
| 0xC || 0x4 || [[#DigitalButtonAssignment|HardwareButtonDown]]
| 0x2 || 0x1 || DeviceIdx
|}
 
= VibrationDeviceHandle =
This is "nn::hid::VibrationDeviceHandle". This is a 4-byte struct with 4-byte alignment.
 
{| class="wikitable" border="1"
|-
|-
| 0x10 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStickL]]
! Offset || Size || Description
|-
|-
| 0x14 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonL]]
| 0x0 || 0x4 || TypeValue
|-
|-
| 0x18 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonZL]]
| 0x0 || 0x1 || NpadStyleIndex
|-
|-
| 0x1C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonSelect]]
| 0x1 || 0x1 || [[#NpadIdType|PlayerNumber]]
|-
|-
| 0x20 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonLeftSL]]
| 0x2 || 0x1 || DeviceIdx
|-
| 0x24 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonLeftSR]]
|-
| 0x28 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonCapture]]
|-
| 0x2C || 0x8 || [[#AnalogStickAssignment|HardwareStickL]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 7,677: Line 8,184:
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonA]]
| 0x0 || 0x4 || [[#VibrationDeviceType|DeviceType]]
|-
|-
| 0x4 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonB]]
| 0x4 || 0x4 || [[#VibrationDevicePosition|Position]]
|-
| 0x8 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonX]]
|-
| 0xC || 0x4 || [[#DigitalButtonAssignment|HardwareButtonY]]
|-
| 0x10 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStickR]]
|-
| 0x14 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonR]]
|-
| 0x18 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonZR]]
|-
| 0x1C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStart]]
|-
| 0x20 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonRightSL]]
|-
| 0x24 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonRightSR]]
|-
| 0x28 || 0x8 || [[#AnalogStickAssignment|HardwareStickR]]
|}
|}


= IrCameraHandle =
= VibrationDeviceType =
This is "nn::irsensor::IrCameraHandle".
This is "nn::hid::VibrationDeviceType".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
! Offset || Size || Description
| 0 || Unknown
|-
|-
| 0x0 || 0x1 || PlayerNumber
| 1 || LinearResonantActuator
|-
|-
| 0x1 || 0x1 || DeviceType
| 2 || GcErm
|-
|-
| 0x2 || 0x2 || Reserved
| 3 || Erm
|}
|}


= IrCameraStatus =
= VibrationDevicePosition =
This is "nn::irsensor::IrCameraStatus".
This is "nn::hid::VibrationDevicePosition".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 7,721: Line 8,212:
!  Description
!  Description
|-
|-
| 0 || Available
| 0 || None
|-
|-
| 1 || Unsupported
| 1 || Left
|-
|-
| 2 || Unconnected
| 2 || Right
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Stopped
! Offset
! Size
! Description
|-
|-
| 1 || FirmwareUpdateNeeded
| 0x0
| 0x4
| AmplitudeLow
|-
|-
| 2 ||  
| 0x4
| 0x4
| FrequencyLow
|-
|-
| 3 ||  
| 0x8
| 0x4
| AmplitudeHigh
|-
|-
| 4 ||
| 0xC
|-
| 0x4
| 5 || FirmwareVersionRequested
| FrequencyHigh
|-
| 6 || FirmwareVersionIsInvalid
|-
| 7 || [4.0.0+] Ready
|-
| 8 || [4.0.0+] Setting
|}
|}


= IrSensorMode =
= VibrationGcErmCommand =
This is "nn::irsensor::detail::StatusManager::IrSensorMode".
This is "nn::hid::VibrationGcErmCommand".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Value
!  Name
!  Description
!  Description
|-
|-
| 0 || None
| 0 || Stop || Stops the vibration with a decay phase.
|-
|-
| 1 || [[#MomentProcessorState|MomentProcessor]]
| 1 || Start || Starts the vibration.
|-
|-
| 2 || [[#ClusteringProcessorState|ClusteringProcessor]]
| 2 || StopHard || Stops the vibration immediately, with no decay phase.
|-
| 3 || [[#ImageTransferProcessorState|ImageTransferProcessor]]
|-
| 4 || [[#PointingProcessorMarkerState|PointingProcessorMarker]]
|-
| 5 || [[#TeraPluginProcessorState|TeraPluginProcessor]]
|-
| 6 || Unknown
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 7,783: Line 8,267:
!  Description
!  Description
|-
|-
| 0 || Stopped
| 0 || Loose
|-
|-
| 1 || Running
| 1 || Tight
|}
|}


= ImageTransferProcessorFormat =
= GyroscopeZeroDriftMode =
This is "nn::irsensor::ImageTransferProcessorFormat".
This is "nn::hid::GyroscopeZeroDriftMode".
 
This controls the IR Sensor image resolution.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 7,797: Line 8,279:
!  Description
!  Description
|-
|-
| 0 || 320x240
| 0 || Loose
|-
|-
| 1 || 160x120
| 1 || Standard
|-
|-
| 2 || 80x60
| 2 || Tight
|-
| 3 || [4.0.0+] 40x30
|-
| 4 || [4.0.0+] 20x15
|}
|}


= MomentProcessorConfig =
= PalmaConnectionHandle =
This is "nn::irsensor::MomentProcessorConfig".
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"
Line 7,815: Line 8,296:
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x8 || ExposureTime (default is 0x493E0)
| 0x0 || 0x4 || [[#PalmaOperationType]]
|-
|-
| 0x8 || 0x4 || LightTarget (default is 0)
| 0x4 || 0x4 || Result
|-
|-
| 0xC || 0x4 || Gain (default is 0x8)
| 0x8 || 0x140 || Buffer for [[#GetPalmaOperationInfo]].
|}
 
= PalmaOperationType =
This is "nn::hid::PalmaOperationType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0x10 || 0x1 || IsNegativeImageUsed (default is 0)
| 0 || PlayActivity
|-
|-
| 0x11 || 0x7 || Reserved
| 1 || SetFrModeType
|-
|-
| 0x18 || 0x2 || WindowOfInterestX (default is 0)
| 2 || ReadStep
|-
|-
| 0x1A || 0x2 || WindowOfInterestY (default is 0)
| 3 || EnableStep
|-
|-
| 0x1C || 0x2 || WindowOfInterestWidth (default is 0x140)
| 4 || ResetStep
|-
|-
| 0x1E || 0x2 || WindowOfInterestHeight (default is 0xF0)
| 5 || ReadApplicationSection
|-
|-
| 0x20 || 0x4 || Preprocess (default is 0x1)
| 6 || WriteApplicationSection
|-
|-
| 0x24 || 0x4 || PreprocessIntensityThreshold (default is 0x50)
| 7 || ReadUniqueCode
|}
 
= PackedMomentProcessorConfig =
This is "nn::irsensor::PackedMomentProcessorConfig".
 
This is converted from [[#MomentProcessorConfig]].
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 8 || SetUniqueCodeInvalid
|-
|-
| 0x0 || 0x8 || ExposureTime (default is 0x493E0)
| 9 || WriteActivityEntry
|-
|-
| 0x8 || 0x1 || LightTarget (default is 0)
| 10 || WriteRgbLedPatternEntry
|-
|-
| 0x9 || 0x1 || Gain (default is 0x8)
| 11 || WriteWaveEntry
|-
|-
| 0xA || 0x1 || IsNegativeImageUsed (default is 0)
| 12 || ReadDataBaseIdentificationVersion
|-
|-
| 0xB || 0x5 || Reserved
| 13 || WriteDataBaseIdentificationVersion
|-
|-
| 0x10 || 0x2 || WindowOfInterestX (default is 0)
| 14 || SuspendFeature
|-
|-
| 0x12 || 0x2 || WindowOfInterestY (default is 0)
| 15 || [5.1.0+] ReadPlayLog
|-
|-
| 0x14 || 0x2 || WindowOfInterestWidth (default is 0x140)
| 16 || [5.1.0+] ResetPlayLog
|}
 
= PalmaFrModeType =
This is "nn::hid::PalmaFrModeType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0x16 || 0x2 || WindowOfInterestHeight (default is 0xF0)
| 0 || Off
|-
|-
| 0x18 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
| 1 || B01
|-
|-
| 0x1C || 0x1 || Preprocess (default is 0x1)
| 2 || B02
|-
|-
| 0x1D || 0x1 || PreprocessIntensityThreshold (default is 0x50)
| 3 || B03
|-
|-
| 0x1E || 0x2 || Reserved
| 4 || Downloaded
|}
|}


= ClusteringProcessorConfig =
= PalmaApplicationSectionAccessBuffer =
This is "nn::irsensor::ClusteringProcessorConfig".
This is "nn::hid::PalmaApplicationSectionAccessBuffer". This is a 0x100-byte struct.
 
= PalmaActivityEntry =
This is "nn::hid::PalmaActivityEntry".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 7,881: Line 8,373:
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x8 || ExposureTime (default is 200000)
| 0x0 || 0x2 || RgbLedPatternIndex.
|-
|-
| 0x8 || 0x4 || LightTarget (default is 0)
| 0x2 || 0x2 || Padding
|-
|-
| 0xC || 0x4 || Gain (default is 0x2)
| 0x4 || 0x4 || [[#PalmaWaveSet|WaveSet]].
|-
|-
| 0x10 || 0x1 || IsNegativeImageUsed (default is 0)
| 0x8 || 0x2 || WaveIndex.
|}
 
= PalmaWaveSet =
This is "nn::hid::PalmaWaveSet".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0x11 || 0x7 || Reserved
| 0 || Small
|-
|-
| 0x18 || 0x2 || WindowOfInterestX (default is 0)
| 1 || Medium
|-
|-
| 0x1A || 0x2 || WindowOfInterestY (default is 0)
| 2 || Large
|}
 
= PalmaFeature =
This is "nn::hid::PalmaFeature".
 
{| class="wikitable" border="1"
|-
|-
| 0x1C || 0x2 || WindowOfInterestWidth (default is 320)
! Bit
! Description
|-
|-
| 0x1E || 0x2 || WindowOfInterestHeight (default is 240)
| 0
| FrMode
|-
|-
| 0x20 || 0x4 || ObjectPixelCountMin (default is 0x3)
| 1
| RumbleFeedback
|-
|-
| 0x24 || 0x4 || ObjectPixelCountMax (default is 0x12C00)
| 2
| Step
|-
|-
| 0x28 || 0x4 || ObjectIntensityMin (default is 150)
| 3
| MuteSwitch
|-
|-
| 0x2C || 0x1 || IsExternalLightFilterEnabled (default is 0x1)
|}
|}


= PackedClusteringProcessorConfig =
= AbstractedPadState =
This is "nn::irsensor::PackedClusteringProcessorConfig".
 
This is converted from [[#ClusteringProcessorConfig]].
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x8 || ExposureTime
| 0x0 || 0x4 || Type, only 1 bit can be set. Converted to [[#HdlsDeviceInfo]]::type internally by [[#SetAutoPilotVirtualPadState]].
|-
|-
| 0x8 || 0x1 || LightTarget
| 0x4 || 0x1 || Flags. [[#SetAutoPilotVirtualPadState]] only uses bit0: when clear it will skip using the rest of the input and run [[#UnsetAutoPilotVirtualPadState]] internally.
|-
|-
| 0x9 || 0x1 || Gain
| 0x5 || 0x3 || Padding
|-
|-
| 0xA || 0x1 || IsNegativeImageUsed
| 0x8 || 0x4 || RGBA Single Body Color
|-
|-
| 0xB || 0x5 || Reserved
| 0xC || 0x4 || RGBA Single Buttons Color
|-
|-
| 0x10 || 0x2 || WindowOfInterestX
| 0x10 || 0x1 || See [[#HiddbgHdlsDeviceInfo]]::[[#NpadInterfaceType]].
|-
|-
| 0x12 || 0x2 || WindowOfInterestY
| 0x11 || 0x3 || Padding
|-
|-
| 0x14 || 0x2 || WindowOfInterestWidth
| 0x14 || 0x24 || [[#HdlsState]]. Unknown if the last 4-bytes are included in this struct, [[#SetAutoPilotVirtualPadState]]/[[#hiddbgGetAbstractedPadsState]] only uses the first 0x20-bytes.
|-
|-
| 0x16 || 0x2 || WindowOfInterestHeight
| 0x38 || 0x60 || Unused with [[#SetAutoPilotVirtualPadState]]/[[#GetAbstractedPadsState]].
|-
| 0x18 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
|-
| 0x1C || 0x4 || ObjectPixelCountMin
|-
| 0x20 || 0x4 || ObjectPixelCountMax
|-
| 0x24 || 0x1 || ObjectIntensityMin
|-
| 0x25 || 0x1 || IsExternalLightFilterEnabled
|-
| 0x26 || 0x2 || Reserved
|}
|}


= ImageTransferProcessorConfig =
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::irsensor::ImageTransferProcessorConfig".


Type:
{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Bits
!  [[#HdlsDeviceInfo]]::type bits
!  Description
!  Notes
|-
|-
! Offset || Size || Description
| 0 || 0 || ||
|-
| 1 || 15 || || [[#DeviceType]] |= BIT(1)
|-
| 2 || 1 || ||  
|-
|-
| 0x0 || 0x8 || ExposureTime
| 3 || 2 || ||  
|-
|-
| 0x8 || 0x4 || LightTarget
| 4 || 1 || ||  
|-
|-
| 0xC || 0x4 || Gain
| 5 || 2 || ||  
|-
|-
| 0x10 || 0x1 || IsNegativeImageUsed
| 6 || 3 || ||  
|-
|-
| 0x11 || 0x7 || Reserved
| 7 || 11 || || [[#DeviceType]] |= BIT(11)
|-
|-
| 0x18 || 0x4 || [[#ImageTransferProcessorFormat|Format]]
| 8 || 12 || || [[#DeviceType]] |= BIT(12)
|}
 
= PackedImageTransferProcessorConfig =
This is "nn::irsensor::PackedImageTransferProcessorConfig".
 
This is converted from [[#ImageTransferProcessorConfig]].
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 9 || 13 || || [[#DeviceType]] |= BIT(13)
|-
|-
| 0x0 || 0x8 || ExposureTime
| 10 || 14 || || [[#DeviceType]] |= BIT(14)
|-
|-
| 0x8 || 0x1 || LightTarget
| 11 || 15 || || [[#DeviceType]] |= BIT(11)
|-
|-
| 0x9 || 0x1 || Gain
| 12 || 12 || || [[#DeviceType]] |= BIT(12)
|-
|-
| 0xA || 0x1 || IsNegativeImageUsed
| 13 || 13 || || [[#DeviceType]] |= BIT(13)
|-
|-
| 0xB || 0x5 || Reserved
| 14 || 14 || || [[#DeviceType]] |= BIT(14)
|-
|-
| 0x10 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
| 15 || 17 || ||  
|-
|-
| 0x14 || 0x1 || [[#ImageTransferProcessorFormat|Format]]
| 31 || 21 || || [[#DeviceType]] = BIT(31)
|-
|-
| 0x15 || 0x3 || Reserved
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| [[#DebugPadAttributeSet|Attributes]]
|-
|-
| 0x0 || 0x8 || SamplingNumber
| 0x4
| 0x4
| [[#DebugPadButtonSet|Buttons]]
|-
|-
| 0x8 || 0x4 || AmbientNoiseLevel
| 0x8
| 0x8
| [[#AnalogStickState|AnalogStickL]]
|-
|-
| 0xC || 0x4 || Reserved
| 0x10
| 0x8
| [[#AnalogStickState|AnalogStickR]]
|}
|}


= TeraPluginProcessorConfig =
= MouseAutoPilotState =
This is "nn::irsensor::TeraPluginProcessorConfig".
This is "nn::hid::debug::MouseAutoPilotState".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset
! Size
! Description
|-
| 0x0
| 0x4
| X
|-
|-
| 0x0 || 0x1 || Mode
| 0x4
| 0x4
| Y
|-
| 0x8
| 0x4
| DeltaX
|-
| 0xC
| 0x4
| DeltaY
|-
|-
| 0x1 || 0x1 ||  
| 0x10
| 0x4
| WheelDelta
|-
|-
| 0x2 || 0x1 ||  
| 0x14
| 0x4
| [[#MouseButtonSet|Buttons]]
|-
|-
| 0x3 || 0x1 ||  
| 0x18
| 0x4
| [[#MouseAttributeSet|Attributes]]
|}
|}


= PackedTeraPluginProcessorConfig =
= KeyboardAutoPilotState =
This is "nn::irsensor::PackedTeraPluginProcessorConfig".
This is "nn::hid::debug::KeyboardAutoPilotState".
 
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"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset
! Size
! Description
|-
|-
| 0x0 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
| 0x0
| 0x8
| [[#KeyboardModifierSet|Modifiers]]
|-
|-
| 0x4 || 0x1 || Mode
| 0x8
|-
| 0x20
| 0x5 || 0x1 ||
| [[#KeyboardKeySet|Keys]]
|-
| 0x6 || 0x1 ||
|-
| 0x7 || 0x1 ||  
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset
|-
! Size
| 0x0 || 0x2 || WindowOfInterestX (default is 0)
! Description
|-
| 0x2 || 0x2 || WindowOfInterestY (default is 0)
|-
| 0x4 || 0x2 || WindowOfInterestWidth (default is 320)
|-
|-
| 0x6 || 0x2 || WindowOfInterestHeight (default is 240)
| 0x0 || 0x8 || Buttons (only bit0 is used)
|}
|}


= PackedPointingProcessorConfig =
= DigitizerAutoPilotState =
This is "nn::irsensor::PackedPointingProcessorConfig".
This is "nn::hid::debug::DigitizerAutoPilotState".
 
This is converted from [[#PointingProcessorConfig]].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset
|-
! Size
| 0x0 || 0x2 || WindowOfInterestX (default is 0)
! Description
|-
| 0x2 || 0x2 || WindowOfInterestY (default is 0)
|-
| 0x4 || 0x2 || WindowOfInterestWidth (default is 320)
|-
|-
| 0x6 || 0x2 || WindowOfInterestHeight (default is 240)
| 0x0 || 0x44 ||  
|-
| 0x8 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
|}
|}


= PackedMcuVersion =
= PowerInfo =
This is "nn::irsensor::PackedMcuVersion".
This is "nn::hidtypes::PowerInfo".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset
! Size
! Description
|-
|-
| 0x0 || 0x2 || MajorVersion
| 0x0 || 0x4 || BatteryLevel
|-
|-
| 0x2 || 0x2 || MinorVersion
| 0x4 || 0x4 || [[#PowerAttribute]]
|}
|}


== Versions ==
= PowerAttribute =
This is "nn::hidtypes::PowerAttribute". This is a 32-bit flag.
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Bits
!  Description
|-
|-
! MajorVersion || MinorVersion || SystemVersion
| 0
| IsPowered
|-
|-
| 0x3 || 0xB || [1.0.0+]
| 1
|-
| IsCharging
| 0x4 || 0x12 || [4.0.0+]
|-
| 0x5 || 0x18 || [5.0.0+]
|-
| 0x6 || 0x1A || [6.0.0+]
|-
| 0x8 || 0x1B || [8.0.0+]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Bits
!  Description
|-
|-
! Offset || Size || Description
| 0
| HasVirtualSixAxisSensorAcceleration
|-
|-
| 0x0 || 0x1 || [[#IrSensorFunctionLevel]]
| 1
|-
| HasVirtualSixAxisSensorAngle
| 0x1 || 0x3 || Reserved
|}
|}


== IrSensorFunctionLevel ==
= HdlsHandle =
This is "nn::irsensor::IrSensorFunctionLevel".
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"
{| class="wikitable" border="1"
|-
|-
! Value || SystemVersion
! Offset || Size || Description
|-
|-
| 0 || [1.0.0+]
| 0x0 || 0x4 || s32 Total entries
|-
|-
| 1 || [4.0.0+]
| 0x4 || 0x4 || Padding
|-
|-
| 2 || [5.0.0+]
| 0x8 || 0x200(0x20*0x10) || Array of [[#HdlsNpadAssignmentEntry]].
|-
| 3 || [6.0.0+]
|-
| 4 || [8.0.0+]
|}
|}


= ImageTransferProcessorExConfig =
= HdlsNpadAssignmentEntry =
This is "nn::irsensor::ImageTransferProcessorExConfig".
This is a 0x20-byte struct.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 8,147: Line 8,664:
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x8 || ExposureTime
| 0x0 || 0x8 || [[#HdlsHandle]]
|-
|-
| 0x8 || 0x4 || LightTarget
| 0x8 || 0x4 || ?
|-
|-
| 0xC || 0x4 || Gain
| 0xC || 0x4 || ?
|-
|-
| 0x10 || 0x1 || IsNegativeImageUsed
| 0x10 || 0x8 || ?
|-
|-
| 0x11 || 0x7 || Reserved
| 0x18 || 0x1 || ?
|-
|-
| 0x18 || 0x4 || [[#ImageTransferProcessorFormat|OrigFormat]]
| 0x19 || 0x7 || Padding
|-
| 0x1C || 0x4 || [[#ImageTransferProcessorFormat|TrimmingFormat]]
|-
| 0x20 || 0x2 || TrimmingStartX
|-
| 0x22 || 0x2 || TrimmingStartY
|-
| 0x24 || 0x1 || IsExternalLightFilterEnabled
|}
|}


= PackedImageTransferProcessorExConfig =
= HdlsStateList =
This is "nn::irsensor::PackedImageTransferProcessorExConfig".
This is a 0x408-byte struct.


This is converted from [[#ImageTransferProcessorExConfig]].
[9.0.0+] This is a 0x488-byte struct.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 8,177: Line 8,686:
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x8 || ExposureTime
| 0x0 || 0x4 || s32 Total entries
|-
|-
| 0x8 || 0x1 || LightTarget
| 0x4 || 0x4 || Padding
|-
|-
| 0x9 || 0x1 || Gain
| 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"
|-
|-
| 0xA || 0x1 || IsNegativeImageUsed
! Offset || Size || Description
|-
|-
| 0xB || 0x5 || Reserved
| 0x0 || 0x8 || [[#HdlsHandle]]
|-
|-
| 0x10 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
| 0x8 || [[#HdlsDeviceInfo]] size || [[#HdlsDeviceInfo]]. With [[#ApplyHdlsStateList]] this is only used when creating new devices.
|-
|-
| 0x14 || 0x1 || [[#ImageTransferProcessorFormat|OrigFormat]]
| 0x8 + [[#HdlsDeviceInfo]] size, with 8-byte alignment || 0x24 || [[#HdlsState]]
|-
|-
| 0x15 || 0x1 || [[#ImageTransferProcessorFormat|TrimmingFormat]]
| <Immediately following the above> || 0x4 || Padding
|-
| 0x16 || 0x2 || TrimmingStartX
|-
| 0x18 || 0x2 || TrimmingStartY
|-
| 0x1A || 0x1 || IsExternalLightFilterEnabled
|-
| 0x1B || 0x5 || Reserved
|}
|}


= IrLedProcessorConfig =
= HdlsDeviceInfo =
This is "nn::irsensor::IrLedProcessorConfig".
This is "nn::hid::debug::HdlsDeviceInfo". This is a 0x10-byte struct.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 8,209: Line 8,720:
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x4 || LightTarget
| 0x0 || 0x4 || [[#DeviceTypeInternal]]
|}
 
= PackedIrLedProcessorConfig =
This is "nn::irsensor::PackedIrLedProcessorConfig".
 
This is converted from [[#IrLedProcessorConfig]].
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 0x4 || 0x4 || RGBA Single Body Color
|-
|-
| 0x0 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
| 0x8 || 0x4 || RGBA Single Buttons Color
|-
|-
| 0x4 || 0x1 || LightTarget
| 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.
|-
|-
| 0x5 || 0x3 || Padding
| 0xD || 0x3 || Padding
|}
|}


= AdaptiveClusteringProcessorConfig =
[9.0.0+] This is a 0x14-byte struct.
This is "nn::irsensor::AdaptiveClusteringProcessorConfig".
 
AdaptiveClusteringProcessor was added with [5.0.0+].
 
This is converted to [[#TeraPluginProcessorConfig]] by the user-process. [[#TeraPluginProcessorConfig]]+0x3 is zero.
 
The default config is all-zero.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 8,241: Line 8,737:
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x4 || [[#AdaptiveClusteringMode]]
| 0x0 || 0x1 || [[#DeviceTypeInternal]]
|-
|-
| 0x4 || 0x4 || [6.0.0+] [[#AdaptiveClusteringTargetDistance]]
| 0x1 || 0x1 || [[#NpadInterfaceType]]. Similar to the field from the old struct.
|}
 
== AdaptiveClusteringMode ==
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || StaticFov
| 0x2 || 0x2 || Padding
|-
|-
| 1 || DynamicFov
| 0x4 || 0x4 || RGBA Single Body Color
|}
 
Controls the mode for [[#TeraPluginProcessorConfig]] (DynamicFov -> 0x10; StaticFov -> 0x0F).
 
== AdaptiveClusteringTargetDistance ==
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Near
| 0x8 || 0x4 || RGBA Single Buttons Color
|-
|-
| 1 || Middle
| 0xC || 0x4 || RGBA Left Grip Color
|-
|-
| 2 || Far
| 0x10 || 0x4 || RGBA Right Grip Color
|}
|}


Controls the second and third bytes for [[#TeraPluginProcessorConfig]] (Near-> 0x00, 0x00; Middle -> 0x01, 0x03; Far -> 0x01, 0x08).
= HdlsState =
 
This is "nn::hid::debug::HdlsState". This is a 0x24-byte struct.
= 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"
Line 8,283: Line 8,759:
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x4 || [[#HandAnalysisMode]]
| 0x0 || 0x1 || IsPowered for the main PowerInfo.
|}
|-
 
| 0x1 || 0x1 || ORRed with IsPowered to set the value of the first byte for the controller [[#NpadSystemProperties]].
== HandAnalysisMode ==
|-
{| class="wikitable" border="1"
| 0x2 || 0x6 || Unknown
!  Value
!  Description
|-
|-
| 0 || None (invalid)
| 0x8 || 0x4 || BatteryLevel for the main PowerInfo.
|-
|-
| 1 || Silhouette
| 0xC || 0x4 || [[#NpadButton|Buttons]]. Bit18 = HOME and bit19 = Capture.
|-
|-
| 2 || Image
| 0x10 || 0x10(4*2*2) || Joystick data.
|-
|-
| 3 || SilhouetteAndImage
| 0x20 || 0x1 || Indicator. Unused for input. Set with output from [[#DumpHdlsStates]] (zero in some cases).
|-
|-
| 4 || [4.0.0+] SilhouetteOnly
| 0x21 || 0x3 || Padding
|}
|}


= BusHandle =
[9.0.0+] (0x28-bytes):
This is "nn::hidbus::BusHandle".
{| class="wikitable" border="1"
 
|-
{| class="wikitable" border="1"
|-
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x4 || AbstractedPadId
| 0x0 || 0x8 || [[#PowerInfo]]
|-
|-
| 0x4 || 0x1 || InternalIndex
| 0x8 || 0x8 || [[#NpadButton|Buttons]], masked with 0xfffffffff00fffff. See above table regarding HOME/Capture buttons.
|-
|-
| 0x5 || 0x1 || PlayerNumber
| 0x10 || 0x10(4*2*2) || Joystick data.
|-
|-
| 0x6 || 0x1 || BusTypeId
| 0x20 || 0x1 || Indicator. Unused for input. Set with output from [[#DumpHdlsStates]] (zero in some cases).
|-
|-
| 0x7 || 0x1 || IsValid
| 0x21 || 0x7 || Padding
|}
|}


= JoyPollingReceivedData =
[12.0.0+] (0x40-bytes):
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
! Offset || Size || Description
|-
|-
| 0x0 || 0x30 || Data
| 0x0 || 0x8 || [[#PowerInfo]]
|-
| 0x8 || 0x8 || [[#NpadButton|Buttons]], masked with 0xfffffffff00fffff. See above table regarding HOME/Capture buttons.
|-
| 0x10 || 0x10(4*2*2) || Joystick data.
|-
|-
| 0x30 || 0x8 || OutSize
| 0x20 || 0xC || VirtualSixAxisSensorAcceleration
|-
|-
| 0x38 || 0x8 || SamplingNumber
| 0x2C || 0xC || VirtualSixAxisSensorAngle
|}
 
= BusType =
This is "nn::hidbus::BusType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || LeftJoyRail
| 0x38 || 0x4 || [[#HdlsAttribute]]
|-
|-
| 1 || RightJoyRail
| 0x3C || 0x1 || Indicator. Unused for input.
|-
|-
| 2 || [6.0.0+] RightLarkRail (for microphone)
| 0x3D || 0x3 || Padding
|}
|}


= JoyPollingMode =
= DebugRegisteredDevice =
This is "nn::hidbus::JoyPollingMode".
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"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || SixAxisSensorDisable
! Offset
! Size
! Description
|-
| 0x0
| 0x1
| TimeUnit
|-
|-
| 1 || SixAxisSensorEnable
| 0x1
| 0x1
| FrameCount
|-
|-
| 2 || ButtonOnly
| 0x2
|}
| 0x1
 
| CycleCount
Other values causes [[#EnableJoyPollingReceiveMode]] to assert.
|-
 
| 0x3
= ExternalDevices =
| 0x1
The following devices are used via hidbus:
| InitialBrightness
* [[Ring-Con]]
|-
* Famicom right controller (with microphone)
| 0x4
| 0x4 * 15
| [[#Frame|Frames]]
|-
| 0x40
| 0x1
| FinalBrightness
|-
| 0x41
| 0x1
| TimeTowardsFinalBrightness
|-
| 0x42
| 0x6
| Reserved
|}


= RomFS =
== Frame ==
The hid-sysmodule RomFS contains:
{| class="wikitable" border="1"
  ftmFwUpdate
|-
    ├── NTD_4CD_1801.fts256
! Offset
    ├── NTD_4CD_2602.fts256
! Size
    ├── NTD_4CD_3801.fts256
! Description
    └── NTD_4CD_xxxx.fts256 [7.0.0+]
|-
| 0x0
| 0x1
| Brightness
|-
| 0x1
| 0x1
| TimeTowards
|-
| 0x2
| 0x1
| TimeToHold
|-
| 0x3
| 0x1
| Reserved
|}


These are firmware files for the touchscreen controller.
= SystemButtonConfigEmbedded =
This is "nn::hid::system::ButtonConfigEmbedded". This is a 0x2C8-byte struct.


[9.0.0+] The hid-sysmodule RomFS now contains:
= SystemButtonConfigFull =
  ftmFwUpdate
This is "nn::hid::system::ButtonConfigFull". This is a 0x2C8-byte struct.
    ├── FTS_00120100.fts256
    ├── FTS_32000001.fts256
    ├── FTS_32000102.fts256
    ├── FTS_32000302.fts256
    └── FTS_32000402.fts256


= Firmware update =
= SystemButtonConfigLeft =
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.
This is "nn::hid::system::ButtonConfigLeft". This is a 0x1C8-byte struct.


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


These titles contain the following files:
{| class="wikitable" border="1"
* '''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.
! Offset || Size || Description
* '''ukyosakyo_ep2_ota.bin''' - Left/Right Joy-Con BT firmware.
|-
* '''raizo_ep2_ota.bin''' - Pro Controller BT firmware.
| 0x0 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonLeft]]
* '''tera_ota.bin''' - Right Joy-Con MCU firmware.  
|-
* '''tera_ota_iap.bin''' - Right Joy-Con MCU (IAP profile) firmware.
| 0x4 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonUp]]
* '''tera_fullkey_ota.bin''' - Pro Controller MCU firmware.
|-
* '''tera_fullkey_ota_iap.bin''' - Pro Controller MCU (IAP profile) firmware.
| 0x8 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonRight]]
* [6.0.0+] '''ProController.dfu''' - Pro Controller USB firmware.
|-
* [6.1.0+] '''PalmaFw.bin''' - Poké Ball Plus BT firmware.
| 0xC || 0x4 || [[#DigitalButtonAssignment|HardwareButtonDown]]
* [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.
| 0x10 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonA]]
* [9.0.0+] '''sioh.bin''' - Switch Lite Joy-Con firmware.
|-
* [9.0.0+] '''sioh_iap.bin''' - Switch Lite Joy-Con (IAP profile) firmware.
| 0x14 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonB]]
* [10.0.0+] '''FTS_00120100.fts256'''
|-
* [10.0.0+] '''FTS_32000001.fts256'''
| 0x18 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonX]]
* [10.0.0+] '''FTS_32000102.fts256'''
|-
* [10.0.0+] '''FTS_32000302.fts256'''
| 0x1C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonY]]
* [10.0.0+] '''FTS_32000402.fts256'''
|-
* [10.0.0+] '''TouchScreenConfiguration.csv'''
| 0x20 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStickL]]
|-
| 0x24 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStickR]]
|-
| 0x28 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonL]]
|-
| 0x2C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonR]]
|-
| 0x30 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonZL]]
|-
| 0x34 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonZR]]
|-
| 0x38 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonSelect]]
|-
| 0x3C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStart]]
|-
| 0x40 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonCapture]]
|-
| 0x44 || 0x8 || [[#AnalogStickAssignment|HardwareStickL]]
|-
| 0x4C || 0x8 || [[#AnalogStickAssignment|HardwareStickR]]
|}
 
== DigitalButtonAssignment ==
This is "nn::hidconfig::DigitalButtonAssignment".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || A
|-
| 1 || B
|-
| 2 || X
|-
| 3 || Y
|-
| 4 || StickL
|-
| 5 || StickR
|-
| 6 || L
|-
| 7 || R
|-
| 8 || ZL
|-
| 9 || ZR
|-
| 10 || Select
|-
| 11 || Start
|-
| 12 || Left
|-
| 13 || Up
|-
| 14 || Right
|-
| 15 || Down
|-
| 16 || LeftSL
|-
| 17 || LeftSR
|-
| 18 || RightSL
|-
| 19 || RightSR
|-
| 20 || HomeButton
|-
| 21 || CaptureButton
|-
| 22 || Invalid
|}
 
== AnalogStickAssignment ==
This is "nn::hidconfig::AnalogStickAssignment".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || [[#AnalogStickRotation]]
|-
| 0x4 || 0x1 || IsPairedStickAssigned
|-
| 0x5 || 0x3 || Reserved
|}
 
== AnalogStickRotation ==
This is "nn::hidconfig::AnalogStickRotation".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || None
|-
| 1 || Clockwise90
|-
| 2 || Anticlockwise90
|}
 
= ButtonConfigFull =
This is "nn::hidconfig::ButtonConfigFull". This is a 0x54-byte struct.
 
This is identical to [[#ButtonConfigEmbedded]].
 
= ButtonConfigLeft =
This is "nn::hidconfig::ButtonConfigLeft". This is a 0x34-byte struct.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonLeft]]
|-
| 0x4 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonUp]]
|-
| 0x8 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonRight]]
|-
| 0xC || 0x4 || [[#DigitalButtonAssignment|HardwareButtonDown]]
|-
| 0x10 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStickL]]
|-
| 0x14 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonL]]
|-
| 0x18 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonZL]]
|-
| 0x1C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonSelect]]
|-
| 0x20 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonLeftSL]]
|-
| 0x24 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonLeftSR]]
|-
| 0x28 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonCapture]]
|-
| 0x2C || 0x8 || [[#AnalogStickAssignment|HardwareStickL]]
|}
 
= ButtonConfigRight =
This is "nn::hidconfig::ButtonConfigRight". This is a 0x30-byte struct.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonA]]
|-
| 0x4 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonB]]
|-
| 0x8 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonX]]
|-
| 0xC || 0x4 || [[#DigitalButtonAssignment|HardwareButtonY]]
|-
| 0x10 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStickR]]
|-
| 0x14 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonR]]
|-
| 0x18 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonZR]]
|-
| 0x1C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStart]]
|-
| 0x20 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonRightSL]]
|-
| 0x24 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonRightSR]]
|-
| 0x28 || 0x8 || [[#AnalogStickAssignment|HardwareStickR]]
|}
 
= StorageName =
This is "nn::hidconfig::StorageName". This is a 0x81-byte struct.
 
This is an UTF-8 NUL-terminated name string.
 
= InterfaceType =
This is "nn::hidtypes::InterfaceType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 1 || Bluetooth
|-
| 2 || Rail
|-
| 3 || Usb
|-
| 4 || Embedded
|}
 
= DigitalButton =
This is "nn::hidtypes::DigitalButton". This is a 64-bit flag.
 
{| class="wikitable" border="1"
|-
! Bit
! Description
|-
| 0
| A
|-
| 1
| B
|-
| 2
| X
|-
| 3
| Y
|-
| 4
| StickL
|-
| 5
| StickR
|-
| 6
| L
|-
| 7
| R
|-
| 8
| ZL
|-
| 9
| ZR
|-
| 10
| Start
|-
| 11
| Select
|-
| 12
| Left
|-
| 13
| Up
|-
| 14
| Right
|-
| 15
| Down
|-
| 16
| SL
|-
| 17
| SR
|-
| 18
| Home
|-
| 19
| Shot
|-
| 20
| StickLLeft
|-
| 21
| StickLUp
|-
| 22
| StickLRight
|-
| 23
| StickLDown
|-
| 24
| StickRLeft
|-
| 25
| StickRUp
|-
| 26
| StickRRight
|-
| 27
| StickRDown
|-
| 28
| Palma
|-
| 29
| HandheldLeftB
|-
| 30
| Plus
|-
| 31
| Minus
|-
| 32
| Z
|-
| 33
| LeftSL
|-
| 34
| LeftSR
|-
| 35
| RightSL
|-
| 36
| RightSR
|-
| 37
| LeftC
|-
| 38
| UpC
|-
| 39
| RightC
|-
| 40
| DownC
|}
 
= AssignmentStyle =
This is "nn::hidtypes::AssignmentStyle". This is a 32-bit flag.
 
{| class="wikitable" border="1"
|-
! Bit
! Description
|-
| 0
| IsExternalAssigned
|-
| 1
| IsExternalLeftAssigned
|-
| 2
| IsExternalRightAssigned
|-
| 3
| IsHandheldAssigned
|-
| 4
| IsHandheldLeftAssigned
|-
| 5
| IsHandheldRightAssigned
|}
 
= FeatureType =
This is "nn::hidtypes::FeatureType". This is a 64-bit flag.
 
{| class="wikitable" border="1"
|-
! Bit
! Description
|-
| 0
| HasLeftAnalogStick
|-
| 1
| HasRightAnalogStick
|-
| 2
| HasLeftJoySixAxisSensor
|-
| 3
| HasRightJoySixAxisSensor
|-
| 4
| HasFullKeySixAxisSensor
|-
| 5
| HasLeftLraVibrationDevice
|-
| 6
| HasRightLraVibrationDevice
|-
| 7
| HasGcVibrationDevice
|-
| 8
| HasErmVibrationDevice
|-
| 9
| HasLeftJoyRailBus
|-
| 10
| HasRightJoyRailBus
|-
| 11
| HasInternalBus
|-
| 12
| IsPalma
|-
| 13
| HasNfc
|-
| 14
| HasIrSensor
|-
| 15
| IsAnalogStickCalibrationSupported
|-
| 16
| IsSixAxisSensorUserCalibrationSupported
|-
| 17
| HasLeftJoyRightJoyBattery
|-
| 18
| HasFullKeyBattery
|-
| 19
| IsDisconnectControllerIfBatteryNone
|-
| 20
| HasControllerColor
|-
| 21
| HasGripColor
|-
| 22
| HasIdentificationCode
|-
| 23
| HasBluetoothAddress
|-
| 24
| HasMcu
|-
| 25
| HasNotificationLed
|-
| 26
| HasDirectionalButtons
|-
| 27
| HasIndicatorLed
|-
| 28
| IsButtonConfigEmbeddedSupported
|-
| 29
| IsButtonConfigFullSupported
|-
| 30
| IsButtonConfigLeftSupported
|-
| 31
| IsButtonConfigRightSupported
|-
| 32
| IsUsbHidDevice
|-
| 33
| IsKuinaDevice
|-
| 34
| IsDirectUsbToBtSwitchingDevice
|-
| 35
| IsNormalizeAnalogStickWithInnerCross
|}
 
= Color =
This is "nn::hidtypes::Color".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || BodyColor
|-
| 0x4 || 0x4 || ButtonColor
|-
| 0x8 || 0x4 || LeftGripColor
|-
| 0xC || 0x4 || RightGripColor
|}
 
= DeviceDescriptorType =
This is "nn::hidtypes::DeviceDescriptorType".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x1 || [[#DeviceTypeInternal|DeviceType]]
|-
| 0x1 || 0x7 || Reserved
|-
| 0x8 || 0x8 || [[#FeatureType|FeatureType]]
|-
| 0x10 || 0x8 || [[#DigitalButton|DigitalButton]]
|-
| 0x18 || 0x4 || [[#AssignmentStyle|AssignmentStyle]]
|-
| 0x1C || 0x10 || [[#Color|DeviceColor]]
|-
| 0x2C || 0x4 || Reserved
|}
 
= DeviceDescriptionList =
This is "nn::hidtypes::detail::DeviceDescriptionList". This is a list of [[#DeviceDescriptorType|DeviceDescriptorType]] objects maintained by the hid-sysmodule.
 
{| class="wikitable" border="1"
|-
! [[#DeviceTypeInternal|DeviceType]] || [[#FeatureType|FeatureType]] || [[#DigitalButton|DigitalButton]] || [[#AssignmentStyle|AssignmentStyle]] || [[#Color|DeviceColor]]
|-
| 1 || 0x18BDBE44A || 0x18F0406AF || 0x24 || 0xFF828282, 0xFF0F0F0F, 0x00000000, 0x00000000
|-
| 2 || 0x14CDB8225 || 0x6F8F950 || 0x12 || 0xFF828282, 0xFF0F0F0F, 0x00000000, 0x00000000
|-
| 3 || 0x72BBDA073 || 0xFFCFFFF || 0x1 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|-
| 4 || 0x108000025 || 0x6F8F950 || 0x2 || 0xFF828282, 0xFF0F0F0F, 0x00000000, 0x00000000
|-
| 5 || 0x10800004A || 0x18F0406AF || 0x4 || 0xFF828282, 0xFF0F0F0F, 0x00000000, 0x00000000
|-
| 6 || 0x108800013 || 0xFFCFFFF || 0x1 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|-
| 7 || 0x108CA0000 || 0x2008FCC3 || 0x11 || 0xFF322891, 0xFFFFFFFF, 0x00000000, 0x00000000
|-
| 8 || 0x108CA0800 || 0x4F0C3 || 0x21 || 0xFF322891, 0xFFFFFFFF, 0x00000000, 0x00000000
|-
| 9 || 0x108CA0000 || 0x2008FCC3 || 0x11 || 0xFFD9D7D7, 0xFFFFFFFF, 0x00000000, 0x00000000
|-
| 10 || 0x108CA0000 || 0x4FCC3 || 0x21 || 0xFFD9D7D7, 0xFFFFFFFF, 0x00000000, 0x00000000
|-
| 11 || 0x700CC0000 || 0xFFCF || 0x0 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|-
| 12 || 0x841011 || 0x10000010 || 0x1 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|-
| 13 || 0x83 || 0xFF0F6CF || 0x1 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|-
| 14 || 0x1 || 0xF8F950 || 0x10 || 0xFF828282, 0xFF0F0F0F, 0x00000000, 0x00000000
|-
| 15 || 0x3 || 0xFFCFFFF || 0x1 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|-
| 16 || 0x3 || 0xFFCFFFF || 0x1 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|-
| 17 || 0x1001A013 || 0xFFCFFFF || 0x8 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|-
| 18 || 0x2 || 0xF0406AF || 0x20 || 0xFF828282, 0xFF0F0F0F, 0x00000000, 0x00000000
|-
| 19 || 0x1088DA073 || 0xFFCF3FF || 0x1 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|-
| 20 || 0x108CA0025 || 0x6F8F150 || 0x12 || 0xFF828282, 0xFF0F0F0F, 0x00000000, 0x00000000
|-
| 21 || 0x108CA604A || 0x18F0402AF || 0x24 || 0xFF828282, 0xFF0F0F0F, 0x00000000, 0x00000000
|-
| [12.0.0+] 22 || 0xF00CC8101 || 0x1E1FCF6C3 || 0x1 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|-
| [12.0.0+] 23 || 0x100000000 || 0x0 || 0x0 || 0x00000000, 0x00000000, 0x00000000, 0x00000000
|-
| [13.0.0+] 28 || 0x700CC0000 || 0xCF6CF || 0x1 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|-
| [14.0.0+] 30 || 0x108800003 || 0xFFCFFFF || 0x1 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|}
 
= UnmaskFeatureDescriptorType =
This is "nn::hid::server::UnmaskFeatureDescriptorType".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x1 || [[#DeviceTypeInternal|DeviceType]]
|-
| 0x1 || 0x1 || [[#InterfaceType|InterfaceType]]
|-
| 0x2 || 0x6 || Reserved
|-
| 0x8 || 0x8 || [[#FeatureType|FeatureType]]
|}
 
= UnmaskFeatureDescriptorList =
This is "nn::hid::server::UnmaskFeatureDescriptorList". This is a list of [[#UnmaskFeatureDescriptorType|UnmaskFeatureDescriptorType]] objects maintained by the hid-sysmodule.
 
{| class="wikitable" border="1"
|-
! [[#DeviceTypeInternal|DeviceType]] || [[#InterfaceType|InterfaceType]] || [[#FeatureType|FeatureType]]
|-
| 3 || 3 || 0x2000
|-
| 2 || 2 || 0x200
|-
| 1 || 2 || 0x400
|-
| 19 || 3 || 0x2000
|-
| 2 || 3 || 0x200
|-
| 1 || 3 || 0x6400
|}
 
= FirmwareVersionInfo =
This is "nn::hidtypes::FirmwareVersionInfo".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || [[#FirmwareVersionAttribute|FirmwareVersionAttribute]]
|-
| 0x4 || 0x2 ||
|-
| 0x6 || 0x2 || MajorVersion
|-
| 0x8 || 0x2 || MinorVersion
|-
| 0xA || 0x2 ||
|}
 
= FirmwareVersionAttribute =
This is "nn::hidtypes::FirmwareVersionAttribute". This is a 32-bit flag.
 
{| class="wikitable" border="1"
|-
! Bit
! Description
|-
| 0
| IsCustomerCodeCorruption
|-
| 1
| IsIapCorrupted
|}
 
= IrCameraHandle =
This is "nn::irsensor::IrCameraHandle".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x1 || PlayerNumber
|-
| 0x1 || 0x1 || DeviceType
|-
| 0x2 || 0x2 || Reserved
|}
 
= IrCameraStatus =
This is "nn::irsensor::IrCameraStatus".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || Available
|-
| 1 || Unsupported
|-
| 2 || Unconnected
|}
 
= IrCameraInternalStatus =
This is "nn::irsensor::IrCameraInternalStatus".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || Stopped
|-
| 1 || FirmwareUpdateNeeded
|-
| 2 ||
|-
| 3 ||
|-
| 4 ||
|-
| 5 || FirmwareVersionRequested
|-
| 6 || FirmwareVersionIsInvalid
|-
| 7 || [4.0.0+] Ready
|-
| 8 || [4.0.0+] Setting
|}
 
= IrSensorMode =
This is "nn::irsensor::detail::StatusManager::IrSensorMode".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || None
|-
| 1 || [[#MomentProcessorState|MomentProcessor]]
|-
| 2 || [[#ClusteringProcessorState|ClusteringProcessor]]
|-
| 3 || [[#ImageTransferProcessorState|ImageTransferProcessor]]
|-
| 4 || [[#PointingProcessorMarkerState|PointingProcessorMarker]]
|-
| 5 || [[#TeraPluginProcessorState|TeraPluginProcessor]]
|-
| 6 || Unknown
|}
 
= ImageProcessorStatus =
This is "nn::irsensor::ImageProcessorStatus".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || Stopped
|-
| 1 || Running
|}
 
= ImageTransferProcessorFormat =
This is "nn::irsensor::ImageTransferProcessorFormat".
 
This controls the IR Sensor image resolution.
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || 320x240
|-
| 1 || 160x120
|-
| 2 || 80x60
|-
| 3 || [4.0.0+] 40x30
|-
| 4 || [4.0.0+] 20x15
|}
 
= MomentProcessorConfig =
This is "nn::irsensor::MomentProcessorConfig".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || ExposureTime (default is 0x493E0)
|-
| 0x8 || 0x4 || LightTarget (default is 0)
|-
| 0xC || 0x4 || Gain (default is 0x8)
|-
| 0x10 || 0x1 || IsNegativeImageUsed (default is 0)
|-
| 0x11 || 0x7 || Reserved
|-
| 0x18 || 0x2 || WindowOfInterestX (default is 0)
|-
| 0x1A || 0x2 || WindowOfInterestY (default is 0)
|-
| 0x1C || 0x2 || WindowOfInterestWidth (default is 0x140)
|-
| 0x1E || 0x2 || WindowOfInterestHeight (default is 0xF0)
|-
| 0x20 || 0x4 || Preprocess (default is 0x1)
|-
| 0x24 || 0x4 || PreprocessIntensityThreshold (default is 0x50)
|}
 
= PackedMomentProcessorConfig =
This is "nn::irsensor::PackedMomentProcessorConfig".
 
This is converted from [[#MomentProcessorConfig]].
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || ExposureTime (default is 0x493E0)
|-
| 0x8 || 0x1 || LightTarget (default is 0)
|-
| 0x9 || 0x1 || Gain (default is 0x8)
|-
| 0xA || 0x1 || IsNegativeImageUsed (default is 0)
|-
| 0xB || 0x5 || Reserved
|-
| 0x10 || 0x2 || WindowOfInterestX (default is 0)
|-
| 0x12 || 0x2 || WindowOfInterestY (default is 0)
|-
| 0x14 || 0x2 || WindowOfInterestWidth (default is 0x140)
|-
| 0x16 || 0x2 || WindowOfInterestHeight (default is 0xF0)
|-
| 0x18 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
|-
| 0x1C || 0x1 || Preprocess (default is 0x1)
|-
| 0x1D || 0x1 || PreprocessIntensityThreshold (default is 0x50)
|-
| 0x1E || 0x2 || Reserved
|}
 
= ClusteringProcessorConfig =
This is "nn::irsensor::ClusteringProcessorConfig".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || ExposureTime (default is 200000)
|-
| 0x8 || 0x4 || LightTarget (default is 0)
|-
| 0xC || 0x4 || Gain (default is 0x2)
|-
| 0x10 || 0x1 || IsNegativeImageUsed (default is 0)
|-
| 0x11 || 0x7 || Reserved
|-
| 0x18 || 0x2 || WindowOfInterestX (default is 0)
|-
| 0x1A || 0x2 || WindowOfInterestY (default is 0)
|-
| 0x1C || 0x2 || WindowOfInterestWidth (default is 320)
|-
| 0x1E || 0x2 || WindowOfInterestHeight (default is 240)
|-
| 0x20 || 0x4 || ObjectPixelCountMin (default is 0x3)
|-
| 0x24 || 0x4 || ObjectPixelCountMax (default is 0x12C00)
|-
| 0x28 || 0x4 || ObjectIntensityMin (default is 150)
|-
| 0x2C || 0x1 || IsExternalLightFilterEnabled (default is 0x1)
|}
 
= PackedClusteringProcessorConfig =
This is "nn::irsensor::PackedClusteringProcessorConfig".
 
This is converted from [[#ClusteringProcessorConfig]].
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || ExposureTime
|-
| 0x8 || 0x1 || LightTarget
|-
| 0x9 || 0x1 || Gain
|-
| 0xA || 0x1 || IsNegativeImageUsed
|-
| 0xB || 0x5 || Reserved
|-
| 0x10 || 0x2 || WindowOfInterestX
|-
| 0x12 || 0x2 || WindowOfInterestY
|-
| 0x14 || 0x2 || WindowOfInterestWidth
|-
| 0x16 || 0x2 || WindowOfInterestHeight
|-
| 0x18 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
|-
| 0x1C || 0x4 || ObjectPixelCountMin
|-
| 0x20 || 0x4 || ObjectPixelCountMax
|-
| 0x24 || 0x1 || ObjectIntensityMin
|-
| 0x25 || 0x1 || IsExternalLightFilterEnabled
|-
| 0x26 || 0x2 || Reserved
|}
 
= ImageTransferProcessorConfig =
This is "nn::irsensor::ImageTransferProcessorConfig".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || ExposureTime
|-
| 0x8 || 0x4 || LightTarget
|-
| 0xC || 0x4 || Gain
|-
| 0x10 || 0x1 || IsNegativeImageUsed
|-
| 0x11 || 0x7 || Reserved
|-
| 0x18 || 0x4 || [[#ImageTransferProcessorFormat|Format]]
|}
 
= PackedImageTransferProcessorConfig =
This is "nn::irsensor::PackedImageTransferProcessorConfig".
 
This is converted from [[#ImageTransferProcessorConfig]].
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || ExposureTime
|-
| 0x8 || 0x1 || LightTarget
|-
| 0x9 || 0x1 || Gain
|-
| 0xA || 0x1 || IsNegativeImageUsed
|-
| 0xB || 0x5 || Reserved
|-
| 0x10 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
|-
| 0x14 || 0x1 || [[#ImageTransferProcessorFormat|Format]]
|-
| 0x15 || 0x3 || Reserved
|}
 
= ImageTransferProcessorState =
This is "nn::irsensor::ImageTransferProcessorState".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || SamplingNumber
|-
| 0x8 || 0x4 || AmbientNoiseLevel
|-
| 0xC || 0x4 || Reserved
|}
 
= TeraPluginProcessorConfig =
This is "nn::irsensor::TeraPluginProcessorConfig".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x1 || Mode
|-
| 0x1 || 0x1 ||
|-
| 0x2 || 0x1 ||
|-
| 0x3 || 0x1 ||
|}
 
= PackedTeraPluginProcessorConfig =
This is "nn::irsensor::PackedTeraPluginProcessorConfig".
 
This is converted from [[#TeraPluginProcessorConfig]]. The data starting at offset 0x5 is only initialized by the user-process with [6.0.0+].
 
[[#TeraPluginProcessorConfig]] +0x0, +0x2, and +0x3 are copied to +0x4, 0x6, and +0x7 here. +0x5 here is set to 0x2 | ([[#TeraPluginProcessorConfig]]+0x1 << 7).
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
|-
| 0x4 || 0x1 || Mode
|-
| 0x5 || 0x1 ||
|-
| 0x6 || 0x1 ||
|-
| 0x7 || 0x1 ||
|}
 
= PointingProcessorConfig =
This is "nn::irsensor::PointingProcessorConfig".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x2 || WindowOfInterestX (default is 0)
|-
| 0x2 || 0x2 || WindowOfInterestY (default is 0)
|-
| 0x4 || 0x2 || WindowOfInterestWidth (default is 320)
|-
| 0x6 || 0x2 || WindowOfInterestHeight (default is 240)
|}
 
= PackedPointingProcessorConfig =
This is "nn::irsensor::PackedPointingProcessorConfig".
 
This is converted from [[#PointingProcessorConfig]].
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x2 || WindowOfInterestX (default is 0)
|-
| 0x2 || 0x2 || WindowOfInterestY (default is 0)
|-
| 0x4 || 0x2 || WindowOfInterestWidth (default is 320)
|-
| 0x6 || 0x2 || WindowOfInterestHeight (default is 240)
|-
| 0x8 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
|}
 
= PackedMcuVersion =
This is "nn::irsensor::PackedMcuVersion".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x2 || MajorVersion
|-
| 0x2 || 0x2 || MinorVersion
|}
 
== Versions ==
{| class="wikitable" border="1"
|-
! MajorVersion || MinorVersion || SystemVersion
|-
| 0x3 || 0xB || [1.0.0+]
|-
| 0x4 || 0x12 || [4.0.0+]
|-
| 0x5 || 0x18 || [5.0.0+]
|-
| 0x6 || 0x1A || [6.0.0+]
|-
| 0x8 || 0x1B || [8.0.0+]
|}
 
= PackedFunctionLevel =
This is nn::irsensor::PackedFunctionLevel.
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x1 || [[#IrSensorFunctionLevel]]
|-
| 0x1 || 0x3 || Reserved
|}
 
== IrSensorFunctionLevel ==
This is "nn::irsensor::IrSensorFunctionLevel".
 
{| class="wikitable" border="1"
|-
! Value || SystemVersion
|-
| 0 || [1.0.0+]
|-
| 1 || [4.0.0+]
|-
| 2 || [5.0.0+]
|-
| 3 || [6.0.0+]
|-
| 4 || [8.0.0+]
|}
 
= ImageTransferProcessorExConfig =
This is "nn::irsensor::ImageTransferProcessorExConfig".
 
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x8 || ExposureTime
|-
| 0x8 || 0x4 || LightTarget
|-
| 0xC || 0x4 || Gain
|-
| 0x10 || 0x1 || IsNegativeImageUsed
|-
| 0x11 || 0x7 || Reserved
|-
| 0x18 || 0x4 || [[#ImageTransferProcessorFormat|OrigFormat]]
|-
| 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.
* '''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'''
* [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
|-
| [11.0.0+]
| 0407
|-
| [12.1.0+]
| 0410
|-
| [13.0.0+]
| 0417
|-
| [14.0.0+]
| 0419
|}
=== Raizo ===
{| class="wikitable" border="1"
|-
! SystemVersion
! FirmwareVersion
|-
| [1.0.0+]
| 0348
|-
| [15.0.0+]
| 0421
|}
=== Tera ===
{| class="wikitable" border="1"
|-
! SystemVersion
! FirmwareVersion
|-
| [1.0.0+]
| 030B
|-
| [4.0.0+]
| 0412
|-
| [5.0.0+]
| 0518
|-
| [6.0.0+]
| 061A
|-
| [8.0.0+]
| 081B
|}
=== TeraFullKey ===
{| class="wikitable" border="1"
|-
! SystemVersion
! FirmwareVersion
|-
| [1.0.0+]
| 0305
|}
=== ProController ===
{| class="wikitable" border="1"
|-
! SystemVersion
! FirmwareVersion
|-
| -
| 010A0200
|-
| [6.0.0+]
| 01100210
|}
=== Palma ===
{| class="wikitable" border="1"
|-
! SystemVersion
! FirmwareVersion
|-
| -
| 1100
|-
| [6.1.0+]
| 1200
|}
=== SioH ===
{| class="wikitable" border="1"
|-
! SystemVersion
! FirmwareVersion
|-
| -
| 000D
|-
| [8.1.1+]
| 0200
|-
| [10.0.0+]
| 0301
|-
| [11.0.0+]
| 0304
|}


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