Functions
void	BbStart (PalBbProt_t protId)
	Start BB processing of given protocol. More...

void	BbStop (PalBbProt_t protId)
	Stop BB processing of given protocol. More...

void	BbExecuteBod (BbOpDesc_t *pBod)
	Execute BOD. More...

void	BbCancelBod (void)
	Cancel current executing BOD. More...

BbOpDesc_t *	BbGetCurrentBod (void)
	Get the currently-executing BOD. More...

void	BbSetBodTerminateFlag (void)
	Set termination flag of current executing BOD. More...

bool_t	BbGetBodTerminateFlag (void)
	Get termination state of current executing BOD. More...

void	BbTerminateBod (void)
	Terminate a BOD immediately. More...

uint16_t	BbGetClockAccuracy (void)
	Get BB clock accuracy. More...

uint32_t	BbGetBbTimerBoundaryUs (void)
	Get BB timer boundary before wraparound. More...

uint16_t	BbGetSchSetupDelayUs (void)
	Get scheduler setup delay. More...

uint32_t	BbAdjustTime (uint32_t dueUsec)
	Adjust new time tick with wraparound. More...

uint32_t	BbGetTargetTimeDelta (uint32_t targetUsec, uint32_t refUsec)
	Get Delta between target and reference time. Only valid if target time is in the future. More...

uint8_t	BbGetActiveProtocol (void)
	Returns the ID of the active protocol. More...

Detailed Description

Function Documentation

uint32_t BbAdjustTime ( uint32_t dueUsec )

Adjust new time tick with wraparound.

Parameters

dueUsec Time tick without wraparound in microseconds.

Returns: Time tick with wraparound.

Note: dueUsec can only be at most +/-(BbTimerBoundaryUs/2) out of range.

void BbCancelBod ( void )

Cancel current executing BOD.

void BbExecuteBod ( BbOpDesc_t * pBod )

Execute BOD.

Parameters

pBod	Pointer to the BOD to execute.

Execute the protocol specific BOD handler.

uint8_t BbGetActiveProtocol ( void )

Returns the ID of the active protocol.

Returns: Protocol operation in progress.

uint32_t BbGetBbTimerBoundaryUs ( void )

Get BB timer boundary before wraparound.

Returns: Time boundary in microseconds.

bool_t BbGetBodTerminateFlag ( void )

Get termination state of current executing BOD.

Returns: TRUE if termination flag set, FALSE otherwise.

uint16_t BbGetClockAccuracy ( void )

Get BB clock accuracy.

Returns: Clock accuracy in part per million.

Returns the current BB clock accuracy.

BbOpDesc_t* BbGetCurrentBod ( void )

Get the currently-executing BOD.

Returns: Currently-executing BOD.

uint16_t BbGetSchSetupDelayUs ( void )

Get scheduler setup delay.

Returns: Scheduler setup delay in microseconds.

Returns the scheduler setup delay.

uint32_t BbGetTargetTimeDelta	(	uint32_t	targetUsec,
		uint32_t	refUsec
	)

Get Delta between target and reference time. Only valid if target time is in the future.

Parameters

targetUsec	Target time in microseconds.
refUsec	Reference time in microseconds.

Returns: Positive number in microseconds if target time is in the future. Zero if target time is in the past or same compared with reference time.

Note: Caller has to make sure target time and reference time are within SCH_MAX_SPAN.

void BbSetBodTerminateFlag ( void )

Set termination flag of current executing BOD.

Note: This function is expected to be called during the execution context of the current executing BOD, typically in the related ISRs. In the end, termination flag will help to decide if BbTerminateBod() should be called.

void BbStart ( PalBbProt_t protId )

Start BB processing of given protocol.

Parameters

protId Protocol ID.

Enable BB and start processing the list of BODs. This routine may be called several times, if a protocol layers has several simultaneously-enabled operations. However, BbStop() must be called an equal number of time to disable the baseband.

void BbStop ( PalBbProt_t protId )

Stop BB processing of given protocol.

Parameters

protId Protocol ID.

Disable BB processing of BODs.

Note: For any particular protocol, calls to BbStart() and BbStop() must be balanced to ensure that the hardware is disabled if and only if appropriate.

void BbTerminateBod ( void )

Terminate a BOD immediately.

Note: This function is expected to be called during the execution context of the current executing BOD, typically in the related ISRs.

Functions

Detailed Description

Function Documentation

Important Information for this Arm website