peripheral.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.
 */
/*!*****************************************************************************
 *  @defgroup Peripheral GAPRole (Peripheral)
 *  @brief This module implements the Peripheral GAP Role
 *  @{
 *  @file       peripheral.h
 *  @brief      Peripheral layer interface
 */

#ifndef PERIPHERAL_H
#define PERIPHERAL_H

#ifdef __cplusplus
extern "C"
{
#endif

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

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

#define GAPROLE_PROFILEROLE         0x300

#define GAPROLE_IRK                 0x301

#define GAPROLE_SRK                 0x302

#define GAPROLE_SIGNCOUNTER         0x303

#define GAPROLE_BD_ADDR             0x304

#define GAPROLE_ADVERT_ENABLED      0x305

#define GAPROLE_ADVERT_OFF_TIME     0x306

#define GAPROLE_ADVERT_DATA         0x307

#define GAPROLE_SCAN_RSP_DATA       0x308

#define GAPROLE_ADV_EVENT_TYPE      0x309

#define GAPROLE_ADV_DIRECT_TYPE     0x30A

#define GAPROLE_ADV_DIRECT_ADDR     0x30B

#define GAPROLE_ADV_CHANNEL_MAP     0x30C 

#define GAPROLE_ADV_FILTER_POLICY   0x30D

#define GAPROLE_CONNHANDLE          0x30E


#define GAPROLE_RSSI_READ_RATE      0x30F

#define GAPROLE_PARAM_UPDATE_ENABLE 0x310

#define GAPROLE_MIN_CONN_INTERVAL   0x311

#define GAPROLE_MAX_CONN_INTERVAL   0x312

#define GAPROLE_SLAVE_LATENCY       0x313

#define GAPROLE_TIMEOUT_MULTIPLIER  0x314

#define GAPROLE_CONN_BD_ADDR        0x315

#define GAPROLE_CONN_INTERVAL       0x316

#define GAPROLE_CONN_LATENCY        0x317

#define GAPROLE_CONN_TIMEOUT        0x318  


#define GAPROLE_PARAM_UPDATE_REQ    0x319

#define GAPROLE_STATE               0x31A

#define GAPROLE_ADV_NONCONN_ENABLED 0x31B

#define GAPROLE_BD_ADDR_TYPE        0x31C

#define GAPROLE_CONN_TERM_REASON    0x31D

/*-------------------------------------------------------------------
 * TYPEDEFS
 */

typedef enum
{
  GAPROLE_INIT = 0,                       
  GAPROLE_STARTED,                        
  GAPROLE_ADVERTISING,                    
  GAPROLE_ADVERTISING_NONCONN,            
  GAPROLE_WAITING,                        
  GAPROLE_WAITING_AFTER_TIMEOUT,          
  GAPROLE_CONNECTED,                      
  GAPROLE_CONNECTED_ADV,                  
  GAPROLE_ERROR                           
} gaprole_States_t;

#define GAPROLE_NO_ACTION                    0 
#define GAPROLE_RESEND_PARAM_UPDATE          1 
#define GAPROLE_TERMINATE_LINK               2 

#define GAPROLE_LINK_PARAM_UPDATE_WAIT_REMOTE_PARAMS   0 
#define GAPROLE_LINK_PARAM_UPDATE_INITIATE_BOTH_PARAMS 1 
#define GAPROLE_LINK_PARAM_UPDATE_INITIATE_APP_PARAMS  2 
#define GAPROLE_LINK_PARAM_UPDATE_WAIT_APP_PARAMS      3 
#define GAPROLE_LINK_PARAM_UPDATE_WAIT_BOTH_PARAMS     4 
#define GAPROLE_LINK_PARAM_UPDATE_REJECT_REQUEST       5 
#define GAPROLE_LINK_PARAM_UPDATE_NUM_OPTIONS          6 

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

/*-------------------------------------------------------------------
 * Profile Callbacks
 */

/*
 * @brief Callback when the connection parameters are updated.
 *
 * @param connInterval new connection interval
 * @param connSlaveLatency new slave latency
 * @param connTimeout new supervision timeout
 */
typedef void (*gapRolesParamUpdateCB_t)(uint16_t connInterval,
                                        uint16_t connSlaveLatency,
                                        uint16_t connTimeout);

typedef void (*gapRolesStateNotify_t)(gaprole_States_t newState);

typedef struct
{
  gapRolesStateNotify_t    pfnStateChange;  
} gapRolesCBs_t;

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

extern bStatus_t GAPRole_SetParameter(uint16_t param, uint8_t len, void *pValue);

extern bStatus_t GAPRole_GetParameter(uint16_t param, void *pValue);

extern bStatus_t GAPRole_StartDevice(gapRolesCBs_t *pAppCallbacks);

extern bStatus_t GAPRole_TerminateConnection(void);

extern bStatus_t GAPRole_SendUpdateParam(uint16_t minConnInterval,
                                         uint16_t maxConnInterval,
                                         uint16_t latency, uint16_t connTimeout,
                                         uint8_t handleFailure);

extern void GAPRole_RegisterAppCBs(gapRolesParamUpdateCB_t *pParamUpdateCB);


/*-------------------------------------------------------------------
 * TASK FUNCTIONS - Don't call these. These are system functions.
 */

extern void GAPRole_createTask(void);


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

#ifdef __cplusplus
}
#endif

#endif /* PERIPHERAL_H */