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