ugap.h

Go to the documentation of this file.

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

 Group: WCS, BTS
 $Target Device: DEVICES $

 ******************************************************************************
 $License: TISD 2009 $
 ******************************************************************************
 $Release Name: PACKAGE NAME $
 $Release Date: PACKAGE RELEASE DATE $
 *****************************************************************************/

#ifndef UGAP_H
#define UGAP_H

#ifdef __cplusplus
extern "C"
{
#endif

/*-------------------------------------------------------------------
 * INCLUDES
 */

/*-------------------------------------------------------------------
 * CONSTANTS
 */

#define UGAP_DUTY_TIME_UNIT    100L  

#if defined(FEATURE_BROADCASTER)

#define UGAP_BCAST_STATE_INVALID     0 
#define UGAP_BCAST_STATE_INITIALIZED 1 
#define UGAP_BCAST_STATE_IDLE        2 
#define UGAP_BCAST_STATE_ADVERTISING 3 
#define UGAP_BCAST_STATE_WAITING     4 
#define UGAP_BCAST_STATE_SUSPENDED   5 

#define UGB_EVT_STATE_CHANGE       1 
#define UGB_EVT_ADV_PREPARE        2 
#define UGB_EVT_ADV_POSTPROCESS    3 

#endif /* FEATURE_BROADCASTER */

#if defined(FEATURE_OBSERVER)

#define UGAP_SCAN_STATE_INVALID     0 
#define UGAP_SCAN_STATE_INITIALIZED 1 
#define UGAP_SCAN_STATE_IDLE        2 
#define UGAP_SCAN_STATE_SCANNING    3 
#define UGAP_SCAN_STATE_WAITING     4 
#define UGAP_SCAN_STATE_SUSPENDED   5 

#define UGAP_OBSERVER_EVT_STATE_CHANGE         4 
#define UGAP_OBSERVER_EVT_SCAN_INDICATION      5 
#define UGAP_OBSERVER_EVT_SCAN_WINDOW_COMPLETE 6 

#endif /* FEATURE_OBSERVER */
  
#if defined(FEATURE_MONITOR)

#define UGAP_MONITOR_STATE_INVALID     0 
#define UGAP_MONITOR_STATE_INITIALIZED 1 
#define UGAP_MONITOR_STATE_IDLE        2 
#define UGAP_MONITOR_STATE_MONITORING  3 

#define UGAP_MONITOR_EVT_STATE_CHANGE         7 
#define UGAP_MONITOR_EVT_MONITOR_INDICATION   8 
#define UGAP_MONITOR_EVT_MONITOR_COMPLETE     9 

#endif /* FEATURE_MONITOR */  
  
/*-------------------------------------------------------------------
 * TYPEDEFS
 */

#if defined(FEATURE_BROADCASTER)

typedef uint8 ugapBcastState_t;      

typedef void (*ugapBcastStateChangeCb_t)(ugapBcastState_t state);

typedef void (*ugapBcastAdvPrepareCb_t)(void);

typedef void (*ugapBcastAdvDoneCb_t)(bStatus_t status);

typedef struct
{
  ugapBcastStateChangeCb_t  pfnStateChangeCB; 
  ugapBcastAdvPrepareCb_t   pfnAdvPrepareCB;  
  ugapBcastAdvDoneCb_t      pfnAdvDoneCB;     
} ugapBcastCBs_t;

PACKED_TYPEDEF_STRUCT {
  ugapBcastState_t state; 
} ugapBcastMsgStateChange_t; 

PACKED_TYPEDEF_STRUCT {
  bStatus_t      status; 
} ugapBcastMsgAdvPostprocess_t; 

#endif /* FEATURE_BROADCASTER */

#if defined(FEATURE_OBSERVER)

typedef uint8 ugapObserverScan_State_t;      

typedef void (*ugapObserverStateChangeCb_t)(ugapObserverScan_State_t state);

typedef void (*ugapObserverScanIndicationCb_t)(bStatus_t status, uint8_t len, uint8_t *pPayload);

typedef void (*ugapObserverScanWindowCompleteCb_t)(bStatus_t status);

typedef struct
{
  ugapObserverStateChangeCb_t         pfnStateChangeCB; 
  ugapObserverScanIndicationCb_t      pfnScanIndicationCB; 
  ugapObserverScanWindowCompleteCb_t  pfnScanWindowCompleteCB; 
} ugapObserverScanCBs_t;

PACKED_TYPEDEF_STRUCT {
  ugapObserverScan_State_t state; 
} ugapObserverMsgStateChange_t; 

PACKED_TYPEDEF_STRUCT {
  bStatus_t status; 
  uint8_t len; 
  uint8_t *pPayload; 
} ugapObserverMsgScanIndication_t; 

PACKED_TYPEDEF_STRUCT {
  bStatus_t status; 
} ugapObserverMsgScanWindowComplete_t; 

#endif /* FEATURE_OBSERVER */

#if defined(FEATURE_MONITOR)

typedef uint8 ugapMonitorState_t;      

typedef void (*ugapMonitorStateChangeCb_t)(ugapMonitorState_t state);

typedef void (*ugapMonitorIndicationCb_t)(bStatus_t status, uint8_t sessionId, uint8_t len, uint8_t *pPayload);

typedef void (*ugapMonitorCompleteCb_t)(bStatus_t status, uint8_t sessionId);

typedef struct
{
  ugapMonitorStateChangeCb_t  pfnStateChangeCB; 
  ugapMonitorIndicationCb_t   pfnMonitorIndicationCB; 
  ugapMonitorCompleteCb_t     pfnMonitorCompleteCB; 
} ugapMonitorCBs_t;

PACKED_TYPEDEF_STRUCT {
  ugapMonitorState_t state; 
} ugapMsgStateChange_t; 

PACKED_TYPEDEF_STRUCT {
  bStatus_t status; 
  uint8_t sessionId; 
  uint8_t len; 
  uint8_t *pPayload; 
} ugapMsgMonitorIndication_t; 

PACKED_TYPEDEF_STRUCT {
  bStatus_t status; 
  uint8_t sessionId; 
} ugapMsgMonitorComplete_t; 

#endif /* FEATURE_MONITOR */

/*-------------------------------------------------------------------
 * MACROS
 */

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

#if defined(FEATURE_BROADCASTER)

bStatus_t ugap_bcastInit(ugapBcastCBs_t* pCBs);

bStatus_t ugap_bcastSetDuty(uint16 dutyOnTime, uint16 dutyOffTime);

bStatus_t ugap_bcastStart(uint16 numAdvEvent);

bStatus_t ugap_bcastStop(void);
#endif /* FEATURE_BROADCASTER */

#if defined(FEATURE_OBSERVER)

bStatus_t ugap_scanInit(ugapObserverScanCBs_t* pCBs);

bStatus_t ugap_scanStart(void);

bStatus_t ugap_scanStop(void);

bStatus_t ugap_scanSuspend(void);

bStatus_t ugap_scanResume(void);

bStatus_t ugap_scanRequest(uint8_t scanChanMap, uint16_t scanWindow, uint16_t scanInterval);

#endif /* FEATURE_OBSERVER */

#if defined(FEATURE_MONITOR)

bStatus_t ugap_monitorInit(ugapMonitorCBs_t* pCBs);

bStatus_t ugap_monitorStart(void);

bStatus_t ugap_monitorStop(void);

bStatus_t ugap_monitorRequest(uint8_t channel, 
                              uint32_t accessAddr,
                              uint32_t startTime,
                              uint16_t duration);

#endif /* FEATURE_MONITOR */

/*-------------------------------------------------------------------
-------------------------------------------------------------------*/

#ifdef __cplusplus
}
#endif

#endif /* UGAP_H */
 // end of Micro_BLE_Stack