bt_hal_manager_adapter_classic.h

Go to the documentation of this file.

/*
 * FreeRTOS BLE HAL V5.1.0
 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * http://aws.amazon.com/freertos
 * http://www.FreeRTOS.org
 */

#ifndef _BT_HAL_MANAGER_ADAPTER_CLASSIC_
#define _BT_HAL_MANAGER_ADAPTER_CLASSIC_

#include "bt_hal_manager.h"

typedef enum
{
    eBTScanModeNone = 0,                   
    eBTScanModeConnectable = 1,            
    eBTScanModeConnectableDiscoverable = 2 
} BTScanMode_t;


typedef enum
{
    eBTPageScanInterval220ms = 0, 
    eBTPageScanInterval1280ms = 1 
} BTScanParam_t;


typedef enum
{
    eBTDiscoveryStopped = 0, 
    eBTDiscoveryStarted = 1  
} BTDiscoveryState_t;

typedef enum
{
    eBTaclStateConnected = 0,   
    eBTaclStateDisconnected = 1 
} BTaclState_t;


typedef struct
{
    BTUuid_t xUuid;
    uint16_t usChannel;
    char * cName; /* what's the maximum length */
} BTServiceRecord_t;

typedef struct
{
    uint32_t ulVvendor;
    uint32_t ulProduct;
} BTEirManfInfo_t;

typedef struct
{
    uint32_t ulVendor;
    uint32_t ulProduct;
    uint32_t ulUuid;
} BTGadgetEirManfInfo_t;

typedef enum
{
    eBTScanTypeStandard = 0,  
    eBTScanTypeInterlaced = 1 
} BTScanType_t;

typedef enum
{
    eBTPropertyBdname = 0x1,

    eBTPropertyBdaddr = 0x2,

    eBTPropertyTypeOfDevice = 0x3,

    eBTPropertyUUIDS = 0x4,

    eBTPropertyClassOfDevice = 0x5,

    eBTPropertyServiceRecord = 0x6,

    eBTPropertyAdapterDiscoveryTimeout = 0x7,
    /* Properties unique to adapter */

    eBTPropertyAdapterScanMode = 0x8,
    /* Properties unique to manufacturer and device */

    eBTPropertyEIRManfInfo = 0xFE,
    /* Properties unique to remove  */

    eBTPropertyAdapterScanParam = 0x100,

    eBTPropertyConnectability = 0x101,

    eBTPropertyScanType = 0x102,

    eBTPropertyGadgetEIRManfInfo = 0x103,
} BTClassicPropertyType_t;

typedef struct
{
    BTClassicPropertyType_t xType;
    size_t xLen;
    void * pvVal;
} BTClassicProperty_t;

typedef void (* BTClassicDevicePropertiesCallback_t)( BTStatus_t xStatus,
                                                      uint32_t ulNumProperties,
                                                      BTClassicProperty_t * pxProperties );

typedef void ( * BTClassicRemoteDevicePropertiesCallback_t )( BTStatus_t xStatus,
                                                              BTBdaddr_t * pxBdAddr,
                                                              uint32_t ulNumProperties,
                                                              BTClassicProperty_t * pxProperties );

typedef void (* BTDeviceFoundCallback_t)( uint32_t ulNumProperties,
                                          BTClassicProperty_t * pxProperties );

typedef void (* BTDiscoveryStateChangedCallback_t)( BTDiscoveryState_t xState );

typedef void (* BTaclStateChangedCallback_t)( BTStatus_t xStatus,
                                              BTBdaddr_t * pxRemoteBdAddr,
                                              BTaclState_t xState );

typedef struct
{
    BTClassicDevicePropertiesCallback_t pxDevProperties_cb;
    BTClassicRemoteDevicePropertiesCallback_t pxRemoteDevProperties_cb;
    BTDeviceFoundCallback_t pxDeviceFound_cb;
    BTDiscoveryStateChangedCallback_t pxDiscoveryStateChanged_cb;
    BTaclStateChangedCallback_t pxAclStateChanged_cb;
} BTClassicCallbacks_t;


typedef struct
{
    BTStatus_t ( * pxInit )( BTClassicCallbacks_t * pxCallbacks );

    BTStatus_t ( * pxCleanup )();

    BTStatus_t ( * pxGetClassicDeviceProperty )( BTClassicPropertyType_t xType );

    BTStatus_t ( * pxSetClassicDeviceProperty )( const BTClassicProperty_t * pxProperty );

    BTStatus_t ( * pxGetAllRemoteClassicDeviceProperties )( BTBdaddr_t * pxRemote_addr );

    BTStatus_t ( * pxGetRemoteClassicDeviceProperty )( BTBdaddr_t * pxRemote_addr,
                                                       BTClassicPropertyType_t xType );

    BTStatus_t ( * pxSetRemoteClassicDeviceProperty )( BTBdaddr_t * pxRemote_addr,
                                                       const BTClassicProperty_t * pxProperty );

    BTStatus_t ( * pxGetRemoteServiceRecord )( BTBdaddr_t * pxRemote_addr,
                                               BTUuid_t * pxUuid );

    BTStatus_t ( * pxGetRemoteService )( BTBdaddr_t * pxRemote_addr );

    BTStatus_t ( * pxStartDiscovery )();

    BTStatus_t ( * pxStopDiscovery )();

    const void * ( *ppvGetProfileInterface )( BTProfile_t xProfile );
} BTClassicInterface_t;

const BTClassicInterface_t * BT_GetClassicAdapter();

#endif /* _BT_HAL_MANAGER_ADAPTER_CLASSIC_ */