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

#ifndef MULTI_H
#define MULTI_H

#ifdef __cplusplus
extern "C"
{
#endif

/*-------------------------------------------------------------------
 * INCLUDES
 */
#include "gap.h"

/*-------------------------------------------------------------------
 * 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_MIN_CONN_INTERVAL   0x311

#define GAPROLE_MAX_CONN_INTERVAL   0x312

#define GAPROLE_SLAVE_LATENCY       0x313

#define GAPROLE_TIMEOUT_MULTIPLIER  0x314

#define GAPROLE_ADV_NONCONN_ENABLED 0x31B

#define GAPROLE_MAX_SCAN_RES        0x404

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

#define GAPROLE_LINK_PARAM_UPDATE_ACCEPT       0 
#define GAPROLE_LINK_PARAM_UPDATE_REJECT       1 
#define GAPROLE_LINK_PARAM_UPDATE_APP_DECIDES  2 
#define GAPROLE_LINK_PARAM_UPDATE_NUM_OPTIONS  3 

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

typedef union
{
  gapEventHdr_t             gap;                
  gapDeviceInitDoneEvent_t  initDone;           
  gapDeviceInfoEvent_t      deviceInfo;         
  gapDevDiscEvent_t         discCmpl;           
  gapEstLinkReqEvent_t      linkCmpl;           
  gapLinkUpdateEvent_t      linkUpdate;         
  gapTerminateLinkEvent_t   linkTerminate;      
} gapMultiRoleEvent_t;

typedef struct
{
  uint8_t paramUpdateEnable;            
  uint16_t connHandle;                  
  uint16_t minConnInterval;             
  uint16_t maxConnInterval;             
  uint16_t slaveLatency;                
  uint16_t timeoutMultiplier;           
} gapRole_updateConnParams_t;
/*-------------------------------------------------------------------
 * MACROS
 */

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

typedef uint8_t (*passThroughToApp_t)
(
  gapMultiRoleEvent_t *pEvent
);

/*
 * @brief Callback for the app to decide on a parameter update request
 *
 * This callback will be used if the @ref GAP_UPDATE_LINK_PARAM_REQ_EVENT parameter
 * is set to @ref GAPROLE_LINK_PARAM_UPDATE_APP_DECIDES
 *
 * @param pReq Pointer to param update request
 * @param pRsp Pointer to param update response.
 */
typedef void (*paramUpdateAppDecision_t)
(
  gapUpdateLinkParamReq_t *pReq,
  gapUpdateLinkParamReqReply_t *pRsp
);

typedef struct
{
  passThroughToApp_t        pfnPassThrough;             
  paramUpdateAppDecision_t  pfnParamUpdateAppDecision;  
} gapRolesCBs_t;

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

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

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

bStatus_t GAPRole_StartDevice(gapRolesCBs_t *pAppCallbacks, uint8_t* numConns);

extern bStatus_t GAPRole_TerminateConnection(uint16_t connHandle);

extern bStatus_t GAPRole_StartDiscovery(uint8_t mode, uint8_t activeScan, uint8_t whiteList);

extern bStatus_t GAPRole_CancelDiscovery(void);

extern bStatus_t GAPRole_EstablishLink(uint8_t highDutyCycle, uint8_t whiteList,
                                              uint8_t addrTypePeer, uint8_t *peerAddr);   
                                         

extern bStatus_t gapRole_connUpdate(uint8_t handleFailure, 
                                       gapRole_updateConnParams_t *pConnParams);


/*-------------------------------------------------------------------
 * TASK FUNCTIONS - Don't call these. These are system functions.
 */
   
extern void GAPRole_createTask(void);

extern void gapRole_abort(void);


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

#ifdef __cplusplus
}
#endif

#endif /* MULTI_H */