btdev.h File Reference

Wrapper around the bt/btmu services for using bluetooth BLE. More...

#include "../types.h"
#include "../kernel/event.h"
#include "../services/btdrv_types.h"

Go to the source code of this file.

Data Structures
struct	BtdevGattAttribute
	GattAttribute. More...
struct	BtdevGattService
	GattService. More...
struct	BtdevGattCharacteristic
	GattCharacteristic. More...
struct	BtdevGattDescriptor
	GattDescriptor. More...

Functions
Result	btdevInitialize (void)
	Initialize bt/btmu.
void	btdevExit (void)
	Exit bt/btmu.
bool	btdevGattAttributeUuidIsSame (const BtdrvGattAttributeUuid *a, const BtdrvGattAttributeUuid *b)
	Compares two BtdrvGattAttributeUuid, returning whether these match.
Result	btdevAcquireBleScanEvent (Event *out_event)
	Wrapper for btmuAcquireBleScanEvent.
Result	btdevGetBleScanParameter (u16 parameter_id, BtdrvBleAdvertisePacketParameter *out)
	Wrapper for btmuGetBleScanFilterParameter.
Result	btdevGetBleScanParameter2 (u16 parameter_id, BtdrvGattAttributeUuid *out)
	Wrapper for btmuGetBleScanFilterParameter2.
Result	btdevStartBleScanGeneral (BtdrvBleAdvertisePacketParameter param)
	Wrapper for btdevStartBleScanGeneral.
Result	btdevStopBleScanGeneral (void)
	Wrapper for btmuStopBleScanForGeneral.
Result	btdevGetBleScanResult (BtdrvBleScanResult *results, u8 count, u8 *total_out)
	Wrapper for btmuGetBleScanResultsForGeneral and btmuGetBleScanResultsForSmartDevice.
Result	btdevEnableBleAutoConnection (BtdrvBleAdvertisePacketParameter param)
	Wrapper for btmuStartBleScanForPaired.
Result	btdevDisableBleAutoConnection (void)
	Wrapper for btmuStopBleScanForPaired.
Result	btdevStartBleScanSmartDevice (const BtdrvGattAttributeUuid *uuid)
	Wrapper for btmuStartBleScanForSmartDevice.
Result	btdevStopBleScanSmartDevice (void)
	Wrapper for btmuStopBleScanForSmartDevice.
Result	btdevAcquireBleConnectionStateChangedEvent (Event *out_event)
	Wrapper for btmuAcquireBleConnectionEvent.
Result	btdevConnectToGattServer (BtdrvAddress addr)
	Wrapper for btmuBleConnect.
Result	btdevDisconnectFromGattServer (u32 connection_handle)
	Wrapper for btmuBleDisconnect.
Result	btdevGetBleConnectionInfoList (BtdrvBleConnectionInfo *info, u8 count, u8 *total_out)
	Wrapper for btmuBleGetConnectionState.
Result	btdevAcquireBleServiceDiscoveryEvent (Event *out_event)
	Wrapper for btmuAcquireBleServiceDiscoveryEvent.
Result	btdevGetGattServices (u32 connection_handle, BtdevGattService *services, u8 count, u8 *total_out)
	Wrapper for btmuGetGattServices.
Result	btdevGetGattService (u32 connection_handle, const BtdrvGattAttributeUuid *uuid, BtdevGattService *service, bool *flag)
	Wrapper for btmuGetGattService.
Result	btdevAcquireBlePairingEvent (Event *out_event)
	Wrapper for btmuAcquireBlePairingEvent.
Result	btdevPairGattServer (u32 connection_handle, BtdrvBleAdvertisePacketParameter param)
	Wrapper for btmuBlePairDevice.
Result	btdevUnpairGattServer (u32 connection_handle, BtdrvBleAdvertisePacketParameter param)
	Wrapper for btmuBleUnPairDevice.
Result	btdevUnpairGattServer2 (BtdrvAddress addr, BtdrvBleAdvertisePacketParameter param)
	Wrapper for btmuBleUnPairDevice2.
Result	btdevGetPairedGattServerAddress (BtdrvBleAdvertisePacketParameter param, BtdrvAddress *addrs, u8 count, u8 *total_out)
	Wrapper for btmuBleGetPairedDevices.
Result	btdevAcquireBleMtuConfigEvent (Event *out_event)
	Wrapper for btmuAcquireBleMtuConfigEvent.
Result	btdevConfigureBleMtu (u32 connection_handle, u16 mtu)
	Wrapper for btmuConfigureBleMtu.
Result	btdevGetBleMtu (u32 connection_handle, u16 *out)
	Wrapper for btmuGetBleMtu.
Result	btdevAcquireBleGattOperationEvent (Event *out_event)
	Wrapper for btRegisterBleEvent.
Result	btdevRegisterGattOperationNotification (const BtdrvGattAttributeUuid *uuid)
	Wrapper for btmuRegisterBleGattDataPath.
Result	btdevUnregisterGattOperationNotification (const BtdrvGattAttributeUuid *uuid)
	Wrapper for btmuUnregisterBleGattDataPath.
Result	btdevGetGattOperationResult (BtdrvBleClientGattOperationInfo *out)
	Wrapper for btGetLeEventInfo.
Result	btdevReadGattCharacteristic (BtdevGattCharacteristic *c)
	Wrapper for btLeClientReadCharacteristic.
Result	btdevWriteGattCharacteristic (BtdevGattCharacteristic *c)
	Wrapper for btLeClientWriteCharacteristic.
Result	btdevEnableGattCharacteristicNotification (BtdevGattCharacteristic *c, bool flag)
	Wrapper for btLeClientRegisterNotification / btLeClientDeregisterNotification.
Result	btdevReadGattDescriptor (BtdevGattDescriptor *d)
	Wrapper for btLeClientReadDescriptor.
Result	btdevWriteGattDescriptor (BtdevGattDescriptor *d)
	Wrapper for btLeClientWriteDescriptor.
GattAttribute
void	btdevGattAttributeCreate (BtdevGattAttribute *a, const BtdrvGattAttributeUuid *uuid, u16 handle, u32 connection_handle)
	Creates a BtdevGattAttribute object.
static u8	btdevGattAttributeGetType (BtdevGattAttribute *a)
	Gets the Type.
static void	btdevGattAttributeGetUuid (BtdevGattAttribute *a, BtdrvGattAttributeUuid *out)
	Gets the Uuid.
static u16	btdevGattAttributeGetHandle (BtdevGattAttribute *a)
	Gets the Handle.
static u32	btdevGattAttributeGetConnectionHandle (BtdevGattAttribute *a)
	Gets the ConnectionHandle.
GattService
void	btdevGattServiceCreate (BtdevGattService *s, const BtdrvGattAttributeUuid *uuid, u16 handle, u32 connection_handle, u16 instance_id, u16 end_group_handle, bool primary_service)
	Creates a BtdevGattService object.
static u16	btdevGattServiceGetInstanceId (BtdevGattService *s)
	Gets the InstanceId.
static u16	btdevGattServiceGetEndGroupHandle (BtdevGattService *s)
	Gets the EndGroupHandle.
static u16	btdevGattServiceIsPrimaryService (BtdevGattService *s)
	Gets whether this is the PrimaryService.
Result	btdevGattServiceGetIncludedServices (BtdevGattService *s, BtdevGattService *services, u8 count, u8 *total_out)
	Wrapper for btmuGetGattIncludedServices.
Result	btdevGattServiceGetCharacteristics (BtdevGattService *s, BtdevGattCharacteristic *characteristics, u8 count, u8 *total_out)
	Wrapper for btmuGetGattCharacteristics.
Result	btdevGattServiceGetCharacteristic (BtdevGattService *s, const BtdrvGattAttributeUuid *uuid, BtdevGattCharacteristic *characteristic, bool *flag)
	Same as btdevGattServiceGetCharacteristics except this only returns the BtdevGattCharacteristic which contains a matching BtdrvGattAttributeUuid.
GattCharacteristic
void	btdevGattCharacteristicCreate (BtdevGattCharacteristic *c, const BtdrvGattAttributeUuid *uuid, u16 handle, u32 connection_handle, u16 instance_id, u8 properties)
	Creates a BtdevGattCharacteristic object.
static u16	btdevGattCharacteristicGetInstanceId (BtdevGattCharacteristic *c)
	Gets the InstanceId.
static u8	btdevGattCharacteristicGetProperties (BtdevGattCharacteristic *c)
	Gets the Properties.
Result	btdevGattCharacteristicGetService (BtdevGattCharacteristic *c, BtdevGattService *service)
	Wrapper for btmuGetBelongingGattService.
Result	btdevGattCharacteristicGetDescriptors (BtdevGattCharacteristic *c, BtdevGattDescriptor *descriptors, u8 count, u8 *total_out)
	Wrapper for btmuGetGattDescriptors.
Result	btdevGattCharacteristicGetDescriptor (BtdevGattCharacteristic *c, const BtdrvGattAttributeUuid *uuid, BtdevGattDescriptor *descriptor, bool *flag)
	Same as btdevGattCharacteristicGetDescriptors except this only returns a BtdevGattDescriptor which contains a matching BtdrvGattAttributeUuid.
void	btdevGattCharacteristicSetValue (BtdevGattCharacteristic *c, const void *buffer, size_t size)
	Sets the Value in the object.
u64	btdevGattCharacteristicGetValue (BtdevGattCharacteristic *c, void *buffer, size_t size)
	Gets the Value in the object, returns the copied value size.
GattDescriptor
void	btdevGattDescriptorCreate (BtdevGattDescriptor *d, const BtdrvGattAttributeUuid *uuid, u16 handle, u32 connection_handle)
	Creates a BtdevGattDescriptor object.
Result	btdevGattDescriptorGetService (BtdevGattDescriptor *d, BtdevGattService *service)
	Wrapper for btmuGetBelongingGattService.
Result	btdevGattDescriptorGetCharacteristic (BtdevGattDescriptor *d, BtdevGattCharacteristic *characteristic)
	Wrapper for btmuGetGattCharacteristics.
void	btdevGattDescriptorSetValue (BtdevGattDescriptor *d, const void *buffer, size_t size)
	Sets the Value in the object.
u64	btdevGattDescriptorGetValue (BtdevGattDescriptor *d, void *buffer, size_t size)
	Gets the Value in the object, returns the copied value size.

Detailed Description

Wrapper around the bt/btmu services for using bluetooth BLE.

Note

Only available on [5.0.0+].

See also: https://switchbrew.org/wiki/BTM_services

Author

yellows8

Copyright

libnx Authors

Function Documentation

btdevConfigureBleMtu()

Result btdevConfigureBleMtu	(	u32	connection_handle,
		u16	mtu
	)

Wrapper for btmuConfigureBleMtu.

Parameters

[in]	connection_handle	Same as btmuBleDisconnect.
[in]	mtu	MTU, must be 0x18-0x200.

btdevEnableGattCharacteristicNotification()

Result btdevEnableGattCharacteristicNotification	(	BtdevGattCharacteristic *	c,
		bool	flag
	)

Wrapper for btLeClientRegisterNotification / btLeClientDeregisterNotification.

Note

An error is thrown if the properties from btdevGattCharacteristicGetProperties don't allow using this.

Parameters

	c	BtdevGattCharacteristic
[in]	flag	Whether to enable/disable, controls which func to call.

btdevGattAttributeCreate()

void btdevGattAttributeCreate	(	BtdevGattAttribute *	a,
		const BtdrvGattAttributeUuid *	uuid,
		u16	handle,
		u32	connection_handle
	)

Creates a BtdevGattAttribute object.

This is intended for internal use.

Parameters

	a	BtdevGattAttribute
[in]	uuid	BtdrvGattAttributeUuid
[in]	handle	Handle
[in]	connection_handle	ConnectionHandle

btdevGattAttributeGetConnectionHandle()

static u32 btdevGattAttributeGetConnectionHandle ( BtdevGattAttribute *  a )

inlinestatic

Gets the ConnectionHandle.

Parameters

a	BtdevGattAttribute

btdevGattAttributeGetHandle()

static u16 btdevGattAttributeGetHandle ( BtdevGattAttribute *  a )

inlinestatic

Gets the Handle.

Parameters

a	BtdevGattAttribute

btdevGattAttributeGetType()

static u8 btdevGattAttributeGetType ( BtdevGattAttribute *  a )

inlinestatic

Gets the Type.

Parameters

a	BtdevGattAttribute

btdevGattAttributeGetUuid()

static void btdevGattAttributeGetUuid ( BtdevGattAttribute *  a, BtdrvGattAttributeUuid *  out  )

inlinestatic

Gets the Uuid.

Parameters

	a	BtdevGattAttribute
[out]	out	BtdrvGattAttributeUuid

btdevGattCharacteristicCreate()

void btdevGattCharacteristicCreate	(	BtdevGattCharacteristic *	c,
		const BtdrvGattAttributeUuid *	uuid,
		u16	handle,
		u32	connection_handle,
		u16	instance_id,
		u8	properties
	)

Creates a BtdevGattCharacteristic object.

This is intended for internal use.

Parameters

	c	BtdevGattCharacteristic
[in]	uuid	BtdrvGattAttributeUuid
[in]	handle	Handle
[in]	connection_handle	ConnectionHandle
[in]	instance_id	InstanceId
[in]	properties	Properties

btdevGattCharacteristicGetDescriptor()

Result btdevGattCharacteristicGetDescriptor	(	BtdevGattCharacteristic *	c,
		const BtdrvGattAttributeUuid *	uuid,
		BtdevGattDescriptor *	descriptor,
		bool *	flag
	)

Same as btdevGattCharacteristicGetDescriptors except this only returns a BtdevGattDescriptor which contains a matching BtdrvGattAttributeUuid.

Parameters

	c	BtdevGattCharacteristic
[in]	uuid	BtdrvGattAttributeUuid
[out]	descriptor	BtdevGattDescriptor
[out]	flag	Whether a BtdevGattDescriptor was returned.

btdevGattCharacteristicGetDescriptors()

Result btdevGattCharacteristicGetDescriptors	(	BtdevGattCharacteristic *	c,
		BtdevGattDescriptor *	descriptors,
		u8	count,
		u8 *	total_out
	)

Wrapper for btmuGetGattDescriptors.

Note

Gets the descriptors which belongs to this object.

Parameters

	c	BtdevGattCharacteristic
[out]	descriptors	Output array of BtdevGattDescriptor.
[in]	count	Size of the descriptors array in entries. The max is 100.
[out]	total_out	Total output entries.

btdevGattCharacteristicGetInstanceId()

static u16 btdevGattCharacteristicGetInstanceId ( BtdevGattCharacteristic *  c )

inlinestatic

Gets the InstanceId.

Parameters

c	BtdevGattCharacteristic

btdevGattCharacteristicGetProperties()

static u8 btdevGattCharacteristicGetProperties ( BtdevGattCharacteristic *  c )

inlinestatic

Gets the Properties.

Parameters

c	BtdevGattCharacteristic

btdevGattCharacteristicGetService()

Result btdevGattCharacteristicGetService	(	BtdevGattCharacteristic *	c,
		BtdevGattService *	service
	)

Wrapper for btmuGetBelongingGattService.

Note

Gets the BtdevGattService which belongs to this object.

Parameters

	c	BtdevGattCharacteristic.
[out]	service	BtdevGattService

btdevGattCharacteristicGetValue()

u64 btdevGattCharacteristicGetValue	(	BtdevGattCharacteristic *	c,
		void *	buffer,
		size_t	size
	)

Gets the Value in the object, returns the copied value size.

Parameters

	c	BtdevGattCharacteristic
[out]	buffer	Output buffer.
[in]	size	Output buffer size, max is 0x200.

btdevGattCharacteristicSetValue()

void btdevGattCharacteristicSetValue	(	BtdevGattCharacteristic *	c,
		const void *	buffer,
		size_t	size
	)

Sets the Value in the object.

Note

See also btdevWriteGattCharacteristic.

Parameters

	c	BtdevGattCharacteristic
[in]	buffer	Input buffer.
[in]	size	Input buffer size, max is 0x200.

btdevGattDescriptorCreate()

void btdevGattDescriptorCreate	(	BtdevGattDescriptor *	d,
		const BtdrvGattAttributeUuid *	uuid,
		u16	handle,
		u32	connection_handle
	)

Creates a BtdevGattDescriptor object.

This is intended for internal use.

Parameters

	d	BtdevGattDescriptor
[in]	uuid	BtdrvGattAttributeUuid
[in]	handle	Handle
[in]	connection_handle	ConnectionHandle

btdevGattDescriptorGetCharacteristic()

Result btdevGattDescriptorGetCharacteristic	(	BtdevGattDescriptor *	d,
		BtdevGattCharacteristic *	characteristic
	)

Wrapper for btmuGetGattCharacteristics.

Note

Gets the BtdevGattCharacteristic which belongs to this object.

Parameters

	d	BtdevGattDescriptor
[out]	characteristic	BtdevGattCharacteristic

btdevGattDescriptorGetService()

Result btdevGattDescriptorGetService	(	BtdevGattDescriptor *	d,
		BtdevGattService *	service
	)

Wrapper for btmuGetBelongingGattService.

Note

Gets the BtdevGattService which belongs to this object.

Parameters

	d	BtdevGattDescriptor
[out]	service	BtdevGattService

btdevGattDescriptorGetValue()

u64 btdevGattDescriptorGetValue	(	BtdevGattDescriptor *	d,
		void *	buffer,
		size_t	size
	)

Gets the Value in the object, returns the copied value size.

Parameters

	d	BtdevGattDescriptor
[out]	buffer	Output buffer.
[in]	size	Output buffer size, max is 0x200.

btdevGattDescriptorSetValue()

void btdevGattDescriptorSetValue	(	BtdevGattDescriptor *	d,
		const void *	buffer,
		size_t	size
	)

Sets the Value in the object.

Note

See also btdevWriteGattDescriptor.

Parameters

	d	BtdevGattDescriptor
[in]	buffer	Input buffer.
[in]	size	Input buffer size, max is 0x200.

btdevGattServiceCreate()

void btdevGattServiceCreate	(	BtdevGattService *	s,
		const BtdrvGattAttributeUuid *	uuid,
		u16	handle,
		u32	connection_handle,
		u16	instance_id,
		u16	end_group_handle,
		bool	primary_service
	)

Creates a BtdevGattService object.

This is intended for internal use.

Parameters

	s	BtdevGattService
[in]	uuid	BtdrvGattAttributeUuid
[in]	handle	Handle
[in]	connection_handle	ConnectionHandle
[in]	instance_id	InstanceId
[in]	end_group_handle	EndGroupHandle
[in]	primary_service	PrimaryService

btdevGattServiceGetCharacteristic()

Result btdevGattServiceGetCharacteristic	(	BtdevGattService *	s,
		const BtdrvGattAttributeUuid *	uuid,
		BtdevGattCharacteristic *	characteristic,
		bool *	flag
	)

Same as btdevGattServiceGetCharacteristics except this only returns the BtdevGattCharacteristic which contains a matching BtdrvGattAttributeUuid.

Parameters

	s	BtdevGattService
[in]	uuid	BtdrvGattAttributeUuid
[out]	characteristic	BtdevGattCharacteristic
[out]	flag	Whether a BtdevGattService was returned.

btdevGattServiceGetCharacteristics()

Result btdevGattServiceGetCharacteristics	(	BtdevGattService *	s,
		BtdevGattCharacteristic *	characteristics,
		u8	count,
		u8 *	total_out
	)

Wrapper for btmuGetGattCharacteristics.

Parameters

	s	BtdevGattService
[out]	characteristics	Output array of BtdevGattCharacteristic.
[in]	count	Size of the characteristics array in entries. The max is 100.
[out]	total_out	Total output entries.

btdevGattServiceGetEndGroupHandle()

static u16 btdevGattServiceGetEndGroupHandle ( BtdevGattService *  s )

inlinestatic

Gets the EndGroupHandle.

Parameters

s	BtdevGattService

btdevGattServiceGetIncludedServices()

Result btdevGattServiceGetIncludedServices	(	BtdevGattService *	s,
		BtdevGattService *	services,
		u8	count,
		u8 *	total_out
	)

Wrapper for btmuGetGattIncludedServices.

Parameters

	s	BtdevGattService
[out]	services	Output array of BtdevGattService.
[in]	count	Size of the services array in entries. The max is 100.
[out]	total_out	Total output entries.

btdevGattServiceGetInstanceId()

static u16 btdevGattServiceGetInstanceId ( BtdevGattService *  s )

inlinestatic

Gets the InstanceId.

Parameters

s	BtdevGattService

btdevGattServiceIsPrimaryService()

static u16 btdevGattServiceIsPrimaryService ( BtdevGattService *  s )

inlinestatic

Gets whether this is the PrimaryService.

Parameters

s	BtdevGattService

btdevGetBleScanResult()

Result btdevGetBleScanResult	(	BtdrvBleScanResult *	results,
		u8	count,
		u8 *	total_out
	)

Wrapper for btmuGetBleScanResultsForGeneral and btmuGetBleScanResultsForSmartDevice.

Parameters

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

btdevGetGattOperationResult()

Result btdevGetGattOperationResult

(

BtdrvBleClientGattOperationInfo *

out

)

Wrapper for btGetLeEventInfo.

Parameters

[out]

out

BtdrvBleClientGattOperationInfo

btdevGetGattService()

Result btdevGetGattService	(	u32	connection_handle,
		const BtdrvGattAttributeUuid *	uuid,
		BtdevGattService *	service,
		bool *	flag
	)

Wrapper for btmuGetGattService.

Parameters

[in]	connection_handle	ConnectionHandle
[in]	uuid	BtdrvGattAttributeUuid
[out]	service	BtdevGattService
[out]	flag	Whether a BtdevGattService was returned.

btdevGetGattServices()

Result btdevGetGattServices	(	u32	connection_handle,
		BtdevGattService *	services,
		u8	count,
		u8 *	total_out
	)

Wrapper for btmuGetGattServices.

Parameters

[in]	connection_handle	ConnectionHandle
[out]	services	Output array of BtdevGattService.
[in]	count	Size of the services array in entries. The max is 100.
[out]	total_out	Total output entries.

btdevReadGattCharacteristic()

Result btdevReadGattCharacteristic

(

BtdevGattCharacteristic *

c

)

Wrapper for btLeClientReadCharacteristic.

Note

An error is thrown if the properties from btdevGattCharacteristicGetProperties don't allow using this.

Parameters

c	BtdevGattCharacteristic

btdevReadGattDescriptor()

Result btdevReadGattDescriptor

(

BtdevGattDescriptor *

d

)

Wrapper for btLeClientReadDescriptor.

Parameters

d	BtdevGattDescriptor

btdevRegisterGattOperationNotification()

Result btdevRegisterGattOperationNotification

(

const BtdrvGattAttributeUuid *

uuid

)

Wrapper for btmuRegisterBleGattDataPath.

Parameters

[in]

uuid

BtdrvGattAttributeUuid

btdevUnregisterGattOperationNotification()

Result btdevUnregisterGattOperationNotification

(

const BtdrvGattAttributeUuid *

uuid

)

Wrapper for btmuUnregisterBleGattDataPath.

Parameters

[in]

uuid

BtdrvGattAttributeUuid

btdevWriteGattCharacteristic()

Result btdevWriteGattCharacteristic

(

BtdevGattCharacteristic *

c

)

Wrapper for btLeClientWriteCharacteristic.

Note

An error is thrown if the properties from btdevGattCharacteristicGetProperties don't allow using this.

This uses the Value from btdevGattCharacteristicSetValue.

Parameters

c	BtdevGattCharacteristic

btdevWriteGattDescriptor()

Result btdevWriteGattDescriptor

(

BtdevGattDescriptor *

d

)

Wrapper for btLeClientWriteDescriptor.

Note

This uses the Value from btdevGattDescriptorSetValue.

Parameters

d	BtdevGattDescriptor