2014-07-30 10:36:32 +00:00
|
|
|
/* mbed Microcontroller Library
|
|
|
|
* Copyright (c) 2006-2013 ARM Limited
|
|
|
|
*
|
|
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
* you may not use this file except in compliance with the License.
|
|
|
|
* You may obtain a copy of the License at
|
|
|
|
*
|
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
*
|
|
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
* See the License for the specific language governing permissions and
|
|
|
|
* limitations under the License.
|
|
|
|
*/
|
|
|
|
|
2015-07-06 13:17:22 +00:00
|
|
|
#ifndef __NRF5x_GAP_H__
|
|
|
|
#define __NRF5x_GAP_H__
|
2014-07-30 10:36:32 +00:00
|
|
|
|
2015-12-15 13:56:47 +00:00
|
|
|
#ifdef YOTTA_CFG_MBED_OS
|
|
|
|
#include "mbed-drivers/mbed.h"
|
|
|
|
#else
|
|
|
|
#include "mbed.h"
|
|
|
|
#endif
|
2015-12-31 13:51:52 +00:00
|
|
|
#ifndef YOTTA_CFG_WHITELIST_MAX_SIZE
|
|
|
|
#define YOTTA_CFG_WHITELIST_MAX_SIZE BLE_GAP_WHITELIST_ADDR_MAX_COUNT
|
|
|
|
#elif YOTTA_CFG_WHITELIST_MAX_SIZE > BLE_GAP_WHITELIST_ADDR_MAX_COUNT
|
|
|
|
#undef YOTTA_CFG_WHITELIST_MAX_SIZE
|
|
|
|
#define YOTTA_CFG_WHITELIST_MAX_SIZE BLE_GAP_WHITELIST_ADDR_MAX_COUNT
|
|
|
|
#endif
|
2016-01-08 10:46:11 +00:00
|
|
|
#ifndef YOTTA_CFG_IRK_TABLE_MAX_SIZE
|
|
|
|
#define YOTTA_CFG_IRK_TABLE_MAX_SIZE BLE_GAP_WHITELIST_IRK_MAX_COUNT
|
|
|
|
#elif YOTTA_CFG_IRK_TABLE_MAX_SIZE > BLE_GAP_WHITELIST_IRK_MAX_COUNT
|
|
|
|
#undef YOTTA_CFG_IRK_TABLE_MAX_SIZE
|
|
|
|
#define YOTTA_CFG_IRK_TABLE_MAX_SIZE BLE_GAP_WHITELIST_IRK_MAX_COUNT
|
|
|
|
#endif
|
2015-06-19 12:39:08 +00:00
|
|
|
#include "ble/blecommon.h"
|
2014-07-30 10:36:32 +00:00
|
|
|
#include "ble.h"
|
2015-06-19 12:39:08 +00:00
|
|
|
#include "ble/GapAdvertisingParams.h"
|
|
|
|
#include "ble/GapAdvertisingData.h"
|
|
|
|
#include "ble/Gap.h"
|
|
|
|
#include "ble/GapScanningParams.h"
|
2014-07-30 10:36:32 +00:00
|
|
|
|
2015-04-09 13:59:16 +00:00
|
|
|
#include "nrf_soc.h"
|
2015-11-16 15:08:31 +00:00
|
|
|
|
|
|
|
extern "C" {
|
2015-04-09 13:59:16 +00:00
|
|
|
#include "ble_radio_notification.h"
|
2015-11-16 15:08:31 +00:00
|
|
|
}
|
|
|
|
|
2015-04-22 12:19:00 +00:00
|
|
|
#include "btle_security.h"
|
2015-04-09 13:59:16 +00:00
|
|
|
|
2015-07-21 10:34:36 +00:00
|
|
|
void radioNotificationStaticCallback(bool param);
|
|
|
|
|
2014-07-30 10:36:32 +00:00
|
|
|
/**************************************************************************/
|
|
|
|
/*!
|
|
|
|
\brief
|
|
|
|
|
|
|
|
*/
|
|
|
|
/**************************************************************************/
|
2015-07-06 13:17:22 +00:00
|
|
|
class nRF5xGap : public Gap
|
2014-07-30 10:36:32 +00:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
/* Functions that must be implemented from Gap */
|
2015-05-21 13:41:48 +00:00
|
|
|
virtual ble_error_t setAddress(AddressType_t type, const Address_t address);
|
|
|
|
virtual ble_error_t getAddress(AddressType_t *typeP, Address_t address);
|
2014-10-06 09:41:23 +00:00
|
|
|
virtual ble_error_t setAdvertisingData(const GapAdvertisingData &, const GapAdvertisingData &);
|
2015-03-23 16:11:30 +00:00
|
|
|
|
2015-08-06 09:50:53 +00:00
|
|
|
virtual uint16_t getMinAdvertisingInterval(void) const {return GapAdvertisingParams::ADVERTISEMENT_DURATION_UNITS_TO_MS(BLE_GAP_ADV_INTERVAL_MIN);}
|
|
|
|
virtual uint16_t getMinNonConnectableAdvertisingInterval(void) const {return GapAdvertisingParams::ADVERTISEMENT_DURATION_UNITS_TO_MS(BLE_GAP_ADV_NONCON_INTERVAL_MIN);}
|
|
|
|
virtual uint16_t getMaxAdvertisingInterval(void) const {return GapAdvertisingParams::ADVERTISEMENT_DURATION_UNITS_TO_MS(BLE_GAP_ADV_INTERVAL_MAX);}
|
2015-03-23 16:11:30 +00:00
|
|
|
|
2014-07-30 10:36:32 +00:00
|
|
|
virtual ble_error_t startAdvertising(const GapAdvertisingParams &);
|
|
|
|
virtual ble_error_t stopAdvertising(void);
|
2015-12-16 08:57:20 +00:00
|
|
|
virtual ble_error_t connect(const Address_t, BLEProtocol::AddressType_t peerAddrType, const ConnectionParams_t *connectionParams, const GapScanningParams *scanParams);
|
2015-06-19 09:23:57 +00:00
|
|
|
virtual ble_error_t disconnect(Handle_t connectionHandle, DisconnectionReason_t reason);
|
2014-08-29 14:03:40 +00:00
|
|
|
virtual ble_error_t disconnect(DisconnectionReason_t reason);
|
2014-07-30 10:36:32 +00:00
|
|
|
|
2014-08-29 10:06:07 +00:00
|
|
|
virtual ble_error_t setDeviceName(const uint8_t *deviceName);
|
|
|
|
virtual ble_error_t getDeviceName(uint8_t *deviceName, unsigned *lengthP);
|
2015-06-18 13:10:19 +00:00
|
|
|
virtual ble_error_t setAppearance(GapAdvertisingData::Appearance appearance);
|
|
|
|
virtual ble_error_t getAppearance(GapAdvertisingData::Appearance *appearanceP);
|
2014-08-29 10:06:07 +00:00
|
|
|
|
2015-06-12 16:50:05 +00:00
|
|
|
virtual ble_error_t setTxPower(int8_t txPower);
|
|
|
|
virtual void getPermittedTxPowerValues(const int8_t **valueArrayPP, size_t *countP);
|
|
|
|
|
2014-07-30 10:36:32 +00:00
|
|
|
void setConnectionHandle(uint16_t con_handle);
|
|
|
|
uint16_t getConnectionHandle(void);
|
|
|
|
|
|
|
|
virtual ble_error_t getPreferredConnectionParams(ConnectionParams_t *params);
|
|
|
|
virtual ble_error_t setPreferredConnectionParams(const ConnectionParams_t *params);
|
|
|
|
virtual ble_error_t updateConnectionParams(Handle_t handle, const ConnectionParams_t *params);
|
|
|
|
|
Modify shutdown due to BLE API change
The module is updated to comply with the changes to BLE API regarding correct
shutdown functionality. The following changes are introduced to ble-nrf51822:
* Calls to the old static function shutdown in Gap, GattClient, GattServer and
SecurityManager are removed.
* The cleanup function in Gap, GattClient, GattServer and SecurityManager is
renamed to `reset()` and made public.
* The static references inside nRF5xGap, nRF5xGattClient, nRF5xGattServer and
nRF5xSecurityManager to objects of their own class are moved to nRF5xn.
* The static getInstance accessors in nRF5xGap, nRF5xGattClient,
nRF5xGattServer and nRF5xSecurityManager are removed and their functionality is
moved to the implemented virtual accessors in nRF5xn i.e. getGap(),
getGattClient, etc.
* A static function Instance is added to nRF5xn class to make the transport
object accessible across the module.
2015-12-14 15:15:35 +00:00
|
|
|
virtual ble_error_t reset(void);
|
|
|
|
|
2016-01-08 11:15:35 +00:00
|
|
|
/*
|
|
|
|
* The following functions are part of the whitelisting experimental API.
|
|
|
|
* Therefore, this functionality can change in the near future.
|
|
|
|
*/
|
2016-01-08 10:46:11 +00:00
|
|
|
virtual uint8_t getMaxWhitelistSize(void) const;
|
|
|
|
virtual ble_error_t getWhitelist(Gap::Whitelist_t &whitelistOut) const;
|
|
|
|
virtual ble_error_t setWhitelist(const Gap::Whitelist_t &whitelistIn);
|
2015-12-31 13:51:52 +00:00
|
|
|
|
2016-01-08 10:46:11 +00:00
|
|
|
virtual ble_error_t setAdvertisingPolicyMode(AdvertisingPolicyMode_t mode);
|
|
|
|
virtual ble_error_t setScanningPolicyMode(ScanningPolicyMode_t mode);
|
|
|
|
virtual ble_error_t setInitiatorPolicyMode(InitiatorPolicyMode_t mode);
|
2015-12-31 13:51:52 +00:00
|
|
|
virtual Gap::AdvertisingPolicyMode_t getAdvertisingPolicyMode(void) const;
|
|
|
|
virtual Gap::ScanningPolicyMode_t getScanningPolicyMode(void) const;
|
|
|
|
virtual Gap::InitiatorPolicyMode_t getInitiatorPolicyMode(void) const;
|
|
|
|
|
2015-07-21 10:34:36 +00:00
|
|
|
virtual ble_error_t initRadioNotification(void) {
|
|
|
|
if (ble_radio_notification_init(NRF_APP_PRIORITY_HIGH, NRF_RADIO_NOTIFICATION_DISTANCE_800US, radioNotificationStaticCallback) == NRF_SUCCESS) {
|
|
|
|
return BLE_ERROR_NONE;
|
|
|
|
}
|
|
|
|
|
|
|
|
return BLE_ERROR_UNSPECIFIED;
|
2015-04-09 13:59:16 +00:00
|
|
|
}
|
|
|
|
|
2015-08-11 11:55:15 +00:00
|
|
|
/* Observer role is not supported by S110, return BLE_ERROR_NOT_IMPLEMENTED */
|
2015-10-05 12:15:35 +00:00
|
|
|
#if !defined(TARGET_MCU_NRF51_16K_S110) && !defined(TARGET_MCU_NRF51_32K_S110)
|
2016-01-08 10:46:11 +00:00
|
|
|
virtual ble_error_t startRadioScan(const GapScanningParams &scanningParams);
|
|
|
|
virtual ble_error_t stopScan(void);
|
2015-08-11 11:55:15 +00:00
|
|
|
#endif
|
2015-04-27 07:05:24 +00:00
|
|
|
|
2015-07-21 10:34:36 +00:00
|
|
|
private:
|
2016-01-08 11:15:35 +00:00
|
|
|
/*
|
|
|
|
* Whitelisting API related structures and helper functions.
|
|
|
|
*/
|
|
|
|
|
2016-01-08 10:46:11 +00:00
|
|
|
/* Policy modes set by the user. By default these are set to ignore the whitelist */
|
2015-12-31 13:51:52 +00:00
|
|
|
Gap::AdvertisingPolicyMode_t advertisingPolicyMode;
|
|
|
|
Gap::ScanningPolicyMode_t scanningPolicyMode;
|
|
|
|
|
2016-01-08 10:46:11 +00:00
|
|
|
/* Internal representation of a whitelist */
|
|
|
|
uint8_t whitelistAddressesSize;
|
|
|
|
ble_gap_addr_t whitelistAddresses[YOTTA_CFG_WHITELIST_MAX_SIZE];
|
|
|
|
ble_gap_addr_t *whitelistAddressPtrs[YOTTA_CFG_WHITELIST_MAX_SIZE];
|
|
|
|
ble_gap_irk_t *whitelistIrkPtrs[YOTTA_CFG_IRK_TABLE_MAX_SIZE];
|
2015-12-31 13:51:52 +00:00
|
|
|
|
2016-01-08 10:46:11 +00:00
|
|
|
/* Structure used by the SoftDevice to represent a whitelist together with IRK table */
|
2015-12-31 13:51:52 +00:00
|
|
|
ble_gap_whitelist_t whitelist;
|
|
|
|
|
2016-01-08 10:46:11 +00:00
|
|
|
/*
|
|
|
|
* An internal function used to populate the ble_gap_whitelist_t that will be used by
|
|
|
|
* the SoftDevice for filtering requests. This function is needed because for the BLE
|
|
|
|
* API the whitelist is just a collection of keys, but for the stack it also includes
|
|
|
|
* the IRK table.
|
|
|
|
*/
|
|
|
|
ble_error_t generateStackWhitelist(void);
|
2015-12-31 13:51:52 +00:00
|
|
|
|
2016-01-08 11:15:35 +00:00
|
|
|
private:
|
2015-11-16 09:41:27 +00:00
|
|
|
bool radioNotificationCallbackParam; /* parameter to be passed into the Timeout-generated radio notification callback. */
|
2015-11-13 14:42:58 +00:00
|
|
|
Timeout radioNotificationTimeout;
|
|
|
|
|
|
|
|
/*
|
2015-11-26 10:56:17 +00:00
|
|
|
* A helper function to post radio notification callbacks with low interrupt priority.
|
2015-11-13 14:42:58 +00:00
|
|
|
*/
|
|
|
|
void postRadioNotificationCallback(void) {
|
2015-11-26 10:56:17 +00:00
|
|
|
#ifdef YOTTA_CFG_MBED_OS
|
|
|
|
/*
|
|
|
|
* In mbed OS, all user-facing BLE events (interrupts) are posted to the
|
|
|
|
* MINAR scheduler to be executed as callbacks in thread mode. MINAR guards
|
|
|
|
* its critical sections from interrupts by acquiring CriticalSectionLock,
|
|
|
|
* which results in a call to sd_nvic_critical_region_enter(). Thus, it is
|
|
|
|
* safe to invoke MINAR APIs from interrupt context as long as those
|
|
|
|
* interrupts are blocked by sd_nvic_critical_region_enter().
|
|
|
|
*
|
|
|
|
* Radio notifications are a special case for the above. The Radio
|
|
|
|
* Notification IRQ is handled at a very high priority--higher than the
|
|
|
|
* level blocked by sd_nvic_critical_region_enter(). Thus Radio Notification
|
|
|
|
* events can preempt MINAR's critical sections. Using MINAR APIs (such as
|
|
|
|
* posting an event) directly in processRadioNotification() may result in a
|
|
|
|
* race condition ending in a hard-fault.
|
|
|
|
*
|
|
|
|
* The solution is to *not* call MINAR APIs directly from the Radio
|
|
|
|
* Notification handling; i.e. to do the bulk of RadioNotification
|
|
|
|
* processing at a reduced priority which respects MINAR's critical
|
|
|
|
* sections. Unfortunately, on a cortex-M0, there is no clean way to demote
|
|
|
|
* priority for the currently executing interrupt--we wouldn't want to
|
|
|
|
* demote the radio notification handling anyway because it is sensitive to
|
|
|
|
* timing, and the system expects to finish this handling very quickly. The
|
|
|
|
* workaround is to employ a Timeout to trigger
|
|
|
|
* postRadioNotificationCallback() after a very short delay (~0 us) and post
|
|
|
|
* the MINAR callback that context.
|
|
|
|
*
|
|
|
|
* !!!WARNING!!! Radio notifications are very time critical events. The
|
|
|
|
* current solution is expected to work under the assumption that
|
|
|
|
* postRadioNotificationCalback() will be executed BEFORE the next radio
|
|
|
|
* notification event is generated.
|
|
|
|
*/
|
2015-11-13 14:42:58 +00:00
|
|
|
minar::Scheduler::postCallback(
|
|
|
|
mbed::util::FunctionPointer1<void, bool>(&radioNotificationCallback, &FunctionPointerWithContext<bool>::call).bind(radioNotificationCallbackParam)
|
|
|
|
);
|
2015-11-26 10:56:17 +00:00
|
|
|
#else
|
|
|
|
/*
|
|
|
|
* In mbed classic, all user-facing BLE events execute callbacks in interrupt
|
|
|
|
* mode. Radio Notifications are a special case because its IRQ is handled at
|
|
|
|
* a very high priority. Thus Radio Notification events can preempt other
|
|
|
|
* operations that require interaction with the SoftDevice such as advertising
|
|
|
|
* payload updates and changing the Gap state. Therefore, executing a Radio
|
|
|
|
* Notification callback directly from processRadioNotification() may result
|
|
|
|
* in a race condition ending in a hard-fault.
|
|
|
|
*
|
|
|
|
* The solution is to *not* execute the Radio Notification callback directly
|
|
|
|
* from the Radio Notification handling; i.e. to do the bulk of the
|
|
|
|
* Radio Notification processing at a reduced priority. Unfortunately, on a
|
|
|
|
* cortex-M0, there is no clean way to demote priority for the currently
|
|
|
|
* executing interrupt--we wouldn't want to demote the radio notification
|
|
|
|
* handling anyway because it is sensitive to timing, and the system expects
|
|
|
|
* to finish this handling very quickly. The workaround is to employ a Timeout
|
|
|
|
* to trigger postRadioNotificationCallback() after a very short delay (~0 us)
|
|
|
|
* and execute the callback in that context.
|
|
|
|
*
|
|
|
|
* !!!WARNING!!! Radio notifications are very time critical events. The
|
|
|
|
* current solution is expected to work under the assumption that
|
|
|
|
* postRadioNotificationCalback() will be executed BEFORE the next radio
|
|
|
|
* notification event is generated.
|
|
|
|
*/
|
|
|
|
radioNotificationCallback.call(radioNotificationCallbackParam);
|
2015-11-16 09:41:27 +00:00
|
|
|
#endif /* #ifdef YOTTA_CFG_MBED_OS */
|
2015-11-26 10:56:17 +00:00
|
|
|
}
|
2015-11-13 14:42:58 +00:00
|
|
|
|
2015-07-21 10:34:36 +00:00
|
|
|
/**
|
|
|
|
* A helper function to process radio-notification events; to be called internally.
|
|
|
|
* @param param [description]
|
|
|
|
*/
|
|
|
|
void processRadioNotificationEvent(bool param) {
|
2015-11-13 14:42:58 +00:00
|
|
|
radioNotificationCallbackParam = param;
|
|
|
|
radioNotificationTimeout.attach_us(this, &nRF5xGap::postRadioNotificationCallback, 0);
|
2015-07-21 10:34:36 +00:00
|
|
|
}
|
|
|
|
friend void radioNotificationStaticCallback(bool param); /* allow invocations of processRadioNotificationEvent() */
|
|
|
|
|
2014-07-30 10:36:32 +00:00
|
|
|
private:
|
|
|
|
uint16_t m_connectionHandle;
|
Modify shutdown due to BLE API change
The module is updated to comply with the changes to BLE API regarding correct
shutdown functionality. The following changes are introduced to ble-nrf51822:
* Calls to the old static function shutdown in Gap, GattClient, GattServer and
SecurityManager are removed.
* The cleanup function in Gap, GattClient, GattServer and SecurityManager is
renamed to `reset()` and made public.
* The static references inside nRF5xGap, nRF5xGattClient, nRF5xGattServer and
nRF5xSecurityManager to objects of their own class are moved to nRF5xn.
* The static getInstance accessors in nRF5xGap, nRF5xGattClient,
nRF5xGattServer and nRF5xSecurityManager are removed and their functionality is
moved to the implemented virtual accessors in nRF5xn i.e. getGap(),
getGattClient, etc.
* A static function Instance is added to nRF5xn class to make the transport
object accessible across the module.
2015-12-14 15:15:35 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Allow instantiation from nRF5xn when required.
|
|
|
|
*/
|
|
|
|
friend class nRF5xn;
|
|
|
|
|
2015-12-31 13:51:52 +00:00
|
|
|
nRF5xGap() :
|
|
|
|
advertisingPolicyMode(Gap::ADV_POLICY_IGNORE_WHITELIST),
|
2016-01-08 10:46:11 +00:00
|
|
|
scanningPolicyMode(Gap::SCAN_POLICY_IGNORE_WHITELIST) {
|
2014-07-30 10:36:32 +00:00
|
|
|
m_connectionHandle = BLE_CONN_HANDLE_INVALID;
|
2015-12-31 13:51:52 +00:00
|
|
|
|
2016-01-08 10:46:11 +00:00
|
|
|
/* Reset the whitelist */
|
|
|
|
whitelist.addr_count = 0;
|
|
|
|
whitelist.irk_count = 0;
|
|
|
|
whitelist.pp_irks = whitelistIrkPtrs;
|
|
|
|
whitelist.pp_addrs = whitelistAddressPtrs;
|
|
|
|
whitelistAddressesSize = 0;
|
2014-07-30 10:36:32 +00:00
|
|
|
}
|
|
|
|
|
2015-07-06 13:17:22 +00:00
|
|
|
nRF5xGap(nRF5xGap const &);
|
|
|
|
void operator=(nRF5xGap const &);
|
2014-07-30 10:36:32 +00:00
|
|
|
};
|
|
|
|
|
2015-07-06 13:17:22 +00:00
|
|
|
#endif // ifndef __NRF5x_GAP_H__
|