uart.h File Reference

UART service IPC wrapper. More...

#include "../types.h"
#include "../kernel/event.h"
#include "../sf/service.h"

Go to the source code of this file.

Data Structures
struct	UartPortSession
	PortSession. More...

Enumerations
enum	UartPort {   UartPort_Bluetooth = 1 ,   UartPort_JoyConR = 2 ,   UartPort_JoyConL = 3 ,   UartPort_MCU = 4 }
	UartPort. More...
enum	UartPortForDev {   UartPortForDev_JoyConR = 1 ,   UartPortForDev_JoyConL = 2 ,   UartPortForDev_Bluetooth = 3 }
	UartPortForDev. More...
enum	UartFlowControlMode {   UartFlowControlMode_None = 0 ,   UartFlowControlMode_Hardware = 1 }
	FlowControlMode. More...
enum	UartPortEventType {   UartPortEventType_SendBufferEmpty = 0 ,   UartPortEventType_SendBufferReady = 1 ,   UartPortEventType_ReceiveBufferReady = 2 ,   UartPortEventType_ReceiveEnd = 3 }
	PortEventType. More...

Functions
Result	uartInitialize (void)
	Initialize uart.
void	uartExit (void)
	Exit uart.
Service *	uartGetServiceSession (void)
	Gets the Service object for the actual uart service session.
Result	uartHasPort (UartPort port, bool *out)
	HasPort.
Result	uartHasPortForDev (UartPortForDev port, bool *out)
	HasPortForDev.
Result	uartIsSupportedBaudRate (UartPort port, u32 baud_rate, bool *out)
	IsSupportedBaudRate.
Result	uartIsSupportedBaudRateForDev (UartPortForDev port, u32 baud_rate, bool *out)
	IsSupportedBaudRateForDev.
Result	uartIsSupportedFlowControlMode (UartPort port, UartFlowControlMode flow_control_mode, bool *out)
	IsSupportedFlowControlMode.
Result	uartIsSupportedFlowControlModeForDev (UartPortForDev port, UartFlowControlMode flow_control_mode, bool *out)
	IsSupportedFlowControlModeForDev.
Result	uartCreatePortSession (UartPortSession *s)
	Creates an UartPortSession.
Result	uartIsSupportedPortEvent (UartPort port, UartPortEventType port_event_type, bool *out)
	IsSupportedPortEvent.
Result	uartIsSupportedPortEventForDev (UartPortForDev port, UartPortEventType port_event_type, bool *out)
	IsSupportedPortEventForDev.
Result	uartIsSupportedDeviceVariation (UartPort port, u32 device_variation, bool *out)
	IsSupportedDeviceVariation.
Result	uartIsSupportedDeviceVariationForDev (UartPortForDev port, u32 device_variation, bool *out)
	IsSupportedDeviceVariationForDev.
IPortSession
void	uartPortSessionClose (UartPortSession *s)
	Close an UartPortSession.
Result	uartPortSessionOpenPort (UartPortSession *s, bool *out, UartPort port, u32 baud_rate, UartFlowControlMode flow_control_mode, u32 device_variation, bool is_invert_tx, bool is_invert_rx, bool is_invert_rts, bool is_invert_cts, void *send_buffer, u64 send_buffer_length, void *receive_buffer, u64 receive_buffer_length)
	OpenPort.
Result	uartPortSessionOpenPortForDev (UartPortSession *s, bool *out, UartPortForDev port, u32 baud_rate, UartFlowControlMode flow_control_mode, u32 device_variation, bool is_invert_tx, bool is_invert_rx, bool is_invert_rts, bool is_invert_cts, void *send_buffer, u64 send_buffer_length, void *receive_buffer, u64 receive_buffer_length)
	OpenPortForDev.
Result	uartPortSessionGetWritableLength (UartPortSession *s, u64 *out)
	GetWritableLength.
Result	uartPortSessionSend (UartPortSession *s, const void *in_data, size_t size, u64 *out)
	Send.
Result	uartPortSessionGetReadableLength (UartPortSession *s, u64 *out)
	GetReadableLength.
Result	uartPortSessionReceive (UartPortSession *s, void *out_data, size_t size, u64 *out)
	Receive.
Result	uartPortSessionBindPortEvent (UartPortSession *s, UartPortEventType port_event_type, s64 threshold, bool *out, Event *out_event)
	BindPortEvent.
Result	uartPortSessionUnbindPortEvent (UartPortSession *s, UartPortEventType port_event_type, bool *out)
	UnbindPortEvent.

Detailed Description

UART service IPC wrapper.

Author

yellows8

Copyright

libnx Authors

Enumeration Type Documentation

UartFlowControlMode

enum UartFlowControlMode

FlowControlMode.

Enumerator
UartFlowControlMode_None	None.
UartFlowControlMode_Hardware	Hardware.

UartPort

enum UartPort

UartPort.

Enumerator
UartPort_Bluetooth	Bluetooth.
UartPort_JoyConR	Joy-Con(R)
UartPort_JoyConL	Joy-Con(L)
UartPort_MCU	MCU.

UartPortEventType

enum UartPortEventType

PortEventType.

Enumerator
UartPortEventType_SendBufferEmpty	SendBufferEmpty.
UartPortEventType_SendBufferReady	SendBufferReady.
UartPortEventType_ReceiveBufferReady	ReceiveBufferReady.
UartPortEventType_ReceiveEnd	ReceiveEnd.

UartPortForDev

enum UartPortForDev

UartPortForDev.

Enumerator
UartPortForDev_JoyConR	Joy-Con(R)
UartPortForDev_JoyConL	Joy-Con(L)
UartPortForDev_Bluetooth	Bluetooth.

Function Documentation

uartCreatePortSession()

Result uartCreatePortSession

(

UartPortSession *

s

)

Creates an UartPortSession.

Note

Use uartPortSessionOpenPort or uartPortSessionOpenPortForDev before using any other cmds.

Parameters

[out]

s

UartPortSession

uartHasPort()

Result uartHasPort	(	UartPort	port,
		bool *	out
	)

HasPort.

Note

Only available on [1.0.0-16.1.0].

Parameters

[in]	port	UartPort
[out]	out	Output success flag.

uartHasPortForDev()

Result uartHasPortForDev	(	UartPortForDev	port,
		bool *	out
	)

HasPortForDev.

Note

Only available on [1.0.0-16.1.0].

Parameters

[in]	port	UartPortForDev
[out]	out	Output success flag.

uartIsSupportedBaudRate()

Result uartIsSupportedBaudRate	(	UartPort	port,
		u32	baud_rate,
		bool *	out
	)

IsSupportedBaudRate.

Note

Only available on [1.0.0-16.1.0].

Parameters

[in]	port	UartPort
[in]	baud_rate	BaudRate
[out]	out	Output success flag.

uartIsSupportedBaudRateForDev()

Result uartIsSupportedBaudRateForDev	(	UartPortForDev	port,
		u32	baud_rate,
		bool *	out
	)

IsSupportedBaudRateForDev.

Note

Only available on [1.0.0-16.1.0].

Parameters

[in]	port	UartPortForDev
[in]	baud_rate	BaudRate
[out]	out	Output success flag.

uartIsSupportedDeviceVariation()

Result uartIsSupportedDeviceVariation	(	UartPort	port,
		u32	device_variation,
		bool *	out
	)

IsSupportedDeviceVariation.

Note

Only available on [7.0.0-16.1.0].

Parameters

[in]	port	UartPort
[in]	device_variation	DeviceVariation
[out]	out	Output success flag.

uartIsSupportedDeviceVariationForDev()

Result uartIsSupportedDeviceVariationForDev	(	UartPortForDev	port,
		u32	device_variation,
		bool *	out
	)

IsSupportedDeviceVariationForDev.

Note

Only available on [7.0.0-16.1.0].

Parameters

[in]	port	UartPortForDev
[in]	device_variation	DeviceVariation
[out]	out	Output success flag.

uartIsSupportedFlowControlMode()

Result uartIsSupportedFlowControlMode	(	UartPort	port,
		UartFlowControlMode	flow_control_mode,
		bool *	out
	)

IsSupportedFlowControlMode.

Note

Only available on [1.0.0-16.1.0].

Parameters

[in]	port	UartPort
[in]	flow_control_mode	UartFlowControlMode
[out]	out	Output success flag.

uartIsSupportedFlowControlModeForDev()

Result uartIsSupportedFlowControlModeForDev	(	UartPortForDev	port,
		UartFlowControlMode	flow_control_mode,
		bool *	out
	)

IsSupportedFlowControlModeForDev.

Note

Only available on [1.0.0-16.1.0].

Parameters

[in]	port	UartPortForDev
[in]	flow_control_mode	UartFlowControlMode
[out]	out	Output success flag.

uartIsSupportedPortEvent()

Result uartIsSupportedPortEvent	(	UartPort	port,
		UartPortEventType	port_event_type,
		bool *	out
	)

IsSupportedPortEvent.

Note

Only available on [1.0.0-16.1.0].

Parameters

[in]	port	UartPort
[in]	port_event_type	UartPortEventType
[out]	out	Output success flag.

uartIsSupportedPortEventForDev()

Result uartIsSupportedPortEventForDev	(	UartPortForDev	port,
		UartPortEventType	port_event_type,
		bool *	out
	)

IsSupportedPortEventForDev.

Note

Only available on [1.0.0-16.1.0].

Parameters

[in]	port	UartPortForDev
[in]	port_event_type	UartPortEventType
[out]	out	Output success flag.

uartPortSessionBindPortEvent()

Result uartPortSessionBindPortEvent	(	UartPortSession *	s,
		UartPortEventType	port_event_type,
		s64	threshold,
		bool *	out,
		Event *	out_event
	)

BindPortEvent.

Note

The Event must be closed by the user after using uartPortSessionUnbindPortEvent.

Parameters

	s	UartPortSession
[in]	port_event_type	UartPortEventType
[in]	threshold	Threshold
[out]	out	Output success flag.
[out]	out_event	Output Event with autoclear=false.

uartPortSessionClose()

void uartPortSessionClose

(

UartPortSession *

s

)

Close an UartPortSession.

Parameters

s	UartPortSession

uartPortSessionGetReadableLength()

Result uartPortSessionGetReadableLength	(	UartPortSession *	s,
		u64 *	out
	)

GetReadableLength.

Parameters

	s	UartPortSession
[out]	out	Output ReadableLength.

uartPortSessionGetWritableLength()

Result uartPortSessionGetWritableLength	(	UartPortSession *	s,
		u64 *	out
	)

GetWritableLength.

Parameters

	s	UartPortSession
[out]	out	Output WritableLength.

uartPortSessionOpenPort()

Result uartPortSessionOpenPort	(	UartPortSession *	s,
		bool *	out,
		UartPort	port,
		u32	baud_rate,
		UartFlowControlMode	flow_control_mode,
		u32	device_variation,
		bool	is_invert_tx,
		bool	is_invert_rx,
		bool	is_invert_rts,
		bool	is_invert_cts,
		void *	send_buffer,
		u64	send_buffer_length,
		void *	receive_buffer,
		u64	receive_buffer_length
	)

OpenPort.

Note

This is not usable when the specified UartPort is already being used.

Parameters

	s	UartPortSession
[out]	out	Output success flag.
[in]	port	UartPort
[in]	baud_rate	BaudRate
[in]	flow_control_mode	UartFlowControlMode
[in]	device_variation	[7.0.0+] DeviceVariation
[in]	is_invert_tx	[6.0.0+] IsInvertTx
[in]	is_invert_rx	[6.0.0+] IsInvertRx
[in]	is_invert_rts	[6.0.0+] IsInvertRts
[in]	is_invert_cts	[6.0.0+] IsInvertCts
[in]	send_buffer	Send buffer, must be 0x1000-byte aligned.
[in]	send_buffer_length	Send buffer size, must be 0x1000-byte aligned.
[in]	receive_buffer	Receive buffer, must be 0x1000-byte aligned.
[in]	receive_buffer_length	Receive buffer size, must be 0x1000-byte aligned.

uartPortSessionOpenPortForDev()

Result uartPortSessionOpenPortForDev	(	UartPortSession *	s,
		bool *	out,
		UartPortForDev	port,
		u32	baud_rate,
		UartFlowControlMode	flow_control_mode,
		u32	device_variation,
		bool	is_invert_tx,
		bool	is_invert_rx,
		bool	is_invert_rts,
		bool	is_invert_cts,
		void *	send_buffer,
		u64	send_buffer_length,
		void *	receive_buffer,
		u64	receive_buffer_length
	)

OpenPortForDev.

Note

See the notes for uartPortSessionOpenPort.

Parameters

	s	UartPortSession
[out]	out	Output success flag.
[in]	port	UartPortForDev
[in]	baud_rate	BaudRate
[in]	flow_control_mode	UartFlowControlMode
[in]	device_variation	[7.0.0+] DeviceVariation
[in]	is_invert_tx	[6.0.0+] IsInvertTx
[in]	is_invert_rx	[6.0.0+] IsInvertRx
[in]	is_invert_rts	[6.0.0+] IsInvertRts
[in]	is_invert_cts	[6.0.0+] IsInvertCts
[in]	send_buffer	Send buffer, must be 0x1000-byte aligned.
[in]	send_buffer_length	Send buffer size, must be 0x1000-byte aligned.
[in]	receive_buffer	Receive buffer, must be 0x1000-byte aligned.
[in]	receive_buffer_length	Receive buffer size, must be 0x1000-byte aligned.

uartPortSessionReceive()

Result uartPortSessionReceive	(	UartPortSession *	s,
		void *	out_data,
		size_t	size,
		u64 *	out
	)

Receive.

Parameters

	s	UartPortSession
[out]	out_data	Output data buffer.
[in]	size	Output data buffer size.
[out]	out	Output size.

uartPortSessionSend()

Result uartPortSessionSend	(	UartPortSession *	s,
		const void *	in_data,
		size_t	size,
		u64 *	out
	)

Send.

Parameters

	s	UartPortSession
[in]	in_data	Input data buffer.
[in]	size	Input data buffer size.
[out]	out	Output size.

uartPortSessionUnbindPortEvent()

Result uartPortSessionUnbindPortEvent	(	UartPortSession *	s,
		UartPortEventType	port_event_type,
		bool *	out
	)

UnbindPortEvent.

Parameters

	s	UartPortSession
[in]	port_event_type	UartPortEventType
[out]	out	Output success flag.