Michael Galis / nRF51822

No changes

Fork of nRF51822 by Nordic Semiconductor

source/nRF5xGap.h@546:1e147322b2b5, 2016-01-11 (annotated)

Committer:
vcoubard
Date:
Mon Jan 11 10:19:05 2016 +0000
Revision:
546:1e147322b2b5
Parent:
541:884f95bf5351
Child:
549:3f782c64d014
Synchronized with git rev cc0cf3df

Author: Vincent Coubard

Merge remote-tracking branch 'origin/develop' into characteristicDescriptorDiscovery

Who changed what in which revision?

UserRevisionLine numberNew contents of line
vcoubard 541:884f95bf5351 1 /* mbed Microcontroller Library
vcoubard 541:884f95bf5351 2 * Copyright (c) 2006-2013 ARM Limited
vcoubard 541:884f95bf5351 3 *
vcoubard 541:884f95bf5351 4 * Licensed under the Apache License, Version 2.0 (the "License");
vcoubard 541:884f95bf5351 5 * you may not use this file except in compliance with the License.
vcoubard 541:884f95bf5351 6 * You may obtain a copy of the License at
vcoubard 541:884f95bf5351 7 *
vcoubard 541:884f95bf5351 8 * http://www.apache.org/licenses/LICENSE-2.0
vcoubard 541:884f95bf5351 9 *
vcoubard 541:884f95bf5351 10 * Unless required by applicable law or agreed to in writing, software
vcoubard 541:884f95bf5351 11 * distributed under the License is distributed on an "AS IS" BASIS,
vcoubard 541:884f95bf5351 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
vcoubard 541:884f95bf5351 13 * See the License for the specific language governing permissions and
vcoubard 541:884f95bf5351 14 * limitations under the License.
vcoubard 541:884f95bf5351 15 */
vcoubard 541:884f95bf5351 16
vcoubard 541:884f95bf5351 17 #ifndef __NRF5x_GAP_H__
vcoubard 541:884f95bf5351 18 #define __NRF5x_GAP_H__
vcoubard 541:884f95bf5351 19
vcoubard 541:884f95bf5351 20 #include "mbed.h"
vcoubard 541:884f95bf5351 21 #include "ble/blecommon.h"
vcoubard 541:884f95bf5351 22 #include "ble.h"
vcoubard 541:884f95bf5351 23 #include "ble/GapAdvertisingParams.h"
vcoubard 541:884f95bf5351 24 #include "ble/GapAdvertisingData.h"
vcoubard 541:884f95bf5351 25 #include "ble/Gap.h"
vcoubard 541:884f95bf5351 26 #include "ble/GapScanningParams.h"
vcoubard 541:884f95bf5351 27
vcoubard 541:884f95bf5351 28 #include "nrf_soc.h"
vcoubard 541:884f95bf5351 29 #include "ble_radio_notification.h"
vcoubard 541:884f95bf5351 30 #include "btle_security.h"
vcoubard 541:884f95bf5351 31
vcoubard 541:884f95bf5351 32 void radioNotificationStaticCallback(bool param);
vcoubard 541:884f95bf5351 33
vcoubard 541:884f95bf5351 34 /**************************************************************************/
vcoubard 541:884f95bf5351 35 /*!
vcoubard 541:884f95bf5351 36 \brief
vcoubard 541:884f95bf5351 37
vcoubard 541:884f95bf5351 38 */
vcoubard 541:884f95bf5351 39 /**************************************************************************/
vcoubard 541:884f95bf5351 40 class nRF5xGap : public Gap
vcoubard 541:884f95bf5351 41 {
vcoubard 541:884f95bf5351 42 public:
vcoubard 541:884f95bf5351 43 static nRF5xGap &getInstance();
vcoubard 541:884f95bf5351 44
vcoubard 541:884f95bf5351 45 /* Functions that must be implemented from Gap */
vcoubard 541:884f95bf5351 46 virtual ble_error_t setAddress(AddressType_t type, const Address_t address);
vcoubard 541:884f95bf5351 47 virtual ble_error_t getAddress(AddressType_t *typeP, Address_t address);
vcoubard 541:884f95bf5351 48 virtual ble_error_t setAdvertisingData(const GapAdvertisingData &, const GapAdvertisingData &);
vcoubard 541:884f95bf5351 49
vcoubard 541:884f95bf5351 50 virtual uint16_t getMinAdvertisingInterval(void) const {return GapAdvertisingParams::ADVERTISEMENT_DURATION_UNITS_TO_MS(BLE_GAP_ADV_INTERVAL_MIN);}
vcoubard 541:884f95bf5351 51 virtual uint16_t getMinNonConnectableAdvertisingInterval(void) const {return GapAdvertisingParams::ADVERTISEMENT_DURATION_UNITS_TO_MS(BLE_GAP_ADV_NONCON_INTERVAL_MIN);}
vcoubard 541:884f95bf5351 52 virtual uint16_t getMaxAdvertisingInterval(void) const {return GapAdvertisingParams::ADVERTISEMENT_DURATION_UNITS_TO_MS(BLE_GAP_ADV_INTERVAL_MAX);}
vcoubard 541:884f95bf5351 53
vcoubard 541:884f95bf5351 54 virtual ble_error_t startAdvertising(const GapAdvertisingParams &);
vcoubard 541:884f95bf5351 55 virtual ble_error_t stopAdvertising(void);
vcoubard 541:884f95bf5351 56 virtual ble_error_t connect(const Address_t, Gap::AddressType_t peerAddrType, const ConnectionParams_t *connectionParams, const GapScanningParams *scanParams);
vcoubard 541:884f95bf5351 57 virtual ble_error_t disconnect(Handle_t connectionHandle, DisconnectionReason_t reason);
vcoubard 541:884f95bf5351 58 virtual ble_error_t disconnect(DisconnectionReason_t reason);
vcoubard 541:884f95bf5351 59
vcoubard 541:884f95bf5351 60 virtual ble_error_t setDeviceName(const uint8_t *deviceName);
vcoubard 541:884f95bf5351 61 virtual ble_error_t getDeviceName(uint8_t *deviceName, unsigned *lengthP);
vcoubard 541:884f95bf5351 62 virtual ble_error_t setAppearance(GapAdvertisingData::Appearance appearance);
vcoubard 541:884f95bf5351 63 virtual ble_error_t getAppearance(GapAdvertisingData::Appearance *appearanceP);
vcoubard 541:884f95bf5351 64
vcoubard 541:884f95bf5351 65 virtual ble_error_t setTxPower(int8_t txPower);
vcoubard 541:884f95bf5351 66 virtual void getPermittedTxPowerValues(const int8_t **valueArrayPP, size_t *countP);
vcoubard 541:884f95bf5351 67
vcoubard 541:884f95bf5351 68 void setConnectionHandle(uint16_t con_handle);
vcoubard 541:884f95bf5351 69 uint16_t getConnectionHandle(void);
vcoubard 541:884f95bf5351 70
vcoubard 541:884f95bf5351 71 virtual ble_error_t getPreferredConnectionParams(ConnectionParams_t *params);
vcoubard 541:884f95bf5351 72 virtual ble_error_t setPreferredConnectionParams(const ConnectionParams_t *params);
vcoubard 541:884f95bf5351 73 virtual ble_error_t updateConnectionParams(Handle_t handle, const ConnectionParams_t *params);
vcoubard 541:884f95bf5351 74
vcoubard 541:884f95bf5351 75 virtual ble_error_t initRadioNotification(void) {
vcoubard 541:884f95bf5351 76 if (ble_radio_notification_init(NRF_APP_PRIORITY_HIGH, NRF_RADIO_NOTIFICATION_DISTANCE_800US, radioNotificationStaticCallback) == NRF_SUCCESS) {
vcoubard 541:884f95bf5351 77 return BLE_ERROR_NONE;
vcoubard 541:884f95bf5351 78 }
vcoubard 541:884f95bf5351 79
vcoubard 541:884f95bf5351 80 return BLE_ERROR_UNSPECIFIED;
vcoubard 541:884f95bf5351 81 }
vcoubard 541:884f95bf5351 82
vcoubard 541:884f95bf5351 83 /* Observer role is not supported by S110, return BLE_ERROR_NOT_IMPLEMENTED */
vcoubard 541:884f95bf5351 84 #if !defined(TARGET_MCU_NRF51_16K_S110) && !defined(TARGET_MCU_NRF51_32K_S110)
vcoubard 541:884f95bf5351 85 virtual ble_error_t startRadioScan(const GapScanningParams &scanningParams) {
vcoubard 541:884f95bf5351 86 ble_gap_scan_params_t scanParams = {
vcoubard 541:884f95bf5351 87 .active = scanningParams.getActiveScanning(), /**< If 1, perform active scanning (scan requests). */
vcoubard 541:884f95bf5351 88 .selective = 0, /**< If 1, ignore unknown devices (non whitelisted). */
vcoubard 541:884f95bf5351 89 .p_whitelist = NULL, /**< Pointer to whitelist, NULL if none is given. */
vcoubard 541:884f95bf5351 90 .interval = scanningParams.getInterval(), /**< Scan interval between 0x0004 and 0x4000 in 0.625ms units (2.5ms to 10.24s). */
vcoubard 541:884f95bf5351 91 .window = scanningParams.getWindow(), /**< Scan window between 0x0004 and 0x4000 in 0.625ms units (2.5ms to 10.24s). */
vcoubard 541:884f95bf5351 92 .timeout = scanningParams.getTimeout(), /**< Scan timeout between 0x0001 and 0xFFFF in seconds, 0x0000 disables timeout. */
vcoubard 541:884f95bf5351 93 };
vcoubard 541:884f95bf5351 94
vcoubard 541:884f95bf5351 95 if (sd_ble_gap_scan_start(&scanParams) != NRF_SUCCESS) {
vcoubard 541:884f95bf5351 96 return BLE_ERROR_PARAM_OUT_OF_RANGE;
vcoubard 541:884f95bf5351 97 }
vcoubard 541:884f95bf5351 98
vcoubard 541:884f95bf5351 99 return BLE_ERROR_NONE;
vcoubard 541:884f95bf5351 100 }
vcoubard 541:884f95bf5351 101
vcoubard 541:884f95bf5351 102 virtual ble_error_t stopScan(void) {
vcoubard 541:884f95bf5351 103 if (sd_ble_gap_scan_stop() == NRF_SUCCESS) {
vcoubard 541:884f95bf5351 104 return BLE_ERROR_NONE;
vcoubard 541:884f95bf5351 105 }
vcoubard 541:884f95bf5351 106
vcoubard 541:884f95bf5351 107 return BLE_STACK_BUSY;
vcoubard 541:884f95bf5351 108 }
vcoubard 541:884f95bf5351 109 #endif
vcoubard 541:884f95bf5351 110
vcoubard 541:884f95bf5351 111 private:
vcoubard 546:1e147322b2b5 112 #ifdef YOTTA_CFG_MBED_OS
vcoubard 546:1e147322b2b5 113 /*
vcoubard 546:1e147322b2b5 114 * In mbed OS, all user-facing BLE events (interrupts) are posted to the
vcoubard 546:1e147322b2b5 115 * MINAR scheduler to be executed as callbacks in thread mode. MINAR guards
vcoubard 546:1e147322b2b5 116 * its critical sections from interrupts by acquiring CriticalSectionLock,
vcoubard 546:1e147322b2b5 117 * which results in a call to sd_nvic_critical_region_enter(). Thus, it is
vcoubard 546:1e147322b2b5 118 * safe to invoke MINAR APIs from interrupt context as long as those
vcoubard 546:1e147322b2b5 119 * interrupts are blocked by sd_nvic_critical_region_enter().
vcoubard 546:1e147322b2b5 120 *
vcoubard 546:1e147322b2b5 121 * Radio notifications are a special case for the above. The Radio
vcoubard 546:1e147322b2b5 122 * Notification IRQ is handled at a very high priority--higher than the
vcoubard 546:1e147322b2b5 123 * level blocked by sd_nvic_critical_region_enter(). Thus Radio Notification
vcoubard 546:1e147322b2b5 124 * events can preempt MINAR's critical sections. Using MINAR APIs (such as
vcoubard 546:1e147322b2b5 125 * posting an event) directly in processRadioNotification() may result in a
vcoubard 546:1e147322b2b5 126 * race condition ending in a hard-fault.
vcoubard 546:1e147322b2b5 127 *
vcoubard 546:1e147322b2b5 128 * The solution is to *not* call MINAR APIs directly from the Radio
vcoubard 546:1e147322b2b5 129 * Notification handling; i.e. to do the bulk of RadioNotification
vcoubard 546:1e147322b2b5 130 * processing at a reduced priority which respects MINAR's critical
vcoubard 546:1e147322b2b5 131 * sections. Unfortunately, on a cortex-M0, there is no clean way to demote
vcoubard 546:1e147322b2b5 132 * priority for the currently executing interrupt--we wouldn't want to
vcoubard 546:1e147322b2b5 133 * demote the radio notification handling anyway because it is sensitive to
vcoubard 546:1e147322b2b5 134 * timing, and the system expects to finish this handling very quickly. The
vcoubard 546:1e147322b2b5 135 * workaround is to employ a Timeout to trigger
vcoubard 546:1e147322b2b5 136 * postRadioNotificationCallback() after a very short delay (~0 us) and post
vcoubard 546:1e147322b2b5 137 * the MINAR callback that context.
vcoubard 546:1e147322b2b5 138 *
vcoubard 546:1e147322b2b5 139 * !!!WARNING!!! Radio notifications are very time critical events. The
vcoubard 546:1e147322b2b5 140 * current solution is expected to work under the assumption that
vcoubard 546:1e147322b2b5 141 * postRadioNotificationCalback() will be executed BEFORE the next radio
vcoubard 546:1e147322b2b5 142 * notification event is generated.
vcoubard 546:1e147322b2b5 143 */
vcoubard 546:1e147322b2b5 144
vcoubard 546:1e147322b2b5 145 bool radioNotificationCallbackParam; /* parameter to be passed into the Timeout-generated radio notification callback. */
vcoubard 546:1e147322b2b5 146 Timeout radioNotificationTimeout;
vcoubard 546:1e147322b2b5 147
vcoubard 546:1e147322b2b5 148 /*
vcoubard 546:1e147322b2b5 149 * A helper function to post radio notification callbacks through MINAR when using mbed OS.
vcoubard 546:1e147322b2b5 150 */
vcoubard 546:1e147322b2b5 151 void postRadioNotificationCallback(void) {
vcoubard 546:1e147322b2b5 152 minar::Scheduler::postCallback(
vcoubard 546:1e147322b2b5 153 mbed::util::FunctionPointer1<void, bool>(&radioNotificationCallback, &FunctionPointerWithContext<bool>::call).bind(radioNotificationCallbackParam)
vcoubard 546:1e147322b2b5 154 );
vcoubard 546:1e147322b2b5 155 }
vcoubard 546:1e147322b2b5 156 #endif /* #ifdef YOTTA_CFG_MBED_OS */
vcoubard 546:1e147322b2b5 157
vcoubard 541:884f95bf5351 158 /**
vcoubard 541:884f95bf5351 159 * A helper function to process radio-notification events; to be called internally.
vcoubard 541:884f95bf5351 160 * @param param [description]
vcoubard 541:884f95bf5351 161 */
vcoubard 541:884f95bf5351 162 void processRadioNotificationEvent(bool param) {
vcoubard 546:1e147322b2b5 163 #ifdef YOTTA_CFG_MBED_OS
vcoubard 546:1e147322b2b5 164 /* When using mbed OS the callback to the user-defined function will be posted through minar */
vcoubard 546:1e147322b2b5 165 radioNotificationCallbackParam = param;
vcoubard 546:1e147322b2b5 166 radioNotificationTimeout.attach_us(this, &nRF5xGap::postRadioNotificationCallback, 0);
vcoubard 546:1e147322b2b5 167 #else
vcoubard 541:884f95bf5351 168 radioNotificationCallback.call(param);
vcoubard 546:1e147322b2b5 169 #endif
vcoubard 541:884f95bf5351 170 }
vcoubard 541:884f95bf5351 171 friend void radioNotificationStaticCallback(bool param); /* allow invocations of processRadioNotificationEvent() */
vcoubard 541:884f95bf5351 172
vcoubard 541:884f95bf5351 173 private:
vcoubard 541:884f95bf5351 174 uint16_t m_connectionHandle;
vcoubard 541:884f95bf5351 175 nRF5xGap() {
vcoubard 541:884f95bf5351 176 m_connectionHandle = BLE_CONN_HANDLE_INVALID;
vcoubard 541:884f95bf5351 177 }
vcoubard 541:884f95bf5351 178
vcoubard 541:884f95bf5351 179 nRF5xGap(nRF5xGap const &);
vcoubard 541:884f95bf5351 180 void operator=(nRF5xGap const &);
vcoubard 541:884f95bf5351 181 };
vcoubard 541:884f95bf5351 182
rgrover1 388:db85a09c27ef 183 #endif // ifndef __NRF5x_GAP_H__