ugap.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2016, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
/*!*****************************************************************************
 *  @addtogroup Micro_BLE_Stack
 *  @{
 *  @defgroup UGAP Micro Gap Layer
 *  @{
 *  @file   ugap.h
 *  @brief  Micro BLE GAP API
 *
 *  This file contains the interface to the Micro GAP Layer.
 */

#ifndef UGAP_H
#define UGAP_H

#ifdef __cplusplus
extern "C"
{
#endif

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

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

#define UG_DUTY_TIME_UNIT    100L  

#if defined(FEATURE_BROADCASTER)

#define UG_BCAST_STATE_INVALID     0 
#define UG_BCAST_STATE_INITIALIZED 1 
#define UG_BCAST_STATE_IDLE        2 
#define UG_BCAST_STATE_ADVERTISING 3 
#define UG_BCAST_STATE_WAITING     4 
#define UG_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 */
   
/*-------------------------------------------------------------------
 * TYPEDEFS
 */

#if defined(FEATURE_BROADCASTER)

typedef uint8 ugBcastState_t;      

typedef void (*ugbStateChangeCb_t)(ugBcastState_t state);

typedef void (*ugbAdvPrepareCb_t)(void);

typedef void (*ugbAdvDoneCb_t)(bStatus_t status);

typedef struct
{
  ugbStateChangeCb_t   pfnStateChangeCB; 
  ugbAdvPrepareCb_t    pfnAdvPrepareCB;  
  ugbAdvDoneCb_t       pfnAdvDoneCB;     
} ugBcastCBs_t;

PACKED_TYPEDEF_STRUCT {
  ugBcastState_t state;
} ugbMsgStateChange_t;

PACKED_TYPEDEF_STRUCT {
  bStatus_t      status;
} ugbMsgAdvPostprocess_t;

#endif /* FEATURE_BROADCASTER */

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

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

#if defined(FEATURE_BROADCASTER)

bStatus_t ug_bcastInit(ugBcastCBs_t* pCBs);

bStatus_t ug_bcastSetDuty(uint16 dutyOnTime, uint16 dutyOffTime);

bStatus_t ug_bcastStart(uint16 numAdvEvent);

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

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

#ifdef __cplusplus
}
#endif

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