mirror of https://github.com/ARMmbed/mbed-os.git
BLE: Move new gap types in ble/gap/Types.h
Vincent Coubard
parent
b4fe04addd
commit
b8db58fe57
|
|
@ -22,8 +22,7 @@
|
||||||
#include <string.h>
|
#include <string.h>
|
||||||
#include "ble/SafeEnum.h"
|
#include "ble/SafeEnum.h"
|
||||||
#include "ble/ArrayView.h"
|
#include "ble/ArrayView.h"
|
||||||
#include "ble/common/Duration.h"
|
#include "ble/gap/Types.h"
|
||||||
#include "ble/common/Bounded.h"
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @addtogroup ble
|
* @addtogroup ble
|
||||||
|
|
@ -44,24 +43,6 @@ void clamp(T& value, const R& min, const R& max) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/* BLE units, using microseconds as the common denominator */
|
|
||||||
typedef Duration<uint32_t, 625, Range<0x20, 0xFFFFFF> > adv_interval_t;
|
|
||||||
typedef Duration<uint16_t, 10000, Range<0x00, 0xFFFF> > adv_duration_t;
|
|
||||||
typedef Duration<uint16_t, 10000, Range<0x00, 0xFFFF> > scan_duration_t;
|
|
||||||
typedef Duration<uint16_t, 1280000, Range<0x00, 0xFFFF> > scan_period_t;
|
|
||||||
typedef Duration<uint16_t, 625, Range<0x04, 0xFFFF> > scan_interval_t;
|
|
||||||
typedef Duration<uint16_t, 625, Range<0x04, 0xFFFF> > scan_window_t;
|
|
||||||
typedef Duration<uint16_t, 1250, Range<0x06, 0x0C80> > conn_interval_t;
|
|
||||||
typedef Duration<uint16_t, 10000, Range<0x0A, 0x0C80> > supervision_timeout_t;
|
|
||||||
typedef Duration<uint16_t, 625, Range< 0, 0xFFFF> > conn_event_length_t;
|
|
||||||
typedef Duration<uint16_t, 10000, Range<0x0A, 0x4000> > sync_timeout_t;
|
|
||||||
typedef Duration<uint16_t, 1250, Range<0x06, 0xFFFF> > periodic_interval_t;
|
|
||||||
|
|
||||||
typedef Duration<uint32_t, 1000> ms_t;
|
|
||||||
typedef Duration<uint32_t, 1> us_t;
|
|
||||||
|
|
||||||
typedef Bounded<uint16_t, 0, 0x01F3> slave_latency_t;
|
|
||||||
|
|
||||||
/** Features supported by the controller.
|
/** Features supported by the controller.
|
||||||
* @see BLUETOOTH SPECIFICATION Version 5.0 | Vol 6, Part B - 4.6 */
|
* @see BLUETOOTH SPECIFICATION Version 5.0 | Vol 6, Part B - 4.6 */
|
||||||
struct controller_supported_features_t : SafeEnum<controller_supported_features_t, uint8_t> {
|
struct controller_supported_features_t : SafeEnum<controller_supported_features_t, uint8_t> {
|
||||||
|
|
@ -87,7 +68,7 @@ struct controller_supported_features_t : SafeEnum<controller_supported_features_
|
||||||
/**
|
/**
|
||||||
* Construct a new instance of ControllerSupportedFeatures_t.
|
* Construct a new instance of ControllerSupportedFeatures_t.
|
||||||
*/
|
*/
|
||||||
controller_supported_features_t(type value) : SafeEnum<controller_supported_features_t, uint8_t>(value) { }
|
controller_supported_features_t(type value) : SafeEnum(value) { }
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
@ -106,20 +87,6 @@ typedef uintptr_t connection_handle_t;
|
||||||
*/
|
*/
|
||||||
typedef uint16_t attribute_handle_t;
|
typedef uint16_t attribute_handle_t;
|
||||||
|
|
||||||
/**
|
|
||||||
* Handle of an advertising set.
|
|
||||||
*
|
|
||||||
* @note Range of valid handle is comprised between 0x00 and 0xEF.
|
|
||||||
*/
|
|
||||||
typedef uint8_t advertising_handle_t;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Handle of a sync representing a periodic advertiser.
|
|
||||||
*
|
|
||||||
* @note Range of valid handle is comprised between 0x0000 and 0xFFFF.
|
|
||||||
*/
|
|
||||||
typedef uint16_t periodic_sync_handle_t;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Inclusive range of GATT attributes handles.
|
* Inclusive range of GATT attributes handles.
|
||||||
*
|
*
|
||||||
|
|
@ -191,262 +158,6 @@ static inline attribute_handle_range_t attribute_handle_range(
|
||||||
return result;
|
return result;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Encapsulates the peripheral advertising modes.
|
|
||||||
*
|
|
||||||
* It determine how the device appears to other scanner and peripheral
|
|
||||||
* devices in the scanning range.
|
|
||||||
*/
|
|
||||||
enum advertising_type_t {
|
|
||||||
/**
|
|
||||||
* Device is connectable, scannable and doesn't expect connection from a
|
|
||||||
* specific peer.
|
|
||||||
*
|
|
||||||
* @see Vol 3, Part C, Section 9.3.4 and Vol 6, Part B, Section 2.3.1.1.
|
|
||||||
*/
|
|
||||||
ADV_CONNECTABLE_UNDIRECTED,
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Device is connectable and expects connection from a specific peer.
|
|
||||||
* (3.75 ms or smaller Advertising Interval)
|
|
||||||
* @see Vol 3, Part C, Section 9.3.3 and Vol 6, Part B, Section 2.3.1.2.
|
|
||||||
*/
|
|
||||||
ADV_CONNECTABLE_DIRECTED,
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Device is scannable but not connectable.
|
|
||||||
*
|
|
||||||
* @see Vol 6, Part B, Section 2.3.1.4.
|
|
||||||
*/
|
|
||||||
ADV_SCANNABLE_UNDIRECTED,
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Device is not connectable and not scannable.
|
|
||||||
*
|
|
||||||
* @see Vol 3, Part C, Section 9.3.2 and Vol 6, Part B, Section 2.3.1.3.
|
|
||||||
*/
|
|
||||||
ADV_NON_CONNECTABLE_UNDIRECTED,
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Device is connectable and expects connection from a specific peer (sent at long user set intervals).
|
|
||||||
*/
|
|
||||||
ADV_CONNECTABLE_DIRECTED_LOW_DUTY
|
|
||||||
};
|
|
||||||
|
|
||||||
/** Used to indicate if the packet is complete and if it's truncated.
|
|
||||||
*/
|
|
||||||
struct advertising_data_status_t : SafeEnum<advertising_data_status_t, uint8_t >{
|
|
||||||
enum type {
|
|
||||||
COMPLETE = 0x00, /**< Advertising payload complete. */
|
|
||||||
INCOMPLETE_MORE_DATA = 0x01, /**< Partial advertising payload, more to come. */
|
|
||||||
INCOMPLETE_DATA_TRUNCATED = 0x02 /**< Advertising payload incomplete and no more is comoing. */
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Construct a new advertising_data_status_t value.
|
|
||||||
*/
|
|
||||||
advertising_data_status_t(type value) :
|
|
||||||
SafeEnum<advertising_data_status_t, uint8_t>(value) { }
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Explicit constructor from a raw value.
|
|
||||||
*/
|
|
||||||
explicit advertising_data_status_t(uint8_t raw_value) :
|
|
||||||
SafeEnum<advertising_data_status_t, uint8_t>(
|
|
||||||
static_cast<advertising_data_status_t>(raw_value)
|
|
||||||
)
|
|
||||||
{ }
|
|
||||||
};
|
|
||||||
|
|
||||||
/** Properties of an advertising event.
|
|
||||||
*/
|
|
||||||
struct advertising_event_t {
|
|
||||||
/** Create based on a raw value.
|
|
||||||
*
|
|
||||||
* @param value
|
|
||||||
*/
|
|
||||||
explicit advertising_event_t(uint8_t value) : value(value) { }
|
|
||||||
|
|
||||||
/** Is advertising connectable.
|
|
||||||
*
|
|
||||||
* @return True if connectable.
|
|
||||||
*/
|
|
||||||
bool connectable() const
|
|
||||||
{
|
|
||||||
return static_cast<bool>(value & (1 << 0));
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Is advertising scannable.
|
|
||||||
*
|
|
||||||
* @return True if scannable
|
|
||||||
*/
|
|
||||||
bool scannable_advertising() const
|
|
||||||
{
|
|
||||||
return static_cast<bool>(value & (1 << 1));
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Is advertising directed.
|
|
||||||
*
|
|
||||||
* @return True if directed.
|
|
||||||
*/
|
|
||||||
bool directed_advertising() const
|
|
||||||
{
|
|
||||||
return static_cast<bool>(value & (1 << 2));
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Is this a scan response.
|
|
||||||
*
|
|
||||||
* @return True if scan response.
|
|
||||||
*/
|
|
||||||
bool scan_response() const
|
|
||||||
{
|
|
||||||
return static_cast<bool>(value & (1 << 3));
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Is this legacy advertising.
|
|
||||||
*
|
|
||||||
* @return True if legacy.
|
|
||||||
*/
|
|
||||||
bool legacy_advertising() const
|
|
||||||
{
|
|
||||||
return static_cast<bool>(value & (1 << 4));
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Payload completeness status.
|
|
||||||
*
|
|
||||||
* @return @see advertising_data_status_t for details.
|
|
||||||
*/
|
|
||||||
advertising_data_status_t data_status() const
|
|
||||||
{
|
|
||||||
return static_cast<advertising_data_status_t::type>((value >> 5) & 0x03);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Is payload complete.
|
|
||||||
*
|
|
||||||
* @return True if payload is coplete.
|
|
||||||
*/
|
|
||||||
bool complete() const
|
|
||||||
{
|
|
||||||
return data_status().value() == advertising_data_status_t::COMPLETE;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Is there more data coming.
|
|
||||||
*
|
|
||||||
* @return True if more data coming.
|
|
||||||
*/
|
|
||||||
bool more_data_to_come() const
|
|
||||||
{
|
|
||||||
return data_status().value() == advertising_data_status_t::INCOMPLETE_MORE_DATA;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Is the payload truncated.
|
|
||||||
*
|
|
||||||
* @return True if no more data coming.
|
|
||||||
*/
|
|
||||||
bool truncated() const
|
|
||||||
{
|
|
||||||
return data_status().value() == advertising_data_status_t::INCOMPLETE_DATA_TRUNCATED;
|
|
||||||
}
|
|
||||||
|
|
||||||
private:
|
|
||||||
uint8_t value;
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Identify an advertising SID. Range: [0x00, 0x0F]
|
|
||||||
*/
|
|
||||||
typedef uint8_t advertising_sid_t;
|
|
||||||
|
|
||||||
/** Received signal strength. Range <-127, 20>.
|
|
||||||
* @note Special value 127 means RSSI is not available. */
|
|
||||||
typedef int8_t rssi_t;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Describe the advertising power.
|
|
||||||
*
|
|
||||||
* Value comprised between -127 and +126 are considered power values in dBm while
|
|
||||||
* the special value 127 can be used as a wildcard to indicates that the host
|
|
||||||
* has no preference or if the power information is not available.
|
|
||||||
*/
|
|
||||||
typedef int8_t advertising_power_t;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Advertising policy filter modes.
|
|
||||||
*
|
|
||||||
* @see Bluetooth Core Specification 4.2 (Vol. 6), Part B, Section 4.3.2.
|
|
||||||
*/
|
|
||||||
enum advertising_policy_mode_t {
|
|
||||||
/**
|
|
||||||
* The whitelist is not used to filter peer request during advertising.
|
|
||||||
*/
|
|
||||||
ADV_POLICY_IGNORE_WHITELIST = 0,
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The whitelist is used to filter peer scan requests.
|
|
||||||
*/
|
|
||||||
ADV_POLICY_FILTER_SCAN_REQS = 1,
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The whitelist is used to filter peer connection requests.
|
|
||||||
*/
|
|
||||||
ADV_POLICY_FILTER_CONN_REQS = 2,
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The whitelist is used to filter peer scan and connection requests.
|
|
||||||
*/
|
|
||||||
ADV_POLICY_FILTER_ALL_REQS = 3,
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Scanning policy filter mode.
|
|
||||||
*
|
|
||||||
* @see Bluetooth Core Specification 4.2 (Vol. 6), Part B, Section 4.3.3.
|
|
||||||
*/
|
|
||||||
enum scanning_policy_mode_t {
|
|
||||||
/**
|
|
||||||
* The whitelist is not used for scanning operations.
|
|
||||||
*/
|
|
||||||
SCAN_POLICY_IGNORE_WHITELIST = 0,
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The whitelist is used to filter incoming advertising.
|
|
||||||
*/
|
|
||||||
SCAN_POLICY_FILTER_ALL_ADV = 1,
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Accept all advertising packets except directed advertising packets
|
|
||||||
* where the initiator's identity address does not address this device.
|
|
||||||
*
|
|
||||||
* @note Directed advertising packets where the initiator's address is a
|
|
||||||
* resolvable private address that cannot be resolved are also accepted.
|
|
||||||
*/
|
|
||||||
SCAN_POLICY_IGNORE_WHITELIST_INCLUDE_UNRESOLVABLE = 2,
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Accept all advertising packets except:
|
|
||||||
* - advertising packets where the advertiser's
|
|
||||||
* identity address is not in the White List,
|
|
||||||
* - directed advertising packets where the initiator's identity address
|
|
||||||
* does not address this device.
|
|
||||||
*
|
|
||||||
* @note Directed advertising packets where the initiator's address is a
|
|
||||||
* resolvable private address that cannot be resolved are also accepted.
|
|
||||||
*/
|
|
||||||
SCAN_POLICY_FILTER_ALL_ADV_INCLUDE_UNRESOLVABLE = 3
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Scanning policy filter mode.
|
|
||||||
*
|
|
||||||
* @see Bluetooth Core Specification 4.2 (Vol. 6), Part B, Section 4.3.3.
|
|
||||||
*/
|
|
||||||
enum scanning_filter_duplicates_t {
|
|
||||||
SCAN_FILTER_DUPLICATES_DISABLED = 0, /**< Do not remove duplicate reports. */
|
|
||||||
SCAN_FILTER_DUPLICATES_ENABLED = 1, /**< Remove duplicate reports. */
|
|
||||||
SCAN_FILTER_DUPLICATES_ENABLED_PER_PERIOD = 2 /**< Remove reports which are duplicate
|
|
||||||
within a single period. */
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Type that describes link's encryption state.
|
* Type that describes link's encryption state.
|
||||||
*/
|
*/
|
||||||
|
|
@ -904,20 +615,6 @@ struct peer_address_type_t :SafeEnum<peer_address_type_t, uint8_t> {
|
||||||
SafeEnum<peer_address_type_t, uint8_t>(PUBLIC) { }
|
SafeEnum<peer_address_type_t, uint8_t>(PUBLIC) { }
|
||||||
};
|
};
|
||||||
|
|
||||||
struct own_address_type_t : ble::SafeEnum<own_address_type_t, uint8_t> {
|
|
||||||
enum type {
|
|
||||||
PUBLIC = 0, /**< Public Device Address. */
|
|
||||||
RANDOM, /**< Random Device Address. */
|
|
||||||
RANDOM_RESOLVABLE_PUBLIC_FALLBACK, /**< Controller generates the Resolvable Private Address based on
|
|
||||||
the local IRK from the resolving list. If the resolving list
|
|
||||||
contains no matching entry, use the public address. */
|
|
||||||
RANDOM_RESOLVABLE_RANDOM_FALLBACK /**< Controller generates the Resolvable Private Address based on
|
|
||||||
the local IRK from the resolving list. If the resolving list
|
|
||||||
contains no matching entry, use previously set random address. */
|
|
||||||
};
|
|
||||||
own_address_type_t(type value) : ble::SafeEnum<own_address_type_t, uint8_t>(value) { }
|
|
||||||
};
|
|
||||||
|
|
||||||
struct target_peer_address_type_t : ble::SafeEnum<target_peer_address_type_t, uint8_t> {
|
struct target_peer_address_type_t : ble::SafeEnum<target_peer_address_type_t, uint8_t> {
|
||||||
enum type {
|
enum type {
|
||||||
PUBLIC = 0, /**< Public Device Address or Public Identity Address. */
|
PUBLIC = 0, /**< Public Device Address or Public Identity Address. */
|
||||||
|
|
@ -1113,153 +810,6 @@ struct coded_symbol_per_bit_t :SafeEnum<coded_symbol_per_bit_t, uint8_t> {
|
||||||
SafeEnum<coded_symbol_per_bit_t, uint8_t>(value) { }
|
SafeEnum<coded_symbol_per_bit_t, uint8_t>(value) { }
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
|
||||||
* Accuracy of the master clock.
|
|
||||||
*/
|
|
||||||
struct clock_accuracy_t : SafeEnum<clock_accuracy_t, uint8_t >{
|
|
||||||
enum type {
|
|
||||||
/**
|
|
||||||
* 500 PPM
|
|
||||||
*/
|
|
||||||
PPM_500 = 0x00,
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 250 PPM
|
|
||||||
*/
|
|
||||||
PPM_250 = 0x01,
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 150 PPM
|
|
||||||
*/
|
|
||||||
PPM_150 = 0x02,
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 100 PPM
|
|
||||||
*/
|
|
||||||
PPM_100 = 0x03,
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 75 PPM
|
|
||||||
*/
|
|
||||||
PPM_75 = 0x04,
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 50 PPM
|
|
||||||
*/
|
|
||||||
PPM_50 = 0x05,
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 30 PPM
|
|
||||||
*/
|
|
||||||
PPM_30 = 0x06,
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 20 PPM
|
|
||||||
*/
|
|
||||||
PPM_20 = 0x07
|
|
||||||
};
|
|
||||||
|
|
||||||
/** Get clock accuracy.
|
|
||||||
*
|
|
||||||
* @return Parts per million as a number.
|
|
||||||
*/
|
|
||||||
uint16_t get_ppm() {
|
|
||||||
uint16_t ppm = 0;
|
|
||||||
|
|
||||||
switch(value()) {
|
|
||||||
case PPM_500:
|
|
||||||
ppm = 500;
|
|
||||||
break;
|
|
||||||
case PPM_250:
|
|
||||||
ppm = 250;
|
|
||||||
break;
|
|
||||||
case PPM_150:
|
|
||||||
ppm = 150;
|
|
||||||
break;
|
|
||||||
case PPM_100:
|
|
||||||
ppm = 100;
|
|
||||||
break;
|
|
||||||
case PPM_75:
|
|
||||||
ppm = 75;
|
|
||||||
break;
|
|
||||||
case PPM_50:
|
|
||||||
ppm = 50;
|
|
||||||
break;
|
|
||||||
case PPM_30:
|
|
||||||
ppm = 30;
|
|
||||||
break;
|
|
||||||
case PPM_20:
|
|
||||||
ppm = 20;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
|
|
||||||
return ppm;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Construct a new clock_accuracy_t value.
|
|
||||||
*/
|
|
||||||
clock_accuracy_t(type value) : SafeEnum<clock_accuracy_t, uint8_t>(value) { }
|
|
||||||
|
|
||||||
explicit clock_accuracy_t(uint8_t raw_value) :
|
|
||||||
SafeEnum<clock_accuracy_t, uint8_t>(static_cast<type>(raw_value)) { }
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Enumeration of GAP roles.
|
|
||||||
*
|
|
||||||
* @note The BLE API does not express the broadcaster and scanner roles.
|
|
||||||
*
|
|
||||||
* @attention A device can fulfill different roles concurrently.
|
|
||||||
*/
|
|
||||||
struct connection_role_t :SafeEnum<connection_role_t, uint8_t> {
|
|
||||||
/** struct scoped enum wrapped by the class */
|
|
||||||
enum type {
|
|
||||||
/**
|
|
||||||
* Central Role.
|
|
||||||
*
|
|
||||||
* The device can scan and initiate connection to peripherals. It
|
|
||||||
* acts as the master when a connection is established.
|
|
||||||
*
|
|
||||||
* @note A central is a scanner.
|
|
||||||
*/
|
|
||||||
CENTRAL = 0x00,
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @see CENTRAL
|
|
||||||
*/
|
|
||||||
MASTER = 0x00,
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Peripheral Role.
|
|
||||||
*
|
|
||||||
* The device can advertise and it can be connected by a central. It
|
|
||||||
* acts as a slave when connected.
|
|
||||||
*
|
|
||||||
* @note A peripheral is a broadcaster.
|
|
||||||
*/
|
|
||||||
PERIPHERAL = 0x01,
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @see SLAVE
|
|
||||||
*/
|
|
||||||
SLAVE = 0x01
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Construct a new instance of role_t.
|
|
||||||
*/
|
|
||||||
connection_role_t(type value) :
|
|
||||||
SafeEnum<connection_role_t, uint8_t>(value) { }
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Explicit constructor from a raw value.
|
|
||||||
* @param raw_value The role.
|
|
||||||
*/
|
|
||||||
explicit connection_role_t(uint8_t raw_value) :
|
|
||||||
SafeEnum<connection_role_t, uint8_t>(raw_value) { }
|
|
||||||
};
|
|
||||||
|
|
||||||
} // namespace ble
|
} // namespace ble
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,474 @@
|
||||||
|
/* mbed Microcontroller Library
|
||||||
|
* Copyright (c) 2018 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.
|
||||||
|
*/
|
||||||
|
|
||||||
|
#ifndef BLE_GAP_TYPES_H
|
||||||
|
#define BLE_GAP_TYPES_H
|
||||||
|
|
||||||
|
#include "ble/common/Duration.h"
|
||||||
|
#include "ble/common/Bounded.h"
|
||||||
|
#include "ble/SafeEnum.h"
|
||||||
|
|
||||||
|
namespace ble {
|
||||||
|
|
||||||
|
/* BLE units, using microseconds as the common denominator */
|
||||||
|
typedef Duration<uint32_t, 625, Range<0x20, 0xFFFFFF> > adv_interval_t;
|
||||||
|
typedef Duration<uint16_t, 10000, Range<0x00, 0xFFFF> > adv_duration_t;
|
||||||
|
typedef Duration<uint16_t, 10000, Range<0x00, 0xFFFF> > scan_duration_t;
|
||||||
|
typedef Duration<uint16_t, 1280000, Range<0x00, 0xFFFF> > scan_period_t;
|
||||||
|
typedef Duration<uint16_t, 625, Range<0x04, 0xFFFF> > scan_interval_t;
|
||||||
|
typedef Duration<uint16_t, 625, Range<0x04, 0xFFFF> > scan_window_t;
|
||||||
|
typedef Duration<uint16_t, 1250, Range<0x06, 0x0C80> > conn_interval_t;
|
||||||
|
typedef Duration<uint16_t, 10000, Range<0x0A, 0x0C80> > supervision_timeout_t;
|
||||||
|
typedef Duration<uint16_t, 625, Range< 0, 0xFFFF> > conn_event_length_t;
|
||||||
|
typedef Duration<uint16_t, 10000, Range<0x0A, 0x4000> > sync_timeout_t;
|
||||||
|
typedef Duration<uint16_t, 1250, Range<0x06, 0xFFFF> > periodic_interval_t;
|
||||||
|
|
||||||
|
typedef Bounded<uint16_t, 0, 0x01F3> slave_latency_t;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle of an advertising set.
|
||||||
|
*
|
||||||
|
* @note Range of valid handle is comprised between 0x00 and 0xEF.
|
||||||
|
*/
|
||||||
|
typedef uint8_t advertising_handle_t;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle of a sync representing a periodic advertiser.
|
||||||
|
*
|
||||||
|
* @note Range of valid handle is comprised between 0x0000 and 0xFFFF.
|
||||||
|
*/
|
||||||
|
typedef uint16_t periodic_sync_handle_t;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Encapsulates the peripheral advertising modes.
|
||||||
|
*
|
||||||
|
* It determine how the device appears to other scanner and peripheral
|
||||||
|
* devices in the scanning range.
|
||||||
|
*/
|
||||||
|
enum advertising_type_t {
|
||||||
|
/**
|
||||||
|
* Device is connectable, scannable and doesn't expect connection from a
|
||||||
|
* specific peer.
|
||||||
|
*
|
||||||
|
* @see Vol 3, Part C, Section 9.3.4 and Vol 6, Part B, Section 2.3.1.1.
|
||||||
|
*/
|
||||||
|
ADV_CONNECTABLE_UNDIRECTED,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Device is connectable and expects connection from a specific peer.
|
||||||
|
* (3.75 ms or smaller Advertising Interval)
|
||||||
|
* @see Vol 3, Part C, Section 9.3.3 and Vol 6, Part B, Section 2.3.1.2.
|
||||||
|
*/
|
||||||
|
ADV_CONNECTABLE_DIRECTED,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Device is scannable but not connectable.
|
||||||
|
*
|
||||||
|
* @see Vol 6, Part B, Section 2.3.1.4.
|
||||||
|
*/
|
||||||
|
ADV_SCANNABLE_UNDIRECTED,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Device is not connectable and not scannable.
|
||||||
|
*
|
||||||
|
* @see Vol 3, Part C, Section 9.3.2 and Vol 6, Part B, Section 2.3.1.3.
|
||||||
|
*/
|
||||||
|
ADV_NON_CONNECTABLE_UNDIRECTED,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Device is connectable and expects connection from a specific peer (sent at long user set intervals).
|
||||||
|
*/
|
||||||
|
ADV_CONNECTABLE_DIRECTED_LOW_DUTY
|
||||||
|
};
|
||||||
|
|
||||||
|
/** Used to indicate if the packet is complete and if it's truncated.
|
||||||
|
*/
|
||||||
|
struct advertising_data_status_t : SafeEnum<advertising_data_status_t, uint8_t >{
|
||||||
|
enum type {
|
||||||
|
COMPLETE = 0x00, /**< Advertising payload complete. */
|
||||||
|
INCOMPLETE_MORE_DATA = 0x01, /**< Partial advertising payload, more to come. */
|
||||||
|
INCOMPLETE_DATA_TRUNCATED = 0x02 /**< Advertising payload incomplete and no more is comoing. */
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Construct a new advertising_data_status_t value.
|
||||||
|
*/
|
||||||
|
advertising_data_status_t(type value) :
|
||||||
|
SafeEnum<advertising_data_status_t, uint8_t>(value) { }
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Explicit constructor from a raw value.
|
||||||
|
*/
|
||||||
|
explicit advertising_data_status_t(uint8_t raw_value) :
|
||||||
|
SafeEnum<advertising_data_status_t, uint8_t>(
|
||||||
|
static_cast<advertising_data_status_t>(raw_value)
|
||||||
|
)
|
||||||
|
{ }
|
||||||
|
};
|
||||||
|
|
||||||
|
/** Properties of an advertising event.
|
||||||
|
*/
|
||||||
|
struct advertising_event_t {
|
||||||
|
/** Create based on a raw value.
|
||||||
|
*
|
||||||
|
* @param value
|
||||||
|
*/
|
||||||
|
explicit advertising_event_t(uint8_t value) : value(value) { }
|
||||||
|
|
||||||
|
/** Is advertising connectable.
|
||||||
|
*
|
||||||
|
* @return True if connectable.
|
||||||
|
*/
|
||||||
|
bool connectable() const
|
||||||
|
{
|
||||||
|
return static_cast<bool>(value & (1 << 0));
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Is advertising scannable.
|
||||||
|
*
|
||||||
|
* @return True if scannable
|
||||||
|
*/
|
||||||
|
bool scannable_advertising() const
|
||||||
|
{
|
||||||
|
return static_cast<bool>(value & (1 << 1));
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Is advertising directed.
|
||||||
|
*
|
||||||
|
* @return True if directed.
|
||||||
|
*/
|
||||||
|
bool directed_advertising() const
|
||||||
|
{
|
||||||
|
return static_cast<bool>(value & (1 << 2));
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Is this a scan response.
|
||||||
|
*
|
||||||
|
* @return True if scan response.
|
||||||
|
*/
|
||||||
|
bool scan_response() const
|
||||||
|
{
|
||||||
|
return static_cast<bool>(value & (1 << 3));
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Is this legacy advertising.
|
||||||
|
*
|
||||||
|
* @return True if legacy.
|
||||||
|
*/
|
||||||
|
bool legacy_advertising() const
|
||||||
|
{
|
||||||
|
return static_cast<bool>(value & (1 << 4));
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Payload completeness status.
|
||||||
|
*
|
||||||
|
* @return @see advertising_data_status_t for details.
|
||||||
|
*/
|
||||||
|
advertising_data_status_t data_status() const
|
||||||
|
{
|
||||||
|
return static_cast<advertising_data_status_t::type>((value >> 5) & 0x03);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Is payload complete.
|
||||||
|
*
|
||||||
|
* @return True if payload is coplete.
|
||||||
|
*/
|
||||||
|
bool complete() const
|
||||||
|
{
|
||||||
|
return data_status().value() == advertising_data_status_t::COMPLETE;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Is there more data coming.
|
||||||
|
*
|
||||||
|
* @return True if more data coming.
|
||||||
|
*/
|
||||||
|
bool more_data_to_come() const
|
||||||
|
{
|
||||||
|
return data_status().value() == advertising_data_status_t::INCOMPLETE_MORE_DATA;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Is the payload truncated.
|
||||||
|
*
|
||||||
|
* @return True if no more data coming.
|
||||||
|
*/
|
||||||
|
bool truncated() const
|
||||||
|
{
|
||||||
|
return data_status().value() == advertising_data_status_t::INCOMPLETE_DATA_TRUNCATED;
|
||||||
|
}
|
||||||
|
|
||||||
|
private:
|
||||||
|
uint8_t value;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Identify an advertising SID. Range: [0x00, 0x0F]
|
||||||
|
*/
|
||||||
|
typedef uint8_t advertising_sid_t;
|
||||||
|
|
||||||
|
/** Received signal strength. Range <-127, 20>.
|
||||||
|
* @note Special value 127 means RSSI is not available. */
|
||||||
|
typedef int8_t rssi_t;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Describe the advertising power.
|
||||||
|
*
|
||||||
|
* Value comprised between -127 and +126 are considered power values in dBm while
|
||||||
|
* the special value 127 can be used as a wildcard to indicates that the host
|
||||||
|
* has no preference or if the power information is not available.
|
||||||
|
*/
|
||||||
|
typedef int8_t advertising_power_t;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Advertising policy filter modes.
|
||||||
|
*
|
||||||
|
* @see Bluetooth Core Specification 4.2 (Vol. 6), Part B, Section 4.3.2.
|
||||||
|
*/
|
||||||
|
enum advertising_policy_mode_t {
|
||||||
|
/**
|
||||||
|
* The whitelist is not used to filter peer request during advertising.
|
||||||
|
*/
|
||||||
|
ADV_POLICY_IGNORE_WHITELIST = 0,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The whitelist is used to filter peer scan requests.
|
||||||
|
*/
|
||||||
|
ADV_POLICY_FILTER_SCAN_REQS = 1,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The whitelist is used to filter peer connection requests.
|
||||||
|
*/
|
||||||
|
ADV_POLICY_FILTER_CONN_REQS = 2,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The whitelist is used to filter peer scan and connection requests.
|
||||||
|
*/
|
||||||
|
ADV_POLICY_FILTER_ALL_REQS = 3,
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Scanning policy filter mode.
|
||||||
|
*
|
||||||
|
* @see Bluetooth Core Specification 4.2 (Vol. 6), Part B, Section 4.3.3.
|
||||||
|
*/
|
||||||
|
enum scanning_policy_mode_t {
|
||||||
|
/**
|
||||||
|
* The whitelist is not used for scanning operations.
|
||||||
|
*/
|
||||||
|
SCAN_POLICY_IGNORE_WHITELIST = 0,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The whitelist is used to filter incoming advertising.
|
||||||
|
*/
|
||||||
|
SCAN_POLICY_FILTER_ALL_ADV = 1,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Accept all advertising packets except directed advertising packets
|
||||||
|
* where the initiator's identity address does not address this device.
|
||||||
|
*
|
||||||
|
* @note Directed advertising packets where the initiator's address is a
|
||||||
|
* resolvable private address that cannot be resolved are also accepted.
|
||||||
|
*/
|
||||||
|
SCAN_POLICY_IGNORE_WHITELIST_INCLUDE_UNRESOLVABLE = 2,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Accept all advertising packets except:
|
||||||
|
* - advertising packets where the advertiser's
|
||||||
|
* identity address is not in the White List,
|
||||||
|
* - directed advertising packets where the initiator's identity address
|
||||||
|
* does not address this device.
|
||||||
|
*
|
||||||
|
* @note Directed advertising packets where the initiator's address is a
|
||||||
|
* resolvable private address that cannot be resolved are also accepted.
|
||||||
|
*/
|
||||||
|
SCAN_POLICY_FILTER_ALL_ADV_INCLUDE_UNRESOLVABLE = 3
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Scanning policy filter mode.
|
||||||
|
*
|
||||||
|
* @see Bluetooth Core Specification 4.2 (Vol. 6), Part B, Section 4.3.3.
|
||||||
|
*/
|
||||||
|
enum scanning_filter_duplicates_t {
|
||||||
|
SCAN_FILTER_DUPLICATES_DISABLED = 0, /**< Do not remove duplicate reports. */
|
||||||
|
SCAN_FILTER_DUPLICATES_ENABLED = 1, /**< Remove duplicate reports. */
|
||||||
|
SCAN_FILTER_DUPLICATES_ENABLED_PER_PERIOD = 2 /**< Remove reports which are duplicate
|
||||||
|
within a single period. */
|
||||||
|
};
|
||||||
|
|
||||||
|
struct own_address_type_t : ble::SafeEnum<own_address_type_t, uint8_t> {
|
||||||
|
enum type {
|
||||||
|
PUBLIC = 0, /**< Public Device Address. */
|
||||||
|
RANDOM, /**< Random Device Address. */
|
||||||
|
RANDOM_RESOLVABLE_PUBLIC_FALLBACK, /**< Controller generates the Resolvable Private Address based on
|
||||||
|
the local IRK from the resolving list. If the resolving list
|
||||||
|
contains no matching entry, use the public address. */
|
||||||
|
RANDOM_RESOLVABLE_RANDOM_FALLBACK /**< Controller generates the Resolvable Private Address based on
|
||||||
|
the local IRK from the resolving list. If the resolving list
|
||||||
|
contains no matching entry, use previously set random address. */
|
||||||
|
};
|
||||||
|
own_address_type_t(type value) : ble::SafeEnum<own_address_type_t, uint8_t>(value) { }
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Accuracy of the master clock.
|
||||||
|
*/
|
||||||
|
struct clock_accuracy_t : SafeEnum<clock_accuracy_t, uint8_t >{
|
||||||
|
enum type {
|
||||||
|
/**
|
||||||
|
* 500 PPM
|
||||||
|
*/
|
||||||
|
PPM_500 = 0x00,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 250 PPM
|
||||||
|
*/
|
||||||
|
PPM_250 = 0x01,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 150 PPM
|
||||||
|
*/
|
||||||
|
PPM_150 = 0x02,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 100 PPM
|
||||||
|
*/
|
||||||
|
PPM_100 = 0x03,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 75 PPM
|
||||||
|
*/
|
||||||
|
PPM_75 = 0x04,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 50 PPM
|
||||||
|
*/
|
||||||
|
PPM_50 = 0x05,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 30 PPM
|
||||||
|
*/
|
||||||
|
PPM_30 = 0x06,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 20 PPM
|
||||||
|
*/
|
||||||
|
PPM_20 = 0x07
|
||||||
|
};
|
||||||
|
|
||||||
|
/** Get clock accuracy.
|
||||||
|
*
|
||||||
|
* @return Parts per million as a number.
|
||||||
|
*/
|
||||||
|
uint16_t get_ppm() {
|
||||||
|
uint16_t ppm = 0;
|
||||||
|
|
||||||
|
switch(value()) {
|
||||||
|
case PPM_500:
|
||||||
|
ppm = 500;
|
||||||
|
break;
|
||||||
|
case PPM_250:
|
||||||
|
ppm = 250;
|
||||||
|
break;
|
||||||
|
case PPM_150:
|
||||||
|
ppm = 150;
|
||||||
|
break;
|
||||||
|
case PPM_100:
|
||||||
|
ppm = 100;
|
||||||
|
break;
|
||||||
|
case PPM_75:
|
||||||
|
ppm = 75;
|
||||||
|
break;
|
||||||
|
case PPM_50:
|
||||||
|
ppm = 50;
|
||||||
|
break;
|
||||||
|
case PPM_30:
|
||||||
|
ppm = 30;
|
||||||
|
break;
|
||||||
|
case PPM_20:
|
||||||
|
ppm = 20;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
return ppm;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Construct a new clock_accuracy_t value.
|
||||||
|
*/
|
||||||
|
clock_accuracy_t(type value) : SafeEnum<clock_accuracy_t, uint8_t>(value) { }
|
||||||
|
|
||||||
|
explicit clock_accuracy_t(uint8_t raw_value) :
|
||||||
|
SafeEnum<clock_accuracy_t, uint8_t>(static_cast<type>(raw_value)) { }
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Enumeration of GAP roles.
|
||||||
|
*
|
||||||
|
* @note The BLE API does not express the broadcaster and scanner roles.
|
||||||
|
*
|
||||||
|
* @attention A device can fulfill different roles concurrently.
|
||||||
|
*/
|
||||||
|
struct connection_role_t :SafeEnum<connection_role_t, uint8_t> {
|
||||||
|
/** struct scoped enum wrapped by the class */
|
||||||
|
enum type {
|
||||||
|
/**
|
||||||
|
* Central Role.
|
||||||
|
*
|
||||||
|
* The device can scan and initiate connection to peripherals. It
|
||||||
|
* acts as the master when a connection is established.
|
||||||
|
*
|
||||||
|
* @note A central is a scanner.
|
||||||
|
*/
|
||||||
|
CENTRAL = 0x00,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @see CENTRAL
|
||||||
|
*/
|
||||||
|
MASTER = 0x00,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Peripheral Role.
|
||||||
|
*
|
||||||
|
* The device can advertise and it can be connected by a central. It
|
||||||
|
* acts as a slave when connected.
|
||||||
|
*
|
||||||
|
* @note A peripheral is a broadcaster.
|
||||||
|
*/
|
||||||
|
PERIPHERAL = 0x01,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @see SLAVE
|
||||||
|
*/
|
||||||
|
SLAVE = 0x01
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Construct a new instance of role_t.
|
||||||
|
*/
|
||||||
|
connection_role_t(type value) :
|
||||||
|
SafeEnum<connection_role_t, uint8_t>(value) { }
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Explicit constructor from a raw value.
|
||||||
|
* @param raw_value The role.
|
||||||
|
*/
|
||||||
|
explicit connection_role_t(uint8_t raw_value) :
|
||||||
|
SafeEnum<connection_role_t, uint8_t>(raw_value) { }
|
||||||
|
};
|
||||||
|
|
||||||
|
} // namespace ble
|
||||||
|
|
||||||
|
#endif //BLE_GAP_TYPES_H
|
||||||
Loading…
Reference in New Issue