util.h

Go to the documentation of this file.

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

 @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_EVENT_ID_NONE       (0)   // Event_Id_NONE
#define UTIL_EVENT_ID_00         (0x1) // Event_Id_00
#define UTIL_EVENT_ID_01         (0x2) // Event_Id_01
#define UTIL_EVENT_ID_02         (0x4) // Event_Id_02
#define UTIL_EVENT_ID_03         (0x8) // Event_Id_03
#define UTIL_EVENT_ID_04         (0x10)// Event_Id_04
#define UTIL_EVENT_ID_05         (0x20)// Event_Id_05
#define UTIL_EVENT_ID_06         (0x40)// Event_Id_06
#define UTIL_QUEUE_EVENT_ID      (0x00100000)//Event_Id_30
#define UTIL_TL_CB_EVENT         UTIL_EVENT_ID_00 // Event_Id_00
#else
#define UTIL_QUEUE_EVENT_ID Event_Id_30
#endif
/*********************************************************************
 * TYPEDEFS
 */

#ifdef FREERTOS
typedef void (*UtilTimerCback)(uint32_t arg);

typedef struct Clock_Struct
{
    timer_t clock;
    UtilTimerCback cback;
    uint32_t 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, UtilTimerCback clockCB,
                          uint32_t clockDuration, uint32_t clockPeriod,
                          uint8_t startFlag, uint32_t 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  FREERTOS
/*********************************************************************
 * @fn      Event_post
 *
 * @brief   DPL that is used to signal events. If a task is waiting
 *          for the event and the event conditions are met, post()
 *          unblocks the task. If no tasks are waiting, post() simply
 *          registers the event with the event object and returns.
 *
 * @param   eventQueue - handle of a event queue
 * @param   msg - mask of eventIds to post (must be non-zero)
 */
extern void Event_post(mqd_t eventQueue, uint32_t msg);
#endif

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

#ifdef __cplusplus
}
#endif

#endif /* UTIL_H */