LDN (local network communications) IPC wrapper. More...

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

Data Structures
struct	LdnIpv4Address
	Ipv4Address. This is essentially the same as struct in_addr - hence this can be used with standard sockets (byteswap required). More...

struct	LdnSubnetMask
	SubnetMask. This is essentially the same as struct in_addr - hence this can be used with standard sockets (byteswap required). More...

struct	LdnMacAddress
	MacAddress. More...

struct	LdnSsid
	Ssid. More...

struct	LdnNodeLatestUpdate
	NodeLatestUpdate. More...

struct	LdnAddressEntry
	AddressEntry. More...

struct	LdnNodeInfo
	NodeInfo. More...

struct	LdnUserConfig
	UserConfig. The input struct is copied to a tmp struct, which is then used with the cmd. More...

struct	LdnNetworkInfo
	NetworkInfo. More...

struct	LdnScanFilter
	ScanFilter. The input struct is copied to a tmp struct, which is then used with the cmd (ldnScan and ldnScanPrivate). More...

struct	LdnSecurityConfig
	SecurityConfig. More...

struct	LdnSecurityParameter
	SecurityParameter. The struct used by ldnCreateNetwork internally is randomly-generated. More...

struct	LdnNetworkConfig
	NetworkConfig. The input struct is copied to a tmp struct, which is then used with the cmd (ldnCreateNetwork, ldnCreateNetworkPrivate, ldnConnectPrivate). More...

Enumerations
enum	LdnServiceType { LdnServiceType_User = 0 , LdnServiceType_System = 1 }

enum	LdnState { LdnState_None = 0 , LdnState_Initialized = 1 , LdnState_AccessPointOpened = 2 , LdnState_AccessPointCreated = 3 , LdnState_StationOpened = 4 , LdnState_StationConnected = 5 , LdnState_Error = 6 }
	State loaded by ldnmGetStateForMonitor / ldnGetState. More...

enum	LdnDisconnectReason { LdnDisconnectReason_None = 0 , LdnDisconnectReason_User = 1 , LdnDisconnectReason_SystemRequest = 2 , LdnDisconnectReason_DestroyedByAdmin = 3 , LdnDisconnectReason_DestroyedBySystemRequest = 4 , LdnDisconnectReason_Admin = 5 , LdnDisconnectReason_SignalLost = 6 }
	DisconnectReason loaded by ldnGetDisconnectReason. More...

enum	LdnScanFilterFlags { LdnScanFilterFlags_LocalCommunicationId = (1U<<( 0 )) , LdnScanFilterFlags_NetworkId = (1U<<( 1 )) , LdnScanFilterFlags_Unknown2 = (1U<<( 2 )) , LdnScanFilterFlags_MacAddr = (1U<<( 3 )) , LdnScanFilterFlags_Ssid = (1U<<( 4 )) , LdnScanFilterFlags_UserData = (1U<<( 5 )) }
	ScanFilterFlags. More...

enum	LdnAcceptPolicy { LdnAcceptPolicy_AllowAll = 0 , LdnAcceptPolicy_DenyAll = 1 , LdnAcceptPolicy_Blacklist = 2 , LdnAcceptPolicy_Whitelist = 3 }
	AcceptPolicy. More...

enum	LdnOperationMode { LdnOperationMode_Unknown0 = 0 , LdnOperationMode_Unknown1 = 1 }
	OperationMode. More...

enum	LdnWirelessControllerRestriction { LdnWirelessControllerRestriction_Unknown0 = 0 , LdnWirelessControllerRestriction_Unknown1 = 1 }
	WirelessControllerRestriction. More...

Functions
ldn:m
Result	ldnmInitialize (void)
	Initialize ldn:m.

void	ldnmExit (void)
	Exit ldn:m.

Service *	ldnmGetServiceSession_MonitorService (void)
	Gets the Service object for IMonitorService.

Result	ldnmGetStateForMonitor (LdnState *out)
	GetStateForMonitor.

Result	ldnmGetNetworkInfoForMonitor (LdnNetworkInfo *out)
	GetNetworkInfoForMonitor.

Result	ldnmGetIpv4AddressForMonitor (LdnIpv4Address addr, LdnSubnetMask mask)
	GetIpv4AddressForMonitor.

Result	ldnmGetSecurityParameterForMonitor (LdnSecurityParameter *out)
	GetSecurityParameterForMonitor.

Result	ldnmGetNetworkConfigForMonitor (LdnNetworkConfig *out)
	GetNetworkConfigForMonitor.

ldn
Result	ldnInitialize (LdnServiceType service_type)
	Initialize ldn.

void	ldnExit (void)
	Exit ldn.

Service *	ldnGetServiceSession_LocalCommunicationService (void)
	Gets the Service object for IUserLocalCommunicationService/ISystemLocalCommunicationService.

Result	ldnGetState (LdnState *out)
	GetState.

Result	ldnGetNetworkInfo (LdnNetworkInfo *out)
	GetNetworkInfo.

Result	ldnGetIpv4Address (LdnIpv4Address addr, LdnSubnetMask mask)
	GetIpv4Address.

Result	ldnGetDisconnectReason (LdnDisconnectReason *out)
	GetDisconnectReason.

Result	ldnGetSecurityParameter (LdnSecurityParameter *out)
	GetSecurityParameter.

Result	ldnGetNetworkConfig (LdnNetworkConfig *out)
	GetNetworkConfig.

Result	ldnAttachStateChangeEvent (Event *out_event)
	AttachStateChangeEvent.

Result	ldnGetNetworkInfoLatestUpdate (LdnNetworkInfo network_info, LdnNodeLatestUpdate nodes, s32 count)
	GetNetworkInfoLatestUpdate.

Result	ldnScan (s32 channel, const LdnScanFilter filter, LdnNetworkInfo network_info, s32 count, s32 *total_out)
	Scan.

Result	ldnScanPrivate (s32 channel, const LdnScanFilter filter, LdnNetworkInfo network_info, s32 count, s32 *total_out)
	ScanPrivate.

Result	ldnSetWirelessControllerRestriction (LdnWirelessControllerRestriction restriction)
	SetWirelessControllerRestriction.

Result	ldnOpenAccessPoint (void)
	OpenAccessPoint.

Result	ldnCloseAccessPoint (void)
	CloseAccessPoint.

Result	ldnCreateNetwork (const LdnSecurityConfig sec_config, const LdnUserConfig user_config, const LdnNetworkConfig *network_config)
	CreateNetwork.

Result	ldnCreateNetworkPrivate (const LdnSecurityConfig sec_config, const LdnSecurityParameter sec_param, const LdnUserConfig user_config, const LdnNetworkConfig network_config, const LdnAddressEntry *addrs, s32 count)
	CreateNetworkPrivate.

Result	ldnDestroyNetwork (void)
	DestroyNetwork.

Result	ldnReject (LdnIpv4Address addr)
	Reject.

Result	ldnSetAdvertiseData (const void *buffer, size_t size)
	SetAdvertiseData.

Result	ldnSetStationAcceptPolicy (LdnAcceptPolicy policy)
	SetStationAcceptPolicy.

Result	ldnAddAcceptFilterEntry (LdnMacAddress addr)
	AddAcceptFilterEntry.

Result	ldnClearAcceptFilter (void)
	ClearAcceptFilter.

Result	ldnOpenStation (void)
	OpenStation.

Result	ldnCloseStation (void)
	CloseStation.

Result	ldnConnect (const LdnSecurityConfig sec_config, const LdnUserConfig user_config, s32 version, u32 option, const LdnNetworkInfo *network_info)
	Connect.

Result	ldnConnectPrivate (const LdnSecurityConfig sec_config, const LdnSecurityParameter sec_param, const LdnUserConfig user_config, s32 version, u32 option, const LdnNetworkConfig network_config)
	ConnectPrivate.

Result	ldnDisconnect (void)
	Disconnect.

Result	ldnSetOperationMode (LdnOperationMode mode)
	SetOperationMode.

Detailed Description

LDN (local network communications) IPC wrapper.

Author: yellows8

Copyright: libnx Authors

Enumeration Type Documentation

◆ LdnAcceptPolicy

enum LdnAcceptPolicy

AcceptPolicy.

Enumerator
LdnAcceptPolicy_AllowAll	Allow all.
LdnAcceptPolicy_DenyAll	Deny all.
LdnAcceptPolicy_Blacklist	Blacklist, addresses in the list (ldnAddAcceptFilterEntry) are not allowed.
LdnAcceptPolicy_Whitelist	Whitelist, only addresses in the list (ldnAddAcceptFilterEntry) are allowed.

◆ LdnDisconnectReason

enum LdnDisconnectReason

DisconnectReason loaded by ldnGetDisconnectReason.

Enumerator
LdnDisconnectReason_None	None.
LdnDisconnectReason_User	User.
LdnDisconnectReason_SystemRequest	SystemRequest.
LdnDisconnectReason_DestroyedByAdmin	DestroyedByAdmin.
LdnDisconnectReason_DestroyedBySystemRequest	DestroyedBySystemRequest.
LdnDisconnectReason_Admin	Admin.
LdnDisconnectReason_SignalLost	SignalLost.

◆ LdnOperationMode

enum LdnOperationMode

OperationMode.

Enumerator
LdnOperationMode_Unknown0	Unknown.
LdnOperationMode_Unknown1	Unknown.

◆ LdnScanFilterFlags

enum LdnScanFilterFlags

ScanFilterFlags.

Enumerator
LdnScanFilterFlags_LocalCommunicationId	When set, enables using LdnScanFilter::local_communication_id.
LdnScanFilterFlags_NetworkId	When set, enables using LdnScanFilter::network_id.
LdnScanFilterFlags_Unknown2	When set, enables using LdnScanFilter::unk_x20.
LdnScanFilterFlags_MacAddr	When set, enables using LdnScanFilter::mac_addr. Only available with ldnScanPrivate.
LdnScanFilterFlags_Ssid	When set, enables using the LdnScanFilter::ssid.
LdnScanFilterFlags_UserData	When set, enables using LdnScanFilter::userdata_filter.

◆ LdnServiceType

enum LdnServiceType

Enumerator
LdnServiceType_User	Initializes ldn:u.
LdnServiceType_System	Initializes ldn:s.

◆ LdnState

enum LdnState

State loaded by ldnmGetStateForMonitor / ldnGetState.

Enumerator
LdnState_None	None.
LdnState_Initialized	Initialized.
LdnState_AccessPointOpened	AccessPointOpened (ldnOpenAccessPoint)
LdnState_AccessPointCreated	AccessPointCreated (ldnCreateNetwork / ldnCreateNetworkPrivate)
LdnState_StationOpened	StationOpened (ldnOpenStation)
LdnState_StationConnected	StationConnected (ldnConnect / ldnConnectPrivate)
LdnState_Error	Error.

◆ LdnWirelessControllerRestriction

enum LdnWirelessControllerRestriction

WirelessControllerRestriction.

Enumerator
LdnWirelessControllerRestriction_Unknown0	Unknown.
LdnWirelessControllerRestriction_Unknown1	Unknown.

Function Documentation

◆ ldnAddAcceptFilterEntry()

Result ldnAddAcceptFilterEntry ( LdnMacAddress addr )

AddAcceptFilterEntry.

Note: LdnState must be LdnState_AccessPointOpened or LdnState_AccessPointCreated.; See LdnAcceptPolicy.

Parameters

[in] addr LdnMacAddress. If you want, you can also pass LdnNodeInfo::mac_addr for this.

◆ ldnAttachStateChangeEvent()

Result ldnAttachStateChangeEvent ( Event * out_event )

AttachStateChangeEvent.

Note: The Event must be closed by the user once finished with it.; This is signaled when the data returned by ldnGetNetworkInfo / ldnGetNetworkInfoLatestUpdate is updated.

Parameters

[out] out_event Output Event with autoclear=true.

◆ ldnClearAcceptFilter()

Result ldnClearAcceptFilter ( void )

ClearAcceptFilter.

Note: LdnState must be LdnState_AccessPointOpened or LdnState_AccessPointCreated.

◆ ldnCloseAccessPoint()

Result ldnCloseAccessPoint ( void )

CloseAccessPoint.

Note: LdnState must be LdnState_AccessPointOpened or LdnState_AccessPointCreated, this eventually sets the State to LdnState_Initialized.; Used automatically internally by ldnExit if needed.

◆ ldnCloseStation()

Result ldnCloseStation ( void )

CloseStation.

Note: LdnState must be LdnState_StationOpened or LdnState_StationConnected, this eventually sets the State to LdnState_Initialized.; Used automatically internally by ldnExit if needed.

◆ ldnConnect()

Result ldnConnect	(	const LdnSecurityConfig *	sec_config,
		const LdnUserConfig *	user_config,
		s32	version,
		u32	option,
		const LdnNetworkInfo *	network_info
	)

Connect.

Note: LdnState must be LdnState_StationOpened, this eventually sets the State to LdnState_StationConnected.; This is identical to ldnConnectPrivate besides the used params, the code overwriting LdnSecurityConfig::type also differs.

Parameters

[in]	sec_config	LdnSecurityConfig
[in]	user_config	LdnUserConfig
[in]	version	LocalCommunicationVersion, this must be 0x0-0x7FFF.
[in]	option	ConnectOption bitmask, must be <=0x1. You can use value 0 for example here.
[in]	network_info	LdnNetworkInfo

◆ ldnConnectPrivate()

Result ldnConnectPrivate	(	const LdnSecurityConfig *	sec_config,
		const LdnSecurityParameter *	sec_param,
		const LdnUserConfig *	user_config,
		s32	version,
		u32	option,
		const LdnNetworkConfig *	network_config
	)

ConnectPrivate.

Note: LdnState must be LdnState_StationOpened, this eventually sets the State to LdnState_StationConnected.; See ldnConnect.

Parameters

[in]	sec_config	LdnSecurityConfig
[in]	sec_param	LdnSecurityParameter
[in]	user_config	LdnUserConfig
[in]	version	LocalCommunicationVersion, this must be 0x0-0x7FFF.
[in]	option	ConnectOption bitmask, must be <=0x1. You can use value 0 for example here.
[in]	network_config	LdnNetworkConfig

◆ ldnCreateNetwork()

Result ldnCreateNetwork	(	const LdnSecurityConfig *	sec_config,
		const LdnUserConfig *	user_config,
		const LdnNetworkConfig *	network_config
	)

CreateNetwork.

Note: LdnState must be LdnState_AccessPointOpened, this eventually sets the State to LdnState_AccessPointCreated.

Parameters

[in]	sec_config	LdnSecurityConfig
[in]	user_config	LdnUserConfig
[in]	network_config	LdnNetworkConfig

◆ ldnCreateNetworkPrivate()

Result ldnCreateNetworkPrivate	(	const LdnSecurityConfig *	sec_config,
		const LdnSecurityParameter *	sec_param,
		const LdnUserConfig *	user_config,
		const LdnNetworkConfig *	network_config,
		const LdnAddressEntry *	addrs,
		s32	count
	)

CreateNetworkPrivate.

Note: LdnState must be LdnState_AccessPointOpened, this eventually sets the State to LdnState_AccessPointCreated.; This is the same as ldnCreateNetwork besides the additional user-specified params, and with this cmd LdnNetworkConfig::channel is not overwritten (unlike ldnCreateNetwork).

Parameters

[in]	sec_config	LdnSecurityConfig
[in]	sec_param	LdnSecurityParameter
[in]	user_config	LdnUserConfig
[in]	network_config	LdnNetworkConfig
[in]	addrs	Input array of LdnAddressEntry. This can be NULL.
[in]	count	Size of the addrs array in entries. This must be <=8. This can be 0, in which case the network will be non-Private like ldnCreateNetwork.

◆ ldnDestroyNetwork()

Result ldnDestroyNetwork ( void )

DestroyNetwork.

Note: LdnState must be LdnState_AccessPointCreated, this eventually sets the State to LdnState_AccessPointOpened.

◆ ldnDisconnect()

Result ldnDisconnect ( void )

Disconnect.

Note: LdnState must be LdnState_StationConnected, this eventually sets the State to LdnState_StationOpened.

◆ ldnGetDisconnectReason()

Result ldnGetDisconnectReason ( LdnDisconnectReason * out )

GetDisconnectReason.

Parameters

[out] out LdnDisconnectReason

◆ ldnGetIpv4Address()

Result ldnGetIpv4Address	(	LdnIpv4Address *	addr,
		LdnSubnetMask *	mask
	)

GetIpv4Address.

Parameters

[out]	addr	LdnIpv4Address
[out]	mask	LdnSubnetMask

◆ ldnGetNetworkConfig()

Result ldnGetNetworkConfig ( LdnNetworkConfig * out )

GetNetworkConfig.

Parameters

[out] out LdnNetworkConfig

◆ ldnGetNetworkInfo()

Result ldnGetNetworkInfo ( LdnNetworkInfo * out )

GetNetworkInfo.

Parameters

[out] out LdnNetworkInfo

◆ ldnGetNetworkInfoLatestUpdate()

Result ldnGetNetworkInfoLatestUpdate	(	LdnNetworkInfo *	network_info,
		LdnNodeLatestUpdate *	nodes,
		s32	count
	)

GetNetworkInfoLatestUpdate.

Parameters

[out]	network_info	LdnNetworkInfo
[out]	nodes	Output array of LdnNodeLatestUpdate.
[in]	count	Size of the nodes array in entries, must be 8.

◆ ldnGetSecurityParameter()

Result ldnGetSecurityParameter ( LdnSecurityParameter * out )

GetSecurityParameter.

Parameters

[out] out LdnSecurityParameter

◆ ldnGetState()

Result ldnGetState ( LdnState * out )

GetState.

Parameters

[out] out LdnState

◆ ldnmGetIpv4AddressForMonitor()

Result ldnmGetIpv4AddressForMonitor	(	LdnIpv4Address *	addr,
		LdnSubnetMask *	mask
	)

GetIpv4AddressForMonitor.

Parameters

[out]	addr	LdnIpv4Address
[out]	mask	LdnSubnetMask

◆ ldnmGetNetworkConfigForMonitor()

Result ldnmGetNetworkConfigForMonitor ( LdnNetworkConfig * out )

GetNetworkConfigForMonitor.

Note: Not exposed by official sw.

Parameters

[out] out LdnNetworkConfig

◆ ldnmGetNetworkInfoForMonitor()

Result ldnmGetNetworkInfoForMonitor ( LdnNetworkInfo * out )

GetNetworkInfoForMonitor.

Parameters

[out] out LdnNetworkInfo

◆ ldnmGetSecurityParameterForMonitor()

Result ldnmGetSecurityParameterForMonitor ( LdnSecurityParameter * out )

GetSecurityParameterForMonitor.

Note: Not exposed by official sw.

Parameters

[out] out LdnSecurityParameter

◆ ldnmGetStateForMonitor()

Result ldnmGetStateForMonitor ( LdnState * out )

GetStateForMonitor.

Parameters

[out] out LdnState

◆ ldnOpenAccessPoint()

Result ldnOpenAccessPoint ( void )

OpenAccessPoint.

Note: LdnState must be LdnState_Initialized, this eventually sets the State to LdnState_AccessPointOpened.

◆ ldnOpenStation()

Result ldnOpenStation ( void )

OpenStation.

Note: LdnState must be LdnState_Initialized, this eventually sets the State to LdnState_StationOpened.

◆ ldnReject()

Result ldnReject ( LdnIpv4Address addr )

Reject.

Note: LdnState must be LdnState_AccessPointCreated.

Parameters

[in] addr LdnIpv4Address

◆ ldnScan()

Result ldnScan	(	s32	channel,
		const LdnScanFilter *	filter,
		LdnNetworkInfo *	network_info,
		s32	count,
		s32 *	total_out
	)

Scan.

Note: LdnState must be LdnState_AccessPointCreated, LdnState_StationOpened, or LdnState_StationConnected.; This is the same as ldnScanPrivate (minus the masking for LdnScanFilter::flags), except this has the same channel-override functionality as ldnCreateNetwork.

Parameters

[in]	channel	Channel, value 0 can be used for this.
[in]	filter	LdnScanFilter
[out]	network_info	Output array of LdnNetworkInfo.
[in]	count	Size of the network_info array in entries. Must be at least 1, this is clamped to a maximum of 0x18 internally.
[out]	total_out	Total output entries.

◆ ldnScanPrivate()

Result ldnScanPrivate	(	s32	channel,
		const LdnScanFilter *	filter,
		LdnNetworkInfo *	network_info,
		s32	count,
		s32 *	total_out
	)

ScanPrivate.

Note: LdnState must be LdnState_AccessPointCreated, LdnState_StationOpened, or LdnState_StationConnected.; See ldnScan.

Parameters

[in]	channel	Channel, value 0 can be used for this.
[in]	filter	LdnScanFilter
[out]	network_info	Output array of LdnNetworkInfo.
[in]	count	Size of the network_info array in entries. Must be at least 1, this is clamped to a maximum of 0x18 internally.
[out]	total_out	Total output entries.

◆ ldnSetAdvertiseData()

Result ldnSetAdvertiseData	(	const void *	buffer,
		size_t	size
	)

SetAdvertiseData.

Note: An empty buffer (buffer=NULL/size=0) can be used to reset the AdvertiseData size in state to zero.; LdnState must be LdnState_AccessPointOpened or LdnState_AccessPointCreated.

Parameters

[in]	buffer	Input buffer containing arbitrary user data.
[in]	size	Input buffer size, must be <=0x180. If this isn't enough space, you can for example also periodically use this cmd with different regions of your data with some sequence_number field (or use sockets while connected to the network).

◆ ldnSetOperationMode()

Result ldnSetOperationMode ( LdnOperationMode mode )

SetOperationMode.

Note: Only available on [4.0.0+].; Only available with LdnServiceType_System.; LdnState must be LdnState_Initialized.

Parameters

[in] mode LdnOperationMode

◆ ldnSetStationAcceptPolicy()

Result ldnSetStationAcceptPolicy ( LdnAcceptPolicy policy )

SetStationAcceptPolicy.

Note: LdnState must be LdnState_AccessPointOpened or LdnState_AccessPointCreated.

Parameters

[in] policy LdnAcceptPolicy

◆ ldnSetWirelessControllerRestriction()

Result ldnSetWirelessControllerRestriction ( LdnWirelessControllerRestriction restriction )

SetWirelessControllerRestriction.

Note: Only available on [5.0.0+].; LdnState must be LdnState_Initialized.

Parameters

[in] restriction LdnWirelessControllerRestriction

Data Structures

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ LdnAcceptPolicy

◆ LdnDisconnectReason

◆ LdnOperationMode

◆ LdnScanFilterFlags

◆ LdnServiceType

◆ LdnState

◆ LdnWirelessControllerRestriction

Function Documentation

◆ ldnAddAcceptFilterEntry()

◆ ldnAttachStateChangeEvent()

◆ ldnClearAcceptFilter()

◆ ldnCloseAccessPoint()

◆ ldnCloseStation()

◆ ldnConnect()

◆ ldnConnectPrivate()

◆ ldnCreateNetwork()

◆ ldnCreateNetworkPrivate()

◆ ldnDestroyNetwork()

◆ ldnDisconnect()

◆ ldnGetDisconnectReason()

◆ ldnGetIpv4Address()

◆ ldnGetNetworkConfig()

◆ ldnGetNetworkInfo()

◆ ldnGetNetworkInfoLatestUpdate()

◆ ldnGetSecurityParameter()

◆ ldnGetState()

◆ ldnmGetIpv4AddressForMonitor()

◆ ldnmGetNetworkConfigForMonitor()

◆ ldnmGetNetworkInfoForMonitor()

◆ ldnmGetSecurityParameterForMonitor()

◆ ldnmGetStateForMonitor()

◆ ldnOpenAccessPoint()

◆ ldnOpenStation()

◆ ldnReject()

◆ ldnScan()

◆ ldnScanPrivate()

◆ ldnSetAdvertiseData()

◆ ldnSetOperationMode()

◆ ldnSetStationAcceptPolicy()

◆ ldnSetWirelessControllerRestriction()