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 swap64 macro 62 #ifdef swap64 63 #undef swap64 64 #endif 65 66 // will be moved to daemon/btstack_device_name_db.h 67 68 /** 69 * @brief The device name type 70 */ 71 #define DEVICE_NAME_LEN 248 72 typedef uint8_t device_name_t[DEVICE_NAME_LEN+1]; 73 74 75 76 /** 77 * @brief Read 16/24/32 bit little endian value from buffer 78 * @param buffer 79 * @param position in buffer 80 * @return value 81 */ 82 uint16_t little_endian_read_16(const uint8_t * buffer, int position); 83 uint32_t little_endian_read_24(const uint8_t * buffer, int position); 84 uint32_t little_endian_read_32(const uint8_t * buffer, int position); 85 86 /** 87 * @brief Write 16/32 bit little endian value into buffer 88 * @param buffer 89 * @param position in buffer 90 * @param value 91 */ 92 void little_endian_store_16(uint8_t *buffer, uint16_t position, uint16_t value); 93 void little_endian_store_32(uint8_t *buffer, uint16_t position, uint32_t value); 94 95 /** 96 * @brief Read 16/24/32 bit big endian value from buffer 97 * @param buffer 98 * @param position in buffer 99 * @return value 100 */ 101 uint32_t big_endian_read_16( const uint8_t * buffer, int pos); 102 uint32_t big_endian_read_32( const uint8_t * buffer, int pos); 103 104 /** 105 * @brief Write 16/32 bit big endian value into buffer 106 * @param buffer 107 * @param position in buffer 108 * @param value 109 */ 110 void big_endian_store_16(uint8_t *buffer, uint16_t pos, uint16_t value); 111 void big_endian_store_32(uint8_t *buffer, uint16_t pos, uint32_t value); 112 113 /** 114 * @brief Copy from source to destination and reverse byte order 115 */ 116 void swapX (const uint8_t *src, uint8_t * dst, int len); 117 void swap24 (const uint8_t *src, uint8_t * dst); 118 void swap48 (const uint8_t *src, uint8_t * dst); 119 void swap56 (const uint8_t *src, uint8_t * dst); 120 void swap64 (const uint8_t *src, uint8_t * dst); 121 void swap128(const uint8_t *src, uint8_t * dst); 122 void bt_flip_addr(bd_addr_t dest, bd_addr_t src); 123 124 /** 125 * @brief 4-bit nibble 126 * @return ASCII character for 4-bit nibble 127 */ 128 char char_for_nibble(int nibble); 129 130 /** 131 * @brief Compare two Bluetooth addresses 132 * @param a 133 * @param b 134 * @return true if equal 135 */ 136 int bd_addr_cmp(bd_addr_t a, bd_addr_t b); 137 138 /** 139 * @brief Copy Bluetooth address 140 * @param dest 141 * @param src 142 */ 143 void bd_addr_copy(bd_addr_t dest, bd_addr_t src); 144 145 /** 146 * @brief Use printf to write hexdump as single line of data 147 */ 148 void printf_hexdump(const void *data, int size); 149 150 // move to btstack_debug.h 151 // void log_info_hexdump(..) either log or hci_dump or off 152 void log_key(const char * name, sm_key_t key); 153 154 // 155 void hexdump(const void *data, int size); 156 void hexdumpf(const void *data, int size); 157 158 /** 159 * @brief Create human readable representation for UUID128 160 * @note uses fixed global buffer 161 * @return pointer to UUID128 string 162 */ 163 char * uuid128_to_str(uint8_t * uuid); 164 165 /** 166 * @brief Create human readable represenationt of Bluetooth address 167 * @note uses fixed global buffer 168 * @return pointer to Bluetooth address string 169 */ 170 char * bd_addr_to_str(bd_addr_t addr); 171 172 /** 173 * @brief Parse Bluetooth address 174 * @param address_string 175 * @param buffer for parsed address 176 * @return 1 if string was parsed successfully 177 */ 178 int sscanf_bd_addr(uint8_t * addr_string, bd_addr_t addr); 179 180 /** 181 * @brief Constructs UUID128 from 16 or 32 bit UUID using Bluetooth base UUID 182 * @param uuid128 output buffer 183 * @param short_uuid 184 */ 185 void uuid_add_bluetooth_prefix(uint8_t * uuid128, uint32_t short_uuid); 186 187 /** 188 * @brief Checks if UUID128 has Bluetooth base UUID prefix 189 * @param uui128 to test 190 * @return 1 if it can be expressed as UUID32 191 */ 192 int uuid_has_bluetooth_prefix(uint8_t * uuid128); 193 194 #if defined __cplusplus 195 } 196 #endif 197 198 #endif // __BTSTACK_UTIL_H 199