Bill Schilit / BLE_API

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.

Fork of BLE_API by Bluetooth Low Energy

public/Gap.h@142:42f038a81ea7, 2014-11-21 (annotated)

Committer:
rgrover1
Date:
Fri Nov 21 09:23:24 2014 +0000
Revision:
142:42f038a81ea7
Parent:
141:bbc85b4fbdb7
Child:
143:8bdf577b1598
Synchronized with git rev 42345159

Author: Rohit Grover

Minor re-organization of member functions and their access privileges.

Make most APIs private, and accessible only to BLEDevice.

Add a private copy constructor and assignment operator.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Rohit Grover 106:a20be740075d 1 /* mbed Microcontroller Library
Rohit Grover 106:a20be740075d 2 * Copyright (c) 2006-2013 ARM Limited
Rohit Grover 106:a20be740075d 3 *
Rohit Grover 106:a20be740075d 4 * Licensed under the Apache License, Version 2.0 (the "License");
Rohit Grover 106:a20be740075d 5 * you may not use this file except in compliance with the License.
Rohit Grover 106:a20be740075d 6 * You may obtain a copy of the License at
Rohit Grover 106:a20be740075d 7 *
Rohit Grover 106:a20be740075d 8 * http://www.apache.org/licenses/LICENSE-2.0
Rohit Grover 106:a20be740075d 9 *
Rohit Grover 106:a20be740075d 10 * Unless required by applicable law or agreed to in writing, software
Rohit Grover 106:a20be740075d 11 * distributed under the License is distributed on an "AS IS" BASIS,
Rohit Grover 106:a20be740075d 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Rohit Grover 106:a20be740075d 13 * See the License for the specific language governing permissions and
Rohit Grover 106:a20be740075d 14 * limitations under the License.
Rohit Grover 106:a20be740075d 15 */
Rohit Grover 106:a20be740075d 16
Rohit Grover 106:a20be740075d 17 #ifndef __GAP_H__
Rohit Grover 106:a20be740075d 18 #define __GAP_H__
Rohit Grover 106:a20be740075d 19
Rohit Grover 106:a20be740075d 20 #include "GapAdvertisingData.h"
Rohit Grover 106:a20be740075d 21 #include "GapAdvertisingParams.h"
Rohit Grover 106:a20be740075d 22 #include "GapEvents.h"
Rohit Grover 106:a20be740075d 23
Rohit Grover 106:a20be740075d 24 /**************************************************************************/
Rohit Grover 106:a20be740075d 25 /*!
Rohit Grover 106:a20be740075d 26 \brief
Rohit Grover 106:a20be740075d 27 The base class used to abstract GAP functionality to a specific radio
Rohit Grover 106:a20be740075d 28 transceiver, SOC or BLE Stack.
Rohit Grover 106:a20be740075d 29 */
Rohit Grover 106:a20be740075d 30 /**************************************************************************/
Rohit Grover 106:a20be740075d 31 class Gap
Rohit Grover 106:a20be740075d 32 {
Rohit Grover 106:a20be740075d 33 public:
Rohit Grover 106:a20be740075d 34 typedef enum addr_type_e {
Rohit Grover 106:a20be740075d 35 ADDR_TYPE_PUBLIC = 0,
Rohit Grover 106:a20be740075d 36 ADDR_TYPE_RANDOM_STATIC,
Rohit Grover 106:a20be740075d 37 ADDR_TYPE_RANDOM_PRIVATE_RESOLVABLE,
Rohit Grover 106:a20be740075d 38 ADDR_TYPE_RANDOM_PRIVATE_NON_RESOLVABLE
Rohit Grover 106:a20be740075d 39 } addr_type_t;
Rohit Grover 106:a20be740075d 40
Rohit Grover 123:fede41ce9407 41 static const unsigned ADDR_LEN = 6;
rgrover1 140:407d134c179d 42 typedef uint8_t address_t[ADDR_LEN];
Rohit Grover 123:fede41ce9407 43
Rohit Grover 117:0fb20195102b 44 /**
Rohit Grover 117:0fb20195102b 45 * enumeration for disconnection reasons. The values for these reasons are
Rohit Grover 117:0fb20195102b 46 * derived from Nordic's implementation; but the reasons are meant to be
Rohit Grover 117:0fb20195102b 47 * independent of the transport. If you are returned a reason which is not
Rohit Grover 117:0fb20195102b 48 * covered by this enumeration, then please refer to the underlying
Rohit Grover 117:0fb20195102b 49 * transport library.
Rohit Grover 117:0fb20195102b 50 */
Rohit Grover 116:ca826083980e 51 enum DisconnectionReason_t {
Rohit Grover 117:0fb20195102b 52 REMOTE_USER_TERMINATED_CONNECTION = 0x13,
Rohit Grover 117:0fb20195102b 53 LOCAL_HOST_TERMINATED_CONNECTION = 0x16,
Rohit Grover 117:0fb20195102b 54 CONN_INTERVAL_UNACCEPTABLE = 0x3B,
Rohit Grover 116:ca826083980e 55 };
Rohit Grover 116:ca826083980e 56
Rohit Grover 106:a20be740075d 57 /* Describes the current state of the device (more than one bit can be set) */
Rohit Grover 106:a20be740075d 58 typedef struct GapState_s {
Rohit Grover 106:a20be740075d 59 unsigned advertising : 1; /**< peripheral is currently advertising */
Rohit Grover 106:a20be740075d 60 unsigned connected : 1; /**< peripheral is connected to a central */
Rohit Grover 106:a20be740075d 61 } GapState_t;
Rohit Grover 106:a20be740075d 62
Rohit Grover 106:a20be740075d 63 typedef uint16_t Handle_t;
Rohit Grover 106:a20be740075d 64
Rohit Grover 106:a20be740075d 65 typedef struct {
rgrover1 140:407d134c179d 66 uint16_t minConnectionInterval; /**< Minimum Connection Interval in 1.25 ms units, see @ref BLE_GAP_CP_LIMITS.*/
rgrover1 140:407d134c179d 67 uint16_t maxConnectionInterval; /**< Maximum Connection Interval in 1.25 ms units, see @ref BLE_GAP_CP_LIMITS.*/
rgrover1 140:407d134c179d 68 uint16_t slaveLatency; /**< Slave Latency in number of connection events, see @ref BLE_GAP_CP_LIMITS.*/
rgrover1 140:407d134c179d 69 uint16_t connectionSupervisionTimeout; /**< Connection Supervision Timeout in 10 ms units, see @ref BLE_GAP_CP_LIMITS.*/
Rohit Grover 106:a20be740075d 70 } ConnectionParams_t;
Rohit Grover 106:a20be740075d 71
rgrover1 140:407d134c179d 72 static const uint16_t UNIT_1_25_MS = 1250; /**< Number of microseconds in 1.25 milliseconds. */
rgrover1 140:407d134c179d 73 static uint16_t MSEC_TO_GAP_DURATION_UNITS(uint32_t durationInMillis) {
rgrover1 140:407d134c179d 74 return (durationInMillis * 1000) / UNIT_1_25_MS;
rgrover1 140:407d134c179d 75 }
rgrover1 140:407d134c179d 76
rgrover1 142:42f038a81ea7 77 typedef void (*EventCallback_t)(void);
rgrover1 142:42f038a81ea7 78 typedef void (*ConnectionEventCallback_t)(Handle_t, addr_type_t peerAddrType, const address_t peerAddr, const ConnectionParams_t *);
rgrover1 142:42f038a81ea7 79 typedef void (*DisconnectionEventCallback_t)(Handle_t, DisconnectionReason_t);
rgrover1 142:42f038a81ea7 80
rgrover1 142:42f038a81ea7 81 friend class BLEDevice;
rgrover1 142:42f038a81ea7 82 private:
Rohit Grover 106:a20be740075d 83 /* These functions must be defined in the sub-class */
rgrover1 140:407d134c179d 84 virtual ble_error_t setAddress(addr_type_t type, const address_t address) = 0;
rgrover1 140:407d134c179d 85 virtual ble_error_t getAddress(addr_type_t *typeP, address_t address) = 0;
Rohit Grover 106:a20be740075d 86 virtual ble_error_t setAdvertisingData(const GapAdvertisingData &, const GapAdvertisingData &) = 0;
rgrover1 140:407d134c179d 87 virtual ble_error_t startAdvertising(const GapAdvertisingParams &) = 0;
rgrover1 140:407d134c179d 88 virtual ble_error_t stopAdvertising(void) = 0;
rgrover1 140:407d134c179d 89 virtual ble_error_t disconnect(DisconnectionReason_t reason) = 0;
rgrover1 140:407d134c179d 90 virtual ble_error_t getPreferredConnectionParams(ConnectionParams_t *params) = 0;
rgrover1 140:407d134c179d 91 virtual ble_error_t setPreferredConnectionParams(const ConnectionParams_t *params) = 0;
rgrover1 140:407d134c179d 92 virtual ble_error_t updateConnectionParams(Handle_t handle, const ConnectionParams_t *params) = 0;
Rohit Grover 106:a20be740075d 93
rgrover1 140:407d134c179d 94 virtual ble_error_t setDeviceName(const uint8_t *deviceName) = 0;
Rohit Grover 116:ca826083980e 95 virtual ble_error_t getDeviceName(uint8_t *deviceName, unsigned *lengthP) = 0;
rgrover1 140:407d134c179d 96 virtual ble_error_t setAppearance(uint16_t appearance) = 0;
rgrover1 140:407d134c179d 97 virtual ble_error_t getAppearance(uint16_t *appearanceP) = 0;
Rohit Grover 116:ca826083980e 98
rgrover1 142:42f038a81ea7 99 private:
rgrover1 142:42f038a81ea7 100 /* Event callback handlers */
rgrover1 142:42f038a81ea7 101 void setOnTimeout(EventCallback_t callback) {onTimeout = callback;}
rgrover1 142:42f038a81ea7 102 void setOnConnection(ConnectionEventCallback_t callback) {onConnection = callback;}
rgrover1 142:42f038a81ea7 103 void setOnDisconnection(DisconnectionEventCallback_t callback) {onDisconnection = callback;}
Rohit Grover 106:a20be740075d 104
rgrover1 142:42f038a81ea7 105 GapState_t getState(void) const {
rgrover1 142:42f038a81ea7 106 return state;
Rohit Grover 106:a20be740075d 107 }
rgrover1 140:407d134c179d 108
rgrover1 142:42f038a81ea7 109 protected:
rgrover1 142:42f038a81ea7 110 Gap() : state(), onTimeout(NULL), onConnection(NULL), onDisconnection(NULL) {
rgrover1 142:42f038a81ea7 111 /* empty */
Rohit Grover 106:a20be740075d 112 }
rgrover1 140:407d134c179d 113
rgrover1 142:42f038a81ea7 114 public:
rgrover1 140:407d134c179d 115 void processConnectionEvent(Handle_t handle, addr_type_t type, const address_t addr, const ConnectionParams_t *params) {
Rohit Grover 116:ca826083980e 116 state.connected = 1;
Rohit Grover 116:ca826083980e 117 if (onConnection) {
rgrover1 140:407d134c179d 118 onConnection(handle, type, addr, params);
Rohit Grover 116:ca826083980e 119 }
Rohit Grover 116:ca826083980e 120 }
Rohit Grover 116:ca826083980e 121
Rohit Grover 116:ca826083980e 122 void processDisconnectionEvent(Handle_t handle, DisconnectionReason_t reason) {
Rohit Grover 116:ca826083980e 123 state.connected = 0;
Rohit Grover 116:ca826083980e 124 if (onDisconnection) {
Rohit Grover 116:ca826083980e 125 onDisconnection(handle, reason);
Rohit Grover 106:a20be740075d 126 }
Rohit Grover 106:a20be740075d 127 }
Rohit Grover 106:a20be740075d 128
Rohit Grover 106:a20be740075d 129 void processEvent(GapEvents::gapEvent_e type) {
Rohit Grover 106:a20be740075d 130 switch (type) {
Rohit Grover 106:a20be740075d 131 case GapEvents::GAP_EVENT_TIMEOUT:
Rohit Grover 106:a20be740075d 132 state.advertising = 0;
Rohit Grover 106:a20be740075d 133 if (onTimeout) {
Rohit Grover 106:a20be740075d 134 onTimeout();
Rohit Grover 106:a20be740075d 135 }
Rohit Grover 106:a20be740075d 136 break;
Rohit Grover 106:a20be740075d 137 }
Rohit Grover 106:a20be740075d 138 }
Rohit Grover 106:a20be740075d 139
Rohit Grover 106:a20be740075d 140 protected:
rgrover1 140:407d134c179d 141 GapState_t state;
Rohit Grover 106:a20be740075d 142
Rohit Grover 106:a20be740075d 143 private:
Rohit Grover 116:ca826083980e 144 EventCallback_t onTimeout;
Rohit Grover 116:ca826083980e 145 ConnectionEventCallback_t onConnection;
Rohit Grover 116:ca826083980e 146 DisconnectionEventCallback_t onDisconnection;
rgrover1 142:42f038a81ea7 147
rgrover1 142:42f038a81ea7 148 private:
rgrover1 142:42f038a81ea7 149 /* disallow copy and assginment */
rgrover1 142:42f038a81ea7 150 Gap(const Gap &);
rgrover1 142:42f038a81ea7 151 Gap& operator=(const Gap &);
Rohit Grover 106:a20be740075d 152 };
Rohit Grover 106:a20be740075d 153
rgrover1 126:fdebe4d5d62f 154 #endif // ifndef __GAP_H__