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

BLE: tag missing documentation block.

pull/8738/head
Vincent Coubard 2018-11-12 11:56:08 +00:00
parent 651bf321db
commit 2f8e336635
2 changed files with 298 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

102
features/FEATURE_BLE/ble/BLETypes.h
View File

@ -175,7 +175,13 @@ enum advertising_type_t {
ADV_CONNECTABLE_DIRECTED_LOW_DUTY
};
/**
* FIXME
*/
struct advertising_data_status_t : SafeEnum<advertising_data_status_t, uint8_t >{
/**
* FIXME
*/
enum type {
COMPLETE = 0x00,
INCOMPLETE_MORE_DATA = 0x01,
@ -198,9 +204,20 @@ struct advertising_data_status_t : SafeEnum<advertising_data_status_t, uint8_t
{ }
};
/**
* FIXME
*/
struct advertising_event_t {
/**
* FIXME
* @param value
*/
explicit advertising_event_t(uint8_t value) : value(value) { }
/**
* FIXME
* @param legacy_type
*/
advertising_event_t(advertising_type_t legacy_type)
{
switch (legacy_type) {
@ -222,13 +239,25 @@ struct advertising_event_t {
}
}
/**
* FIXME
*/
advertising_event_t() : value(0) { }
/**
* FIXME
* @return
*/
bool connectable() const
{
return static_cast<bool>(value & (1 << 0));
}
/**
* FIXME
* @param v
* @return
*/
advertising_event_t& connectable(bool v)
{
if (v) {
@ -239,11 +268,20 @@ struct advertising_event_t {
return *this;
}
/**
* FIXME
* @return
*/
bool scannable_advertising() const
{
return static_cast<bool>(value & (1 << 1));
}
/**
* FIXME
* @param v
* @return
*/
advertising_event_t& scannable_advertising(bool v)
{
if (v) {
@ -254,11 +292,20 @@ struct advertising_event_t {
return *this;
}
/**
* FIXME
* @return
*/
bool directed_advertising() const
{
return static_cast<bool>(value & (1 << 2));
}
/**
* FIXME
* @param v
* @return
*/
advertising_event_t& directed_advertising(bool v)
{
if (v) {
@ -269,11 +316,20 @@ struct advertising_event_t {
return *this;
}
/**
* FIXME
* @return
*/
bool scan_response() const
{
return static_cast<bool>(value & (1 << 3));
}
/**
* FIXME
* @param v
* @return
*/
advertising_event_t& scan_response(bool v)
{
if (v) {
@ -284,11 +340,20 @@ struct advertising_event_t {
return *this;
}
/**
* FIXME
* @return
*/
bool legacy_advertising() const
{
return static_cast<bool>(value & (1 << 4));
}
/**
* FIXME
* @param v
* @return
*/
advertising_event_t& legacy_advertising(bool v)
{
if (v) {
@ -299,26 +364,48 @@ struct advertising_event_t {
return *this;
}
/**
* FIXME
* @return
*/
advertising_data_status_t data_status() const
{
return static_cast<advertising_data_status_t::type>((value >> 5) & 0x03);
}
/**
* FIXME
* @return
*/
bool complete() const
{
return data_status() == advertising_data_status_t::COMPLETE;
}
/**
* FIXME
* @return
*/
bool more_data_to_come() const
{
return data_status() == advertising_data_status_t::INCOMPLETE_MORE_DATA;
}
/**
* FIXME
* @return
*/
bool truncated() const
{
return data_status() == advertising_data_status_t::INCOMPLETE_DATA_TRUNCATED;
}
/**
* FIXME
* @param lhs
* @param rhs
* @return
*/
friend bool operator==(
const advertising_event_t &lhs,
const advertising_event_t &rhs
@ -327,6 +414,12 @@ struct advertising_event_t {
return lhs.value == rhs.value;
}
/**
* FIXME
* @param lhs
* @param rhs
* @return
*/
friend bool operator!=(
const advertising_event_t &lhs,
const advertising_event_t &rhs
@ -391,8 +484,17 @@ enum scanning_policy_mode_t {
* @see Bluetooth Core Specification 4.2 (Vol. 6), Part B, Section 4.3.3.
*/
enum scanning_filter_duplicates_t {
/**
* FIXME
*/
SCAN_FILTER_DUPLICATES_DISABLED = 0,
/**
* FIXME
*/
SCAN_FILTER_DUPLICATES_ENABLED = 1,
/**
* FIXME
*/
SCAN_FILTER_DUPLICATES_ENABLED_PER_PERIOD = 2
};

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

@ -1117,18 +1117,41 @@ public:
typedef CallChainOfFunctionPointersWithContext<const Gap *>
GapShutdownCallbackChain_t;
/**
* FIXME
*/
typedef ble::advertising_handle_t AdvHandle_t;
/**
* FIXME
*/
typedef ble::periodic_sync_handle_t PeriodicSyncHandle_t;
/**
* FIXME
*/
typedef ble::advertising_event_t AdvertisingEventType_t;
/**
* FIXME
*/
static const AdvHandle_t LEGACY_ADVERTISING_HANDLE = 0x00;
/**
* FIXME
*/
static const AdvHandle_t INVALID_ADVERTISING_HANDLE = 0xFF;
/**
* Definition of the general handler of Gap related events.
*/
struct EventHandler {
/**
* FIXME
* @param advHandle
* @param peerAddressType
* @param peerAddress
*/
virtual void onScanRequest(
AdvHandle_t advHandle,
PeerAddressType_t peerAddressType,
@ -1139,6 +1162,13 @@ public:
(void) peerAddress;
}
/**
* FIXME
* @param advHandle
* @param connection
* @param completed_events
* @param connected
*/
virtual void onAdvertisingEnd(
AdvHandle_t advHandle,
Handle_t connection,
@ -1151,6 +1181,21 @@ public:
(void) connected;
}
/**
* FIXME
* @param type
* @param peerAddressType
* @param peerAddress
* @param primaryPhy
* @param secondaryPhy
* @param SID
* @param txPower
* @param rssi
* @param periodicInterval
* @param directAddressType
* @param directAddress
* @param advertisingData
*/
void onAdvertisingReport(
AdvertisingEventType_t type,
PeerAddressType_t peerAddressType,
@ -1668,16 +1713,30 @@ public:
/* advertising */
/**
* FIXME
* @return
*/
virtual uint8_t getMaxAdvertisingSetNumber() {
/* Requesting action from porter(s): override this API if this capability is supported. */
return 1;
}
/**
* FIXME
* @return
*/
virtual uint8_t getMaxAdvertisingDataLength() {
/* Requesting action from porter(s): override this API if this capability is supported. */
return 0x1F;
}
/**
* FIXME
* @param handle
* @param parameters
* @return
*/
virtual ble_error_t createAdvertisingSet(
AdvHandle_t *handle,
const GapAdvertisingParameters &parameters
@ -1688,12 +1747,23 @@ public:
return BLE_ERROR_NOT_IMPLEMENTED;
}
/**
* FIXME
* @param handle
* @return
*/
virtual ble_error_t destroyAdvertisingSet(AdvHandle_t handle) {
(void) handle;
/* Requesting action from porter(s): override this API if this capability is supported. */
return BLE_ERROR_NOT_IMPLEMENTED;
}
/**
* FIXME
* @param handle
* @param params
* @return
*/
virtual ble_error_t setAdvertisingParams(
AdvHandle_t handle,
const GapAdvertisingParameters &params
@ -1704,6 +1774,13 @@ public:
return BLE_ERROR_NOT_IMPLEMENTED;
}
/**
* FIXME
* @param handle
* @param payload
* @param minimiseFragmentation
* @return
*/
virtual ble_error_t setAdvertisingPayload(
AdvHandle_t handle,
mbed::Span<uint8_t> payload,
@ -1716,6 +1793,13 @@ public:
return BLE_ERROR_NOT_IMPLEMENTED;
}
/**
* FIXME
* @param handle
* @param response
* @param minimiseFragmentation
* @return
*/
virtual ble_error_t setAdvertisingScanResponse(
AdvHandle_t handle,
mbed::Span<uint8_t> response,
@ -1729,6 +1813,13 @@ public:
return BLE_ERROR_NOT_IMPLEMENTED;
}
/**
* FIXME
* @param handle
* @param maxDuration
* @param maxEvents
* @return
*/
virtual ble_error_t startAdvertising(
AdvHandle_t handle,
uint32_t maxDuration = 0,
@ -1741,16 +1832,34 @@ public:
return BLE_ERROR_NOT_IMPLEMENTED;
}
/**
* FIXME
* @param handle
* @return
*/
virtual ble_error_t stopAdvertising(AdvHandle_t handle) {
(void) handle;
/* Requesting action from porter(s): override this API if this capability is supported. */
return BLE_ERROR_NOT_IMPLEMENTED;
}
/**
* FIXME
* @param handle
* @return
*/
virtual bool isAdvertisingActive(AdvHandle_t handle) {
return false;
}
/**
* FIXME
* @param handle
* @param periodicAdvertisingIntervalMinMs
* @param periodicAdvertisingIntervalMaxMs
* @param advertiseTxPower
* @return
*/
virtual ble_error_t setPeriodicAdvertisingParameters(
AdvHandle_t handle,
uint32_t periodicAdvertisingIntervalMinMs,
@ -1765,6 +1874,12 @@ public:
return BLE_ERROR_NOT_IMPLEMENTED;
}
/**
* FIXME
* @param handle
* @param payload
* @return
*/
virtual ble_error_t setPeriodicAdvertisingPayload(
AdvHandle_t handle,
mbed::Span<uint8_t> payload
@ -1775,6 +1890,11 @@ public:
return BLE_ERROR_NOT_IMPLEMENTED;
}
/**
* FIXME
* @param handle
* @return
*/
virtual ble_error_t startPeriodicAdvertising(AdvHandle_t handle)
{
(void) handle;
@ -1782,6 +1902,11 @@ public:
return BLE_ERROR_NOT_IMPLEMENTED;
}
/**
* FIXME
* @param handle
* @return
*/
virtual ble_error_t stopPeriodicAdvertising(AdvHandle_t handle)
{
(void) handle;
@ -1789,6 +1914,11 @@ public:
return BLE_ERROR_NOT_IMPLEMENTED;
}
/**
* FIXME
* @param handle
* @return
*/
virtual bool isPeriodicAdvertisingActive(AdvHandle_t handle)
{
(void) handle;
@ -1798,6 +1928,11 @@ public:
/* scanning */
/**
* FIXME
* @param params
* @return
*/
virtual ble_error_t setScanParameters(
const GapScanParameters& params
) {
@ -1806,6 +1941,13 @@ public:
return BLE_ERROR_NOT_IMPLEMENTED;
};
/**
* FIXME
* @param filtering
* @param duration
* @param period
* @return
*/
virtual ble_error_t startScan(
ble::scanning_filter_duplicates_t filtering = ble::SCAN_FILTER_DUPLICATES_DISABLED,
uint16_t duration = 0,
@ -1816,6 +1958,15 @@ public:
return BLE_ERROR_NOT_IMPLEMENTED;
};
/**
* FIXME
* @param peerAddressType
* @param peerAddress
* @param sid
* @param maxPacketSkip
* @param timeoutMs
* @return
*/
virtual ble_error_t createSync(
PeerAddressType_t peerAddressType,
Address_t peerAddress,
@ -1827,6 +1978,12 @@ public:
return BLE_ERROR_NOT_IMPLEMENTED;
}
/**
* FIXME
* @param maxPacketSkip
* @param timeoutMs
* @return
*/
virtual ble_error_t createSync(
uint16_t maxPacketSkip,
uint32_t timeoutMs
@ -1835,18 +1992,32 @@ public:
return BLE_ERROR_NOT_IMPLEMENTED;
}
/**
* FIXME
* @return
*/
virtual ble_error_t cancelCreateSync()
{
/* Requesting action from porter(s): override this API if this capability is supported. */
return BLE_ERROR_NOT_IMPLEMENTED;
}
/**
* FIXME
*/
virtual ble_error_t terminateSync(PeriodicSyncHandle_t handle)
{
/* Requesting action from porter(s): override this API if this capability is supported. */
return BLE_ERROR_NOT_IMPLEMENTED;
}
/**
* FIXME
* @param peerAddressType
* @param peerAddress
* @param sid
* @return
*/
virtual ble_error_t addDeviceToPeriodicAdvertiserList(
PeerAddressType_t peerAddressType,
Address_t peerAddress,
@ -1856,6 +2027,13 @@ public:
return BLE_ERROR_NOT_IMPLEMENTED;
}
/**
* FIXME
* @param peerAddressType
* @param peerAddress
* @param sid
* @return
*/
virtual ble_error_t removeDeviceFromPeriodicAdvertiserList(
PeerAddressType_t peerAddressType,
Address_t peerAddress,
@ -1865,11 +2043,19 @@ public:
return BLE_ERROR_NOT_IMPLEMENTED;
}
/**
* FIXME
* @return
*/
virtual ble_error_t clearPeriodicAdvertiserList() {
/* Requesting action from porter(s): override this API if this capability is supported. */
return BLE_ERROR_NOT_IMPLEMENTED;
}
/**
* FIXME
* @return
*/
virtual uint8_t getMaxPeriodicAdvertiserListSize() {
/* Requesting action from porter(s): override this API if this capability is supported. */
return 0;
@ -1878,7 +2064,15 @@ public:
protected:
/* Override the following in the underlying adaptation layer to provide the
* functionality of scanning. */
/**
* FIXME
*/
virtual void use_deprecated_scan_api() const { }
/**
* FIXME
*/
virtual void use_non_deprecated_scan_api() const { }
public: