Philip Holifield / nRF51822

for bbc microbit library

Dependencies:   nrf51-sdk

Dependents:   microbit-dal

Fork of nRF51822 by Lancaster University

source/nRF5xGap.h@615:65ea2acfc6a2, 2016-04-06 (annotated)

Committer:
LancasterUniversity
Date:
Wed Apr 06 22:38:43 2016 +0100
Revision:
615:65ea2acfc6a2
Parent:
604:0f5c8725146c
Child:
616:a8f9b022d8fd
Synchronized with git rev 60a7c0c0

Author: Rohit Grover

bring in the latest changes for BLE::init() where we allow <object, member> tuples for init callback.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
LancasterUniversity 615:65ea2acfc6a2 1 /* mbed Microcontroller Library
LancasterUniversity 615:65ea2acfc6a2 2 * Copyright (c) 2006-2013 ARM Limited
LancasterUniversity 615:65ea2acfc6a2 3 *
LancasterUniversity 615:65ea2acfc6a2 4 * Licensed under the Apache License, Version 2.0 (the "License");
LancasterUniversity 615:65ea2acfc6a2 5 * you may not use this file except in compliance with the License.
LancasterUniversity 615:65ea2acfc6a2 6 * You may obtain a copy of the License at
LancasterUniversity 615:65ea2acfc6a2 7 *
LancasterUniversity 615:65ea2acfc6a2 8 * http://www.apache.org/licenses/LICENSE-2.0
LancasterUniversity 615:65ea2acfc6a2 9 *
LancasterUniversity 615:65ea2acfc6a2 10 * Unless required by applicable law or agreed to in writing, software
LancasterUniversity 615:65ea2acfc6a2 11 * distributed under the License is distributed on an "AS IS" BASIS,
LancasterUniversity 615:65ea2acfc6a2 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
LancasterUniversity 615:65ea2acfc6a2 13 * See the License for the specific language governing permissions and
LancasterUniversity 615:65ea2acfc6a2 14 * limitations under the License.
LancasterUniversity 615:65ea2acfc6a2 15 */
LancasterUniversity 615:65ea2acfc6a2 16
LancasterUniversity 615:65ea2acfc6a2 17 #ifndef __NRF5x_GAP_H__
LancasterUniversity 615:65ea2acfc6a2 18 #define __NRF5x_GAP_H__
LancasterUniversity 615:65ea2acfc6a2 19
LancasterUniversity 615:65ea2acfc6a2 20 #include "mbed.h"
LancasterUniversity 615:65ea2acfc6a2 21 #include "ble/blecommon.h"
LancasterUniversity 615:65ea2acfc6a2 22 #include "ble.h"
LancasterUniversity 615:65ea2acfc6a2 23 #include "ble/GapAdvertisingParams.h"
LancasterUniversity 615:65ea2acfc6a2 24 #include "ble/GapAdvertisingData.h"
LancasterUniversity 615:65ea2acfc6a2 25 #include "ble/Gap.h"
LancasterUniversity 615:65ea2acfc6a2 26 #include "ble/GapScanningParams.h"
LancasterUniversity 615:65ea2acfc6a2 27
LancasterUniversity 615:65ea2acfc6a2 28 #include "nrf_soc.h"
LancasterUniversity 615:65ea2acfc6a2 29 #include "ble_radio_notification.h"
LancasterUniversity 615:65ea2acfc6a2 30 #include "btle_security.h"
LancasterUniversity 615:65ea2acfc6a2 31
LancasterUniversity 615:65ea2acfc6a2 32 void radioNotificationStaticCallback(bool param);
LancasterUniversity 615:65ea2acfc6a2 33
LancasterUniversity 615:65ea2acfc6a2 34 /**************************************************************************/
LancasterUniversity 615:65ea2acfc6a2 35 /*!
LancasterUniversity 615:65ea2acfc6a2 36 \brief
LancasterUniversity 615:65ea2acfc6a2 37
LancasterUniversity 615:65ea2acfc6a2 38 */
LancasterUniversity 615:65ea2acfc6a2 39 /**************************************************************************/
LancasterUniversity 615:65ea2acfc6a2 40 class nRF5xGap : public Gap
LancasterUniversity 615:65ea2acfc6a2 41 {
LancasterUniversity 615:65ea2acfc6a2 42 public:
LancasterUniversity 615:65ea2acfc6a2 43 static nRF5xGap &getInstance();
LancasterUniversity 615:65ea2acfc6a2 44
LancasterUniversity 615:65ea2acfc6a2 45 /* Functions that must be implemented from Gap */
LancasterUniversity 615:65ea2acfc6a2 46 virtual ble_error_t setAddress(AddressType_t type, const Address_t address);
LancasterUniversity 615:65ea2acfc6a2 47 virtual ble_error_t getAddress(AddressType_t *typeP, Address_t address);
LancasterUniversity 615:65ea2acfc6a2 48 virtual ble_error_t setAdvertisingData(const GapAdvertisingData &, const GapAdvertisingData &);
LancasterUniversity 615:65ea2acfc6a2 49
LancasterUniversity 615:65ea2acfc6a2 50 virtual uint16_t getMinAdvertisingInterval(void) const {return GapAdvertisingParams::ADVERTISEMENT_DURATION_UNITS_TO_MS(BLE_GAP_ADV_INTERVAL_MIN);}
LancasterUniversity 615:65ea2acfc6a2 51 virtual uint16_t getMinNonConnectableAdvertisingInterval(void) const {return GapAdvertisingParams::ADVERTISEMENT_DURATION_UNITS_TO_MS(BLE_GAP_ADV_NONCON_INTERVAL_MIN);}
LancasterUniversity 615:65ea2acfc6a2 52 virtual uint16_t getMaxAdvertisingInterval(void) const {return GapAdvertisingParams::ADVERTISEMENT_DURATION_UNITS_TO_MS(BLE_GAP_ADV_INTERVAL_MAX);}
LancasterUniversity 615:65ea2acfc6a2 53
LancasterUniversity 615:65ea2acfc6a2 54 virtual ble_error_t startAdvertising(const GapAdvertisingParams &);
LancasterUniversity 615:65ea2acfc6a2 55 virtual ble_error_t stopAdvertising(void);
LancasterUniversity 615:65ea2acfc6a2 56 virtual ble_error_t connect(const Address_t, Gap::AddressType_t peerAddrType, const ConnectionParams_t *connectionParams, const GapScanningParams *scanParams);
LancasterUniversity 615:65ea2acfc6a2 57 virtual ble_error_t disconnect(Handle_t connectionHandle, DisconnectionReason_t reason);
LancasterUniversity 615:65ea2acfc6a2 58 virtual ble_error_t disconnect(DisconnectionReason_t reason);
LancasterUniversity 615:65ea2acfc6a2 59
LancasterUniversity 615:65ea2acfc6a2 60 virtual ble_error_t setDeviceName(const uint8_t *deviceName);
LancasterUniversity 615:65ea2acfc6a2 61 virtual ble_error_t getDeviceName(uint8_t *deviceName, unsigned *lengthP);
LancasterUniversity 615:65ea2acfc6a2 62 virtual ble_error_t setAppearance(GapAdvertisingData::Appearance appearance);
LancasterUniversity 615:65ea2acfc6a2 63 virtual ble_error_t getAppearance(GapAdvertisingData::Appearance *appearanceP);
LancasterUniversity 615:65ea2acfc6a2 64
LancasterUniversity 615:65ea2acfc6a2 65 virtual ble_error_t setTxPower(int8_t txPower);
LancasterUniversity 615:65ea2acfc6a2 66 virtual void getPermittedTxPowerValues(const int8_t **valueArrayPP, size_t *countP);
LancasterUniversity 615:65ea2acfc6a2 67
LancasterUniversity 615:65ea2acfc6a2 68 void setConnectionHandle(uint16_t con_handle);
LancasterUniversity 615:65ea2acfc6a2 69 uint16_t getConnectionHandle(void);
LancasterUniversity 615:65ea2acfc6a2 70
LancasterUniversity 615:65ea2acfc6a2 71 virtual ble_error_t getPreferredConnectionParams(ConnectionParams_t *params);
LancasterUniversity 615:65ea2acfc6a2 72 virtual ble_error_t setPreferredConnectionParams(const ConnectionParams_t *params);
LancasterUniversity 615:65ea2acfc6a2 73 virtual ble_error_t updateConnectionParams(Handle_t handle, const ConnectionParams_t *params);
LancasterUniversity 615:65ea2acfc6a2 74
LancasterUniversity 615:65ea2acfc6a2 75 virtual ble_error_t initRadioNotification(void) {
LancasterUniversity 615:65ea2acfc6a2 76 if (ble_radio_notification_init(NRF_APP_PRIORITY_HIGH, NRF_RADIO_NOTIFICATION_DISTANCE_800US, radioNotificationStaticCallback) == NRF_SUCCESS) {
LancasterUniversity 615:65ea2acfc6a2 77 return BLE_ERROR_NONE;
LancasterUniversity 615:65ea2acfc6a2 78 }
LancasterUniversity 615:65ea2acfc6a2 79
LancasterUniversity 615:65ea2acfc6a2 80 return BLE_ERROR_UNSPECIFIED;
LancasterUniversity 615:65ea2acfc6a2 81 }
LancasterUniversity 615:65ea2acfc6a2 82
LancasterUniversity 615:65ea2acfc6a2 83 /* Observer role is not supported by S110, return BLE_ERROR_NOT_IMPLEMENTED */
LancasterUniversity 615:65ea2acfc6a2 84 #if !defined(TARGET_MCU_NRF51_16K_S110) && !defined(TARGET_MCU_NRF51_32K_S110)
LancasterUniversity 615:65ea2acfc6a2 85 virtual ble_error_t startRadioScan(const GapScanningParams &scanningParams) {
LancasterUniversity 615:65ea2acfc6a2 86 ble_gap_scan_params_t scanParams = {
LancasterUniversity 615:65ea2acfc6a2 87 .active = scanningParams.getActiveScanning(), /**< If 1, perform active scanning (scan requests). */
LancasterUniversity 615:65ea2acfc6a2 88 .selective = 0, /**< If 1, ignore unknown devices (non whitelisted). */
LancasterUniversity 615:65ea2acfc6a2 89 .p_whitelist = NULL, /**< Pointer to whitelist, NULL if none is given. */
LancasterUniversity 615:65ea2acfc6a2 90 .interval = scanningParams.getInterval(), /**< Scan interval between 0x0004 and 0x4000 in 0.625ms units (2.5ms to 10.24s). */
LancasterUniversity 615:65ea2acfc6a2 91 .window = scanningParams.getWindow(), /**< Scan window between 0x0004 and 0x4000 in 0.625ms units (2.5ms to 10.24s). */
LancasterUniversity 615:65ea2acfc6a2 92 .timeout = scanningParams.getTimeout(), /**< Scan timeout between 0x0001 and 0xFFFF in seconds, 0x0000 disables timeout. */
LancasterUniversity 615:65ea2acfc6a2 93 };
LancasterUniversity 615:65ea2acfc6a2 94
LancasterUniversity 615:65ea2acfc6a2 95 if (sd_ble_gap_scan_start(&scanParams) != NRF_SUCCESS) {
LancasterUniversity 615:65ea2acfc6a2 96 return BLE_ERROR_PARAM_OUT_OF_RANGE;
LancasterUniversity 615:65ea2acfc6a2 97 }
LancasterUniversity 615:65ea2acfc6a2 98
LancasterUniversity 615:65ea2acfc6a2 99 return BLE_ERROR_NONE;
LancasterUniversity 615:65ea2acfc6a2 100 }
LancasterUniversity 615:65ea2acfc6a2 101
LancasterUniversity 615:65ea2acfc6a2 102 virtual ble_error_t stopScan(void) {
LancasterUniversity 615:65ea2acfc6a2 103 if (sd_ble_gap_scan_stop() == NRF_SUCCESS) {
LancasterUniversity 615:65ea2acfc6a2 104 return BLE_ERROR_NONE;
LancasterUniversity 615:65ea2acfc6a2 105 }
LancasterUniversity 615:65ea2acfc6a2 106
LancasterUniversity 615:65ea2acfc6a2 107 return BLE_STACK_BUSY;
LancasterUniversity 615:65ea2acfc6a2 108 }
LancasterUniversity 615:65ea2acfc6a2 109 #endif
LancasterUniversity 615:65ea2acfc6a2 110
LancasterUniversity 615:65ea2acfc6a2 111 private:
LancasterUniversity 615:65ea2acfc6a2 112 /**
LancasterUniversity 615:65ea2acfc6a2 113 * A helper function to process radio-notification events; to be called internally.
LancasterUniversity 615:65ea2acfc6a2 114 * @param param [description]
LancasterUniversity 615:65ea2acfc6a2 115 */
LancasterUniversity 615:65ea2acfc6a2 116 void processRadioNotificationEvent(bool param) {
LancasterUniversity 615:65ea2acfc6a2 117 radioNotificationCallback.call(param);
LancasterUniversity 615:65ea2acfc6a2 118 }
LancasterUniversity 615:65ea2acfc6a2 119 friend void radioNotificationStaticCallback(bool param); /* allow invocations of processRadioNotificationEvent() */
LancasterUniversity 615:65ea2acfc6a2 120
LancasterUniversity 615:65ea2acfc6a2 121 private:
LancasterUniversity 615:65ea2acfc6a2 122 uint16_t m_connectionHandle;
LancasterUniversity 615:65ea2acfc6a2 123 nRF5xGap() {
LancasterUniversity 615:65ea2acfc6a2 124 m_connectionHandle = BLE_CONN_HANDLE_INVALID;
LancasterUniversity 615:65ea2acfc6a2 125 }
LancasterUniversity 615:65ea2acfc6a2 126
LancasterUniversity 615:65ea2acfc6a2 127 nRF5xGap(nRF5xGap const &);
LancasterUniversity 615:65ea2acfc6a2 128 void operator=(nRF5xGap const &);
LancasterUniversity 615:65ea2acfc6a2 129 };
LancasterUniversity 615:65ea2acfc6a2 130
rgrover1 388:db85a09c27ef 131 #endif // ifndef __NRF5x_GAP_H__