ble_types.h

00001 /* 
00002  * Copyright (c) Nordic Semiconductor ASA
00003  * All rights reserved.
00004  * 
00005  * Redistribution and use in source and binary forms, with or without modification,
00006  * are permitted provided that the following conditions are met:
00007  * 
00008  *   1. Redistributions of source code must retain the above copyright notice, this
00009  *   list of conditions and the following disclaimer.
00010  * 
00011  *   2. Redistributions in binary form must reproduce the above copyright notice, this
00012  *   list of conditions and the following disclaimer in the documentation and/or
00013  *   other materials provided with the distribution.
00014  * 
00015  *   3. Neither the name of Nordic Semiconductor ASA nor the names of other
00016  *   contributors to this software may be used to endorse or promote products
00017  *   derived from this software without specific prior written permission.
00018  * 
00019  *   4. This software must only be used in a processor manufactured by Nordic
00020  *   Semiconductor ASA, or in a processor manufactured by a third party that
00021  *   is used in combination with a processor manufactured by Nordic Semiconductor.
00022  * 
00023  * 
00024  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
00025  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
00026  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00027  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
00028  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
00029  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00030  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
00031  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00032  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00033  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00034  * 
00035  */
00036 
00037 /**
00038   @addtogroup BLE_COMMON
00039   @{
00040   @defgroup ble_types Common types and macro definitions
00041   @{
00042 
00043   @brief Common types and macro definitions for the BLE SoftDevice.
00044  */
00045 
00046 #ifndef BLE_TYPES_H__
00047 #define BLE_TYPES_H__
00048 
00049 #include <stdint.h>
00050 
00051 #ifdef __cplusplus
00052 extern "C" {
00053 #endif
00054 
00055 /** @addtogroup BLE_TYPES_DEFINES Defines
00056  * @{ */
00057 
00058 /** @defgroup BLE_CONN_HANDLES BLE Connection Handles
00059  * @{ */
00060 #define BLE_CONN_HANDLE_INVALID 0xFFFF  /**< Invalid Connection Handle. */
00061 #define BLE_CONN_HANDLE_ALL     0xFFFE  /**< Applies to all Connection Handles. */
00062 /** @} */
00063 
00064 
00065 /** @defgroup BLE_UUID_VALUES Assigned Values for BLE UUIDs
00066  * @{ */
00067 /* Generic UUIDs, applicable to all services */
00068 #define BLE_UUID_UNKNOWN                              0x0000 /**< Reserved UUID. */
00069 #define BLE_UUID_SERVICE_PRIMARY                      0x2800 /**< Primary Service. */
00070 #define BLE_UUID_SERVICE_SECONDARY                    0x2801 /**< Secondary Service. */
00071 #define BLE_UUID_SERVICE_INCLUDE                      0x2802 /**< Include. */
00072 #define BLE_UUID_CHARACTERISTIC                       0x2803 /**< Characteristic. */
00073 #define BLE_UUID_DESCRIPTOR_CHAR_EXT_PROP             0x2900 /**< Characteristic Extended Properties Descriptor. */
00074 #define BLE_UUID_DESCRIPTOR_CHAR_USER_DESC            0x2901 /**< Characteristic User Description Descriptor. */
00075 #define BLE_UUID_DESCRIPTOR_CLIENT_CHAR_CONFIG        0x2902 /**< Client Characteristic Configuration Descriptor. */
00076 #define BLE_UUID_DESCRIPTOR_SERVER_CHAR_CONFIG        0x2903 /**< Server Characteristic Configuration Descriptor. */
00077 #define BLE_UUID_DESCRIPTOR_CHAR_PRESENTATION_FORMAT  0x2904 /**< Characteristic Presentation Format Descriptor. */
00078 #define BLE_UUID_DESCRIPTOR_CHAR_AGGREGATE_FORMAT     0x2905 /**< Characteristic Aggregate Format Descriptor. */
00079 /* GATT specific UUIDs */
00080 #define BLE_UUID_GATT                                 0x1801 /**< Generic Attribute Profile. */
00081 #define BLE_UUID_GATT_CHARACTERISTIC_SERVICE_CHANGED  0x2A05 /**< Service Changed Characteristic. */
00082 /* GAP specific UUIDs */
00083 #define BLE_UUID_GAP                                  0x1800 /**< Generic Access Profile. */
00084 #define BLE_UUID_GAP_CHARACTERISTIC_DEVICE_NAME       0x2A00 /**< Device Name Characteristic. */
00085 #define BLE_UUID_GAP_CHARACTERISTIC_APPEARANCE        0x2A01 /**< Appearance Characteristic. */
00086 #define BLE_UUID_GAP_CHARACTERISTIC_PPF               0x2A02 /**< Peripheral Privacy Flag Characteristic. */
00087 #define BLE_UUID_GAP_CHARACTERISTIC_RECONN_ADDR       0x2A03 /**< Reconnection Address Characteristic. */
00088 #define BLE_UUID_GAP_CHARACTERISTIC_PPCP              0x2A04 /**< Peripheral Preferred Connection Parameters Characteristic. */
00089 /** @} */
00090 
00091 
00092 /** @defgroup BLE_UUID_TYPES Types of UUID
00093  * @{ */
00094 #define BLE_UUID_TYPE_UNKNOWN       0x00 /**< Invalid UUID type. */
00095 #define BLE_UUID_TYPE_BLE           0x01 /**< Bluetooth SIG UUID (16-bit). */
00096 #define BLE_UUID_TYPE_VENDOR_BEGIN  0x02 /**< Vendor UUID types start at this index (128-bit). */
00097 /** @} */
00098 
00099 
00100 /** @defgroup BLE_APPEARANCES Bluetooth Appearance values
00101  *  @note Retrieved from http://developer.bluetooth.org/gatt/characteristics/Pages/CharacteristicViewer.aspx?u=org.bluetooth.characteristic.gap.appearance.xml
00102  * @{ */
00103 #define BLE_APPEARANCE_UNKNOWN                                0 /**< Unknown. */
00104 #define BLE_APPEARANCE_GENERIC_PHONE                         64 /**< Generic Phone. */
00105 #define BLE_APPEARANCE_GENERIC_COMPUTER                     128 /**< Generic Computer. */
00106 #define BLE_APPEARANCE_GENERIC_WATCH                        192 /**< Generic Watch. */
00107 #define BLE_APPEARANCE_WATCH_SPORTS_WATCH                   193 /**< Watch: Sports Watch. */
00108 #define BLE_APPEARANCE_GENERIC_CLOCK                        256 /**< Generic Clock. */
00109 #define BLE_APPEARANCE_GENERIC_DISPLAY                      320 /**< Generic Display. */
00110 #define BLE_APPEARANCE_GENERIC_REMOTE_CONTROL               384 /**< Generic Remote Control. */
00111 #define BLE_APPEARANCE_GENERIC_EYE_GLASSES                  448 /**< Generic Eye-glasses. */
00112 #define BLE_APPEARANCE_GENERIC_TAG                          512 /**< Generic Tag. */
00113 #define BLE_APPEARANCE_GENERIC_KEYRING                      576 /**< Generic Keyring. */
00114 #define BLE_APPEARANCE_GENERIC_MEDIA_PLAYER                 640 /**< Generic Media Player. */
00115 #define BLE_APPEARANCE_GENERIC_BARCODE_SCANNER              704 /**< Generic Barcode Scanner. */
00116 #define BLE_APPEARANCE_GENERIC_THERMOMETER                  768 /**< Generic Thermometer. */
00117 #define BLE_APPEARANCE_THERMOMETER_EAR                      769 /**< Thermometer: Ear. */
00118 #define BLE_APPEARANCE_GENERIC_HEART_RATE_SENSOR            832 /**< Generic Heart rate Sensor. */
00119 #define BLE_APPEARANCE_HEART_RATE_SENSOR_HEART_RATE_BELT    833 /**< Heart Rate Sensor: Heart Rate Belt. */
00120 #define BLE_APPEARANCE_GENERIC_BLOOD_PRESSURE               896 /**< Generic Blood Pressure. */
00121 #define BLE_APPEARANCE_BLOOD_PRESSURE_ARM                   897 /**< Blood Pressure: Arm. */
00122 #define BLE_APPEARANCE_BLOOD_PRESSURE_WRIST                 898 /**< Blood Pressure: Wrist. */
00123 #define BLE_APPEARANCE_GENERIC_HID                          960 /**< Human Interface Device (HID). */
00124 #define BLE_APPEARANCE_HID_KEYBOARD                         961 /**< Keyboard (HID Subtype). */
00125 #define BLE_APPEARANCE_HID_MOUSE                            962 /**< Mouse (HID Subtype). */
00126 #define BLE_APPEARANCE_HID_JOYSTICK                         963 /**< Joystiq (HID Subtype). */
00127 #define BLE_APPEARANCE_HID_GAMEPAD                          964 /**< Gamepad (HID Subtype). */
00128 #define BLE_APPEARANCE_HID_DIGITIZERSUBTYPE                 965 /**< Digitizer Tablet (HID Subtype). */
00129 #define BLE_APPEARANCE_HID_CARD_READER                      966 /**< Card Reader (HID Subtype). */
00130 #define BLE_APPEARANCE_HID_DIGITAL_PEN                      967 /**< Digital Pen (HID Subtype). */
00131 #define BLE_APPEARANCE_HID_BARCODE                          968 /**< Barcode Scanner (HID Subtype). */
00132 #define BLE_APPEARANCE_GENERIC_GLUCOSE_METER               1024 /**< Generic Glucose Meter. */
00133 #define BLE_APPEARANCE_GENERIC_RUNNING_WALKING_SENSOR      1088 /**< Generic Running Walking Sensor. */
00134 #define BLE_APPEARANCE_RUNNING_WALKING_SENSOR_IN_SHOE      1089 /**< Running Walking Sensor: In-Shoe. */
00135 #define BLE_APPEARANCE_RUNNING_WALKING_SENSOR_ON_SHOE      1090 /**< Running Walking Sensor: On-Shoe. */
00136 #define BLE_APPEARANCE_RUNNING_WALKING_SENSOR_ON_HIP       1091 /**< Running Walking Sensor: On-Hip. */
00137 #define BLE_APPEARANCE_GENERIC_CYCLING                     1152 /**< Generic Cycling. */
00138 #define BLE_APPEARANCE_CYCLING_CYCLING_COMPUTER            1153 /**< Cycling: Cycling Computer. */
00139 #define BLE_APPEARANCE_CYCLING_SPEED_SENSOR                1154 /**< Cycling: Speed Sensor. */
00140 #define BLE_APPEARANCE_CYCLING_CADENCE_SENSOR              1155 /**< Cycling: Cadence Sensor. */
00141 #define BLE_APPEARANCE_CYCLING_POWER_SENSOR                1156 /**< Cycling: Power Sensor. */
00142 #define BLE_APPEARANCE_CYCLING_SPEED_CADENCE_SENSOR        1157 /**< Cycling: Speed and Cadence Sensor. */
00143 #define BLE_APPEARANCE_GENERIC_PULSE_OXIMETER              3136 /**< Generic Pulse Oximeter. */
00144 #define BLE_APPEARANCE_PULSE_OXIMETER_FINGERTIP            3137 /**< Fingertip (Pulse Oximeter subtype). */
00145 #define BLE_APPEARANCE_PULSE_OXIMETER_WRIST_WORN           3138 /**< Wrist Worn(Pulse Oximeter subtype). */
00146 #define BLE_APPEARANCE_GENERIC_WEIGHT_SCALE                3200 /**< Generic Weight Scale. */
00147 #define BLE_APPEARANCE_GENERIC_OUTDOOR_SPORTS_ACT          5184 /**< Generic Outdoor Sports Activity. */
00148 #define BLE_APPEARANCE_OUTDOOR_SPORTS_ACT_LOC_DISP         5185 /**< Location Display Device (Outdoor Sports Activity subtype). */
00149 #define BLE_APPEARANCE_OUTDOOR_SPORTS_ACT_LOC_AND_NAV_DISP 5186 /**< Location and Navigation Display Device (Outdoor Sports Activity subtype). */
00150 #define BLE_APPEARANCE_OUTDOOR_SPORTS_ACT_LOC_POD          5187 /**< Location Pod (Outdoor Sports Activity subtype). */
00151 #define BLE_APPEARANCE_OUTDOOR_SPORTS_ACT_LOC_AND_NAV_POD  5188 /**< Location and Navigation Pod (Outdoor Sports Activity subtype). */
00152 /** @} */
00153 
00154 /** @brief Set .type and .uuid fields of ble_uuid_struct to specified uuid value. */
00155 #define BLE_UUID_BLE_ASSIGN(instance, value) do {\
00156             instance.type = BLE_UUID_TYPE_BLE; \
00157             instance.uuid = value;} while(0)
00158 
00159 /** @brief Copy type and uuid members from src to dst ble_uuid_t pointer. Both pointers must be valid/non-null. */
00160 #define BLE_UUID_COPY_PTR(dst, src) do {\
00161             (dst)->type = (src)->type; \
00162             (dst)->uuid = (src)->uuid;} while(0)
00163 
00164 /** @brief Copy type and uuid members from src to dst ble_uuid_t struct. */
00165 #define BLE_UUID_COPY_INST(dst, src) do {\
00166             (dst).type = (src).type; \
00167             (dst).uuid = (src).uuid;} while(0)
00168 
00169 /** @brief Compare for equality both type and uuid members of two (valid, non-null) ble_uuid_t pointers. */
00170 #define BLE_UUID_EQ(p_uuid1, p_uuid2) \
00171             (((p_uuid1)->type == (p_uuid2)->type) && ((p_uuid1)->uuid == (p_uuid2)->uuid))
00172 
00173 /** @brief Compare for difference both type and uuid members of two (valid, non-null) ble_uuid_t pointers. */
00174 #define BLE_UUID_NEQ(p_uuid1, p_uuid2) \
00175             (((p_uuid1)->type != (p_uuid2)->type) || ((p_uuid1)->uuid != (p_uuid2)->uuid))
00176 
00177 /** @} */
00178 
00179 /** @addtogroup BLE_TYPES_STRUCTURES Structures
00180  * @{ */
00181 
00182 /** @brief 128 bit UUID values. */
00183 typedef struct
00184 { 
00185   uint8_t uuid128[16]; /**< Little-Endian UUID bytes. */
00186 } ble_uuid128_t;
00187 
00188 /** @brief  Bluetooth Low Energy UUID type, encapsulates both 16-bit and 128-bit UUIDs. */
00189 typedef struct
00190 {
00191   uint16_t    uuid; /**< 16-bit UUID value or octets 12-13 of 128-bit UUID. */
00192   uint8_t     type; /**< UUID type, see @ref BLE_UUID_TYPES. If type is @ref BLE_UUID_TYPE_UNKNOWN, the value of uuid is undefined. */
00193 } ble_uuid_t;
00194 
00195 /** @} */
00196 #ifdef __cplusplus
00197 }
00198 #endif
00199 
00200 #endif /* BLE_TYPES_H__ */
00201 
00202 /**
00203   @}
00204   @}
00205 */
00206