ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs and synchronise connection result with other events

pull/8738/head
paul-szczepanek-arm 2018-11-13 14:54:40 +00:00 committed by Vincent Coubard
parent 4de9a613c8
commit da22df74bc
2 changed files with 65 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

92
features/FEATURE_BLE/ble/Gap.h
View File

@ -528,6 +528,7 @@ public:
unsigned connected : 1; unsigned connected : 1;
}; };
/* Time units. */
typedef ble::unit_adv_interval_t UnitAdvInterval_t; typedef ble::unit_adv_interval_t UnitAdvInterval_t;
typedef ble::unit_adv_duration_t UnitAdvDuration_t; typedef ble::unit_adv_duration_t UnitAdvDuration_t;
typedef ble::unit_scan_duration_t UnitScanDuration_t; typedef ble::unit_scan_duration_t UnitScanDuration_t;
@ -535,7 +536,6 @@ public:
typedef ble::unit_scan_interval_t UnitScanInterval_t; typedef ble::unit_scan_interval_t UnitScanInterval_t;
typedef ble::unit_scan_window_t UnitScanWindow_t; typedef ble::unit_scan_window_t UnitScanWindow_t;
typedef ble::unit_conn_interval_t UnitConnInterval_t; typedef ble::unit_conn_interval_t UnitConnInterval_t;
typedef ble::unit_slave_latency_t UnitSlaveLatency_t;
typedef ble::unit_supervision_timeout_t UnitSupervisionTimeout_t; typedef ble::unit_supervision_timeout_t UnitSupervisionTimeout_t;
typedef ble::unit_conn_event_length_t UnitConnEventLength_t; typedef ble::unit_conn_event_length_t UnitConnEventLength_t;
typedef ble::unit_sync_timeout_t UnitSyncTimeout_t; typedef ble::unit_sync_timeout_t UnitSyncTimeout_t;
@ -543,6 +543,9 @@ public:
typedef ble::unit_ms_t UnitMs_t; typedef ble::unit_ms_t UnitMs_t;
typedef ble::unit_us_t UnitUs_t; typedef ble::unit_us_t UnitUs_t;
/** Measured in number of events. */
typedef ble::unit_slave_latency_t UnitSlaveLatency_t;
/** /**
* Opaque value type representing a connection handle. * Opaque value type representing a connection handle.
* *
@ -1153,7 +1156,26 @@ public:
* Definition of the general handler of Gap related events. * Definition of the general handler of Gap related events.
*/ */
struct EventHandler { struct EventHandler {
/** Event generated when when an advertising packet is seen during passive scanning
* or a scan response is received during active scanning.
*/
struct AdvertisingReportEvent { struct AdvertisingReportEvent {
/** Create a advertising report event.
*
* @param type Type of advertising used.
* @param peerAddressType Peer address type of advertiser.
* @param peerAddress Peer address of advertiser.
* @param primaryPhy PHY used on the primary channels.
* @param secondaryPhy PHY used on secondary channels.
* @param SID Set identification number.
* @param txPower Transmission power reported by the packet.
* @param rssi Measured signal strength.
* @param periodicInterval Interval of periodic advertising.
* @param directAddressType Directed advertising target address type.
* @param directAddress Directed advertising target address.
* @param advertisingData Advertising payload.
*/
AdvertisingReportEvent( AdvertisingReportEvent(
const AdvertisingEventType_t &type, const AdvertisingEventType_t &type,
const PeerAddressType_t &peerAddressType, const PeerAddressType_t &peerAddressType,
@ -1242,18 +1264,18 @@ public:
} }
private: private:
AdvertisingEventType_t type; /**< Type of advertising used. */ AdvertisingEventType_t type;
PeerAddressType_t peerAddressType; /**< Peer address type of advertiser. */ PeerAddressType_t peerAddressType;
ble::address_t const &peerAddress; /**< Peer address of advertiser. */ ble::address_t const &peerAddress;
Phy_t primaryPhy; /**< PHY used on the primary channels. */ Phy_t primaryPhy;
Phy_t secondaryPhy; /**< PHY used on secondary channels. */ Phy_t secondaryPhy;
ble::advertising_sid_t SID; /**< Set identification number. */ ble::advertising_sid_t SID;
ble::advertising_power_t txPower; /**< Transmission power reported by the packet. */ ble::advertising_power_t txPower;
ble::rssi_t rssi; /**< Measured signal strength. */ ble::rssi_t rssi;
UnitPeriodicInterval_t periodicInterval; /**< Interval of periodic advertising. */ UnitPeriodicInterval_t periodicInterval;
PeerAddressType_t directAddressType;/**< Directed advertising target address type. */ PeerAddressType_t directAddressType;
const ble::address_t &directAddress; /**< Directed advertising target address. */ const ble::address_t &directAddress;
mbed::Span<const uint8_t> advertisingData; /**< Advertising payload. */ mbed::Span<const uint8_t> advertisingData;
}; };
/** Called when scanning reads an advertising packet during passive scan or receives /** Called when scanning reads an advertising packet during passive scan or receives
@ -1268,8 +1290,22 @@ public:
} }
struct ConnectionCompleteEvent { struct ConnectionCompleteEvent {
/** Create a connection complete event.
*
* @param success BLE_ERROR_NONE if connection succeeded.
* @param connectionHandle Connection handle if successful.
* @param ownRole Role of the local device.
* @param peerAddressType Peer address type.
* @param peerAddress Peer address.
* @param localResolvablePrivateAddress Local address type if privacy enabled.
* @param peerResolvablePrivateAddress Peer address type if privacy enabled.
* @param connectionInterval Connection interval.
* @param connectionLatency Connection latency in events.
* @param supervisionTimeout Supervision timeout.
* @param masterClockAccuracy Peer clock accuracy in parts per million.
*/
ConnectionCompleteEvent( ConnectionCompleteEvent(
bool success, ble_error_t status,
Handle_t connectionHandle, Handle_t connectionHandle,
Role_t ownRole, Role_t ownRole,
const PeerAddressType_t &peerAddressType, const PeerAddressType_t &peerAddressType,
@ -1281,7 +1317,7 @@ public:
UnitSupervisionTimeout_t supervisionTimeout, UnitSupervisionTimeout_t supervisionTimeout,
uint16_t masterClockAccuracy uint16_t masterClockAccuracy
) : ) :
success(success), status(status),
connectionHandle(connectionHandle), connectionHandle(connectionHandle),
ownRole(ownRole), ownRole(ownRole),
peerAddressType(peerAddressType), peerAddressType(peerAddressType),
@ -1293,9 +1329,9 @@ public:
supervisionTimeout(supervisionTimeout), supervisionTimeout(supervisionTimeout),
masterClockAccuracy(masterClockAccuracy) { } masterClockAccuracy(masterClockAccuracy) { }
bool isSuccess() const ble_error_t getStatus() const
{ {
return success; return status;
} }
Handle_t getConnectionHandle() const Handle_t getConnectionHandle() const
@ -1349,17 +1385,17 @@ public:
} }
private: private:
bool success; /**< True if connection succeeded. */ ble_error_t status;
Handle_t connectionHandle; /**< Connection handle if successful. */ Handle_t connectionHandle;
Role_t ownRole; /**< Role of the local device. */ Role_t ownRole;
PeerAddressType_t peerAddressType; /**< Peer address type. */ PeerAddressType_t peerAddressType;
const ble::address_t &peerAddress; /**< Peer address. */ const ble::address_t &peerAddress;
const ble::address_t &localResolvablePrivateAddress; /**< Local address type if privacy enabled. */ const ble::address_t &localResolvablePrivateAddress;
const ble::address_t &peerResolvablePrivateAddress; /**< Peer address type if privacy enabled. */ const ble::address_t &peerResolvablePrivateAddress;
UnitConnInterval_t connectionInterval; /**< Connection interval. */ UnitConnInterval_t connectionInterval;
UnitSlaveLatency_t connectionLatency; /**< Connection latency in events. */ UnitSlaveLatency_t connectionLatency;
UnitSupervisionTimeout_t supervisionTimeout; /**< Supervision timeout. */ UnitSupervisionTimeout_t supervisionTimeout;
uint16_t masterClockAccuracy; /**< Peer clock accuracy in parts per million. */ uint16_t masterClockAccuracy;
}; };
/** Called when connection attempt ends. /** Called when connection attempt ends.

2
features/FEATURE_BLE/source/generic/GenericGap.cpp
View File

@ -2191,7 +2191,7 @@ void GenericGap::on_enhanced_connection_complete(
_eventHandler->onConnectionComplete( _eventHandler->onConnectionComplete(
Gap::EventHandler::ConnectionCompleteEvent( Gap::EventHandler::ConnectionCompleteEvent(
(status==pal::hci_error_code_t::SUCCESS), (status == pal::hci_error_code_t::SUCCESS) ? BLE_ERROR_NONE : BLE_ERROR_INTERNAL_STACK_FAILURE,
(ble::connection_handle_t)connection_handle, (ble::connection_handle_t)connection_handle,
(Gap::Role_t)own_role.value(), (Gap::Role_t)own_role.value(),
(ble::peer_address_type_t::type)peer_address_type.value(), (ble::peer_address_type_t::type)peer_address_type.value(),