Data Structures
struct	LlInitParam_t
	Initiating parameters (LlExtCreateConn()). More...

struct	LlExtInitParam_t
	Initiating parameters (LlExtCreateConn()). More...

struct	LlExtInitScanParam_t
	Initiating scan parameters (LlExtCreateConn()). More...

struct	LlConnSpec_t
	Connection specification (LlCreateConn(), LlConnUpdate() and LlExtCreateConn()). More...

Macros
#define	LL_PC_PATH_LOSS_UNUSED_HIGH_THRESHOLD 0xFF
	PCL path loss monitoring unused high threshold value. More...

Enumerations

Functions
uint8_t	LlDisconnect (uint16_t handle, uint8_t reason)
	Disconnect a connection. More...

uint8_t	LlSetConnOpFlags (uint16_t handle, uint32_t flags, bool_t enable)
	Set connection's operational mode flags. More...

uint8_t	LlReadRemoteFeat (uint16_t handle)
	Read remote features. More...

uint8_t	LlReadRemoteVerInfo (uint16_t handle)
	Read remote version information. More...

uint8_t	LlGetRssi (uint16_t handle, int8_t *pRssi)
	Get RSSI of a connection. More...

uint8_t	LlGetTxPowerLevel (uint16_t handle, uint8_t type, int8_t *pLevel)
	Get connection's TX power level. More...

uint8_t	LlGetEnhTxPowerLevel (uint16_t handle, uint8_t phy, int8_t pCurPwr, int8_t pMaxPwr)
	Get connection's enhanced TX power level and max txPower. More...

uint8_t	LlSetAllPhyTxPowerLevel (uint16_t handle, int8_t level)
	Set connection's TX power level (all PHYs). More...

uint8_t	LlSetPhyTxPowerLevel (uint16_t handle, int8_t level, uint8_t phy)
	Set connection's TX power level for a PHY. More...

uint8_t	LlConnUpdate (uint16_t handle, const LlConnSpec_t *pConnSpec)
	Update connection parameters. More...

uint8_t	LlRemoteConnParamReqReply (uint16_t handle, const LlConnSpec_t *pConnSpec)
	Remote connection parameter request reply. More...

uint8_t	LlRemoteConnParamReqNegReply (uint16_t handle, uint8_t reason)
	Remote connection parameter request negative reply. More...

uint8_t	LlSetChannelMap (uint16_t handle, const uint8_t *pChanMap)
	Set connection's channel map. More...

uint8_t	LlGetChannelMap (uint16_t handle, uint8_t *pChanMap)
	Get connection's channel map. More...

uint8_t	LlSetDataLen (uint16_t handle, uint16_t txLen, uint16_t txTime)
	Set data length. More...

void	LlReadDefaultDataLen (uint16_t pMaxTxLen, uint16_t pMaxTxTime)
	Read default data length. More...

uint8_t	LlWriteDefaultDataLen (uint16_t maxTxLen, uint16_t maxTxTime)
	Write default data length. More...

void	LlReadMaximumDataLen (uint16_t pMaxTxLen, uint16_t pMaxTxTime, uint16_t pMaxRxLen, uint16_t pMaxRxTime)
	Read maximum data length. More...

uint8_t	LlReadPhy (uint16_t handle, uint8_t pTxPhy, uint8_t pRxPhy)
	Read current transmitter PHY and receive PHY. More...

uint8_t	LlSetDefaultPhy (uint8_t allPhys, uint8_t txPhys, uint8_t rxPhys)
	Set default PHYs. More...

bool_t	llValidatePhySupport (uint8_t txPhys, uint8_t rxPhys)
	Validate if specified PHYs are supported by LL. More...

uint8_t	LlSetPhy (uint16_t handle, uint8_t allPhys, uint8_t txPhys, uint8_t rxPhys, uint16_t phyOptions)
	Set PHY for a connection. More...

uint8_t	LlSetLocalMinUsedChan (uint8_t phys, int8_t pwrThres, uint8_t minUsedCh)
	Set local minimum number of used channels. More...

uint8_t	LlGetPeerMinUsedChan (uint16_t handle, uint8_t *pPeerMinUsedChan)
	Get peer minimum number of used channels. More...

uint8_t	LlRequestPeerSca (uint16_t handle)
	Used to read the sleep clock accuracy of the peer device. More...

Detailed Description

Macro Definition Documentation

#define LL_PC_PATH_LOSS_UNUSED_HIGH_THRESHOLD 0xFF

PCL path loss monitoring unused high threshold value.

Definition at line 586 of file ll_api.h.

Enumeration Type Documentation

anonymous enum

Master clock accuracy.

Enumerator
LL_MCA_500_PPM	500 ppm
LL_MCA_250_PPM	250 ppm
LL_MCA_150_PPM	150 ppm
LL_MCA_100_PPM	100 ppm
LL_MCA_75_PPM	75 ppm
LL_MCA_50_PPM	50 ppm
LL_MCA_30_PPM	30 ppm
LL_MCA_20_PPM	20 ppm

Definition at line 515 of file ll_api.h.

anonymous enum

PHYS specification.

Enumerator
LL_PHYS_NONE	No selected PHY.
LL_PHYS_LE_1M_BIT	LE 1M PHY.
LL_PHYS_LE_2M_BIT	LE 2M PHY.
LL_PHYS_LE_CODED_BIT	LE Coded PHY.

Definition at line 528 of file ll_api.h.

anonymous enum

All PHYs preference.

Enumerator
LL_ALL_PHY_ALL_PREFERENCES	All PHY preferences.
LL_ALL_PHY_TX_PREFERENCE_BIT	Set if no Tx PHY preference.
LL_ALL_PHY_RX_PREFERENCE_BIT	Set if no Rx PHY preference.

Definition at line 537 of file ll_api.h.

anonymous enum

PHY options.

Enumerator
LL_PHY_OPTIONS_NONE	No preferences.
LL_PHY_OPTIONS_S2_PREFERRED	S=2 coding preferred when transmitting on LE Coded PHY.
LL_PHY_OPTIONS_S8_PREFERRED	S=8 coding preferred when transmitting on LE Coded PHY.

Definition at line 545 of file ll_api.h.

anonymous enum

Power Control managed PHYs.

Definition at line 562 of file ll_api.h.

anonymous enum

Power control PHY bits.

Enumerator
LL_PC_1M_BIT	LE 1M PHY bit.
LL_PC_2M_BIT	LE 2M PHY bit.
LL_PC_CODED_S8_BIT	LE Coded S8 PHY bit.
LL_PC_CODED_S2_BIT	LE Coded S2 PHY bit.

Definition at line 574 of file ll_api.h.

anonymous enum

Privacy modes.

Enumerator
LL_PRIV_MODE_NETWORK	Network privacy mode.
LL_PRIV_MODE_DEVICE	Device privacy mode.

Definition at line 589 of file ll_api.h.

anonymous enum

Channel selection algorithm methods.

Enumerator
LL_CH_SEL_1	Channel selection #1.
LL_CH_SEL_2	Channel selection #2.

Definition at line 635 of file ll_api.h.

anonymous enum

Tx power level type.

Enumerator
LL_TX_PWR_LVL_TYPE_CURRENT	Current transmit power level.
LL_TX_PWR_LVL_TYPE_MAX	Maximum transmit power level.

Definition at line 642 of file ll_api.h.

enum LlPhy_t

PHY types.

Enumerator
LL_PHY_NONE	PHY not selected.
LL_PHY_LE_1M	LE 1M PHY.
LL_PHY_LE_2M	LE 2M PHY.
LL_PHY_LE_CODED	LE Coded PHY.

Definition at line 553 of file ll_api.h.

Function Documentation

uint8_t LlConnUpdate	(	uint16_t	handle,
		const LlConnSpec_t *	pConnSpec
	)

Update connection parameters.

Parameters

handle	Connection handle.
pConnSpec	New connection specification.

Returns: Status error code.

Update the connection parameters of a connection.

uint8_t LlDisconnect	(	uint16_t	handle,
		uint8_t	reason
	)

Disconnect a connection.

Parameters

handle	Connection handle.
reason	Disconnect reason.

Returns: Status error code.

Disconnect a connection.

uint8_t LlGetChannelMap	(	uint16_t	handle,
		uint8_t *	pChanMap
	)

Get connection's channel map.

Parameters

handle	Connection handle.
pChanMap	Channel map.

Returns: Status error code.

Get the current channel map of a connection.

uint8_t LlGetEnhTxPowerLevel	(	uint16_t	handle,
		uint8_t	phy,
		int8_t *	pCurPwr,
		int8_t *	pMaxPwr
	)

Get connection's enhanced TX power level and max txPower.

Parameters

handle	Connection handle.
phy	PHY.
pCurPwr	Transmit power level.
pMaxPwr	Max power level.

Returns: Status error code.

uint8_t LlGetPeerMinUsedChan	(	uint16_t	handle,
		uint8_t *	pPeerMinUsedChan
	)

Get peer minimum number of used channels.

Parameters

handle	Connection handle.
pPeerMinUsedChan	Storage for the peer minimum number of used channels.

Returns: Status error code.

Get peer minimum number of used channels.

uint8_t LlGetRssi	(	uint16_t	handle,
		int8_t *	pRssi
	)

Get RSSI of a connection.

Parameters

handle	Connection handle.
pRssi	RSSI value.

Returns: Status error code.

Get the current RSSI of a connection.

uint8_t LlGetTxPowerLevel	(	uint16_t	handle,
		uint8_t	type,
		int8_t *	pLevel
	)

Get connection's TX power level.

Parameters

handle	Connection handle.
type	Power level type.
pLevel	Transmit power level.

Returns: Status error code.

Get the TX power of a connection.

void LlReadDefaultDataLen	(	uint16_t *	pMaxTxLen,
		uint16_t *	pMaxTxTime
	)

Read default data length.

Parameters

pMaxTxLen	Maximum number of payload bytes for a Data PDU
pMaxTxTime	Maximum microseconds for a Data PDU

Suggested length and microseconds that the local Controller should use to transmit a single Link Layer Data Channel PDU.

void LlReadMaximumDataLen	(	uint16_t *	pMaxTxLen,
		uint16_t *	pMaxTxTime,
		uint16_t *	pMaxRxLen,
		uint16_t *	pMaxRxTime
	)

Read maximum data length.

Parameters

pMaxTxLen	Maximum number of payload bytes for a Tx Data PDU
pMaxTxTime	Maximum microseconds for a Tx Data PDU
pMaxRxLen	Maximum number of payload bytes for a Rx Data PDU
pMaxRxTime	Maximum microseconds for a Rx Data PDU

Read the Controller's maximum supported payload octets and packet duration times for transmission and reception.

uint8_t LlReadPhy	(	uint16_t	handle,
		uint8_t *	pTxPhy,
		uint8_t *	pRxPhy
	)

Read current transmitter PHY and receive PHY.

Parameters

handle	Connection handle.
pTxPhy	Storage for transmitter PHY.
pRxPhy	Storage for receiver PHY.

Returns: Status error code.

Read current transmitter PHY and receive PHY.

uint8_t LlReadRemoteFeat ( uint16_t handle )

Read remote features.

Parameters

handle Connection handle.

Returns: Status error code.

Read the link layer features of the remote device.

uint8_t LlReadRemoteVerInfo ( uint16_t handle )

Read remote version information.

Parameters

handle Connection handle.

Returns: Status error code.

Read the version information of the remote device.

uint8_t LlRemoteConnParamReqNegReply	(	uint16_t	handle,
		uint8_t	reason
	)

Remote connection parameter request negative reply.

Parameters

handle	Connection handle.
reason	Reason code.

Returns: Status error code.

Negative reply to a connection parameter request.

uint8_t LlRemoteConnParamReqReply	(	uint16_t	handle,
		const LlConnSpec_t *	pConnSpec
	)

Remote connection parameter request reply.

Parameters

handle	Connection handle.
pConnSpec	New connection specification.

Returns: Status error code.

Reply to a connection parameter request.

uint8_t LlRequestPeerSca ( uint16_t handle )

Used to read the sleep clock accuracy of the peer device.

Parameters

handle Handle of the ACL.

Returns: Status error code.

uint8_t LlSetAllPhyTxPowerLevel	(	uint16_t	handle,
		int8_t	level
	)

Set connection's TX power level (all PHYs).

Parameters

handle	Connection handle.
level	Transmit power level.

Returns: Status error code.

uint8_t LlSetChannelMap	(	uint16_t	handle,
		const uint8_t *	pChanMap
	)

Set connection's channel map.

Parameters

handle	Connection handle.
pChanMap	Channel map.

Returns: Status error code.

Set the channel map of a connection.

uint8_t LlSetConnOpFlags	(	uint16_t	handle,
		uint32_t	flags,
		bool_t	enable
	)

Set connection's operational mode flags.

Parameters

handle	Connection handle.
flags	Flags.
enable	TRUE to set flags or FALSE to clear flags.

Returns: Status error code.

Set connection's operational mode flags governing LL operations.

uint8_t LlSetDataLen	(	uint16_t	handle,
		uint16_t	txLen,
		uint16_t	txTime
	)

Set data length.

Parameters

handle	Connection handle.
txLen	Maximum number of payload bytes for a Data PDU
txTime	Maximum microseconds for a Data PDU

Returns: Status error code.

Preferred maximum microseconds that the local Controller should use to transmit a single Link Layer Data Channel PDU.

uint8_t LlSetDefaultPhy	(	uint8_t	allPhys,
		uint8_t	txPhys,
		uint8_t	rxPhys
	)

Set default PHYs.

Parameters

allPhys	All PHYs preferences.
txPhys	Preferred transmitter PHYs.
rxPhys	Preferred receiver PHYs.

Returns: Status error code.

Specify the preferred values for the transmitter PHY and receiver PHY to be used for all subsequent connections over the LE transport.

uint8_t LlSetLocalMinUsedChan	(	uint8_t	phys,
		int8_t	pwrThres,
		uint8_t	minUsedCh
	)

Set local minimum number of used channels.

Parameters

phys	Bitmask for the PHYs.
pwrThres	Power threshold.
minUsedCh	Minimum number of used channels.

Returns: Status error code.

Set local minimum number of used channels.

uint8_t LlSetPhy	(	uint16_t	handle,
		uint8_t	allPhys,
		uint8_t	txPhys,
		uint8_t	rxPhys,
		uint16_t	phyOptions
	)

Set PHY for a connection.

Parameters

handle	Connection handle.
allPhys	All PHYs preferences.
txPhys	Preferred transmitter PHYs.
rxPhys	Preferred receiver PHYs.
phyOptions	PHY options.

Returns: Status error code.

Set PHY preferences for a given connection. The controller might not be able to make the change (e.g., because the peer does not support the requested PHY) or may decide that the current PHY is preferable.

uint8_t LlSetPhyTxPowerLevel	(	uint16_t	handle,
		int8_t	level,
		uint8_t	phy
	)

Set connection's TX power level for a PHY.

Parameters

handle	Connection handle.
level	Transmit power level.
phy	PHY txPower to change.

Returns: Status error code.

bool_t llValidatePhySupport	(	uint8_t	txPhys,
		uint8_t	rxPhys
	)

Validate if specified PHYs are supported by LL.

Parameters

txPhys	Preferred transmitter PHYs.
rxPhys	Preferred receiver PHYs.

Returns: TRUE if all specified PHYs are supported.

uint8_t LlWriteDefaultDataLen	(	uint16_t	maxTxLen,
		uint16_t	maxTxTime
	)

Write default data length.

Parameters

maxTxLen	Maximum number of payload bytes for a Data PDU
maxTxTime	Maximum microseconds for a Data PDU

Returns: Status error code.

Suggested length and microseconds that the local Controller should use to transmit a single Link Layer Data Channel PDU.

Data Structures

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

Enumeration Type Documentation

Function Documentation

Important Information for this Arm website