Nintendo Switch Brew

HID services: Difference between revisions

← Older edit
No edit summary
 
(66 intermediate revisions by 3 users not shown)
Line 13: Line 13:
|-
|-
| 21 || [[#ActivateMouse]]
| 21 || [[#ActivateMouse]]
|-
| 22 || [19.0.0+] AddMouseWheelDelta
|-
| 26 || [16.0.0+] ActivateDebugMouse
|-
|-
| 31 || [[#ActivateKeyboard]]
| 31 || [[#ActivateKeyboard]]
Line 80: Line 84:
| 83 || [6.0.0+] [[#IsFirmwareUpdateAvailableForSixAxisSensor]]
| 83 || [6.0.0+] [[#IsFirmwareUpdateAvailableForSixAxisSensor]]
|-
|-
| 84 || [13.0.0+] EnableSixAxisSensorUnalteredPassthrough
| 84 || [13.0.0+] [[#EnableSixAxisSensorUnalteredPassthrough]]
|-
|-
| 85 || [13.0.0+] IsSixAxisSensorUnalteredPassthroughEnabled
| 85 || [13.0.0+] [[#IsSixAxisSensorUnalteredPassthroughEnabled]]
|-
|-
| 86 || [13.0.0+] StoreSixAxisSensorCalibrationParameter
| 86 || [13.0.0+] [[#StoreSixAxisSensorCalibrationParameter]]
|-
|-
| 87 || [13.0.0+] LoadSixAxisSensorCalibrationParameter
| 87 || [13.0.0+] [[#LoadSixAxisSensorCalibrationParameter]]
|-
|-
| 88 || [13.0.0+] GetSixAxisSensorIcInformation
| 88 || [13.0.0+] [[#GetSixAxisSensorIcInformation]]
|-
|-
| 89 || [13.0.0+] ResetIsSixAxisSensorDeviceNewlyAssigned
| 89 || [13.0.0+] [[#ResetIsSixAxisSensorDeviceNewlyAssigned]]
|-
|-
| 91 || [[#ActivateGesture]]
| 91 || [[#ActivateGesture]]
|-
| 92 || [18.0.0+] SetGestureOutputRanges
|-
|-
| 100 || [[#SetSupportedNpadStyleSet]]
| 100 || [[#SetSupportedNpadStyleSet]]
Line 145: Line 151:
|-
|-
| 136 || [8.0.0+] [[#ClearNpadCaptureButtonAssignment]]
| 136 || [8.0.0+] [[#ClearNpadCaptureButtonAssignment]]
|-
| 137 || [20.0.0+] SetNpadGcAnalogStick8bitRawValue
|-
| 138 || [S2]
|-
| 139 || [S2]
|-
|-
| 200 || [[#GetVibrationDeviceInfo]]
| 200 || [[#GetVibrationDeviceInfo]]
Line 171: Line 183:
|-
|-
| 212 || [11.0.0+] [[#SendVibrationValueInBool]]
| 212 || [11.0.0+] [[#SendVibrationValueInBool]]
|-
| 213 || [17.0.0+] SendVibrationValueInMode
|-
| 214 || [17.0.0+] SendVibrationValuesInMode
|-
| 220 || [S2]
|-
|-
| 300 || [3.0.0+] [[#ActivateConsoleSixAxisSensor]]
| 300 || [3.0.0+] [[#ActivateConsoleSixAxisSensor]]
Line 193: Line 211:
|-
|-
| 310 || [6.0.0+] [[#ResetSevenSixAxisSensorTimestamp]]
| 310 || [6.0.0+] [[#ResetSevenSixAxisSensorTimestamp]]
|-
| 311 || [17.0.0+] ForceActivateConsoleSixAxisSensor
|-
| 312 || [17.0.0+] ForceDeactivateConsoleSixAxisSensor
|-
| 320 || [21.0.0+] EnableNpadImu
|-
| 321 || [21.0.0+] DisableNpadImu
|-
|-
| 400 || [3.0.0+] [[#IsUsbFullKeyControllerEnabled]]
| 400 || [3.0.0+] [[#IsUsbFullKeyControllerEnabled]]
Line 271: Line 297:
|-
|-
| 529 || [8.0.0+] [[#SetDisallowedPalmaConnection]]
| 529 || [8.0.0+] [[#SetDisallowedPalmaConnection]]
|-
| 550 || [S2]
|-
|-
| 1000 || [[#SetNpadCommunicationMode]]
| 1000 || [[#SetNpadCommunicationMode]]
Line 279: Line 307:
|-
|-
| 1003 || [9.0.0+] [[#IsFirmwareUpdateNeededForNotification]]
| 1003 || [9.0.0+] [[#IsFirmwareUpdateNeededForNotification]]
|-
| 1004 || [20.0.0+] [[#SetTouchScreenOutputRanges|SetTouchScreenOutputRanges]] ([17.0.0-19.0.1] SetTouchScreenResolution)
|-
| 1005 || [20.0.0+] EnableNxTouchScreenEmulationForTouchEnter
|-
|-
| 2000 || [10.0.0+] [[#ActivateDigitizer]]
| 2000 || [10.0.0+] [[#ActivateDigitizer]]
|-
|-
| 3000 || [15.0.0+]
| 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
|-
| 3012 || [21.0.0+] GetDebugPadGenericPadMap
|-
| 3013 || [21.0.0+] SetDebugPadGenericPadMap
|-
| 3014 || [21.0.0+] GetDebugPadKeyboardMap
|-
| 3015 || [21.0.0+] SetDebugPadKeyboardMap
|-
| 3110 || [S2]
|-
| 3111 || [S2]
|-
| 3112 || [S2]
|-
| 3113 || [S2]
|-
| 3130 || [S2]
|-
| 3131 || [S2]
|-
| 3132 || [S2]
|-
|-
| 3001 || [15.0.0+]
| 3133 || [S2]
|-
|-
| 3002 || [15.0.0+]
| 3135 || [S2]
|-
|-
| 3003 || [15.0.0+]
| 3136 || [S2]
|-
|-
| 3004 || [15.0.0+]
| 3137 || [S2]
|-
|-
| 3005 || [15.0.0+]
| 3138 || [S2]
|-
|-
| 3006 || [15.0.0+]
| 3139 || [S2]
|-
|-
| 3007 || [15.0.0+]
| 3140 || [S2]
|-
|-
| 3008 || [15.0.0+]
| 3141 || [S2]
|-
|-
| 3009 || [15.0.0+]
| 3142 || [S2]
|-
|-
| 3010 || [15.0.0+]
| 3143 || [S2]
|-
|-
| 3011 || [15.0.0+]
| 3150 || [21.0.0+] SetMouseLibraryVersion
|}
|}


Line 465: Line 541:
== 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 513: Line 607:
* 0x2: [6.0.0+]
* 0x2: [6.0.0+]
* 0x3: [8.0.0+]
* 0x3: [8.0.0+]
* 0x5: [18.0.0+]


== SetNpadJoyHoldType ==
== SetNpadJoyHoldType ==
Line 523: Line 618:


== 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 578: Line 673:
== ClearNpadCaptureButtonAssignment ==
== ClearNpadCaptureButtonAssignment ==
Takes a PID, an [[AM_services|AppletResourceUserId]], no output.
Takes a PID, an [[AM_services|AppletResourceUserId]], no output.
== Cmd138 ==
This is exclusive to S2.
Takes a PID, two input u64s, no output.
== Cmd139 ==
This is exclusive to S2.
Takes a PID, an u64, returns an output u64.


== GetVibrationDeviceInfo ==
== GetVibrationDeviceInfo ==
Line 629: Line 734:


This is currently not exposed by sdknso.
This is currently not exposed by sdknso.
== Cmd220 ==
This is exclusive to S2.
Takes a PID, an u32, an u64, returns an output u8.


== ActivateConsoleSixAxisSensor ==
== ActivateConsoleSixAxisSensor ==
Line 695: Line 805:
| 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 909: Line 1,037:
== SetDisallowedPalmaConnection ==
== SetDisallowedPalmaConnection ==
Takes a PID, an [[AM_services|AppletResourceUserId]], a type-0x9 input buffer containing an array of [[Bluetooth_Driver_services#Address|Address]], no output.
Takes a PID, an [[AM_services|AppletResourceUserId]], a type-0x9 input buffer containing an array of [[Bluetooth_Driver_services#Address|Address]], no output.
== Cmd550 ==
This is exclusive to S2.
Takes a PID, an u32, an u64, returns two output u8s.


== SetNpadCommunicationMode ==
== SetNpadCommunicationMode ==
Line 929: Line 1,062:


sdknso passes hard-coded value 1 for the s32.
sdknso passes hard-coded value 1 for the s32.
== SetTouchScreenOutputRanges ==
Takes a PID, a s32 width, a s32 height, an [[AM_services|AppletResourceUserId]], no output.
This is used by user-processes prior to [[#ActivateTouchScreen|ActivateTouchScreen]], on newer versions.
User-processes can optionally specify input values for width/height during TouchScreen initiailization, with the default values being the relevant fixed width/height values for the platform which the user-process was built for.


== ActivateDigitizer ==
== ActivateDigitizer ==
Takes a PID and an [[AM_services|AppletResourceUserId]]. No output.
== Cmd3110 ==
This is exclusive to S2.
Takes a PID, a handle, an u64, an u64, no output.
== Cmd3111 ==
This is exclusive to S2.
Takes a PID and an u64, no output.
== Cmd3112 ==
This is exclusive to S2.
Takes a PID, an u32, an u64, no output.
== Cmd3113 ==
This is exclusive to S2.
Takes a PID, an u32, an u64, no output.
== Cmd3130 ==
This is exclusive to S2.
Takes a PID, a handle, an u8, two u32s, two u64s, no output.
== Cmd3131 ==
This is exclusive to S2.
Takes a PID and an [[AM_services|AppletResourceUserId]], no output.
Takes a PID and an [[AM_services|AppletResourceUserId]], no output.
== Cmd3132 ==
This is exclusive to S2.
Takes a PID, an u32, an u32, an u64, no output.
== Cmd3133 ==
This is exclusive to S2.
Takes a PID, an u64, returns two output u32s.
== Cmd3135 ==
This is exclusive to S2.
Takes a PID, a bool, an [[AM_services|AppletResourceUserId]], no output.
== Cmd3136 ==
This is exclusive to S2.
Takes a PID, an u64, an u64, no output.
== Cmd3137 ==
This is exclusive to S2.
Takes a PID, an u64, an u64, no output.
== Cmd3138 ==
This is exclusive to S2.
Takes a PID, an u32, an [[AM_services|AppletResourceUserId]], no output.
Official sw masks the u32 with bitmask 0x6.
== Cmd3139 ==
This is exclusive to S2.
Takes a PID, a TransferMemory handle, an u8, an u32 width, an u32 height, an u32, an [[AM_services|AppletResourceUserId]], an u64 tmem_size, no output.
The input TransferMemory is created with permissions = R--. The user-process later reads from the buffer used with this.
Official sw always (?) passes value 1 for the last u32.
This and the related nearby cmds are likely (?) for Joy-Con 2 Mouse Mode.
== Cmd3140 ==
This is exclusive to S2.
Takes a PID, two u32s, two u64s, no output.
== Cmd3141 ==
This is exclusive to S2.
Takes a PID, a bool, an [[AM_services|AppletResourceUserId]], an u64, no output.
== Cmd3142 ==
This is exclusive to S2.
Takes a PID, 4 floats, an [[AM_services|AppletResourceUserId]], no output.
== Cmd3143 ==
This is exclusive to S2.
Takes a PID, two u64s, no output.


== IAppletResource ==
== IAppletResource ==
Line 987: Line 1,220:
|-
|-
| 17 || [13.0.0+] IsTouchScreenManaged
| 17 || [13.0.0+] IsTouchScreenManaged
|-
| 18 || [18.0.0+] SetTouchScreenAutoPilotStateWithAruid
|-
|-
| 20 || [[#DeactivateMouse]]
| 20 || [[#DeactivateMouse]]
Line 993: Line 1,228:
|-
|-
| 22 || [[#UnsetMouseAutoPilotState]]
| 22 || [[#UnsetMouseAutoPilotState]]
|-
| 23 || [21.0.0+] AddMouseSideWheelDelta
|-
| 25 || [16.0.0+] SetDebugMouseAutoPilotState
|-
| 26 || [16.0.0+] UnsetDebugMouseAutoPilotState
|-
|-
| 30 || [[#DeactivateKeyboard]]
| 30 || [[#DeactivateKeyboard]]
Line 1,071: Line 1,312:
|-
|-
| 152 || [10.0.0+] GetWhoAmI
| 152 || [10.0.0+] GetWhoAmI
|-
| 160 || [S2]
|-
| 161 || [S2]
|-
| 162 || [S2]
|-
| 170 || [S2]
|-
| 171 || [S2]
|-
| 172 || [S2]
|-
|-
| 201 || ActivateFirmwareUpdate
| 201 || ActivateFirmwareUpdate
Line 1,093: Line 1,346:
|-
|-
| 211 || [6.0.0+] StartFirmwareUpdateIndividual
| 211 || [6.0.0+] StartFirmwareUpdateIndividual
|-
| 212 || [19.0.0+] GetDetailFirmwareVersion
|-
| 213 || [20.0.0+] GetFirmwareVersionStringForDevMenu
|-
| 214 || [20.1.0+] GetDestinationFirmwareVersionStringForDevMenu
|-
|-
| 215 || [6.0.0+] SetUsbFirmwareForceUpdateEnabled
| 215 || [6.0.0+] SetUsbFirmwareForceUpdateEnabled
|-
|-
| 216 || [6.0.0+] SetAllKuinaDevicesToFirmwareUpdateMode
| 216 || [6.0.0+] SetAllKuinaDevicesToFirmwareUpdateMode
|-
| 217 || [17.0.0+] StartFirmwareUpdateFromImageSet
|-
|-
| 221 || [3.0.0+] [[#UpdateControllerColor]]
| 221 || [3.0.0+] [[#UpdateControllerColor]]
Line 1,160: Line 1,421:
| 251 || [12.0.0+] GetAnalogStickModuleParam
| 251 || [12.0.0+] GetAnalogStickModuleParam
|-
|-
| 301 || [5.0.0-8.1.0] [[#GetAbstractedPadHandles]]
| 252 || [S2]
|-
|-
| 302 || [5.0.0-8.1.0] [[#GetAbstractedPadState]]
| 253 || [19.0.0+] ClearStorageForShipment
|-
|-
| 303 || [5.0.0-8.1.0] [[#GetAbstractedPadsState]]
| 254 || [S2]
|-
| 255 || [S2]
|-
| 256 || [S2]
|-
| 261 || [21.0.0+] UpdateDesignInfo12
|-
| 266 || [21.0.0+] GetUniquePadButtonCount
|-
| 267 || [21.0.0+] SetAnalogStickCalibration
|-
| 268 || [21.0.0+] ResetAnalogStickCalibration
|-
| 301 || [5.0.0-8.1.0] [[#GetAbstractedPadHandles]]
|-
| 302 || [5.0.0-8.1.0] [[#GetAbstractedPadState]]
|-
| 303 || [5.0.0-8.1.0] [[#GetAbstractedPadsState]]
|-
|-
| 321 || [5.0.0-8.1.0] [[#SetAutoPilotVirtualPadState]]
| 321 || [5.0.0-8.1.0] [[#SetAutoPilotVirtualPadState]]
Line 1,191: Line 1,470:
|-
|-
| 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,213: Line 1,496:
|-
|-
| 600 || [10.0.0+] ConvertPadState
| 600 || [10.0.0+] ConvertPadState
|-
| 601 || [18.0.0+] [[#IsButtonConfigSupported]]
|-
| 602 || [18.0.0+] [[#IsButtonConfigEmbeddedSupported]]
|-
| 603 || [18.0.0+] [[#DeleteButtonConfig]]
|-
| 604 || [18.0.0+] [[#DeleteButtonConfigEmbedded]]
|-
| 605 || [18.0.0+] [[#SetButtonConfigEnabled]]
|-
| 606 || [18.0.0+] [[#SetButtonConfigEmbeddedEnabled]]
|-
| 607 || [18.0.0+] [[#IsButtonConfigEnabled]]
|-
| 608 || [18.0.0+] [[#IsButtonConfigEmbeddedEnabled]]
|-
| 609 || [18.0.0+] [[#SetButtonConfigEmbedded]]
|-
| 610 || [18.0.0+] [[#SetButtonConfigFull]]
|-
| 611 || [18.0.0+] [[#SetButtonConfigLeft]]
|-
| 612 || [18.0.0+] [[#SetButtonConfigRight]]
|-
| 613 || [18.0.0+] [[#GetButtonConfigEmbedded]]
|-
| 614 || [18.0.0+] [[#GetButtonConfigFull]]
|-
| 615 || [18.0.0+] [[#GetButtonConfigLeft]]
|-
| 616 || [18.0.0+] [[#GetButtonConfigRight]]
|-
| 617 || [S2]
|-
| 618 || [S2]
|-
| 619 || [S2]
|-
| 620 || [S2]
|-
| 621 || [S2]
|-
| 622 || [S2]
|-
|-
| 650 || [12.0.0+] AddButtonPlayData
| 650 || [12.0.0+] AddButtonPlayData
Line 1,220: Line 1,547:
| 652 || [12.0.0+] StopButtonPlayData
| 652 || [12.0.0+] StopButtonPlayData
|-
|-
| 2000 || [10.0.0+] DeactivateDigitizer
| 700 || [21.0.0+] GetRailAttachEventCount
|-
| 2000 || [10.0.0+] [[#DeactivateDigitizer]]
|-
| 2001 || [10.0.0+] [[#SetDigitizerAutoPilotState]]
|-
|-
| 2001 || [10.0.0+] SetDigitizerAutoPilotState
| 2002 || [10.0.0+] [[#UnsetDigitizerAutoPilotState]]
|-
|-
| 2002 || [10.0.0+] UnsetDigitizerAutoPilotState
| 3000 || [16.0.0+] ReloadFirmwareDebugSettings
|}
|}


Line 1,316: Line 1,647:


[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,442: Line 1,775:


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


= hid:sys =
= hid:sys =
Line 1,469: Line 1,811:
|-
|-
| 161 || [7.0.0+] GetPlatformConfig
| 161 || [7.0.0+] GetPlatformConfig
|-
| 171 || [S2]
|-
| 181 || [S2]
|-
|-
| 210 || AcquireNfcDeviceUpdateEventHandle
| 210 || AcquireNfcDeviceUpdateEventHandle
Line 1,478: Line 1,824:
| 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]]
|-
| 251 || [S2]
|-
| 252 || [S2]
|-
| 253 || [S2]
|-
| 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,545: Line 1,937:
|-
|-
| 330 || [14.0.0+] CheckAbstractedPadConnection
| 330 || [14.0.0+] CheckAbstractedPadConnection
|-
| 332 || [19.0.0+] ConvertAppletDetailedUiTypeFromPlayReportType
|-
| 333 || [20.0.0+] SetNpadUserSpgApplet
|-
| 334 || [20.0.0+] AcquireUniquePadButtonStateChangedEventHandle
|-
|-
| 500 || SetAppletResourceUserId
| 500 || SetAppletResourceUserId
|-
|-
| 501 || RegisterAppletResourceUserId
| 501 || [[#RegisterAppletResourceUserId|RegisterAppletResourceUserId]]
|-
|-
| 502 || UnregisterAppletResourceUserId
| 502 || UnregisterAppletResourceUserId
Line 1,583: Line 1,981:
|-
|-
| 525 || [11.0.0+] IsJoyConAttachedOnAllRail
| 525 || [11.0.0+] IsJoyConAttachedOnAllRail
|-
| 526 || [19.0.0+] IsInvertedControllerConnectedOnRail
|-
|-
| 540 || AcquirePlayReportControllerUsageUpdateEvent
| 540 || AcquirePlayReportControllerUsageUpdateEvent
Line 1,590: Line 1,990:
| 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,603: Line 2,003:
|-
|-
| 549 || [6.0.0+] GetConnectableRegisteredDevices
| 549 || [6.0.0+] GetConnectableRegisteredDevices
|-
| 550 || [S2]
|-
| 551 || [20.0.0+] GetRegisteredDevicesForControllerSupport
|-
|-
| 700 || ActivateUniquePad
| 700 || ActivateUniquePad
Line 1,610: Line 2,014:
| 703 || [[#GetUniquePadIds]]
| 703 || [[#GetUniquePadIds]]
|-
|-
| 751 || AcquireJoyDetachOnBluetoothOffEventHandle
| 704 || [S2]
|-
|-
| 800 || ListSixAxisSensorHandles
| 705 || [S2]
|-
|-
| 801 || IsSixAxisSensorUserCalibrationSupported
| 707 || [S2]
|-
|-
| 802 || ResetSixAxisSensorCalibrationValues
| 711 || [20.0.0+] AcquireUniquePadConnectionOnHandheldForNsEventHandle
|-
|-
| 803 || StartSixAxisSensorUserCalibration
| 712 || [20.0.0+] GetUniquePadColor12
|-
|-
| 804 || CancelSixAxisSensorUserCalibration
| 721 || [S2]
|-
|-
| 805 || [3.0.0+] GetUniquePadBluetoothAddress
| 722 || [S2]
|-
|-
| 806 || [3.0.0+] DisconnectUniquePad
| 723 || [S2]
|-
|-
| 807 || [5.0.0+] [[#GetUniquePadType]]
| 724 || [S2]
|-
|-
| 808 || [5.0.0+] GetUniquePadInterface
| 725 || [S2]
|-
|-
| 809 || [5.0.0+] [[#GetUniquePadSerialNumber]]
| 726 || [S2]
|-
|-
| 810 || [5.0.0+] GetUniquePadControllerNumber
| 727 || [S2]
|-
|-
| 811 || [5.0.0+] GetSixAxisSensorUserCalibrationStage
| 728 || [S2]
|-
|-
| 812 || [8.0.0+] GetConsoleUniqueSixAxisSensorHandle
| 729 || [S2]
|-
|-
| 821 || StartAnalogStickManualCalibration
| 730 || [S2]
|-
|-
| 822 || RetryCurrentAnalogStickManualCalibrationStage
| 731 || [S2]
|-
|-
| 823 || CancelAnalogStickManualCalibration
| 732 || [S2]
|-
|-
| 824 || ResetAnalogStickManualCalibration
| 733 || [S2]
|-
|-
| 825 || [5.0.0+] GetAnalogStickState
| 734 || [S2]
|-
|-
| 826 || [5.0.0+] GetAnalogStickManualCalibrationStage
| 735 || [S2]
|-
| 736 || [S2]
|-
| 737 || [S2]
|-
| 738 || [S2]
|-
| 739 || [S2]
|-
| 740 || [S2]
|-
| 741 || [S2]
|-
| 742 || [S2]
|-
| 743 || [S2]
|-
| 744 || [S2]
|-
| 745 || [S2]
|-
| 746 || [S2]
|-
| 751 || AcquireJoyDetachOnBluetoothOffEventHandle
|-
| 800 || ListSixAxisSensorHandles
|-
| 801 || IsSixAxisSensorUserCalibrationSupported
|-
| 802 || ResetSixAxisSensorCalibrationValues
|-
| 803 || StartSixAxisSensorUserCalibration
|-
| 804 || CancelSixAxisSensorUserCalibration
|-
| 805 || [3.0.0+] GetUniquePadBluetoothAddress
|-
| 806 || [3.0.0+] DisconnectUniquePad
|-
| 807 || [5.0.0+] [[#GetUniquePadType]]
|-
| 808 || [5.0.0+] GetUniquePadInterface
|-
| 809 || [5.0.0+] [[#GetUniquePadSerialNumber]]
|-
| 810 || [5.0.0+] GetUniquePadControllerNumber
|-
| 811 || [5.0.0+] GetSixAxisSensorUserCalibrationStage
|-
| 812 || [8.0.0+] GetConsoleUniqueSixAxisSensorHandle
|-
| 813 || [18.0.0+] GetDeviceType
|-
| 821 || StartAnalogStickManualCalibration
|-
| 822 || RetryCurrentAnalogStickManualCalibrationStage
|-
| 823 || CancelAnalogStickManualCalibration
|-
| 824 || ResetAnalogStickManualCalibration
|-
| 825 || [5.0.0+] GetAnalogStickState
|-
| 826 || [5.0.0+] GetAnalogStickManualCalibrationStage
|-
|-
| 827 || [5.0.0+] IsAnalogStickButtonPressed
| 827 || [5.0.0+] IsAnalogStickButtonPressed
Line 1,697: Line 2,165:
|-
|-
| 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,710: Line 2,180:
| 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,738: Line 2,208:
| 1157 || [10.0.0+] [[#CancelConnectionTrigger]]
| 1157 || [10.0.0+] [[#CancelConnectionTrigger]]
|-
|-
| 1200 || [10.0.0+] [[#IsButtonConfigSupported]]
| 1158 || [20.1.0+] SetConnectionLimitForSplay
|-
| 1159 || [20.1.0+] ClearConnectionLimitForSplay
|-
|-
| 1201 || [11.0.0+] [[#IsButtonConfigEmbeddedSupported]] ([10.0.0-10.2.0] [[#DeleteButtonConfig]])
| 1200 || [10.0.0-17.0.1] [[#IsButtonConfigSupported]]
|-
|-
| 1202 || [11.0.0+] [[#DeleteButtonConfig]] ([10.0.0-10.2.0] [[#SetButtonConfigEnabled]])
| 1201 || [11.0.0-17.0.1] [[#IsButtonConfigEmbeddedSupported]] ([10.0.0-10.2.0] [[#DeleteButtonConfig]])
|-
|-
| 1203 || [11.0.0+] [[#DeleteButtonConfigEmbedded]] ([10.0.0-10.2.0] [[#IsButtonConfigEnabled]])
| 1202 || [11.0.0-17.0.1] [[#DeleteButtonConfig]] ([10.0.0-10.2.0] [[#SetButtonConfigEnabled]])
|-
|-
| 1204 || [11.0.0+] [[#SetButtonConfigEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigEmbedded]])
| 1203 || [11.0.0-17.0.1] [[#DeleteButtonConfigEmbedded]] ([10.0.0-10.2.0] [[#IsButtonConfigEnabled]])
|-
|-
| 1205 || [11.0.0+] [[#SetButtonConfigEmbeddedEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigFull]])
| 1204 || [11.0.0-17.0.1] [[#SetButtonConfigEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigEmbedded]])
|-
|-
| 1206 || [11.0.0+] [[#IsButtonConfigEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigLeft]])
| 1205 || [11.0.0-17.0.1] [[#SetButtonConfigEmbeddedEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigFull]])
|-
|-
| 1207 || [11.0.0+] [[#IsButtonConfigEmbeddedEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigRight]])
| 1206 || [11.0.0-17.0.1] [[#IsButtonConfigEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigLeft]])
|-
|-
| 1208 || [11.0.0+] [[#SetButtonConfigEmbedded]] ([10.0.0-10.2.0] [[#GetButtonConfigEmbedded]])
| 1207 || [11.0.0-17.0.1] [[#IsButtonConfigEmbeddedEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigRight]])
|-
|-
| 1209 || [11.0.0+] [[#SetButtonConfigFull]] ([10.0.0-10.2.0] [[#GetButtonConfigFull]])
| 1208 || [11.0.0-17.0.1] [[#SetButtonConfigEmbedded]] ([10.0.0-10.2.0] [[#GetButtonConfigEmbedded]])
|-
| 1209 || [11.0.0-17.0.1] [[#SetButtonConfigFull]] ([10.0.0-10.2.0] [[#GetButtonConfigFull]])
|-
|-
| 1210 || [10.0.0-10.2.0] [[#GetButtonConfigLeft]]
| 1210 || [10.0.0-10.2.0] [[#GetButtonConfigLeft]]
|-
|-
| 1211 || [11.0.0+] [[#SetButtonConfigRight]] ([10.0.0-10.2.0] [[#GetButtonConfigRight]])
| 1211 || [11.0.0-17.0.1] [[#SetButtonConfigRight]] ([10.0.0-10.2.0] [[#GetButtonConfigRight]])
|-
|-
| 1212 || [11.0.0+] [[#GetButtonConfigEmbedded]]
| 1212 || [11.0.0-17.0.1] [[#GetButtonConfigEmbedded]]
|-
|-
| 1213 || [11.0.0+] [[#GetButtonConfigFull]]
| 1213 || [11.0.0-17.0.1] [[#GetButtonConfigFull]]
|-
|-
| 1214 || [11.0.0+] [[#GetButtonConfigLeft]]
| 1214 || [11.0.0-17.0.1] [[#GetButtonConfigLeft]]
|-
|-
| 1215 || [11.0.0+] [[#GetButtonConfigRight]]
| 1215 || [11.0.0-17.0.1] [[#GetButtonConfigRight]]
|-
|-
| 1250 || [10.0.0+] [[#IsCustomButtonConfigSupported]]
| 1250 || [10.0.0+] [[#IsCustomButtonConfigSupported]]
Line 1,854: Line 2,328:
| 1291 || [11.0.0+] [[#SetButtonConfigStorageRight]]
| 1291 || [11.0.0+] [[#SetButtonConfigStorageRight]]
|-
|-
| 12010 || [11.0.0+] [[#SetButtonConfigLeft]]
| 1292 || [S2]
|}
|-
 
| 1293 || [S2]
== SendKeyboardLockKeyEvent ==
|-
Takes an u32 BitFlagSet [[#KeyboardLockKeyEvent]], no output.
| 1294 || [S2]
 
|-
== AcquireHomeButtonEventHandle ==
| 1295 || [S2]
Takes a PID, an [[AM_services|AppletResourceUserId]], returns an output Event handle.
|-
 
| 1296 || [S2]
The EventClearMode used by sdknso is user-specified. The Event is signaled when [[#HomeButtonState]] is updated.
|-
 
| 1297 || [S2]
This is used by [[AM_services|AM]].
|-
 
| 1298 || [S2]
== ActivateHomeButton ==
|-
Takes a PID, an [[AM_services|AppletResourceUserId]], no output.
| 1299 || [S2]
 
|-
Activates the [[#HomeButtonSharedMemoryFormat|HomeButton]] sharedmem.
| 1300 || [S2]
 
|-
== AcquireSleepButtonEventHandle ==
| 1301 || [S2]
Takes a PID, an [[AM_services|AppletResourceUserId]], returns an output Event handle.
|-
 
| 1302 || [S2]
The EventClearMode used by sdknso is user-specified. The Event is signaled when [[#SleepButtonState]] is updated.
|-
 
| 1303 || [S2]
This is used by [[AM_services|AM]].
|-
 
| 1304 || [S2]
== ActivateSleepButton ==
|-
Takes a PID, an [[AM_services|AppletResourceUserId]], no output.
| 1305 || [S2]
 
|-
Activates the [[#SleepButtonSharedMemoryFormat|SleepButton]] sharedmem.
| 1306 || [S2]
 
|-
== AcquireCaptureButtonEventHandle ==
| 1307 || [S2]
Takes a PID, an [[AM_services|AppletResourceUserId]], returns an output Event handle.
|-
 
| 1308 || [18.0.0+] SetButtonConfigVisible
The EventClearMode used by sdknso is user-specified. The Event is signaled when [[#CaptureButtonState]] is updated.
|-
 
| 1309 || [18.0.0+] IsButtonConfigVisible
This is used by [[AM_services|AM]].
|-
 
| 1310 || [S2]
== ActivateCaptureButton ==
|-
Takes a PID, an [[AM_services|AppletResourceUserId]], no output.
| 1320 || [17.0.0+] WakeTouchScreenUp
 
|-
Activates the [[#CaptureButtonSharedMemoryFormat|CaptureButton]] sharedmem.
| 1321 || [17.0.0+] PutTouchScreenToSleep
 
|-
== GetMaskedSupportedNpadStyleSet ==
| 1322 || [20.0.0+] AcquireTouchScreenAsyncWakeCompletedEvent
Takes an input u64 AppletResourceUserId, returns an output u32 [[#NpadStyleTag]].
|-
 
| 1323 || [21.0.0+] StartTouchScreenAutoTuneForSystemSettings
Official sw uses the output from [[Applet_Manager_services|GetAppletResourceUserIdOfCallerApplet]] with this.
|-
 
| 1324 || [21.0.0+] AcquireTouchScreenAutoTuneCompletedEvent
== GetUniquePadsFromNpad ==
|-
Takes an input u32 [[#NpadIdType]], a type-0xA output buffer, and returns an output s64 for total output entries (which is copied to a s32 by official sw).
| 1325 || [21.0.0+] IsTouchScreenAutoTuneRequiredForRepairProviderReplacement
 
|-
The output buffer contains an array of [[#UniquePadId]].
| 1326 || [21.0.0+] SetTouchScreenOffset
 
|-
== SetVibrationMasterVolume ==
| 1327 || [22.0.0+]
Takes an input 32bit float.
|-
 
| 1350 || [S2]
== GetUniquePadIds ==
|-
Takes a type-0xA output buffer, and returns an output s64 for total output entries (which is copied to a s32 by official sw).
| 1351 || [S2]
 
|-
The output buffer contains an array of [[#UniquePadId]].
| 1352 || [S2]
 
|-
== GetUniquePadType ==
| 1360 || [S2]
Takes an input [[#UniquePadId]] and returns an output u64 [[#UniquePadType]].
|-
 
| 1361 || [S2]
== GetUniquePadSerialNumber ==
|-
Takes an input [[#UniquePadId]] and returns an output [[#UniquePadSerialNumber]].
| 1362 || [S2]
 
|-
== SetNotificationLedPattern ==
| 1380 || [S2]
Takes an input [[#NotificationLedPattern]] and an [[#UniquePadId]], no output.
|-
 
| 1381 || [S2]
The specified controller must have a HOME button.
|-
 
| 1382 || [S2]
This sends [https://github.com/dekuNukem/Nintendo_Switch_Reverse_Engineering/blob/master/bluetooth_hid_subcommands_notes.md#subcommand-0x38-set-home-light subcommand 0x38] to the specified controller, for setting the pattern for the HOME button notification LED. The input structure is converted to the format as follows: <code>((u8*)cmd_argdata)[pos] = u8_in[pos2] | u8_in[pos3]<<4;</code> Hence, 4bits from pairs of 2-bytes of the input struct are combined to write to the subcommand. Only the low 4bits of each used byte in the struct is used. This is written to stack initially, then copied to the actual cmd_argdata (the data immediately following the subcommandID byte). There's a total of 0x1D-bytes of cmd_argdata initialized from this.
 
The layout of cmd_argdata is as follows:
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 1383 || [S2]
|-
|-
| 0x0 || 0x1 || <nowiki>((TimeUnit & 0xF) | ((FrameCount & 0xF) << 4))</nowiki>
| 1384 || [S2]
|-
|-
| 0x1 || 0x1 || <nowiki>((CycleCount & 0xF) | ((InitialBrightness & 0xF) << 4))</nowiki>
| 1385 || [S2]
|-
|-
| 0x2 || 0x1 || <nowiki>((Frame2Brightness & 0xF) | ((Frame1Brightness & 0xF) << 4))</nowiki>
| 1386 || [S2]
|-
|-
| 0x3 || 0x1 || <nowiki>((Frame1TimeToHold & 0xF) | ((Frame1TimeTowards & 0xF) << 4))</nowiki>
| 1387 || [S2]
|-
|-
| 0x4 || 0x1 || <nowiki>((Frame2TimeToHold & 0xF) | ((Frame2TimeTowards & 0xF) << 4))</nowiki>
| 1388 || [S2]
|-
|-
| 0x5 || 0x1 || <nowiki>((Frame4Brightness & 0xF) | ((Frame3Brightness & 0xF) << 4))</nowiki>
| 1400 || [S2]
|-
|-
| 0x6 || 0x1 || <nowiki>((Frame3TimeToHold & 0xF) | ((Frame3TimeTowards & 0xF) << 4))</nowiki>
| 1401 || [S2]
|-
|-
| 0x7 || 0x1 || <nowiki>((Frame4TimeToHold & 0xF) | ((Frame4TimeTowards & 0xF) << 4))</nowiki>
| 1420 || [19.0.0+] GetAppletResourceProperty
|-
|-
| 0x8 || 0x1 || <nowiki>((Frame6Brightness & 0xF) | ((Frame5Brightness & 0xF) << 4))</nowiki>
| 1445 || [S2]
|-
|-
| 0x9 || 0x1 || <nowiki>((Frame5TimeToHold & 0xF) | ((Frame5TimeTowards & 0xF) << 4))</nowiki>
| 1446 || [S2]
|-
|-
| 0xA || 0x1 || <nowiki>((Frame6TimeToHold & 0xF) | ((Frame6TimeTowards & 0xF) << 4))</nowiki>
| 1447 || [S2]
|-
|-
| 0xB || 0x1 || <nowiki>((Frame8Brightness & 0xF) | ((Frame7Brightness & 0xF) << 4))</nowiki>
| 1448 || [S2]
|-
|-
| 0xC || 0x1 || <nowiki>((Frame7TimeToHold & 0xF) | ((Frame7TimeTowards & 0xF) << 4))</nowiki>
| 1449 || [S2]
|-
|-
| 0xD || 0x1 || <nowiki>((Frame8TimeToHold & 0xF) | ((Frame8TimeTowards & 0xF) << 4))</nowiki>
| 1455 || [S2]
|-
|-
| 0xE || 0x1 || <nowiki>((Frame10Brightness & 0xF) | ((Frame9Brightness & 0xF) << 4))</nowiki>
| 1456 || [S2]
|-
|-
| 0xF || 0x1 || <nowiki>((Frame9TimeToHold & 0xF) | ((Frame9TimeTowards & 0xF) << 4))</nowiki>
| 1457 || [S2]
|-
|-
| 0x10 || 0x1 || <nowiki>((Frame10TimeToHold & 0xF) | ((Frame10TimeTowards & 0xF) << 4))</nowiki>
| 1458 || [S2]
|-
|-
| 0x11 || 0x1 || <nowiki>((Frame12Brightness & 0xF) | ((Frame11Brightness & 0xF) << 4))</nowiki>
| 1459 || [S2]
|-
|-
| 0x12 || 0x1 || <nowiki>((Frame11TimeToHold & 0xF) | ((Frame11TimeTowards & 0xF) << 4))</nowiki>
| 1460 || [S2]
|-
|-
| 0x13 || 0x1 || <nowiki>((Frame12TimeToHold & 0xF) | ((Frame12TimeTowards & 0xF) << 4))</nowiki>
| 1461 || [S2]
|-
|-
| 0x14 || 0x1 || <nowiki>((Frame14Brightness & 0xF) | ((Frame13Brightness & 0xF) << 4))</nowiki>
| 1470 || [S2]
|-
|-
| 0x15 || 0x1 || <nowiki>((Frame13TimeToHold & 0xF) | ((Frame13TimeTowards & 0xF) << 4))</nowiki>
| 1471 || [S2]
|-
|-
| 0x16 || 0x1 || <nowiki>((Frame14TimeToHold & 0xF) | ((Frame14TimeTowards & 0xF) << 4))</nowiki>
| 1472 || [S2]
|-
|-
| 0x17 || 0x1 || <nowiki>((Reserved & 0xF) | ((Frame15Brightness & 0xF) << 4))</nowiki>
| 1473 || [S2]
|-
|-
| 0x18 || 0x1 || <nowiki>((Frame15TimeToHold & 0xF) | ((Frame15TimeTowards & 0xF) << 4))</nowiki>
| 1474 || [S2]
|-
|-
| 0x19 || 0x1 || <nowiki>((Reserved & 0xF) | ((Reserved & 0xF) << 4))</nowiki>
| 1480 || [S2]
|-
|-
| 0x1A || 0x1 || <nowiki>((TimeTowardsFinalBrightness & 0xF) | ((FinalBrightness & 0xF) << 4))</nowiki>
| 1490 || [22.0.0+]
|-
|-
| 0x1B || 0x1 || <nowiki>(Timeout & 0xFF)</nowiki>
| 1491 || [22.0.0+]
|-
|-
| 0x1C || 0x1 || <nowiki>((Timeout >> 8) & 0xFF)</nowiki>
| 12010 || [11.0.0-17.0.1] [[#SetButtonConfigLeft]]
|}
|}


[9.0.0+] This runs code similar to [[#SetNotificationLedPatternWithTimeout]], except it passes the following param values to an internal func: flag=1 and TimeSpan=0 (with [[#SetNotificationLedPatternWithTimeout]] these are flag=0 and TimeSpan={input value}).
== SendKeyboardLockKeyEvent ==
Takes an u32 BitFlagSet [[#KeyboardLockKeyEvent]], no output.
 
== AcquireHomeButtonEventHandle ==
Takes a PID, an [[AM_services|AppletResourceUserId]], returns an output Event handle.
 
The EventClearMode used by sdknso is user-specified. The Event is signaled when [[#HomeButtonState]] is updated.
 
This is used by [[AM_services|AM]].
 
== ActivateHomeButton ==
Takes a PID, an [[AM_services|AppletResourceUserId]], no output.
 
Activates the [[#HomeButtonSharedMemoryFormat|HomeButton]] sharedmem.


== SetNotificationLedPatternWithTimeout ==
== AcquireSleepButtonEventHandle ==
Takes an input [[#NotificationLedPattern]], an [[#UniquePadId]], and an s64 TimeSpan, no output.
Takes a PID, an [[AM_services|AppletResourceUserId]], returns an output Event handle.


== PrepareHidsForNotificationWake ==
The EventClearMode used by sdknso is user-specified. The Event is signaled when [[#SleepButtonState]] is updated.
Takes a type-0x9 input buffer containing an array of [[#UniquePadId]], no output.


== IsUsbConnected ==
This is used by [[AM_services|AM]].
Tales an input [[#UniquePadId]], returns an output bool.


== NotifyInputDetector ==
== ActivateSleepButton ==
Takes an input u32 bitmask InputSourceId, no output.
Takes a PID, an [[AM_services|AppletResourceUserId]], no output.


This is the only hid:sys command used by USB-sysmodule (with value 0x40).
Activates the [[#SleepButtonSharedMemoryFormat|SleepButton]] sharedmem.


== GetHidbusSystemServiceObject ==
== AcquireCaptureButtonEventHandle ==
No input, returns an [[#IHidbusSystemServer]].
Takes a PID, an [[AM_services|AppletResourceUserId]], returns an output Event handle.


== GetTouchScreenFirmwareVersion ==
The EventClearMode used by sdknso is user-specified. The Event is signaled when [[#CaptureButtonState]] is updated.
No input. Returns a [[#FirmwareVersion]].


This requests the current firmware version from the touch screen IC.
This is used by [[AM_services|AM]].


It first ensures the touch screen IC's chip id is one of the following:
== ActivateCaptureButton ==
0x7036 - STMicroelectronics FingerTipS FT9CJ/FT9CF
Takes a PID, an [[AM_services|AppletResourceUserId]], no output.
0x4036 - ?


Then constructs the final firmware version as follows:
Activates the [[#CaptureButtonSharedMemoryFormat|CaptureButton]] sharedmem.
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 ==
== GetMaskedSupportedNpadStyleSet ==
Takes a PID, a s32, an [[#UniquePadId]], an [[AM_services|AppletResourceUserId]], returns an output bool.
Takes an input u64 AppletResourceUserId, returns an output u32 [[#NpadStyleTag]].


sdknso uses hard-coded value 1 for the s32.
Official sw uses the output from [[Applet_Manager_services|GetAppletResourceUserIdOfCallerApplet]] with this.


== CancelConnectionTrigger ==
== GetUniquePadsFromNpad ==
Takes an input "nn::bluetooth::Address", no output.
Takes an input u32 [[#NpadIdType]], a type-0xA output buffer, and returns an output s64 for total output entries (which is copied to a s32 by official sw).


== IsButtonConfigSupported ==
The output buffer contains an array of [[#UniquePadId]].
Takes an input [[#UniquePadId]], returns an output bool.


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


== IsButtonConfigEmbeddedSupported ==
[20.4.0+] Takes an input bool, an u8, an [[Applet_Manager_services|AppletResourceUserId]], no output.
No input, returns an output bool.


== DeleteButtonConfig ==
== SetVibrationMasterVolume ==
Takes an input [[#UniquePadId]], no output.
Takes an input 32bit float.


[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], no output.
== GetUniquePadIds ==
Takes a type-0xA output buffer, and returns an output s64 for total output entries (which is copied to a s32 by official sw).


== DeleteButtonConfigEmbedded ==
The output buffer contains an array of [[#UniquePadId]].
No input/output.


== SetButtonConfigEnabled ==
== GetUniquePadType ==
Takes an input bool, an [[#UniquePadId]], no output.
Takes an input [[#UniquePadId]] and returns an output u64 [[#UniquePadType]].


[11.0.0+] Takes an input bool, an [[Bluetooth_Driver_services#Address|Address]], no output.
== GetUniquePadSerialNumber ==
Takes an input [[#UniquePadId]] and returns an output [[#UniquePadSerialNumber]].


== SetButtonConfigEmbeddedEnabled ==
== SetNotificationLedPattern ==
Takes an input bool, no output.
Takes an input [[#NotificationLedPattern]] and an [[#UniquePadId]], no output.


== IsButtonConfigEnabled ==
The specified controller must have a HOME button.
Takes an input [[#UniquePadId]], returns an output bool.


[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], returns an output bool.
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.


== IsButtonConfigEmbeddedEnabled ==
The layout of cmd_argdata is as follows:
No input, returns an output bool.
{| class="wikitable" border="1"
 
|-
== SetButtonConfigEmbedded ==
! Offset || Size || Description
Takes ([10.0.0-10.2.0] an input [[#UniquePadId]]), a type-0x15 input buffer containing a [[#SystemButtonConfigEmbedded]], no output.
|-
 
| 0x0 || 0x1 || <nowiki>((TimeUnit & 0xF) | ((FrameCount & 0xF) << 4))</nowiki>
== SetButtonConfigFull ==
|-
Takes an input [[#UniquePadId]], a type-0x15 input buffer containing a [[#SystemButtonConfigFull]], no output.
| 0x1 || 0x1 || <nowiki>((CycleCount & 0xF) | ((InitialBrightness & 0xF) << 4))</nowiki>
 
|-
[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], a type-0x15 input buffer containing a [[#SystemButtonConfigFull]], no output.
| 0x2 || 0x1 || <nowiki>((Frame2Brightness & 0xF) | ((Frame1Brightness & 0xF) << 4))</nowiki>
 
|-
== SetButtonConfigLeft ==
| 0x3 || 0x1 || <nowiki>((Frame1TimeToHold & 0xF) | ((Frame1TimeTowards & 0xF) << 4))</nowiki>
Takes an input [[#UniquePadId]], a type-0x15 input buffer containing a [[#SystemButtonConfigLeft]], no output.
|-
 
| 0x4 || 0x1 || <nowiki>((Frame2TimeToHold & 0xF) | ((Frame2TimeTowards & 0xF) << 4))</nowiki>
[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], a type-0x15 input buffer containing a [[#SystemButtonConfigLeft]], no output.
|-
 
| 0x5 || 0x1 || <nowiki>((Frame4Brightness & 0xF) | ((Frame3Brightness & 0xF) << 4))</nowiki>
== SetButtonConfigRight ==
|-
Takes an input [[#UniquePadId]], a type-0x15 input buffer containing a [[#SystemButtonConfigRight]], no output.
| 0x6 || 0x1 || <nowiki>((Frame3TimeToHold & 0xF) | ((Frame3TimeTowards & 0xF) << 4))</nowiki>
 
|-
[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], a type-0x15 input buffer containing a [[#SystemButtonConfigRight]], no output.
| 0x7 || 0x1 || <nowiki>((Frame4TimeToHold & 0xF) | ((Frame4TimeTowards & 0xF) << 4))</nowiki>
 
|-
== GetButtonConfigEmbedded ==
| 0x8 || 0x1 || <nowiki>((Frame6Brightness & 0xF) | ((Frame5Brightness & 0xF) << 4))</nowiki>
Takes ([10.0.0-10.2.0] an input [[#UniquePadId]]), and a type-0x16 output buffer containing a [[#SystemButtonConfigEmbedded]].
|-
 
| 0x9 || 0x1 || <nowiki>((Frame5TimeToHold & 0xF) | ((Frame5TimeTowards & 0xF) << 4))</nowiki>
== GetButtonConfigFull ==
|-
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#SystemButtonConfigFull]].
| 0xA || 0x1 || <nowiki>((Frame6TimeToHold & 0xF) | ((Frame6TimeTowards & 0xF) << 4))</nowiki>
 
|-
[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], and a type-0x16 output buffer containing a [[#SystemButtonConfigFull]].
| 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>
|}


== GetButtonConfigLeft ==
[9.0.0+] This runs code similar to [[#SetNotificationLedPatternWithTimeout]], except it passes the following param values to an internal func: flag=1 and TimeSpan=0 (with [[#SetNotificationLedPatternWithTimeout]] these are flag=0 and TimeSpan={input value}).
Takes 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]].
== SetNotificationLedPatternWithTimeout ==
Takes an input [[#NotificationLedPattern]], an [[#UniquePadId]], and an s64 TimeSpan, no output.


== GetButtonConfigRight ==
== PrepareHidsForNotificationWake ==
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#SystemButtonConfigRight]].
Takes a type-0x9 input buffer containing an array of [[#UniquePadId]], no output.


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


== IsCustomButtonConfigSupported ==
== NotifyInputDetector ==
Takes an input [[#UniquePadId]], returns an output bool.
Takes an input u32 bitmask InputSourceId, no output.


== IsDefaultButtonConfigEmbedded ==
This is the only hid:sys command used by USB-sysmodule (with value 0x40).
Takes a type-0x15 input buffer containing a [[#ButtonConfigEmbedded]], returns an output bool.


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


== IsDefaultButtonConfigFull ==
== GetTouchScreenFirmwareVersion ==
Takes a type-0x15 input buffer containing a [[#ButtonConfigFull]], returns an output bool.
No input. Returns a [[#FirmwareVersion]].


This compares the input config with config in state, sets the output bool to whether these match, then returns 0.
This requests the current firmware version from the touch screen IC.


== IsDefaultButtonConfigLeft ==
It first ensures the touch screen IC's chip id is one of the following:
Takes a type-0x15 input buffer containing a [[#ButtonConfigLeft]], returns an output bool.
0x7036 - Ftm4cd60d (STMicroelectronics FingerTipS FT9CJ/FT9CF)
0x4036 - Fst2ba61ya1


This compares the input config with config in state, sets the output bool to whether these match, then returns 0.
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;


== IsDefaultButtonConfigRight ==
== IsFirmwareAvailableForNotification ==
Takes a type-0x15 input buffer containing a [[#ButtonConfigRight]], returns an output bool.
Takes a PID, a s32, an [[#UniquePadId]], an [[AM_services|AppletResourceUserId]], returns an output bool.


This compares the input config with config in state, sets the output bool to whether these match, then returns 0.
sdknso uses hard-coded value 1 for the s32.


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


[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.
== IsButtonConfigSupported ==
Takes an input [[#UniquePadId]], returns an output bool.


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.
[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], returns an output bool.


== IsButtonConfigStorageFullEmpty ==
== IsButtonConfigEmbeddedSupported ==
Takes an input s32 entry-index, returns an output bool.
No input, returns an output bool.


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


== IsButtonConfigStorageLeftEmpty ==
[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], no output.
Takes an input s32 entry-index, returns an output bool.


Same as [[#IsButtonConfigStorageEmbeddedEmpty]] except with a different setsys cmd.
== DeleteButtonConfigEmbedded ==
No input/output.


== IsButtonConfigStorageRightEmpty ==
== SetButtonConfigEnabled ==
Takes an input s32 entry-index, returns an output bool.
Takes an input bool, an [[#UniquePadId]], no output.


Same as [[#IsButtonConfigStorageEmbeddedEmpty]] except with a different setsys cmd.
[11.0.0+] Takes an input bool, an [[Bluetooth_Driver_services#Address|Address]], no output.


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


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


[11.0.0+] This now calls the same func internally as [[#GetButtonConfigStorageEmbedded]], except the [[#StorageName]] isn't exposed.
[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], returns an output bool.


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.
== IsButtonConfigEmbeddedEnabled ==
No input, returns an output bool.


== GetButtonConfigStorageFullDeprecated ==
== SetButtonConfigEmbedded ==
Takes an input s32 entry-index, and a type-0x16 output buffer containing a [[#ButtonConfigFull]].
Takes ([10.0.0-10.2.0] an input [[#UniquePadId]]), a type-0x15 input buffer containing a [[#SystemButtonConfigEmbedded]], no output.


Same as [[#GetButtonConfigStorageEmbeddedDeprecated]], except this uses a different setsys cmd, and uses a different conversion func / different output struct.
== SetButtonConfigFull ==
Takes an input [[#UniquePadId]], a type-0x15 input buffer containing a [[#SystemButtonConfigFull]], no output.


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


Same as [[#GetButtonConfigStorageEmbeddedDeprecated]], except this uses a different setsys cmd, and uses a different conversion func / different output struct.
== SetButtonConfigLeft ==
Takes an input [[#UniquePadId]], a type-0x15 input buffer containing a [[#SystemButtonConfigLeft]], no output.


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


Same as [[#GetButtonConfigStorageEmbeddedDeprecated]], except this uses a different setsys cmd, and uses a different conversion func / different output struct.
== SetButtonConfigRight ==
Takes an input [[#UniquePadId]], a type-0x15 input buffer containing a [[#SystemButtonConfigRight]], no output.


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


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


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


If the input config matches the [[#IsDefaultButtonConfigEmbedded|default]], this first does:
[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], and a type-0x16 output buffer containing a [[#SystemButtonConfigFull]].
* Uses [[Settings_services#GetButtonConfigSettingsEmbedded|GetButtonConfigSettingsEmbedded]] with count=5 (output s32 ignored). The input entry-index is used with this array. When [[Settings_services#ButtonConfigSettings|IsFull]] is set, the config is deleted the same way as [[#DeleteButtonConfigStorageEmbedded]] (following the IsFull check).


Afterwards, this uses [[Settings_services#GetButtonConfigSettingsEmbedded|GetButtonConfigSettingsEmbedded]] with count=5 (output s32 ignored). The input entry-index is used with this array. The input struct is converted, the output from that is copied to +0x1C8 size 0x3E0, IsFull is set, [[Settings_services#SetButtonConfigSettingsEmbedded|SetButtonConfigSettingsEmbedded]] is used with the updated array, and then returns 0.
== GetButtonConfigLeft ==
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#SystemButtonConfigLeft]].


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


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


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


Same as [[#SetButtonConfigStorageEmbeddedDeprecated]], except this uses different setsys cmds, and uses a different structs etc.
== IsCustomButtonConfigSupported ==
Takes an input [[#UniquePadId]], returns an output bool.


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


Same as [[#SetButtonConfigStorageEmbeddedDeprecated]], except this uses different setsys cmds, and uses a different structs etc.
This compares the input config with config in state, sets the output bool to whether these match, then returns 0.


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


[10.1.0-10.2.0] This will now Abort if the s32 is negative or >=5. [11.0.0+] When the input s32 is larger than unsigned value 4, an error is returned.
This compares the input config with config in state, sets the output bool to whether these match, 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.
== IsDefaultButtonConfigLeft ==
Takes a type-0x15 input buffer containing a [[#ButtonConfigLeft]], returns an output bool.


== DeleteButtonConfigStorageFull ==
This compares the input config with config in state, sets the output bool to whether these match, then returns 0.
Takes an input s32 entry-index, no output.


Same as [[#DeleteButtonConfigStorageEmbedded]] except with different setsys cmds.
== IsDefaultButtonConfigRight ==
Takes a type-0x15 input buffer containing a [[#ButtonConfigRight]], returns an output bool.


== DeleteButtonConfigStorageLeft ==
This compares the input config with config in state, sets the output bool to whether these match, then returns 0.
Takes an input s32 entry-index, no output.


Same as [[#DeleteButtonConfigStorageEmbedded]] except with different setsys cmds.
== IsButtonConfigStorageEmbeddedEmpty ==
Takes an input s32 entry-index, returns an output bool.


== DeleteButtonConfigStorageRight ==
[10.1.0-10.2.0] This will now Abort if the s32 is negative or >=5. [11.0.0+] This value must now be unsigned <=4, otherwise 0 is returned.
Takes an input s32 entry-index, no output.


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


== IsUsingCustomButtonConfig ==
== IsButtonConfigStorageFullEmpty ==
Takes an input [[#UniquePadId]], returns an output bool.
Takes an input s32 entry-index, returns an output bool.


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


== SetAllCustomButtonConfigEnabled ==
== IsButtonConfigStorageLeftEmpty ==
Takes an input bool and an AppletResourceUserId, no output.
Takes an input s32 entry-index, returns an output bool.


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


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


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


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


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


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


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


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


== GetHidButtonConfigLeft ==
Same as [[#GetButtonConfigStorageEmbeddedDeprecated]], except this uses a different setsys cmd, and uses a different conversion func / different output struct.
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#ButtonConfigLeft]].


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


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


When the input s32 is larger than unsigned value 4, an error is returned.
== GetButtonConfigStorageRightDeprecated ==
Takes an input s32 entry-index, and a type-0x16 output buffer containing a [[#ButtonConfigRight]].


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


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


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


== SetButtonConfigStorageEmbedded ==
[11.0.0+] This now calls the same func internally as [[#SetButtonConfigStorageEmbedded]], except the [[#StorageName]] isn't exposed.
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).
If the input config matches the [[#IsDefaultButtonConfigEmbedded|default]], this first does:
* Uses [[Settings_services#GetButtonConfigSettingsEmbedded|GetButtonConfigSettingsEmbedded]] with count=5 (output s32 ignored). The input entry-index is used with this array. When [[Settings_services#ButtonConfigSettings|IsFull]] is set, the config is deleted the same way as [[#DeleteButtonConfigStorageEmbedded]] (following the IsFull check).


== SetButtonConfigStorageFull ==
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.
Takes an input s32, a type-0x15 input buffer containing a [[#ButtonConfigFull]], a type-0x19 input buffer containing a [[#StorageName]].


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


== SetButtonConfigStorageRight ==
Same as [[#SetButtonConfigStorageEmbeddedDeprecated]], except this uses different setsys cmds, and uses a different structs etc.
Takes an input s32, a type-0x15 input buffer containing a [[#ButtonConfigRight]], a type-0x19 input buffer containing a [[#StorageName]].


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


This was added with [5.0.0+].
Same as [[#SetButtonConfigStorageEmbeddedDeprecated]], except this uses different setsys cmds, and uses a different structs etc.


{| class="wikitable" border="1"
== SetButtonConfigStorageRightDeprecated ==
|-
Takes an input s32 entry-index, and a type-0x15 input buffer containing a [[#ButtonConfigRight]].
! Cmd || Name
 
|-
Same as [[#SetButtonConfigStorageEmbeddedDeprecated]], except this uses different setsys cmds, and uses a different structs etc.
| 500 || SetAppletResourceUserId
 
|-
== DeleteButtonConfigStorageEmbedded ==
| 501 || RegisterAppletResourceUserId
Takes an input s32 entry-index, no output.
|-
 
| 502 || UnregisterAppletResourceUserId
[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.
 
== DeleteButtonConfigStorageFull ==
Takes an input s32 entry-index, no output.
 
Same as [[#DeleteButtonConfigStorageEmbedded]] except with different setsys cmds.


= hid:tmp =
== DeleteButtonConfigStorageLeft ==
This is "nn::hid::IHidTemporaryServer".
Takes an input s32 entry-index, no output.


This service was added with [3.0.0+], then removed with [8.0.0+].
Same as [[#DeleteButtonConfigStorageEmbedded]] except with different setsys cmds.


{| class="wikitable" border="1"
== DeleteButtonConfigStorageRight ==
|-
Takes an input s32 entry-index, no output.
! Cmd || Name
|-
| 0 || GetConsoleSixAxisSensorCalibrationValues
|}


= irs =
Same as [[#DeleteButtonConfigStorageEmbedded]] except with different setsys cmds.
This is "nn::irsensor::IIrSensorServer".


This was added to sdknso with 3.x.
== IsUsingCustomButtonConfig ==
Takes an input [[#UniquePadId]], returns an output bool.


With sdknso versions pre-4.x PointingProcessor used to be DpdProcessor. The [[#PackedPointingProcessorConfig|packed-config]] with DpdProcessor (besides RequiredMcuVersion) used to be initialized from user-specified config, now it's hard-coded.
== IsAnyCustomButtonConfigEnabled ==
No input, returns an output bool.


{| class="wikitable" border="1"
== SetAllCustomButtonConfigEnabled ==
|-
Takes an input bool and an AppletResourceUserId, no output.
! Cmd || Name
|-
| 302 || [[#ActivateIrsensor]]
|-
| 303 || [[#DeactivateIrsensor]]
|-
| 304 || [[#GetIrsensorSharedMemoryHandle]]
|-
| 305 || [[#StopImageProcessor]]
|-
| 306 || [[#RunMomentProcessor]]
|-
| 307 || [[#RunClusteringProcessor]]
|-
| 308 || [[#RunImageTransferProcessor]]
|-
| 309 || [[#GetImageTransferProcessorState]]
|-
| 310 || [[#RunTeraPluginProcessor]]
|-
| 311 || [[#GetNpadIrCameraHandle]]
|-
| 312 || [[#RunPointingProcessor]]
|-
| 313 || [[#SuspendImageProcessor]]
|-
| 314 || [3.0.0+] [[#CheckFirmwareVersion]]
|-
| 315 || [4.0.0+] [[#SetFunctionLevel]]
|-
| 316 || [4.0.0+] [[#RunImageTransferExProcessor]]
|-
| 317 || [4.0.0+] [[#RunIrLedProcessor]]
|-
| 318 || [4.0.0+] [[#StopImageProcessorAsync]]
|-
| 319 || [4.0.0+] [[#ActivateIrsensorWithFunctionLevel]]
|}


== ActivateIrsensor ==
== SetDefaultButtonConfig ==
Takes a PID-descriptor and an [[AM_services|AppletResourceUserId]]. No output.
Takes an input [[#UniquePadId]], no output.


== DeactivateIrsensor ==
== SetAllDefaultButtonConfig ==
Takes a PID-descriptor and an [[AM_services|AppletResourceUserId]]. No output.
No input/output.


== GetIrsensorSharedMemoryHandle ==
== SetHidButtonConfigEmbedded ==
Takes a PID-descriptor and an [[AM_services|AppletResourceUserId]]. Returns a SharedMemory handle.
Takes an input [[#UniquePadId]] and a type-0x15 input buffer containing a [[#ButtonConfigEmbedded]], no output.


The SharedMemory is "nn::irsensor::detail::StatusManager". It's mapped with permission read-only and size 0x8000.
== SetHidButtonConfigFull ==
Takes an input [[#UniquePadId]] and a type-0x15 input buffer containing a [[#ButtonConfigFull]], no output.


It's structure is as follows:
== SetHidButtonConfigLeft ==
Takes an input [[#UniquePadId]] and a type-0x15 input buffer containing a [[#ButtonConfigLeft]], no output.


{| class="wikitable" border="1"
== SetHidButtonConfigRight ==
|-
Takes an input [[#UniquePadId]] and a type-0x15 input buffer containing a [[#ButtonConfigRight]], no output.
! Offset || Size || Description
|-
| 0x0 || 0x7FB0 || Array of [[#DeviceFormat]]
|-
| 0x7FB0 || 0x50 || Array of [[#AruidFormat]]
|}


The array of [[#DeviceFormat]] is indexed by [[#IrCameraHandle|PlayerNumber]] and can hold up to 9 entries. The array of [[#AruidFormat]] can only hold up to 5 entries.
== GetHidButtonConfigEmbedded ==
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#ButtonConfigEmbedded]].


=== DeviceFormat ===
== GetHidButtonConfigFull ==
{| class="wikitable" border="1"
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#ButtonConfigFull]].
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || [[#IrCameraStatus]]
|-
| 0x4 || 0x4 || [[#IrCameraInternalStatus]]
|-
| 0x8 || 0x8 || [[#IrSensorMode]]
|-
| 0x10 || 0xE20 || [[#ProcessorStateRingLifo]]
|}


==== ProcessorStateRingLifo ====
== GetHidButtonConfigLeft ==
This is "nn::irsensor::detail::RingLifo<X,Y>" where "X" is a specialized processor state (e.g.: "nn::irsensor::MomentProcessorState") and "Y" is the maximum element count (e.g.: 5).
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#ButtonConfigLeft]].


{| class="wikitable" border="1"
== GetHidButtonConfigRight ==
|-
Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#ButtonConfigRight]].
! Offset || Size || Description
|-
| 0x0 || 0x8 || Start
|-
| 0x8 || 0x4 || Count
|-
| 0xC || 0x4 || Padding
|-
| 0x10 || Variable || ProcessorState
|}


The maximum element count is 6 for [[#PointingProcessorMarkerState]] or 5 for any of the other states.
== GetButtonConfigStorageEmbedded ==
Takes an input s32, a type-0x16 output buffer containing a [[#ButtonConfigEmbedded]], a type-0x1A output buffer containing a [[#StorageName]].


ProcessorState is specialized depending on the value of [[#IrSensorMode]].
When the input s32 is larger than unsigned value 4, an error is returned.


===== MomentProcessorState =====
== GetButtonConfigStorageFull ==
This is "nn::irsensor::MomentProcessorState".
Takes an input s32, a type-0x16 output buffer containing a [[#ButtonConfigFull]], a type-0x1A output buffer containing a [[#StorageName]].


{| class="wikitable" border="1"
== GetButtonConfigStorageLeft ==
|-
Takes an input s32, a type-0x16 output buffer containing a [[#ButtonConfigLeft]], a type-0x1A output buffer containing a [[#StorageName]].
! Offset || Size || Description
|-
| 0x0 || 0x8 || SamplingNumber
|-
| 0x8 || 0x8 || TimeStamp
|-
| 0x10 || 0x4 || AmbientNoiseLevel
|-
| 0x14 || 0x4 || Reserved
|-
| 0x18 || 0x240 || Array of [[#MomentStatistic]]
|}


The array of [[#MomentStatistic]] can hold up to 48 entries. This array can be accessed as [y + x*8] (this is a 6x8 array). region_x = image_x/6, region_y = image_y/8.
== GetButtonConfigStorageRight ==
Takes an input s32, a type-0x16 output buffer containing a [[#ButtonConfigRight]], a type-0x1A output buffer containing a [[#StorageName]].


====== MomentStatistic ======
== SetButtonConfigStorageEmbedded ==
In sdknso GetMomentProcessorStates, this loops through each MomentProcessorState->MomentStatistic entry: <code>AverageIntensity *= scale;</code> The scale is calculated with: <code>scale = 76800.0f / (float)([[#PackedMomentProcessorConfig|WindowOfInterest]].width * [[#PackedMomentProcessorConfig|WindowOfInterest]].height);</code> Note that <code>76800 == 320*240</code>, hence with the default width/height the calculated scale is 1.0f.
Takes an input s32, a type-0x15 input buffer containing a [[#ButtonConfigEmbedded]], a type-0x19 input buffer containing a [[#StorageName]].
 
When the input s32 is larger than unsigned value 4, this will immediately return (this cmd always returns 0 regardless).
 
== SetButtonConfigStorageFull ==
Takes an input s32, a type-0x15 input buffer containing a [[#ButtonConfigFull]], a type-0x19 input buffer containing a [[#StorageName]].
 
== SetButtonConfigStorageLeft ==
Takes an input s32, a type-0x15 input buffer containing a [[#ButtonConfigLeft]], a type-0x19 input buffer containing a [[#StorageName]].
 
== SetButtonConfigStorageRight ==
Takes an input s32, a type-0x15 input buffer containing a [[#ButtonConfigRight]], a type-0x19 input buffer containing a [[#StorageName]].
 
== Cmd1470 ==
This is exclusive to S2.
 
This is likely SetSelectorUiPresentationPolicy?
 
Takes a PID, an u8 SelectorUiPresentationPolicy, an [[AM_services|AppletResourceUserId]], no output.
 
== Cmd1471 ==
This is exclusive to S2.
 
This is likely GetSelectorUiPresentationPolicy?
 
Takes a PID, an [[AM_services|AppletResourceUserId]], returns an output u8 SelectorUiPresentationPolicy.
 
== IHidbusSystemServer ==
This is "nn::hidbus::IHidbusSystemServer".
 
This was added with [5.0.0+].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Cmd || Name
|-
|-
| 0x0 || 0x4 || float AverageIntensity
| 500 || SetAppletResourceUserId
|-
|-
| 0x4 || 0x4 || float CentroidX
| 501 || RegisterAppletResourceUserId
|-
|-
| 0x8 || 0x4 || float CentroidY
| 502 || UnregisterAppletResourceUserId
|}
|}


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


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


The array of [[#ClusteringData]] can hold up to 16 entries.
= irs =
This is "nn::irsensor::IIrSensorServer".
 
This was added to sdknso with 3.x.
 
With sdknso versions pre-4.x PointingProcessor used to be DpdProcessor. The [[#PackedPointingProcessorConfig|packed-config]] with DpdProcessor (besides RequiredMcuVersion) used to be initialized from user-specified config, now it's hard-coded.


====== ClusteringData ======
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Cmd || Name
|-
|-
| 0x0 || 0x4 || float AverageIntensity
| 302 || [[#ActivateIrsensor]]
|-
|-
| 0x4 || 0x4 || float CentroidX
| 303 || [[#DeactivateIrsensor]]
|-
|-
| 0x8 || 0x4 || float CentroidY
| 304 || [[#GetIrsensorSharedMemoryHandle]]
|-
|-
| 0xC || 0x4 || PixelCount
| 305 || [[#StopImageProcessor]]
|-
|-
| 0x10 || 0x2 || BoundX
| 306 || [[#RunMomentProcessor]]
|-
|-
| 0x12 || 0x2 || BoundY
| 307 || [[#RunClusteringProcessor]]
|-
|-
| 0x14 || 0x2 || BoundtWidth
| 308 || [[#RunImageTransferProcessor]]
|-
|-
| 0x16 || 0x2 || BoundHeight
| 309 || [[#GetImageTransferProcessorState]]
|}
 
===== PointingProcessorMarkerState =====
This is "nn::irsensor::PointingProcessorMarkerState".
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 310 || [[#RunTeraPluginProcessor]]
|-
|-
| 0x0 || 0x8 || SamplingNumber
| 311 || [[#GetNpadIrCameraHandle]]
|-
|-
| 0x8 || 0x8 || TimeStamp
| 312 || [[#RunPointingProcessor]]
|-
|-
| 0x10 || 0x1 || PointingStatus
| 313 || [[#SuspendImageProcessor]]
|-
|-
| 0x11 || 0x3 || Reserved
| 314 || [3.0.0+] [[#CheckFirmwareVersion]]
|-
|-
| 0x14 || 0x4 || Unknown
| 315 || [4.0.0+] [[#SetFunctionLevel]]
|-
|-
| 0x18 || 0x4 || float Unknown
| 316 || [4.0.0+] [[#RunImageTransferExProcessor]]
|-
|-
| 0x1C || 0x4 || float PositionX
| 317 || [4.0.0+] [[#RunIrLedProcessor]]
|-
|-
| 0x20 || 0x4 || float PositionY
| 318 || [4.0.0+] [[#StopImageProcessorAsync]]
|-
|-
| 0x24 || 0x4 || float Unknown
| 319 || [4.0.0+] [[#ActivateIrsensorWithFunctionLevel]]
|}
 
== ActivateIrsensor ==
Takes a PID-descriptor and an [[AM_services|AppletResourceUserId]]. No output.
 
== DeactivateIrsensor ==
Takes a PID-descriptor and an [[AM_services|AppletResourceUserId]]. No output.
 
== GetIrsensorSharedMemoryHandle ==
Takes a PID-descriptor and an [[AM_services|AppletResourceUserId]]. Returns a SharedMemory handle.
 
The SharedMemory is "nn::irsensor::detail::StatusManager". It's mapped with permission read-only and size 0x8000.
 
It's structure is as follows:
 
{| class="wikitable" border="1"
|-
|-
| 0x28 || 0x2 || WindowOfInterestX
! Offset || Size || Description
|-
|-
| 0x2A || 0x2 || WindowOfInterestY
| 0x0 || 0x7FB0 || Array of [[#DeviceFormat]]
|-
|-
| 0x2C || 0x2 || WindowOfInterestWidth
| 0x7FB0 || 0x50 || Array of [[#AruidFormat]]
|}
 
The array of [[#DeviceFormat]] is indexed by [[#IrCameraHandle|PlayerNumber]] and can hold up to 9 entries. The array of [[#AruidFormat]] can only hold up to 5 entries.
 
=== DeviceFormat ===
{| class="wikitable" border="1"
|-
|-
| 0x2E || 0x2 || WindowOfInterestHeight
! Offset || Size || Description
|-
|-
| 0x30 || 0x1 || PointingStatus
| 0x0 || 0x4 || [[#IrCameraStatus]]
|-
|-
| 0x31 || 0x3 || Reserved
| 0x4 || 0x4 || [[#IrCameraInternalStatus]]
|-
|-
| 0x34 || 0x4 || Unknown
| 0x8 || 0x8 || [[#IrSensorMode]]
|-
|-
| 0x38 || 0x4 || float Unknown
| 0x10 || 0xE20 || [[#ProcessorStateRingLifo]]
|}
 
==== ProcessorStateRingLifo ====
This is "nn::irsensor::detail::RingLifo<X,Y>" where "X" is a specialized processor state (e.g.: "nn::irsensor::MomentProcessorState") and "Y" is the maximum element count (e.g.: 5).
 
{| class="wikitable" border="1"
|-
|-
| 0x3C || 0x4 || float PositionX
! Offset || Size || Description
|-
|-
| 0x40 || 0x4 || float PositionY
| 0x0 || 0x8 || Start
|-
|-
| 0x44 || 0x4 || float Unknown
| 0x8 || 0x4 || Count
|-
|-
| 0x48 || 0x2 || WindowOfInterestX
| 0xC || 0x4 || Padding
|-
|-
| 0x4A || 0x2 || WindowOfInterestY
| 0x10 || Variable || ProcessorState
|}
 
The maximum element count is 6 for [[#PointingProcessorMarkerState]] or 5 for any of the other states.
 
ProcessorState is specialized depending on the value of [[#IrSensorMode]].
 
===== MomentProcessorState =====
This is "nn::irsensor::MomentProcessorState".
 
{| class="wikitable" border="1"
|-
|-
| 0x4C || 0x2 || WindowOfInterestWidth
! Offset || Size || Description
|-
|-
| 0x4E || 0x2 || WindowOfInterestHeight
| 0x0 || 0x8 || SamplingNumber
|-
|-
| 0x50 || 0x1 || PointingStatus
| 0x8 || 0x8 || TimeStamp
|-
|-
| 0x51 || 0x3 || Reserved
| 0x10 || 0x4 || AmbientNoiseLevel
|-
|-
| 0x54 || 0x4 || Unknown
| 0x14 || 0x4 || Reserved
|-
|-
| 0x58 || 0x4 || float Unknown
| 0x18 || 0x240 || Array of [[#MomentStatistic]]
|}
 
The array of [[#MomentStatistic]] can hold up to 48 entries. This array can be accessed as [y + x*8] (this is a 6x8 array). region_x = image_x/6, region_y = image_y/8.
 
====== MomentStatistic ======
In sdknso GetMomentProcessorStates, this loops through each MomentProcessorState->MomentStatistic entry: <code>AverageIntensity *= scale;</code> The scale is calculated with: <code>scale = 76800.0f / (float)([[#PackedMomentProcessorConfig|WindowOfInterest]].width * [[#PackedMomentProcessorConfig|WindowOfInterest]].height);</code> Note that <code>76800 == 320*240</code>, hence with the default width/height the calculated scale is 1.0f.
 
{| class="wikitable" border="1"
|-
|-
| 0x5C || 0x4 || float PositionX
! Offset || Size || Description
|-
|-
| 0x60 || 0x4 || float PositionY
| 0x0 || 0x4 || float AverageIntensity
|-
|-
| 0x64 || 0x4 || float Unknown
| 0x4 || 0x4 || float CentroidX
|-
|-
| 0x68 || 0x2 || WindowOfInterestX
| 0x8 || 0x4 || float CentroidY
|-
| 0x6A || 0x2 || WindowOfInterestY
|-
| 0x6C || 0x2 || WindowOfInterestWidth
|-
| 0x6E || 0x2 || WindowOfInterestHeight
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 2,618: Line 3,117:
| 0x8 || 0x8 || TimeStamp
| 0x8 || 0x8 || TimeStamp
|-
|-
| 0x10 || 0x4 || PointingStatus
| 0x10 || 0x1 || ObjectCount
|-
|-
| 0x14 || 0x4 || float PositionX
| 0x11 || 0x3 || Reserved
|-
|-
| 0x18 || 0x4 || float PositionY
| 0x14 || 0x4 || AmbientNoiseLevel
|-
|-
| 0x1C || 0x4 || Reserved
| 0x18 || 0x180 || Array of [[#ClusteringData]]
|}
|}


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


====== ClusteringData ======
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x8 || SamplingNumber
| 0x0 || 0x4 || float AverageIntensity
|-
| 0x4 || 0x4 || float CentroidX
|-
| 0x8 || 0x4 || float CentroidY
|-
| 0xC || 0x4 || PixelCount
|-
| 0x10 || 0x2 || BoundX
|-
|-
| 0x8 || 0x8 || TimeStamp
| 0x12 || 0x2 || BoundY
|-
|-
| 0x10 || 0x4 || AmbientNoiseLevel
| 0x14 || 0x2 || BoundtWidth
|-
|-
| 0x14 || 0x12C || PluginData
| 0x16 || 0x2 || BoundHeight
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 2,656: Line 3,161:
| 0x8 || 0x8 || TimeStamp
| 0x8 || 0x8 || TimeStamp
|-
|-
| 0x10 || 0x4 || AmbientNoiseLevel
| 0x10 || 0x1 || PointingStatus
|-
|-
| 0x14 || 0x4 || AccuracyLevel
| 0x11 || 0x3 || Reserved
|-
|-
| 0x18 || 0x1 || ObjectCount
| 0x14 || 0x4 || Unknown
|-
|-
| 0x19 || 0x1 || BackgroundIntensity
| 0x18 || 0x4 || float Unknown
|-
|-
| 0x1A || 0x6 || Reserved
| 0x1C || 0x4 || float PositionX
|-
|-
| 0x20 || 0x200 || Array of [[#AdaptiveClusteringData]]
| 0x20 || 0x4 || float PositionY
|}
 
The array of [[#AdaptiveClusteringData]] can hold up to 16 entries.
 
====== AdaptiveClusteringData ======
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 0x24 || 0x4 || float Unknown
|-
|-
| 0x0 || 0x4 || float CentroidX
| 0x28 || 0x2 || WindowOfInterestX
|-
|-
| 0x4 || 0x4 || float CentroidY
| 0x2A || 0x2 || WindowOfInterestY
|-
|-
| 0x8 || 0x4 || float Area
| 0x2C || 0x2 || WindowOfInterestWidth
|-
|-
| 0xC || 0x4 || IsIncomplete
| 0x2E || 0x2 || WindowOfInterestHeight
|}
 
===== HandAnalysisImageState =====
This is "nn::irsensor::HandAnalysisImageState".
 
This is created from [[#TeraPluginProcessorState]].
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 0x30 || 0x1 || PointingStatus
|-
|-
| 0x0 || 0x8 || SamplingNumber
| 0x31 || 0x3 || Reserved
|-
|-
| 0x8 || 0x4 || AmbientNoiseLevel
| 0x34 || 0x4 || Unknown
|-
|-
| 0xC || 0x960 || Image
| 0x38 || 0x4 || float Unknown
|-
|-
| 0x96C || 0x4 || Reserved
| 0x3C || 0x4 || float PositionX
|}
 
===== HandAnalysisSilhouetteState =====
This is "nn::irsensor::HandAnalysisSilhouetteState".
 
This is created from [[#TeraPluginProcessorState]].
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 0x40 || 0x4 || float PositionY
|-
|-
| 0x0 || 0x8 || SamplingNumber
| 0x44 || 0x4 || float Unknown
|-
|-
| 0x8 || 0x4 || AmbientNoiseLevel
| 0x48 || 0x2 || WindowOfInterestX
|-
|-
| 0xC || 0x1354 || Unknown
| 0x4A || 0x2 || WindowOfInterestY
|}
|-
 
| 0x4C || 0x2 || WindowOfInterestWidth
===== HandAnalysisSilhouetteStateWithFullFrameShape =====
|-
This is "nn::irsensor::HandAnalysisSilhouetteStateWithFullFrameShape".
| 0x4E || 0x2 || WindowOfInterestHeight
 
|-
This is created from [[#TeraPluginProcessorState]].
| 0x50 || 0x1 || PointingStatus
 
|-
{| class="wikitable" border="1"
| 0x51 || 0x3 || Reserved
|-
| 0x54 || 0x4 || Unknown
|-
| 0x58 || 0x4 || float Unknown
|-
| 0x5C || 0x4 || float PositionX
|-
| 0x60 || 0x4 || float PositionY
|-
| 0x64 || 0x4 || float Unknown
|-
| 0x68 || 0x2 || WindowOfInterestX
|-
| 0x6A || 0x2 || WindowOfInterestY
|-
| 0x6C || 0x2 || WindowOfInterestWidth
|-
| 0x6E || 0x2 || WindowOfInterestHeight
|}
 
===== PointingProcessorState =====
This is "nn::irsensor::PointingProcessorState".
 
This is created from [[#PointingProcessorMarkerState]].
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset || Size || Description
Line 2,730: Line 3,239:
| 0x0 || 0x8 || SamplingNumber
| 0x0 || 0x8 || SamplingNumber
|-
|-
| 0x8 || 0x4 || AmbientNoiseLevel
| 0x8 || 0x8 || TimeStamp
|-
| 0x10 || 0x4 || PointingStatus
|-
| 0x14 || 0x4 || float PositionX
|-
| 0x18 || 0x4 || float PositionY
|-
|-
| 0xC || 0x156C || Unknown
| 0x1C || 0x4 || Reserved
|}
|}


=== AruidFormat ===
===== TeraPluginProcessorState =====
This is "nn::irsensor::TeraPluginProcessorState".
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x8 || IrSensorAruid
| 0x0 || 0x8 || SamplingNumber
|-
| 0x8 || 0x8 || TimeStamp
|-
| 0x10 || 0x4 || AmbientNoiseLevel
|-
|-
| 0x8 || 0x8 || IrSensorAruidStatus
| 0x14 || 0x12C || PluginData
|}
|}


== StopImageProcessor ==
===== AdaptiveClusteringProcessorState =====
Takes a PID-descriptor, an [[#IrCameraHandle]], and an [[AM_services|AppletResourceUserId]]. No output.
This is "nn::irsensor::AdaptiveClusteringProcessorState".


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
! Offset || Size || Description
|-
| 0x0 || 0x8 || SamplingNumber
|-
| 0x8 || 0x8 || TimeStamp
|-
|-
| 500 || [[#SetAppletResourceUserId]]
| 0x10 || 0x4 || AmbientNoiseLevel
|-
|-
| 501 || [[#RegisterAppletResourceUserId]]
| 0x14 || 0x4 || AccuracyLevel
|-
|-
| 502 || [[#UnregisterAppletResourceUserId]]
| 0x18 || 0x1 || ObjectCount
|-
|-
| 503 || [[#EnableAppletToGetInput]]
| 0x19 || 0x1 || BackgroundIntensity
|-
| 0x1A || 0x6 || Reserved
|-
| 0x20 || 0x200 || Array of [[#AdaptiveClusteringData]]
|}
|}


== SetAppletResourceUserId ==
The array of [[#AdaptiveClusteringData]] can hold up to 16 entries.
Takes an [[AM_services|AppletResourceUserId]]. No output.


== RegisterAppletResourceUserId ==
====== AdaptiveClusteringData ======
Takes a bool and an [[AM_services|AppletResourceUserId]]. No output.
{| class="wikitable" border="1"
|-
! Offset || Size || Description
|-
| 0x0 || 0x4 || float CentroidX
|-
| 0x4 || 0x4 || float CentroidY
|-
| 0x8 || 0x4 || float Area
|-
| 0xC || 0x4 || IsIncomplete
|}


== UnregisterAppletResourceUserId ==
===== HandAnalysisImageState =====
Takes an [[AM_services|AppletResourceUserId]]. No output.
This is "nn::irsensor::HandAnalysisImageState".


== EnableAppletToGetInput ==
This is created from [[#TeraPluginProcessorState]].
Takes a bool and an [[AM_services|AppletResourceUserId]]. No output.
 
= ahid:cd =
This is "nn::ahid::IServerSession".
 
Used for USB HID devices.
 
This service no longer exists in [9.0.0+].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
! Offset || Size || Description
|-
|-
| 0 || [[#AcquireDevice]]
| 0x0 || 0x8 || SamplingNumber
|-
|-
| 1 || [[#ReleaseDevice]]
| 0x8 || 0x4 || AmbientNoiseLevel
|-
|-
| 2 || [[#GetCtrlSession]]
| 0xC || 0x960 || Image
|-
|-
| 3 || [[#GetReadSession]]
| 0x96C || 0x4 || Reserved
|-
| 4 || [1.0.0-2.3.0] [[#GetWriteSession]]
|}
|}


== AcquireDevice ==
===== HandAnalysisSilhouetteState =====
Takes an input s32, no output.
This is "nn::irsensor::HandAnalysisSilhouetteState".


== ReleaseDevice ==
This is created from [[#TeraPluginProcessorState]].
Takes an input s32, no output.


== GetCtrlSession ==
{| class="wikitable" border="1"
Takes an input u32, returns an [[#ICtrlSession]].
|-
 
! Offset || Size || Description
== GetReadSession ==
|-
Takes an input u32, returns an [[#IReadSession]].
| 0x0 || 0x8 || SamplingNumber
|-
| 0x8 || 0x4 || AmbientNoiseLevel
|-
| 0xC || 0x1354 || Unknown
|}


== GetWriteSession ==
===== HandAnalysisSilhouetteStateWithFullFrameShape =====
Takes an input u32, returns an [[#IWriteSession]].
This is "nn::irsensor::HandAnalysisSilhouetteStateWithFullFrameShape".


== ICtrlSession ==
This is created from [[#TeraPluginProcessorState]].
This is "nn::ahid::ICtrlSession".
 
This no longer exists in [9.0.0+].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Cmd || Name
! Offset || Size || Description
|-
|-
| 0 || GetString
| 0x0 || 0x8 || SamplingNumber
|-
|-
| 1 || GetCodeBook
| 0x8 || 0x4 || AmbientNoiseLevel
|-
|-
| 2 || GetReport
| 0xC || 0x156C || Unknown
|}
 
=== AruidFormat ===
{| class="wikitable" border="1"
|-
|-
| 3 || SetReport
! Offset || Size || Description
|-
|-
| 4 || GetIdle
| 0x0 || 0x8 || IrSensorAruid
|-
|-
| 5 || SetIdle
| 0x8 || 0x8 || IrSensorAruidStatus
|-
| 6 || GetProtocol
|-
| 7 || SetProtocol
|-
| 8 || GetDescriptor
|-
| 9 || SetDescriptor
|-
| 10 || GetStateChangeEvent
|-
| 11 || SignalStateChangeEvent
|-
| 12 || [3.0.0+] Write
|}
|}


All of these use USB [[USB_services|CtrlXfer]], except for GetStateChangeEvent and SignalStateChangeEvent, and GetCodeBook which copies 0x4000-bytes from state to output.
== StopImageProcessor ==
Takes a PID-descriptor, an [[#IrCameraHandle]], and an [[AM_services|AppletResourceUserId]]. No output.


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


This no longer exists in [9.0.0+].
== RunClusteringProcessor ==
Takes a PID-descriptor, an [[#IrCameraHandle]], an [[AM_services|AppletResourceUserId]], and a [[#PackedClusteringProcessorConfig]]. No output.


{| class="wikitable" border="1"
== RunImageTransferProcessor ==
|-
Takes a PID-descriptor, an [[#IrCameraHandle]], an [[AM_services|AppletResourceUserId]], a [[#PackedImageTransferProcessorConfig]], an u64 for the TransferMemory's size, and a TransferMemory handle. No output.
! Cmd || Name
 
|-
The TransferMemory is created with an user specified buffer and permission none.
| 0 || [[#Read]]
 
|}
== GetImageTransferProcessorState ==
Takes a PID-descriptor, a type-0x6 output buffer, an [[#IrCameraHandle]], and an [[AM_services|AppletResourceUserId]]. Returns an [[#ImageTransferProcessorState]]. No output.
 
== RunTeraPluginProcessor==
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedTeraPluginProcessorConfig]] (immediately after the previous word), and an [[AM_services|AppletResourceUserId]]. No output.
 
== GetNpadIrCameraHandle ==
Takes an input [[#NpadIdType]]. Returns an output [[#IrCameraHandle]].
 
== RunPointingProcessor ==
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedPointingProcessorConfig]] (immediately after the previous word), and an [[AM_services|AppletResourceUserId]]. No output.
 
== SuspendImageProcessor ==
Takes a PID-descriptor, an [[#IrCameraHandle]], and an [[AM_services|AppletResourceUserId]]. No output.
 
sdknso uses this from the Run*Processor funcs to suspend the current Processor when the current [[#PackedFunctionLevel|FunctionLevel]] is >= 0x1, prior to starting another Processor if needed (depending on  what Processor was already active via a state field). Hence, this cmd is only used with [4.0.0+].


=== Read ===
== CheckFirmwareVersion ==
Uses [[USB_services|PostBufferAsync]] etc with the INPUT endpoint. The size must be <=0x1000. The actual transfer size is returned in an output u64. The data is copied from the tmpbuf to the output buffer using the actual-transfer-size.
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedMcuVersion]], and an [[AM_services|AppletResourceUserId]]. No output.


[3.0.0+] Now takes a total of 8-bytes of input.
sdknso didn't actually use this until 4.x (the RequiredMcuVersion was also updated with that version).


== IWriteSession ==
== SetFunctionLevel ==
This is "nn::ahid::IWriteSession".
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedFunctionLevel]], and an [[AM_services|AppletResourceUserId]]. No output.


This was removed with [3.0.0+].
== RunImageTransferExProcessor ==
Takes a PID-descriptor, an [[#IrCameraHandle]], an [[AM_services|AppletResourceUserId]], a [[#PackedImageTransferProcessorExConfig]], an u64 for the TransferMemory's size, and a TransferMemory handle. No output.


{| class="wikitable" border="1"
The TransferMemory is created with an user specified buffer and permission none.
|-
! Cmd || Name
|-
| 0 || [[#Write]]
|}


=== Write ===
== RunIrLedProcessor ==
This is the inverse of [[#IReadSession]] cmd0. Uses the OUTPUT endpoint with an input buffer.
Takes a PID-descriptor, an [[#IrCameraHandle]], a [[#PackedIrLedProcessorConfig]] (immediately after the previous word), and an [[AM_services|AppletResourceUserId]]. No output.


= ahid:hdr =
== StopImageProcessorAsync ==
This is "nn::ahid::hdr::ISession".
Takes a PID-descriptor, an [[#IrCameraHandle]], and an [[AM_services|AppletResourceUserId]]. No output.


Used internally for USB HID devices.
== ActivateIrsensorWithFunctionLevel ==
Takes a PID-descriptor, an [[#PackedFunctionLevel]], and an [[AM_services|AppletResourceUserId]]. No output.


This service no longer exists in [9.0.0+].
= irs:sys =
This is "nn::irsensor::IIrSensorSystemServer".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 2,944: Line 3,428:
! Cmd || Name
! Cmd || Name
|-
|-
| 0 || GetDeviceEntries
| 500 || [[#SetAppletResourceUserId]]
|-
|-
| 1 || GetDeviceList
| 501 || [[#RegisterAppletResourceUserId]]
|-
|-
| 2 || GetDeviceParameters
| 502 || [[#UnregisterAppletResourceUserId]]
|-
|-
| 3 || AttachDevice
| 503 || [[#EnableAppletToGetInput]]
|-
| 4 || DetachDevice
|-
| 5 || [6.0.0+] SetDeviceFilter
|}
|}


= xcd:sys =
== SetAppletResourceUserId ==
This is "nn::xcd::detail::ISystemServer".
Takes an [[AM_services|AppletResourceUserId]]. No output.
 
== RegisterAppletResourceUserId ==
Takes a bool and an [[AM_services|AppletResourceUserId]]. No output.
 
== UnregisterAppletResourceUserId ==
Takes an [[AM_services|AppletResourceUserId]]. No output.
 
== EnableAppletToGetInput ==
Takes a bool and an [[AM_services|AppletResourceUserId]]. No output.
 
= ahid:cd =
This is "nn::ahid::IServerSession".
 
Used for USB HID devices.
 
This service no longer exists in [9.0.0+].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 2,964: Line 3,460:
! Cmd || Name
! Cmd || Name
|-
|-
| 0 || [[#GetDataFormat]]
| 0 || [[#AcquireDevice]]
|-
|-
| 1 || [[#SetDataFormat]]
| 1 || [[#ReleaseDevice]]
|-
|-
| 2 || [[#GetMcuState]]
| 2 || [[#GetCtrlSession]]
|-
|-
| 3 || [[#SetMcuState]]
| 3 || [[#GetReadSession]]
|-
|-
| 4 || [[#GetMcuVersionForNfc]]
| 4 || [1.0.0-2.3.0] [[#GetWriteSession]]
|-
|}
| 5 || [[#CheckNfcDevicePower]]
 
|-
== AcquireDevice ==
| 6 || [5.0.0+] [[#SetMcuStateImmediate]]
Takes an input s32, no output.
|-
 
| 10 || [[#SetNfcEvent]]
== ReleaseDevice ==
|-
Takes an input s32, no output.
| 11 || [[#GetNfcInfo]]
 
|-
== GetCtrlSession ==
| 12 || StartNfcDiscovery
Takes an input u32, returns an [[#ICtrlSession]].
|-
 
| 13 || StopNfcDiscovery
== GetReadSession ==
Takes an input u32, returns an [[#IReadSession]].
 
== GetWriteSession ==
Takes an input u32, returns an [[#IWriteSession]].
 
== ICtrlSession ==
This is "nn::ahid::ICtrlSession".
 
This no longer exists in [9.0.0+].
 
{| class="wikitable" border="1"
|-
! Cmd || Name
|-
| 0 || GetString
|-
| 1 || GetCodeBook
|-
|-
| 14 || StartNtagRead
| 2 || GetReport
|-
|-
| 15 || StartNtagWrite
| 3 || SetReport
|-
|-
| 16 || SendNfcRawData
| 4 || GetIdle
|-
|-
| 17 || RegisterMifareKey
| 5 || SetIdle
|-
|-
| 18 || ClearMifareKey
| 6 || GetProtocol
|-
|-
| 19 || StartMifareRead
| 7 || SetProtocol
|-
|-
| 20 || StartMifareWrite
| 8 || GetDescriptor
|-
|-
| 101 || GetAwakeTriggerReasonForLeftRail
| 9 || SetDescriptor
|-
|-
| 102 || GetAwakeTriggerReasonForRightRail
| 10 || GetStateChangeEvent
|-
|-
| 103 || [10.0.0+] GetAwakeTriggerBatteryLevelTransitionForLeftRail
| 11 || SignalStateChangeEvent
|-
|-
| 104 || [10.0.0+] GetAwakeTriggerBatteryLevelTransitionForRightRail
| 12 || [3.0.0+] Write
|}
|}


[5.0.0+] SetDataFormat, SetMcuState, and ClearMifareKey: now takes a total of 0xC-bytes of input instead of 0x10.
All of these use USB [[USB_services|CtrlXfer]], except for GetStateChangeEvent and SignalStateChangeEvent, and GetCodeBook which copies 0x4000-bytes from state to output.


== GetDataFormat ==
== IReadSession ==
Takes an input 8-byte handle, returns an output u8.
This is "nn::ahid::IReadSession".


== SetDataFormat ==
This no longer exists in [9.0.0+].
Takes an input u8 and a 8-byte handle (4-byte alignment), no output.


== GetMcuState ==
{| class="wikitable" border="1"
Takes an input 8-byte handle, returns an output u8.
|-
! Cmd || Name
|-
| 0 || [[#Read]]
|}


== SetMcuState ==
=== Read ===
Takes an input u8 and a 8-byte handle (4-byte alignment), no output.
Uses [[USB_services|PostBufferAsync]] etc with the INPUT endpoint. The size must be <=0x1000. The actual transfer size is returned in an output u64. The data is copied from the tmpbuf to the output buffer using the actual-transfer-size.


== GetMcuVersionForNfc ==
[3.0.0+] Now takes a total of 8-bytes of input.
Takes an input 8-byte handle, returns an output 0x20-byte struct.


== CheckNfcDevicePower ==
== IWriteSession ==
Takes an input 8-byte handle, no output.
This is "nn::ahid::IWriteSession".


== SetMcuStateImmediate ==
This was removed with [3.0.0+].
Takes an input u8 and a 8-byte handle (4-byte alignment), no output.


== SetNfcEvent ==
{| class="wikitable" border="1"
Takes an input 8-byte handle, returns 2 output Event handles.
|-
! Cmd || Name
|-
| 0 || [[#Write]]
|}


== GetNfcInfo ==
=== Write ===
Takes an input 8-byte handle and a type-0x1A output buffer.
This is the inverse of [[#IReadSession]] cmd0. Uses the OUTPUT endpoint with an input buffer.


[6.0.0+]: The buffer type is now 0x32 instead of 0x1A.
= ahid:hdr =
This is "nn::ahid::hdr::ISession".


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


= hidbus =
This service no longer exists in [9.0.0+].
This is "nn::hidbus::IHidbusServer".
 
This was added with [5.0.0+].
 
Official sw opens a temporary service-session for each func using this, with it being closed once done: no global session is kept open.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,053: Line 3,567:
! Cmd || Name
! Cmd || Name
|-
|-
| 1 || [[#GetBusHandle]]
| 0 || GetDeviceEntries
|-
|-
| 2 || [[#IsExternalDeviceConnected]]
| 1 || GetDeviceList
|-
|-
| 3 || [[#Initialize]]
| 2 || GetDeviceParameters
|-
|-
| 4 || [[#Finalize]]
| 3 || AttachDevice
|-
|-
| 5 || [[#EnableExternalDevice]]
| 4 || DetachDevice
|-
|-
| 6 || [[#GetExternalDeviceId]]
| 5 || [6.0.0+] SetDeviceFilter
|}
 
= xcd:sys =
This is "nn::xcd::detail::ISystemServer".
 
This was removed with [19.0.0+].
 
{| class="wikitable" border="1"
|-
|-
| 7 || [[#SendCommandAsync]]
! Cmd || Name
|-
|-
| 8 || [[#GetSendCommandAsynceResult]]
| 0 || [[#GetDataFormat]]
|-
|-
| 9 || [[#SetEventForSendCommandAsycResult]]
| 1 || [[#SetDataFormat]]
|-
|-
| 10 || [[#GetSharedMemoryHandle]]
| 2 || [[#GetMcuState]]
|-
|-
| 11 || [[#EnableJoyPollingReceiveMode]]
| 3 || [[#SetMcuState]]
|-
| 4 || [[#GetMcuVersionForNfc]]
|-
| 5 || [[#CheckNfcDevicePower]]
|-
| 6 || [5.0.0+] [[#SetMcuStateImmediate]]
|-
| 10 || [[#SetNfcEvent]]
|-
| 11 || [[#GetNfcInfo]]
|-
| 12 || StartNfcDiscovery
|-
| 13 || StopNfcDiscovery
|-
| 14 || StartNtagRead
|-
| 15 || StartNtagWrite
|-
| 16 || SendNfcRawData
|-
| 17 || RegisterMifareKey
|-
| 18 || ClearMifareKey
|-
| 19 || StartMifareRead
|-
| 20 || StartMifareWrite
|-
| 101 || GetAwakeTriggerReasonForLeftRail
|-
|-
| 12 || [[#DisableJoyPollingReceiveMode]]
| 102 || GetAwakeTriggerReasonForRightRail
|-
|-
| 13 || [5.0.0-6.2.0] GetPollingData
| 103 || [10.0.0+] GetAwakeTriggerBatteryLevelTransitionForLeftRail
|-
|-
| 14 || [6.0.0+] [[#SetStatusManagerType]]
| 104 || [10.0.0+] GetAwakeTriggerBatteryLevelTransitionForRightRail
|}
|}


sdknso doesn't use the GetPollingData cmd.
[5.0.0+] SetDataFormat, SetMcuState, and ClearMifareKey: now takes a total of 0xC-bytes of input instead of 0x10.


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


'''HasHandle''' indicates whether the [[#BusHandle]] is valid.
== SetDataFormat ==
Takes an input u8 and a 8-byte handle (4-byte alignment), no output.


Official sw will assert when [[#BusHandle]] InternalIndex is >=0x11 (>=0x13 with [6.0.0+]). This same check is also done for all funcs using [[#BusHandle]] as input.
== GetMcuState ==
Takes an input 8-byte handle, returns an output u8.


This cmd will throw an error when [[#BusType]] is invalid.
== SetMcuState ==
Takes an input u8 and a 8-byte handle (4-byte alignment), no output.


== IsExternalDeviceConnected ==
== GetMcuVersionForNfc ==
Takes an input [[#BusHandle]]. Returns an output bool '''IsAttached'''.
Takes an input 8-byte handle, returns an output 0x20-byte struct.


This is not used by sdknso.
== CheckNfcDevicePower ==
Takes an input 8-byte handle, no output.


== Initialize ==
== SetMcuStateImmediate ==
Takes an input [[#BusHandle]] and an u64 [[AM_services|AppletResourceUserId]]. No output.
Takes an input u8 and a 8-byte handle (4-byte alignment), no output.


Prior to using this cmd, sdknso handles [[#GetSharedMemoryHandle|sharedmem]] mapping if not done previously.
== SetNfcEvent ==
Takes an input 8-byte handle, returns 2 output Event handles.


== Finalize ==
== GetNfcInfo ==
Takes an input [[#BusHandle]] and an u64 [[AM_services|AppletResourceUserId]]. No output.
Takes an input 8-byte handle and a type-0x1A output buffer.


== EnableExternalDevice ==
[6.0.0+]: The buffer type is now 0x32 instead of 0x1A.
Takes an input bool '''IsEnabled''', a [[#BusHandle]], an u64 '''Version''' and an u64 [[AM_services|AppletResourceUserId]]. No output.


sdknso passes value 0x38900050018 (0x3A600050018 with 7.x+) for '''Version'''.
This buffer contains a 0x804-byte struct, for the NFC data sent in response to the various other cmds.


'''IsEnabled''' indicates whether to enable the device (true = enable, false = disable).  When false, this will use [[#DisableJoyPollingReceiveMode]] if needed.
= hidbus =
This is "nn::hidbus::IHidbusServer".


== GetExternalDeviceId ==
This was added with [5.0.0+].
Takes an input [[#BusHandle]]. Returns an output u32 '''DeviceId'''.


== SendCommandAsync ==
Official sw opens a temporary service-session for each func using this, with it being closed once done: no global session is kept open.
Takes a type-0x21 input buffer and a [[#BusHandle]]. No output.
 
== GetSendCommandAsynceResult ==
Takes a type-0x22 output buffer and a [[#BusHandle]]. Returns an output u32 '''OutSize'''.
 
Official sw copies '''OutSize''' to an output u64, for the actual output size.
 
== SetEventForSendCommandAsycResult ==
Takes an input [[#BusHandle]]. Returns an output Event handle '''AttachmentDataReceiveEventHandle''' with EventClearMode=0.
 
Official sw with SendAndReceive clears this event (6.x+ sdknso), uses [[#SendCommandAsync]], waits on + clears this event, then uses [[#GetSendCommandAsynceResult]].
 
== GetSharedMemoryHandle ==
No input. Returns an output SharedMemory handle.
 
The SharedMemory is mapped with size 0x1000 and permissions=R--.
 
See also [[#SetStatusManagerType]].
 
This sharedmem is the StatusManager. This sharedmem contains an array of 0x100-byte (0x80-byte with [[#SetStatusManagerType|[6.0.0+]]]) entries, with entry-count {max [[#GetBusHandle|BusHandles]]}.
 
sdknso only uses the first 0x10-bytes of these entries, the rest is the ignored. Entry structure:


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Cmd || Name
|-
| 1 || [[#GetBusHandle]]
|-
|-
| 0x0 || 0x1 || IsConnected
| 2 || [[#IsExternalDeviceConnected]]
|-
|-
| 0x1 || 0x3 || Reserved
| 3 || [[#Initialize]]
|-
|-
| 0x4 || 0x4 || IsConnectedResult
| 4 || [[#Finalize]]
|-
|-
| 0x8 || 0x1 || IsEnabled. Bool flag indicating whether a device is [[#EnableExternalDevice|enabled]].
| 5 || [[#EnableExternalDevice]]
|-
|-
| 0x9 || 0x1 || IsInFocus. Bool flag indicating whether this entry is valid.
| 6 || [[#GetExternalDeviceId]]
|-
|-
| 0xA || 0x1 || IsPollingMode. Bool flag indicating whether polling is [[#EnableJoyPollingReceiveMode|enabled]].
| 7 || [[#SendCommandAsync]]
|-
|-
| 0xB || 0x1 || Reserved
| 8 || [[#GetSendCommandAsynceResult]]
|-
|-
| 0xC || 0x4 || [[#JoyPollingMode|PollingMode]]
| 9 || [[#SetEventForSendCommandAsycResult]]
|}
 
== EnableJoyPollingReceiveMode ==
Takes a type-0x21 input buffer, a TransferMemory handle, an u32 '''TransferMemorySize''', an u32 [[#JoyPollingMode]] and a [[#BusHandle]]. No output.
 
The TransferMemory is created with an user-specified output buffer, with permissions=R--.
 
The content of the TransferMemory depends of the [[#JoyPollingMode]]. This is used by GetJoyPollingReceivedData. Structure of the TransferMemory (DisableSixAxisPollingDataAccessor, EnableSixAxisPollingDataAccessor, JoyButtonOnlyPollingDataAccessor):
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 10 || [[#GetSharedMemoryHandle]]
|-
|-
| 0x0 || 0x4 || Result.
| 11 || [[#EnableJoyPollingReceiveMode]]
|-
|-
| 0x0 || 0x4 || Padding.
| 12 || [[#DisableJoyPollingReceiveMode]]
|-
|-
| 0x8 || 0x18 || Initialized sysmodule-side, not used by sdknso.
| 13 || [5.0.0-6.2.0] GetPollingData
|-
|-
| 0x20 || 0x8 || Latest entry.
| 14 || [6.0.0+] [[#SetStatusManagerType]]
|-
| 0x28 || 0x8 || Total entries.
|}
|}


The entries specific to the [[#JoyPollingMode]] follow, with 0xA entries total. Each entry starts with an u64 timestamp. Structure for each mode, after the timestamp:
sdknso doesn't use the GetPollingData cmd.
 
== GetBusHandle ==
Takes an input u32 [[#NpadIdType]], an u64 [[#BusType]] and an u64 [[AM_services|AppletResourceUserId]]. Returns an output bool '''HasHandle''' and a [[#BusHandle]].


DisableSixAxisPollingDataAccessor:
'''HasHandle''' indicates whether the [[#BusHandle]] is valid.


{| class="wikitable" border="1"
Official sw will assert when [[#BusHandle]] InternalIndex is >=0x11 (>=0x13 with [6.0.0+]). This same check is also done for all funcs using [[#BusHandle]] as input.
|-
! Offset || Size || Description
|-
| 0x0 || 0x26 || Data
|-
| 0x26 || 0x1 || Size of data.
|-
| 0x27 || 0x1 || Padding
|-
| 0x28 || 0x8 || Timestamp
|}


JoyEnableSixAxisPollingDataAccessor:
This cmd will throw an error when [[#BusType]] is invalid.


{| class="wikitable" border="1"
== IsExternalDeviceConnected ==
|-
Takes an input [[#BusHandle]]. Returns an output bool '''IsAttached'''.
! Offset || Size || Description
|-
| 0x0 || 0x8 || Data
|-
| 0x8 || 0x1 || Size of data.
|-
| 0x9 || 0x7 || Padding
|-
| 0x10 || 0x8 || Timestamp
|}


JoyButtonOnlyPollingDataAccessor:
This is not used by sdknso.


{| class="wikitable" border="1"
== Initialize ==
|-
Takes an input [[#BusHandle]] and an u64 [[AM_services|AppletResourceUserId]]. No output.
! Offset || Size || Description
 
|-
Prior to using this cmd, sdknso handles [[#GetSharedMemoryHandle|sharedmem]] mapping if not done previously.
| 0x0 || 0x2C || Data
 
|-
== Finalize ==
| 0x2C || 0x1 || Size of data.
Takes an input [[#BusHandle]] and an u64 [[AM_services|AppletResourceUserId]]. No output.
|-
 
| 0x2D || 0x3 || Padding
== EnableExternalDevice ==
|-
Takes an input bool '''IsEnabled''', a [[#BusHandle]], an u64 '''Version''' and an u64 [[AM_services|AppletResourceUserId]]. No output.
| 0x30 || 0x8 || Timestamp
 
|}
sdknso passes value 0x38900050018 (0x3A600050018 with 7.x+) for '''Version'''.
 
'''IsEnabled''' indicates whether to enable the device (true = enable, false = disable).  When false, this will use [[#DisableJoyPollingReceiveMode]] if needed.
 
== GetExternalDeviceId ==
Takes an input [[#BusHandle]]. Returns an output u32 '''DeviceId'''.
 
== SendCommandAsync ==
Takes a type-0x21 input buffer and a [[#BusHandle]]. No output.
 
== GetSendCommandAsynceResult ==
Takes a type-0x22 output buffer and a [[#BusHandle]]. Returns an output u32 '''OutSize'''.
 
Official sw copies '''OutSize''' to an output u64, for the actual output size.
 
== SetEventForSendCommandAsycResult ==
Takes an input [[#BusHandle]]. Returns an output Event handle '''AttachmentDataReceiveEventHandle''' with EventClearMode=0.
 
Official sw with SendAndReceive clears this event (6.x+ sdknso), uses [[#SendCommandAsync]], waits on + clears this event, then uses [[#GetSendCommandAsynceResult]].


== DisableJoyPollingReceiveMode ==
== GetSharedMemoryHandle ==
Takes an input [[#BusHandle]]. No output.
No input. Returns an output SharedMemory handle.


== SetStatusManagerType ==
The SharedMemory is mapped with size 0x1000 and permissions=R--.
Takes an input u32 [[#StatusManagerType]]. No output.


This is used by sdknso immediately after mapping [[#GetSharedMemoryHandle|sharedmem]] (before [[#Initialize]]) with hard-coded value 0x2.
See also [[#SetStatusManagerType]].


= SharedMemoryFormat =
This sharedmem is the StatusManager. This sharedmem contains an array of 0x100-byte (0x80-byte with [[#SetStatusManagerType|[6.0.0+]]]) entries, with entry-count {max [[#GetBusHandle|BusHandles]]}.
This is "nn::hid::detail::SharedMemoryFormat".


The shared memory is a 0x40000 byte read-only segment of memory shared between applications for input. The segment contains structures for most if not all input methods available to applications.
sdknso only uses the first 0x10-bytes of these entries, the rest is the ignored. Entry structure:


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Offset || Size || Description
! Size
|-
! Description
| 0x0 || 0x1 || IsConnected
|-
|-
| 0x0
| 0x1 || 0x3 || Reserved
| 0x400
| [[#DebugPadSharedMemoryFormat|DebugPad]]
|-
|-
| 0x400
| 0x4 || 0x4 || IsConnectedResult
| 0x3000
| [[#TouchScreenSharedMemoryFormat|TouchScreen]]
|-
|-
| 0x3400
| 0x8 || 0x1 || IsEnabled. Bool flag indicating whether a device is [[#EnableExternalDevice|enabled]].
| 0x400
| [[#MouseSharedMemoryFormat|Mouse]]
|-
|-
| 0x3800
| 0x9 || 0x1 || IsInFocus. Bool flag indicating whether this entry is valid.
| 0x400
| [[#KeyboardSharedMemoryFormat|Keyboard]]
|-
|-
| 0x3C00
| 0xA || 0x1 || IsPollingMode. Bool flag indicating whether polling is [[#EnableJoyPollingReceiveMode|enabled]].
| 0x1000
| [[#DigitizerSharedMemoryFormat|Digitizer]] ([1.0.0-9.2.0] [[#BasicXpadSharedMemoryFormat|BasicXpad]])
|-
|-
| 0x4C00
| 0xB || 0x1 || Reserved
| 0x200
| [[#HomeButtonSharedMemoryFormat|HomeButton]]
|-
|-
| 0x4E00
| 0xC || 0x4 || [[#JoyPollingMode|PollingMode]]
| 0x200
|}
| [[#SleepButtonSharedMemoryFormat|SleepButton]]
 
== EnableJoyPollingReceiveMode ==
Takes a type-0x21 input buffer, a TransferMemory handle, an u32 '''TransferMemorySize''', an u32 [[#JoyPollingMode]] and a [[#BusHandle]]. No output.
 
The TransferMemory is created with an user-specified output buffer, with permissions=R--.
 
The content of the TransferMemory depends of the [[#JoyPollingMode]]. This is used by GetJoyPollingReceivedData. Structure of the TransferMemory (DisableSixAxisPollingDataAccessor, EnableSixAxisPollingDataAccessor, JoyButtonOnlyPollingDataAccessor):
 
{| class="wikitable" border="1"
|-
|-
| 0x5000
! Offset || Size || Description
| 0x200
| [[#CaptureButtonSharedMemoryFormat|CaptureButton]]
|-
|-
| 0x5200
| 0x0 || 0x4 || Result.
| 0x800
| [[#InputDetectorSharedMemoryFormat|InputDetector]]
|-
|-
| 0x5A00
| 0x0 || 0x4 || Padding.
| 0x4000
| [1.0.0-4.1.0] [[#UniquePadSharedMemoryFormat|UniquePad]]
|-
|-
| 0x9A00
| 0x8 || 0x18 || Initialized sysmodule-side, not used by sdknso.
| 0x32000
| [[#NpadSharedMemoryFormat|Npad]]
|-
|-
| 0x3BA00
| 0x20 || 0x8 || Latest entry.
| 0x800
| [[#GestureSharedMemoryFormat|Gesture]]
|-
|-
| 0x3C200
| 0x28 || 0x8 || Total entries.
| 0x1C
| [5.0.0+] [[#ConsoleSixAxisSensorSharedMemoryFormat|ConsoleSixAxisSensor]]
|}
|}


== DebugPadSharedMemoryFormat ==
The entries specific to the [[#JoyPollingMode]] follow, with 0xA entries total. Each entry starts with an u64 timestamp. Structure for each mode, after the timestamp:
This is "nn::hid::detail::DebugPadSharedMemoryFormat".
 
DisableSixAxisPollingDataAccessor:


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


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Offset || Size || Description
! Size
! Description
|-
|-
| 0x0
| 0x0 || 0x8 || Data
| 0x8
| RingLifoVptr
|-
|-
| 0x8
| 0x8 || 0x1 || Size of data.
| 0x8
| BufferCount
|-
|-
| 0x10
| 0x9 || 0x7 || Padding
| 0x8
| Tail
|-
|-
| 0x18
| 0x10 || 0x8 || Timestamp
| 0x8
| Count
|-
| 0x20
| 0x28 * 17
| Array of [[#DebugPadStateAtomicStorage]]
|}
|}


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


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


===== DebugPadState =====
== DisableJoyPollingReceiveMode ==
This is "nn::hid::DebugPadState".
Takes an input [[#BusHandle]]. No output.
 
== SetStatusManagerType ==
Takes an input u32 [[#StatusManagerType]]. No output.
 
This is used by sdknso immediately after mapping [[#GetSharedMemoryHandle|sharedmem]] (before [[#Initialize]]) with hard-coded value 0x2.
 
= SharedMemoryFormat =
This is "nn::hid::detail::SharedMemoryFormat".
 
The shared memory is a 0x40000 byte read-only segment of memory shared between applications for input. The segment contains structures for most if not all input methods available to applications.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,374: Line 3,875:
|-
|-
| 0x0
| 0x0
| 0x8
| 0x400
| SamplingNumber
| [[#DebugPadSharedMemoryFormat|DebugPad]]
|-
|-
| 0x8
| 0x400
| 0x4
| 0x3000
| [[#DebugPadAttributeSet|Attributes]]
| [[#TouchScreenSharedMemoryFormat|TouchScreen]]
|-
|-
| 0xC
| 0x3400
| 0x4
| 0x400
| [[#DebugPadButtonSet|Buttons]]
| [[#MouseSharedMemoryFormat|Mouse]]
|-
|-
| 0x10
| 0x3800
| 0x8
| 0x400
| [[#AnalogStickState|AnalogStickR]]
| [[#KeyboardSharedMemoryFormat|Keyboard]]
|-
|-
| 0x18
| 0x3C00
| 0x8
| 0x1000
| [[#AnalogStickState|AnalogStickL]]
| [[#DigitizerSharedMemoryFormat|Digitizer]] ([1.0.0-9.2.0] [[#BasicXpadSharedMemoryFormat|BasicXpad]])
|}
 
== TouchScreenSharedMemoryFormat ==
This is "nn::hid::detail::TouchScreenSharedMemoryFormat".
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 0x4C00
! Size
| 0x200
! Description
| [[#HomeButtonSharedMemoryFormat|HomeButton]]
|-
|-
| 0x0
| 0x4E00
| 0x2C38
| 0x200
| [[#TouchScreenLifo]]
| [[#SleepButtonSharedMemoryFormat|SleepButton]]
|-
| 0x5000
| 0x200
| [[#CaptureButtonSharedMemoryFormat|CaptureButton]]
|-
| 0x5200
| 0x800
| [[#InputDetectorSharedMemoryFormat|InputDetector]]
|-
| 0x5A00
| 0x4000
| [1.0.0-4.1.0] [[#UniquePadSharedMemoryFormat|UniquePad]]
|-
| 0x9A00
| 0x32000
| [[#NpadSharedMemoryFormat|Npad]]
|-
| 0x3BA00
| 0x800
| [[#GestureSharedMemoryFormat|Gesture]]
|-
| 0x3C200
| 0x1C
| [5.0.0+] [[#ConsoleSixAxisSensorSharedMemoryFormat|ConsoleSixAxisSensor]]
|-
| 0x3DC00
| 0x400
| [16.0.0+] [[#MouseSharedMemoryFormat|DebugMouse]]
|-
| 0x3E200
| ?
| [?+] NpadCondition
|}
 
== DebugPadSharedMemoryFormat ==
This is "nn::hid::detail::DebugPadSharedMemoryFormat".
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x2C8
| [[#DebugPadLifo]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,434: Line 3,975:
|-
|-
| 0x20
| 0x20
| 0x298 * 17
| 0x28 * 17
| Array of [[#TouchScreenStateAtomicStorage]]
| Array of [[#DebugPadStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,452: Line 3,993:
|-
|-
| 0x8
| 0x8
| 0x290
| 0x20
| [[#TouchScreenState]]
| [[#DebugPadState]]
|}
|}


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


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


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,492: Line 4,037:
|-
|-
| 0x0
| 0x0
| 0x350
| 0x2C38
| [[#MouseLifo]]
| [[#TouchScreenLifo]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,522: Line 4,067:
|-
|-
| 0x20
| 0x20
| 0x30 * 17
| 0x298 * 17
| Array of [[#MouseStateAtomicStorage]]
| Array of [[#TouchScreenStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,540: Line 4,085:
|-
|-
| 0x8
| 0x8
| 0x28
| 0x290
| [[#MouseState]]
| [[#TouchScreenState]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,559: Line 4,104:
| 0x8
| 0x8
| 0x4
| 0x4
| X
| s32 Count
|-
|-
| 0xC
| 0xC
| 0x4
| 0x4
| Y
| Reserved
|-
|-
| 0x10
| 0x10
| 0x4
| 0x28 * 16
| DeltaX
| [[#TouchState|Touches]]
|}
 
== MouseSharedMemoryFormat ==
This is "nn::hid::detail::MouseSharedMemoryFormat".
 
{| class="wikitable" border="1"
|-
|-
| 0x14
! Offset
| 0x4
! Size
| DeltaY
! Description
|-
|-
| 0x18
| 0x0
| 0x4
| 0x350
| WheelDeltaX
| [[#MouseLifo]]
|-
| 0x1C
| 0x4
| WheelDeltaY
|-
| 0x20
| 0x4
| [[#MouseButtonSet|Buttons]]
|-
| 0x24
| 0x4
| [[#MouseAttributeSet|Attributes]]
|}
|}


== KeyboardSharedMemoryFormat ==
=== MouseLifo ===
This is "nn::hid::detail::KeyboardSharedMemoryFormat".
This is "nn::hid::detail::MouseLifo". This is a RingLifo object.
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x3D8
| [[#KeyboardLifo]]
|}
 
=== KeyboardLifo ===
This is "nn::hid::detail::KeyboardLifo". This is a RingLifo object.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,630: Line 4,155:
|-
|-
| 0x20
| 0x20
| 0x38 * 17
| 0x30 * 17
| Array of [[#KeyboardStateAtomicStorage]]
| Array of [[#MouseStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,648: Line 4,173:
|-
|-
| 0x8
| 0x8
| 0x30
| 0x28
| [[#KeyboardState]]
| [[#MouseState]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,666: Line 4,191:
|-
|-
| 0x8
| 0x8
| 0x8
| 0x4
| [[#KeyboardModifierSet|Modifiers]]
| X
|-
| 0xC
| 0x4
| Y
|-
|-
| 0x10
| 0x10
| 0x20
| 0x4
| [[#KeyboardKeySet|Keys]]
| DeltaX
|}
|-
 
| 0x14
== BasicXpadSharedMemoryFormat ==
| 0x4
This is "nn::hid::detail::BasicXpadSharedMemoryFormat".
| DeltaY
 
|-
{| class="wikitable" border="1"
| 0x18
| 0x4
| WheelDeltaX
|-
| 0x1C
| 0x4
| WheelDeltaY
|-
|-
! Offset
| 0x20
! Size
| 0x4
! Description
| [[#MouseButtonSet|Buttons]]
|-
|-
| 0x0
| 0x24
| 0x400 * 4
| 0x4
| Array of [[#BasicXpadSharedMemoryEntry]]
| [[#MouseAttributeSet|Attributes]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,698: Line 4,233:
|-
|-
| 0x0
| 0x0
| 0x2C8
| 0x3D8
| [[#BasicXpadLifo]]
| [[#KeyboardLifo]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,728: Line 4,263:
|-
|-
| 0x20
| 0x20
| 0x28 * 17
| 0x38 * 17
| Array of [[#BasicXpadStateAtomicStorage]]
| Array of [[#KeyboardStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,746: Line 4,281:
|-
|-
| 0x8
| 0x8
| 0x20
| 0x30
| [[#BasicXpadState]]
| [[#KeyboardState]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,764: Line 4,299:
|-
|-
| 0x8
| 0x8
| 0x4
| 0x8
| [[#BasicXpadAttributeSet|Attributes]]
| [[#KeyboardModifierSet|Modifiers]]
|-
|-
| 0xC
| 0x10
| 0x4
| 0x20
| [[#BasicXpadButtonSet|Buttons]]
| [[#KeyboardKeySet|Keys]]
|}
 
== BasicXpadSharedMemoryFormat ==
This is "nn::hid::detail::BasicXpadSharedMemoryFormat".
 
{| class="wikitable" border="1"
|-
|-
| 0x10
! Offset
| 0x8
! Size
| [[#AnalogStickState|AnalogStickL]]
! Description
|-
|-
| 0x18
| 0x0
| 0x8
| 0x400 * 4
| [[#AnalogStickState|AnalogStickR]]
| Array of [[#BasicXpadSharedMemoryEntry]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,790: Line 4,331:
|-
|-
| 0x0
| 0x0
| 0x680
| 0x2C8
| [[#DigitizerLifo]]
| [[#BasicXpadLifo]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,820: Line 4,361:
|-
|-
| 0x20
| 0x20
| 0x60 * 17
| 0x28 * 17
| Array of [[#DigitizerStateAtomicStorage]]
| Array of [[#BasicXpadStateAtomicStorage]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,838: Line 4,379:
|-
|-
| 0x8
| 0x8
| 0x58
| 0x20
| [[#DigitizerState]]
| [[#BasicXpadState]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 3,857: Line 4,398:
| 0x8
| 0x8
| 0x4
| 0x4
|  
| [[#BasicXpadAttributeSet|Attributes]]
|-
|-
| 0xC
| 0xC
| 0x4
| 0x4
|  
| [[#BasicXpadButtonSet|Buttons]]
|-
|-
| 0x10
| 0x10
| 0x4
| 0x8
| [[#DigitizerAttributeSet|Attributes]]
| [[#AnalogStickState|AnalogStickL]]
|-
|-
| 0x14
| 0x18
| 0x4
| 0x8
| [[#DigitizerButtonSet|Buttons]]
| [[#AnalogStickState|AnalogStickR]]
|}
 
== DigitizerSharedMemoryFormat ==
This is "nn::hid::server::DigitizerSharedMemoryFormat".
 
{| class="wikitable" border="1"
|-
|-
| 0x18
! Offset
| 0x4
! Size
|
! Description
|-
|-
| 0x1C
| 0x0
| 0x4
| 0x680
|  
| [[#DigitizerLifo]]
|}
 
=== DigitizerLifo ===
This is "nn::hid::server::DigitizerLifo". This is a RingLifo object.
 
{| class="wikitable" border="1"
|-
|-
| 0x20
! Offset
| 0x4
! Size
|
! Description
|-
|-
| 0x24
| 0x0
| 0x4
| 0x8
|  
| RingLifoVptr
|-
|-
| 0x28
| 0x8
| 0x4
| 0x8
|  
| BufferCount
|-
|-
| 0x2C
| 0x10
| 0x4
| 0x8
|  
| Tail
|-
|-
| 0x30
| 0x18
| 0x4
| 0x8
|  
| Count
|-
|-
| 0x34
| 0x20
| 0x4
| 0x60 * 17
| Array of [[#DigitizerStateAtomicStorage]]
|}
 
==== DigitizerStateAtomicStorage ====
This is "nn::hid::server::DigitizerStateAtomicStorage".
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| SamplingNumber
|-
| 0x8
| 0x58
| [[#DigitizerState]]
|}
 
===== DigitizerState =====
This is "nn::hid::DigitizerState".
 
This is managed by the sysmodule "cs" (development only) through [[HID_services#hid:dbg|hid:dbg]] commands. No actual physical device is supported on NX.
 
{| class="wikitable" border="1"
|-
! Offset
! Size
! Description
|-
| 0x0
| 0x8
| SamplingNumber
|-
| 0x8
| 0x4
|  
|  
|-
|-
| 0x38
| 0xC
| 0x4
| 0x4
|  
|  
|-
|-
| 0x3C
| 0x10
| 0x4
| [[#DigitizerAttributeSet|Attributes]]
|-
| 0x14
| 0x4
| [[#DigitizerButtonSet|Buttons]]
|-
| 0x18
| 0x4
| 0x4
|  
|  
|-
|-
| 0x40
| 0x1C
| 0x4
| 0x4
|  
|  
|-
|-
| 0x44
| 0x20
| 0x4
| 0x4
|  
|  
|-
|-
| 0x48
| 0x24
| 0x4
| 0x4
|  
|  
|-
|-
| 0x4C
| 0x28
| 0x4
| 0x4
|  
|  
|-
|-
| 0x50
| 0x2C
| 0x4
| 0x4
|  
|  
|-
|-
| 0x54
| 0x30
| 0x4
| 0x4
|  
|  
|}
|-
| 0x34
| 0x4
|
|-
| 0x38
| 0x4
|
|-
| 0x3C
| 0x4
|
|-
| 0x40
| 0x4
|
|-
| 0x44
| 0x4
|
|-
| 0x48
| 0x4
|
|-
| 0x4C
| 0x4
|
|-
| 0x50
| 0x4
|
|-
| 0x54
| 0x4
|
|}


== HomeButtonSharedMemoryFormat ==
== HomeButtonSharedMemoryFormat ==
Line 4,324: Line 4,959:
|-
|-
| 0x160
| 0x160
| 0x40
| 0x60
| [[#SixAxisSensorUserCalibrationStateLifo]]
| [[#SixAxisSensorUserCalibrationStateLifo]]
|-
|-
| 0x1A0
| 0x1C0
| 0x40
| 0x20
| UniquePadConfigMutex
| UniquePadConfigMutex
|}
|}
Line 4,732: Line 5,367:
|-
|-
| 0x4208
| 0x4208
| 0x40
| 0x20
| [1.0.0-8.1.0] Mutex
| [1.0.0-8.1.0] Mutex
|-
|-
Line 7,231: Line 7,866:
| "FK" || Pro Controller
| "FK" || Pro Controller
|-
|-
| "MY" || [[#DeviceTypeInternal|DeviceType]] 4 and [[#DeviceTypeInternal|DeviceType]] 5
| "MY" || MiyabiLeft and MiyabiRight
|-
|-
| "LC" || [[#DeviceTypeInternal|DeviceType]] 6 and [[#DeviceTypeInternal|DeviceType]] 30
| "LC" || Tarragon and Tarragon2
|-
|-
| "HL" || Famicom left controller
| "HL" || Famicom left controller
Line 7,429: Line 8,064:
| 2 || Rail
| 2 || Rail
|-
|-
| 3 || USB
| 3 || Usb
|-
|-
| 4 || Embedded
| 4 || Embedded
Line 7,618: Line 8,253:
= DeviceTypeInternal =
= DeviceTypeInternal =
This is "nn::hid::detail::DeviceTypeInternal".
This is "nn::hid::detail::DeviceTypeInternal".
[9.0.0+] This has been superseded by [[#DeviceType_2|DeviceType]].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 7,654: Line 8,291:
|}
|}


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


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


= NpadPowerInfo =
== JoyConRight ==
This is "nn::hid::system::NpadPowerInfo".
[[Joy-Con|Joy-Con]] right controller.
 
== JoyConLeft ==
[[Joy-Con|Joy-Con]] left controller.
 
== SwitchProController ==
[[Pro_Controller|Pro Controller]].
 
== Tarragon ==
Licensed Pro Controller.
 
== LarkH1 ==
Famicom left controller.
 
== LarkH2 ==
Famicom right controller (with microphone).
 
== LarkNL ==
NES left controller.
 
== LarkNR ==
NES right controller.


{| class="wikitable" border="1"
== Lucia ==
|-
SNES controller.
! Offset
 
! Size
== Palma ==
! Description
Poké Ball Plus controller.
|-
 
| 0x0
== GcOnGggg ==
| 0x1
GameCube controller.
| IsPowered
 
|-
== Lagon ==
| 0x1
N64 controller.
| 0x1
 
| IsCharging
== ExternalGrip ==
|-
Joy-Con Charging Grip.
| 0x2
 
| 0x6
== SwitchProControllerDfu ==
| Reserved
"Kotetsu" (Pro Controller MCU) in DFU mode.
|-
 
| 0x8
== ExternalGripDfu ==
| 0x6
"Kuina" (Joy-Con Charging Grip MCU) in DFU mode.
| [[#BatteryLevel|BatteryLevel]]
 
|}
== LuciaDfu ==
SNES controller MCU in DFU mode.
 
== LagonDfu ==
N64 controller MCU in DFU mode.
 
== Lager ==
Sega Genesis controller.


= BatteryLevel =
== LagerDfu ==
This is "nn::hid::system::NpadBatteryLevel". This is a 4 byte value.
Sega Genesis controller MCU in DFU mode.


= ConsoleSixAxisSensorHandle =
== Tarragon2 ==
This is "nn::hid::ConsoleSixAxisSensorHandle". This is a 4-byte struct with 4-byte alignment.
Licensed Pro Controller.


sdknso GetConsoleSixAxisSensorHandle always returns a handle with value 0x13.
= VidPidDefinition =
This is "nn::hidtypes::VidPidDefinition".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset
! Size
! Description
|-
| 0x0
| 0x2
| Vid
|-
| 0x2
| 0x2
| PidRangeMax
|-
|-
| 0x0 || 0x4 || TypeValue
| 0x4
| 0x2
| PidRangeMin
|-
|-
| 0x0 || 0x1 ||  
| 0x6
| 0x1
| [[#DeviceTypeInternal|DeviceType]]
|-
|-
| 0x1 || 0x1 ||
| 0x7
| 0x1
| Reserved
|}
|}


= SixAxisSensorHandle =
= VidPidDefinitions =
This is "nn::hid::SixAxisSensorHandle". This is a 4-byte struct with 4-byte alignment.
This is "nn::hidtypes::detail::VidPidDefinitions". This is a list of [[#VidPidDefinition|VidPidDefinition]] objects maintained by the hid-sysmodule.


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


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


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


= VibrationGcErmCommand =
= BatteryLevel =
This is "nn::hid::VibrationGcErmCommand".
This is "nn::hid::system::NpadBatteryLevel". This is a 4 byte value.
 
= ConsoleSixAxisSensorHandle =
This is "nn::hid::ConsoleSixAxisSensorHandle". This is a 4-byte struct with 4-byte alignment.
 
sdknso GetConsoleSixAxisSensorHandle always returns a handle with value 0x13.


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


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


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


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


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


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


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


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 7,936: Line 8,627:
!  Description
!  Description
|-
|-
| 0 || PlayActivity
| 0 || Unknown
|-
|-
| 1 || SetFrModeType
| 1 || LinearResonantActuator
|-
|-
| 2 || ReadStep
| 2 || GcErm
|-
|-
| 3 || EnableStep
| 3 || Erm
|-
| 4 || ResetStep
|-
| 5 || ReadApplicationSection
|-
| 6 || WriteApplicationSection
|-
| 7 || ReadUniqueCode
|-
| 8 || SetUniqueCodeInvalid
|-
| 9 || WriteActivityEntry
|-
| 10 || WriteRgbLedPatternEntry
|-
| 11 || WriteWaveEntry
|-
| 12 || ReadDataBaseIdentificationVersion
|-
| 13 || WriteDataBaseIdentificationVersion
|-
| 14 || SuspendFeature
|-
| 15 || [5.1.0+] ReadPlayLog
|-
| 16 || [5.1.0+] ResetPlayLog
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 7,978: Line 8,643:
!  Description
!  Description
|-
|-
| 0 || Off
| 0 || None
|-
|-
| 1 || B01
| 1 || Left
|-
|-
| 2 || B02
| 2 || Right
|-
| 3 || B03
|-
| 4 || Downloaded
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset
! Size
! Description
|-
|-
| 0x0 || 0x2 || RgbLedPatternIndex.
| 0x0
| 0x4
| AmplitudeLow
|-
|-
| 0x2 || 0x2 || Padding
| 0x4
| 0x4
| FrequencyLow
|-
|-
| 0x4 || 0x4 || [[#PalmaWaveSet|WaveSet]].
| 0x8
| 0x4
| AmplitudeHigh
|-
|-
| 0x8 || 0x2 || WaveIndex.
| 0xC
| 0x4
| FrequencyHigh
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Value
!  Name
!  Description
!  Description
|-
|-
| 0 || Small
| 0 || Stop || Stops the vibration with a decay phase.
|-
|-
| 1 || Medium
| 1 || Start || Starts the vibration.
|-
|-
| 2 || Large
| 2 || StopHard || Stops the vibration immediately, with no decay phase.
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
! Bit
| 0 || Loose
! Description
|-
|-
| 0
| 1 || Tight
| FrMode
|}
|-
 
| 1
= GyroscopeZeroDriftMode =
| RumbleFeedback
This is "nn::hid::GyroscopeZeroDriftMode".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 2
| 0 || Loose
| Step
|-
|-
| 3
| 1 || Standard
| MuteSwitch
|-
|-
| 2 || Tight
|}
|}


= AbstractedPadState =
= 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"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x4 || Type, only 1 bit can be set. Converted to [[#HdlsDeviceInfo]]::type internally by [[#SetAutoPilotVirtualPadState]].
| 0x0 || 0x4 || [[#PalmaOperationType]]
|-
|-
| 0x4 || 0x1 || Flags. [[#SetAutoPilotVirtualPadState]] only uses bit0: when clear it will skip using the rest of the input and run [[#UnsetAutoPilotVirtualPadState]] internally.
| 0x4 || 0x4 || Result
|-
|-
| 0x5 || 0x3 || Padding
| 0x8 || 0x140 || Buffer for [[#GetPalmaOperationInfo]].
|-
| 0x8 || 0x4 || RGBA Single Body Color
|-
| 0xC || 0x4 || RGBA Single Buttons Color
|-
| 0x10 || 0x1 || See [[#HiddbgHdlsDeviceInfo]]::[[#NpadInterfaceType]].
|-
| 0x11 || 0x3 || Padding
|-
| 0x14 || 0x24 || [[#HdlsState]]. Unknown if the last 4-bytes are included in this struct, [[#SetAutoPilotVirtualPadState]]/[[#hiddbgGetAbstractedPadsState]] only uses the first 0x20-bytes.
|-
| 0x38 || 0x60 || Unused with [[#SetAutoPilotVirtualPadState]]/[[#GetAbstractedPadsState]].
|}
|}


Normally the input state is merged with an existing controller selected by Type. However in some cases (BIT(2-5) with type2!=0x2 and BIT(31)) it's detected as a dedicated controller.
= PalmaOperationType =
This is "nn::hid::PalmaOperationType".


Type:
{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Bits
!  Value
!  [[#HdlsDeviceInfo]]::type bits
!  Description
!  Description
!  Notes
|-
|-
| 0 || 0 || ||
| 0 || PlayActivity
|-
|-
| 1 || 15 || || [[#DeviceType]] |= BIT(1)
| 1 || SetFrModeType
|-
|-
| 2 || 1 || ||
| 2 || ReadStep
|-
|-
| 3 || 2 || ||
| 3 || EnableStep
|-
|-
| 4 || 1 || ||
| 4 || ResetStep
|-
|-
| 5 || 2 || ||
| 5 || ReadApplicationSection
|-
|-
| 6 || 3 || ||
| 6 || WriteApplicationSection
|-
|-
| 7 || 11 || || [[#DeviceType]] |= BIT(11)
| 7 || ReadUniqueCode
|-
|-
| 8 || 12 || || [[#DeviceType]] |= BIT(12)
| 8 || SetUniqueCodeInvalid
|-
|-
| 9 || 13 || || [[#DeviceType]] |= BIT(13)
| 9 || WriteActivityEntry
|-
|-
| 10 || 14 || || [[#DeviceType]] |= BIT(14)
| 10 || WriteRgbLedPatternEntry
|-
|-
| 11 || 15 || || [[#DeviceType]] |= BIT(11)
| 11 || WriteWaveEntry
|-
|-
| 12 || 12 || || [[#DeviceType]] |= BIT(12)
| 12 || ReadDataBaseIdentificationVersion
|-
|-
| 13 || 13 || || [[#DeviceType]] |= BIT(13)
| 13 || WriteDataBaseIdentificationVersion
|-
|-
| 14 || 14 || || [[#DeviceType]] |= BIT(14)
| 14 || SuspendFeature
|-
|-
| 15 || 17 || ||
| 15 || [5.1.0+] ReadPlayLog
|-
| 31 || 21 || || [[#DeviceType]] = BIT(31)
|-
|-
| 16 || [5.1.0+] ResetPlayLog
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
! Offset
| 0 || Off
! Size
! Description
|-
|-
| 0x0
| 1 || B01
| 0x4
| [[#DebugPadAttributeSet|Attributes]]
|-
|-
| 0x4
| 2 || B02
| 0x4
| [[#DebugPadButtonSet|Buttons]]
|-
|-
| 0x8
| 3 || B03
| 0x8
| [[#AnalogStickState|AnalogStickL]]
|-
|-
| 0x10
| 4 || Downloaded
| 0x8
| [[#AnalogStickState|AnalogStickR]]
|}
|}


= MouseAutoPilotState =
= PalmaApplicationSectionAccessBuffer =
This is "nn::hid::debug::MouseAutoPilotState".
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"
|-
|-
! Offset
! Offset || Size || Description
! Size
|-
! Description
| 0x0 || 0x2 || RgbLedPatternIndex.
|-
|-
| 0x0
| 0x2 || 0x2 || Padding
| 0x4
| X
|-
|-
| 0x4
| 0x4 || 0x4 || [[#PalmaWaveSet|WaveSet]].
| 0x4
| Y
|-
|-
| 0x8
| 0x8 || 0x2 || WaveIndex.
| 0x4
| DeltaX
|-
| 0xC
| 0x4
| DeltaY
|-
| 0x10
| 0x4
| WheelDelta
|-
| 0x14
| 0x4
| [[#MouseButtonSet|Buttons]]
|-
| 0x18
| 0x4
| [[#MouseAttributeSet|Attributes]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
! Offset
| 0 || Small
! Size
! Description
|-
|-
| 0x0
| 1 || Medium
| 0x8
| [[#KeyboardModifierSet|Modifiers]]
|-
|-
| 0x8
| 2 || Large
| 0x20
| [[#KeyboardKeySet|Keys]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Bit
! Size
! Description
! Description
|-
|-
| 0x0 || 0x8 || Buttons (only bit0 is used)
| 0
|}
| FrMode
 
= PowerInfo =
This is "nn::hidtypes::PowerInfo".
 
{| class="wikitable" border="1"
|-
|-
! Offset
| 1
! Size
| RumbleFeedback
! Description
|-
| 2
| Step
|-
|-
| 0x0 || 0x4 || BatteryLevel
| 3
| MuteSwitch
|-
|-
| 0x4 || 0x4 || [[#PowerAttribute]]
|}
|}


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


= HdlsAttribute =
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::hidtypes::HdlsAttribute". This is a 32-bit flag.


Type:
{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Bits
!  Bits
!  [[#HdlsDeviceInfo]]::type bits
!  Description
!  Description
!  Notes
|-
| 0 || 0 || ||
|-
|-
| 0
| 1 || 15 || || [[#DeviceType]] |= BIT(1)
| HasVirtualSixAxisSensorAcceleration
|-
| 2 || 1 || ||
|-
| 3 || 2 || ||
|-
|-
| 1
| 4 || 1 || ||
| HasVirtualSixAxisSensorAngle
|-
|}
| 5 || 2 || ||
 
|-
= HdlsHandle =
| 6 || 3 || ||
This is "nn::hid::debug::HdlsHandle". This is a 0x8-byte struct with 8-byte alignment.
 
= HdlsSessionId =
This is "nn::hid::debug::detail::HdlsSessionId". This is a 0x8-byte struct with 8-byte alignment.
 
= HdlsNpadAssignment =
This is a 0x208-byte struct.
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 7 || 11 || || [[#DeviceType]] |= BIT(11)
|-
|-
| 0x0 || 0x4 || s32 Total entries
| 8 || 12 || || [[#DeviceType]] |= BIT(12)
|-
|-
| 0x4 || 0x4 || Padding
| 9 || 13 || || [[#DeviceType]] |= BIT(13)
|-
|-
| 0x8 || 0x200(0x20*0x10) || Array of [[#HdlsNpadAssignmentEntry]].
| 10 || 14 || || [[#DeviceType]] |= BIT(14)
|}
 
= HdlsNpadAssignmentEntry =
This is a 0x20-byte struct.
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 11 || 15 || || [[#DeviceType]] |= BIT(11)
|-
|-
| 0x0 || 0x8 || [[#HdlsHandle]]
| 12 || 12 || || [[#DeviceType]] |= BIT(12)
|-
|-
| 0x8 || 0x4 || ?
| 13 || 13 || || [[#DeviceType]] |= BIT(13)
|-
|-
| 0xC || 0x4 || ?
| 14 || 14 || || [[#DeviceType]] |= BIT(14)
|-
|-
| 0x10 || 0x8 || ?
| 15 || 17 || ||  
|-
|-
| 0x18 || 0x1 || ?
| 31 || 21 || || [[#DeviceType]] = BIT(31)
|-
|-
| 0x19 || 0x7 || Padding
|}
|}


= HdlsStateList =
The above "[[#DeviceType]] |=" notes only apply when type2 is 0x2.
This is a 0x408-byte struct.


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset
! Size
! Description
|-
|-
| 0x0 || 0x4 || s32 Total entries
| 0x0
| 0x4
| [[#DebugPadAttributeSet|Attributes]]
|-
|-
| 0x4 || 0x4 || Padding
| 0x4
| 0x4
| [[#DebugPadButtonSet|Buttons]]
|-
|-
| 0x8 || <[[#HdlsStateListEntry]] size>*0x10 || Array of [[#HdlsStateListEntry]].
| 0x8
|}
| 0x8
 
| [[#AnalogStickState|AnalogStickL]]
This contains a list of all controllers, including non-virtual controllers.
|-
| 0x10
| 0x8
| [[#AnalogStickState|AnalogStickR]]
|}


= HdlsStateListEntry =
= MouseAutoPilotState =
This is a 0x40-byte struct.
This is "nn::hid::debug::MouseAutoPilotState".
 
[9.0.0+] This is a 0x48-byte struct.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset
! Size
! Description
|-
|-
| 0x0 || 0x8 || [[#HdlsHandle]]
| 0x0
| 0x4
| X
|-
|-
| 0x8 || [[#HdlsDeviceInfo]] size || [[#HdlsDeviceInfo]]. With [[#ApplyHdlsStateList]] this is only used when creating new devices.
| 0x4
| 0x4
| Y
|-
|-
| 0x8 + [[#HdlsDeviceInfo]] size, with 8-byte alignment || 0x24 || [[#HdlsState]]
| 0x8
| 0x4
| DeltaX
|-
|-
| <Immediately following the above> || 0x4 || Padding
| 0xC
|}
| 0x4
 
| DeltaY
= HdlsDeviceInfo =
This is "nn::hid::debug::HdlsDeviceInfo". This is a 0x10-byte struct.
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 0x10
| 0x4
| WheelDelta
|-
|-
| 0x0 || 0x4 || [[#DeviceTypeInternal]]
| 0x14
| 0x4
| [[#MouseButtonSet|Buttons]]
|-
|-
| 0x4 || 0x4 || RGBA Single Body Color
| 0x18
|-
| 0x4
| 0x8 || 0x4 || RGBA Single Buttons Color
| [[#MouseAttributeSet|Attributes]]
|-
| 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.
= KeyboardAutoPilotState =
This is "nn::hid::debug::KeyboardAutoPilotState".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset
! Size
! Description
|-
|-
| 0x0 || 0x1 || [[#DeviceTypeInternal]]
| 0x0
| 0x8
| [[#KeyboardModifierSet|Modifiers]]
|-
|-
| 0x1 || 0x1 || [[#NpadInterfaceType]]. Similar to the field from the old struct.
| 0x8
| 0x20
| [[#KeyboardKeySet|Keys]]
|}
 
= SleepButtonAutoPilotState =
This is "nn::hid::debug::SleepButtonAutoPilotState". This is a 0x8-byte struct with 8-byte alignment.
 
{| class="wikitable" border="1"
|-
|-
| 0x2 || 0x2 || Padding
! Offset
! Size
! Description
|-
|-
| 0x4 || 0x4 || RGBA Single Body Color
| 0x0 || 0x8 || Buttons (only bit0 is used)
|}
 
= DigitizerAutoPilotState =
This is "nn::hid::debug::DigitizerAutoPilotState".
 
{| class="wikitable" border="1"
|-
|-
| 0x8 || 0x4 || RGBA Single Buttons Color
! Offset
|-
! Size
| 0xC || 0x4 || RGBA Left Grip Color
! Description
|-
|-
| 0x10 || 0x4 || RGBA Right Grip Color
| 0x0 || 0x44 ||  
|}
|}


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


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


[9.0.0+] (0x28-bytes):
= PowerAttribute =
This is "nn::hidtypes::PowerAttribute". This is a 32-bit flag.
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Bits
!  Description
|-
|-
! Offset || Size || Description
| 0
| IsPowered
|-
| 1
| IsCharging
|}
 
= HdlsAttribute =
This is "nn::hidtypes::HdlsAttribute". This is a 32-bit flag.
 
{| class="wikitable" border="1"
!  Bits
!  Description
|-
| 0
| HasVirtualSixAxisSensorAcceleration
|-
|-
| 0x0 || 0x8 || [[#PowerInfo]]
| 1
| HasVirtualSixAxisSensorAngle
|}
 
= HdlsHandle =
This is "nn::hid::debug::HdlsHandle". This is a 0x8-byte struct with 8-byte alignment.
 
= HdlsSessionId =
This is "nn::hid::debug::detail::HdlsSessionId". This is a 0x8-byte struct with 8-byte alignment.
 
= HdlsNpadAssignment =
This is a 0x208-byte struct.
 
{| class="wikitable" border="1"
|-
|-
| 0x8 || 0x8 || [[#NpadButton|Buttons]], masked with 0xfffffffff00fffff. See above table regarding HOME/Capture buttons.
! Offset || Size || Description
|-
|-
| 0x10 || 0x10(4*2*2) || Joystick data.
| 0x0 || 0x4 || s32 Total entries
|-
|-
| 0x20 || 0x1 || Indicator. Unused for input. Set with output from [[#DumpHdlsStates]] (zero in some cases).
| 0x4 || 0x4 || Padding
|-
|-
| 0x21 || 0x7 || Padding
| 0x8 || 0x200(0x20*0x10) || Array of [[#HdlsNpadAssignmentEntry]].
|}
|}


[12.0.0+] (0x40-bytes):
= HdlsNpadAssignmentEntry =
This is a 0x20-byte struct.
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x8 || [[#PowerInfo]]
| 0x0 || 0x8 || [[#HdlsHandle]]
|-
|-
| 0x8 || 0x8 || [[#NpadButton|Buttons]], masked with 0xfffffffff00fffff. See above table regarding HOME/Capture buttons.
| 0x8 || 0x4 || ?
|-
|-
| 0x10 || 0x10(4*2*2) || Joystick data.
| 0xC || 0x4 || ?
|-
|-
| 0x20 || 0xC || VirtualSixAxisSensorAcceleration
| 0x10 || 0x8 || ?
|-
|-
| 0x2C || 0xC || VirtualSixAxisSensorAngle
| 0x18 || 0x1 || ?
|-
|-
| 0x38 || 0x4 || [[#HdlsAttribute]]
| 0x19 || 0x7 || Padding
|-
| 0x3C || 0x1 || Indicator. Unused for input.
|-
| 0x3D || 0x3 || Padding
|}
|}


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


= RegisteredDevice =
[9.0.0+] This is a 0x488-byte struct.
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"
|-
|-
! Offset
! Offset || Size || Description
! Size
! Description
|-
|-
| 0x0
| 0x0 || 0x4 || s32 Total entries
| 0x1
| TimeUnit
|-
|-
| 0x1
| 0x4 || 0x4 || Padding
| 0x1
| FrameCount
|-
|-
| 0x2
| 0x8 || <[[#HdlsStateListEntry]] size>*0x10 || Array of [[#HdlsStateListEntry]].
| 0x1
|}
| CycleCount
 
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"
|-
|-
| 0x3
! Offset || Size || Description
| 0x1
| InitialBrightness
|-
|-
| 0x4
| 0x0 || 0x8 || [[#HdlsHandle]]
| 0x4 * 15
| [[#Frame|Frames]]
|-
|-
| 0x40
| 0x8 || [[#HdlsDeviceInfo]] size || [[#HdlsDeviceInfo]]. With [[#ApplyHdlsStateList]] this is only used when creating new devices.
| 0x1
| FinalBrightness
|-
|-
| 0x41
| 0x8 + [[#HdlsDeviceInfo]] size, with 8-byte alignment || 0x24 || [[#HdlsState]]
| 0x1
| TimeTowardsFinalBrightness
|-
|-
| 0x42
| <Immediately following the above> || 0x4 || Padding
| 0x6
| Reserved
|}
|}


== Frame ==
= HdlsDeviceInfo =
This is "nn::hid::debug::HdlsDeviceInfo". This is a 0x10-byte struct.
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset
! Offset || Size || Description
! Size
! Description
|-
|-
| 0x0
| 0x0 || 0x4 || [[#DeviceTypeInternal]]
| 0x1
|-
| Brightness
| 0x4 || 0x4 || RGBA Single Body Color
|-
|-
| 0x1
| 0x8 || 0x4 || RGBA Single Buttons Color
| 0x1
| TimeTowards
|-
|-
| 0x2
| 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.
| 0x1
| TimeToHold
|-
|-
| 0x3
| 0xD || 0x3 || Padding
| 0x1
| Reserved
|}
|}


= SystemButtonConfigEmbedded =
[9.0.0+] This is a 0x14-byte struct.
This is "nn::hid::system::ButtonConfigEmbedded". This is a 0x2C8-byte struct.
 
= SystemButtonConfigFull =
This is "nn::hid::system::ButtonConfigFull". This is a 0x2C8-byte struct.
 
= SystemButtonConfigLeft =
This is "nn::hid::system::ButtonConfigLeft". This is a 0x1C8-byte struct.
 
= SystemButtonConfigRight =
This is "nn::hid::system::ButtonConfigRight". This is a 0x1A0-byte struct.
 
= ButtonConfigEmbedded =
This is "nn::hidconfig::ButtonConfigEmbedded". This is a 0x54-byte struct.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 8,519: Line 9,168:
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonLeft]]
| 0x0 || 0x1 || [[#DeviceTypeInternal]]
|-
|-
| 0x4 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonUp]]
| 0x1 || 0x1 || [[#NpadInterfaceType]]. Similar to the field from the old struct.
|-
|-
| 0x8 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonRight]]
| 0x2 || 0x2 || Padding
|-
|-
| 0xC || 0x4 || [[#DigitalButtonAssignment|HardwareButtonDown]]
| 0x4 || 0x4 || RGBA Single Body Color
|-
|-
| 0x10 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonA]]
| 0x8 || 0x4 || RGBA Single Buttons Color
|-
|-
| 0x14 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonB]]
| 0xC || 0x4 || RGBA Left Grip Color
|-
|-
| 0x18 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonX]]
| 0x10 || 0x4 || RGBA Right Grip Color
|}
 
= HdlsState =
This is "nn::hid::debug::HdlsState". This is a 0x24-byte struct.
 
{| class="wikitable" border="1"
|-
|-
| 0x1C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonY]]
! Offset || Size || Description
|-
|-
| 0x20 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStickL]]
| 0x0 || 0x1 || IsPowered for the main PowerInfo.
|-
|-
| 0x24 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStickR]]
| 0x1 || 0x1 || ORRed with IsPowered to set the value of the first byte for the controller [[#NpadSystemProperties]].
|-
|-
| 0x28 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonL]]
| 0x2 || 0x6 || Unknown
|-
|-
| 0x2C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonR]]
| 0x8 || 0x4 || BatteryLevel for the main PowerInfo.
|-
|-
| 0x30 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonZL]]
| 0xC || 0x4 || [[#NpadButton|Buttons]]. Bit18 = HOME and bit19 = Capture.
|-
|-
| 0x34 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonZR]]
| 0x10 || 0x10(4*2*2) || Joystick data.
|-
|-
| 0x38 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonSelect]]
| 0x20 || 0x1 || Indicator. Unused for input. Set with output from [[#DumpHdlsStates]] (zero in some cases).
|-
|-
| 0x3C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStart]]
| 0x21 || 0x3 || Padding
|-
| 0x40 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonCapture]]
|-
| 0x44 || 0x8 || [[#AnalogStickAssignment|HardwareStickL]]
|-
| 0x4C || 0x8 || [[#AnalogStickAssignment|HardwareStickR]]
|}
|}


== DigitalButtonAssignment ==
[9.0.0+] (0x28-bytes):
This is "nn::hidconfig::DigitalButtonAssignment".
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || A
! Offset || Size || Description
|-
|-
| 1 || B
| 0x0 || 0x8 || [[#PowerInfo]]
|-
|-
| 2 || X
| 0x8 || 0x8 || [[#NpadButton|Buttons]], masked with 0xfffffffff00fffff. See above table regarding HOME/Capture buttons.
|-
|-
| 3 || Y
| 0x10 || 0x10(4*2*2) || Joystick data.
|-
|-
| 4 || StickL
| 0x20 || 0x1 || Indicator. Unused for input. Set with output from [[#DumpHdlsStates]] (zero in some cases).
|-
|-
| 5 || StickR
| 0x21 || 0x7 || Padding
|}
 
[12.0.0+] (0x40-bytes):
{| class="wikitable" border="1"
|-
|-
| 6 || L
! Offset || Size || Description
|-
|-
| 7 || R
| 0x0 || 0x8 || [[#PowerInfo]]
|-
|-
| 8 || ZL
| 0x8 || 0x8 || [[#NpadButton|Buttons]], masked with 0xfffffffff00fffff. See above table regarding HOME/Capture buttons.
|-
|-
| 9 || ZR
| 0x10 || 0x10(4*2*2) || Joystick data.
|-
|-
| 10 || Select
| 0x20 || 0xC || VirtualSixAxisSensorAcceleration
|-
|-
| 11 || Start
| 0x2C || 0xC || VirtualSixAxisSensorAngle
|-
|-
| 12 || Left
| 0x38 || 0x4 || [[#HdlsAttribute]]
|-
|-
| 13 || Up
| 0x3C || 0x1 || Indicator. Unused for input.
|-
|-
| 14 || Right
| 0x3D || 0x3 || Padding
|-
|}
| 15 || Down
 
|-
= DebugRegisteredDevice =
| 16 || LeftSL
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"
|-
|-
| 17 || LeftSR
! Offset
! Size
! Description
|-
|-
| 18 || RightSL
| 0x0
| 0x1
| TimeUnit
|-
|-
| 19 || RightSR
| 0x1
| 0x1
| FrameCount
|-
|-
| 20 || HomeButton
| 0x2
| 0x1
| CycleCount
|-
|-
| 21 || CaptureButton
| 0x3
| 0x1
| InitialBrightness
|-
|-
| 22 || Invalid
| 0x4
|}
| 0x4 * 15
 
| [[#Frame|Frames]]
== AnalogStickAssignment ==
This is "nn::hidconfig::AnalogStickAssignment".
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 0x40
| 0x1
| FinalBrightness
|-
|-
| 0x0 || 0x4 || [[#AnalogStickRotation]]
| 0x41
| 0x1
| TimeTowardsFinalBrightness
|-
|-
| 0x4 || 0x1 || IsPairedStickAssigned
| 0x42
|-
| 0x6
| 0x5 || 0x3 || Reserved
| Reserved
|}
|}


== AnalogStickRotation ==
== Frame ==
This is "nn::hidconfig::AnalogStickRotation".
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || None
! Offset
! Size
! Description
|-
| 0x0
| 0x1
| Brightness
|-
| 0x1
| 0x1
| TimeTowards
|-
|-
| 1 || Clockwise90
| 0x2
| 0x1
| TimeToHold
|-
|-
| 2 || Anticlockwise90
| 0x3
| 0x1
| Reserved
|}
|}


= ButtonConfigFull =
= SystemButtonConfigEmbedded =
This is "nn::hidconfig::ButtonConfigFull". This is a 0x54-byte struct.
This is "nn::hid::system::ButtonConfigEmbedded". This is a 0x2C8-byte struct.
 
= SystemButtonConfigFull =
This is "nn::hid::system::ButtonConfigFull". This is a 0x2C8-byte struct.
 
= SystemButtonConfigLeft =
This is "nn::hid::system::ButtonConfigLeft". This is a 0x1C8-byte struct.


This is identical to [[#ButtonConfigEmbedded]].
= SystemButtonConfigRight =
This is "nn::hid::system::ButtonConfigRight". This is a 0x1A0-byte struct.


= ButtonConfigLeft =
= ButtonConfigEmbedded =
This is "nn::hidconfig::ButtonConfigLeft". This is a 0x34-byte struct.
This is "nn::hidconfig::ButtonConfigEmbedded". This is a 0x54-byte struct.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 8,660: Line 9,344:
| 0xC || 0x4 || [[#DigitalButtonAssignment|HardwareButtonDown]]
| 0xC || 0x4 || [[#DigitalButtonAssignment|HardwareButtonDown]]
|-
|-
| 0x10 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStickL]]
| 0x10 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonA]]
|-
|-
| 0x14 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonL]]
| 0x14 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonB]]
|-
|-
| 0x18 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonZL]]
| 0x18 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonX]]
|-
|-
| 0x1C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonSelect]]
| 0x1C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonY]]
|-
|-
| 0x20 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonLeftSL]]
| 0x20 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStickL]]
|-
|-
| 0x24 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonLeftSR]]
| 0x24 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStickR]]
|-
|-
| 0x28 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonCapture]]
| 0x28 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonL]]
|-
|-
| 0x2C || 0x8 || [[#AnalogStickAssignment|HardwareStickL]]
| 0x2C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonR]]
|}
 
= ButtonConfigRight =
This is "nn::hidconfig::ButtonConfigRight". This is a 0x30-byte struct.
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 0x30 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonZL]]
|-
|-
| 0x0 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonA]]
| 0x34 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonZR]]
|-
|-
| 0x4 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonB]]
| 0x38 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonSelect]]
|-
|-
| 0x8 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonX]]
| 0x3C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStart]]
|-
|-
| 0xC || 0x4 || [[#DigitalButtonAssignment|HardwareButtonY]]
| 0x40 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonCapture]]
|-
|-
| 0x10 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStickR]]
| 0x44 || 0x8 || [[#AnalogStickAssignment|HardwareStickL]]
|-
|-
| 0x14 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonR]]
| 0x4C || 0x8 || [[#AnalogStickAssignment|HardwareStickR]]
|-
| 0x18 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonZR]]
|-
| 0x1C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStart]]
|-
| 0x20 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonRightSL]]
|-
| 0x24 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonRightSR]]
|-
| 0x28 || 0x8 || [[#AnalogStickAssignment|HardwareStickR]]
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 8,719: Line 9,382:
!  Description
!  Description
|-
|-
| 1 || Bluetooth
| 0 || A
|-
|-
| 2 || Rail
| 1 || B
|-
|-
| 3 || USB
| 2 || X
|-
|-
| 4 || Embedded
| 3 || Y
|}
 
= DigitalButton =
This is "nn::hidtypes::DigitalButton". This is a 64-bit flag.
 
{| class="wikitable" border="1"
|-
|-
! Bit
| 4 || StickL
! Description
|-
|-
| 0
| 5 || StickR
| A
|-
|-
| 1
| 6 || L
| B
|-
|-
| 2
| 7 || R
| X
|-
|-
| 3
| 8 || ZL
| Y
|-
|-
| 4
| 9 || ZR
| StickL
|-
|-
| 5
| 10 || Select
| StickR
|-
|-
| 6
| 11 || Start
| L
|-
|-
| 7
| 12 || Left
| R
|-
|-
| 8
| 13 || Up
| ZL
|-
|-
| 9
| 14 || Right
| ZR
|-
|-
| 10
| 15 || Down
| Start
|-
|-
| 11
| 16 || LeftSL
| Select
|-
|-
| 12
| 17 || LeftSR
| Left
|-
|-
| 13
| 18 || RightSL
| Up
|-
|-
| 14
| 19 || RightSR
| Right
|-
|-
| 15
| 20 || HomeButton
| Down
|-
|-
| 16
| 21 || CaptureButton
| SL
|-
|-
| 17
| 22 || Invalid
| SR
|}
 
== AnalogStickAssignment ==
This is "nn::hidconfig::AnalogStickAssignment".
 
{| class="wikitable" border="1"
|-
|-
| 18
! Offset || Size || Description
| Home
|-
|-
| 19
| 0x0 || 0x4 || [[#AnalogStickRotation]]
| Shot
|-
|-
| 20
| 0x4 || 0x1 || IsPairedStickAssigned
| StickLLeft
|-
|-
| 21
| 0x5 || 0x3 || Reserved
| StickLUp
|}
 
== AnalogStickRotation ==
This is "nn::hidconfig::AnalogStickRotation".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 22
| 0 || None
| StickLRight
|-
|-
| 23
| 1 || Clockwise90
| StickLDown
|-
|-
| 24
| 2 || Anticlockwise90
| StickRLeft
|}
 
= 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"
|-
|-
| 25
! Offset || Size || Description
| StickRUp
|-
|-
| 26
| 0x0 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonLeft]]
| StickRRight
|-
|-
| 27
| 0x4 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonUp]]
| StickRDown
|-
|-
| 28
| 0x8 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonRight]]
| Palma
|-
|-
| 29
| 0xC || 0x4 || [[#DigitalButtonAssignment|HardwareButtonDown]]
| HandheldLeftB
|-
|-
| 30
| 0x10 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonStickL]]
| Plus
|-
|-
| 31
| 0x14 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonL]]
| Minus
|-
|-
| 32
| 0x18 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonZL]]
| Z
|-
|-
| 33
| 0x1C || 0x4 || [[#DigitalButtonAssignment|HardwareButtonSelect]]
| LeftSL
|-
|-
| 34
| 0x20 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonLeftSL]]
| LeftSR
|-
|-
| 35
| 0x24 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonLeftSR]]
| RightSL
|-
|-
| 36
| 0x28 || 0x4 || [[#DigitalButtonAssignment|HardwareButtonCapture]]
| RightSR
|-
|-
| 37
| 0x2C || 0x8 || [[#AnalogStickAssignment|HardwareStickL]]
| LeftC
|}
|-
 
| 38
= ButtonConfigRight =
| UpC
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
|-
|-
| 39
| 3 || Usb
| RightC
|-
|-
| 40
| 4 || Embedded
| DownC
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 8,869: Line 9,554:
|-
|-
| 0
| 0
| IsExternalAssigned
| A
|-
|-
| 1
| 1
| IsExternalLeftAssigned
| B
|-
|-
| 2
| 2
| IsExternalRightAssigned
| X
|-
|-
| 3
| 3
| IsHandheldAssigned
| Y
|-
|-
| 4
| 4
| IsHandheldLeftAssigned
| StickL
|-
|-
| 5
| 5
| IsHandheldRightAssigned
| StickR
|}
 
= FeatureType =
This is "nn::hidtypes::FeatureType". This is a 64-bit flag.
 
{| class="wikitable" border="1"
|-
! Bit
! Description
|-
| 0
| HasLeftAnalogStick
|-
| 1
| HasRightAnalogStick
|-
| 2
| HasLeftSixAxisSensor
|-
| 3
| HasRightSixAxisSensor
|-
| 4
| HasExternalSixAxisSensor
|-
| 5
| HasLeftLraVibrationDevice
|-
|-
| 6
| 6
| HasRightLraVibrationDevice
| L
|-
|-
| 7
| 7
| HasGcVibrationDevice
| R
|-
|-
| 8
| 8
| HasErmVibrationDevice
| ZL
|-
|-
| 9
| 9
| HasLeftJoyRailBus
| ZR
|-
|-
| 10
| 10
| HasRightJoyRailBus
| Start
|-
|-
| 11
| 11
| HasInternalBus
| Select
|-
|-
| 12
| 12
| HasPalmaIc
| Left
|-
|-
| 13
| 13
| HasNfc
| Up
|-
|-
| 14
| 14
| HasIrSensor
| Right
|-
|-
| 15
| 15
| IsAnalogStickCalibrationSupported
| Down
|-
|-
| 16
| 16
| IsSixAxisSensorUserCalibrationSupported
| SL
|-
|-
| 17
| 17
| HasLeftRightBattery
| SR
|-
|-
| 18
| 18
| HasStandardBattery
| Home
|-
|-
| 19
| 19
| HasBattery
| Shot
|-
|-
| 20
| 20
| HasMainColor
| StickLLeft
|-
|-
| 21
| 21
| HasSubColor
| StickLUp
|-
|-
| 22
| 22
| HasIdentificationCode
| StickLRight
|-
|-
| 23
| 23
| HasBluetoothAddress
| StickLDown
|-
|-
| 24
| 24
| HasMcu
| StickRLeft
|-
|-
| 25
| 25
| HasNotificationLed
| StickRUp
|-
|-
| 26
| 26
| HasDirectionalButtons
| StickRRight
|-
|-
| 27
| 27
| HasIndicatorLed
| StickRDown
|-
|-
| 28
| 28
| IsEmbeddedController
| Palma
|-
|-
| 29
| 29
| IsFullController
| HandheldLeftB
|-
|-
| 30
| 30
| IsLeftController
| Plus
|-
|-
| 31
| 31
| IsRightController
| Minus
|-
|-
| 32
| 32
| IsUsbHidDevice
| Z
|-
|-
| 33
| 33
| IsKuinaDevice
| LeftSL
|-
|-
| 34
| 34
| IsDirectUsbToBtSwitchingDevice
| LeftSR
|-
|-
| 35
| 35
| NormalizeAnalogStickWithInnerCross
| RightSL
|}
 
= Color =
This is "nn::hidtypes::Color".
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 36
| RightSR
|-
|-
| 0x0 || 0x4 || BodyColor
| 37
| LeftC
|-
|-
| 0x4 || 0x4 || ButtonColor
| 38
| UpC
|-
|-
| 0x8 || 0x4 || LeftGripColor
| 39
| RightC
|-
|-
| 0xC || 0x4 || RightGripColor
| 40
| DownC
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Bit
! Description
|-
|-
| 0x0 || 0x1 || [[#DeviceTypeInternal|DeviceType]]
| 0
| IsExternalAssigned
|-
|-
| 0x1 || 0x7 || Reserved
| 1
| IsExternalLeftAssigned
|-
|-
| 0x8 || 0x8 || [[#FeatureType|FeatureType]]
| 2
| IsExternalRightAssigned
|-
|-
| 0x10 || 0x8 || [[#DigitalButton|DigitalButton]]
| 3
| IsHandheldAssigned
|-
|-
| 0x18 || 0x4 || [[#AssignmentStyle|AssignmentStyle]]
| 4
| IsHandheldLeftAssigned
|-
|-
| 0x1C || 0x10 || [[#Color|DeviceColor]]
| 5
|-
| IsHandheldRightAssigned
| 0x2C || 0x4 || Reserved
|}
|}


= UnmaskFeatureDescriptorType =
= FeatureType =
This is "nn::hid::server::UnmaskFeatureDescriptorType".
This is "nn::hidtypes::FeatureType". This is a 64-bit flag.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Bit
! Description
|-
| 0
| HasLeftAnalogStick
|-
|-
| 0x0 || 0x1 || [[#DeviceTypeInternal|DeviceType]]
| 1
| HasRightAnalogStick
|-
|-
| 0x1 || 0x1 || [[#InterfaceType|InterfaceType]]
| 2
| HasLeftJoySixAxisSensor
|-
|-
| 0x2 || 0x6 || Reserved
| 3
| HasRightJoySixAxisSensor
|-
|-
| 0x8 || 0x8 || [[#FeatureType|FeatureType]]
| 4
|}
| HasFullKeySixAxisSensor
 
= FirmwareVersionInfo =
This is "nn::hidtypes::FirmwareVersionInfo".
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 5
| HasLeftLraVibrationDevice
|-
|-
| 0x0 || 0x4 || [[#FirmwareVersionAttribute|FirmwareVersionAttribute]]
| 6
| HasRightLraVibrationDevice
|-
|-
| 0x4 || 0x2 ||
| 7
| HasGcVibrationDevice
|-
|-
| 0x6 || 0x2 || MajorVersion
| 8
| HasErmVibrationDevice
|-
|-
| 0x8 || 0x2 || MinorVersion
| 9
| HasLeftJoyRailBus
|-
|-
| 0xA || 0x2 ||
| 10
|}
| HasRightJoyRailBus
 
= FirmwareVersionAttribute =
This is "nn::hidtypes::FirmwareVersionAttribute". This is a 32-bit flag.
 
{| class="wikitable" border="1"
|-
|-
! Bit
| 11
! Description
| HasInternalBus
|-
|-
| 0
| 12
| IsCustomerCodeCorruption
| IsPalma
|-
|-
| 1
| 13
| IsIapCorrupted
| HasNfc
|}
 
= IrCameraHandle =
This is "nn::irsensor::IrCameraHandle".
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 14
| HasIrSensor
|-
|-
| 0x0 || 0x1 || PlayerNumber
| 15
| IsAnalogStickCalibrationSupported
|-
|-
| 0x1 || 0x1 || DeviceType
| 16
| IsSixAxisSensorUserCalibrationSupported
|-
|-
| 0x2 || 0x2 || Reserved
| 17
|}
| HasLeftJoyRightJoyBattery
 
= IrCameraStatus =
This is "nn::irsensor::IrCameraStatus".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Available
| 18
| HasFullKeyBattery
|-
|-
| 1 || Unsupported
| 19
| IsDisconnectControllerIfBatteryNone
|-
|-
| 2 || Unconnected
| 20
|}
| HasControllerColor
 
= IrCameraInternalStatus =
This is "nn::irsensor::IrCameraInternalStatus".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Stopped
| 21
| HasGripColor
|-
|-
| 1 || FirmwareUpdateNeeded
| 22
| HasIdentificationCode
|-
|-
| 2 ||  
| 23
| HasBluetoothAddress
|-
|-
| 3 ||  
| 24
| HasMcu
|-
|-
| 4 ||  
| 25
| HasNotificationLed
|-
|-
| 5 || FirmwareVersionRequested
| 26
| HasDirectionalButtons
|-
|-
| 6 || FirmwareVersionIsInvalid
| 27
| HasIndicatorLed
|-
|-
| 7 || [4.0.0+] Ready
| 28
| IsButtonConfigEmbeddedSupported
|-
|-
| 8 || [4.0.0+] Setting
| 29
|}
| IsButtonConfigFullSupported
 
= IrSensorMode =
This is "nn::irsensor::detail::StatusManager::IrSensorMode".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || None
| 30
| IsButtonConfigLeftSupported
|-
|-
| 1 || [[#MomentProcessorState|MomentProcessor]]
| 31
| IsButtonConfigRightSupported
|-
|-
| 2 || [[#ClusteringProcessorState|ClusteringProcessor]]
| 32
| IsUsbHidDevice
|-
|-
| 3 || [[#ImageTransferProcessorState|ImageTransferProcessor]]
| 33
| IsKuinaDevice
|-
|-
| 4 || [[#PointingProcessorMarkerState|PointingProcessorMarker]]
| 34
| IsDirectUsbToBtSwitchingDevice
|-
|-
| 5 || [[#TeraPluginProcessorState|TeraPluginProcessor]]
| 35
|-
| IsNormalizeAnalogStickWithInnerCross
| 6 || Unknown
|}
|}


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


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || Stopped
! Offset || Size || Description
|-
|-
| 1 || Running
| 0x0 || 0x4 || BodyColor
|}
 
= ImageTransferProcessorFormat =
This is "nn::irsensor::ImageTransferProcessorFormat".
 
This controls the IR Sensor image resolution.
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || 320x240
| 0x4 || 0x4 || ButtonColor
|-
|-
| 1 || 160x120
| 0x8 || 0x4 || LeftGripColor
|-
|-
| 2 || 80x60
| 0xC || 0x4 || RightGripColor
|-
| 3 || [4.0.0+] 40x30
|-
| 4 || [4.0.0+] 20x15
|}
|}


= MomentProcessorConfig =
= DeviceDescriptorType =
This is "nn::irsensor::MomentProcessorConfig".
This is "nn::hidtypes::DeviceDescriptorType".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 9,206: Line 9,844:
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x8 || ExposureTime (default is 0x493E0)
| 0x0 || 0x1 || [[#DeviceTypeInternal|DeviceType]]
|-
|-
| 0x8 || 0x4 || LightTarget (default is 0)
| 0x1 || 0x7 || Reserved
|-
|-
| 0xC || 0x4 || Gain (default is 0x8)
| 0x8 || 0x8 || [[#FeatureType|FeatureType]]
|-
|-
| 0x10 || 0x1 || IsNegativeImageUsed (default is 0)
| 0x10 || 0x8 || [[#DigitalButton|DigitalButton]]
|-
|-
| 0x11 || 0x7 || Reserved
| 0x18 || 0x4 || [[#AssignmentStyle|AssignmentStyle]]
|-
|-
| 0x18 || 0x2 || WindowOfInterestX (default is 0)
| 0x1C || 0x10 || [[#Color|DeviceColor]]
|-
|-
| 0x1A || 0x2 || WindowOfInterestY (default is 0)
| 0x2C || 0x4 || Reserved
|-
| 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 =
= DeviceDescriptionList =
This is "nn::irsensor::PackedMomentProcessorConfig".
This is "nn::hidtypes::detail::DeviceDescriptionList". This is a list of [[#DeviceDescriptorType|DeviceDescriptorType]] objects maintained by the hid-sysmodule.
 
This is converted from [[#MomentProcessorConfig]].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! [[#DeviceTypeInternal|DeviceType]] || [[#FeatureType|FeatureType]] || [[#DigitalButton|DigitalButton]] || [[#AssignmentStyle|AssignmentStyle]] || [[#Color|DeviceColor]]
|-
| 0x0 || 0x8 || ExposureTime (default is 0x493E0)
|-
|-
| 0x8 || 0x1 || LightTarget (default is 0)
| 1 || 0x18BDBE44A || 0x18F0406AF || 0x24 || 0xFF828282, 0xFF0F0F0F, 0x00000000, 0x00000000
|-
| 0x9 || 0x1 || Gain (default is 0x8)
|-
|-
| 0xA || 0x1 || IsNegativeImageUsed (default is 0)
| 2 || 0x14CDB8225 || 0x6F8F950 || 0x12 || 0xFF828282, 0xFF0F0F0F, 0x00000000, 0x00000000
|-
|-
| 0xB || 0x5 || Reserved
| 3 || 0x72BBDA073 || 0xFFCFFFF || 0x1 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|-
|-
| 0x10 || 0x2 || WindowOfInterestX (default is 0)
| 4 || 0x108000025 || 0x6F8F950 || 0x2 || 0xFF828282, 0xFF0F0F0F, 0x00000000, 0x00000000
|-
|-
| 0x12 || 0x2 || WindowOfInterestY (default is 0)
| 5 || 0x10800004A || 0x18F0406AF || 0x4 || 0xFF828282, 0xFF0F0F0F, 0x00000000, 0x00000000
|-
|-
| 0x14 || 0x2 || WindowOfInterestWidth (default is 0x140)
| 6 || 0x108800013 || 0xFFCFFFF || 0x1 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|-
|-
| 0x16 || 0x2 || WindowOfInterestHeight (default is 0xF0)
| 7 || 0x108CA0000 || 0x2008FCC3 || 0x11 || 0xFF322891, 0xFFFFFFFF, 0x00000000, 0x00000000
|-
|-
| 0x18 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
| 8 || 0x108CA0800 || 0x4F0C3 || 0x21 || 0xFF322891, 0xFFFFFFFF, 0x00000000, 0x00000000
|-
|-
| 0x1C || 0x1 || Preprocess (default is 0x1)
| 9 || 0x108CA0000 || 0x2008FCC3 || 0x11 || 0xFFD9D7D7, 0xFFFFFFFF, 0x00000000, 0x00000000
|-
|-
| 0x1D || 0x1 || PreprocessIntensityThreshold (default is 0x50)
| 10 || 0x108CA0000 || 0x4FCC3 || 0x21 || 0xFFD9D7D7, 0xFFFFFFFF, 0x00000000, 0x00000000
|-
|-
| 0x1E || 0x2 || Reserved
| 11 || 0x700CC0000 || 0xFFCF || 0x0 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|}
 
= ClusteringProcessorConfig =
This is "nn::irsensor::ClusteringProcessorConfig".
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 12 || 0x841011 || 0x10000010 || 0x1 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|-
|-
| 0x0 || 0x8 || ExposureTime (default is 200000)
| 13 || 0x83 || 0xFF0F6CF || 0x1 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|-
|-
| 0x8 || 0x4 || LightTarget (default is 0)
| 14 || 0x1 || 0xF8F950 || 0x10 || 0xFF828282, 0xFF0F0F0F, 0x00000000, 0x00000000
|-
|-
| 0xC || 0x4 || Gain (default is 0x2)
| 15 || 0x3 || 0xFFCFFFF || 0x1 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|-
|-
| 0x10 || 0x1 || IsNegativeImageUsed (default is 0)
| 16 || 0x3 || 0xFFCFFFF || 0x1 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|-
|-
| 0x11 || 0x7 || Reserved
| 17 || 0x1001A013 || 0xFFCFFFF || 0x8 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|-
|-
| 0x18 || 0x2 || WindowOfInterestX (default is 0)
| 18 || 0x2 || 0xF0406AF || 0x20 || 0xFF828282, 0xFF0F0F0F, 0x00000000, 0x00000000
|-
|-
| 0x1A || 0x2 || WindowOfInterestY (default is 0)
| 19 || 0x1088DA073 || 0xFFCF3FF || 0x1 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|-
|-
| 0x1C || 0x2 || WindowOfInterestWidth (default is 320)
| 20 || 0x108CA0025 || 0x6F8F150 || 0x12 || 0xFF828282, 0xFF0F0F0F, 0x00000000, 0x00000000
|-
|-
| 0x1E || 0x2 || WindowOfInterestHeight (default is 240)
| 21 || 0x108CA604A || 0x18F0402AF || 0x24 || 0xFF828282, 0xFF0F0F0F, 0x00000000, 0x00000000
|-
|-
| 0x20 || 0x4 || ObjectPixelCountMin (default is 0x3)
| [12.0.0+] 22 || 0xF00CC8101 || 0x1E1FCF6C3 || 0x1 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|-
|-
| 0x24 || 0x4 || ObjectPixelCountMax (default is 0x12C00)
| [12.0.0+] 23 || 0x100000000 || 0x0 || 0x0 || 0x00000000, 0x00000000, 0x00000000, 0x00000000
|-
|-
| 0x28 || 0x4 || ObjectIntensityMin (default is 150)
| [13.0.0+] 28 || 0x700CC0000 || 0xCF6CF || 0x1 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|-
|-
| 0x2C || 0x1 || IsExternalLightFilterEnabled (default is 0x1)
| [14.0.0+] 30 || 0x108800003 || 0xFFCFFFF || 0x1 || 0xFF2D2D2D, 0xFFE6E6E6, 0xFF464646, 0xFF464646
|}
|}


= PackedClusteringProcessorConfig =
= UnmaskFeatureDescriptorType =
This is "nn::irsensor::PackedClusteringProcessorConfig".
This is "nn::hid::server::UnmaskFeatureDescriptorType".
 
This is converted from [[#ClusteringProcessorConfig]].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 9,308: Line 9,924:
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x8 || ExposureTime
| 0x0 || 0x1 || [[#DeviceTypeInternal|DeviceType]]
|-
|-
| 0x8 || 0x1 || LightTarget
| 0x1 || 0x1 || [[#InterfaceType|InterfaceType]]
|-
|-
| 0x9 || 0x1 || Gain
| 0x2 || 0x6 || Reserved
|-
|-
| 0xA || 0x1 || IsNegativeImageUsed
| 0x8 || 0x8 || [[#FeatureType|FeatureType]]
|-
|}
| 0xB || 0x5 || Reserved
 
= UnmaskFeatureDescriptorList =
This is "nn::hid::server::UnmaskFeatureDescriptorList". This is a list of [[#UnmaskFeatureDescriptorType|UnmaskFeatureDescriptorType]] objects maintained by the hid-sysmodule.
 
{| class="wikitable" border="1"
|-
|-
| 0x10 || 0x2 || WindowOfInterestX
! [[#DeviceTypeInternal|DeviceType]] || [[#InterfaceType|InterfaceType]] || [[#FeatureType|FeatureType]]
|-
|-
| 0x12 || 0x2 || WindowOfInterestY
| 3 || 3 || 0x2000
|-
|-
| 0x14 || 0x2 || WindowOfInterestWidth
| 2 || 2 || 0x200
|-
|-
| 0x16 || 0x2 || WindowOfInterestHeight
| 1 || 2 || 0x400
|-
|-
| 0x18 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
| 19 || 3 || 0x2000
|-
|-
| 0x1C || 0x4 || ObjectPixelCountMin
| 2 || 3 || 0x200
|-
| 0x20 || 0x4 || ObjectPixelCountMax
|-
| 0x24 || 0x1 || ObjectIntensityMin
|-
| 0x25 || 0x1 || IsExternalLightFilterEnabled
|-
|-
| 0x26 || 0x2 || Reserved
| 1 || 3 || 0x6400
|}
|}


= ImageTransferProcessorConfig =
= FirmwareVersionInfo =
This is "nn::irsensor::ImageTransferProcessorConfig".
This is "nn::hidtypes::FirmwareVersionInfo".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 9,346: Line 9,960:
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x8 || ExposureTime
| 0x0 || 0x4 || [[#FirmwareVersionAttribute|FirmwareVersionAttribute]]
|-
|-
| 0x8 || 0x4 || LightTarget
| 0x4 || 0x2 ||
|-
|-
| 0xC || 0x4 || Gain
| 0x6 || 0x2 || MajorVersion
|-
|-
| 0x10 || 0x1 || IsNegativeImageUsed
| 0x8 || 0x2 || MinorVersion
|-
|-
| 0x11 || 0x7 || Reserved
| 0xA || 0x2 ||
|-
| 0x18 || 0x4 || [[#ImageTransferProcessorFormat|Format]]
|}
|}


= PackedImageTransferProcessorConfig =
= FirmwareVersionAttribute =
This is "nn::irsensor::PackedImageTransferProcessorConfig".
This is "nn::hidtypes::FirmwareVersionAttribute". This is a 32-bit flag.
 
This is converted from [[#ImageTransferProcessorConfig]].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! Bit
! Description
|-
|-
| 0x0 || 0x8 || ExposureTime
| 0
| IsCustomerCodeCorruption
|-
|-
| 0x8 || 0x1 || LightTarget
| 1
|-
| IsIapCorrupted
| 0x9 || 0x1 || Gain
|-
| 0xA || 0x1 || IsNegativeImageUsed
|-
| 0xB || 0x5 || Reserved
|-
| 0x10 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
|-
| 0x14 || 0x1 || [[#ImageTransferProcessorFormat|Format]]
|-
| 0x15 || 0x3 || Reserved
|}
|}


= ImageTransferProcessorState =
= IrCameraHandle =
This is "nn::irsensor::ImageTransferProcessorState".
This is "nn::irsensor::IrCameraHandle".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 9,392: Line 9,993:
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x8 || SamplingNumber
| 0x0 || 0x1 || PlayerNumber
|-
|-
| 0x8 || 0x4 || AmbientNoiseLevel
| 0x1 || 0x1 || DeviceType
|-
|-
| 0xC || 0x4 || Reserved
| 0x2 || 0x2 || Reserved
|}
|}


= TeraPluginProcessorConfig =
= IrCameraStatus =
This is "nn::irsensor::TeraPluginProcessorConfig".
This is "nn::irsensor::IrCameraStatus".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
! Offset || Size || Description
| 0 || Available
|-
|-
| 0x0 || 0x1 || Mode
| 1 || Unsupported
|-
|-
| 0x1 || 0x1 ||
| 2 || Unconnected
|-
| 0x2 || 0x1 ||
|-
| 0x3 || 0x1 ||  
|}
|}


= PackedTeraPluginProcessorConfig =
= IrCameraInternalStatus =
This is "nn::irsensor::PackedTeraPluginProcessorConfig".
This is "nn::irsensor::IrCameraInternalStatus".
 
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"
!  Value
!  Description
|-
| 0 || Stopped
|-
|-
! Offset || Size || Description
| 1 || FirmwareUpdateNeeded
|-
|-
| 0x0 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
| 2 ||  
|-
|-
| 0x4 || 0x1 || Mode
| 3 ||  
|-
|-
| 0x5 || 0x1 ||  
| 4 ||  
|-
|-
| 0x6 || 0x1 ||  
| 5 || FirmwareVersionRequested
|-
|-
| 0x7 || 0x1 ||  
| 6 || FirmwareVersionIsInvalid
|-
| 7 || [4.0.0+] Ready
|-
| 8 || [4.0.0+] Setting
|}
|}


= PointingProcessorConfig =
= IrSensorMode =
This is "nn::irsensor::PointingProcessorConfig".
This is "nn::irsensor::detail::StatusManager::IrSensorMode".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || None
|-
| 1 || [[#MomentProcessorState|MomentProcessor]]
|-
|-
! Offset || Size || Description
| 2 || [[#ClusteringProcessorState|ClusteringProcessor]]
|-
| 3 || [[#ImageTransferProcessorState|ImageTransferProcessor]]
|-
| 4 || [[#PointingProcessorMarkerState|PointingProcessorMarker]]
|-
|-
| 0x0 || 0x2 || WindowOfInterestX (default is 0)
| 5 || [[#TeraPluginProcessorState|TeraPluginProcessor]]
|-
|-
| 0x2 || 0x2 || WindowOfInterestY (default is 0)
| 6 || Unknown
|}
 
= ImageProcessorStatus =
This is "nn::irsensor::ImageProcessorStatus".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0x4 || 0x2 || WindowOfInterestWidth (default is 320)
| 0 || Stopped
|-
|-
| 0x6 || 0x2 || WindowOfInterestHeight (default is 240)
| 1 || Running
|}
|}


= PackedPointingProcessorConfig =
= ImageTransferProcessorFormat =
This is "nn::irsensor::PackedPointingProcessorConfig".
This is "nn::irsensor::ImageTransferProcessorFormat".


This is converted from [[#PointingProcessorConfig]].
This controls the IR Sensor image resolution.


{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
! Offset || Size || Description
| 0 || 320x240
|-
|-
| 0x0 || 0x2 || WindowOfInterestX (default is 0)
| 1 || 160x120
|-
|-
| 0x2 || 0x2 || WindowOfInterestY (default is 0)
| 2 || 80x60
|-
|-
| 0x4 || 0x2 || WindowOfInterestWidth (default is 320)
| 3 || [4.0.0+] 40x30
|-
|-
| 0x6 || 0x2 || WindowOfInterestHeight (default is 240)
| 4 || [4.0.0+] 20x15
|-
| 0x8 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
|}
|}


= PackedMcuVersion =
= MomentProcessorConfig =
This is "nn::irsensor::PackedMcuVersion".
This is "nn::irsensor::MomentProcessorConfig".


{| class="wikitable" border="1"
{| class="wikitable" border="1"
Line 9,480: Line 10,101:
! Offset || Size || Description
! Offset || Size || Description
|-
|-
| 0x0 || 0x2 || MajorVersion
| 0x0 || 0x8 || ExposureTime (default is 0x493E0)
|-
|-
| 0x2 || 0x2 || MinorVersion
| 0x8 || 0x4 || LightTarget (default is 0)
|}
 
== Versions ==
{| class="wikitable" border="1"
|-
|-
! MajorVersion || MinorVersion || SystemVersion
| 0xC || 0x4 || Gain (default is 0x8)
|-
|-
| 0x3 || 0xB || [1.0.0+]
| 0x10 || 0x1 || IsNegativeImageUsed (default is 0)
|-
|-
| 0x4 || 0x12 || [4.0.0+]
| 0x11 || 0x7 || Reserved
|-
|-
| 0x5 || 0x18 || [5.0.0+]
| 0x18 || 0x2 || WindowOfInterestX (default is 0)
|-
|-
| 0x6 || 0x1A || [6.0.0+]
| 0x1A || 0x2 || WindowOfInterestY (default is 0)
|-
|-
| 0x8 || 0x1B || [8.0.0+]
| 0x1C || 0x2 || WindowOfInterestWidth (default is 0x140)
|}
 
= PackedFunctionLevel =
This is nn::irsensor::PackedFunctionLevel.
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 0x1E || 0x2 || WindowOfInterestHeight (default is 0xF0)
|-
|-
| 0x0 || 0x1 || [[#IrSensorFunctionLevel]]
| 0x20 || 0x4 || Preprocess (default is 0x1)
|-
|-
| 0x1 || 0x3 || Reserved
| 0x24 || 0x4 || PreprocessIntensityThreshold (default is 0x50)
|}
|}


== IrSensorFunctionLevel ==
= PackedMomentProcessorConfig =
This is "nn::irsensor::IrSensorFunctionLevel".
This is "nn::irsensor::PackedMomentProcessorConfig".
 
This is converted from [[#MomentProcessorConfig]].


{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Value || SystemVersion
! Offset || Size || Description
|-
|-
| 0 || [1.0.0+]
| 0x0 || 0x8 || ExposureTime (default is 0x493E0)
|-
|-
| 1 || [4.0.0+]
| 0x8 || 0x1 || LightTarget (default is 0)
|-
|-
| 2 || [5.0.0+]
| 0x9 || 0x1 || Gain (default is 0x8)
|-
|-
| 3 || [6.0.0+]
| 0xA || 0x1 || IsNegativeImageUsed (default is 0)
|-
|-
| 4 || [8.0.0+]
| 0xB || 0x5 || Reserved
|}
 
= ImageTransferProcessorExConfig =
This is "nn::irsensor::ImageTransferProcessorExConfig".
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| 0x10 || 0x2 || WindowOfInterestX (default is 0)
|-
|-
| 0x0 || 0x8 || ExposureTime
| 0x12 || 0x2 || WindowOfInterestY (default is 0)
|-
|-
| 0x8 || 0x4 || LightTarget
| 0x14 || 0x2 || WindowOfInterestWidth (default is 0x140)
|-
|-
| 0xC || 0x4 || Gain
| 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
| 0x10 || 0x1 || IsNegativeImageUsed (default is 0)
|-
|-
| 0x11 || 0x7 || Reserved
| 0x11 || 0x7 || Reserved
|-
|-
| 0x18 || 0x4 || [[#ImageTransferProcessorFormat|OrigFormat]]
| 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
|-
|-
| 0x1C || 0x4 || [[#ImageTransferProcessorFormat|TrimmingFormat]]
| 0x9 || 0x1 || Gain
|-
|-
| 0x20 || 0x2 || TrimmingStartX
| 0xA || 0x1 || IsNegativeImageUsed
|-
|-
| 0x22 || 0x2 || TrimmingStartY
| 0xB || 0x5 || Reserved
|-
|-
| 0x24 || 0x1 || IsExternalLightFilterEnabled
| 0x10 || 0x2 || WindowOfInterestX
|}
|-
 
| 0x12 || 0x2 || WindowOfInterestY
= PackedImageTransferProcessorExConfig =
|-
This is "nn::irsensor::PackedImageTransferProcessorExConfig".
| 0x14 || 0x2 || WindowOfInterestWidth
 
|-
This is converted from [[#ImageTransferProcessorExConfig]].
| 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.
* [S2] [20.1.1+] '''ExpectVersionInfo.json'''
* '''FirmwareInfo.csv'''
** List in the format "[device],[type],[version],[file]" where "device", "type" and "version" should match the values from "ExpectVersionInfo" and "file" is the name of the firmware file.
* '''ukyosakyo_ep2_ota.bin'''
** Left/Right Joy-Con BT firmware.
* '''raizo_ep2_ota.bin'''
** Pro Controller BT firmware.
* '''tera_ota.bin'''
** Right Joy-Con MCU firmware.
* '''tera_ota_iap.bin'''
** Right Joy-Con MCU (IAP profile) firmware.
* '''tera_fullkey_ota.bin'''
** Pro Controller MCU firmware.
* '''tera_fullkey_ota_iap.bin'''
** Pro Controller MCU (IAP profile) firmware.
* [6.0.0+] '''ProController.dfu'''
** Pro Controller USB firmware.
* [6.1.0+] '''PalmaFw.bin'''
** Poké Ball Plus BT firmware.
* [S1] [8.1.1+] '''ExpectVersionInfo-platform.hoag.csv'''
** Same as "ExpectVersionInfo.csv" but for the Switch Lite platform.
* [S1] [8.1.1+] '''FirmwareInfo-platform.hoag.csv'''
** Same as "FirmwareInfo.csv" but for the Switch Lite platform.
* [S1] [8.1.1+] '''sioh.bin'''
** Switch Lite Joy-Con firmware.
* [S1] [8.1.1+] '''sioh_iap.bin'''
** Switch Lite Joy-Con (IAP profile) firmware.
* [S1] [10.0.0+] '''FTS_00120100.fts256'''
** Touch Screen controller firmware in FTS256 format.
* [S1] [10.0.0+] '''FTS_32000001.fts256'''
** Touch Screen controller firmware in FTS256 format for panel vendor "Nissha".
* [S1] [10.0.0+] '''FTS_32000102.fts256'''
** Touch Screen controller firmware in FTS256 format for panel vendor "GIS".
* [S1] [10.0.0+] '''FTS_32000302.fts256'''
** Touch Screen controller firmware in FTS256 format for panel vendor "Nissha_Hoag".
* [S1] [10.0.0+] '''FTS_32000402.fts256'''
** Touch Screen controller firmware in FTS256 format for panel vendor "GIS_Hoag".
* [S1] [10.0.0+] '''TouchScreenConfiguration.csv'''
** List in the format "[gpio],[gpio],[gpio],[config],[config]" where "gpio" can be "0" or "1" and "config" is an integer number.
* [10.0.0+] '''TouchScreenFirmwareInfo.csv'''
** List in the format "[driver],[gpio],[gpio],[gpio],[version],[file]" where "driver" can be "FTM" or "FST2", "gpio" can be "0" or "1", "version" is the hexadecimal representation of the firmware file's version and "file" is the name of the firmware file.
** With [S2] there's only a single hex-value field between "driver" and "file". "driver" is "Innolux" or "Sharp".
* [13.0.0+] '''FTS_33000510.fts256'''
** Touch Screen controller firmware in FTS256 format for panel vendor "Samsung_Aula".
* [13.0.0] '''FTS_98000004.ftb'''
** Touch Screen controller firmware in FTB format.
* [13.1.0-13.2.1] '''FTS_50000001.ftb'''
** Touch Screen controller firmware in FTB format for panel vendor "Nissha".
* [S1] [14.0.0+] '''FTS_50000002.ftb'''
** Touch Screen controller firmware in FTB format for panel vendor "Nissha".
* [S2] [20.1.1+] '''JoyLeftImage1.json'''
* [S2] [20.1.1+] '''JoyLeftImage2.json'''
* [S2] [20.1.1+] '''JoyRightImage1.json'''
* [S2] [20.1.1+] '''JoyRightImage2.json'''
* [S2] '''NT36683_INX.bin'''
** Touch Screen controller firmware for panel vendor "Innolux".
* [S2] '''NT36683_SHP.bin'''
** Touch Screen controller firmware for panel vendor "Sharp".
* [S2] [20.1.1+] '''OunceJoyLeft.bin'''
* [S2] [20.1.1+] '''OunceJoyLeftBtPatch.bin'''
* [S2] [20.1.1+] '''OunceJoyRight.bin'''
* [S2] [20.1.1+] '''OunceJoyRightBtPatch.bin'''
* [S2] [20.1.1+] '''OunceProCon.bin'''
* [S2] [20.1.1+] '''OunceProConBtPatch.bin'''
* [S2] [20.1.1+] '''OunceProConDspFirmware.img'''
* [S2] [20.1.1+] '''ProConImage1.json'''
* [S2] [20.1.1+] '''ProConImage2.json'''
* [S2] [20.1.1+] '''ProConImage3.json'''
 
== Versions ==
=== Ukyosakyo ===
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! SystemVersion
|-
! FirmwareVersion
| 0x0 || 0x8 || ExposureTime
|-
| 0x8 || 0x1 || LightTarget
|-
| 0x9 || 0x1 || Gain
|-
| 0xA || 0x1 || IsNegativeImageUsed
|-
| 0xB || 0x5 || Reserved
|-
| 0x10 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
|-
| 0x14 || 0x1 || [[#ImageTransferProcessorFormat|OrigFormat]]
|-
| 0x15 || 0x1 || [[#ImageTransferProcessorFormat|TrimmingFormat]]
|-
| 0x16 || 0x2 || TrimmingStartX
|-
| 0x18 || 0x2 || TrimmingStartY
|-
| 0x1A || 0x1 || IsExternalLightFilterEnabled
|-
|-
| 0x1B || 0x5 || Reserved
| [1.0.0+]
|}
| 0348
 
= IrLedProcessorConfig =
This is "nn::irsensor::IrLedProcessorConfig".
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| [5.0.0+]
| 0389
|-
|-
| 0x0 || 0x4 || LightTarget
| [6.0.0+]
|}
| 038B
 
= PackedIrLedProcessorConfig =
This is "nn::irsensor::PackedIrLedProcessorConfig".
 
This is converted from [[#IrLedProcessorConfig]].
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| [7.0.0+]
| 03A6
|-
|-
| 0x0 || 0x4 || [[#PackedMcuVersion|RequiredMcuVersion]]
| [8.0.0+]
| 03B5
|-
|-
| 0x4 || 0x1 || LightTarget
| [9.0.0+]
| 0400
|-
|-
| 0x5 || 0x3 || Padding
| [10.0.0+]
|}
| 0406
 
= AdaptiveClusteringProcessorConfig =
This is "nn::irsensor::AdaptiveClusteringProcessorConfig".
 
AdaptiveClusteringProcessor was added with [5.0.0+].
 
This is converted to [[#TeraPluginProcessorConfig]] by the user-process. [[#TeraPluginProcessorConfig]]+0x3 is zero.
 
The default config is all-zero.
 
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
| [11.0.0+]
| 0407
|-
|-
| 0x0 || 0x4 || [[#AdaptiveClusteringMode]]
| [12.1.0+]
| 0410
|-
|-
| 0x4 || 0x4 || [6.0.0+] [[#AdaptiveClusteringTargetDistance]]
| [13.0.0+]
|}
| 0417
 
== AdaptiveClusteringMode ==
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || StaticFov
| [14.0.0+]
| 0419
|-
|-
| 1 || DynamicFov
| [21.0.0+]
| 0420
|}
|}


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


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


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


= JoyPollingReceivedData =
=== ProController ===
This is "nn::hidbus::JoyPollingReceivedData".
 
This is copied from the entries in [[#EnableJoyPollingReceiveMode|TransferMemory]] by GetJoyPollingReceivedData.
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
|-
|-
! Offset || Size || Description
! SystemVersion
|-
! FirmwareVersion
| 0x0 || 0x30 || Data
|-
|-
| 0x30 || 0x8 || OutSize
| -
| 010A0200
|-
|-
| 0x38 || 0x8 || SamplingNumber
| [6.0.0+]
| 01100210
|}
|}


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


= JoyPollingMode =
=== SioH ===
This is "nn::hidbus::JoyPollingMode".
 
{| class="wikitable" border="1"
{| class="wikitable" border="1"
!  Value
!  Description
|-
|-
| 0 || SixAxisSensorDisable
! SystemVersion
! FirmwareVersion
|-
|-
| 1 || SixAxisSensorEnable
| -
| 000D
|-
|-
| 2 || ButtonOnly
| [8.1.1+]
|}
| 0200
 
Other values causes [[#EnableJoyPollingReceiveMode]] to assert.
 
= StatusManagerType =
This is "nn::hidbus::detail::StatusManagerType".
 
{| class="wikitable" border="1"
!  Value
!  Description
|-
| 0 || None
|-
|-
| 1 || 16
| [10.0.0+]
| 0301
|-
|-
| 2 || 32
| [11.0.0+]
| 0304
|}
|}
= ExternalDevices =
The following devices are used via hidbus:
* [[Ring-Con]]
* Famicom right controller (with microphone)
** [[#BusType]] is 2, ExternalDeviceId is 0x21. SendAndReceive is not used. EnableJoyPollingReceiveMode is used where the input buffer is an u32 with value 0, [[#JoyPollingMode]] = 2. GetJoyPollingReceivedData is used to get the output data.
* Used by Starlink: Battle For Atlas.
** [[#BusType]] is 1, ExternalDeviceId is 0x28. EnableJoyPollingReceiveMode is used where the input buffer is an u16 with value 0x09, [[#JoyPollingMode]] = 0. SendAndReceive is called from 1 func. GetJoyPollingReceivedData is used to determine whether to call the same func which calls SendAndReceive, which is only done if <code>out_size==0x4 && data[0]==0x09 && (data[1] & 1 == 1)</code>.
= RomFS =
The hid-sysmodule RomFS contains:
  ftmFwUpdate
    ├── NTD_4CD_1801.fts256
    ├── NTD_4CD_2602.fts256
    ├── NTD_4CD_3801.fts256
    └── NTD_4CD_xxxx.fts256 [7.0.0+]
These are firmware files for the touchscreen controller.
[9.0.0+] The hid-sysmodule RomFS now contains:
  ftmFwUpdate
    ├── FTS_00120100.fts256
    ├── FTS_32000001.fts256
    ├── FTS_32000102.fts256
    ├── FTS_32000302.fts256
    └── FTS_32000402.fts256
[10.0.0+] The RomFs for hid-sysmodule was removed. The data which used to be in RomFs was moved into title [[Title_list|0100000000000822]].
= Firmware update =
HID-sysmodule mounts the contents of title [[Title_list|0100000000000822]] as "systemData" or the contents of title [[Title_list|010000000000B22B]] as "systemDataD". Both titles contain the same files, but [[Title_list|0100000000000822]] is used on retail units while [[Title_list|010000000000B22B]] is used for development.
These titles contain the following files:
* '''ExpectVersionInfo.csv''' - List in the format "[device],[type],[version]" where "device" can be "JoyLeft", "JoyRight", "FullKey", "Palma" or "Handheld", "type" can be "BT", "MCU", "USB" or "SioH" and "version" is the hexadecimal representation of the firmware file's version.
* '''FirmwareInfo.csv''' - List in the format "[device],[type],[version],[file]" where "device", "type" and "version" should match the values from "ExpectVersionInfo" and "file" is the name of the firmware file.
* '''ukyosakyo_ep2_ota.bin''' - Left/Right Joy-Con BT firmware.
* '''raizo_ep2_ota.bin''' - Pro Controller BT firmware.
* '''tera_ota.bin''' - Right Joy-Con MCU firmware.
* '''tera_ota_iap.bin''' - Right Joy-Con MCU (IAP profile) firmware.
* '''tera_fullkey_ota.bin''' - Pro Controller MCU firmware.
* '''tera_fullkey_ota_iap.bin''' - Pro Controller MCU (IAP profile) firmware.
* [6.0.0+] '''ProController.dfu''' - Pro Controller USB firmware.
* [6.1.0+] '''PalmaFw.bin''' - Poké Ball Plus BT firmware.
* [9.0.0+] '''ExpectVersionInfo-platform.hoag.csv''' - Same as "ExpectVersionInfo.csv" but for the Switch Lite platform.
* [9.0.0+] '''FirmwareInfo-platform.hoag.csv''' - Same as "FirmwareInfo.csv" but for the Switch Lite platform.
* [9.0.0+] '''sioh.bin''' - Switch Lite Joy-Con firmware.
* [9.0.0+] '''sioh_iap.bin''' - Switch Lite Joy-Con (IAP profile) firmware.
* [10.0.0+] '''FTS_00120100.fts256''' - Touch Screen controller firmware in FTS256 format.
* [10.0.0+] '''FTS_32000001.fts256''' - Touch Screen controller firmware in FTS256 format for panel vendor "Nissha".
* [10.0.0+] '''FTS_32000102.fts256''' - Touch Screen controller firmware in FTS256 format for panel vendor "GIS".
* [10.0.0+] '''FTS_32000302.fts256''' - Touch Screen controller firmware in FTS256 format for panel vendor "Nissha_Hoag".
* [10.0.0+] '''FTS_32000402.fts256''' - Touch Screen controller firmware in FTS256 format for panel vendor "GIS_Hoag".
* [10.0.0+] '''TouchScreenConfiguration.csv''' - List in the format "[gpio],[gpio],[gpio],[config],[config]" where "gpio" can be "0" or "1" and "config" is an integer number.
* [10.0.0+] '''TouchScreenFirmwareInfo.csv''' - List in the format "[driver],[gpio],[gpio],[gpio],[version],[file]" where "driver" can be "FTM" or "FST2", "gpio" can be "0" or "1", "version" is the hexadecimal representation of the firmware file's version and "file" is the name of the firmware file.
* [13.0.0+] '''FTS_33000510.fts256''' - Touch Screen controller firmware in FTS256 format for panel vendor "Samsung".
* [13.0.0] '''FTS_98000004.ftb''' - Touch Screen controller firmware in FTB format.
* [13.1.0-13.2.1] '''FTS_50000001.ftb''' - Touch Screen controller firmware in FTB format for panel vendor "Nissha".
* [14.0.0+] '''FTS_50000002.ftb''' - Touch Screen controller firmware in FTB format for panel vendor "Nissha".


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