hid:dbg service IPC wrapper. More...

#include "../types.h"
#include "../services/hid.h"
#include "../services/hidsys.h"
#include "../sf/service.h"

Data Structures
struct	HiddbgDebugPadAutoPilotState
	State for overriding HidDebugPadState. More...

struct	HiddbgMouseAutoPilotState
	State for overriding HidMouseState. More...

struct	HiddbgKeyboardAutoPilotState
	State for overriding HidKeyboardState. More...

struct	HiddbgSleepButtonAutoPilotState
	State for overriding SleepButtonState. More...

struct	HiddbgHdlsHandle
	HdlsHandle. More...

struct	HiddbgHdlsSessionId
	HdlsSessionId, returned by hiddbgAttachHdlsWorkBuffer. More...

struct	HiddbgHdlsDeviceInfoV7
	HdlsDeviceInfo, for [7.0.0-8.1.0]. More...

struct	HiddbgHdlsDeviceInfo
	HdlsDeviceInfo, for [9.0.0+]. Converted to/from HiddbgHdlsDeviceInfoV7 on prior sysvers. More...

struct	HiddbgHdlsStateV7
	HdlsState, for [7.0.0-8.1.0]. More...

struct	HiddbgHdlsStateV9
	HdlsState, for [9.0.0-11.0.1]. More...

struct	HiddbgHdlsState
	HdlsState, for [12.0.0+]. More...

struct	HiddbgHdlsNpadAssignmentEntry
	HdlsNpadAssignmentEntry. More...

struct	HiddbgHdlsNpadAssignment
	HdlsNpadAssignment. Same controllers as HiddbgHdlsStateList, with different entry data. More...

struct	HiddbgHdlsStateListEntryV7
	HdlsStateListEntryV7, for [7.0.0-8.1.0]. More...

struct	HiddbgHdlsStateListV7
	HdlsStateListV7, for [7.0.0-8.1.0]. This contains a list of all controllers, including non-virtual controllers. More...

struct	HiddbgHdlsStateListEntryV9
	HdlsStateListEntry, for [9.0.0-11.0.1]. More...

struct	HiddbgHdlsStateListV9
	HdlsStateList, for [9.0.0-11.0.1]. More...

struct	HiddbgHdlsStateListEntry
	HdlsStateListEntry, for [12.0.0+]. More...

struct	HiddbgHdlsStateList
	HdlsStateList, for [12.0.0+]. More...

struct	HiddbgAbstractedPadHandle
	AbstractedPadHandle. More...

struct	HiddbgAbstractedPadState
	AbstractedPadState. More...

Enumerations
enum	HiddbgNpadButton { HiddbgNpadButton_Home = (1U<<( 18 )) , HiddbgNpadButton_Capture = (1U<<( 19 )) }
	HiddbgNpadButton. For the remaining buttons, see HidNpadButton. More...

enum	HiddbgHdlsAttribute { HiddbgHdlsAttribute_HasVirtualSixAxisSensorAcceleration = (1U<<( 0 )) , HiddbgHdlsAttribute_HasVirtualSixAxisSensorAngle = (1U<<( 1 )) }
	HdlsAttribute. More...

Functions
Result	hiddbgInitialize (void)
	Initialize hiddbg.

void	hiddbgExit (void)
	Exit hiddbg.

Service *	hiddbgGetServiceSession (void)
	Gets the Service object for the actual hiddbg service session.

Result	hiddbgSetDebugPadAutoPilotState (const HiddbgDebugPadAutoPilotState *state)
	SetDebugPadAutoPilotState.

Result	hiddbgUnsetDebugPadAutoPilotState (void)
	UnsetDebugPadAutoPilotState.

Result	hiddbgSetTouchScreenAutoPilotState (const HidTouchState *states, s32 count)
	SetTouchScreenAutoPilotState.

Result	hiddbgUnsetTouchScreenAutoPilotState (void)
	UnsetTouchScreenAutoPilotState.

Result	hiddbgSetMouseAutoPilotState (const HiddbgMouseAutoPilotState *state)
	SetMouseAutoPilotState.

Result	hiddbgUnsetMouseAutoPilotState (void)
	UnsetMouseAutoPilotState.

Result	hiddbgSetKeyboardAutoPilotState (const HiddbgKeyboardAutoPilotState *state)
	SetKeyboardAutoPilotState.

Result	hiddbgUnsetKeyboardAutoPilotState (void)
	UnsetKeyboardAutoPilotState.

Result	hiddbgDeactivateHomeButton (void)
	Deactivates the HomeButton.

Result	hiddbgSetSleepButtonAutoPilotState (const HiddbgSleepButtonAutoPilotState *state)
	SetSleepButtonAutoPilotState.

Result	hiddbgUnsetSleepButtonAutoPilotState (void)
	UnsetSleepButtonAutoPilotState.

Result	hiddbgUpdateControllerColor (u32 colorBody, u32 colorButtons, HidsysUniquePadId unique_pad_id)
	Writes the input RGB colors to the spi-flash for the specified UniquePad (offset 0x6050 size 0x6).

Result	hiddbgUpdateDesignInfo (u32 colorBody, u32 colorButtons, u32 colorLeftGrip, u32 colorRightGrip, u8 inval, HidsysUniquePadId unique_pad_id)
	Writes the input RGB colors followed by inval to the spi-flash for the specified UniquePad (offset 0x6050 size 0xD).

Result	hiddbgAcquireOperationEventHandle (Event *out_event, bool autoclear, HidsysUniquePadId unique_pad_id)
	Get the OperationEvent for the specified UniquePad.

Result	hiddbgReadSerialFlash (u32 offset, void *buffer, size_t size, HidsysUniquePadId unique_pad_id)
	Reads spi-flash for the specified UniquePad.

Result	hiddbgWriteSerialFlash (u32 offset, void *buffer, size_t tmem_size, size_t size, HidsysUniquePadId unique_pad_id)
	Writes spi-flash for the specified UniquePad.

Result	hiddbgGetOperationResult (HidsysUniquePadId unique_pad_id)
	Get the Result for the Operation and handles cleanup, for the specified UniquePad.

Result	hiddbgGetUniquePadDeviceTypeSetInternal (HidsysUniquePadId unique_pad_id, u32 *out)
	Gets the internal DeviceType for the specified controller.

AbstractedPad
This is for virtual HID controllers. Only use this on pre-7.0.0, Hdls should be used otherwise.
Result	hiddbgGetAbstractedPadHandles (HiddbgAbstractedPadHandle handles, s32 count, s32 total_out)
	Gets a list of HiddbgAbstractedPadHandle.

Result	hiddbgGetAbstractedPadState (HiddbgAbstractedPadHandle handle, HiddbgAbstractedPadState *state)
	Gets the state for the specified HiddbgAbstractedPadHandle.

Result	hiddbgGetAbstractedPadsState (HiddbgAbstractedPadHandle handles, HiddbgAbstractedPadState states, s32 count, s32 *total_out)
	Similar to hiddbgGetAbstractedPadHandles except this also returns the state for each pad in output array states.

Result	hiddbgSetAutoPilotVirtualPadState (s8 AbstractedVirtualPadId, const HiddbgAbstractedPadState *state)
	Sets AutoPilot state for the specified pad.

Result	hiddbgUnsetAutoPilotVirtualPadState (s8 AbstractedVirtualPadId)
	Clears AutoPilot state for the specified pad set by hiddbgSetAutoPilotVirtualPadState.

Result	hiddbgUnsetAllAutoPilotVirtualPadState (void)
	Clears AutoPilot state for all pads set by hiddbgSetAutoPilotVirtualPadState.

Hdls
This is for virtual HID controllers.
Result	hiddbgAttachHdlsWorkBuffer (HiddbgHdlsSessionId session_id, void buffer, size_t size)
	Initialize Hdls.

Result	hiddbgReleaseHdlsWorkBuffer (HiddbgHdlsSessionId session_id)
	Exit Hdls, must be called at some point prior to hiddbgExit.

Result	hiddbgIsHdlsVirtualDeviceAttached (HiddbgHdlsSessionId session_id, HiddbgHdlsHandle handle, bool *out)
	Checks if the given device is still attached.

Result	hiddbgDumpHdlsNpadAssignmentState (HiddbgHdlsSessionId session_id, HiddbgHdlsNpadAssignment *state)
	Gets state for HiddbgHdlsNpadAssignment.

Result	hiddbgDumpHdlsStates (HiddbgHdlsSessionId session_id, HiddbgHdlsStateList *state)
	Gets state for HiddbgHdlsStateList.

Result	hiddbgApplyHdlsNpadAssignmentState (HiddbgHdlsSessionId session_id, const HiddbgHdlsNpadAssignment *state, bool flag)
	Sets state for HiddbgHdlsNpadAssignment.

Result	hiddbgApplyHdlsStateList (HiddbgHdlsSessionId session_id, const HiddbgHdlsStateList *state)
	Sets state for HiddbgHdlsStateList.

Result	hiddbgAttachHdlsVirtualDevice (HiddbgHdlsHandle handle, const HiddbgHdlsDeviceInfo info)
	Attach a device with the input info.

Result	hiddbgDetachHdlsVirtualDevice (HiddbgHdlsHandle handle)
	Detach the specified device.

Result	hiddbgSetHdlsState (HiddbgHdlsHandle handle, const HiddbgHdlsState *state)
	Sets state for the specified device.

Detailed Description

hid:dbg service IPC wrapper.

Author: yellows8

Enumeration Type Documentation

◆ HiddbgHdlsAttribute

enum HiddbgHdlsAttribute

HdlsAttribute.

Enumerator
HiddbgHdlsAttribute_HasVirtualSixAxisSensorAcceleration	HasVirtualSixAxisSensorAcceleration.
HiddbgHdlsAttribute_HasVirtualSixAxisSensorAngle	HasVirtualSixAxisSensorAngle.

◆ HiddbgNpadButton

enum HiddbgNpadButton

HiddbgNpadButton. For the remaining buttons, see HidNpadButton.

Enumerator
HiddbgNpadButton_Home	HOME button.
HiddbgNpadButton_Capture	Capture button.

Function Documentation

◆ hiddbgAcquireOperationEventHandle()

Result hiddbgAcquireOperationEventHandle	(	Event *	out_event,
		bool	autoclear,
		HidsysUniquePadId	unique_pad_id
	)

Get the OperationEvent for the specified UniquePad.

Note: The Event must be closed by the user once finished with it.; Only available with [6.0.0+].

Parameters

[out]	out_event	Output Event.
[in]	autoclear	The autoclear for the Event.
[in]	unique_pad_id	HidsysUniquePadId

◆ hiddbgApplyHdlsNpadAssignmentState()

Result hiddbgApplyHdlsNpadAssignmentState	(	HiddbgHdlsSessionId	session_id,
		const HiddbgHdlsNpadAssignment *	state,
		bool	flag
	)

Sets state for HiddbgHdlsNpadAssignment.

Note: Only available with [7.0.0+].

Parameters

[in]	session_id	[13.0.0+] HiddbgHdlsSessionId
[in]	state	HiddbgHdlsNpadAssignment
[in]	flag	Flag

◆ hiddbgApplyHdlsStateList()

Result hiddbgApplyHdlsStateList	(	HiddbgHdlsSessionId	session_id,
		const HiddbgHdlsStateList *	state
	)

Sets state for HiddbgHdlsStateList.

Note: The HiddbgHdlsState will be applied for each HiddbgHdlsHandle. If a HiddbgHdlsHandle is not found, code similar to hiddbgAttachHdlsVirtualDevice will run with the HiddbgHdlsDeviceInfo, then it will continue with applying state with the new device.; Only available with [7.0.0+].

Parameters

[in]	session_id	[13.0.0+] HiddbgHdlsSessionId
[in]	state	HiddbgHdlsStateList

◆ hiddbgAttachHdlsVirtualDevice()

Result hiddbgAttachHdlsVirtualDevice	(	HiddbgHdlsHandle *	handle,
		const HiddbgHdlsDeviceInfo *	info
	)

Attach a device with the input info.

Note: Only available with [7.0.0+].

Parameters

[out]	handle	HiddbgHdlsHandle
[in]	info	HiddbgHdlsDeviceInfo

◆ hiddbgAttachHdlsWorkBuffer()

Result hiddbgAttachHdlsWorkBuffer	(	HiddbgHdlsSessionId *	session_id,
		void *	buffer,
		size_t	size
	)

Initialize Hdls.

Note: Only available with [7.0.0+].

Parameters

[out]	session_id	[13.0.0+] HiddbgHdlsSessionId
[in]	buffer	An existing buffer to be used as transfer memory.
[in]	size	Size of the supplied buffer.

◆ hiddbgDetachHdlsVirtualDevice()

Result hiddbgDetachHdlsVirtualDevice ( HiddbgHdlsHandle handle )

Detach the specified device.

Note: Only available with [7.0.0+].

Parameters

[in] handle HiddbgHdlsHandle

◆ hiddbgDumpHdlsNpadAssignmentState()

Result hiddbgDumpHdlsNpadAssignmentState	(	HiddbgHdlsSessionId	session_id,
		HiddbgHdlsNpadAssignment *	state
	)

Gets state for HiddbgHdlsNpadAssignment.

Note: Only available with [7.0.0+].

Parameters

[in]	session_id	[13.0.0+] HiddbgHdlsSessionId
[out]	state	HiddbgHdlsNpadAssignment

◆ hiddbgDumpHdlsStates()

Result hiddbgDumpHdlsStates	(	HiddbgHdlsSessionId	session_id,
		HiddbgHdlsStateList *	state
	)

Gets state for HiddbgHdlsStateList.

Note: Only available with [7.0.0+].

Parameters

[in]	session_id	[13.0.0+] HiddbgHdlsSessionId
[out]	state	HiddbgHdlsStateList

◆ hiddbgGetAbstractedPadHandles()

Result hiddbgGetAbstractedPadHandles	(	HiddbgAbstractedPadHandle *	handles,
		s32	count,
		s32 *	total_out
	)

Gets a list of HiddbgAbstractedPadHandle.

Note: Only available with [5.0.0-8.1.0].

Parameters

[out]	handles	Output array of HiddbgAbstractedPadHandle.
[in]	count	Max number of entries for the handles array.
[out]	total_out	Total output entries.

◆ hiddbgGetAbstractedPadsState()

Result hiddbgGetAbstractedPadsState	(	HiddbgAbstractedPadHandle *	handles,
		HiddbgAbstractedPadState *	states,
		s32	count,
		s32 *	total_out
	)

Similar to hiddbgGetAbstractedPadHandles except this also returns the state for each pad in output array states.

Note: Only available with [5.0.0-8.1.0].

Parameters

[out]	handles	Output array of HiddbgAbstractedPadHandle.
[out]	states	Output array of HiddbgAbstractedPadState.
[in]	count	Max number of entries for the handles/states arrays.
[out]	total_out	Total output entries.

◆ hiddbgGetAbstractedPadState()

Result hiddbgGetAbstractedPadState	(	HiddbgAbstractedPadHandle	handle,
		HiddbgAbstractedPadState *	state
	)

Gets the state for the specified HiddbgAbstractedPadHandle.

Note: Only available with [5.0.0-8.1.0].

Parameters

[in]	handle	HiddbgAbstractedPadHandle
[out]	state	HiddbgAbstractedPadState

◆ hiddbgGetOperationResult()

Result hiddbgGetOperationResult ( HidsysUniquePadId unique_pad_id )

Get the Result for the Operation and handles cleanup, for the specified UniquePad.

Note: Only available with [6.0.0+].

Parameters

[in] unique_pad_id HidsysUniquePadId

◆ hiddbgGetUniquePadDeviceTypeSetInternal()

Result hiddbgGetUniquePadDeviceTypeSetInternal	(	HidsysUniquePadId	unique_pad_id,
		u32 *	out
	)

Gets the internal DeviceType for the specified controller.

Note: Only available with [6.0.0+].

Parameters

[in]	unique_pad_id	HidsysUniquePadId
[out]	out	Pre-9.0.0 this is an u32, with [9.0.0+] it's an u8.

◆ hiddbgIsHdlsVirtualDeviceAttached()

Result hiddbgIsHdlsVirtualDeviceAttached	(	HiddbgHdlsSessionId	session_id,
		HiddbgHdlsHandle	handle,
		bool *	out
	)

Checks if the given device is still attached.

Note: Only available with [7.0.0+].

Parameters

[in]	session_id	[13.0.0+] HiddbgHdlsSessionId
[in]	handle	HiddbgHdlsHandle
[out]	out	Whether the device is attached.

◆ hiddbgReadSerialFlash()

Result hiddbgReadSerialFlash	(	u32	offset,
		void *	buffer,
		size_t	size,
		HidsysUniquePadId	unique_pad_id
	)

Reads spi-flash for the specified UniquePad.

Note: This also uses hiddbgAcquireOperationEventHandle to wait for the operation to finish, then hiddbgGetOperationResult is used.; Only available with [6.0.0+].

Parameters

[in]	offset	Offset in spi-flash.
[out]	buffer	Output buffer.
[in]	size	Output buffer size.
[in]	unique_pad_id	HidsysUniquePadId

◆ hiddbgReleaseHdlsWorkBuffer()

Result hiddbgReleaseHdlsWorkBuffer ( HiddbgHdlsSessionId session_id )

Exit Hdls, must be called at some point prior to hiddbgExit.

Note: Only available with [7.0.0+].

Parameters

[in] session_id [13.0.0+] HiddbgHdlsSessionId

◆ hiddbgSetAutoPilotVirtualPadState()

Result hiddbgSetAutoPilotVirtualPadState	(	s8	AbstractedVirtualPadId,
		const HiddbgAbstractedPadState *	state
	)

Sets AutoPilot state for the specified pad.

Note: Only available with [5.0.0-8.1.0].

Parameters

[in]	AbstractedVirtualPadId	This can be any unique value as long as it's within bounds. For example, 0-7 is usable.
[in]	state	HiddbgAbstractedPadState

◆ hiddbgSetDebugPadAutoPilotState()

Result hiddbgSetDebugPadAutoPilotState ( const HiddbgDebugPadAutoPilotState * state )

SetDebugPadAutoPilotState.

Parameters

[in] state HiddbgDebugPadAutoPilotState

◆ hiddbgSetHdlsState()

Result hiddbgSetHdlsState	(	HiddbgHdlsHandle	handle,
		const HiddbgHdlsState *	state
	)

Sets state for the specified device.

Note: Only available with [7.0.0+].

Parameters

[in]	handle	HiddbgHdlsHandle
[in]	state	HiddbgHdlsState

◆ hiddbgSetKeyboardAutoPilotState()

Result hiddbgSetKeyboardAutoPilotState ( const HiddbgKeyboardAutoPilotState * state )

SetKeyboardAutoPilotState.

Parameters

[in] state HiddbgKeyboardAutoPilotState

◆ hiddbgSetMouseAutoPilotState()

Result hiddbgSetMouseAutoPilotState ( const HiddbgMouseAutoPilotState * state )

SetMouseAutoPilotState.

Parameters

[in] state HiddbgMouseAutoPilotState

◆ hiddbgSetSleepButtonAutoPilotState()

Result hiddbgSetSleepButtonAutoPilotState ( const HiddbgSleepButtonAutoPilotState * state )

SetSleepButtonAutoPilotState.

Parameters

[in] state HiddbgSleepButtonAutoPilotState

◆ hiddbgSetTouchScreenAutoPilotState()

Result hiddbgSetTouchScreenAutoPilotState	(	const HidTouchState *	states,
		s32	count
	)

SetTouchScreenAutoPilotState.

Parameters

[in]	states	Input array of HiddbgMouseAutoPilotState.
[in]	count	Total entries in the states array. Max is 16.

◆ hiddbgUnsetAutoPilotVirtualPadState()

Result hiddbgUnsetAutoPilotVirtualPadState ( s8 AbstractedVirtualPadId )

Clears AutoPilot state for the specified pad set by hiddbgSetAutoPilotVirtualPadState.

Note: Only available with [5.0.0-8.1.0].

Parameters

[in] AbstractedVirtualPadId Id from hiddbgSetAutoPilotVirtualPadState.

◆ hiddbgUpdateControllerColor()

Result hiddbgUpdateControllerColor	(	u32	colorBody,
		u32	colorButtons,
		HidsysUniquePadId	unique_pad_id
	)

Writes the input RGB colors to the spi-flash for the specified UniquePad (offset 0x6050 size 0x6).

Note: Only available with [3.0.0+].

Parameters

[in]	colorBody	RGB body color.
[in]	colorButtons	RGB buttons color.
[in]	unique_pad_id	HidsysUniquePadId

◆ hiddbgUpdateDesignInfo()

Result hiddbgUpdateDesignInfo	(	u32	colorBody,
		u32	colorButtons,
		u32	colorLeftGrip,
		u32	colorRightGrip,
		u8	inval,
		HidsysUniquePadId	unique_pad_id
	)

Writes the input RGB colors followed by inval to the spi-flash for the specified UniquePad (offset 0x6050 size 0xD).

Note: Only available with [5.0.0+].

Parameters

[in]	colorBody	RGB body color.
[in]	colorButtons	RGB buttons color.
[in]	colorLeftGrip	RGB left grip color.
[in]	colorRightGrip	RGB right grip color.
[in]	inval	Input value.
[in]	unique_pad_id	HidsysUniquePadId

◆ hiddbgWriteSerialFlash()

Result hiddbgWriteSerialFlash	(	u32	offset,
		void *	buffer,
		size_t	tmem_size,
		size_t	size,
		HidsysUniquePadId	unique_pad_id
	)

Writes spi-flash for the specified UniquePad.

Note: This also uses hiddbgAcquireOperationEventHandle to wait for the operation to finish, then hiddbgGetOperationResult is used.; Only available with [6.0.0+].

Parameters

[in]	offset	Offset in spi-flash.
[in]	buffer	Input buffer, must be 0x1000-byte aligned.
[in]	tmem_size	Size of the buffer, must be 0x1000-byte aligned.
[in]	size	Actual transfer size.
[in]	unique_pad_id	HidsysUniquePadId

Data Structures

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ HiddbgHdlsAttribute

◆ HiddbgNpadButton

Function Documentation

◆ hiddbgAcquireOperationEventHandle()

◆ hiddbgApplyHdlsNpadAssignmentState()

◆ hiddbgApplyHdlsStateList()

◆ hiddbgAttachHdlsVirtualDevice()

◆ hiddbgAttachHdlsWorkBuffer()

◆ hiddbgDetachHdlsVirtualDevice()

◆ hiddbgDumpHdlsNpadAssignmentState()

◆ hiddbgDumpHdlsStates()

◆ hiddbgGetAbstractedPadHandles()

◆ hiddbgGetAbstractedPadsState()

◆ hiddbgGetAbstractedPadState()

◆ hiddbgGetOperationResult()

◆ hiddbgGetUniquePadDeviceTypeSetInternal()

◆ hiddbgIsHdlsVirtualDeviceAttached()

◆ hiddbgReadSerialFlash()

◆ hiddbgReleaseHdlsWorkBuffer()

◆ hiddbgSetAutoPilotVirtualPadState()

◆ hiddbgSetDebugPadAutoPilotState()

◆ hiddbgSetHdlsState()

◆ hiddbgSetKeyboardAutoPilotState()

◆ hiddbgSetMouseAutoPilotState()

◆ hiddbgSetSleepButtonAutoPilotState()

◆ hiddbgSetTouchScreenAutoPilotState()

◆ hiddbgUnsetAutoPilotVirtualPadState()

◆ hiddbgUpdateControllerColor()

◆ hiddbgUpdateDesignInfo()

◆ hiddbgWriteSerialFlash()