1 /* 2 * Copyright (C) 2014 BlueKitchen GmbH 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. Neither the name of the copyright holders nor the names of 14 * contributors may be used to endorse or promote products derived 15 * from this software without specific prior written permission. 16 * 4. Any redistribution, use, or modification is done solely for 17 * personal benefit and not for any commercial purpose or for 18 * monetary gain. 19 * 20 * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS 24 * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 26 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 27 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 28 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 29 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 30 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * Please inquire about commercial licensing options at 34 * [email protected] 35 * 36 */ 37 38 /* 39 * btstack_util.h 40 * 41 * General utility functions 42 * 43 * Created by Matthias Ringwald on 7/23/09. 44 */ 45 46 #ifndef BTSTACK_UTIL_H 47 #define BTSTACK_UTIL_H 48 49 50 #if defined __cplusplus 51 extern "C" { 52 #endif 53 54 #include <stdint.h> 55 #include <string.h> 56 57 #include "bluetooth.h" 58 #include "btstack_defines.h" 59 #include "btstack_linked_list.h" 60 61 // hack: compilation with the android ndk causes an error as there's a reverse_64 macro 62 #ifdef reverse_64 63 #undef reverse_64 64 #endif 65 66 // will be moved to daemon/btstack_device_name_db.h 67 68 69 /** 70 * @brief The device name type 71 */ 72 #define DEVICE_NAME_LEN 248 73 typedef uint8_t device_name_t[DEVICE_NAME_LEN+1]; 74 75 /* API_START */ 76 77 /** 78 * @brief Minimum function for uint32_t 79 * @param a 80 * @param b 81 * @return value 82 */ 83 uint32_t btstack_min(uint32_t a, uint32_t b); 84 85 /** 86 * @brief Maximum function for uint32_t 87 * @param a 88 * @param b 89 * @return value 90 */ 91 uint32_t btstack_max(uint32_t a, uint32_t b); 92 93 94 /** 95 * @brief Read 16/24/32 bit little endian value from buffer 96 * @param buffer 97 * @param position in buffer 98 * @return value 99 */ 100 uint16_t little_endian_read_16(const uint8_t * buffer, int position); 101 uint32_t little_endian_read_24(const uint8_t * buffer, int position); 102 uint32_t little_endian_read_32(const uint8_t * buffer, int position); 103 104 /** 105 * @brief Write 16/32 bit little endian value into buffer 106 * @param buffer 107 * @param position in buffer 108 * @param value 109 */ 110 void little_endian_store_16(uint8_t *buffer, uint16_t position, uint16_t value); 111 void little_endian_store_24(uint8_t *buffer, uint16_t position, uint32_t value); 112 void little_endian_store_32(uint8_t *buffer, uint16_t position, uint32_t value); 113 114 /** 115 * @brief Read 16/24/32 bit big endian value from buffer 116 * @param buffer 117 * @param position in buffer 118 * @return value 119 */ 120 uint32_t big_endian_read_16( const uint8_t * buffer, int pos); 121 uint32_t big_endian_read_24( const uint8_t * buffer, int pos); 122 uint32_t big_endian_read_32( const uint8_t * buffer, int pos); 123 124 /** 125 * @brief Write 16/32 bit big endian value into buffer 126 * @param buffer 127 * @param position in buffer 128 * @param value 129 */ 130 void big_endian_store_16(uint8_t *buffer, uint16_t pos, uint16_t value); 131 void big_endian_store_24(uint8_t *buffer, uint16_t pos, uint32_t value); 132 void big_endian_store_32(uint8_t *buffer, uint16_t pos, uint32_t value); 133 134 135 /** 136 * @brief Swap bytes in 16 bit integer 137 */ 138 static inline uint16_t btstack_flip_16(uint16_t value){ 139 return (uint16_t)((value & 0xff) << 8) | (value >> 8); 140 } 141 142 /** 143 * @brief Check for big endian system 144 * @returns 1 if on big endian 145 */ 146 static inline int btstack_is_big_endian(void){ 147 uint16_t sample = 0x0100; 148 return *(uint8_t*) &sample; 149 } 150 151 /** 152 * @brief Check for little endian system 153 * @returns 1 if on little endian 154 */ 155 static inline int btstack_is_little_endian(void){ 156 uint16_t sample = 0x0001; 157 return *(uint8_t*) &sample; 158 } 159 160 /** 161 * @brief Copy from source to destination and reverse byte order 162 * @param src 163 * @param dest 164 * @param len 165 */ 166 void reverse_bytes (const uint8_t *src, uint8_t * dest, int len); 167 168 /** 169 * @brief Wrapper around reverse_bytes for common buffer sizes 170 * @param src 171 * @param dest 172 */ 173 void reverse_24 (const uint8_t *src, uint8_t * dest); 174 void reverse_48 (const uint8_t *src, uint8_t * dest); 175 void reverse_56 (const uint8_t *src, uint8_t * dest); 176 void reverse_64 (const uint8_t *src, uint8_t * dest); 177 void reverse_128(const uint8_t *src, uint8_t * dest); 178 void reverse_256(const uint8_t *src, uint8_t * dest); 179 180 void reverse_bd_addr(const bd_addr_t src, bd_addr_t dest); 181 182 /** 183 * @brief ASCII character for 4-bit nibble 184 * @return character 185 */ 186 char char_for_nibble(int nibble); 187 188 /** 189 * @brif 4-bit nibble from ASCII character 190 * @return value 191 */ 192 int nibble_for_char(char c); 193 194 /** 195 * @brief Compare two Bluetooth addresses 196 * @param a 197 * @param b 198 * @return 0 if equal 199 */ 200 int bd_addr_cmp(const bd_addr_t a, const bd_addr_t b); 201 202 /** 203 * @brief Copy Bluetooth address 204 * @param dest 205 * @param src 206 */ 207 void bd_addr_copy(bd_addr_t dest, const bd_addr_t src); 208 209 /** 210 * @brief Use printf to write hexdump as single line of data 211 */ 212 void printf_hexdump(const void *data, int size); 213 214 /** 215 * @brief Create human readable representation for UUID128 216 * @note uses fixed global buffer 217 * @return pointer to UUID128 string 218 */ 219 char * uuid128_to_str(const uint8_t * uuid); 220 221 /** 222 * @brief Create human readable represenationt of Bluetooth address 223 * @note uses fixed global buffer 224 * @return pointer to Bluetooth address string 225 */ 226 char * bd_addr_to_str(const bd_addr_t addr); 227 228 /** 229 * @brief Parse Bluetooth address 230 * @param address_string 231 * @param buffer for parsed address 232 * @return 1 if string was parsed successfully 233 */ 234 int sscanf_bd_addr(const char * addr_string, bd_addr_t addr); 235 236 /** 237 * @brief Constructs UUID128 from 16 or 32 bit UUID using Bluetooth base UUID 238 * @param uuid128 output buffer 239 * @param short_uuid 240 */ 241 void uuid_add_bluetooth_prefix(uint8_t * uuid128, uint32_t short_uuid); 242 243 /** 244 * @brief Checks if UUID128 has Bluetooth base UUID prefix 245 * @param uui128 to test 246 * @return 1 if it can be expressed as UUID32 247 */ 248 int uuid_has_bluetooth_prefix(const uint8_t * uuid128); 249 250 /** 251 * @brief Parse unsigned number 252 * @param str to parse 253 * @return value 254 */ 255 uint32_t btstack_atoi(const char *str); 256 257 /** 258 * @brief Return number of digits of a uint32 number 259 * @param uint32_number 260 * @return num_digits 261 */ 262 int string_len_for_uint32(uint32_t i); 263 264 /** 265 * @brief Return number of set bits in a uint32 number 266 * @param uint32_number 267 * @return num_set_bits 268 */ 269 int count_set_bits_uint32(uint32_t x); 270 271 /** 272 * CRC8 functions using ETSI TS 101 369 V6.3.0. 273 * Only used by RFCOMM 274 */ 275 uint8_t btstack_crc8_check(uint8_t *data, uint16_t len, uint8_t check_sum); 276 uint8_t btstack_crc8_calc(uint8_t *data, uint16_t len); 277 278 /* API_END */ 279 280 #if defined __cplusplus 281 } 282 #endif 283 284 #endif // BTSTACK_UTIL_H 285