Rizky Ardi Maulana / mbed-os

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

features/FEATURE_BLE/targets/TARGET_Maxim/MaximGap.h@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

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