Microbug / 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

hw/Gap.h@34:da2ea8cd6216, 2014-05-21 (annotated)

Committer:
Rohit Grover
Date:
Wed May 21 15:01:14 2014 +0100
Revision:
34:da2ea8cd6216
Parent:
33:6d51a2c69442
Child:
38:02cf26a2a4db
white space diffs; generated using uncrustify

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ktownsend 29:011e95ce78b8 1 /* mbed Microcontroller Library
ktownsend 29:011e95ce78b8 2 * Copyright (c) 2006-2013 ARM Limited
ktownsend 29:011e95ce78b8 3 *
ktownsend 29:011e95ce78b8 4 * Licensed under the Apache License, Version 2.0 (the "License");
ktownsend 29:011e95ce78b8 5 * you may not use this file except in compliance with the License.
ktownsend 29:011e95ce78b8 6 * You may obtain a copy of the License at
ktownsend 29:011e95ce78b8 7 *
ktownsend 29:011e95ce78b8 8 * http://www.apache.org/licenses/LICENSE-2.0
ktownsend 29:011e95ce78b8 9 *
ktownsend 29:011e95ce78b8 10 * Unless required by applicable law or agreed to in writing, software
ktownsend 29:011e95ce78b8 11 * distributed under the License is distributed on an "AS IS" BASIS,
ktownsend 29:011e95ce78b8 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ktownsend 29:011e95ce78b8 13 * See the License for the specific language governing permissions and
ktownsend 29:011e95ce78b8 14 * limitations under the License.
ktownsend 29:011e95ce78b8 15 */
Rohit Grover 34:da2ea8cd6216 16
ktownsend 29:011e95ce78b8 17 #ifndef __GAP_H__
ktownsend 29:011e95ce78b8 18 #define __GAP_H__
ktownsend 29:011e95ce78b8 19
ktownsend 29:011e95ce78b8 20 #include "mbed.h"
ktownsend 29:011e95ce78b8 21 #include "blecommon.h"
ktownsend 29:011e95ce78b8 22 #include "GapAdvertisingData.h"
ktownsend 29:011e95ce78b8 23 #include "GapAdvertisingParams.h"
bogdanm 31:2c94f0501807 24 #include "GapEvents.h"
ktownsend 29:011e95ce78b8 25
ktownsend 29:011e95ce78b8 26 /**************************************************************************/
ktownsend 29:011e95ce78b8 27 /*!
ktownsend 29:011e95ce78b8 28 \brief
ktownsend 29:011e95ce78b8 29 The base class used to abstract GAP functionality to a specific radio
ktownsend 29:011e95ce78b8 30 transceiver, SOC or BLE Stack.
ktownsend 29:011e95ce78b8 31 */
ktownsend 29:011e95ce78b8 32 /**************************************************************************/
ktownsend 29:011e95ce78b8 33 class Gap
ktownsend 29:011e95ce78b8 34 {
Rohit Grover 34:da2ea8cd6216 35 private:
Rohit Grover 34:da2ea8cd6216 36 GapEvents *m_pEventHandler;
bogdanm 31:2c94f0501807 37
Rohit Grover 34:da2ea8cd6216 38 public:
Rohit Grover 34:da2ea8cd6216 39 typedef enum addr_type_e {
Rohit Grover 34:da2ea8cd6216 40 ADDR_TYPE_PUBLIC = 0,
Rohit Grover 34:da2ea8cd6216 41 ADDR_TYPE_RANDOM_STATIC,
Rohit Grover 34:da2ea8cd6216 42 ADDR_TYPE_RANDOM_PRIVATE_RESOLVABLE,
Rohit Grover 34:da2ea8cd6216 43 ADDR_TYPE_RANDOM_PRIVATE_NON_RESOLVABLE
Rohit Grover 34:da2ea8cd6216 44 } addr_type_t;
Rohit Grover 34:da2ea8cd6216 45
Rohit Grover 34:da2ea8cd6216 46 /* These functions must be defined in the sub-class */
Rohit Grover 34:da2ea8cd6216 47 virtual ble_error_t setAddress(addr_type_t type, uint8_t address[6]) = 0;
Rohit Grover 34:da2ea8cd6216 48 virtual ble_error_t setAdvertisingData(GapAdvertisingData &,
Rohit Grover 34:da2ea8cd6216 49 GapAdvertisingData &) = 0;
Rohit Grover 34:da2ea8cd6216 50 virtual ble_error_t startAdvertising(GapAdvertisingParams &) = 0;
Rohit Grover 34:da2ea8cd6216 51 virtual ble_error_t stopAdvertising(void) = 0;
Rohit Grover 34:da2ea8cd6216 52 virtual ble_error_t disconnect(void) = 0;
bogdanm 31:2c94f0501807 53
Rohit Grover 34:da2ea8cd6216 54 /* Describes the current state of the device (more than one bit can be
Rohit Grover 34:da2ea8cd6216 55 *set) */
Rohit Grover 34:da2ea8cd6216 56 typedef struct GapState_s
Rohit Grover 34:da2ea8cd6216 57 {
Rohit Grover 34:da2ea8cd6216 58 unsigned advertising : 1; /**< The device is current
Rohit Grover 34:da2ea8cd6216 59 *advertising */
Rohit Grover 34:da2ea8cd6216 60 unsigned connected : 1; /**< The peripheral is
Rohit Grover 34:da2ea8cd6216 61 *connected to a central
Rohit Grover 34:da2ea8cd6216 62 *device */
Rohit Grover 34:da2ea8cd6216 63 } GapState_t;
Rohit Grover 34:da2ea8cd6216 64
Rohit Grover 34:da2ea8cd6216 65 /* Event callback handlers */
Rohit Grover 34:da2ea8cd6216 66 void setEventHandler(GapEvents *pEventHandler) {
Rohit Grover 34:da2ea8cd6216 67 m_pEventHandler = pEventHandler;
Rohit Grover 34:da2ea8cd6216 68 }
ktownsend 29:011e95ce78b8 69
Rohit Grover 34:da2ea8cd6216 70 void handleEvent(GapEvents::gapEvent_e type) {
Rohit Grover 34:da2ea8cd6216 71 if (NULL == m_pEventHandler) {
Rohit Grover 34:da2ea8cd6216 72 return;
Rohit Grover 34:da2ea8cd6216 73 }
Rohit Grover 34:da2ea8cd6216 74 switch (type) {
Rohit Grover 34:da2ea8cd6216 75 case GapEvents::GAP_EVENT_TIMEOUT:
Rohit Grover 34:da2ea8cd6216 76 state.advertising = 0;
Rohit Grover 34:da2ea8cd6216 77 m_pEventHandler->onTimeout();
Rohit Grover 34:da2ea8cd6216 78 break;
Rohit Grover 34:da2ea8cd6216 79 case GapEvents::GAP_EVENT_CONNECTED:
Rohit Grover 34:da2ea8cd6216 80 state.connected = 1;
Rohit Grover 34:da2ea8cd6216 81 m_pEventHandler->onConnected();
Rohit Grover 34:da2ea8cd6216 82 break;
Rohit Grover 34:da2ea8cd6216 83 case GapEvents::GAP_EVENT_DISCONNECTED:
Rohit Grover 34:da2ea8cd6216 84 state.connected = 0;
Rohit Grover 34:da2ea8cd6216 85 m_pEventHandler->onDisconnected();
Rohit Grover 34:da2ea8cd6216 86 break;
Rohit Grover 34:da2ea8cd6216 87 }
Rohit Grover 34:da2ea8cd6216 88 }
Rohit Grover 34:da2ea8cd6216 89
Rohit Grover 34:da2ea8cd6216 90 GapState_t state;
ktownsend 29:011e95ce78b8 91 };
ktownsend 29:011e95ce78b8 92
Rohit Grover 34:da2ea8cd6216 93 #endif // ifndef __GAP_H__