Changes

HID services (view source)

Revision as of 20:02, 23 July 2021

14,256 bytes added , 20:02, 23 July 2021

no edit summary

Line 157: Line 157:

|-

| 211 || [7.0.0+] [[#IsVibrationDeviceMounted]]

+

|-

+

| 212 || [11.0.0+] [[#SendVibrationValueInBool]]

|-

| 300 || [3.0.0+] [[#ActivateConsoleSixAxisSensor]]

Line 584: Line 586:

== IsVibrationDeviceMounted ==

Takes a PID, an [[#VibrationDeviceHandle]], and an u64 [[AM_services|AppletResourceUserId]], returns an output u8 bool.

+

== SendVibrationValueInBool ==

+

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

+

Stubbed, this just returns 0.

+

This is currently not exposed by sdknso.

== ActivateConsoleSixAxisSensor ==

Line 713: Line 722:

sdknso uses an user-specified EventClearMode.

+

The Event is signaled when data is available with [[#GetPalmaOperationInfo]].

== GetPalmaOperationInfo ==

Line 718: Line 729:

sdknso passes [[#PalmaOperationInfo]]+0x8 size 0x140 for the output buffer. [5.1.0+] After using the cmd successfully, [[#GetPalmaOperationResult]] is used.

+

This must be used at some point following using any of the other Palma cmds which trigger an Operation, once the [[#AcquirePalmaOperationCompleteEvent|Event]] is signaled. Up to 4 Operations can be queued at once, the other cmds will throw an error once there's too many operations.

== PlayPalmaActivity ==

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

+

See [[#hidGetPalmaOperationInfo]].

== SetPalmaFrModeType ==

Takes an input [[#PalmaConnectionHandle]], an u64 [[#PalmaFrModeType]], no output.

+

See [[#hidGetPalmaOperationInfo]].

== ReadPalmaStep ==

Takes an input [[#PalmaConnectionHandle]], no output.

+

See [[#hidGetPalmaOperationInfo]].

+

[[#EnablePalmaStep]] should be used before this.

== EnablePalmaStep ==

Takes an input bool, a [[#PalmaConnectionHandle]], no output.

+

See [[#hidGetPalmaOperationInfo]].

== ResetPalmaStep ==

Takes an input [[#PalmaConnectionHandle]], no output.

+

See [[#hidGetPalmaOperationInfo]].

== ReadPalmaApplicationSection ==

−

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

+

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

+

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

+

See [[#hidGetPalmaOperationInfo]].

== WritePalmaApplicationSection ==

−

Takes an input [[#PalmaConnectionHandle]], an u64, an u64, a type-0x19 input buffer containing a [[#PalmaApplicationSectionAccessBuffer]], no output.

+

Takes an input [[#PalmaConnectionHandle]], an u64, an u64 size, a type-0x19 input buffer containing a [[#PalmaApplicationSectionAccessBuffer]], no output.

+

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

+

See [[#hidGetPalmaOperationInfo]].

== ReadPalmaUniqueCode ==

Takes an input [[#PalmaConnectionHandle]], no output.

+

See [[#hidGetPalmaOperationInfo]].

== SetPalmaUniqueCodeInvalid ==

Takes an input [[#PalmaConnectionHandle]], no output.

+

See [[#hidGetPalmaOperationInfo]].

== WritePalmaActivityEntry ==

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

+

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

+

See [[#hidGetPalmaOperationInfo]].

== WritePalmaRgbLedPatternEntry ==

Takes an input [[#PalmaConnectionHandle]], an u64, a type-0x5 input buffer, no output.

+

sdknso exposes the u64 as an u16.

+

See [[#hidGetPalmaOperationInfo]].

== WritePalmaWaveEntry ==

−

Takes an input [[#PalmaConnectionHandle]], an u64, an u64, a handle, an u64, an u64, no output.

+

Takes an input [[#PalmaConnectionHandle]], an u64 [[#PalmaWaveSet]], an u64 (exposed by sdknso as an u16), a TransferMemory handle, an u64 tmem_size, an u64 size, no output.

+

The TransferMemory is created from an user-specified buffer with permissions=R--.

+

Note that the sysmodule will not properly close the TransferMemory handle if the [[#PalmaConnectionHandle]] is invalid.

+

See [[#hidGetPalmaOperationInfo]].

== SetPalmaDataBaseIdentificationVersion ==

Takes an input s32, a [[#PalmaConnectionHandle]], no output.

+

See [[#hidGetPalmaOperationInfo]].

== GetPalmaDataBaseIdentificationVersion ==

Takes an input [[#PalmaConnectionHandle]], no output.

+

See [[#hidGetPalmaOperationInfo]].

== SuspendPalmaFeature ==

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

+

See [[#hidGetPalmaOperationInfo]].

== GetPalmaOperationResult ==

Line 771: Line 828:

== ReadPalmaPlayLog ==

Takes an input u16, a [[#PalmaConnectionHandle]], no output.

+

See [[#hidGetPalmaOperationInfo]].

== ResetPalmaPlayLog ==

Takes an input u16, a [[#PalmaConnectionHandle]], no output.

+

See [[#hidGetPalmaOperationInfo]].

== SetIsPalmaAllConnectable ==

Line 786: Line 847:

== SetPalmaBoostMode ==

Takes an input bool, no output.

+

Stubbed, just returns 0. This was replaced by [[#EnablePalmaBoostMode]].

== CancelWritePalmaWaveEntry ==

Line 801: Line 864:

== SetNpadCommunicationMode ==

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

+

[2.0.0+] Stubbed, just returns 0.

== GetNpadCommunicationMode ==

Line 806: Line 871:

sdknso uses a switch-statement to determine the value to write to the output [[#NpadCommunicationMode]], with the s64 (written value is the same as the s64). sdknso will Abort if the s64 is not 0-3.

+

[2.0.0+] Stubbed, just returns hard-coded output mode=3.

== SetTouchScreenConfiguration ==

Line 862: Line 929:

|-

| 13 || [9.0.0+] GetTouchScreenConfiguration

+

|-

+

| 14 || [11.0.0+] ProcessTouchScreenAutoTune

|-

| 20 || [[#DeactivateMouse]]

Line 897: Line 966:

| 112 || UnsetHomeButtonAutoPilotState

|-

−

| 120 || DeactivateSleepButton

+

| 120 || [[#DeactivateSleepButton]]

|-

−

| 121 || SetSleepButtonAutoPilotState

+

| 121 || [[#SetSleepButtonAutoPilotState]]

|-

−

| 122 || UnsetSleepButtonAutoPilotState

+

| 122 || [[#UnsetSleepButtonAutoPilotState]]

|-

| 123 || [1.0.0-9.2.0] DeactivateInputDetector

Line 1,022: Line 1,091:

|-

| 246 || [9.0.0+] GetVidPid

+

|-

+

| 247 || [11.0.0+] GetAnalogStickCalibrationValue

+

|-

+

| 248 || [11.0.0+] GetUniquePadIdsFull

+

|-

+

| 249 || [11.0.0+] ConnectUniquePad

+

|-

+

| 250 || [12.0.0+] IsVirtual

+

|-

+

| 251 || [12.0.0+] GetAnalogStickModuleParam

|-

| 301 || [5.0.0-8.1.0] [[#GetAbstractedPadHandles]]

Line 1,053: Line 1,132:

| 332 || [7.0.0+] [[#SetHdlsState]]

|-

−

| 350 || [5.0.0+] AddRegisteredDevice

+

| 350 || [5.0.0+] [[#AddRegisteredDevice]]

|-

| 400 || [6.0.0+] DisableExternalMcuOnNxDevice

Line 1,062: Line 1,141:

|-

| 403 || [10.0.0+] EnableShipmentModeAutoClear

+

|-

+

| 404 || [11.0.0+] SetRailEnabled

|-

| 500 || [8.0.0+] SetFactoryInt

Line 1,074: Line 1,155:

|-

| 600 || [10.0.0+] ConvertPadState

+

|-

+

| 650 || [12.0.0+] AddButtonPlayData

+

|-

+

| 651 || [12.0.0+] StartButtonPlayData

+

|-

+

| 652 || [12.0.0+] StopButtonPlayData

|-

| 2000 || [10.0.0+] DeactivateDigitizer

Line 1,127: Line 1,214:

This just returns 0.

+

== DeactivateSleepButton ==

+

No input/output.

+

== SetSleepButtonAutoPilotState ==

+

Takes an input [[#SleepButtonAutoPilotState]], no output.

+

== UnsetSleepButtonAutoPilotState ==

+

No input/output.

== StartFirmwareUpdate ==

Line 1,275: Line 1,371:

[9.0.0+] Input order was swapped: now takes an input [[#HdlsHandle]] and a [[#HdlsState]], no output.

+

== AddRegisteredDevice ==

+

Takes an input [[#RegisteredDevice]], no output.

+

[11.0.0+] Takes an input [[#DebugRegisteredDevice]], no output.

= hid:sys =

Line 1,386: Line 1,487:

|-

| 513 || [3.0.0+] EndPermitVibrationSession

+

|-

+

| 514 || [12.0.0+] SendVibrationNotificationPattern

|-

| 520 || EnableHandheldHids

Line 1,396: Line 1,499:

|-

| 524 || [10.0.0+] IsHandheldHidsEnabled

+

|-

+

| 525 || [11.0.0+] IsJoyConAttachedOnAllRail

|-

| 540 || AcquirePlayReportControllerUsageUpdateEvent

Line 1,551: Line 1,656:

| 1200 || [10.0.0+] [[#IsButtonConfigSupported]]

|-

−

| 1201 || [10.0.0+] [[#DeleteButtonConfig]]

+

| 1201 || [11.0.0+] [[#IsButtonConfigEmbeddedSupported]] ([10.0.0-10.2.0] [[#DeleteButtonConfig]])

+

|-

+

| 1202 || [11.0.0+] [[#DeleteButtonConfig]] ([10.0.0-10.2.0] [[#SetButtonConfigEnabled]])

+

|-

+

| 1203 || [11.0.0+] [[#DeleteButtonConfigEmbedded]] ([10.0.0-10.2.0] [[#IsButtonConfigEnabled]])

|-

−

| ~~1202~~ || [10.0.0+] [[#SetButtonConfigEnabled]]

+

| 1204 || [11.0.0+] [[#SetButtonConfigEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigEmbedded]])

|-

−

| ~~1203~~ || [10.0.0+] [[#~~IsButtonConfigEnabled~~]]

+

| 1205 || [11.0.0+] [[#SetButtonConfigEmbeddedEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigFull]])

|-

−

| ~~1204~~ || [10.0.0+] [[#~~SetButtonConfigEmbedded~~]]

+

| 1206 || [11.0.0+] [[#IsButtonConfigEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigLeft]])

|-

−

| ~~1205~~ || [10.0.0+] [[#~~SetButtonConfigFull~~]]

+

| 1207 || [11.0.0+] [[#IsButtonConfigEmbeddedEnabled]] ([10.0.0-10.2.0] [[#SetButtonConfigRight]])

|-

−

| ~~1206~~ || [10.0.0+] [[#~~SetButtonConfigLeft~~]]

+

| 1208 || [11.0.0+] [[#SetButtonConfigEmbedded]] ([10.0.0-10.2.0] [[#GetButtonConfigEmbedded]])

|-

−

| ~~1207~~ || [10.0.0+] [[#~~SetButtonConfigRight~~]]

+

| 1209 || [11.0.0+] [[#SetButtonConfigFull]] ([10.0.0-10.2.0] [[#GetButtonConfigFull]])

|-

−

| ~~1208~~ || [10.0.0+] [[#~~GetButtonConfigEmbedded~~]]

+

| 1210 || [10.0.0-10.2.0] [[#GetButtonConfigLeft]]

|-

−

| ~~1209~~ || [10.0.0+] [[#~~GetButtonConfigFull~~]]

+

| 1211 || [11.0.0+] [[#SetButtonConfigRight]] ([10.0.0-10.2.0] [[#GetButtonConfigRight]])

|-

−

| ~~1210~~ || [10.0.0+] [[#~~GetButtonConfigLeft~~]]

+

| 1212 || [11.0.0+] [[#GetButtonConfigEmbedded]]

|-

−

| ~~1211~~ || [10.0.0+] [[#GetButtonConfigRight]]

+

| 1213 || [11.0.0+] [[#GetButtonConfigFull]]

+

|-

+

| 1214 || [11.0.0+] [[#GetButtonConfigLeft]]

+

|-

+

| 1215 || [11.0.0+] [[#GetButtonConfigRight]]

|-

| 1250 || [10.0.0+] [[#IsCustomButtonConfigSupported]]

Line 1,591: Line 1,704:

| 1258 || [10.0.0+] [[#IsButtonConfigStorageRightEmpty]]

|-

−

| 1259 || [10.0.0+] [[#GetButtonConfigStorageEmbedded]]

+

| 1259 || [11.0.0+] [[#GetButtonConfigStorageEmbeddedDeprecated]] ([10.0.0-10.2.0] [[#GetButtonConfigStorageEmbeddedDeprecated|GetButtonConfigStorageEmbedded]])

|-

−

| 1260 || [10.0.0+] [[#GetButtonConfigStorageFull]]

+

| 1260 || [11.0.0+] [[#GetButtonConfigStorageFullDeprecated]] ([10.0.0-10.2.0] [[#GetButtonConfigStorageFullDeprecated|GetButtonConfigStorageFull]])

|-

−

| 1261 || [10.0.0+] [[#GetButtonConfigStorageLeft]]

+

| 1261 || [11.0.0+] [[#GetButtonConfigStorageLeftDeprecated]] ([10.0.0-10.2.0] [[#GetButtonConfigStorageLeftDeprecated|GetButtonConfigStorageLeft]])

|-

−

| 1262 || [10.0.0+] [[#GetButtonConfigStorageRight]]

+

| 1262 || [11.0.0+] [[#GetButtonConfigStorageRightDeprecated]] ([10.0.0-10.2.0] [[#GetButtonConfigStorageRightDeprecated|GetButtonConfigStorageRight]])

|-

−

| 1263 || [10.0.0+] [[#SetButtonConfigStorageEmbedded]]

+

| 1263 || [11.0.0+] [[#SetButtonConfigStorageEmbeddedDeprecated]] ([10.0.0-10.2.0] [[#SetButtonConfigStorageEmbeddedDeprecated|SetButtonConfigStorageEmbedded]])

|-

−

| 1264 || [10.0.0+] [[#SetButtonConfigStorageFull]]

+

| 1264 || [11.0.0+] [[#SetButtonConfigStorageFullDeprecated]] ([10.0.0-10.2.0] [[#SetButtonConfigStorageFullDeprecated|SetButtonConfigStorageFull]])

|-

−

| 1265 || [10.0.0+] [[#SetButtonConfigStorageLeft]]

+

| 1265 || [11.0.0+] [[#SetButtonConfigStorageLeftDeprecated]] ([10.0.0-10.2.0] [[#SetButtonConfigStorageLeftDeprecated|SetButtonConfigStorageLeft]])

|-

−

| 1266 || [10.0.0+] [[#SetButtonConfigStorageRight]]

+

| 1266 || [11.0.0+] [[#SetButtonConfigStorageRightDeprecated]] ([10.0.0-10.2.0] [[#SetButtonConfigStorageRightDeprecated|SetButtonConfigStorageRight]])

|-

| 1267 || [10.0.0+] [[#DeleteButtonConfigStorageEmbedded]]

Line 1,640: Line 1,753:

|-

| 1283 || [10.0.0+] [[#GetHidButtonConfigRight]]

−

|}

+

|-

+

| 1284 || [11.0.0+] [[#GetButtonConfigStorageEmbedded]]

+

|-

+

| 1285 || [11.0.0+] [[#GetButtonConfigStorageFull]]

+

|-

+

| 1286 || [11.0.0+] [[#GetButtonConfigStorageLeft]]

+

|-

+

| 1287 || [11.0.0+] [[#GetButtonConfigStorageRight]]

+

|-

+

| 1288 || [11.0.0+] [[#SetButtonConfigStorageEmbedded]]

+

|-

+

| 1289 || [11.0.0+] [[#SetButtonConfigStorageFull]]

+

|-

+

| 1290 || [11.0.0+] [[#SetButtonConfigStorageLeft]]

+

|-

+

| 1291 || [11.0.0+] [[#SetButtonConfigStorageRight]]

+

|-

+

| 12010 || [11.0.0+] [[#SetButtonConfigLeft]]

+

|}

== SendKeyboardLockKeyEvent ==

Line 1,741: Line 1,872:

== IsButtonConfigSupported ==

Takes an input [[#UniquePadId]], returns an output bool.

+

[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], returns an output bool.

+

== IsButtonConfigEmbeddedSupported ==

+

No input, returns an output bool.

== DeleteButtonConfig ==

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

+

[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], no output.

+

== DeleteButtonConfigEmbedded ==

+

No input/output.

== SetButtonConfigEnabled ==

Takes an input bool, an [[#UniquePadId]], no output.

+

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

+

== SetButtonConfigEmbeddedEnabled ==

+

Takes an input bool, no output.

== IsButtonConfigEnabled ==

Takes an input [[#UniquePadId]], returns an output bool.

+

[11.0.0+] Takes an input [[Bluetooth_Driver_services#Address|Address]], returns an output bool.

+

== IsButtonConfigEmbeddedEnabled ==

+

No input, returns an output bool.

== SetButtonConfigEmbedded ==

−

Takes an input [[#UniquePadId]], a type-0x15 input buffer containing a [[#SystemButtonConfigEmbedded]], no output.

+

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

== SetButtonConfigFull ==

Takes an input [[#UniquePadId]], a type-0x15 input buffer containing a [[#SystemButtonConfigFull]], no output.

+

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

== SetButtonConfigLeft ==

Takes an input [[#UniquePadId]], a type-0x15 input buffer containing a [[#SystemButtonConfigLeft]], no output.

+

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

== SetButtonConfigRight ==

Takes an input [[#UniquePadId]], a type-0x15 input buffer containing a [[#SystemButtonConfigRight]], no output.

+

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

== GetButtonConfigEmbedded ==

−

Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#SystemButtonConfigEmbedded]].

+

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

== GetButtonConfigFull ==

Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#SystemButtonConfigFull]].

+

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

== GetButtonConfigLeft ==

Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#SystemButtonConfigLeft]].

+

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

== GetButtonConfigRight ==

Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#SystemButtonConfigRight]].

+

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

== IsCustomButtonConfigSupported ==

Line 1,801: Line 1,964:

Takes an input s32 entry-index, returns an output bool.

−

[10.1.0+] This will now Abort if the s32 is negative or >=5.

+

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

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

Line 1,820: Line 1,983:

Same as [[#IsButtonConfigStorageEmbeddedEmpty]] except with a different setsys cmd.

−

== ~~GetButtonConfigStorageEmbedded~~ ==

+

== GetButtonConfigStorageEmbeddedDeprecated ==

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

−

[10.1.0+] This will now Abort if the s32 is negative or >=5.

+

[10.1.0-10.2.0] This will now Abort if the s32 is negative or >=5.

+

[11.0.0+] This now calls the same func internally as [[#GetButtonConfigStorageEmbedded]], except the [[#StorageName]] isn't exposed.

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

−

== ~~GetButtonConfigStorageFull~~ ==

+

== GetButtonConfigStorageFullDeprecated ==

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

−

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

+

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

−

== ~~GetButtonConfigStorageLeft~~ ==

+

== GetButtonConfigStorageLeftDeprecated ==

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

−

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

+

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

−

== ~~GetButtonConfigStorageRight~~ ==

+

== GetButtonConfigStorageRightDeprecated ==

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

−

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

+

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

−

== ~~SetButtonConfigStorageEmbedded~~ ==

+

== SetButtonConfigStorageEmbeddedDeprecated ==

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

−

[10.1.0+] This will now Abort if the s32 is negative or >=5.

+

[10.1.0-10.2.0] This will now Abort if the s32 is negative or >=5.

+

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

If the input config matches the [[#IsDefaultButtonConfigEmbedded|default]], this first does:

Line 1,852: Line 2,019:

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

−

== ~~SetButtonConfigStorageFull~~ ==

+

== SetButtonConfigStorageFullDeprecated ==

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

−

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

+

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

−

== ~~SetButtonConfigStorageLeft~~ ==

+

== SetButtonConfigStorageLeftDeprecated ==

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

−

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

+

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

−

== ~~SetButtonConfigStorageRight~~ ==

+

== SetButtonConfigStorageRightDeprecated ==

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

−

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

+

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

== DeleteButtonConfigStorageEmbedded ==

Takes an input s32 entry-index, no output.

−

[10.1.0+] This will now Abort if the s32 is negative or >=5.

+

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

Uses [[Settings_services#GetButtonConfigSettingsEmbedded|GetButtonConfigSettingsEmbedded]] with count=5 (output s32 ignored). The input entry-index is used with this array. Then an error is thrown if [[Settings_services#ButtonConfigSettings|IsFull]] bit0 is clear. Then the data at +0x1C8 size 0x3E0 is cleared, IsFull bit0 is cleared, [[Settings_services#SetButtonConfigSettingsEmbedded|SetButtonConfigSettingsEmbedded]] is used with the updated array, and then returns 0.

Line 1,877: Line 2,044:

Takes an input s32 entry-index, no output.

−

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

+

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

== DeleteButtonConfigStorageLeft ==

Takes an input s32 entry-index, no output.

−

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

+

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

== DeleteButtonConfigStorageRight ==

Takes an input s32 entry-index, no output.

−

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

+

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

== IsUsingCustomButtonConfig ==

Line 1,927: Line 2,094:

== GetHidButtonConfigRight ==

Takes an input [[#UniquePadId]], and a type-0x16 output buffer containing a [[#ButtonConfigRight]].

+

== GetButtonConfigStorageEmbedded ==

+

Takes an input s32, a type-0x16 output buffer containing a [[#ButtonConfigEmbedded]], a type-0x1A output buffer containing a [[#StorageName]].

+

When the input s32 is larger than unsigned value 4, an error is returned.

+

== GetButtonConfigStorageFull ==

+

Takes an input s32, a type-0x16 output buffer containing a [[#ButtonConfigFull]], a type-0x1A output buffer containing a [[#StorageName]].

+

== GetButtonConfigStorageLeft ==

+

Takes an input s32, a type-0x16 output buffer containing a [[#ButtonConfigLeft]], a type-0x1A output buffer containing a [[#StorageName]].

+

== GetButtonConfigStorageRight ==

+

Takes an input s32, a type-0x16 output buffer containing a [[#ButtonConfigRight]], a type-0x1A output buffer containing a [[#StorageName]].

+

== SetButtonConfigStorageEmbedded ==

+

Takes an input s32, a type-0x15 input buffer containing a [[#ButtonConfigEmbedded]], a type-0x19 input buffer containing a [[#StorageName]].

+

When the input s32 is larger than unsigned value 4, this will immediately return (this cmd always returns 0 regardless).

+

== SetButtonConfigStorageFull ==

+

Takes an input s32, a type-0x15 input buffer containing a [[#ButtonConfigFull]], a type-0x19 input buffer containing a [[#StorageName]].

+

== SetButtonConfigStorageLeft ==

+

Takes an input s32, a type-0x15 input buffer containing a [[#ButtonConfigLeft]], a type-0x19 input buffer containing a [[#StorageName]].

+

== SetButtonConfigStorageRight ==

+

Takes an input s32, a type-0x15 input buffer containing a [[#ButtonConfigRight]], a type-0x19 input buffer containing a [[#StorageName]].

== IHidbusSystemServer ==

Line 2,669: Line 2,864:

== GetBusHandle ==

−

Takes an input u32 [[#NpadIdType]], an u64 [[#BusType]], an u64 [[AM_services|AppletResourceUserId]]~~, returns~~ an output u8 bool and a [[#BusHandle]].

+

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

−

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

+

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

Official sw will assert when [[#BusHandle]] InternalIndex is >=0x11 (>=0x13 with [6.0.0+]). This same check is also done for all funcs using [[#BusHandle]] as input.

Line 2,678: Line 2,873:

== IsExternalDeviceConnected ==

−

Takes an input [[#BusHandle]]~~, returns~~ an output u8 bool.

+

Takes an input [[#BusHandle]]. Returns an output bool '''IsAttached'''.

This is not used by sdknso.

== Initialize ==

−

Takes an input [[#BusHandle]], an u64 [[AM_services|AppletResourceUserId]]~~, no~~ output.

+

Takes an input [[#BusHandle]] and an u64 [[AM_services|AppletResourceUserId]]. No output.

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

== Finalize ==

−

Takes an input [[#BusHandle]], an u64 [[AM_services|AppletResourceUserId]]~~, no~~ output.

+

Takes an input [[#BusHandle]] and an u64 [[AM_services|AppletResourceUserId]]. No output.

== EnableExternalDevice ==

−

Takes an input u8 bool, a [[#BusHandle]], an u64, an u64 [[AM_services|AppletResourceUserId]]~~, no~~ output.

+

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

−

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

+

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

−

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

+

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

== GetExternalDeviceId ==

−

Takes an input [[#BusHandle]]~~, returns~~ an output u32 ~~ExternalDeviceId~~.

+

Takes an input [[#BusHandle]]. Returns an output u32 '''DeviceId'''.

== SendCommandAsync ==

−

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

+

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.

+

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

−

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

+

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

== SetEventForSendCommandAsycResult ==

−

Takes an input [[#BusHandle]]~~, returns~~ an output Event handle with EventClearMode=0.

+

Takes an input [[#BusHandle]]. Returns an output Event handle '''AttachmentDataReceiveEventHandle''' with EventClearMode=0.

Official sw with SendAndReceive clears this event (6.x+ sdknso), uses [[#SendCommandAsync]], waits on + clears this event, then uses [[#GetSendCommandAsynceResult]].

== GetSharedMemoryHandle ==

−

No input~~, returns~~ an output SharedMemory handle.

+

No input. Returns an output SharedMemory handle.

The SharedMemory is mapped with size 0x1000 and permissions=R--.

Line 2,746: Line 2,941:

== EnableJoyPollingReceiveMode ==

−

Takes a type-0x21 input buffer, a TransferMemory handle, an u32 ~~tmem_size~~, an u32 [[#JoyPollingMode]], a [[#BusHandle]]~~, no~~ output.

+

Takes a type-0x21 input buffer, a TransferMemory handle, an u32 '''TransferMemorySize''', an u32 [[#JoyPollingMode]] and a [[#BusHandle]]. No output.

The TransferMemory is created with an user-specified output buffer, with permissions=R--.

Line 2,815: Line 3,010:

== DisableJoyPollingReceiveMode ==

−

Takes an input [[#BusHandle]]~~, no~~ output.

+

Takes an input [[#BusHandle]]. No output.

== SetStatusManagerType ==

−

Takes an input u32~~, no~~ output.

+

Takes an input u32 [[#StatusManagerType]]. No output.

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

Line 5,912: Line 6,107:

This is "nn::hid::KeyboardKeySet". This is a BitFlagSet object for [[#KeyboardKey]].

−

= ~~KeyboardLockKeyEventSet~~ =

+

= KeyboardKey =

−

This is "nn::hid::~~system::KeyboardLockKeyEventSet~~". This is a ~~BitFlagSet object for [[#KeyboardLockKeyEvent]]~~.

+

This is "nn::hid::KeyboardKey". This is a 256-bit flag.

−

~~= KeyboardLockKeyEvent =~~

+

{| class="wikitable" border="1"

−

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

−

{| class="wikitable" border="1"

|-

! Bit

! Description

−

|-

−

~~| 0~~

−

~~| NumLockOn~~

−

|-

−

~~| 1~~

−

~~| NumLockOff~~

−

|-

−

~~| 2~~

−

~~| NumLockToggle~~

−

|-

−

~~| 3~~

−

~~| CapsLockOn~~

|-

| 4

−

| ~~CapsLockOff~~

+

| A

|-

| 5

−

| ~~CapsLockToggle~~

+

| B

|-

| 6

−

| ~~ScrollLockOn~~

+

| C

|-

| 7

−

| ~~ScrollLockOff~~

+

| D

|-

| 8

−

| ~~ScrollLockToggle~~

+

| E

−

|}

−

~~= BasicXpadButtonSet =~~

−

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

−

~~= HomeButtonSet =~~

−

~~This is "nn::hid::system::HomeButtonSet". This is a BitFlagSet object for [[#HomeButton]].~~

−

~~= SleepButtonSet =~~

−

~~This is "nn::hid::system::SleepButtonSet". This is a BitFlagSet object for [[#SleepButton]].~~

−

~~= CaptureButtonSet =~~

−

~~This is "nn::hid::system::CaptureButtonSet". This is a BitFlagSet object for [[#CaptureButton]].~~

−

~~= NpadButtonSet =~~

−

~~This is "nn::hid::NpadButtonSet". This is a BitFlagSet object for [[#NpadButton]].~~

−

~~= NpadButton =~~

−

~~This is "nn::hid::NpadButton". This is a 64-bit flag.~~

−

~~{| class="wikitable" border="1"~~

|-

−

~~! Bit~~

+

| 9

−

~~! Description~~

+

| F

|-

−

| 0

+

| 10

−

| A

+

| G

|-

−

| 1

+

| 11

−

| B

+

| H

|-

−

| 2

+

| 12

−

| X

+

| I

|-

−

~~| 3~~

+

| 13

−

~~| Y~~

+

| J

−

|-

−

~~| 4~~

−

~~| StickL~~

−

|-

−

~~| 5~~

−

~~| StickR~~

−

|-

−

~~| 6~~

−

~~| L~~

−

|-

−

~~| 7~~

−

~~| R~~

−

|-

−

~~| 8~~

−

~~| ZL~~

−

|-

−

~~| 9~~

−

~~| ZR~~

−

|-

−

~~| 10~~

−

~~| Plus~~

−

|-

−

~~| 11~~

−

~~| Minus~~

−

|-

−

~~| 12~~

−

~~| Left~~

−

|-

−

| 13

−

| Up

|-

| 14

−

| ~~Right~~

+

| K

|-

| 15

−

| ~~Down~~

+

| L

|-

| 16

−

| ~~StickLLeft~~

+

| M

|-

| 17

−

| ~~StickLUp~~

+

| N

|-

| 18

−

| ~~StickLRight~~

+

| O

|-

| 19

−

| ~~StickLDown~~

+

| P

|-

| 20

−

| ~~StickRLeft~~

+

| Q

|-

| 21

−

| ~~StickRUp~~

+

| R

|-

| 22

−

| ~~StickRRight~~

+

| S

|-

| 23

−

| ~~StickRDown~~

+

| T

|-

| 24

−

| ~~LeftSL~~

+

| U

|-

| 25

−

| ~~LeftSR~~

+

| V

|-

| 26

−

| ~~RightSL~~

+

| W

|-

| 27

−

| ~~RightSR~~

+

| X

|-

| 28

−

| ~~Palma~~

+

| Y

|-

| 29

−

|

+

| Z

|-

| 30

−

| ~~HandheldLeftB (Left B button on NES controllers in Handheld mode)~~

+

| D1

−

|}

+

|-

−

+

| 31

−

~~= AnalogStickCalibrationFlagsSet =~~

+

| D2

−

~~This is "nn::hid::detail::AnalogStickCalibrationFlagsSet". This is a BitFlagSet object for [[#AnalogStickCalibrationFlags]].~~

+

|-

−

+

| 32

−

~~= SixAxisSensorUserCalibrationFlagsSet =~~

+

| D3

−

~~This is "nn::hid::detail::SixAxisSensorUserCalibrationFlagsSet". This is a BitFlagSet object for [[#SixAxisSensorUserCalibrationFlags]].~~

+

|-

−

+

| 33

−

~~= NpadStyleSet =~~

+

| D4

−

~~This is "nn::hid::NpadStyleSet". This is a BitFlagSet object for [[#NpadStyleTag]].~~

+

|-

−

+

| 34

−

~~= NpadStyleTag =~~

+

| D5

−

~~This is "nn::hid::NpadStyleTag".~~

−

{| ~~class="wikitable" border="1"~~

−

~~! Bits~~

−

~~! Description~~

−

~~! Notes~~

|-

−

| 0

+

| 35

−

| ~~NpadStyleFullKey~~

+

| D6

−

~~| Pro Controller~~

|-

−

| 1

+

| 36

−

| ~~NpadStyleHandheld~~

+

| D7

−

~~| Joy-Con controller in handheld mode~~

|-

−

| 2

+

| 37

−

| ~~NpadStyleJoyDual~~

+

| D8

−

~~| Joy-Con controller in dual mode~~

|-

−

| 3

+

| 38

−

| ~~NpadStyleJoyLeft~~

+

| D9

−

~~| Joy-Con left controller in single mode~~

|-

−

| 4

+

| 39

−

| ~~NpadStyleJoyRight~~

+

| D0

−

~~| Joy-Con right controller in single mode~~

|-

−

| 5

+

| 40

−

| ~~NpadStyleGc~~

+

| Return

−

~~| GameCube controller~~

|-

−

| 6

+

| 41

−

| ~~NpadStylePalma~~

+

| Escape

−

~~| Poké Ball Plus controller~~

|-

−

| 7

+

| 42

−

| ~~NpadStyleLark~~

+

| Backspace

−

~~| NES/Famicom controller~~

|-

−

| 8

+

| 43

−

| ~~NpadStyleHandheldLark~~

+

| Tab

−

~~| NES/Famicom controller in handheld mode~~

|-

−

| 9

+

| 44

−

| ~~NpadStyleLucia~~

+

| Space

−

~~| SNES controller~~

|-

−

| ~~10-28~~

+

| 45

−

~~| Reserved~~

+

| Minus

−

|

|-

−

| 29

+

| 46

−

| ~~NpadStyleSystemExt~~

+

| Plus

−

~~| Generic external controller~~

|-

−

| 30

+

| 47

−

| ~~NpadStyleSystem~~

+

| OpenBracket

−

~~| Generic controller~~

|-

−

| 31

+

| 48

−

| ~~Reserved~~

+

| CloseBracket

−

|

+

|-

−

|}

+

| 49

−

+

| Pipe

−

~~= NpadDeviceTypeSet =~~

+

|-

−

~~This is "nn::hid::system::NpadDeviceType". This is a BitFlagSet object for [[#NpadDeviceType]].~~

+

| 50

−

+

| Tilde

−

~~= NpadSystemPropertiesSet =~~

−

~~This is "nn::hid::detail::NpadSystemPropertiesSet". This is a BitFlagSet object for [[#NpadSystemProperties]].~~

−

~~= NpadSystemProperties =~~

−

~~This is "nn::hid::NpadSystemProperties". This is a 64~~-~~bit flag.~~

−

{| ~~class="wikitable" border="1"~~

|-

−

~~! Bit~~

+

| 51

−

~~! Description~~

+

| Semicolon

|-

−

| 0

+

| 52

−

| ~~IsChargingJoyDual~~

+

| Quote

|-

−

| 1

+

| 53

−

| ~~IsChargingJoyLeft~~

+

| Backquote

|-

−

| 2

+

| 54

−

| ~~IsChargingJoyRight~~

+

| Comma

|-

−

| 3

+

| 55

−

| ~~IsPoweredJoyDual~~

+

| Period

|-

−

| 4

+

| 56

−

| ~~IsPoweredJoyLeft~~

+

| Slash

|-

−

| 5

+

| 57

−

| ~~IsPoweredJoyRight~~

+

| CapsLock

|-

−

| 9

+

| 58

−

| ~~IsUnsuportedButtonPressedOnNpadSystem~~

+

| F1

|-

−

| 10

+

| 59

−

| ~~IsUnsuportedButtonPressedOnNpadSystemExt~~

+

| F2

|-

−

| 11

+

| 60

−

| ~~IsAbxyButtonOriented~~

+

| F3

|-

−

| 12

+

| 61

−

| ~~IsSlSrButtonOriented~~

+

| F4

|-

−

| 13

+

| 62

−

| ~~[4.0.0+] IsPlusAvailable~~

+

| F5

|-

−

| 14

+

| 63

−

| ~~[4.0.0+] IsMinusAvailable~~

+

| F6

|-

−

| 15

+

| 64

−

| ~~[8.0.0+] IsDirectionalButtonsAvailable~~

+

| F7

−

|}

−

~~= NpadSystemButtonPropertiesSet =~~

−

~~This is "nn::hid::detail::NpadSystemButtonPropertiesSet". This is a BitFlagSet object for [[#NpadSystemButtonProperties]].~~

−

~~= NpadSystemButtonProperties =~~

−

~~This is "nn::hid::NpadSystemButtonProperties". This is a 32-bit flag.~~

−

~~{| class="wikitable" border="1"~~

|-

−

~~! Bit~~

+

| 65

−

~~! Description~~

+

| F8

|-

−

| 0

+

| 66

−

| ~~IsUnintendedHomeButtonInputProtectionEnabled~~

+

| F9

−

|}

+

|-

−

+

| 67

−

~~= AppletFooterUiAttributesSet =~~

+

| F10

−

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

+

|-

−

+

| 68

−

~~= UniquePadType =~~

+

| F11

−

~~This is "nn::hid::system::UniquePadType".~~

−

{| ~~class="wikitable" border="1"~~

−

~~! Value~~

−

~~! Description~~

|-

−

| 0 |~~| Embedded~~

+

| 69

+

| F12

|-

−

| 1 |~~| FullKeyController~~

+

| 70

+

| PrintScreen

|-

−

| 2 |~~| RightController~~

+

| 71

+

| ScrollLock

|-

−

| 3 |~~| LeftController~~

+

| 72

+

| Pause

|-

−

| ~~4 || DebugPadController~~

+

| 73

−

|}

+

| Insert

−

~~= UniquePadInterface =~~

−

~~This is "nn::hid::system::UniquePadInterface".~~

−

{| ~~class="wikitable" border="1"~~

−

~~! Value~~

−

~~! Description~~

|-

−

| 0 |~~| Embedded~~

+

| 74

+

| Home

|-

−

| 1 |~~| Rail~~

+

| 75

+

| PageUp

|-

−

| 2 |~~| Bluetooth~~

+

| 76

+

| Delete

|-

−

| ~~3 || Usb~~

+

| 77

−

|}

+

| End

−

~~= UniquePadSerialNumber =~~

−

~~This is "nn::hid::system::UniquePadSerialNumber". This is a 0x10 byte value.~~

−

~~= UniquePadId =~~

−

~~This is "nn::hid::system::UniquePadId". This is a 8 byte value.~~

−

~~= AnalogStickManualCalibrationStage =~~

−

~~This is "nn::hid::system::AnalogStickManualCalibrationStage".~~

−

{| ~~class="wikitable" border="1"~~

−

~~! Value~~

−

~~! Description~~

|-

−

| 0 |~~| ReleaseFromRight~~

+

| 78

+

| PageDown

|-

−

| 1 |~~| ReleaseFromBottom~~

+

| 79

+

| RightArrow

|-

−

| 2 |~~| ReleaseFromLeft~~

+

| 80

+

| LeftArrow

|-

−

| 3 |~~| ReleaseFromTop~~

+

| 81

+

| DownArrow

|-

−

| 4 |~~| Rotate~~

+

| 82

+

| UpArrow

|-

−

| 5 |~~| Update~~

+

| 83

+

| NumLock

|-

−

| 6 |~~| Completed~~

+

| 84

+

| NumPadDivide

|-

−

| 7 |~~| Clear~~

+

| 85

+

| NumPadMultiply

|-

−

| 8 || ~~ClearCompleted~~

+

| 86

−

|}

+

| NumPadSubtract

−

+

|-

−

~~= SixAxisSensorUserCalibrationStage =~~

+

| 87

−

~~This is "nn::hid::system::SixAxisSensorUserCalibrationStage".~~

+

| NumPadAdd

−

+

|-

−

{| ~~class="wikitable" border="1"~~

+

| 88

−

~~! Value~~

+

| NumPadEnter

−

~~! Description~~

+

|-

+

| 89

+

| NumPad1

|-

−

| 0 |~~| Measuring~~

+

| 90

+

| NumPad2

|-

−

| 1 |~~| Update~~

+

| 91

+

| NumPad3

|-

−

| ~~2 || Completed~~

+

| 92

−

|}

+

| NumPad4

−

~~= NpadJoyHoldType =~~

−

~~This is "nn::hid::NpadJoyHoldType".~~

−

{| ~~class="wikitable" border="1"~~

−

~~! Value~~

−

~~! Description~~

|-

−

| 0 |~~| Vertical~~

+

| 93

+

| NumPad5

|-

−

| ~~1 || Horizontal~~

+

| 94

−

|}

+

| NumPad6

−

~~= NpadJoyDeviceType =~~

−

~~This is "nn::hid::NpadJoyDeviceType".~~

−

{| ~~class="wikitable" border="1"~~

−

~~! Value~~

−

~~! Description~~

|-

−

| 0 |~~| Left~~

+

| 95

+

| NumPad7

|-

−

| ~~1 || Right~~

+

| 96

−

|}

+

| NumPad8

−

~~= NpadHandheldActivationMode =~~

−

~~This is "nn::hid::NpadHandheldActivationMode".~~

−

~~This controls how many joycons must be attached for handheld mode to be triggered (Dual = 2, Single = 1, None = 0).~~

−

{| ~~class="wikitable" border="1"~~

−

~~! Value~~

−

~~! Description~~

|-

−

| 0 |~~| Dual~~

+

| 97

+

| NumPad9

|-

−

| 1 |~~| Single~~

+

| 98

+

| NumPad0

|-

−

| ~~2 || None~~

+

| 99

−

|}

+

| NumPadDot

−

~~= NpadJoyAssignmentMode =~~

−

~~This is "nn::hid::NpadJoyAssignmentMode".~~

−

{| ~~class="wikitable" border="1"~~

−

~~! Value~~

−

~~! Description~~

|-

−

| 0 |~~| Dual~~

+

| 100

+

| Backslash

|-

−

| ~~1 || Single~~

+

| 101

−

|}

+

| Application

−

~~= NpadCommunicationMode =~~

−

~~This is "nn::hid::NpadCommunicationMode".~~

−

{| ~~class="wikitable" border="1"~~

−

~~! Value~~

−

~~! Description~~

|-

−

| 0 |~~| 5ms~~

+

| 102

+

| Power

|-

−

| 1 |~~| 10ms~~

+

| 103

+

| NumPadEquals

|-

−

| 2 |~~| 15ms~~

+

| 104

+

| F13

|-

−

| ~~3 || Default~~

+

| 105

−

|}

+

| F14

−

~~= AppletDetailedUiType =~~

−

~~This is "nn::hid::system::AppletDetailedUiType".~~

−

{| ~~class="wikitable" border="1"~~

−

~~! Value~~

−

~~! Description~~

|-

−

| ~~0x00000000~~ |~~| None~~

+

| 106

+

| F15

|-

−

| ~~0x01000000 || HandheldNone~~

+

| 107

−

|-

+

| F16

−

| ~~0x02000000 || HandheldJoyConLeftOnly~~

|-

−

| ~~0x02000001~~ |~~| HandheldLarkHvc1Only~~

+

| 108

+

| F17

|-

−

| ~~0x02000002~~ |~~| HandheldLarkNesLeftOnly~~

+

| 109

+

| F18

|-

−

| ~~0x03000000~~ |~~| HandheldJoyConRightOnly~~

+

| 110

+

| F19

|-

−

| ~~0x03000001~~ |~~| HandheldLarkHvc2Only~~

+

| 111

+

| F20

|-

−

| ~~0x03000002~~ |~~| HandheldLarkNesRightOnly~~

+

| 112

+

| F21

|-

−

| ~~0x04000000~~ |~~| HandheldJoyConLeftJoyConRight~~

+

| 113

+

| F22

|-

−

| ~~0x04000001~~ |~~| HandheldJoyConLeftLarkHvc2~~

+

| 114

+

| F23

|-

−

| ~~0x04000002~~ |~~| HandheldJoyConLeftLarkNesRight~~

+

| 115

+

| F24

|-

−

| ~~0x04000003~~ |~~| HandheldLarkHvc1JoyConRight~~

+

| 133

+

| NumPadComma

|-

−

| ~~0x04000004~~ |~~| HandheldLarkHvc1LarkHvc2~~

+

| 135

+

| Ro

|-

−

| ~~0x04000005~~ |~~| HandheldLarkHvc1LarkNesRight~~

+

| 136

+

| KatakanaHiragana

|-

−

| ~~0x04000006~~ |~~| HandheldLarkNesLeftJoyConRight~~

+

| 137

+

| Yen

|-

−

| ~~0x04000007~~ |~~| HandheldLarkNesLeftLarkHvc2~~

+

| 138

+

| Henkan

|-

−

| ~~0x04000008~~ |~~| HandheldLarkNesLeftLarkNesRight~~

+

| 139

+

| Muhenkan

|-

−

| ~~0x05000000~~ |~~| JoyDual~~

+

| 140

+

| NumPadCommaPc98

|-

−

| ~~0x06000000~~ |~~| JoyDualLeftOnly~~

+

| 144

+

| HangulEnglish

|-

−

| ~~0x07000000~~ |~~| JoyDualRightOnly~~

+

| 145

+

| Hanja

|-

−

| ~~0x08000000~~ |~~| JoyLeftHorizontal~~

+

| 146

+

| Katakana

|-

−

| ~~0x09000000~~ |~~| JoyLeftVertical~~

+

| 147

+

| Hiragana

|-

−

| ~~0x0A000000~~ |~~| JoyRightHorizontal~~

+

| 148

+

| ZenkakuHankaku

|-

−

| ~~0x0B000000~~ |~~| JoyRightVertical~~

+

| 224

+

| LeftControl

|-

−

| ~~0x0C000000~~ |~~| SwitchProController~~

+

| 225

+

| LeftShift

|-

−

| ~~0x0D000000~~ |~~| CompatibleProController~~

+

| 226

+

| LeftAlt

|-

−

| ~~0x0E000000~~ |~~| CompatibleJoyCon~~

+

| 227

+

| LeftGui

|-

−

| ~~0x0F000000~~ |~~| LarkHvc1~~

+

| 228

+

| RightControl

|-

−

| ~~0x10000000~~ |~~| LarkHvc2~~

+

| 229

+

| RightShift

|-

−

| ~~0x11000000~~ |~~| LarkNesLeft~~

+

| 230

+

| RightAlt

|-

−

| ~~0x12000000 || LarkNesRight~~

+

| 231

−

|-

+

| RightGui

−

| ~~0x13000000 || LuciaU~~

+

|}

−

|-

+

−

~~| 0x13000001 || LuciaJ~~

+

= KeyboardLockKeyEventSet =

−

|-

+

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

−

~~| 0x13000002 || LuciaE~~

−

|-

−

~~| 0x14000000 || Verification~~

−

|-

−

~~| 0xFFFFFFFF || Unknown~~

−

|}

−

= ~~AppletFooterUiType~~ =

+

= KeyboardLockKeyEvent =

−

This is "nn::hid::system::~~AppletFooterUiType~~".

+

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

{| class="wikitable" border="1"

−

~~! Value~~

−

~~! Description~~

|-

−

~~| 0 || None~~

+

! Bit

+

! Description

|-

−

| 1 |~~| HandheldNone~~

+

| 0

+

| NumLockOn

|-

−

| 2 |~~| HandheldJoyConLeftOnly~~

+

| 1

+

| NumLockOff

|-

−

| 3 |~~| HandheldJoyConRightOnly~~

+

| 2

+

| NumLockToggle

|-

−

| 4 |~~| HandheldJoyConLeftJoyConRight~~

+

| 3

+

| CapsLockOn

|-

−

| 5 |~~| JoyDual~~

+

| 4

+

| CapsLockOff

|-

−

| 6 |~~| JoyDualLeftOnly~~

+

| 5

+

| CapsLockToggle

|-

−

| 7 |~~| JoyDualRightOnly~~

+

| 6

+

| ScrollLockOn

|-

−

| 8 |~~| JoyLeftHorizontal~~

+

| 7

+

| ScrollLockOff

|-

−

| 9 || ~~JoyLeftVertical~~

+

| 8

−

|-

+

| ScrollLockToggle

−

~~| 10 || JoyRightHorizontal~~

+

|}

−

|-

+

−

~~| 11 || JoyRightVertical~~

+

= BasicXpadButtonSet =

−

|-

+

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

−

| ~~12 || SwitchProController~~

+

= HomeButtonSet =

+

This is "nn::hid::system::HomeButtonSet". This is a BitFlagSet object for [[#HomeButton]].

+

= SleepButtonSet =

+

This is "nn::hid::system::SleepButtonSet". This is a BitFlagSet object for [[#SleepButton]].

+

= CaptureButtonSet =

+

This is "nn::hid::system::CaptureButtonSet". This is a BitFlagSet object for [[#CaptureButton]].

+

= NpadButtonSet =

+

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

+

= NpadButton =

+

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

+

{| class="wikitable" border="1"

|-

−

~~| 13 || CompatibleProController~~

+

! Bit

+

! Description

|-

−

| 14 |~~| CompatibleJoyCon~~

+

| 0

+

| A

|-

−

| 15 |~~| LarkHvc1~~

+

| 1

+

| B

|-

−

| 16 |~~| LarkHvc2~~

+

| 2

+

| X

|-

−

| 17 |~~| LarkNesLeft~~

+

| 3

+

| Y

|-

−

| 18 |~~| LarkNesRight~~

+

| 4

+

| StickL

|-

−

| 19 |~~| Lucia~~

+

| 5

+

| StickR

|-

−

| ~~20 || Verification~~

+

| 6

−

|}

+

| L

−

~~= NpadIdType =~~

−

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

−

~~{| class="wikitable" border="1"~~

−

~~! Value~~

−

~~! Description~~

|-

−

| ~~0x0~~ |~~| No1~~

+

| 7

+

| R

|-

−

| ~~0x1~~ |~~| No2~~

+

| 8

+

| ZL

|-

−

| ~~0x2~~ |~~| No3~~

+

| 9

+

| ZR

|-

−

| ~~0x3~~ |~~| No4~~

+

| 10

+

| Plus

|-

−

| ~~0x4~~ |~~| No5~~

+

| 11

+

| Minus

|-

−

| ~~0x5~~ |~~| No6~~

+

| 12

+

| Left

|-

−

| ~~0x6~~ |~~| No7~~

+

| 13

+

| Up

|-

−

| ~~0x7~~ |~~| No8~~

+

| 14

+

| Right

|-

−

| ~~0x10~~ |~~| Other~~

+

| 15

+

| Down

|-

−

| ~~0x20 || Handheld~~

+

| 16

−

|}

+

| StickLLeft

−

~~= NpadInterfaceType =~~

−

~~This is "nn::hid::NpadInterfaceType".~~

−

{| ~~class="wikitable" border="1"~~

−

~~! Value~~

−

~~! Description~~

|-

−

| 1 |~~| Bluetooth~~

+

| 17

+

| StickLUp

|-

−

| 2 |~~| Rail~~

+

| 18

+

| StickLRight

|-

−

| 3 |~~| USB~~

+

| 19

+

| StickLDown

|-

−

| ~~4 || Unknown~~

+

| 20

−

|}

+

| StickRLeft

−

~~= NpadLarkType =~~

−

~~This is "nn::hid::NpadLarkType".~~

−

{| ~~class="wikitable" border="1"~~

−

~~! Value~~

−

~~! Description~~

|-

−

| 0 |~~| Invalid~~

+

| 21

+

| StickRUp

|-

−

| 1 |~~| H1~~

+

| 22

+

| StickRRight

|-

−

| 2 |~~| H2~~

+

| 23

+

| StickRDown

|-

−

| 3 || NL

+

| 24

+

| LeftSL

+

|-

+

| 25

+

| LeftSR

|-

−

| ~~4 || NR~~

+

| 26

−

|}

+

| RightSL

−

~~= NpadLuciaType =~~

−

~~This is "nn::hid::NpadLuciaType".~~

−

{| ~~class="wikitable" border="1"~~

−

~~! Value~~

−

~~! Description~~

|-

−

| 0 |~~| Invalid~~

+

| 27

+

| RightSR

|-

−

| 1 |~~| J~~

+

| 28

+

| Palma

|-

−

| 2 |~~| E~~

+

| 29

+

|

|-

−

| 3 |~~| U~~

+

| 30

+

| HandheldLeftB (Left B button on NES controllers in Handheld mode)

|}

−

= ~~GestureDirection~~ =

+

= AnalogStickCalibrationFlagsSet =

−

This is "nn::hid::~~GestureDirection~~".

+

This is "nn::hid::detail::AnalogStickCalibrationFlagsSet". This is a BitFlagSet object for [[#AnalogStickCalibrationFlags]].

+

= SixAxisSensorUserCalibrationFlagsSet =

+

This is "nn::hid::detail::SixAxisSensorUserCalibrationFlagsSet". This is a BitFlagSet object for [[#SixAxisSensorUserCalibrationFlags]].

+

= NpadStyleSet =

+

This is "nn::hid::NpadStyleSet". This is a BitFlagSet object for [[#NpadStyleTag]].

+

= NpadStyleTag =

+

This is "nn::hid::NpadStyleTag".

{| class="wikitable" border="1"

−

! ~~Value~~

+

! Bits

! Description

+

! Notes

|-

−

| 0 || ~~None~~

+

| 0

+

| NpadStyleFullKey

+

| Pro Controller

|-

−

| 1 || ~~Left~~

+

| 1

+

| NpadStyleHandheld

+

| Joy-Con controller in handheld mode

|-

−

| 2 || Up

+

| 2

+

| NpadStyleJoyDual

+

| Joy-Con controller in dual mode

|-

−

| 3 || ~~Right~~

+

| 3

+

| NpadStyleJoyLeft

+

| Joy-Con left controller in single mode

|-

−

| 4 ~~|| Down~~

+

| 4

−

|}

+

| NpadStyleJoyRight

−

+

| Joy-Con right controller in single mode

−

~~= GestureType =~~

−

~~This is "nn::hid::GestureType".~~

−

{| ~~class="wikitable" border="1"~~

−

~~! Value~~

−

~~! Description~~

|-

−

| 0 || ~~Idle~~

+

| 5

+

| NpadStyleGc

+

| GameCube controller

|-

−

| 1 || ~~Complete~~

+

| 6

+

| NpadStylePalma

+

| Poké Ball Plus controller

|-

−

| 2 || ~~Cancel~~

+

| 7

+

| NpadStyleLark

+

| NES/Famicom controller

|-

−

| 3 || ~~Touch~~

+

| 8

+

| NpadStyleHandheldLark

+

| NES/Famicom controller in handheld mode

|-

−

| 4 || ~~Press~~

+

| 9

+

| NpadStyleLucia

+

| SNES controller

|-

−

| 5 || ~~Tap~~

+

| 10-28

+

| Reserved

+

|

|-

−

| 6 || ~~Pan~~

+

| 29

+

| NpadStyleSystemExt

+

| Generic external controller

|-

−

| 7 || ~~Swipe~~

+

| 30

+

| NpadStyleSystem

+

| Generic controller

|-

−

| ~~8 || Pinch~~

+

| 31

−

|-

+

| Reserved

−

| ~~9 || Rotate~~

+

|

|}

−

= ~~DeviceHandle~~ =

+

= NpadDeviceTypeSet =

−

This is "nn::~~xcd~~::~~DeviceHandle~~". This is a ~~8 byte value~~.

+

This is "nn::hid::system::NpadDeviceType". This is a BitFlagSet object for [[#NpadDeviceType]].

−

= ~~DeviceType~~ =

+

= NpadSystemPropertiesSet =

−

This is "nn::hid::~~system~~::~~DeviceType~~".

+

This is "nn::hid::detail::NpadSystemPropertiesSet". This is a BitFlagSet object for [[#NpadSystemProperties]].

+

= NpadSystemProperties =

+

This is "nn::hid::NpadSystemProperties". This is a 64-bit flag.

{| class="wikitable" border="1"

−

! ~~Bits~~

+

|-

−

! Description

+

! Bit

+

! Description

|-

| 0

−

| ~~FullKey~~

+

| IsChargingJoyDual

|-

| 1

−

| ~~DebugPad~~

+

| IsChargingJoyLeft

|-

| 2

−

| ~~HandheldLeft~~

+

| IsChargingJoyRight

|-

| 3

−

| ~~HandheldRight~~

+

| IsPoweredJoyDual

|-

| 4

−

| ~~JoyLeft~~

+

| IsPoweredJoyLeft

|-

| 5

−

| ~~JoyRight~~

+

| IsPoweredJoyRight

−

|-

−

~~| 6~~

−

~~| Palma~~

−

|-

−

~~| 7~~

−

~~| LarkHvcLeft~~

−

|-

−

~~| 8~~

−

~~| LarkHvcRight~~

|-

| 9

−

| ~~LarkNesLeft~~

+

| IsUnsuportedButtonPressedOnNpadSystem

|-

| 10

−

| ~~LarkNesRight~~

+

| IsUnsuportedButtonPressedOnNpadSystemExt

|-

| 11

−

| ~~HandheldLarkHvcLeft~~

+

| IsAbxyButtonOriented

|-

| 12

−

| ~~HandheldLarkHvcRight~~

+

| IsSlSrButtonOriented

|-

| 13

−

| ~~HandheldLarkNesLeft~~

+

| [4.0.0+] IsPlusAvailable

|-

| 14

−

| ~~HandheldLarkNesRight~~

+

| [4.0.0+] IsMinusAvailable

|-

| 15

−

| ~~Lucia~~

+

| [8.0.0+] IsDirectionalButtonsAvailable

−

|-

−

~~| 16-30~~

−

~~| Reserved~~

−

|-

−

~~| 31~~

−

~~| System~~

|}

−

= ~~DeviceTypeInternal~~ =

+

= NpadSystemButtonPropertiesSet =

−

This is "nn::hid::detail::~~DeviceTypeInternal~~".

+

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

+

= NpadSystemButtonProperties =

+

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

{| class="wikitable" border="1"

−

~~! Bits~~

−

~~! Description~~

|-

−

~~| 0-7~~

+

! Bit

−

~~| BIT(N*4+0) = Pro Controller, BIT(N*4+1) = Joy-Con Left, BIT(N*4+2) = Joy-Con Right, BIT(N*4+3) = invalid. Where N is 0-1.~~

+

! Description

|-

−

| ~~8-10~~

+

| 0

−

| ~~Pro Controller~~

+

| IsUnintendedHomeButtonInputProtectionEnabled

+

|}

+

= AppletFooterUiAttributesSet =

+

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

+

= UniquePadType =

+

This is "nn::hid::system::UniquePadType".

+

{| class="wikitable" border="1"

+

! Value

+

! Description

|-

−

| 11

+

| 0 || Embedded

−

| ~~Famicom left controller~~

|-

−

| 12

+

| 1 || FullKeyController

−

| ~~Famicom right controller (with microphone)~~

|-

−

| 13

+

| 2 || RightController

−

| ~~NES left controller~~

|-

−

| 14

+

| 3 || LeftController

−

| ~~NES right controller~~

|-

−

| ~~15-16~~

+

| 4 || DebugPadController

−

| ~~Invalid~~

−

|-

−

~~| 17~~

−

~~| Generic external controller~~

−

|-

−

~~| 18-20~~

−

~~| Invalid~~

−

|-

−

~~| 21-23~~

−

~~| Generic controller~~

|}

−

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

+

= UniquePadInterface =

+

This is "nn::hid::system::UniquePadInterface".

{| class="wikitable" border="1"

! Value

−

~~! [[#DeviceType|DeviceType]]~~

−

~~! [[#UniquePadType|UniquePadType]]~~

! Description

|-

−

| 1 || ~~JoyRight, HandheldRight || JoyRight || Joy-Con right controller~~

+

| 0 || Embedded

|-

−

| 2 || ~~JoyLeft, HandheldLeft || JoyLeft || Joy-Con left controller~~

+

| 1 || Rail

|-

−

| 3 || ~~FullKey || FullKey || Pro Controller~~

+

| 2 || Bluetooth

|-

−

| 4 || ~~JoyLeft~~ || ~~JoyLeft || Reserved~~

+

| 3 || Usb

+

|}

+

= UniquePadSerialNumber =

+

This is "nn::hid::system::UniquePadSerialNumber". This is a 0x10 byte value.

+

= UniquePadId =

+

This is "nn::hid::system::UniquePadId". This is a 8 byte value.

+

= AnalogStickManualCalibrationStage =

+

This is "nn::hid::system::AnalogStickManualCalibrationStage".

+

{| class="wikitable" border="1"

+

! Value

+

! Description

|-

−

| 5 || ~~JoyRight || JoyRight || Reserved~~

+

| 0 || ReleaseFromRight

|-

−

| 6 || ~~FullKey || FullKey || Reserved~~

+

| 1 || ReleaseFromBottom

|-

−

| 7 || ~~LarkHvcLeft, HandheldLarkHvcLeft || JoyLeft || Famicom left controller~~

+

| 2 || ReleaseFromLeft

|-

−

| 8 || ~~LarkHvcRight, HandheldLarkHvcRight || JoyRight || Famicom right controller (with microphone)~~

+

| 3 || ReleaseFromTop

|-

−

| 9 || ~~LarkNesLeft, HandheldLarkNesLeft || JoyLeft || NES left controller~~

+

| 4 || Rotate

|-

−

| 10 || ~~LarkNesRight, HandheldLarkNesRight || JoyRight || NES right controller~~

+

| 5 || Update

|-

−

| 11 || ~~Lucia || FullKey || SNES controller~~

+

| 6 || Completed

|-

−

| 12 || ~~Palma || Other || Poké Ball Plus controller~~

+

| 7 || Clear

|-

−

| 13 || ~~FullKey || FullKey || Gc controller~~

+

| 8 || ClearCompleted

−

|-

−

~~| 14 || HandheldLeft || JoyLeft || Reserved~~

−

|-

−

~~| 15 || FullKey || FullKey || Reserved~~

−

|-

−

~~| 16 || FullKey || FullKey || Reserved~~

−

|-

−

~~| 17 || DebugPad || DebugPad || Debug controller~~

−

|-

−

~~| 18 || HandheldRight || JoyRight || Reserved~~

−

|-

−

~~| 19 || System || Other || Unknown (has [[#NpadStyleTag|NpadFullKey]] style tag)~~

−

|-

−

~~| 20 || System || Other || Unknown (has [[#NpadStyleTag|NpadJoyDual]] style tag)~~

−

|-

−

~~| 21 || System || Other || Unknown (has [[#NpadStyleTag|NpadJoyDual]] style tag)~~

|}

−

= ~~NpadPowerInfo~~ =

+

= SixAxisSensorUserCalibrationStage =

−

This is "nn::hid::system::~~NpadPowerInfo~~".

+

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

{| class="wikitable" border="1"

+

! Value

+

! Description

|-

−

~~! Offset~~

+

| 0 || Measuring

−

~~! Size~~

−

~~! Description~~

|-

−

| ~~0x0~~

+

| 1 || Update

−

| ~~0x1~~

−

| ~~IsPowered~~

|-

−

| ~~0x1~~

+

| 2 || Completed

−

| ~~0x1~~

−

| ~~IsCharging~~

−

|-

−

~~| 0x2~~

−

~~| 0x6~~

−

~~| Reserved~~

−

|-

−

~~| 0x8~~

−

~~| 0x6~~

−

~~| [[#BatteryLevel|BatteryLevel]]~~

|}

−

= ~~BatteryLevel~~ =

+

= NpadJoyHoldType =

−

This is "nn::hid::~~system::NpadBatteryLevel". This is a 4 byte value.~~

+

This is "nn::hid::NpadJoyHoldType".

−

~~= 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"

+

! Value

+

! Description

|-

−

~~! Offset~~ || ~~Size~~ |~~| Description~~

+

| 0 || Vertical

|-

−

| ~~0x0 || 0x4 || TypeValue~~

+

| 1 || Horizontal

−

|-

−

~~| 0x0 || 0x1 ||~~

−

|-

−

~~| 0x1 || 0x1~~ ||

|}

−

= ~~SixAxisSensorHandle~~ =

+

= NpadJoyDeviceType =

−

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

+

This is "nn::hid::NpadJoyDeviceType".

{| class="wikitable" border="1"

+

! Value

+

! Description

|-

−

~~! Offset~~ || ~~Size~~ |~~| Description~~

+

| 0 || Left

|-

−

| ~~0x0~~ || ~~0x4 || TypeValue~~

+

| 1 || Right

−

|-

−

~~| 0x0 || 0x1 || NpadStyleIndex~~

−

|-

−

~~| 0x1 || 0x1 || [[#NpadIdType|PlayerNumber]]~~

−

|-

−

~~| 0x2 || 0x1 || DeviceIdx~~

|}

−

= ~~VibrationDeviceHandle~~ =

+

= NpadHandheldActivationMode =

−

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

+

This is "nn::hid::NpadHandheldActivationMode".

+

This controls how many joycons must be attached for handheld mode to be triggered (Dual = 2, Single = 1, None = 0).

{| class="wikitable" border="1"

+

! Value

+

! Description

|-

−

~~! Offset~~ || ~~Size~~ |~~| Description~~

+

| 0 || Dual

|-

−

| ~~0x0~~ || ~~0x4 || TypeValue~~

+

| 1 || Single

|-

−

| ~~0x0~~ || ~~0x1 || NpadStyleIndex~~

+

| 2 || None

−

|-

−

~~| 0x1 || 0x1 || [[#NpadIdType|PlayerNumber]]~~

−

|-

−

~~| 0x2 || 0x1 || DeviceIdx~~

|}

−

= ~~VibrationDeviceInfo~~ =

+

= NpadJoyAssignmentMode =

−

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

+

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

{| class="wikitable" border="1"

+

! Value

+

! Description

|-

−

~~! Offset~~ || ~~Size~~ |~~| Description~~

+

| 0 || Dual

|-

−

| ~~0x0~~ || ~~0x4 || [[#VibrationDeviceType|DeviceType]]~~

+

| 1 || Single

−

|-

−

~~| 0x4 || 0x4 || [[#VibrationDevicePosition|Position]]~~

|}

−

= ~~VibrationDeviceType~~ =

+

= NpadCommunicationMode =

−

This is "nn::hid::~~VibrationDeviceType~~".

+

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

{| class="wikitable" border="1"

Line 6,866: Line 6,953:

! Description

|-

−

| 0 || ~~Unknown~~

+

| 0 || 5ms

+

|-

+

| 1 || 10ms

|-

−

| 1 || ~~LinearResonantActuator~~

+

| 2 || 15ms

|-

−

| 2 || ~~GcErm~~

+

| 3 || Default

|}

−

= ~~VibrationDevicePosition~~ =

+

= AppletDetailedUiType =

−

This is "nn::hid::~~VibrationDevicePosition~~".

+

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

{| class="wikitable" border="1"

Line 6,880: Line 6,969:

! Description

|-

−

| 0 || None

+

| 0x00000000 || None

+

|-

+

| 0x01000000 || HandheldNone

|-

−

| 1 || ~~Left~~

+

| 0x02000000 || HandheldJoyConLeftOnly

|-

−

| 2 || ~~Right~~

+

| 0x02000001 || HandheldLarkHvc1Only

−

|}

−

~~= VibrationValue =~~

−

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

−

~~{| class="wikitable" border="1"~~

|-

−

~~! Offset~~

+

| 0x02000002 || HandheldLarkNesLeftOnly

−

~~! Size~~

−

~~! Description~~

|-

−

| ~~0x0~~

+

| 0x03000000 || HandheldJoyConRightOnly

−

| ~~0x4~~

+

|-

−

| ~~AmplitudeLow~~

+

| 0x03000001 || HandheldLarkHvc2Only

|-

−

| ~~0x4~~

+

| 0x03000002 || HandheldLarkNesRightOnly

−

| ~~0x4~~

−

| ~~FrequencyLow~~

|-

−

| ~~0x8~~

+

| 0x04000000 || HandheldJoyConLeftJoyConRight

−

| ~~0x4~~

−

| ~~AmplitudeHigh~~

|-

−

| ~~0xC~~

+

| 0x04000001 || HandheldJoyConLeftLarkHvc2

−

| ~~0x4~~

−

| ~~FrequencyHigh~~

−

|}

−

~~= VibrationGcErmCommand =~~

−

~~This is "nn::hid::VibrationGcErmCommand".~~

−

~~{| class="wikitable" border="1"~~

−

~~! Value~~

−

~~! Name~~

−

~~! Description~~

|-

−

| 0 || ~~Stop || Stops the vibration with a decay phase.~~

+

| 0x04000002 || HandheldJoyConLeftLarkNesRight

|-

−

| 1 || ~~Start || Starts the vibration.~~

+

| 0x04000003 || HandheldLarkHvc1JoyConRight

|-

−

| 2 || ~~StopHard || Stops the vibration immediately, with no decay phase.~~

+

| 0x04000004 || HandheldLarkHvc1LarkHvc2

−

|}

−

~~= AccelerometerPlayMode =~~

−

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

−

~~{| class="wikitable" border="1"~~

−

~~! Value~~

−

~~! Description~~

|-

−

| 0 || ~~Loose~~

+

| 0x04000005 || HandheldLarkHvc1LarkNesRight

|-

−

| 1 || ~~Tight~~

+

| 0x04000006 || HandheldLarkNesLeftJoyConRight

−

|}

−

~~= GyroscopeZeroDriftMode =~~

−

~~This is "nn::hid::GyroscopeZeroDriftMode".~~

−

~~{| class="wikitable" border="1"~~

−

~~! Value~~

−

~~! Description~~

|-

−

| 0 || ~~Loose~~

+

| 0x04000007 || HandheldLarkNesLeftLarkHvc2

|-

−

| 1 || ~~Standard~~

+

| 0x04000008 || HandheldLarkNesLeftLarkNesRight

|-

−

| 2 || ~~Tight~~

+

| 0x05000000 || JoyDual

−

|}

+

|-

−

+

| 0x06000000 || JoyDualLeftOnly

−

~~= PalmaConnectionHandle =~~

+

|-

−

~~This is "nn::hid::PalmaConnectionHandle". This is a 0x8~~-~~byte struct with 8-byte alignment.~~

+

| 0x07000000 || JoyDualRightOnly

−

+

|-

−

~~= PalmaOperationInfo =~~

+

| 0x08000000 || JoyLeftHorizontal

−

~~This is "nn::hid::PalmaOperationInfo". This is a 0x148~~-~~byte struct.~~

+

|-

−

+

| 0x09000000 || JoyLeftVertical

−

{| ~~class="wikitable" border="1"~~

|-

−

~~! Offset~~ || ~~Size~~ |~~| Description~~

+

| 0x0A000000 || JoyRightHorizontal

|-

−

| ~~0x0~~ || ~~0x4 || sdknso sets this to the output value from [[#GetPalmaOperationInfo]], sdknso will Abort if it's larger than 0x10 ([5.0.0-5.0.2] 0xE).~~

+

| 0x0B000000 || JoyRightVertical

|-

−

| ~~0x4~~ || ~~0x4 || Result~~

+

| 0x0C000000 || SwitchProController

|-

−

| ~~0x8~~ || ~~0x140 || Buffer for [[#GetPalmaOperationInfo]].~~

+

| 0x0D000000 || CompatibleProController

−

|}

−

~~= PalmaFrModeType =~~

−

~~This is "nn::hid::PalmaFrModeType".~~

−

~~= PalmaApplicationSectionAccessBuffer =~~

−

~~This is "nn::hid::PalmaApplicationSectionAccessBuffer". This is a 0x100-byte struct.~~

−

~~= PalmaFeature =~~

−

~~This is "nn::hid::PalmaFeature".~~

−

~~= AbstractedPadState =~~

−

~~{| class="wikitable" border="1"~~

|-

−

~~! Offset~~ || ~~Size~~ |~~| Description~~

+

| 0x0E000000 || CompatibleJoyCon

|-

−

| ~~0x0~~ || ~~0x4 || Type, only 1 bit can be set. Converted to [[#HdlsDeviceInfo]]::type internally by [[#SetAutoPilotVirtualPadState]].~~

+

| 0x0F000000 || LarkHvc1

|-

−

| ~~0x4~~ || ~~0x1 || Flags. [[#SetAutoPilotVirtualPadState]] only uses bit0: when clear it will skip using the rest of the input and run [[#UnsetAutoPilotVirtualPadState]] internally.~~

+

| 0x10000000 || LarkHvc2

|-

−

| ~~0x5~~ || ~~0x3 || Padding~~

+

| 0x11000000 || LarkNesLeft

|-

−

| ~~0x8~~ || ~~0x4 || RGBA Single Body Color~~

+

| 0x12000000 || LarkNesRight

|-

−

| ~~0xC~~ || ~~0x4 || RGBA Single Buttons Color~~

+

| 0x13000000 || LuciaU

|-

−

| ~~0x10~~ || ~~0x1 || See [[#HiddbgHdlsDeviceInfo]]::[[#NpadInterfaceType]].~~

+

| 0x13000001 || LuciaJ

|-

−

| ~~0x11~~ || ~~0x3 || Padding~~

+

| 0x13000002 || LuciaE

|-

−

| ~~0x14~~ || ~~0x24 || [[#HdlsState]]. Unknown if the last 4-bytes are included in this struct, [[#SetAutoPilotVirtualPadState]]/[[#hiddbgGetAbstractedPadsState]] only uses the first 0x20-bytes.~~

+

| 0x14000000 || Verification

|-

−

| ~~0x38~~ || ~~0x60 || Unused with [[#SetAutoPilotVirtualPadState]]/[[#GetAbstractedPadsState]].~~

+

| 0xFFFFFFFF || Unknown

|}

−

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

+

= AppletFooterUiType =

+

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

−

~~Type:~~

{| class="wikitable" border="1"

−

! ~~Bits~~

+

! Value

−

~~! [[#HdlsDeviceInfo]]::type bits~~

! Description

−

~~! Notes~~

|-

−

| 0 || 0 || ||

+

| 0 || None

+

|-

+

| 1 || HandheldNone

+

|-

+

| 2 || HandheldJoyConLeftOnly

+

|-

+

| 3 || HandheldJoyConRightOnly

|-

−

| 1 || ~~15 || || [[#DeviceType]] |= BIT(1)~~

+

| 4 || HandheldJoyConLeftJoyConRight

|-

−

| ~~2 || 1 ||~~ ||

+

| 5 || JoyDual

|-

−

| ~~3 || 2 ||~~ ||

+

| 6 || JoyDualLeftOnly

|-

−

| ~~4 || 1 ||~~ ||

+

| 7 || JoyDualRightOnly

|-

−

| ~~5 || 2 ||~~ ||

+

| 8 || JoyLeftHorizontal

|-

−

| ~~6 || 3 ||~~ ||

+

| 9 || JoyLeftVertical

|-

−

| 7 || ~~11 || || [[#DeviceType]] |= BIT(11)~~

+

| 10 || JoyRightHorizontal

|-

−

| 8 || ~~12 || || [[#DeviceType]] |= BIT(12)~~

+

| 11 || JoyRightVertical

|-

−

| 9 || ~~13 || || [[#DeviceType]] |= BIT(13)~~

+

| 12 || SwitchProController

|-

−

| 10 || ~~14 || || [[#DeviceType]] |= BIT(14)~~

+

| 13 || CompatibleProController

|-

−

| 11 || ~~15 || || [[#DeviceType]] |= BIT(11)~~

+

| 14 || CompatibleJoyCon

|-

−

| 12 || ~~12 || || [[#DeviceType]] |= BIT(12)~~

+

| 15 || LarkHvc1

|-

−

| 13 || ~~13 || || [[#DeviceType]] |= BIT(13)~~

+

| 16 || LarkHvc2

|-

−

| 14 || ~~14 || || [[#DeviceType]] |= BIT(14)~~

+

| 17 || LarkNesLeft

|-

−

| ~~15 || 17 ||~~ ||

+

| 18 || LarkNesRight

|-

−

| 31 || ~~21 || || [[#DeviceType]] = BIT(31)~~

+

| 19 || Lucia

|-

+

| 20 || Verification

|}

−

~~The above "[[#DeviceType]] |~~=~~" notes only apply when type2 is 0x2.~~

+

= NpadIdType =

−

+

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

−

~~= DebugPadAutoPilotState~~ =

−

This is "nn::hid::~~debug::DebugPadAutoPilotState~~"

{| class="wikitable" border="1"

+

! Value

+

! Description

|-

−

~~! Offset~~

+

| 0x0 || No1

−

~~! Size~~

+

|-

−

~~! Description~~

+

| 0x1 || No2

+

|-

+

| 0x2 || No3

+

|-

+

| 0x3 || No4

+

|-

+

| 0x4 || No5

+

|-

+

| 0x5 || No6

|-

−

| ~~0x0~~

+

| 0x6 || No7

−

| ~~0x4~~

−

| ~~[[#DebugPadAttributeSet|Attributes]]~~

|-

−

| ~~0x4~~

+

| 0x7 || No8

−

| ~~0x4~~

−

| ~~[[#DebugPadButtonSet|Buttons]]~~

|-

−

| ~~0x8~~

+

| 0x10 || Other

−

| ~~0x8~~

−

| ~~[[#AnalogStickState|AnalogStickR]]~~

|-

−

| ~~0x10~~

+

| 0x20 || Handheld

−

| ~~0x8~~

−

| ~~[[#AnalogStickState|AnalogStickL]]~~

|}

−

= ~~MouseAutoPilotState~~ =

+

= NpadInterfaceType =

−

This is "nn::hid::~~debug::MouseAutoPilotState~~".

+

This is "nn::hid::NpadInterfaceType".

{| class="wikitable" border="1"

+

! Value

+

! Description

|-

−

~~! Offset~~

+

| 1 || Bluetooth

−

~~! Size~~

−

~~! Description~~

|-

−

| ~~0x0~~

+

| 2 || Rail

−

| ~~0x4~~

−

| X

|-

−

| ~~0x4~~

+

| 3 || USB

−

| ~~0x4~~

−

| Y

|-

−

| ~~0x8~~

+

| 4 || Unknown

−

| ~~0x4~~

+

|}

−

| ~~DeltaX~~

+

= NpadLarkType =

+

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

+

{| class="wikitable" border="1"

+

! Value

+

! Description

|-

−

| ~~0xC~~

+

| 0 || Invalid

−

| ~~0x4~~

−

| ~~DeltaY~~

|-

−

| ~~0x10~~

+

| 1 || H1

−

| ~~0x4~~

−

| ~~WheelDeltaX~~

|-

−

| ~~0x14~~

+

| 2 || H2

−

| ~~0x4~~

−

| ~~WheelDeltaY~~

|-

−

| ~~0x18~~

+

| 3 || NL

−

| ~~0x4~~

−

| ~~[[#MouseButtonSet|Buttons]]~~

|-

−

| ~~0x1C~~

+

| 4 || NR

−

| ~~0x4~~

−

| ~~[[#MouseAttributeSet|Attributes]]~~

|}

−

= ~~KeyboardAutoPilotState~~ =

+

= NpadLuciaType =

−

This is "nn::hid::~~debug::KeyboardAutoPilotState~~".

+

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

{| class="wikitable" border="1"

+

! Value

+

! Description

|-

−

~~! Offset~~

+

| 0 || Invalid

−

~~! Size~~

+

|-

−

~~! Description~~

+

| 1 || J

|-

−

| ~~0x0~~

+

| 2 || E

−

| ~~0x8~~

−

| ~~[[#KeyboardModifierSet|Modifiers]]~~

|-

−

| ~~0x8~~

+

| 3 || U

−

| ~~0x20~~

−

| ~~[[#KeyboardKeySet|Keys]]~~

|}

−

= ~~HdlsHandle~~ =

+

= GestureDirection =

−

This is "nn::hid::~~debug::HdlsHandle~~"~~. This is a 0x8-byte struct with 8-byte alignment.~~

+

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

−

~~= HdlsNpadAssignment =~~

−

~~This is a 0x208-byte struct~~.

{| class="wikitable" border="1"

+

! Value

+

! Description

+

|-

+

| 0 || None

|-

−

~~! Offset~~ || ~~Size~~ |~~| Description~~

+

| 1 || Left

|-

−

| ~~0x0~~ || ~~0x4 || s32 Total entries~~

+

| 2 || Up

|-

−

| 0x4 || 0x4 || Padding

+

| 3 || Right

−

|-

+

|-

−

| 0x8 || 0x200(0x20*0x10) || Array of [[#HdlsNpadAssignmentEntry]].

+

| 4 || Down

−

|}

+

|}

−

+

−

= HdlsNpadAssignmentEntry =

+

= GestureType =

−

This is a 0x20-byte struct.

+

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

−

+

−

{| class="wikitable" border="1"

+

{| class="wikitable" border="1"

−

|-

+

! Value

−

! Offset || Size || Description

+

! Description

−

|-

+

|-

−

| 0x0 || 0x8 || [[#HdlsHandle]]

+

| 0 || Idle

−

|-

+

|-

−

| 0x8 || 0x4 || ?

+

| 1 || Complete

−

|-

+

|-

−

| 0xC || 0x4 || ?

+

| 2 || Cancel

−

|-

+

|-

−

| 0x10 || 0x8 || ?

+

| 3 || Touch

−

|-

+

|-

−

| 0x18 || 0x1 || ?

+

| 4 || Press

−

|-

+

|-

−

| 0x19 || 0x7 || Padding

+

| 5 || Tap

−

|}

+

|-

−

+

| 6 || Pan

−

= HdlsStateList =

+

|-

−

This is a 0x408-byte struct.

+

| 7 || Swipe

−

+

|-

−

[9.0.0+] This is a 0x488-byte struct.

+

| 8 || Pinch

−

+

|-

−

{| class="wikitable" border="1"

+

| 9 || Rotate

−

|-

+

|}

−

! Offset || Size || Description

+

−

|-

+

= DeviceHandle =

−

| 0x0 || 0x4 || s32 Total entries

+

This is "nn::xcd::DeviceHandle". This is a 8 byte value.

−

|-

+

−

| 0x4 || 0x4 || Padding

+

= DeviceType =

−

|-

+

This is "nn::hid::system::DeviceType".

−

| 0x8 || <[[#HdlsStateListEntry]] size>*0x10 || Array of [[#HdlsStateListEntry]].

+

−

|}

+

{| class="wikitable" border="1"

−

+

! Bits

−

This contains a list of all controllers, including non-virtual controllers.

+

! Description

−

+

|-

−

= HdlsStateListEntry =

+

| 0

−

This is a 0x40-byte struct.

+

| FullKey

−

+

|-

−

[9.0.0+] This is a 0x48-byte struct.

+

| 1

−

+

| DebugPad

−

{| class="wikitable" border="1"

+

|-

−

|-

+

| 2

−

! Offset || Size || Description

+

| HandheldLeft

−

|-

+

|-

−

| 0x0 || 0x8 || [[#HdlsHandle]]

+

| 3

−

|-

+

| HandheldRight

−

| 0x8 || [[#HdlsDeviceInfo]] size || [[#HdlsDeviceInfo]]. With [[#ApplyHdlsStateList]] this is only used when creating new devices.

+

|-

−

|-

+

| 4

−

| 0x8 + [[#HdlsDeviceInfo]] size, with 8-byte alignment || 0x24 || [[#HdlsState]]

+

| JoyLeft

−

|-

+

|-

−

| <Immediately following the above> || 0x4 || Padding

+

| 5

−

|}

+

| JoyRight

−

+

|-

−

= HdlsDeviceInfo =

+

| 6

−

This is a 0x10-byte struct.

+

| Palma

−

+

|-

−

{| class="wikitable" border="1"

+

| 7

−

|-

+

| LarkHvcLeft

−

! Offset || Size || Description

+

|-

−

|-

+

| 8

−

| 0x0 || 0x4 || [[#DeviceTypeInternal]]

+

| LarkHvcRight

−

|-

+

|-

−

| 0x4 || 0x4 || RGBA Single Body Color

+

| 9

−

|-

+

| LarkNesLeft

−

| 0x8 || 0x4 || RGBA Single Buttons Color

+

|-

−

|-

+

| 10

−

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

+

| LarkNesRight

−

|-

+

|-

−

| 0xD || 0x3 || Padding

+

| 11

−

|}

+

| HandheldLarkHvcLeft

−

+

|-

−

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

+

| 12

−

+

| HandheldLarkHvcRight

−

{| class="wikitable" border="1"

+

|-

−

|-

+

| 13

−

! Offset || Size || Description

+

| HandheldLarkNesLeft

−

|-

+

|-

−

| 0x0 || 0x1 || [[#DeviceTypeInternal]]

+

| 14

−

|-

+

| HandheldLarkNesRight

−

| 0x1 || 0x1 || [[#NpadInterfaceType]]. Similar to the field from the old struct.

+

|-

+

| 15

+

| Lucia

+

|-

+

| 16-30

+

| Reserved

+

|-

+

| 31

+

| System

+

|}

+

= DeviceTypeInternal =

+

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

+

{| class="wikitable" border="1"

+

! Bits

+

! Description

+

|-

+

| 0-7

+

| BIT(N*4+0) = Pro Controller, BIT(N*4+1) = Joy-Con Left, BIT(N*4+2) = Joy-Con Right, BIT(N*4+3) = invalid. Where N is 0-1.

+

|-

+

| 8-10

+

| Pro Controller

+

|-

+

| 11

+

| Famicom left controller

+

|-

+

| 12

+

| Famicom right controller (with microphone)

+

|-

+

| 13

+

| NES left controller

+

|-

+

| 14

+

| NES right controller

+

|-

+

| 15-16

+

| Invalid

+

|-

+

| 17

+

| Generic external controller

+

|-

+

| 18-20

+

| Invalid

+

|-

+

| 21-23

+

| Generic controller

+

|}

+

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

+

{| class="wikitable" border="1"

+

! Value

+

! [[#DeviceType|DeviceType]]

+

! [[#UniquePadType|UniquePadType]]

+

! Description

+

|-

+

| 1 || JoyRight, HandheldRight || JoyRight || Joy-Con right controller

+

|-

+

| 2 || JoyLeft, HandheldLeft || JoyLeft || Joy-Con left controller

+

|-

+

| 3 || FullKey || FullKey || Pro Controller

+

|-

+

| 4 || JoyLeft || JoyLeft || Reserved

+

|-

+

| 5 || JoyRight || JoyRight || Reserved

+

|-

+

| 6 || FullKey || FullKey || Reserved

+

|-

+

| 7 || LarkHvcLeft, HandheldLarkHvcLeft || JoyLeft || Famicom left controller

+

|-

+

| 8 || LarkHvcRight, HandheldLarkHvcRight || JoyRight || Famicom right controller (with microphone)

+

|-

+

| 9 || LarkNesLeft, HandheldLarkNesLeft || JoyLeft || NES left controller

+

|-

+

| 10 || LarkNesRight, HandheldLarkNesRight || JoyRight || NES right controller

+

|-

+

| 11 || Lucia || FullKey || SNES controller

+

|-

+

| 12 || Palma || Other || Poké Ball Plus controller

+

|-

+

| 13 || FullKey || FullKey || Gc controller

+

|-

+

| 14 || HandheldLeft || JoyLeft || Reserved

+

|-

+

| 15 || FullKey || FullKey || Reserved

+

|-

+

| 16 || FullKey || FullKey || Reserved

+

|-

+

| 17 || DebugPad || DebugPad || Debug controller

+

|-

+

| 18 || HandheldRight || JoyRight || Reserved

+

|-

+

| 19 || System || Other || Unknown (has [[#NpadStyleTag|NpadFullKey]] style tag)

+

|-

+

| 20 || System || Other || Unknown (has [[#NpadStyleTag|NpadJoyDual]] style tag)

+

|-

+

| 21 || System || Other || Unknown (has [[#NpadStyleTag|NpadJoyDual]] style tag)

+

|}

+

= NpadPowerInfo =

+

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

+

{| class="wikitable" border="1"

+

|-

+

! Offset

+

! Size

+

! Description

+

|-

+

| 0x0

+

| 0x1

+

| IsPowered

+

|-

+

| 0x1

+

| 0x1

+

| IsCharging

+

|-

+

| 0x2

+

| 0x6

+

| Reserved

+

|-

+

| 0x8

+

| 0x6

+

| [[#BatteryLevel|BatteryLevel]]

+

|}

+

= BatteryLevel =

+

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

+

= ConsoleSixAxisSensorHandle =

+

This is "nn::hid::ConsoleSixAxisSensorHandle". This is a 4-byte struct with 4-byte alignment.

+

sdknso GetConsoleSixAxisSensorHandle always returns a handle with value 0x13.

+

{| class="wikitable" border="1"

+

|-

+

! Offset || Size || Description

+

|-

+

| 0x0 || 0x4 || TypeValue

+

|-

+

| 0x0 || 0x1 ||

+

|-

+

| 0x1 || 0x1 ||

+

|}

+

= SixAxisSensorHandle =

+

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

+

{| class="wikitable" border="1"

+

|-

+

! Offset || Size || Description

+

|-

+

| 0x0 || 0x4 || TypeValue

+

|-

+

| 0x0 || 0x1 || NpadStyleIndex

+

|-

+

| 0x1 || 0x1 || [[#NpadIdType|PlayerNumber]]

+

|-

+

| 0x2 || 0x1 || DeviceIdx

+

|}

+

= VibrationDeviceHandle =

+

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

+

{| class="wikitable" border="1"

+

|-

+

! Offset || Size || Description

+

|-

+

| 0x0 || 0x4 || TypeValue

+

|-

+

| 0x0 || 0x1 || NpadStyleIndex

+

|-

+

| 0x1 || 0x1 || [[#NpadIdType|PlayerNumber]]

+

|-

+

| 0x2 || 0x1 || DeviceIdx

+

|}

+

= VibrationDeviceInfo =

+

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

+

{| class="wikitable" border="1"

+

|-

+

! Offset || Size || Description

+

|-

+

| 0x0 || 0x4 || [[#VibrationDeviceType|DeviceType]]

+

|-

+

| 0x4 || 0x4 || [[#VibrationDevicePosition|Position]]

+

|}

+

= VibrationDeviceType =

+

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

+

{| class="wikitable" border="1"

+

! Value

+

! Description

+

|-

+

| 0 || Unknown

+

|-

+

| 1 || LinearResonantActuator

+

|-

+

| 2 || GcErm

+

|}

+

= VibrationDevicePosition =

+

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

+

{| class="wikitable" border="1"

+

! Value

+

! Description

+

|-

+

| 0 || None

+

|-

+

| 1 || Left

+

|-

+

| 2 || Right

+

|}

+

= VibrationValue =

+

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

+

{| class="wikitable" border="1"

+

|-

+

! Offset

+

! Size

+

! Description

+

|-

+

| 0x0

+

| 0x4

+

| AmplitudeLow

+

|-

+

| 0x4

+

| 0x4

+

| FrequencyLow

+

|-

+

| 0x8

+

| 0x4

+

| AmplitudeHigh

+

|-

+

| 0xC

+

| 0x4

+

| FrequencyHigh

+

|}

+

= VibrationGcErmCommand =

+

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

+

{| class="wikitable" border="1"

+

! Value

+

! Name

+

! Description

+

|-

+

| 0 || Stop || Stops the vibration with a decay phase.

+

|-

+

| 1 || Start || Starts the vibration.

+

|-

+

| 2 || StopHard || Stops the vibration immediately, with no decay phase.

+

|}

+

= AccelerometerPlayMode =

+

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

+

{| class="wikitable" border="1"

+

! Value

+

! Description

+

|-

+

| 0 || Loose

+

|-

+

| 1 || Tight

+

|}

+

= GyroscopeZeroDriftMode =

+

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

+

{| class="wikitable" border="1"

+

! Value

+

! Description

+

|-

+

| 0 || Loose

+

|-

+

| 1 || Standard

+

|-

+

| 2 || Tight

+

|}

+

= PalmaConnectionHandle =

+

This is "nn::hid::PalmaConnectionHandle". This is a 0x8-byte struct with 8-byte alignment.

+

= PalmaOperationInfo =

+

This is "nn::hid::PalmaOperationInfo". This is a 0x148-byte struct.

+

{| class="wikitable" border="1"

+

|-

+

! Offset || Size || Description

+

|-

+

| 0x0 || 0x4 || [[#PalmaOperationType]]

+

|-

+

| 0x4 || 0x4 || Result

+

|-

+

| 0x8 || 0x140 || Buffer for [[#GetPalmaOperationInfo]].

+

|}

+

= PalmaOperationType =

+

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

+

{| class="wikitable" border="1"

+

! Value

+

! Description

+

|-

+

| 0 || PlayActivity

+

|-

+

| 1 || SetFrModeType

+

|-

+

| 2 || ReadStep

+

|-

+

| 3 || EnableStep

+

|-

+

| 4 || ResetStep

+

|-

+

| 5 || ReadApplicationSection

+

|-

+

| 6 || WriteApplicationSection

+

|-

+

| 7 || ReadUniqueCode

+

|-

+

| 8 || SetUniqueCodeInvalid

+

|-

+

| 9 || WriteActivityEntry

+

|-

+

| 10 || WriteRgbLedPatternEntry

+

|-

+

| 11 || WriteWaveEntry

+

|-

+

| 12 || ReadDataBaseIdentificationVersion

+

|-

+

| 13 || WriteDataBaseIdentificationVersion

+

|-

+

| 14 || SuspendFeature

+

|-

+

| [[5.1.0]]+ 15 || ReadPlayLog

+

|-

+

| [[5.1.0]]+ 16 || ResetPlayLog

+

|}

+

= PalmaFrModeType =

+

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

+

{| class="wikitable" border="1"

+

! Value

+

! Description

+

|-

+

| 0 || Off

+

|-

+

| 1 || B01

+

|-

+

| 2 || B02

+

|-

+

| 3 || B03

+

|-

+

| 4 || Downloaded

+

|}

+

= PalmaApplicationSectionAccessBuffer =

+

This is "nn::hid::PalmaApplicationSectionAccessBuffer". This is a 0x100-byte struct.

+

= PalmaActivityEntry =

+

This is "nn::hid::PalmaActivityEntry".

+

{| class="wikitable" border="1"

+

|-

+

! Offset || Size || Description

+

|-

+

| 0x0 || 0x2 || RgbLedPatternIndex.

+

|-

+

| 0x2 || 0x2 || Padding

+

|-

+

| 0x4 || 0x4 || [[#PalmaWaveSet|WaveSet]].

+

|-

+

| 0x8 || 0x2 || WaveIndex.

+

|}

+

= PalmaWaveSet =

+

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

+

{| class="wikitable" border="1"

+

! Value

+

! Description

+

|-

+

| 0 || Small

+

|-

+

| 1 || Medium

+

|-

+

| 2 || Large

+

|}

+

= PalmaFeature =

+

This is "nn::hid::PalmaFeature".

+

{| class="wikitable" border="1"

+

|-

+

! Bit

+

! Description

+

|-

+

| 0

+

| FrMode

+

|-

+

| 1

+

| RumbleFeedback

+

|-

+

| 2

+

| Step

+

|-

+

| 3

+

| MuteSwitch

+

|-

+

|}

+

= AbstractedPadState =

+

{| class="wikitable" border="1"

+

|-

+

! Offset || Size || Description

+

|-

+

| 0x0 || 0x4 || Type, only 1 bit can be set. Converted to [[#HdlsDeviceInfo]]::type internally by [[#SetAutoPilotVirtualPadState]].

+

|-

+

| 0x4 || 0x1 || Flags. [[#SetAutoPilotVirtualPadState]] only uses bit0: when clear it will skip using the rest of the input and run [[#UnsetAutoPilotVirtualPadState]] internally.

+

|-

+

| 0x5 || 0x3 || Padding

+

|-

+

| 0x8 || 0x4 || RGBA Single Body Color

+

|-

+

| 0xC || 0x4 || RGBA Single Buttons Color

+

|-

+

| 0x10 || 0x1 || See [[#HiddbgHdlsDeviceInfo]]::[[#NpadInterfaceType]].

+

|-

+

| 0x11 || 0x3 || Padding

+

|-

+

| 0x14 || 0x24 || [[#HdlsState]]. Unknown if the last 4-bytes are included in this struct, [[#SetAutoPilotVirtualPadState]]/[[#hiddbgGetAbstractedPadsState]] only uses the first 0x20-bytes.

+

|-

+

| 0x38 || 0x60 || Unused with [[#SetAutoPilotVirtualPadState]]/[[#GetAbstractedPadsState]].

+

|}

+

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

+

Type:

+

{| class="wikitable" border="1"

+

! Bits

+

! [[#HdlsDeviceInfo]]::type bits

+

! Description

+

! Notes

+

|-

+

| 0 || 0 || ||

+

|-

+

| 1 || 15 || || [[#DeviceType]] |= BIT(1)

+

|-

+

| 2 || 1 || ||

+

|-

+

| 3 || 2 || ||

+

|-

+

| 4 || 1 || ||

+

|-

+

| 5 || 2 || ||

+

|-

+

| 6 || 3 || ||

+

|-

+

| 7 || 11 || || [[#DeviceType]] |= BIT(11)

+

|-

+

| 8 || 12 || || [[#DeviceType]] |= BIT(12)

+

|-

+

| 9 || 13 || || [[#DeviceType]] |= BIT(13)

+

|-

+

| 10 || 14 || || [[#DeviceType]] |= BIT(14)

+

|-

+

| 11 || 15 || || [[#DeviceType]] |= BIT(11)

+

|-

+

| 12 || 12 || || [[#DeviceType]] |= BIT(12)

+

|-

+

| 13 || 13 || || [[#DeviceType]] |= BIT(13)

+

|-

+

| 14 || 14 || || [[#DeviceType]] |= BIT(14)

+

|-

+

| 15 || 17 || ||

+

|-

+

| 31 || 21 || || [[#DeviceType]] = BIT(31)

+

|-

+

|}

+

The above "[[#DeviceType]] |=" notes only apply when type2 is 0x2.

+

= DebugPadAutoPilotState =

+

This is "nn::hid::debug::DebugPadAutoPilotState"

+

{| class="wikitable" border="1"

+

|-

+

! Offset

+

! Size

+

! Description

+

|-

+

| 0x0

+

| 0x4

+

| [[#DebugPadAttributeSet|Attributes]]

+

|-

+

| 0x4

+

| 0x4

+

| [[#DebugPadButtonSet|Buttons]]

+

|-

+

| 0x8

+

| 0x8

+

| [[#AnalogStickState|AnalogStickL]]

+

|-

+

| 0x10

+

| 0x8

+

| [[#AnalogStickState|AnalogStickR]]

+

|}

+

= MouseAutoPilotState =

+

This is "nn::hid::debug::MouseAutoPilotState".

+

{| class="wikitable" border="1"

+

|-

+

! Offset

+

! Size

+

! Description

+

|-

+

| 0x0

+

| 0x4

+

| X

+

|-

+

| 0x4

+

| 0x4

+

| Y

+

|-

+

| 0x8

+

| 0x4

+

| DeltaX

+

|-

+

| 0xC

+

| 0x4

+

| DeltaY

+

|-

+

| 0x10

+

| 0x4

+

| WheelDelta

+

|-

+

| 0x14

+

| 0x4

+

| [[#MouseButtonSet|Buttons]]

+

|-

+

| 0x18

+

| 0x4

+

| [[#MouseAttributeSet|Attributes]]

+

|}

+

= KeyboardAutoPilotState =

+

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

+

{| class="wikitable" border="1"

+

|-

+

! Offset

+

! Size

+

! Description

+

|-

+

| 0x0

+

| 0x8

+

| [[#KeyboardModifierSet|Modifiers]]

+

|-

+

| 0x8

+

| 0x20

+

| [[#KeyboardKeySet|Keys]]

+

|}

+

= SleepButtonAutoPilotState =

+

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

+

{| class="wikitable" border="1"

+

|-

+

! Offset

+

! Size

+

! Description

+

|-

+

| 0x0 || 0x8 || Buttons (only bit0 is used)

+

|}

+

= PowerInfo =

+

This is "nn::hidtypes::PowerInfo".

+

{| class="wikitable" border="1"

+

|-

+

! Offset

+

! Size

+

! Description

+

|-

+

| 0x0 || 0x4 || BatteryLevel

+

|-

+

| 0x4 || 0x4 || [[#PowerAttribute]]

+

|}

+

= PowerAttribute =

+

This is "nn::hidtypes::PowerAttribute". This is a 32-bit flag.

+

{| class="wikitable" border="1"

+

! Bits

+

! Description

+

|-

+

| 0

+

| IsPowered

+

|-

+

| 1

+

| IsCharging

+

|}

+

= HdlsAttribute =

+

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

+

{| class="wikitable" border="1"

+

! Bits

+

! Description

+

|-

+

| 0

+

| HasVirtualSixAxisSensorAcceleration

+

|-

+

| 1

+

| HasVirtualSixAxisSensorAngle

+

|}

+

= HdlsHandle =

+

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

+

= HdlsNpadAssignment =

+

This is a 0x208-byte struct.

+

{| class="wikitable" border="1"

+

|-

+

! Offset || Size || Description

+

|-

+

| 0x0 || 0x4 || s32 Total entries

+

|-

+

| 0x4 || 0x4 || Padding

+

|-

+

| 0x8 || 0x200(0x20*0x10) || Array of [[#HdlsNpadAssignmentEntry]].

+

|}

+

= HdlsNpadAssignmentEntry =

+

This is a 0x20-byte struct.

+

{| class="wikitable" border="1"

+

|-

+

! Offset || Size || Description

+

|-

+

| 0x0 || 0x8 || [[#HdlsHandle]]

+

|-

+

| 0x8 || 0x4 || ?

+

|-

+

| 0xC || 0x4 || ?

+

|-

+

| 0x10 || 0x8 || ?

+

|-

+

| 0x18 || 0x1 || ?

+

|-

+

| 0x19 || 0x7 || Padding

+

|}

+

= HdlsStateList =

+

This is a 0x408-byte struct.

+

[9.0.0+] This is a 0x488-byte struct.

+

{| class="wikitable" border="1"

+

|-

+

! Offset || Size || Description

+

|-

+

| 0x0 || 0x4 || s32 Total entries

+

|-

+

| 0x4 || 0x4 || Padding

+

|-

+

| 0x8 || <[[#HdlsStateListEntry]] size>*0x10 || Array of [[#HdlsStateListEntry]].

+

|}

+

This contains a list of all controllers, including non-virtual controllers.

+

= HdlsStateListEntry =

+

This is a 0x40-byte struct.

+

[9.0.0+] This is a 0x48-byte struct.

+

{| class="wikitable" border="1"

+

|-

+

! Offset || Size || Description

+

|-

+

| 0x0 || 0x8 || [[#HdlsHandle]]

+

|-

+

| 0x8 || [[#HdlsDeviceInfo]] size || [[#HdlsDeviceInfo]]. With [[#ApplyHdlsStateList]] this is only used when creating new devices.

+

|-

+

| 0x8 + [[#HdlsDeviceInfo]] size, with 8-byte alignment || 0x24 || [[#HdlsState]]

+

|-

+

| <Immediately following the above> || 0x4 || Padding

+

|}

+

= HdlsDeviceInfo =

+

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

+

{| class="wikitable" border="1"

+

|-

+

! Offset || Size || Description

+

|-

+

| 0x0 || 0x4 || [[#DeviceTypeInternal]]

+

|-

+

| 0x4 || 0x4 || RGBA Single Body Color

+

|-

+

| 0x8 || 0x4 || RGBA Single Buttons Color

+

|-

+

| 0xC || 0x1 || [[#NpadInterfaceType]]. Additional type field used with the above type field, if the value doesn't match one of the following a default is used. Type Pro-Controller: value 0x3 indicates that the controller is connected via USB. Type bit21: value 0x3 = unknown. When value is 0x2, state is merged with an existing controller (when the type value is compatible with this). Otherwise, it's a dedicated controller.

+

|-

+

| 0xD || 0x3 || Padding

+

|}

+

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

+

{| class="wikitable" border="1"

+

|-

+

! Offset || Size || Description

+

|-

+

| 0x0 || 0x1 || [[#DeviceTypeInternal]]

+

|-

+

| 0x1 || 0x1 || [[#NpadInterfaceType]]. Similar to the field from the old struct.

|-

| 0x2 || 0x2 || Padding

Line 7,250: Line 8,006:

= HdlsState =

−

This is a 0x24-byte struct.

+

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

{| class="wikitable" border="1"

Line 7,268: Line 8,024:

| 0x10 || 0x10(4*2*2) || Joystick data.

|-

−

| 0x20 || 0x1 || Unused for input. Set with output from [[#DumpHdlsStates]] (zero in some cases).

+

| 0x20 || 0x1 || Indicator. Unused for input. Set with output from [[#DumpHdlsStates]] (zero in some cases).

|-

| 0x21 || 0x3 || Padding

|}

−

[9.0.0+]:

+

[9.0.0+] (0x28-bytes):

{| class="wikitable" border="1"

|-

! Offset || Size || Description

|-

−

| 0x0 || ~~0x4~~ || ~~BatteryLevel for the main~~ PowerInfo.

+

| 0x0 || 0x8 || [[#PowerInfo]]

|-

−

| ~~0x4~~ || ~~0x4~~ || ~~Flags~~. ~~Used to set the main PowerInfo~~ for [[#~~NpadSystemProperties~~]]. ~~Bit0~~ -~~> IsPowered, bit1~~ -~~> IsCharging.~~

+

| 0x8 || 0x8 || [[#NpadButton|Buttons]], masked with 0xfffffffff00fffff. See above table regarding HOME/Capture buttons.

+

|-

+

| 0x10 || 0x10(4*2*2) || Joystick data.

+

|-

+

| 0x20 || 0x1 || Indicator. Unused for input. Set with output from [[#DumpHdlsStates]] (zero in some cases).

+

|-

+

| 0x21 || 0x7 || Padding

+

|}

+

[12.0.0+] (0x40-bytes):

+

{| class="wikitable" border="1"

+

|-

+

! Offset || Size || Description

+

|-

+

| 0x0 || 0x8 || [[#PowerInfo]]

|-

| 0x8 || 0x8 || [[#NpadButton|Buttons]], masked with 0xfffffffff00fffff. See above table regarding HOME/Capture buttons.

Line 7,286: Line 8,056:

| 0x10 || 0x10(4*2*2) || Joystick data.

|-

−

| 0x20 || ~~0x1~~ || ~~Unused for input. Set with output from [[#DumpHdlsStates]] (zero in some cases).~~

+

| 0x20 || 0xC || VirtualSixAxisSensorAcceleration

|-

−

| ~~0x21~~ || 0x3 || Padding

+

| 0x2C || 0xC || VirtualSixAxisSensorAngle

+

|-

+

| 0x38 || 0x4 || [[#HdlsAttribute]]

+

|-

+

| 0x3C || 0x1 || Indicator. Unused for input.

+

|-

+

| 0x3D || 0x3 || Padding

|}

+

= DebugRegisteredDevice =

+

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

+

= RegisteredDevice =

+

This is "nn::hid::system::RegisteredDevice". This is a 0x68-byte struct with 4-byte alignment.

= NotificationLedPattern =

Line 7,672: Line 8,454:

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

= IrCameraHandle =

Line 8,320: Line 9,107:

| 1 || RightJoyRail

|-

−

| 2 || [6.0.0+] ~~RightLarkRail~~ (for microphone)

+

| 2 || [6.0.0+] InternalBus (for Lark microphone)

|}

Line 8,338: Line 9,125:

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 =

Hexkyz

Bureaucrats, Administrators

2,781

edits

Changes

HID services (view source)

Revision as of 20:02, 23 July 2021

Navigation menu

Search