lp2p service IPC wrapper, for local-WLAN communications with accessories. More...

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

Data Structures
struct	Lp2pMacAddress
	MacAddress. More...

struct	Lp2pGroupId
	GroupId. More...

struct	Lp2pGroupInfo
	GroupInfo lp2pScan only uses the following fields for the cmd input struct: supported_platform/priority, frequency/channel, and preshared_key_binary_size/preshared_key. More...

struct	Lp2pScanResult
	ScanResult. More...

struct	Lp2pNodeInfo
	NodeInfo. More...

struct	Lp2pIpConfig
	IpConfig. Only contains IPv4 addresses. More...

Enumerations
enum	Lp2pServiceType { Lp2pServiceType_App = 0 , Lp2pServiceType_System = 1 }

Functions
Result	lp2pInitialize (Lp2pServiceType service_type)
	Initialize lp2p.

void	lp2pExit (void)
	Exit lp2p.

Service *	lp2pGetServiceSession_INetworkService (void)
	Gets the Service object for INetworkService.

Service *	lp2pGetServiceSession_INetworkServiceMonitor (void)
	Gets the Service object for INetworkServiceMonitor.

void	lp2pCreateGroupInfo (Lp2pGroupInfo *info)
	Creates a default Lp2pGroupInfo for use with lp2pCreateGroup / lp2pJoin.

void	lp2pCreateGroupInfoScan (Lp2pGroupInfo *info)
	Creates a default Lp2pGroupInfo for use with lp2pScan.

void	lp2pGroupInfoSetServiceName (Lp2pGroupInfo info, const char name)
	Sets Lp2pGroupInfo::service_name.

void	lp2pGroupInfoSetFlags (Lp2pGroupInfo info, s8 flags, size_t count)
	Sets Lp2pGroupInfo::flags_count and Lp2pGroupInfo::flags.

static void	lp2pGroupInfoSetMemberCountMax (Lp2pGroupInfo *info, size_t count)
	Sets Lp2pGroupInfo::member_count_max.

static void	lp2pGroupInfoSetFrequencyChannel (Lp2pGroupInfo *info, u16 frequency, s16 channel)
	Sets Lp2pGroupInfo::frequency and Lp2pGroupInfo::channel.

static void	lp2pGroupInfoSetStealthEnabled (Lp2pGroupInfo *info, bool flag)
	Sets Lp2pGroupInfo::stealth_enabled.

void	lp2pGroupInfoSetPresharedKey (Lp2pGroupInfo info, const void key, size_t size)
	Sets the PresharedKey for the specified Lp2pGroupInfo.

Result	lp2pGroupInfoSetPassphrase (Lp2pGroupInfo info, const char passphrase)
	Sets the passphrase, for when standard WPA2-PSK is being used.

INetworkService
Result	lp2pScan (const Lp2pGroupInfo info, Lp2pScanResult results, s32 count, s32 *total_out)
	Scan.

Result	lp2pCreateGroup (const Lp2pGroupInfo *info)
	CreateGroup.

Result	lp2pDestroyGroup (void)
	This destroys the previously created group from lp2pCreateGroup.

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

Result	lp2pSendToOtherGroup (const void *buffer, size_t size, Lp2pMacAddress addr, Lp2pGroupId group_id, s16 frequency, s16 channel, u32 flags)
	This sends an Action frame to the specified Lp2pGroupId, with the specified destination Lp2pMacAddress.

Result	lp2pRecvFromOtherGroup (void buffer, size_t size, u32 flags, Lp2pMacAddress addr, u16 unk0, s32 unk1, u64 out_size, s32 unk2)
	This receives an Action frame.

Result	lp2pAddAcceptableGroupId (Lp2pGroupId group_id)
	AddAcceptableGroupId.

Result	lp2pRemoveAcceptableGroupId (void)
	RemoveAcceptableGroupId.

INetworkServiceMonitor
Result	lp2pAttachNetworkInterfaceStateChangeEvent (Event *out_event)
	AttachNetworkInterfaceStateChangeEvent.

Result	lp2pGetNetworkInterfaceLastError (void)
	GetNetworkInterfaceLastError.

Result	lp2pGetRole (u8 *out)
	GetRole.

Result	lp2pGetAdvertiseData (void buffer, size_t size, u16 transfer_size, u16 *original_size)
	GetAdvertiseData.

Result	lp2pGetAdvertiseData2 (void buffer, size_t size, u16 transfer_size, u16 *original_size)
	GetAdvertiseData2.

Result	lp2pGetGroupInfo (Lp2pGroupInfo *out)
	GetGroupInfo.

Result	lp2pJoin (Lp2pGroupInfo out, const Lp2pGroupInfo info)
	This runs the same code as lp2pCreateGroup to generate the Lp2pGroupInfo for the input struct.

Result	lp2pGetGroupOwner (Lp2pNodeInfo *out)
	GetGroupOwner.

Result	lp2pGetIpConfig (Lp2pIpConfig *out)
	GetIpConfig.

Result	lp2pLeave (u32 *out)
	Leave.

Result	lp2pAttachJoinEvent (Event *out_event)
	AttachJoinEvent.

Result	lp2pGetMembers (Lp2pNodeInfo members, s32 count, s32 total_out)
	GetMembers.

Detailed Description

lp2p service IPC wrapper, for local-WLAN communications with accessories.

Note: Only available on [9.1.0+].

Author: yellows8

Copyright: libnx Authors

Enumeration Type Documentation

◆ Lp2pServiceType

enum Lp2pServiceType

Enumerator
Lp2pServiceType_App	Initializes lp2p:app.
Lp2pServiceType_System	Initializes lp2p:sys.

Function Documentation

◆ lp2pAddAcceptableGroupId()

Result lp2pAddAcceptableGroupId ( Lp2pGroupId group_id )

AddAcceptableGroupId.

Parameters

[in] group_id Lp2pGroupId

◆ lp2pAttachJoinEvent()

Result lp2pAttachJoinEvent ( Event * out_event )

AttachJoinEvent.

Note: The Event must be closed by the user once finished with it.

Parameters

[out] out_event Output Event with autoclear=false.

◆ lp2pAttachNetworkInterfaceStateChangeEvent()

Result lp2pAttachNetworkInterfaceStateChangeEvent ( Event * out_event )

AttachNetworkInterfaceStateChangeEvent.

Note: The Event must be closed by the user once finished with it.

Parameters

[out] out_event Output Event with autoclear=false.

◆ lp2pCreateGroup()

Result lp2pCreateGroup ( const Lp2pGroupInfo * info )

CreateGroup.

Note: The role (lp2pGetRole) must be 0. This eventually sets the role to value 1.

Parameters

[in] info Lp2pGroupInfo

◆ lp2pCreateGroupInfo()

void lp2pCreateGroupInfo ( Lp2pGroupInfo * info )

Creates a default Lp2pGroupInfo for use with lp2pCreateGroup / lp2pJoin.

Parameters

info	Lp2pGroupInfo

◆ lp2pCreateGroupInfoScan()

void lp2pCreateGroupInfoScan ( Lp2pGroupInfo * info )

Creates a default Lp2pGroupInfo for use with lp2pScan.

Parameters

info	Lp2pGroupInfo

◆ lp2pDestroyGroup()

Result lp2pDestroyGroup ( void )

This destroys the previously created group from lp2pCreateGroup.

Note: If no group was previously created (role from lp2pGetRole is not 1), this just returns 0.

◆ lp2pGetAdvertiseData()

Result lp2pGetAdvertiseData	(	void *	buffer,
		size_t	size,
		u16 *	transfer_size,
		u16 *	original_size
	)

GetAdvertiseData.

Note: The role from lp2pGetRole must be value 2.

Parameters

[out]	buffer	Output buffer data.
[in]	size	Output buffer size.
[out]	transfer_size	Size of the data copied into the buffer.
[out]	original_size	Original size from state.

◆ lp2pGetAdvertiseData2()

Result lp2pGetAdvertiseData2	(	void *	buffer,
		size_t	size,
		u16 *	transfer_size,
		u16 *	original_size
	)

GetAdvertiseData2.

Note: This is identical to lp2pGetAdvertiseData except this doesn't run the role validation.

Parameters

[out]	buffer	Output buffer data.
[in]	size	Output buffer size.
[out]	transfer_size	Size of the data copied into the buffer.
[out]	original_size	Original size from state.

◆ lp2pGetGroupInfo()

Result lp2pGetGroupInfo ( Lp2pGroupInfo * out )

GetGroupInfo.

Note: The role from lp2pGetRole must be non-zero.

Parameters

[out] out Lp2pGroupInfo

◆ lp2pGetGroupOwner()

Result lp2pGetGroupOwner ( Lp2pNodeInfo * out )

GetGroupOwner.

Note: The role from lp2pGetRole must be non-zero.

Parameters

[out] out Lp2pNodeInfo

◆ lp2pGetIpConfig()

Result lp2pGetIpConfig ( Lp2pIpConfig * out )

GetIpConfig.

Note: The role from lp2pGetRole must be non-zero.

Parameters

[out] out Lp2pIpConfig

◆ lp2pGetMembers()

Result lp2pGetMembers	(	Lp2pNodeInfo *	members,
		s32	count,
		s32 *	total_out
	)

GetMembers.

Note: The role from lp2pGetRole must be value 1.

Parameters

[out]	members	Output array of Lp2pNodeInfo.
[in]	count	Size of the members array in entries. A maximum of 8 entries can be returned.
[out]	total_out	Total output entries.

◆ lp2pGetRole()

Result lp2pGetRole ( u8 * out )

GetRole.

Parameters

[out] out Output Role.

◆ lp2pGroupInfoSetFlags()

void lp2pGroupInfoSetFlags	(	Lp2pGroupInfo *	info,
		s8 *	flags,
		size_t	count
	)

Sets Lp2pGroupInfo::flags_count and Lp2pGroupInfo::flags.

Note: The default is count=1 flags[0]=1, which is used by lp2pCreateGroupInfo. [11.0.0+] To use standard WPA2-PSK, you can use flags[0]=0.

Parameters

	info	Lp2pGroupInfo
[in]	flags	Lp2pGroupInfo::flags
[in]	count	Lp2pGroupInfo::flags_count

◆ lp2pGroupInfoSetFrequencyChannel()

static void lp2pGroupInfoSetFrequencyChannel	(	Lp2pGroupInfo *	info,
		u16	frequency,
		s16	channel
	)

inlinestatic

Sets Lp2pGroupInfo::frequency and Lp2pGroupInfo::channel.

Parameters

	info	Lp2pGroupInfo
[in]	frequency	Lp2pGroupInfo::frequency
[in]	channel	Lp2pGroupInfo::channel

◆ lp2pGroupInfoSetMemberCountMax()

static void lp2pGroupInfoSetMemberCountMax	(	Lp2pGroupInfo *	info,
		size_t	count
	)

inlinestatic

Sets Lp2pGroupInfo::member_count_max.

Parameters

	info	Lp2pGroupInfo
[in]	count	MemberCountMax

◆ lp2pGroupInfoSetPassphrase()

Result lp2pGroupInfoSetPassphrase	(	Lp2pGroupInfo *	info,
		const char *	passphrase
	)

Sets the passphrase, for when standard WPA2-PSK is being used.

Note: Configure standard WPA2-PSK usage via lp2pGroupInfoSetFlags / Lp2pGroupInfo::security_type.; Only available on [11.0.0+].

Parameters

	info	Lp2pGroupInfo
[in]	passphrase	Passphrase string, the required length is 0x8-0x3F.

◆ lp2pGroupInfoSetPresharedKey()

void lp2pGroupInfoSetPresharedKey	(	Lp2pGroupInfo *	info,
		const void *	key,
		size_t	size
	)

Sets the PresharedKey for the specified Lp2pGroupInfo.

Note: Using this is required before using the Lp2pGroupInfo as input for any cmds, so that Lp2pGroupInfo::preshared_key_binary_size gets initialized.; If standard WPA2-PSK is being used, use lp2pGroupInfoSetPassphrase instead.

Parameters

	info	Lp2pGroupInfo
[in]	key	Data for the PresharedKey.
[in]	size	Size to copy into the PresharedKey, max is 0x20.

◆ lp2pGroupInfoSetServiceName()

void lp2pGroupInfoSetServiceName	(	Lp2pGroupInfo *	info,
		const char *	name
	)

Sets Lp2pGroupInfo::service_name.

Parameters

	info	Lp2pGroupInfo
[in]	name	ServiceName / SSID.

◆ lp2pGroupInfoSetStealthEnabled()

static void lp2pGroupInfoSetStealthEnabled	(	Lp2pGroupInfo *	info,
		bool	flag
	)

inlinestatic

Sets Lp2pGroupInfo::stealth_enabled.

Parameters

	info	Lp2pGroupInfo
[in]	flag	Lp2pGroupInfo::stealth_enabled

◆ lp2pJoin()

Result lp2pJoin	(	Lp2pGroupInfo *	out,
		const Lp2pGroupInfo *	info
	)

This runs the same code as lp2pCreateGroup to generate the Lp2pGroupInfo for the input struct.

Parameters

[out]	out	Lp2pGroupInfo
[in]	info	Lp2pGroupInfo

◆ lp2pLeave()

Result lp2pLeave ( u32 * out )

Leave.

Parameters

[out] out Output value.

◆ lp2pRecvFromOtherGroup()

Result lp2pRecvFromOtherGroup	(	void *	buffer,
		size_t	size,
		u32	flags,
		Lp2pMacAddress *	addr,
		u16 *	unk0,
		s32 *	unk1,
		u64 *	out_size,
		s32 *	unk2
	)

This receives an Action frame.

Note: The role (lp2pGetRole) must be non-zero.; When data is not available, the error from lp2pGetNetworkInterfaceLastError will be returned if it's set.

Parameters

[out]	buffer	Output buffer containing arbitrary user data.
[in]	size	Output buffer size.
[in]	flags	Only bit0 is used: clear = block until data is available, set = return error when data is not available.
[in]	addr	Lp2pMacAddress
[in]	unk0	Unknown
[in]	unk1	Unknown
[out]	out_size	This is the original size used for copying to the output buffer, before it's clamped to the output-buffer size.
[out]	unk2	Unknown

◆ lp2pScan()

Result lp2pScan	(	const Lp2pGroupInfo *	info,
		Lp2pScanResult *	results,
		s32	count,
		s32 *	total_out
	)

Scan.

Parameters

[in]	info	Lp2pGroupInfo
[out]	results	Output array of Lp2pScanResult.
[in]	count	Size of the results array in entries.
[out]	total_out	Total output entries.

◆ lp2pSendToOtherGroup()

Result lp2pSendToOtherGroup	(	const void *	buffer,
		size_t	size,
		Lp2pMacAddress	addr,
		Lp2pGroupId	group_id,
		s16	frequency,
		s16	channel,
		u32	flags
	)

This sends an Action frame to the specified Lp2pGroupId, with the specified destination Lp2pMacAddress.

Note: The role (lp2pGetRole) must be non-zero.; The error from lp2pGetNetworkInterfaceLastError will be returned if it's set.; [11.0.0+] Lp2pGroupInfo::security_type must be value 2 (default encryption), otherwise an error is returned.

Parameters

[in]	buffer	Input buffer containing arbitrary user data.
[in]	size	Input buffer size, must be <=0x400.
[in]	addr	Lp2pMacAddress, this can be a broadcast address. This must be non-zero.
[in]	group_id	Lp2pGroupId
[in]	frequency	Must be >=1. See Lp2pGroupInfo::frequency.
[in]	channel	Must be >=1. See Lp2pGroupInfo::channel.
[in]	flags	Only bit0 is used: clear = block until the data can be sent, set = return error when the data can't be sent.

◆ lp2pSetAdvertiseData()

Result lp2pSetAdvertiseData	(	const void *	buffer,
		size_t	size
	)

SetAdvertiseData.

Note: The role (lp2pGetRole) must be <=1.; An empty buffer (buffer=NULL/size=0) can be used to reset the AdvertiseData size in state to zero.

Parameters

[out]	buffer	Input buffer containing arbitrary user data.
[in]	size	Input buffer size, must be <=0x80.

Data Structures

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ Lp2pServiceType

Function Documentation

◆ lp2pAddAcceptableGroupId()

◆ lp2pAttachJoinEvent()

◆ lp2pAttachNetworkInterfaceStateChangeEvent()

◆ lp2pCreateGroup()

◆ lp2pCreateGroupInfo()

◆ lp2pCreateGroupInfoScan()

◆ lp2pDestroyGroup()

◆ lp2pGetAdvertiseData()

◆ lp2pGetAdvertiseData2()

◆ lp2pGetGroupInfo()

◆ lp2pGetGroupOwner()

◆ lp2pGetIpConfig()

◆ lp2pGetMembers()

◆ lp2pGetRole()

◆ lp2pGroupInfoSetFlags()

◆ lp2pGroupInfoSetFrequencyChannel()

◆ lp2pGroupInfoSetMemberCountMax()

◆ lp2pGroupInfoSetPassphrase()

◆ lp2pGroupInfoSetPresharedKey()

◆ lp2pGroupInfoSetServiceName()

◆ lp2pGroupInfoSetStealthEnabled()

◆ lp2pJoin()

◆ lp2pLeave()

◆ lp2pRecvFromOtherGroup()

◆ lp2pScan()

◆ lp2pSendToOtherGroup()

◆ lp2pSetAdvertiseData()