ringcon.h File Reference

Wrapper for using the Ring-Con attached to a Joy-Con, with hidbus. More...

#include "../types.h"
#include "../services/hidbus.h"

Go to the source code of this file.

Data Structures
struct	RingConFwVersion
	Ring-Con firmware version. More...
struct	RingConManuCal
	Ring-Con manufacturer calibration. More...
struct	RingConUserCal
	Ring-Con user calibration. More...
struct	RingConPollingData
	Polling data extracted from HidbusJoyPollingReceivedData. More...
struct	RingCon
	Ring-Con state object. More...

Macros
#define	RINGCON_CAL_MAGIC   -0x3502

Enumerations
enum	RingConDataValid {   RingConDataValid_Ok = 0 ,   RingConDataValid_CRC = 1 ,   RingConDataValid_Cal = 2 }
	Whether the output data is valid. More...
enum	RingConErrorFlag {   RingConErrorFlag_BadUserCalUpdate = 0 ,   RingConErrorFlag_BadFlag = 4 ,   RingConErrorFlag_BadUserCal = 5 ,   RingConErrorFlag_BadManuCal = 6 }

Functions
Result	ringconCreate (RingCon *c, HidNpadIdType id)
	Creates a RingCon object, and handles the various initialization for it.
void	ringconClose (RingCon *c)
	Close a RingCon.
static u32	ringconGetErrorFlags (RingCon *c)
	Gets the error flags field.
static bool	ringconGetErrorFlag (RingCon *c, RingConErrorFlag flag)
	Gets the value of an error flag, set by ringconSetErrorFlag.
static RingConFwVersion	ringconGetFwVersion (RingCon *c)
	Gets the RingConFwVersion previously loaded by ringconCreate.
static void	ringconGetId (RingCon *c, u64 *id_l, u64 *id_h)
	Gets the Id previously loaded by ringconCreate.
static s16	ringconGetUnkCal (RingCon *c)
	Gets the unk_cal previously loaded by ringconCreate with ringconReadUnkCal.
static s32	ringconGetTotalPushCount (RingCon *c)
	Gets the total-push-count previously loaded by ringconCreate.
static void	ringconGetManuCal (RingCon *c, RingConManuCal *out)
	Gets the RingConManuCal previously loaded by ringconCreate.
static void	ringconGetUserCal (RingCon *c, RingConUserCal *out)
	Gets the RingConUserCal previously loaded by ringconCreate.
Result	ringconUpdateUserCal (RingCon *c, RingConUserCal cal)
	Updates the RingConUserCal.
Result	ringconReadFwVersion (RingCon *c, RingConFwVersion *out)
	Reads the RingConFwVersion.
Result	ringconReadId (RingCon *c, u64 *id_l, u64 *id_h)
	Reads the Id.
Result	ringconGetPollingData (RingCon *c, RingConPollingData *out, s32 count, s32 *total_out)
	Gets the RingConPollingData.
Result	ringconCmdx00020105 (RingCon *c, u32 *out)
	Uses cmd 0x00020105.
Result	ringconReadManuCal (RingCon *c, RingConManuCal *out)
	Reads the RingConManuCal.
Result	ringconReadUnkCal (RingCon *c, s16 *out)
	Gets the unknown value derived from the output of cmd 0x00020504 and ringconReadManuCal.
Result	ringconReadUserCal (RingCon *c, RingConUserCal *out)
	Reads the RingConUserCal.
Result	ringconReadRepCount (RingCon *c, s32 *out, RingConDataValid *data_valid)
	Reads the rep-count for Multitask Mode.
Result	ringconReadTotalPushCount (RingCon *c, s32 *out, RingConDataValid *data_valid)
	Reads the total-push-count, for Multitask Mode.
Result	ringconResetRepCount (RingCon *c)
	This resets the value returned by ringconReadRepCount to 0.
Result	ringconWriteUserCal (RingCon *c, RingConUserCal cal)
	Writes the RingConUserCal.

Detailed Description

Wrapper for using the Ring-Con attached to a Joy-Con, with hidbus.

See also: https://switchbrew.org/wiki/Ring-Con

Author

yellows8

Copyright

libnx Authors

Enumeration Type Documentation

RingConDataValid

enum RingConDataValid

Whether the output data is valid.

Enumerator
RingConDataValid_Ok	Valid.
RingConDataValid_CRC	Bad CRC.
RingConDataValid_Cal	Only used with ringconReadUserCal. Calibration is needed via ringconUpdateUserCal.

RingConErrorFlag

enum RingConErrorFlag

Enumerator
RingConErrorFlag_BadUserCalUpdate	The output from ringconReadUserCal doesn't match the input used with ringconWriteUserCal, or the RingConDataValid is not RingConDataValid_Ok.
RingConErrorFlag_BadFlag	The output flag from ringconCmdx00020105 when successful is invalid.
RingConErrorFlag_BadUserCal	BadUserCal.
RingConErrorFlag_BadManuCal	BadManuCal.

Function Documentation

ringconClose()

void ringconClose

(

RingCon *

c

)

Close a RingCon.

Parameters

c

RingCon

ringconCmdx00020105()

Result ringconCmdx00020105	(	RingCon *	c,
		u32 *	out
	)

Uses cmd 0x00020105.

Note

Used internally by ringconCreate.

Parameters

	c	RingCon
[out]	out	Output value.

ringconCreate()

Result ringconCreate	(	RingCon *	c,
		HidNpadIdType	id
	)

Creates a RingCon object, and handles the various initialization for it.

Parameters

	c	RingCon
[in]	id	HidNpadIdType. A Ring-Con must be attached to this controller.

ringconGetErrorFlag()

static bool ringconGetErrorFlag ( RingCon *  c, RingConErrorFlag  flag  )

inlinestatic

Gets the value of an error flag, set by ringconSetErrorFlag.

Parameters

	c	RingCon
[in]	flag	RingConErrorFlag

ringconGetErrorFlags()

static u32 ringconGetErrorFlags ( RingCon *  c )

inlinestatic

Gets the error flags field.

Parameters

c

RingCon

ringconGetFwVersion()

static RingConFwVersion ringconGetFwVersion ( RingCon *  c )

inlinestatic

Gets the RingConFwVersion previously loaded by ringconCreate.

Parameters

	c	RingCon
[out]	out	RingConFwVersion

ringconGetId()

static void ringconGetId ( RingCon *  c, u64 *  id_l, u64 *  id_h  )

inlinestatic

Gets the Id previously loaded by ringconCreate.

Parameters

	c	RingCon
[out]	id_l	Id low.
[out]	id_h	Id high.

ringconGetManuCal()

static void ringconGetManuCal ( RingCon *  c, RingConManuCal *  out  )

inlinestatic

Gets the RingConManuCal previously loaded by ringconCreate.

Parameters

	c	RingCon
[out]	out	RingConManuCal

ringconGetPollingData()

Result ringconGetPollingData	(	RingCon *	c,
		RingConPollingData *	out,
		s32	count,
		s32 *	total_out
	)

Gets the RingConPollingData.

Only returns entries which are new since the last time this was called (or if not previously called, all available entries up to count).

Parameters

	c	RingCon
[out]	out	Output array of RingConPollingData. Entry order is newest -> oldest.
[in]	count	Total size of the out array in entries, max value is 0x9.
[out]	total_out	Total output entries.

ringconGetTotalPushCount()

static s32 ringconGetTotalPushCount ( RingCon *  c )

inlinestatic

Gets the total-push-count previously loaded by ringconCreate.

Parameters

	c	RingCon
[out]	out	total_push_count

ringconGetUnkCal()

static s16 ringconGetUnkCal ( RingCon *  c )

inlinestatic

Gets the unk_cal previously loaded by ringconCreate with ringconReadUnkCal.

Only valid when the output flag from ringconCmdx00020105 is valid.

Parameters

c

RingCon

ringconGetUserCal()

static void ringconGetUserCal ( RingCon *  c, RingConUserCal *  out  )

inlinestatic

Gets the RingConUserCal previously loaded by ringconCreate.

Note

The Ring-Con UserCal doesn't seem to be calibrated normally?

Parameters

	c	RingCon
[out]	out	RingConUserCal

ringconReadFwVersion()

Result ringconReadFwVersion	(	RingCon *	c,
		RingConFwVersion *	out
	)

Reads the RingConFwVersion.

Note

This is used internally by ringconCreate. Normally you should use ringconGetFwVersion instead.

Parameters

	c	RingCon
[out]	out	RingConFwVersion

ringconReadId()

Result ringconReadId	(	RingCon *	c,
		u64 *	id_l,
		u64 *	id_h
	)

Reads the Id.

Note

This is used internally by ringconCreate. Normally you should use ringconGetId instead.

Parameters

	c	RingCon
[out]	id_l	Id low.
[out]	id_h	Id high.

ringconReadManuCal()

Result ringconReadManuCal	(	RingCon *	c,
		RingConManuCal *	out
	)

Reads the RingConManuCal.

Note

Used internally by ringconCreate and ringconReadUnkCal.

Parameters

	c	RingCon
[out]	out	RingConManuCal

ringconReadRepCount()

Result ringconReadRepCount	(	RingCon *	c,
		s32 *	out,
		RingConDataValid *	data_valid
	)

Reads the rep-count for Multitask Mode.

Parameters

	c	RingCon
[out]	out	Output value. Official sw using this clamps the output to range 0-500.
[out]	data_valid	RingConDataValid

ringconReadTotalPushCount()

Result ringconReadTotalPushCount	(	RingCon *	c,
		s32 *	out,
		RingConDataValid *	data_valid
	)

Reads the total-push-count, for Multitask Mode.

Note

Used internally by ringconCreate. Normally ringconGetTotalPushCount should be used instead.

Parameters

	c	RingCon
[out]	out	Output value.
[out]	data_valid	RingConDataValid

ringconReadUnkCal()

Result ringconReadUnkCal	(	RingCon *	c,
		s16 *	out
	)

Gets the unknown value derived from the output of cmd 0x00020504 and ringconReadManuCal.

Note

Used internally by ringconCreate.

Parameters

	c	RingCon
[out]	out	Output value.

ringconReadUserCal()

Result ringconReadUserCal	(	RingCon *	c,
		RingConUserCal *	out
	)

Reads the RingConUserCal.

Note

Used internally by ringconCreate and ringconUpdateUserCal.

Parameters

	c	RingCon
[out]	out	RingConUserCal

ringconResetRepCount()

Result ringconResetRepCount

(

RingCon *

c

)

This resets the value returned by ringconReadRepCount to 0.

Parameters

c

RingCon

ringconUpdateUserCal()

Result ringconUpdateUserCal	(	RingCon *	c,
		RingConUserCal	cal
	)

Updates the RingConUserCal.

Note

The input RingConUserCal is used with ringconWriteUserCal, and the output from ringconReadUserCal is verified with the input RingConUserCal. This does not update the RingConUserCal returned by ringconGetUserCal.

The Ring-Con UserCal doesn't seem to be calibrated normally?

Parameters

	c	RingCon
[in]	cal	RingConUserCal

ringconWriteUserCal()

Result ringconWriteUserCal	(	RingCon *	c,
		RingConUserCal	cal
	)

Writes the RingConUserCal.

Note

Used internally by ringconUpdateUserCal.

Parameters

	c	RingCon
[in]	cal	RingConUserCal