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_32(uint8_t *buffer, uint16_t position, uint32_t value); 112 113 /** 114 * @brief Read 16/24/32 bit big endian value from buffer 115 * @param buffer 116 * @param position in buffer 117 * @return value 118 */ 119 uint32_t big_endian_read_16( const uint8_t * buffer, int pos); 120 uint32_t big_endian_read_32( const uint8_t * buffer, int pos); 121 122 /** 123 * @brief Write 16/32 bit big endian value into buffer 124 * @param buffer 125 * @param position in buffer 126 * @param value 127 */ 128 void big_endian_store_16(uint8_t *buffer, uint16_t pos, uint16_t value); 129 void big_endian_store_32(uint8_t *buffer, uint16_t pos, uint32_t value); 130 131 /** 132 * @brief Copy from source to destination and reverse byte order 133 * @param src 134 * @param dest 135 * @param len 136 */ 137 void reverse_bytes (const uint8_t *src, uint8_t * dest, int len); 138 139 /** 140 * @brief Wrapper around reverse_bytes for common buffer sizes 141 * @param src 142 * @param dest 143 */ 144 void reverse_24 (const uint8_t *src, uint8_t * dest); 145 void reverse_48 (const uint8_t *src, uint8_t * dest); 146 void reverse_56 (const uint8_t *src, uint8_t * dest); 147 void reverse_64 (const uint8_t *src, uint8_t * dest); 148 void reverse_128(const uint8_t *src, uint8_t * dest); 149 void reverse_256(const uint8_t *src, uint8_t * dest); 150 151 void reverse_bd_addr(const bd_addr_t src, bd_addr_t dest); 152 153 /** 154 * @brief ASCII character for 4-bit nibble 155 * @return character 156 */ 157 char char_for_nibble(int nibble); 158 159 /** 160 * @brif 4-bit nibble from ASCII character 161 * @return value 162 */ 163 int nibble_for_char(char c); 164 165 /** 166 * @brief Compare two Bluetooth addresses 167 * @param a 168 * @param b 169 * @return true if equal 170 */ 171 int bd_addr_cmp(bd_addr_t a, bd_addr_t b); 172 173 /** 174 * @brief Copy Bluetooth address 175 * @param dest 176 * @param src 177 */ 178 void bd_addr_copy(bd_addr_t dest, bd_addr_t src); 179 180 /** 181 * @brief Use printf to write hexdump as single line of data 182 */ 183 void printf_hexdump(const void *data, int size); 184 185 /** 186 * @brief Create human readable representation for UUID128 187 * @note uses fixed global buffer 188 * @return pointer to UUID128 string 189 */ 190 char * uuid128_to_str(uint8_t * uuid); 191 192 /** 193 * @brief Create human readable represenationt of Bluetooth address 194 * @note uses fixed global buffer 195 * @return pointer to Bluetooth address string 196 */ 197 char * bd_addr_to_str(bd_addr_t addr); 198 199 /** 200 * @brief Parse Bluetooth address 201 * @param address_string 202 * @param buffer for parsed address 203 * @return 1 if string was parsed successfully 204 */ 205 int sscanf_bd_addr(const char * addr_string, bd_addr_t addr); 206 207 /** 208 * @brief Constructs UUID128 from 16 or 32 bit UUID using Bluetooth base UUID 209 * @param uuid128 output buffer 210 * @param short_uuid 211 */ 212 void uuid_add_bluetooth_prefix(uint8_t * uuid128, uint32_t short_uuid); 213 214 /** 215 * @brief Checks if UUID128 has Bluetooth base UUID prefix 216 * @param uui128 to test 217 * @return 1 if it can be expressed as UUID32 218 */ 219 int uuid_has_bluetooth_prefix(uint8_t * uuid128); 220 221 /** 222 * @brief Parse unsigned number 223 * @param str to parse 224 * @return value 225 */ 226 uint32_t btstack_atoi(const char *str); 227 228 /* API_END */ 229 230 #if defined __cplusplus 231 } 232 #endif 233 234 #endif // __BTSTACK_UTIL_H 235