takashi kadono / Mbed OS Nucleo_446

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   ssd1331

mbed-os/features/FEATURE_BLE/ble/BLEProtocol.h@3:f3764f852aa8, 2018-10-11 (annotated)

Committer:
kadonotakashi
Date:
Thu Oct 11 02:27:46 2018 +0000
Revision:
3:f3764f852aa8
Parent:
0:8fdf9a60065b 
Nucreo 446 + SSD1331 test version;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kadonotakashi 0:8fdf9a60065b 1 /* mbed Microcontroller Library
kadonotakashi 0:8fdf9a60065b 2 * Copyright (c) 2006-2013 ARM Limited
kadonotakashi 0:8fdf9a60065b 3 *
kadonotakashi 0:8fdf9a60065b 4 * Licensed under the Apache License, Version 2.0 (the "License");
kadonotakashi 0:8fdf9a60065b 5 * you may not use this file except in compliance with the License.
kadonotakashi 0:8fdf9a60065b 6 * You may obtain a copy of the License at
kadonotakashi 0:8fdf9a60065b 7 *
kadonotakashi 0:8fdf9a60065b 8 * http://www.apache.org/licenses/LICENSE-2.0
kadonotakashi 0:8fdf9a60065b 9 *
kadonotakashi 0:8fdf9a60065b 10 * Unless required by applicable law or agreed to in writing, software
kadonotakashi 0:8fdf9a60065b 11 * distributed under the License is distributed on an "AS IS" BASIS,
kadonotakashi 0:8fdf9a60065b 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
kadonotakashi 0:8fdf9a60065b 13 * See the License for the specific language governing permissions and
kadonotakashi 0:8fdf9a60065b 14 * limitations under the License.
kadonotakashi 0:8fdf9a60065b 15 */
kadonotakashi 0:8fdf9a60065b 16
kadonotakashi 0:8fdf9a60065b 17 #ifndef MBED_BLE_PROTOCOL_H__
kadonotakashi 0:8fdf9a60065b 18 #define MBED_BLE_PROTOCOL_H__
kadonotakashi 0:8fdf9a60065b 19
kadonotakashi 0:8fdf9a60065b 20 #include <stddef.h>
kadonotakashi 0:8fdf9a60065b 21 #include <stdint.h>
kadonotakashi 0:8fdf9a60065b 22 #include <algorithm>
kadonotakashi 0:8fdf9a60065b 23
kadonotakashi 0:8fdf9a60065b 24 /**
kadonotakashi 0:8fdf9a60065b 25 * @addtogroup ble
kadonotakashi 0:8fdf9a60065b 26 * @{
kadonotakashi 0:8fdf9a60065b 27 * @addtogroup common
kadonotakashi 0:8fdf9a60065b 28 * @{
kadonotakashi 0:8fdf9a60065b 29 */
kadonotakashi 0:8fdf9a60065b 30
kadonotakashi 0:8fdf9a60065b 31 /**
kadonotakashi 0:8fdf9a60065b 32 * Common namespace for types and constants used everywhere in BLE API.
kadonotakashi 0:8fdf9a60065b 33 */
kadonotakashi 0:8fdf9a60065b 34 namespace BLEProtocol {
kadonotakashi 0:8fdf9a60065b 35
kadonotakashi 0:8fdf9a60065b 36 /**
kadonotakashi 0:8fdf9a60065b 37 * Container for the enumeration of BLE address types.
kadonotakashi 0:8fdf9a60065b 38 *
kadonotakashi 0:8fdf9a60065b 39 * @note Adding a struct to encapsulate the contained enumeration prevents
kadonotakashi 0:8fdf9a60065b 40 * polluting the BLEProtocol namespace with the enumerated values. It also
kadonotakashi 0:8fdf9a60065b 41 * allows type-aliases for the enumeration while retaining the enumerated
kadonotakashi 0:8fdf9a60065b 42 * values. i.e. doing:
kadonotakashi 0:8fdf9a60065b 43 *
kadonotakashi 0:8fdf9a60065b 44 * @code
kadonotakashi 0:8fdf9a60065b 45 * typedef AddressType AliasedType;
kadonotakashi 0:8fdf9a60065b 46 * @endcode
kadonotakashi 0:8fdf9a60065b 47 *
kadonotakashi 0:8fdf9a60065b 48 * would allow the use of AliasedType::PUBLIC in code.
kadonotakashi 0:8fdf9a60065b 49 *
kadonotakashi 0:8fdf9a60065b 50 * @note see Bluetooth Standard version 4.2 [Vol 6, Part B] section 1.3 .
kadonotakashi 0:8fdf9a60065b 51 */
kadonotakashi 0:8fdf9a60065b 52 struct AddressType {
kadonotakashi 0:8fdf9a60065b 53 /**
kadonotakashi 0:8fdf9a60065b 54 * Address-types for Protocol addresses.
kadonotakashi 0:8fdf9a60065b 55 */
kadonotakashi 0:8fdf9a60065b 56 enum Type {
kadonotakashi 0:8fdf9a60065b 57 /**
kadonotakashi 0:8fdf9a60065b 58 * Public device address.
kadonotakashi 0:8fdf9a60065b 59 */
kadonotakashi 0:8fdf9a60065b 60 PUBLIC = 0,
kadonotakashi 0:8fdf9a60065b 61
kadonotakashi 0:8fdf9a60065b 62 /**
kadonotakashi 0:8fdf9a60065b 63 * Random static device address.
kadonotakashi 0:8fdf9a60065b 64 *
kadonotakashi 0:8fdf9a60065b 65 * @deprecated This enumeration value is not relevant anymore.
kadonotakashi 0:8fdf9a60065b 66 * Advertising reporting and the connection procedure should rely
kadonotakashi 0:8fdf9a60065b 67 * on RANDOM instead. Use Gap::getRandomAddressType to retrieve the
kadonotakashi 0:8fdf9a60065b 68 * type of the random address.
kadonotakashi 0:8fdf9a60065b 69 */
kadonotakashi 0:8fdf9a60065b 70 RANDOM_STATIC,
kadonotakashi 0:8fdf9a60065b 71
kadonotakashi 0:8fdf9a60065b 72 /**
kadonotakashi 0:8fdf9a60065b 73 * Private resolvable device address.
kadonotakashi 0:8fdf9a60065b 74 *
kadonotakashi 0:8fdf9a60065b 75 * @deprecated This enumeration value is not relevant anymore.
kadonotakashi 0:8fdf9a60065b 76 * Advertising reporting and the connection procedure should rely
kadonotakashi 0:8fdf9a60065b 77 * on RANDOM instead. Use Gap::getRandomAddressType to retrieve the
kadonotakashi 0:8fdf9a60065b 78 * type of the random address.
kadonotakashi 0:8fdf9a60065b 79 */
kadonotakashi 0:8fdf9a60065b 80 RANDOM_PRIVATE_RESOLVABLE,
kadonotakashi 0:8fdf9a60065b 81
kadonotakashi 0:8fdf9a60065b 82 /**
kadonotakashi 0:8fdf9a60065b 83 * Private non-resolvable device address.
kadonotakashi 0:8fdf9a60065b 84 *
kadonotakashi 0:8fdf9a60065b 85 * @deprecated This enumeration value is not relevant anymore.
kadonotakashi 0:8fdf9a60065b 86 * Advertising reporting and the connection procedure should rely
kadonotakashi 0:8fdf9a60065b 87 * on RANDOM instead. Use Gap::getRandomAddressType to retrieve the
kadonotakashi 0:8fdf9a60065b 88 * type of the random address.
kadonotakashi 0:8fdf9a60065b 89 */
kadonotakashi 0:8fdf9a60065b 90 RANDOM_PRIVATE_NON_RESOLVABLE
kadonotakashi 0:8fdf9a60065b 91 };
kadonotakashi 0:8fdf9a60065b 92 };
kadonotakashi 0:8fdf9a60065b 93
kadonotakashi 0:8fdf9a60065b 94 /**
kadonotakashi 0:8fdf9a60065b 95 * Alias for AddressType::Type
kadonotakashi 0:8fdf9a60065b 96 */
kadonotakashi 0:8fdf9a60065b 97 typedef AddressType::Type AddressType_t;
kadonotakashi 0:8fdf9a60065b 98
kadonotakashi 0:8fdf9a60065b 99 /**
kadonotakashi 0:8fdf9a60065b 100 * Length (in octets) of the BLE MAC address.
kadonotakashi 0:8fdf9a60065b 101 */
kadonotakashi 0:8fdf9a60065b 102 static const size_t ADDR_LEN = 6;
kadonotakashi 0:8fdf9a60065b 103
kadonotakashi 0:8fdf9a60065b 104 /**
kadonotakashi 0:8fdf9a60065b 105 * 48-bit address, in LSB format.
kadonotakashi 0:8fdf9a60065b 106 */
kadonotakashi 0:8fdf9a60065b 107 typedef uint8_t AddressBytes_t[ADDR_LEN];
kadonotakashi 0:8fdf9a60065b 108
kadonotakashi 0:8fdf9a60065b 109 /**
kadonotakashi 0:8fdf9a60065b 110 * BLE address representation.
kadonotakashi 0:8fdf9a60065b 111 *
kadonotakashi 0:8fdf9a60065b 112 * It contains an address-type (::AddressType_t) and the address value
kadonotakashi 0:8fdf9a60065b 113 * (::AddressBytes_t).
kadonotakashi 0:8fdf9a60065b 114 */
kadonotakashi 0:8fdf9a60065b 115 struct Address_t {
kadonotakashi 0:8fdf9a60065b 116 /**
kadonotakashi 0:8fdf9a60065b 117 * Construct an Address_t object with the supplied type and address.
kadonotakashi 0:8fdf9a60065b 118 *
kadonotakashi 0:8fdf9a60065b 119 * @param[in] typeIn The BLE address type.
kadonotakashi 0:8fdf9a60065b 120 * @param[in] addressIn The BLE address.
kadonotakashi 0:8fdf9a60065b 121 *
kadonotakashi 0:8fdf9a60065b 122 * @post type is equal to typeIn and address is equal to the content
kadonotakashi 0:8fdf9a60065b 123 * present in addressIn.
kadonotakashi 0:8fdf9a60065b 124 */
kadonotakashi 0:8fdf9a60065b 125 Address_t(AddressType_t typeIn, const AddressBytes_t &addressIn) :
kadonotakashi 0:8fdf9a60065b 126 type(typeIn) {
kadonotakashi 0:8fdf9a60065b 127 std::copy(addressIn, addressIn + ADDR_LEN, address);
kadonotakashi 0:8fdf9a60065b 128 }
kadonotakashi 0:8fdf9a60065b 129
kadonotakashi 0:8fdf9a60065b 130 /**
kadonotakashi 0:8fdf9a60065b 131 * Empty constructor.
kadonotakashi 0:8fdf9a60065b 132 *
kadonotakashi 0:8fdf9a60065b 133 * @note The address constructed with the empty constructor is not
kadonotakashi 0:8fdf9a60065b 134 * valid.
kadonotakashi 0:8fdf9a60065b 135 *
kadonotakashi 0:8fdf9a60065b 136 * @post type is equal to PUBLIC and the address value is equal to
kadonotakashi 0:8fdf9a60065b 137 * 00:00:00:00:00:00
kadonotakashi 0:8fdf9a60065b 138 */
kadonotakashi 0:8fdf9a60065b 139 Address_t(void) : type(), address() { }
kadonotakashi 0:8fdf9a60065b 140
kadonotakashi 0:8fdf9a60065b 141 /**
kadonotakashi 0:8fdf9a60065b 142 * Type of the BLE device address.
kadonotakashi 0:8fdf9a60065b 143 */
kadonotakashi 0:8fdf9a60065b 144 AddressType_t type;
kadonotakashi 0:8fdf9a60065b 145
kadonotakashi 0:8fdf9a60065b 146 /**
kadonotakashi 0:8fdf9a60065b 147 * Value of the device address.
kadonotakashi 0:8fdf9a60065b 148 */
kadonotakashi 0:8fdf9a60065b 149 AddressBytes_t address;
kadonotakashi 0:8fdf9a60065b 150 };
kadonotakashi 0:8fdf9a60065b 151 };
kadonotakashi 0:8fdf9a60065b 152
kadonotakashi 0:8fdf9a60065b 153 /**
kadonotakashi 0:8fdf9a60065b 154 * @}
kadonotakashi 0:8fdf9a60065b 155 * @}
kadonotakashi 0:8fdf9a60065b 156 */
kadonotakashi 0:8fdf9a60065b 157
kadonotakashi 0:8fdf9a60065b 158 #endif /* MBED_BLE_PROTOCOL_H__ */