mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_NRF51_DONGLE/TOOLCHAIN_GCC_ARM/nrf_ble_types.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
Parent:
TARGET_NRF51_DONGLE/TARGET_NORDIC/TARGET_NRF5x/TARGET_NRF51/TARGET_MCU_NRF51822_UNIFIED/sdk/softdevice/s130/headers/nrf_ble_types.h@169:a7c7b631e539 
mbed library. Release version 164

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Kojto 148:fd96258d940d 1 /*
Kojto 148:fd96258d940d 2 * Copyright (c) 2000 Nordic Semiconductor ASA
Kojto 148:fd96258d940d 3 * All rights reserved.
Kojto 148:fd96258d940d 4 *
Kojto 148:fd96258d940d 5 * Redistribution and use in source and binary forms, with or without modification,
Kojto 148:fd96258d940d 6 * are permitted provided that the following conditions are met:
Kojto 148:fd96258d940d 7 *
Kojto 148:fd96258d940d 8 * 1. Redistributions of source code must retain the above copyright notice, this list
Kojto 148:fd96258d940d 9 * of conditions and the following disclaimer.
Kojto 148:fd96258d940d 10 *
Kojto 148:fd96258d940d 11 * 2. Redistributions in binary form, except as embedded into a Nordic Semiconductor ASA
Kojto 148:fd96258d940d 12 * integrated circuit in a product or a software update for such product, must reproduce
Kojto 148:fd96258d940d 13 * the above copyright notice, this list of conditions and the following disclaimer in
Kojto 148:fd96258d940d 14 * the documentation and/or other materials provided with the distribution.
Kojto 148:fd96258d940d 15 *
Kojto 148:fd96258d940d 16 * 3. Neither the name of Nordic Semiconductor ASA nor the names of its contributors may be
Kojto 148:fd96258d940d 17 * used to endorse or promote products derived from this software without specific prior
Kojto 148:fd96258d940d 18 * written permission.
Kojto 148:fd96258d940d 19 *
Kojto 148:fd96258d940d 20 * 4. This software, with or without modification, must only be used with a
Kojto 148:fd96258d940d 21 * Nordic Semiconductor ASA integrated circuit.
Kojto 148:fd96258d940d 22 *
Kojto 148:fd96258d940d 23 * 5. Any software provided in binary or object form under this license must not be reverse
Kojto 148:fd96258d940d 24 * engineered, decompiled, modified and/or disassembled.
Kojto 148:fd96258d940d 25 *
Kojto 148:fd96258d940d 26 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
Kojto 148:fd96258d940d 27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
Kojto 148:fd96258d940d 28 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Kojto 148:fd96258d940d 29 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
Kojto 148:fd96258d940d 30 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
Kojto 148:fd96258d940d 31 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
Kojto 148:fd96258d940d 32 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
Kojto 148:fd96258d940d 33 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
Kojto 148:fd96258d940d 34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
Kojto 148:fd96258d940d 35 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Kojto 148:fd96258d940d 36 *
Kojto 148:fd96258d940d 37 */
Kojto 148:fd96258d940d 38
Kojto 148:fd96258d940d 39
Kojto 148:fd96258d940d 40 /**
Kojto 148:fd96258d940d 41 @addtogroup BLE_COMMON
Kojto 148:fd96258d940d 42 @{
Kojto 148:fd96258d940d 43 @defgroup ble_types Common types and macro definitions
Kojto 148:fd96258d940d 44 @{
Kojto 148:fd96258d940d 45
Kojto 148:fd96258d940d 46 @brief Common types and macro definitions for the BLE SoftDevice.
Kojto 148:fd96258d940d 47 */
Kojto 148:fd96258d940d 48
Kojto 148:fd96258d940d 49 #ifndef NRF_BLE_TYPES_H__
Kojto 148:fd96258d940d 50 #define NRF_BLE_TYPES_H__
Kojto 148:fd96258d940d 51
Kojto 148:fd96258d940d 52 #include <stdint.h>
Kojto 148:fd96258d940d 53
Kojto 148:fd96258d940d 54 #ifdef __cplusplus
Kojto 148:fd96258d940d 55 extern "C" {
Kojto 148:fd96258d940d 56 #endif
Kojto 148:fd96258d940d 57
Kojto 148:fd96258d940d 58 /** @addtogroup BLE_TYPES_DEFINES Defines
Kojto 148:fd96258d940d 59 * @{ */
Kojto 148:fd96258d940d 60
Kojto 148:fd96258d940d 61 /** @defgroup BLE_CONN_HANDLES BLE Connection Handles
Kojto 148:fd96258d940d 62 * @{ */
Kojto 148:fd96258d940d 63 #define BLE_CONN_HANDLE_INVALID 0xFFFF /**< Invalid Connection Handle. */
Kojto 148:fd96258d940d 64 #define BLE_CONN_HANDLE_ALL 0xFFFE /**< Applies to all Connection Handles. */
Kojto 148:fd96258d940d 65 /** @} */
Kojto 148:fd96258d940d 66
Kojto 148:fd96258d940d 67
Kojto 148:fd96258d940d 68 /** @defgroup BLE_UUID_VALUES Assigned Values for BLE UUIDs
Kojto 148:fd96258d940d 69 * @{ */
Kojto 148:fd96258d940d 70 /* Generic UUIDs, applicable to all services */
Kojto 148:fd96258d940d 71 #define BLE_UUID_UNKNOWN 0x0000 /**< Reserved UUID. */
Kojto 148:fd96258d940d 72 #define BLE_UUID_SERVICE_PRIMARY 0x2800 /**< Primary Service. */
Kojto 148:fd96258d940d 73 #define BLE_UUID_SERVICE_SECONDARY 0x2801 /**< Secondary Service. */
Kojto 148:fd96258d940d 74 #define BLE_UUID_SERVICE_INCLUDE 0x2802 /**< Include. */
Kojto 148:fd96258d940d 75 #define BLE_UUID_CHARACTERISTIC 0x2803 /**< Characteristic. */
Kojto 148:fd96258d940d 76 #define BLE_UUID_DESCRIPTOR_CHAR_EXT_PROP 0x2900 /**< Characteristic Extended Properties Descriptor. */
Kojto 148:fd96258d940d 77 #define BLE_UUID_DESCRIPTOR_CHAR_USER_DESC 0x2901 /**< Characteristic User Description Descriptor. */
Kojto 148:fd96258d940d 78 #define BLE_UUID_DESCRIPTOR_CLIENT_CHAR_CONFIG 0x2902 /**< Client Characteristic Configuration Descriptor. */
Kojto 148:fd96258d940d 79 #define BLE_UUID_DESCRIPTOR_SERVER_CHAR_CONFIG 0x2903 /**< Server Characteristic Configuration Descriptor. */
Kojto 148:fd96258d940d 80 #define BLE_UUID_DESCRIPTOR_CHAR_PRESENTATION_FORMAT 0x2904 /**< Characteristic Presentation Format Descriptor. */
Kojto 148:fd96258d940d 81 #define BLE_UUID_DESCRIPTOR_CHAR_AGGREGATE_FORMAT 0x2905 /**< Characteristic Aggregate Format Descriptor. */
Kojto 148:fd96258d940d 82 /* GATT specific UUIDs */
Kojto 148:fd96258d940d 83 #define BLE_UUID_GATT 0x1801 /**< Generic Attribute Profile. */
Kojto 148:fd96258d940d 84 #define BLE_UUID_GATT_CHARACTERISTIC_SERVICE_CHANGED 0x2A05 /**< Service Changed Characteristic. */
Kojto 148:fd96258d940d 85 /* GAP specific UUIDs */
Kojto 148:fd96258d940d 86 #define BLE_UUID_GAP 0x1800 /**< Generic Access Profile. */
Kojto 148:fd96258d940d 87 #define BLE_UUID_GAP_CHARACTERISTIC_DEVICE_NAME 0x2A00 /**< Device Name Characteristic. */
Kojto 148:fd96258d940d 88 #define BLE_UUID_GAP_CHARACTERISTIC_APPEARANCE 0x2A01 /**< Appearance Characteristic. */
Kojto 148:fd96258d940d 89 #define BLE_UUID_GAP_CHARACTERISTIC_PPF 0x2A02 /**< Peripheral Privacy Flag Characteristic. */
Kojto 148:fd96258d940d 90 #define BLE_UUID_GAP_CHARACTERISTIC_RECONN_ADDR 0x2A03 /**< Reconnection Address Characteristic. */
Kojto 148:fd96258d940d 91 #define BLE_UUID_GAP_CHARACTERISTIC_PPCP 0x2A04 /**< Peripheral Preferred Connection Parameters Characteristic. */
Kojto 148:fd96258d940d 92 /** @} */
Kojto 148:fd96258d940d 93
Kojto 148:fd96258d940d 94
Kojto 148:fd96258d940d 95 /** @defgroup BLE_UUID_TYPES Types of UUID
Kojto 148:fd96258d940d 96 * @{ */
Kojto 148:fd96258d940d 97 #define BLE_UUID_TYPE_UNKNOWN 0x00 /**< Invalid UUID type. */
Kojto 148:fd96258d940d 98 #define BLE_UUID_TYPE_BLE 0x01 /**< Bluetooth SIG UUID (16-bit). */
Kojto 148:fd96258d940d 99 #define BLE_UUID_TYPE_VENDOR_BEGIN 0x02 /**< Vendor UUID types start at this index (128-bit). */
Kojto 148:fd96258d940d 100 /** @} */
Kojto 148:fd96258d940d 101
Kojto 148:fd96258d940d 102
Kojto 148:fd96258d940d 103 /** @defgroup BLE_APPEARANCES Bluetooth Appearance values
Kojto 148:fd96258d940d 104 * @note Retrieved from http://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.gap.appearance.xml
Kojto 148:fd96258d940d 105 * @{ */
Kojto 148:fd96258d940d 106 #define BLE_APPEARANCE_UNKNOWN 0 /**< Unknown. */
Kojto 148:fd96258d940d 107 #define BLE_APPEARANCE_GENERIC_PHONE 64 /**< Generic Phone. */
Kojto 148:fd96258d940d 108 #define BLE_APPEARANCE_GENERIC_COMPUTER 128 /**< Generic Computer. */
Kojto 148:fd96258d940d 109 #define BLE_APPEARANCE_GENERIC_WATCH 192 /**< Generic Watch. */
Kojto 148:fd96258d940d 110 #define BLE_APPEARANCE_WATCH_SPORTS_WATCH 193 /**< Watch: Sports Watch. */
Kojto 148:fd96258d940d 111 #define BLE_APPEARANCE_GENERIC_CLOCK 256 /**< Generic Clock. */
Kojto 148:fd96258d940d 112 #define BLE_APPEARANCE_GENERIC_DISPLAY 320 /**< Generic Display. */
Kojto 148:fd96258d940d 113 #define BLE_APPEARANCE_GENERIC_REMOTE_CONTROL 384 /**< Generic Remote Control. */
Kojto 148:fd96258d940d 114 #define BLE_APPEARANCE_GENERIC_EYE_GLASSES 448 /**< Generic Eye-glasses. */
Kojto 148:fd96258d940d 115 #define BLE_APPEARANCE_GENERIC_TAG 512 /**< Generic Tag. */
Kojto 148:fd96258d940d 116 #define BLE_APPEARANCE_GENERIC_KEYRING 576 /**< Generic Keyring. */
Kojto 148:fd96258d940d 117 #define BLE_APPEARANCE_GENERIC_MEDIA_PLAYER 640 /**< Generic Media Player. */
Kojto 148:fd96258d940d 118 #define BLE_APPEARANCE_GENERIC_BARCODE_SCANNER 704 /**< Generic Barcode Scanner. */
Kojto 148:fd96258d940d 119 #define BLE_APPEARANCE_GENERIC_THERMOMETER 768 /**< Generic Thermometer. */
Kojto 148:fd96258d940d 120 #define BLE_APPEARANCE_THERMOMETER_EAR 769 /**< Thermometer: Ear. */
Kojto 148:fd96258d940d 121 #define BLE_APPEARANCE_GENERIC_HEART_RATE_SENSOR 832 /**< Generic Heart rate Sensor. */
Kojto 148:fd96258d940d 122 #define BLE_APPEARANCE_HEART_RATE_SENSOR_HEART_RATE_BELT 833 /**< Heart Rate Sensor: Heart Rate Belt. */
Kojto 148:fd96258d940d 123 #define BLE_APPEARANCE_GENERIC_BLOOD_PRESSURE 896 /**< Generic Blood Pressure. */
Kojto 148:fd96258d940d 124 #define BLE_APPEARANCE_BLOOD_PRESSURE_ARM 897 /**< Blood Pressure: Arm. */
Kojto 148:fd96258d940d 125 #define BLE_APPEARANCE_BLOOD_PRESSURE_WRIST 898 /**< Blood Pressure: Wrist. */
Kojto 148:fd96258d940d 126 #define BLE_APPEARANCE_GENERIC_HID 960 /**< Human Interface Device (HID). */
Kojto 148:fd96258d940d 127 #define BLE_APPEARANCE_HID_KEYBOARD 961 /**< Keyboard (HID Subtype). */
Kojto 148:fd96258d940d 128 #define BLE_APPEARANCE_HID_MOUSE 962 /**< Mouse (HID Subtype). */
Kojto 148:fd96258d940d 129 #define BLE_APPEARANCE_HID_JOYSTICK 963 /**< Joystiq (HID Subtype). */
Kojto 148:fd96258d940d 130 #define BLE_APPEARANCE_HID_GAMEPAD 964 /**< Gamepad (HID Subtype). */
Kojto 148:fd96258d940d 131 #define BLE_APPEARANCE_HID_DIGITIZERSUBTYPE 965 /**< Digitizer Tablet (HID Subtype). */
Kojto 148:fd96258d940d 132 #define BLE_APPEARANCE_HID_CARD_READER 966 /**< Card Reader (HID Subtype). */
Kojto 148:fd96258d940d 133 #define BLE_APPEARANCE_HID_DIGITAL_PEN 967 /**< Digital Pen (HID Subtype). */
Kojto 148:fd96258d940d 134 #define BLE_APPEARANCE_HID_BARCODE 968 /**< Barcode Scanner (HID Subtype). */
Kojto 148:fd96258d940d 135 #define BLE_APPEARANCE_GENERIC_GLUCOSE_METER 1024 /**< Generic Glucose Meter. */
Kojto 148:fd96258d940d 136 #define BLE_APPEARANCE_GENERIC_RUNNING_WALKING_SENSOR 1088 /**< Generic Running Walking Sensor. */
Kojto 148:fd96258d940d 137 #define BLE_APPEARANCE_RUNNING_WALKING_SENSOR_IN_SHOE 1089 /**< Running Walking Sensor: In-Shoe. */
Kojto 148:fd96258d940d 138 #define BLE_APPEARANCE_RUNNING_WALKING_SENSOR_ON_SHOE 1090 /**< Running Walking Sensor: On-Shoe. */
Kojto 148:fd96258d940d 139 #define BLE_APPEARANCE_RUNNING_WALKING_SENSOR_ON_HIP 1091 /**< Running Walking Sensor: On-Hip. */
Kojto 148:fd96258d940d 140 #define BLE_APPEARANCE_GENERIC_CYCLING 1152 /**< Generic Cycling. */
Kojto 148:fd96258d940d 141 #define BLE_APPEARANCE_CYCLING_CYCLING_COMPUTER 1153 /**< Cycling: Cycling Computer. */
Kojto 148:fd96258d940d 142 #define BLE_APPEARANCE_CYCLING_SPEED_SENSOR 1154 /**< Cycling: Speed Sensor. */
Kojto 148:fd96258d940d 143 #define BLE_APPEARANCE_CYCLING_CADENCE_SENSOR 1155 /**< Cycling: Cadence Sensor. */
Kojto 148:fd96258d940d 144 #define BLE_APPEARANCE_CYCLING_POWER_SENSOR 1156 /**< Cycling: Power Sensor. */
Kojto 148:fd96258d940d 145 #define BLE_APPEARANCE_CYCLING_SPEED_CADENCE_SENSOR 1157 /**< Cycling: Speed and Cadence Sensor. */
Kojto 148:fd96258d940d 146 #define BLE_APPEARANCE_GENERIC_PULSE_OXIMETER 3136 /**< Generic Pulse Oximeter. */
Kojto 148:fd96258d940d 147 #define BLE_APPEARANCE_PULSE_OXIMETER_FINGERTIP 3137 /**< Fingertip (Pulse Oximeter subtype). */
Kojto 148:fd96258d940d 148 #define BLE_APPEARANCE_PULSE_OXIMETER_WRIST_WORN 3138 /**< Wrist Worn(Pulse Oximeter subtype). */
Kojto 148:fd96258d940d 149 #define BLE_APPEARANCE_GENERIC_WEIGHT_SCALE 3200 /**< Generic Weight Scale. */
Kojto 148:fd96258d940d 150 #define BLE_APPEARANCE_GENERIC_OUTDOOR_SPORTS_ACT 5184 /**< Generic Outdoor Sports Activity. */
Kojto 148:fd96258d940d 151 #define BLE_APPEARANCE_OUTDOOR_SPORTS_ACT_LOC_DISP 5185 /**< Location Display Device (Outdoor Sports Activity subtype). */
Kojto 148:fd96258d940d 152 #define BLE_APPEARANCE_OUTDOOR_SPORTS_ACT_LOC_AND_NAV_DISP 5186 /**< Location and Navigation Display Device (Outdoor Sports Activity subtype). */
Kojto 148:fd96258d940d 153 #define BLE_APPEARANCE_OUTDOOR_SPORTS_ACT_LOC_POD 5187 /**< Location Pod (Outdoor Sports Activity subtype). */
Kojto 148:fd96258d940d 154 #define BLE_APPEARANCE_OUTDOOR_SPORTS_ACT_LOC_AND_NAV_POD 5188 /**< Location and Navigation Pod (Outdoor Sports Activity subtype). */
Kojto 148:fd96258d940d 155 /** @} */
Kojto 148:fd96258d940d 156
Kojto 148:fd96258d940d 157 /** @brief Set .type and .uuid fields of ble_uuid_struct to specified uuid value. */
Kojto 148:fd96258d940d 158 #define BLE_UUID_BLE_ASSIGN(instance, value) do {\
Kojto 148:fd96258d940d 159 instance.type = BLE_UUID_TYPE_BLE; \
Kojto 148:fd96258d940d 160 instance.uuid = value;} while(0)
Kojto 148:fd96258d940d 161
Kojto 148:fd96258d940d 162 /** @brief Copy type and uuid members from src to dst ble_uuid_t pointer. Both pointers must be valid/non-null. */
Kojto 148:fd96258d940d 163 #define BLE_UUID_COPY_PTR(dst, src) do {\
Kojto 148:fd96258d940d 164 (dst)->type = (src)->type; \
Kojto 148:fd96258d940d 165 (dst)->uuid = (src)->uuid;} while(0)
Kojto 148:fd96258d940d 166
Kojto 148:fd96258d940d 167 /** @brief Copy type and uuid members from src to dst ble_uuid_t struct. */
Kojto 148:fd96258d940d 168 #define BLE_UUID_COPY_INST(dst, src) do {\
Kojto 148:fd96258d940d 169 (dst).type = (src).type; \
Kojto 148:fd96258d940d 170 (dst).uuid = (src).uuid;} while(0)
Kojto 148:fd96258d940d 171
Kojto 148:fd96258d940d 172 /** @brief Compare for equality both type and uuid members of two (valid, non-null) ble_uuid_t pointers. */
Kojto 148:fd96258d940d 173 #define BLE_UUID_EQ(p_uuid1, p_uuid2) \
Kojto 148:fd96258d940d 174 (((p_uuid1)->type == (p_uuid2)->type) && ((p_uuid1)->uuid == (p_uuid2)->uuid))
Kojto 148:fd96258d940d 175
Kojto 148:fd96258d940d 176 /** @brief Compare for difference both type and uuid members of two (valid, non-null) ble_uuid_t pointers. */
Kojto 148:fd96258d940d 177 #define BLE_UUID_NEQ(p_uuid1, p_uuid2) \
Kojto 148:fd96258d940d 178 (((p_uuid1)->type != (p_uuid2)->type) || ((p_uuid1)->uuid != (p_uuid2)->uuid))
Kojto 148:fd96258d940d 179
Kojto 148:fd96258d940d 180 /** @} */
Kojto 148:fd96258d940d 181
Kojto 148:fd96258d940d 182 /** @addtogroup BLE_TYPES_STRUCTURES Structures
Kojto 148:fd96258d940d 183 * @{ */
Kojto 148:fd96258d940d 184
Kojto 148:fd96258d940d 185 /** @brief 128 bit UUID values. */
Kojto 148:fd96258d940d 186 typedef struct
Kojto 148:fd96258d940d 187 {
Kojto 148:fd96258d940d 188 uint8_t uuid128[16]; /**< Little-Endian UUID bytes. */
Kojto 148:fd96258d940d 189 } ble_uuid128_t;
Kojto 148:fd96258d940d 190
Kojto 148:fd96258d940d 191 /** @brief Bluetooth Low Energy UUID type, encapsulates both 16-bit and 128-bit UUIDs. */
Kojto 148:fd96258d940d 192 typedef struct
Kojto 148:fd96258d940d 193 {
Kojto 148:fd96258d940d 194 uint16_t uuid; /**< 16-bit UUID value or octets 12-13 of 128-bit UUID. */
Kojto 148:fd96258d940d 195 uint8_t type; /**< UUID type, see @ref BLE_UUID_TYPES. If type is @ref BLE_UUID_TYPE_UNKNOWN, the value of uuid is undefined. */
Kojto 148:fd96258d940d 196 } ble_uuid_t;
Kojto 148:fd96258d940d 197
Kojto 148:fd96258d940d 198 /** @} */
Kojto 148:fd96258d940d 199 #ifdef __cplusplus
Kojto 148:fd96258d940d 200 }
Kojto 148:fd96258d940d 201 #endif
Kojto 148:fd96258d940d 202
Kojto 148:fd96258d940d 203 #endif /* NRF_BLE_TYPES_H__ */
Kojto 148:fd96258d940d 204
Kojto 148:fd96258d940d 205 /**
Kojto 148:fd96258d940d 206 @}
Kojto 148:fd96258d940d 207 @}
Kojto 148:fd96258d940d 208 */