Microbug / nRF51822_FOTA

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.

Fork of nRF51822 by Nordic Semiconductor

nordic-sdk/components/softdevice/s110/headers/ble_types.h@112:737b08b3b995, 2015-04-30 (annotated)

Committer:
rgrover1
Date:
Thu Apr 30 08:34:37 2015 +0100
Revision:
112:737b08b3b995
Parent:
103:138bdc859cc9 
Synchronized with git rev 4ae92f89

Author: Rohit Grover

porting to v8.0 of the SDK

Who changed what in which revision?

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