EL4121 Embedded System / mbed-os

mbed-os

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

features/FEATURE_BLE/targets/TARGET_Maxim/MaximGap.h@0:b74591d5ab33, 2017-12-11 (annotated)

Committer:
be_bryan
Date:
Mon Dec 11 17:54:04 2017 +0000
Revision:
0:b74591d5ab33
motor ++

Who changed what in which revision?

UserRevisionLine numberNew contents of line
be_bryan 0:b74591d5ab33 1 /*******************************************************************************
be_bryan 0:b74591d5ab33 2 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
be_bryan 0:b74591d5ab33 3 *
be_bryan 0:b74591d5ab33 4 * Permission is hereby granted, free of charge, to any person obtaining a
be_bryan 0:b74591d5ab33 5 * copy of this software and associated documentation files (the "Software"),
be_bryan 0:b74591d5ab33 6 * to deal in the Software without restriction, including without limitation
be_bryan 0:b74591d5ab33 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
be_bryan 0:b74591d5ab33 8 * and/or sell copies of the Software, and to permit persons to whom the
be_bryan 0:b74591d5ab33 9 * Software is furnished to do so, subject to the following conditions:
be_bryan 0:b74591d5ab33 10 *
be_bryan 0:b74591d5ab33 11 * The above copyright notice and this permission notice shall be included
be_bryan 0:b74591d5ab33 12 * in all copies or substantial portions of the Software.
be_bryan 0:b74591d5ab33 13 *
be_bryan 0:b74591d5ab33 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
be_bryan 0:b74591d5ab33 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
be_bryan 0:b74591d5ab33 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
be_bryan 0:b74591d5ab33 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
be_bryan 0:b74591d5ab33 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
be_bryan 0:b74591d5ab33 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
be_bryan 0:b74591d5ab33 20 * OTHER DEALINGS IN THE SOFTWARE.
be_bryan 0:b74591d5ab33 21 *
be_bryan 0:b74591d5ab33 22 * Except as contained in this notice, the name of Maxim Integrated
be_bryan 0:b74591d5ab33 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
be_bryan 0:b74591d5ab33 24 * Products, Inc. Branding Policy.
be_bryan 0:b74591d5ab33 25 *
be_bryan 0:b74591d5ab33 26 * The mere transfer of this software does not imply any licenses
be_bryan 0:b74591d5ab33 27 * of trade secrets, proprietary technology, copyrights, patents,
be_bryan 0:b74591d5ab33 28 * trademarks, maskwork rights, or any other form of intellectual
be_bryan 0:b74591d5ab33 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
be_bryan 0:b74591d5ab33 30 * ownership rights.
be_bryan 0:b74591d5ab33 31 *******************************************************************************
be_bryan 0:b74591d5ab33 32 */
be_bryan 0:b74591d5ab33 33
be_bryan 0:b74591d5ab33 34 #ifndef _MAXIM_GAP_H_
be_bryan 0:b74591d5ab33 35 #define _MAXIM_GAP_H_
be_bryan 0:b74591d5ab33 36
be_bryan 0:b74591d5ab33 37 #include "mbed.h"
be_bryan 0:b74591d5ab33 38 #include "ble/blecommon.h"
be_bryan 0:b74591d5ab33 39 #include "ble/GapAdvertisingParams.h"
be_bryan 0:b74591d5ab33 40 #include "ble/GapAdvertisingData.h"
be_bryan 0:b74591d5ab33 41 #include "ble/Gap.h"
be_bryan 0:b74591d5ab33 42 #include "ble/GapScanningParams.h"
be_bryan 0:b74591d5ab33 43 #include "dm_api.h"
be_bryan 0:b74591d5ab33 44 #include "att_api.h"
be_bryan 0:b74591d5ab33 45
be_bryan 0:b74591d5ab33 46 /**************************************************************************/
be_bryan 0:b74591d5ab33 47 /*!
be_bryan 0:b74591d5ab33 48 \brief
be_bryan 0:b74591d5ab33 49
be_bryan 0:b74591d5ab33 50 */
be_bryan 0:b74591d5ab33 51 /**************************************************************************/
be_bryan 0:b74591d5ab33 52 class MaximGap : public Gap
be_bryan 0:b74591d5ab33 53 {
be_bryan 0:b74591d5ab33 54 public:
be_bryan 0:b74591d5ab33 55 static MaximGap &getInstance();
be_bryan 0:b74591d5ab33 56
be_bryan 0:b74591d5ab33 57 /* Functions that must be implemented from Gap */
be_bryan 0:b74591d5ab33 58 virtual ble_error_t setAddress(AddressType_t type, const Address_t address);
be_bryan 0:b74591d5ab33 59 virtual ble_error_t getAddress(AddressType_t *typeP, Address_t address);
be_bryan 0:b74591d5ab33 60 virtual ble_error_t setAdvertisingData(const GapAdvertisingData &, const GapAdvertisingData &);
be_bryan 0:b74591d5ab33 61
be_bryan 0:b74591d5ab33 62 #define BLE_GAP_ADV_INTERVAL_MIN 0x0020 /**< Minimum Advertising interval in 625 us units, i.e. 20 ms. */
be_bryan 0:b74591d5ab33 63 #define BLE_GAP_ADV_NONCON_INTERVAL_MIN 0x00A0 /**< Minimum Advertising interval in 625 us units for non connectable mode, i.e. 100 ms. */
be_bryan 0:b74591d5ab33 64 #define BLE_GAP_ADV_INTERVAL_MAX 0x4000 /**< Maximum Advertising interval in 625 us units, i.e. 10.24 s. */
be_bryan 0:b74591d5ab33 65
be_bryan 0:b74591d5ab33 66 virtual uint16_t getMinAdvertisingInterval(void) const { return BLE_GAP_ADV_INTERVAL_MIN; }
be_bryan 0:b74591d5ab33 67 virtual uint16_t getMinNonConnectableAdvertisingInterval(void) const { return BLE_GAP_ADV_NONCON_INTERVAL_MIN; }
be_bryan 0:b74591d5ab33 68 virtual uint16_t getMaxAdvertisingInterval(void) const { return BLE_GAP_ADV_INTERVAL_MAX; }
be_bryan 0:b74591d5ab33 69
be_bryan 0:b74591d5ab33 70 virtual ble_error_t startAdvertising(const GapAdvertisingParams &);
be_bryan 0:b74591d5ab33 71 virtual ble_error_t stopAdvertising(void);
be_bryan 0:b74591d5ab33 72 virtual ble_error_t disconnect(Handle_t connectionHandle, DisconnectionReason_t reason);
be_bryan 0:b74591d5ab33 73 virtual ble_error_t disconnect(DisconnectionReason_t reason);
be_bryan 0:b74591d5ab33 74
be_bryan 0:b74591d5ab33 75 virtual ble_error_t setDeviceName(const uint8_t *deviceName);
be_bryan 0:b74591d5ab33 76 virtual ble_error_t getDeviceName(uint8_t *deviceName, unsigned *lengthP);
be_bryan 0:b74591d5ab33 77 virtual ble_error_t setAppearance(GapAdvertisingData::Appearance appearance);
be_bryan 0:b74591d5ab33 78 virtual ble_error_t getAppearance(GapAdvertisingData::Appearance *appearanceP);
be_bryan 0:b74591d5ab33 79
be_bryan 0:b74591d5ab33 80 virtual ble_error_t setTxPower(int8_t txPower);
be_bryan 0:b74591d5ab33 81 virtual void getPermittedTxPowerValues(const int8_t **valueArrayPP, size_t *countP);
be_bryan 0:b74591d5ab33 82
be_bryan 0:b74591d5ab33 83 void setConnectionHandle(uint16_t m_connectionHandle);
be_bryan 0:b74591d5ab33 84 uint16_t getConnectionHandle(void);
be_bryan 0:b74591d5ab33 85
be_bryan 0:b74591d5ab33 86 virtual ble_error_t getPreferredConnectionParams(ConnectionParams_t *params);
be_bryan 0:b74591d5ab33 87 virtual ble_error_t setPreferredConnectionParams(const ConnectionParams_t *params);
be_bryan 0:b74591d5ab33 88 virtual ble_error_t updateConnectionParams(Handle_t handle, const ConnectionParams_t *params);
be_bryan 0:b74591d5ab33 89
be_bryan 0:b74591d5ab33 90 virtual ble_error_t startRadioScan(const GapScanningParams &scanningParams);
be_bryan 0:b74591d5ab33 91 virtual ble_error_t stopScan(void);
be_bryan 0:b74591d5ab33 92
be_bryan 0:b74591d5ab33 93 void advertisingStopped(void);
be_bryan 0:b74591d5ab33 94
be_bryan 0:b74591d5ab33 95 private:
be_bryan 0:b74591d5ab33 96 uint16_t m_connectionHandle;
be_bryan 0:b74591d5ab33 97 addr_type_t m_type;
be_bryan 0:b74591d5ab33 98 MaximGap() {
be_bryan 0:b74591d5ab33 99 m_connectionHandle = DM_CONN_ID_NONE;
be_bryan 0:b74591d5ab33 100 m_type = BLEProtocol::AddressType::RANDOM_STATIC;
be_bryan 0:b74591d5ab33 101 }
be_bryan 0:b74591d5ab33 102
be_bryan 0:b74591d5ab33 103 MaximGap(MaximGap const &);
be_bryan 0:b74591d5ab33 104 void operator=(MaximGap const &);
be_bryan 0:b74591d5ab33 105
be_bryan 0:b74591d5ab33 106 uint8_t advDataCache[HCI_LEN_LE_SET_ADV_DATA];
be_bryan 0:b74591d5ab33 107 uint8_t scanResponseCache[HCI_LEN_LE_SET_SCAN_RESP_DATA];
be_bryan 0:b74591d5ab33 108 int advDataLen;
be_bryan 0:b74591d5ab33 109 int scanResponseLen;
be_bryan 0:b74591d5ab33 110 };
be_bryan 0:b74591d5ab33 111
be_bryan 0:b74591d5ab33 112 #endif /* _MAXIM_GAP_H_ */