TI BLE5-Stack API Documentation  1.01.01.00
Files | Macros | Functions
Util

This module implements Utility function. More...

Files

file  util.h
 Util layer interface.
 

Macros

#define UTIL_QUEUE_EVENT_ID   Event_Id_30
 Util Queue Event ID. More...
 

Functions

Clock_Handle Util_constructClock (Clock_Struct *pClock, Clock_FuncPtr clockCB, uint32_t clockDuration, uint32_t clockPeriod, uint8_t startFlag, UArg arg)
 Initialize a TIRTOS Clock instance. More...
 
Queue_Handle Util_constructQueue (Queue_Struct *pQueue)
 Initialize an RTOS queue to hold messages from profile to be processed. More...
 
char * Util_convertBdAddr2Str (uint8_t *pAddr)
 Convert Bluetooth address to string. Only needed when LCD display is used. More...
 
uint8_t * Util_dequeueMsg (Queue_Handle msgQueue)
 Dequeues the message from the RTOS queue. More...
 
uint8_t Util_enqueueMsg (Queue_Handle msgQueue, Event_Handle event, uint8_t *pMsg)
 Creates a queue node and puts the node in RTOS queue. More...
 
bool Util_isActive (Clock_Struct *pClock)
 Determine if a clock is currently active. More...
 
uint8_t Util_isBufSet (uint8_t *pBuf, uint8_t pattern, uint16_t len)
 Check if contents of buffer matches byte pattern. More...
 
void Util_rescheduleClock (Clock_Struct *pClock, uint32_t clockPeriod)
 Reschedule a clock by changing the timeout and period values. More...
 
void Util_restartClock (Clock_Struct *pClock, uint32_t clockTimeout)
 Restart a clock by changing the timeout. More...
 
void Util_startClock (Clock_Struct *pClock)
 Start a clock. More...
 
void Util_stopClock (Clock_Struct *pClock)
 Stop a clock. More...
 

Detailed Description

This module implements Utility function.

Macro Definition Documentation

§ UTIL_QUEUE_EVENT_ID

#define UTIL_QUEUE_EVENT_ID   Event_Id_30

Util Queue Event ID.

In order to wake an application when a message is inserted into its queue, an event must be posted. Util reserved Event Id 30 for a generic queue event.

Function Documentation

§ Util_constructClock()

Clock_Handle Util_constructClock ( Clock_Struct *  pClock,
Clock_FuncPtr  clockCB,
uint32_t  clockDuration,
uint32_t  clockPeriod,
uint8_t  startFlag,
UArg  arg 
)

Initialize a TIRTOS Clock instance.

Parameters
pClock- pointer to clock instance structure.
clockCB- callback function upon clock expiration.
clockDuration- longevity of clock timer in milliseconds
clockPeriod- duration of a periodic clock, used continuously after clockDuration expires.
startFlag- TRUE to start immediately, FALSE to wait.
arg- argument passed to callback function.
Returns
Clock_Handle - a handle to the clock instance.

§ Util_constructQueue()

Queue_Handle Util_constructQueue ( Queue_Struct *  pQueue)

Initialize an RTOS queue to hold messages from profile to be processed.

Parameters
pQueue- pointer to queue instance structure.
Returns
A queue handle.

§ Util_convertBdAddr2Str()

char* Util_convertBdAddr2Str ( uint8_t *  pAddr)

Convert Bluetooth address to string. Only needed when LCD display is used.

Parameters
pAddr- BD address
Returns
BD address as a string

§ Util_dequeueMsg()

uint8_t* Util_dequeueMsg ( Queue_Handle  msgQueue)

Dequeues the message from the RTOS queue.

Parameters
msgQueue- queue handle.
Returns
pointer to dequeued message, NULL otherwise.

§ Util_enqueueMsg()

uint8_t Util_enqueueMsg ( Queue_Handle  msgQueue,
Event_Handle  event,
uint8_t *  pMsg 
)

Creates a queue node and puts the node in RTOS queue.

Parameters
msgQueue- queue handle.
event- the thread's event processing event that this queue is associated with.
pMsg- pointer to message to be queued
Returns
TRUE if message was queued, FALSE otherwise.

§ Util_isActive()

bool Util_isActive ( Clock_Struct *  pClock)

Determine if a clock is currently active.

Parameters
pClock- pointer to clock struct
Returns
TRUE or FALSE

§ Util_isBufSet()

uint8_t Util_isBufSet ( uint8_t *  pBuf,
uint8_t  pattern,
uint16_t  len 
)

Check if contents of buffer matches byte pattern.

Parameters
pBuf- buffer to check
pattern- pattern to match
len- len of buffer (in bytes) to iterate over
Returns
TRUE if buffer matches the pattern, FALSE otherwise.

§ Util_rescheduleClock()

void Util_rescheduleClock ( Clock_Struct *  pClock,
uint32_t  clockPeriod 
)

Reschedule a clock by changing the timeout and period values.

Parameters
pClock- pointer to clock struct
clockPeriod- longevity of clock timer in milliseconds
Returns
none

§ Util_restartClock()

void Util_restartClock ( Clock_Struct *  pClock,
uint32_t  clockTimeout 
)

Restart a clock by changing the timeout.

Parameters
pClock- pointer to clock struct
clockTimeout- longevity of clock timer in milliseconds
Returns
none

§ Util_startClock()

void Util_startClock ( Clock_Struct *  pClock)

Start a clock.

Parameters
pClock- pointer to clock struct
Returns
none

§ Util_stopClock()

void Util_stopClock ( Clock_Struct *  pClock)

Stop a clock.

Parameters
pClock- pointer to clock struct
Returns
none
Copyright 2018, Texas Instruments Incorporated