Mistake on this page?
Report an issue in GitHub or email us
Functions
LL_API_CIS

Functions

uint8_t LlSetCigParams (LlCisCigParams_t *pCigParam, uint16_t *pCisHandles)
 Used by a master host to set the parameters of all connected isochronous streams associated with a connected isochronous group in the controller. More...
 
uint8_t LlSetCigParamsTest (LlCisCigParamsTest_t *pSetCigParamTest, uint16_t *pCisHandles)
 Used by a master Host to set the parameters of all connected isochronous streams associated with a connected isochronous group in the controller for testing purpose. More...
 
uint8_t LlCreateCis (uint8_t numCis, LlCisCreateCisParams_t *pCreateCisParam)
 Used by the master host to establish one or more connected isochronous streams. More...
 
uint8_t LlRemoveCig (uint8_t cigId)
 Removes all the connected isochronous streams which have previously been set up. More...
 
uint8_t LlAcceptCisReq (uint16_t cisHandle)
 Used by the slave host to inform the controller to accept the request for the connected isochronous stream. More...
 
uint8_t LlRejectCisReq (uint16_t cisHandle, uint8_t reason)
 Used by the slave host to inform the controller to reject the request for the connected isochronous stream. More...
 
uint8_t LlCreateBig (LlCreateBig_t *pCreateBig)
 Used by a broadcaster host to command is used to create one or more BISes of a BIG in the controller. More...
 
uint8_t LlCreateBigTest (LlCreateBigTest_t *pCreateBigTest)
 Used by a broadcaster host to command is used to create one or more BISes of a BIG in the ISO test mode. More...
 
uint8_t LlTerminateBig (uint8_t bigHandle, uint8_t reason)
 Used to terminate the transmission of all BISes of a BIG, or to cancel the process of creating a BIG using the HCI_LE_Create_BIG command from the Isochronous Broadcaster. More...
 
uint8_t LlBigCreateSync (LlBigCreateSync_t *pCreateSync)
 Used to synchronize and receive PDUs from one or more BISes within a BIG. More...
 
void LlBigTerminateSync (uint8_t bigHandle)
 Used to stop synchronization with the BIG or to cancel the process of synchronizing to BISes invoked by the HCI_LE_BIG_Create_Sync command. More...
 
uint8_t LlReadIsoTxSync (uint16_t handle, uint16_t *pPktSn, uint32_t *pTs, uint32_t *pTimeOffs)
 Read the Time_Stamp and Time_Offset of a transmitted ISO_SDU identified by the Packet_Sequence_Number on a CIS or BIS identified by the Connection_Handle. More...
 
uint8_t LlSetupIsoDataPath (LlIsoSetupDataPath_t *pSetupDataPath)
 Used to identify and enable the isochronous data path between the host and the controller for each connected isochronous or broadcast isochronous stream. More...
 
uint8_t LlRemoveIsoDataPath (uint16_t handle, uint8_t dpDir)
 Used to remove the isochronous data path associated with the connected isochronous or broadcast isochronous stream. More...
 
void LlCisSlaveInit (void)
 Initialize LL subsystem for operation for slave connected isochronous stream. More...
 
void LlCisMasterInit (void)
 Initialize LL subsystem for operation for master connected isochronous stream. More...
 
uint16_t LlInitCisMem (uint8_t *pFreeMem, uint32_t freeMemSize)
 Initialize memory for CIS. More...
 
void LlBisSlaveInit (void)
 Initialize LL subsystem for operation for slave broadcast isochronous stream. More...
 
void LlBisMasterInit (void)
 Initialize LL subsystem for operation for master broadcast isochronous stream. More...
 
uint16_t LlInitBisMem (uint8_t *pFreeMem, uint32_t freeMemSize)
 Initialize memory for BIS. More...
 
uint16_t LlInitIsoMem (uint8_t *pFreeMem, uint32_t freeMemSize)
 Initialize memory for ISO. More...
 
void LlInitCodec (void)
 Initialize LL for use with an audio codec. More...
 
void LlSendIsoData (uint8_t *pData)
 Send an ISO data packet. More...
 
uint8_t * LlRecvIsoData (void)
 Receive an ISO data packet. More...
 
void LlRecvIsoDataComplete (uint8_t numBufs)
 Indicate that received ISO data buffer has been deallocated. More...
 

Detailed Description

Function Documentation

uint8_t LlAcceptCisReq ( uint16_t  cisHandle)

Used by the slave host to inform the controller to accept the request for the connected isochronous stream.

Parameters
cisHandleHandle of the connected isochronous stream.
Returns
Status error code.
uint8_t LlBigCreateSync ( LlBigCreateSync_t pCreateSync)

Used to synchronize and receive PDUs from one or more BISes within a BIG.

Parameters
pCreateSyncBIG Create Sync parameters.
Returns
Status error code.
void LlBigTerminateSync ( uint8_t  bigHandle)

Used to stop synchronization with the BIG or to cancel the process of synchronizing to BISes invoked by the HCI_LE_BIG_Create_Sync command.

Parameters
bigHandleUsed to identify the BIG.
void LlBisMasterInit ( void  )

Initialize LL subsystem for operation for master broadcast isochronous stream.

This function initializes the LL subsystem for use as a master broadcast isochronous stream.

void LlBisSlaveInit ( void  )

Initialize LL subsystem for operation for slave broadcast isochronous stream.

This function initializes the LL subsystem for use as a slave broadcast isochronous stream.

void LlCisMasterInit ( void  )

Initialize LL subsystem for operation for master connected isochronous stream.

This function initializes the LL subsystem for use as a master connected isochronous stream.

void LlCisSlaveInit ( void  )

Initialize LL subsystem for operation for slave connected isochronous stream.

This function initializes the LL subsystem for use as a slave connected isochronous stream.

uint8_t LlCreateBig ( LlCreateBig_t pCreateBig)

Used by a broadcaster host to command is used to create one or more BISes of a BIG in the controller.

Parameters
pCreateBigCreate BIG parameters.
Returns
Status error code.
uint8_t LlCreateBigTest ( LlCreateBigTest_t pCreateBigTest)

Used by a broadcaster host to command is used to create one or more BISes of a BIG in the ISO test mode.

Parameters
pCreateBigTestCreate BIG Test parameters.
Returns
Status error code.
uint8_t LlCreateCis ( uint8_t  numCis,
LlCisCreateCisParams_t pCreateCisParam 
)

Used by the master host to establish one or more connected isochronous streams.

Parameters
numCisNumber of connected isochronous streams.
pCreateCisParamParameters for create connected isochronous stream.
Returns
Status error code.
uint16_t LlInitBisMem ( uint8_t *  pFreeMem,
uint32_t  freeMemSize 
)

Initialize memory for BIS.

Parameters
pFreeMemPointer to free memory.
freeMemSizeSize of pFreeMem.
Returns
Amount of free memory consumed.

This function allocates memory for BIS.

Note
This routine must be called after LlInitRunTimeCfg() but only once before any other initialization routines.
uint16_t LlInitCisMem ( uint8_t *  pFreeMem,
uint32_t  freeMemSize 
)

Initialize memory for CIS.

Parameters
pFreeMemPointer to free memory.
freeMemSizeSize of pFreeMem.
Returns
Amount of free memory consumed.

This function allocates memory for CIS.

Note
This routine must be called after LlInitRunTimeCfg() but only once before any other initialization routines.
void LlInitCodec ( void  )

Initialize LL for use with an audio codec.

Assign codec functions for direct LL audio streaming.

uint16_t LlInitIsoMem ( uint8_t *  pFreeMem,
uint32_t  freeMemSize 
)

Initialize memory for ISO.

Parameters
pFreeMemPointer to free memory.
freeMemSizeSize of pFreeMem.
Returns
Amount of free memory consumed.

This function allocates memory for CIS.

Note
This routine must be called after LlInitRunTimeCfg() but only once before any other initialization routines.
uint8_t LlReadIsoTxSync ( uint16_t  handle,
uint16_t *  pPktSn,
uint32_t *  pTs,
uint32_t *  pTimeOffs 
)

Read the Time_Stamp and Time_Offset of a transmitted ISO_SDU identified by the Packet_Sequence_Number on a CIS or BIS identified by the Connection_Handle.

Parameters
handleBIS or CIS handle.
pPktSnPacket sequence number.
pTsTimestamp.
pTimeOffsTime offset.
Returns
Status error code.
uint8_t* LlRecvIsoData ( void  )

Receive an ISO data packet.

Returns
Data buffer.

Receive an ISO data packet. If no ISO buffers are available this function returns NULL.

Note
The host must deallocate the buffer by calling WsfMsgFree() and call LlRecvBufCmpl() to update LL accounting.
void LlRecvIsoDataComplete ( uint8_t  numBufs)

Indicate that received ISO data buffer has been deallocated.

Parameters
numBufsNumber of completed packets.

Indicate that received ISO data buffer has been deallocated.

uint8_t LlRejectCisReq ( uint16_t  cisHandle,
uint8_t  reason 
)

Used by the slave host to inform the controller to reject the request for the connected isochronous stream.

Parameters
cisHandleHandle of the connected isochronous stream.
reasonIndicate the reason for rejecting the request.
Returns
Status error code.
uint8_t LlRemoveCig ( uint8_t  cigId)

Removes all the connected isochronous streams which have previously been set up.

Parameters
cigIdIdentifier of the connected isochronous group.
Returns
Status error code.
uint8_t LlRemoveIsoDataPath ( uint16_t  handle,
uint8_t  dpDir 
)

Used to remove the isochronous data path associated with the connected isochronous or broadcast isochronous stream.

Parameters
handleHandle for CIS or BIS.
dpDirDirection of data path to remove.
Returns
Status error code.
void LlSendIsoData ( uint8_t *  pData)

Send an ISO data packet.

Parameters
pDataData buffer

Send an ISO data packet. pData points to an ISO buffer formatted according to [1]; the host must set the connection handle, flags, and length fields in the buffer.

uint8_t LlSetCigParams ( LlCisCigParams_t pCigParam,
uint16_t *  pCisHandles 
)

Used by a master host to set the parameters of all connected isochronous streams associated with a connected isochronous group in the controller.

Parameters
pCigParamCIG parameters.
pCisHandlesReturn buffer for the connected isochronous handles.
Returns
Status error code.
uint8_t LlSetCigParamsTest ( LlCisCigParamsTest_t pSetCigParamTest,
uint16_t *  pCisHandles 
)

Used by a master Host to set the parameters of all connected isochronous streams associated with a connected isochronous group in the controller for testing purpose.

Parameters
pSetCigParamTestCIG test parameters.
pCisHandlesReturn buffer for the connected isochronous handles.
Returns
Status error code.
uint8_t LlSetupIsoDataPath ( LlIsoSetupDataPath_t pSetupDataPath)

Used to identify and enable the isochronous data path between the host and the controller for each connected isochronous or broadcast isochronous stream.

Parameters
pSetupDataPathParameters for setup ISO data path.
Returns
Status error code.
uint8_t LlTerminateBig ( uint8_t  bigHandle,
uint8_t  reason 
)

Used to terminate the transmission of all BISes of a BIG, or to cancel the process of creating a BIG using the HCI_LE_Create_BIG command from the Isochronous Broadcaster.

Parameters
bigHandleUsed to identify the BIG.
reasonTermination reason.
Returns
Status error code.
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.