ble/html/util_8h_source.html

 /******************************************************************************

  @file  util.h

  @brief This file contains function declarations common to CC26xx
         TIRTOS Applications.

  Group: WCS, BTS
  $Target Device: DEVICES $

  ******************************************************************************
  $License: BSD3 2014 $
  ******************************************************************************
  $Release Name: PACKAGE NAME $
  $Release Date: PACKAGE RELEASE DATE $
  *****************************************************************************/

 #ifndef UTIL_H
 #define UTIL_H

 #ifdef __cplusplus
 extern "C" {
 #endif

 /*********************************************************************
  * INCLUDES
  */
 #include <stdbool.h>
 #ifdef FREERTOS
 #include <mqueue.h>
 #include <pthread.h>
     #ifndef Event_Handle
     #define Event_Handle void*
     #endif
 #else
 #include <ti/sysbios/knl/Queue.h>
 #include <ti/sysbios/knl/Clock.h>
 #include <ti/sysbios/knl/Event.h>
 #endif

 /*********************************************************************
 *  EXTERNAL VARIABLES
 */

 /*********************************************************************
  * CONSTANTS
  */

 #ifdef FREERTOS
 #define UTIL_QUEUE_EVENT_ID (0x40000000)//Event_Id_30
 #else
 #define UTIL_QUEUE_EVENT_ID Event_Id_30
 #endif
 /*********************************************************************
  * TYPEDEFS
  */

 #ifdef FREERTOS
 typedef struct Clock_Struct
 {
     timer_t clock;
     void *cback;
     void *arg;
     sigevent evnt;
     pthread_attr_t timerThrdAttr;
     struct itimerspec timeVal;
     uint8_t isActive;
 }Clock_Struct;
 #endif

 typedef struct
 {
   uint16_t event; // Event type.
   uint8_t state; // Event state;
 }appEvtHdr_t;

 /*********************************************************************
  * MACROS
  */

 /*********************************************************************
  * API FUNCTIONS
  */

 #ifdef FREERTOS
 void* Util_constructClock(Clock_Struct *entry, void *clockCB,
                           uint32_t clockDuration, uint32_t clockPeriod,
                           uint8_t startFlag, void *arg);

 void Clock_destruct(Clock_Struct *structP);
 #else
 extern Clock_Handle Util_constructClock(Clock_Struct *pClock,
                                         Clock_FuncPtr clockCB,
                                         uint32_t clockDuration,
                                         uint32_t clockPeriod,
                                         uint8_t startFlag,
                                         UArg arg);
 #endif

 extern void Util_startClock(Clock_Struct *pClock);

 extern void Util_restartClock(Clock_Struct *pClock, uint32_t clockTimeout);

 extern bool Util_isActive(Clock_Struct *pClock);

 extern void Util_stopClock(Clock_Struct *pClock);

 extern void Util_rescheduleClock(Clock_Struct *pClock, uint32_t clockPeriod);

 #ifdef FREERTOS
 extern void Util_constructQueue(mqd_t *pQueue);
 #else
 extern Queue_Handle Util_constructQueue(Queue_Struct *pQueue);
 #endif

 #ifdef FREERTOS
 uint8_t Util_enqueueMsg(mqd_t msgQueue,
                         Event_Handle event,
                         uint8_t *pMsg);
 #else

 extern uint8_t Util_enqueueMsg(Queue_Handle msgQueue,
                                Event_Handle event,
                                uint8_t *pMsg);
 #endif

 #ifdef FREERTOS
 uint8_t *Util_dequeueMsg(mqd_t msgQueue);
 #else
 extern uint8_t *Util_dequeueMsg(Queue_Handle msgQueue);
 #endif

 extern char *Util_convertBdAddr2Str(uint8_t *pAddr);

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


 /*********************************************************************
 *********************************************************************/

 #ifdef __cplusplus
 }
 #endif

 #endif /* UTIL_H */

Util_dequeueMsg
uint8_t * Util_dequeueMsg(Queue_Handle msgQueue)
Dequeues the message from the RTOS queue.

Util_isBufSet
uint8_t Util_isBufSet(uint8_t *pBuf, uint8_t pattern, uint16_t len)
Check if contents of buffer matches byte pattern.

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.

Util_rescheduleClock
void Util_rescheduleClock(Clock_Struct *pClock, uint32_t clockPeriod)
Reschedule a clock by changing the timeout and period values.

Util_startClock
void Util_startClock(Clock_Struct *pClock)
Start a clock.

Util_convertBdAddr2Str
char * Util_convertBdAddr2Str(uint8_t *pAddr)
Convert Bluetooth address to string. Only needed when LCD display is used.

Util_stopClock
void Util_stopClock(Clock_Struct *pClock)
Stop a clock.

Util_restartClock
void Util_restartClock(Clock_Struct *pClock, uint32_t clockTimeout)
Restart a clock by changing the timeout.

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.

Util_constructQueue
Queue_Handle Util_constructQueue(Queue_Struct *pQueue)
Initialize an RTOS queue to hold messages from profile to be processed.

Util_isActive
bool Util_isActive(Clock_Struct *pClock)
Determine if a clock is currently active.