Michael Galis / nRF51822

No changes

Fork of nRF51822 by Nordic Semiconductor

source/nRF5xGap.h@471:945e53179855, 2015-11-26 (annotated)

Committer:
rgrover1
Date:
Thu Nov 26 14:33:45 2015 +0000
Revision:
471:945e53179855
Parent:
470:2c1d3b1fe249
Child:
475:fe3d08b3a8e9
Synchronized with git rev 7de2b716

Author: Rohit Grover

minor rewording of the comment introduced by the previous pull request

Who changed what in which revision?

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