Jonathan Austin / nRF51822

Nordic stack and drivers for the mbed BLE API. Version to work around build bug.

Dependents:   microbit_rubber_ducky microbit_mouse_BLE microbit_mouse_BLE_daybreak_version microbit_presenter

Fork of nRF51822 by Nordic Semiconductor

source/nRF5xGap.h@600:0978b5626451, 2016-01-11 (annotated)

Committer:
vcoubard
Date:
Mon Jan 11 10:19:36 2016 +0000
Revision:
600:0978b5626451
Parent:
598:814c1ce92947
Child:
604:0f5c8725146c
Synchronized with git rev 9d0c6381

Author: Andres Amaya Garcia

Add missing documentation to btle_security for whitelisting

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 578:78f69f1be114 20 #ifdef YOTTA_CFG_MBED_OS
vcoubard 578:78f69f1be114 21 #include "mbed-drivers/mbed.h"
vcoubard 578:78f69f1be114 22 #else
vcoubard 578:78f69f1be114 23 #include "mbed.h"
vcoubard 578:78f69f1be114 24 #endif
vcoubard 596:b66851544182 25 #ifndef YOTTA_CFG_WHITELIST_MAX_SIZE
vcoubard 596:b66851544182 26 #define YOTTA_CFG_WHITELIST_MAX_SIZE BLE_GAP_WHITELIST_ADDR_MAX_COUNT
vcoubard 596:b66851544182 27 #elif YOTTA_CFG_WHITELIST_MAX_SIZE > BLE_GAP_WHITELIST_ADDR_MAX_COUNT
vcoubard 596:b66851544182 28 #undef YOTTA_CFG_WHITELIST_MAX_SIZE
vcoubard 596:b66851544182 29 #define YOTTA_CFG_WHITELIST_MAX_SIZE BLE_GAP_WHITELIST_ADDR_MAX_COUNT
vcoubard 596:b66851544182 30 #endif
vcoubard 598:814c1ce92947 31 #ifndef YOTTA_CFG_IRK_TABLE_MAX_SIZE
vcoubard 598:814c1ce92947 32 #define YOTTA_CFG_IRK_TABLE_MAX_SIZE BLE_GAP_WHITELIST_IRK_MAX_COUNT
vcoubard 598:814c1ce92947 33 #elif YOTTA_CFG_IRK_TABLE_MAX_SIZE > BLE_GAP_WHITELIST_IRK_MAX_COUNT
vcoubard 598:814c1ce92947 34 #undef YOTTA_CFG_IRK_TABLE_MAX_SIZE
vcoubard 598:814c1ce92947 35 #define YOTTA_CFG_IRK_TABLE_MAX_SIZE BLE_GAP_WHITELIST_IRK_MAX_COUNT
vcoubard 598:814c1ce92947 36 #endif
vcoubard 541:884f95bf5351 37 #include "ble/blecommon.h"
vcoubard 541:884f95bf5351 38 #include "ble.h"
vcoubard 541:884f95bf5351 39 #include "ble/GapAdvertisingParams.h"
vcoubard 541:884f95bf5351 40 #include "ble/GapAdvertisingData.h"
vcoubard 541:884f95bf5351 41 #include "ble/Gap.h"
vcoubard 541:884f95bf5351 42 #include "ble/GapScanningParams.h"
vcoubard 541:884f95bf5351 43
vcoubard 541:884f95bf5351 44 #include "nrf_soc.h"
vcoubard 549:3f782c64d014 45
vcoubard 549:3f782c64d014 46 extern "C" {
vcoubard 541:884f95bf5351 47 #include "ble_radio_notification.h"
vcoubard 549:3f782c64d014 48 }
vcoubard 549:3f782c64d014 49
vcoubard 541:884f95bf5351 50 #include "btle_security.h"
vcoubard 541:884f95bf5351 51
vcoubard 541:884f95bf5351 52 void radioNotificationStaticCallback(bool param);
vcoubard 541:884f95bf5351 53
vcoubard 541:884f95bf5351 54 /**************************************************************************/
vcoubard 541:884f95bf5351 55 /*!
vcoubard 541:884f95bf5351 56 \brief
vcoubard 541:884f95bf5351 57
vcoubard 541:884f95bf5351 58 */
vcoubard 541:884f95bf5351 59 /**************************************************************************/
vcoubard 541:884f95bf5351 60 class nRF5xGap : public Gap
vcoubard 541:884f95bf5351 61 {
vcoubard 541:884f95bf5351 62 public:
vcoubard 541:884f95bf5351 63 /* Functions that must be implemented from Gap */
vcoubard 541:884f95bf5351 64 virtual ble_error_t setAddress(AddressType_t type, const Address_t address);
vcoubard 541:884f95bf5351 65 virtual ble_error_t getAddress(AddressType_t *typeP, Address_t address);
vcoubard 541:884f95bf5351 66 virtual ble_error_t setAdvertisingData(const GapAdvertisingData &, const GapAdvertisingData &);
vcoubard 541:884f95bf5351 67
vcoubard 541:884f95bf5351 68 virtual uint16_t getMinAdvertisingInterval(void) const {return GapAdvertisingParams::ADVERTISEMENT_DURATION_UNITS_TO_MS(BLE_GAP_ADV_INTERVAL_MIN);}
vcoubard 541:884f95bf5351 69 virtual uint16_t getMinNonConnectableAdvertisingInterval(void) const {return GapAdvertisingParams::ADVERTISEMENT_DURATION_UNITS_TO_MS(BLE_GAP_ADV_NONCON_INTERVAL_MIN);}
vcoubard 541:884f95bf5351 70 virtual uint16_t getMaxAdvertisingInterval(void) const {return GapAdvertisingParams::ADVERTISEMENT_DURATION_UNITS_TO_MS(BLE_GAP_ADV_INTERVAL_MAX);}
vcoubard 541:884f95bf5351 71
vcoubard 541:884f95bf5351 72 virtual ble_error_t startAdvertising(const GapAdvertisingParams &);
vcoubard 541:884f95bf5351 73 virtual ble_error_t stopAdvertising(void);
vcoubard 581:1dd90ec7527b 74 virtual ble_error_t connect(const Address_t, BLEProtocol::AddressType_t peerAddrType, const ConnectionParams_t *connectionParams, const GapScanningParams *scanParams);
vcoubard 541:884f95bf5351 75 virtual ble_error_t disconnect(Handle_t connectionHandle, DisconnectionReason_t reason);
vcoubard 541:884f95bf5351 76 virtual ble_error_t disconnect(DisconnectionReason_t reason);
vcoubard 541:884f95bf5351 77
vcoubard 541:884f95bf5351 78 virtual ble_error_t setDeviceName(const uint8_t *deviceName);
vcoubard 541:884f95bf5351 79 virtual ble_error_t getDeviceName(uint8_t *deviceName, unsigned *lengthP);
vcoubard 541:884f95bf5351 80 virtual ble_error_t setAppearance(GapAdvertisingData::Appearance appearance);
vcoubard 541:884f95bf5351 81 virtual ble_error_t getAppearance(GapAdvertisingData::Appearance *appearanceP);
vcoubard 541:884f95bf5351 82
vcoubard 541:884f95bf5351 83 virtual ble_error_t setTxPower(int8_t txPower);
vcoubard 541:884f95bf5351 84 virtual void getPermittedTxPowerValues(const int8_t **valueArrayPP, size_t *countP);
vcoubard 541:884f95bf5351 85
vcoubard 541:884f95bf5351 86 void setConnectionHandle(uint16_t con_handle);
vcoubard 541:884f95bf5351 87 uint16_t getConnectionHandle(void);
vcoubard 541:884f95bf5351 88
vcoubard 541:884f95bf5351 89 virtual ble_error_t getPreferredConnectionParams(ConnectionParams_t *params);
vcoubard 541:884f95bf5351 90 virtual ble_error_t setPreferredConnectionParams(const ConnectionParams_t *params);
vcoubard 541:884f95bf5351 91 virtual ble_error_t updateConnectionParams(Handle_t handle, const ConnectionParams_t *params);
vcoubard 541:884f95bf5351 92
vcoubard 575:7023a8204a1b 93 virtual ble_error_t reset(void);
vcoubard 575:7023a8204a1b 94
vcoubard 600:0978b5626451 95 /*
vcoubard 600:0978b5626451 96 * The following functions are part of the whitelisting experimental API.
vcoubard 600:0978b5626451 97 * Therefore, this functionality can change in the near future.
vcoubard 600:0978b5626451 98 */
vcoubard 598:814c1ce92947 99 virtual uint8_t getMaxWhitelistSize(void) const;
vcoubard 598:814c1ce92947 100 virtual ble_error_t getWhitelist(Gap::Whitelist_t &whitelistOut) const;
vcoubard 598:814c1ce92947 101 virtual ble_error_t setWhitelist(const Gap::Whitelist_t &whitelistIn);
vcoubard 596:b66851544182 102
vcoubard 598:814c1ce92947 103 virtual ble_error_t setAdvertisingPolicyMode(AdvertisingPolicyMode_t mode);
vcoubard 598:814c1ce92947 104 virtual ble_error_t setScanningPolicyMode(ScanningPolicyMode_t mode);
vcoubard 598:814c1ce92947 105 virtual ble_error_t setInitiatorPolicyMode(InitiatorPolicyMode_t mode);
vcoubard 596:b66851544182 106 virtual Gap::AdvertisingPolicyMode_t getAdvertisingPolicyMode(void) const;
vcoubard 596:b66851544182 107 virtual Gap::ScanningPolicyMode_t getScanningPolicyMode(void) const;
vcoubard 596:b66851544182 108 virtual Gap::InitiatorPolicyMode_t getInitiatorPolicyMode(void) const;
vcoubard 596:b66851544182 109
vcoubard 541:884f95bf5351 110 virtual ble_error_t initRadioNotification(void) {
vcoubard 541:884f95bf5351 111 if (ble_radio_notification_init(NRF_APP_PRIORITY_HIGH, NRF_RADIO_NOTIFICATION_DISTANCE_800US, radioNotificationStaticCallback) == NRF_SUCCESS) {
vcoubard 541:884f95bf5351 112 return BLE_ERROR_NONE;
vcoubard 541:884f95bf5351 113 }
vcoubard 541:884f95bf5351 114
vcoubard 541:884f95bf5351 115 return BLE_ERROR_UNSPECIFIED;
vcoubard 541:884f95bf5351 116 }
vcoubard 541:884f95bf5351 117
vcoubard 541:884f95bf5351 118 /* Observer role is not supported by S110, return BLE_ERROR_NOT_IMPLEMENTED */
vcoubard 541:884f95bf5351 119 #if !defined(TARGET_MCU_NRF51_16K_S110) && !defined(TARGET_MCU_NRF51_32K_S110)
vcoubard 598:814c1ce92947 120 virtual ble_error_t startRadioScan(const GapScanningParams &scanningParams);
vcoubard 598:814c1ce92947 121 virtual ble_error_t stopScan(void);
vcoubard 541:884f95bf5351 122 #endif
vcoubard 541:884f95bf5351 123
vcoubard 541:884f95bf5351 124 private:
vcoubard 600:0978b5626451 125 /*
vcoubard 600:0978b5626451 126 * Whitelisting API related structures and helper functions.
vcoubard 600:0978b5626451 127 */
vcoubard 600:0978b5626451 128
vcoubard 598:814c1ce92947 129 /* Policy modes set by the user. By default these are set to ignore the whitelist */
vcoubard 596:b66851544182 130 Gap::AdvertisingPolicyMode_t advertisingPolicyMode;
vcoubard 596:b66851544182 131 Gap::ScanningPolicyMode_t scanningPolicyMode;
vcoubard 596:b66851544182 132
vcoubard 598:814c1ce92947 133 /* Internal representation of a whitelist */
vcoubard 598:814c1ce92947 134 uint8_t whitelistAddressesSize;
vcoubard 598:814c1ce92947 135 ble_gap_addr_t whitelistAddresses[YOTTA_CFG_WHITELIST_MAX_SIZE];
vcoubard 598:814c1ce92947 136 ble_gap_addr_t *whitelistAddressPtrs[YOTTA_CFG_WHITELIST_MAX_SIZE];
vcoubard 598:814c1ce92947 137 ble_gap_irk_t *whitelistIrkPtrs[YOTTA_CFG_IRK_TABLE_MAX_SIZE];
vcoubard 596:b66851544182 138
vcoubard 598:814c1ce92947 139 /* Structure used by the SoftDevice to represent a whitelist together with IRK table */
vcoubard 596:b66851544182 140 ble_gap_whitelist_t whitelist;
vcoubard 596:b66851544182 141
vcoubard 598:814c1ce92947 142 /*
vcoubard 598:814c1ce92947 143 * An internal function used to populate the ble_gap_whitelist_t that will be used by
vcoubard 598:814c1ce92947 144 * the SoftDevice for filtering requests. This function is needed because for the BLE
vcoubard 598:814c1ce92947 145 * API the whitelist is just a collection of keys, but for the stack it also includes
vcoubard 598:814c1ce92947 146 * the IRK table.
vcoubard 598:814c1ce92947 147 */
vcoubard 598:814c1ce92947 148 ble_error_t generateStackWhitelist(void);
vcoubard 596:b66851544182 149
vcoubard 600:0978b5626451 150 private:
vcoubard 546:1e147322b2b5 151 bool radioNotificationCallbackParam; /* parameter to be passed into the Timeout-generated radio notification callback. */
vcoubard 546:1e147322b2b5 152 Timeout radioNotificationTimeout;
vcoubard 546:1e147322b2b5 153
vcoubard 546:1e147322b2b5 154 /*
vcoubard 550:bcb632fc92df 155 * A helper function to post radio notification callbacks with low interrupt priority.
vcoubard 546:1e147322b2b5 156 */
vcoubard 546:1e147322b2b5 157 void postRadioNotificationCallback(void) {
vcoubard 550:bcb632fc92df 158 #ifdef YOTTA_CFG_MBED_OS
vcoubard 550:bcb632fc92df 159 /*
vcoubard 550:bcb632fc92df 160 * In mbed OS, all user-facing BLE events (interrupts) are posted to the
vcoubard 550:bcb632fc92df 161 * MINAR scheduler to be executed as callbacks in thread mode. MINAR guards
vcoubard 550:bcb632fc92df 162 * its critical sections from interrupts by acquiring CriticalSectionLock,
vcoubard 550:bcb632fc92df 163 * which results in a call to sd_nvic_critical_region_enter(). Thus, it is
vcoubard 550:bcb632fc92df 164 * safe to invoke MINAR APIs from interrupt context as long as those
vcoubard 550:bcb632fc92df 165 * interrupts are blocked by sd_nvic_critical_region_enter().
vcoubard 550:bcb632fc92df 166 *
vcoubard 550:bcb632fc92df 167 * Radio notifications are a special case for the above. The Radio
vcoubard 550:bcb632fc92df 168 * Notification IRQ is handled at a very high priority--higher than the
vcoubard 550:bcb632fc92df 169 * level blocked by sd_nvic_critical_region_enter(). Thus Radio Notification
vcoubard 550:bcb632fc92df 170 * events can preempt MINAR's critical sections. Using MINAR APIs (such as
vcoubard 550:bcb632fc92df 171 * posting an event) directly in processRadioNotification() may result in a
vcoubard 550:bcb632fc92df 172 * race condition ending in a hard-fault.
vcoubard 550:bcb632fc92df 173 *
vcoubard 550:bcb632fc92df 174 * The solution is to *not* call MINAR APIs directly from the Radio
vcoubard 550:bcb632fc92df 175 * Notification handling; i.e. to do the bulk of RadioNotification
vcoubard 550:bcb632fc92df 176 * processing at a reduced priority which respects MINAR's critical
vcoubard 550:bcb632fc92df 177 * sections. Unfortunately, on a cortex-M0, there is no clean way to demote
vcoubard 550:bcb632fc92df 178 * priority for the currently executing interrupt--we wouldn't want to
vcoubard 550:bcb632fc92df 179 * demote the radio notification handling anyway because it is sensitive to
vcoubard 550:bcb632fc92df 180 * timing, and the system expects to finish this handling very quickly. The
vcoubard 550:bcb632fc92df 181 * workaround is to employ a Timeout to trigger
vcoubard 550:bcb632fc92df 182 * postRadioNotificationCallback() after a very short delay (~0 us) and post
vcoubard 550:bcb632fc92df 183 * the MINAR callback that context.
vcoubard 550:bcb632fc92df 184 *
vcoubard 550:bcb632fc92df 185 * !!!WARNING!!! Radio notifications are very time critical events. The
vcoubard 550:bcb632fc92df 186 * current solution is expected to work under the assumption that
vcoubard 550:bcb632fc92df 187 * postRadioNotificationCalback() will be executed BEFORE the next radio
vcoubard 550:bcb632fc92df 188 * notification event is generated.
vcoubard 550:bcb632fc92df 189 */
vcoubard 546:1e147322b2b5 190 minar::Scheduler::postCallback(
vcoubard 546:1e147322b2b5 191 mbed::util::FunctionPointer1<void, bool>(&radioNotificationCallback, &FunctionPointerWithContext<bool>::call).bind(radioNotificationCallbackParam)
vcoubard 546:1e147322b2b5 192 );
vcoubard 550:bcb632fc92df 193 #else
vcoubard 550:bcb632fc92df 194 /*
vcoubard 550:bcb632fc92df 195 * In mbed classic, all user-facing BLE events execute callbacks in interrupt
vcoubard 550:bcb632fc92df 196 * mode. Radio Notifications are a special case because its IRQ is handled at
vcoubard 550:bcb632fc92df 197 * a very high priority. Thus Radio Notification events can preempt other
vcoubard 550:bcb632fc92df 198 * operations that require interaction with the SoftDevice such as advertising
vcoubard 550:bcb632fc92df 199 * payload updates and changing the Gap state. Therefore, executing a Radio
vcoubard 550:bcb632fc92df 200 * Notification callback directly from processRadioNotification() may result
vcoubard 550:bcb632fc92df 201 * in a race condition ending in a hard-fault.
vcoubard 550:bcb632fc92df 202 *
vcoubard 550:bcb632fc92df 203 * The solution is to *not* execute the Radio Notification callback directly
vcoubard 550:bcb632fc92df 204 * from the Radio Notification handling; i.e. to do the bulk of the
vcoubard 550:bcb632fc92df 205 * Radio Notification processing at a reduced priority. Unfortunately, on a
vcoubard 550:bcb632fc92df 206 * cortex-M0, there is no clean way to demote priority for the currently
vcoubard 550:bcb632fc92df 207 * executing interrupt--we wouldn't want to demote the radio notification
vcoubard 550:bcb632fc92df 208 * handling anyway because it is sensitive to timing, and the system expects
vcoubard 550:bcb632fc92df 209 * to finish this handling very quickly. The workaround is to employ a Timeout
vcoubard 550:bcb632fc92df 210 * to trigger postRadioNotificationCallback() after a very short delay (~0 us)
vcoubard 550:bcb632fc92df 211 * and execute the callback in that context.
vcoubard 550:bcb632fc92df 212 *
vcoubard 550:bcb632fc92df 213 * !!!WARNING!!! Radio notifications are very time critical events. The
vcoubard 550:bcb632fc92df 214 * current solution is expected to work under the assumption that
vcoubard 550:bcb632fc92df 215 * postRadioNotificationCalback() will be executed BEFORE the next radio
vcoubard 550:bcb632fc92df 216 * notification event is generated.
vcoubard 550:bcb632fc92df 217 */
vcoubard 550:bcb632fc92df 218 radioNotificationCallback.call(radioNotificationCallbackParam);
vcoubard 550:bcb632fc92df 219 #endif /* #ifdef YOTTA_CFG_MBED_OS */
vcoubard 546:1e147322b2b5 220 }
vcoubard 546:1e147322b2b5 221
vcoubard 541:884f95bf5351 222 /**
vcoubard 541:884f95bf5351 223 * A helper function to process radio-notification events; to be called internally.
vcoubard 541:884f95bf5351 224 * @param param [description]
vcoubard 541:884f95bf5351 225 */
vcoubard 541:884f95bf5351 226 void processRadioNotificationEvent(bool param) {
vcoubard 546:1e147322b2b5 227 radioNotificationCallbackParam = param;
vcoubard 546:1e147322b2b5 228 radioNotificationTimeout.attach_us(this, &nRF5xGap::postRadioNotificationCallback, 0);
vcoubard 541:884f95bf5351 229 }
vcoubard 541:884f95bf5351 230 friend void radioNotificationStaticCallback(bool param); /* allow invocations of processRadioNotificationEvent() */
vcoubard 541:884f95bf5351 231
vcoubard 541:884f95bf5351 232 private:
vcoubard 541:884f95bf5351 233 uint16_t m_connectionHandle;
vcoubard 575:7023a8204a1b 234
vcoubard 575:7023a8204a1b 235 /*
vcoubard 575:7023a8204a1b 236 * Allow instantiation from nRF5xn when required.
vcoubard 575:7023a8204a1b 237 */
vcoubard 575:7023a8204a1b 238 friend class nRF5xn;
vcoubard 575:7023a8204a1b 239
vcoubard 596:b66851544182 240 nRF5xGap() :
vcoubard 596:b66851544182 241 advertisingPolicyMode(Gap::ADV_POLICY_IGNORE_WHITELIST),
vcoubard 598:814c1ce92947 242 scanningPolicyMode(Gap::SCAN_POLICY_IGNORE_WHITELIST) {
vcoubard 541:884f95bf5351 243 m_connectionHandle = BLE_CONN_HANDLE_INVALID;
vcoubard 596:b66851544182 244
vcoubard 598:814c1ce92947 245 /* Reset the whitelist */
vcoubard 598:814c1ce92947 246 whitelist.addr_count = 0;
vcoubard 598:814c1ce92947 247 whitelist.irk_count = 0;
vcoubard 598:814c1ce92947 248 whitelist.pp_irks = whitelistIrkPtrs;
vcoubard 598:814c1ce92947 249 whitelist.pp_addrs = whitelistAddressPtrs;
vcoubard 598:814c1ce92947 250 whitelistAddressesSize = 0;
vcoubard 541:884f95bf5351 251 }
vcoubard 541:884f95bf5351 252
vcoubard 541:884f95bf5351 253 nRF5xGap(nRF5xGap const &);
vcoubard 541:884f95bf5351 254 void operator=(nRF5xGap const &);
vcoubard 541:884f95bf5351 255 };
vcoubard 541:884f95bf5351 256
rgrover1 388:db85a09c27ef 257 #endif // ifndef __NRF5x_GAP_H__