This module implements Utility function.
More...
|
file | util.h |
| Util layer interface.
|
|
|
uint16_t | appEvtHdr_t::event |
|
uint8_t | appEvtHdr_t::state |
|
This module implements Utility function.
§ 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
-
- Returns
- BD address as a string
§ Util_dequeueMsg()
uint8_t* Util_dequeueMsg |
( |
Queue_Handle |
msgQueue | ) |
|
Dequeue the message from the RTOS queue.
- Parameters
-
- Returns
- pointer to dequeued message, NULL otherwise.
§ Util_enqueueMsg()
uint8_t Util_enqueueMsg |
( |
Queue_Handle |
msgQueue, |
|
|
Semaphore_Handle |
sem, |
|
|
uint8_t * |
pMsg |
|
) |
| |
Creates a queue node and puts the node in RTOS queue.
- Parameters
-
msgQueue | - queue handle. |
sem | - the thread's event processing semaphore that this queue is associated with. |
pMsg | - pointer to message to be queued |
- Returns
- TRUE if message was queued, FALSE otherwise.
- Parameters
-
§ 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_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 |
§ 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 |
§ Util_startClock()
void Util_startClock |
( |
Clock_Struct * |
pClock | ) |
|
Start a clock.
- Parameters
-
pClock | - pointer to clock struct |
§ Util_stopClock()
void Util_stopClock |
( |
Clock_Struct * |
pClock | ) |
|
Stop a clock.
- Parameters
-
pClock | - pointer to clock struct |