1eb886013SMatthias Ringwald /* 2eb886013SMatthias Ringwald * Copyright (C) 2014 BlueKitchen GmbH 3eb886013SMatthias Ringwald * 4eb886013SMatthias Ringwald * Redistribution and use in source and binary forms, with or without 5eb886013SMatthias Ringwald * modification, are permitted provided that the following conditions 6eb886013SMatthias Ringwald * are met: 7eb886013SMatthias Ringwald * 8eb886013SMatthias Ringwald * 1. Redistributions of source code must retain the above copyright 9eb886013SMatthias Ringwald * notice, this list of conditions and the following disclaimer. 10eb886013SMatthias Ringwald * 2. Redistributions in binary form must reproduce the above copyright 11eb886013SMatthias Ringwald * notice, this list of conditions and the following disclaimer in the 12eb886013SMatthias Ringwald * documentation and/or other materials provided with the distribution. 13eb886013SMatthias Ringwald * 3. Neither the name of the copyright holders nor the names of 14eb886013SMatthias Ringwald * contributors may be used to endorse or promote products derived 15eb886013SMatthias Ringwald * from this software without specific prior written permission. 16eb886013SMatthias Ringwald * 4. Any redistribution, use, or modification is done solely for 17eb886013SMatthias Ringwald * personal benefit and not for any commercial purpose or for 18eb886013SMatthias Ringwald * monetary gain. 19eb886013SMatthias Ringwald * 20eb886013SMatthias Ringwald * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS 21eb886013SMatthias Ringwald * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22eb886013SMatthias Ringwald * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 23eb886013SMatthias Ringwald * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS 24eb886013SMatthias Ringwald * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 25eb886013SMatthias Ringwald * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 26eb886013SMatthias Ringwald * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 27eb886013SMatthias Ringwald * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 28eb886013SMatthias Ringwald * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 29eb886013SMatthias Ringwald * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 30eb886013SMatthias Ringwald * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31eb886013SMatthias Ringwald * SUCH DAMAGE. 32eb886013SMatthias Ringwald * 33eb886013SMatthias Ringwald * Please inquire about commercial licensing options at 34eb886013SMatthias Ringwald * [email protected] 35eb886013SMatthias Ringwald * 36eb886013SMatthias Ringwald */ 37eb886013SMatthias Ringwald 38eb886013SMatthias Ringwald /* 39eb886013SMatthias Ringwald * btstack_util.h 40eb886013SMatthias Ringwald * 41eb886013SMatthias Ringwald * General utility functions 42eb886013SMatthias Ringwald * 43eb886013SMatthias Ringwald * Created by Matthias Ringwald on 7/23/09. 44eb886013SMatthias Ringwald */ 45eb886013SMatthias Ringwald 46bf1b35bfSMatthias Ringwald #ifndef __BTSTACK_UTIL_H 47bf1b35bfSMatthias Ringwald #define __BTSTACK_UTIL_H 48eb886013SMatthias Ringwald 49eb886013SMatthias Ringwald 50eb886013SMatthias Ringwald #if defined __cplusplus 51eb886013SMatthias Ringwald extern "C" { 52eb886013SMatthias Ringwald #endif 53eb886013SMatthias Ringwald 54eb886013SMatthias Ringwald #include <stdint.h> 55cbabbca4SMatthias Ringwald #include <string.h> 56cbabbca4SMatthias Ringwald 578974fcd6SMatthias Ringwald #include "bluetooth.h" 588974fcd6SMatthias Ringwald #include "btstack_defines.h" 598d471f5cSMatthias Ringwald #include "btstack_linked_list.h" 60eb886013SMatthias Ringwald 61*73988a59SMatthias Ringwald // hack: compilation with the android ndk causes an error as there's a swap64 macro 62*73988a59SMatthias Ringwald #ifdef swap64 63*73988a59SMatthias Ringwald #undef swap64 64*73988a59SMatthias Ringwald #endif 65*73988a59SMatthias Ringwald 668974fcd6SMatthias Ringwald // will be moved to daemon/btstack_device_name_db.h 67eb886013SMatthias Ringwald 68eb886013SMatthias Ringwald /** 69eb886013SMatthias Ringwald * @brief The device name type 70eb886013SMatthias Ringwald */ 71eb886013SMatthias Ringwald #define DEVICE_NAME_LEN 248 72eb886013SMatthias Ringwald typedef uint8_t device_name_t[DEVICE_NAME_LEN+1]; 73eb886013SMatthias Ringwald 74caed94dfSMatthias Ringwald 75cbabbca4SMatthias Ringwald 76*73988a59SMatthias Ringwald /** 77*73988a59SMatthias Ringwald * @brief Read 16/24/32 bit little endian value from buffer 78*73988a59SMatthias Ringwald * @param buffer 79*73988a59SMatthias Ringwald * @param position in buffer 80*73988a59SMatthias Ringwald * @return value 81*73988a59SMatthias Ringwald */ 82*73988a59SMatthias Ringwald uint16_t little_endian_read_16(const uint8_t * buffer, int position); 83*73988a59SMatthias Ringwald uint32_t little_endian_read_24(const uint8_t * buffer, int position); 84*73988a59SMatthias Ringwald uint32_t little_endian_read_32(const uint8_t * buffer, int position); 85eb886013SMatthias Ringwald 86*73988a59SMatthias Ringwald /** 87*73988a59SMatthias Ringwald * @brief Write 16/32 bit little endian value into buffer 88*73988a59SMatthias Ringwald * @param buffer 89*73988a59SMatthias Ringwald * @param position in buffer 90*73988a59SMatthias Ringwald * @param value 91*73988a59SMatthias Ringwald */ 92*73988a59SMatthias Ringwald void little_endian_store_16(uint8_t *buffer, uint16_t position, uint16_t value); 93*73988a59SMatthias Ringwald void little_endian_store_32(uint8_t *buffer, uint16_t position, uint32_t value); 94*73988a59SMatthias Ringwald 95*73988a59SMatthias Ringwald /** 96*73988a59SMatthias Ringwald * @brief Read 16/24/32 bit big endian value from buffer 97*73988a59SMatthias Ringwald * @param buffer 98*73988a59SMatthias Ringwald * @param position in buffer 99*73988a59SMatthias Ringwald * @return value 100*73988a59SMatthias Ringwald */ 101*73988a59SMatthias Ringwald uint32_t big_endian_read_16( const uint8_t * buffer, int pos); 102*73988a59SMatthias Ringwald uint32_t big_endian_read_32( const uint8_t * buffer, int pos); 103*73988a59SMatthias Ringwald 104*73988a59SMatthias Ringwald /** 105*73988a59SMatthias Ringwald * @brief Write 16/32 bit big endian value into buffer 106*73988a59SMatthias Ringwald * @param buffer 107*73988a59SMatthias Ringwald * @param position in buffer 108*73988a59SMatthias Ringwald * @param value 109*73988a59SMatthias Ringwald */ 110f8fbdce0SMatthias Ringwald void big_endian_store_16(uint8_t *buffer, uint16_t pos, uint16_t value); 111f8fbdce0SMatthias Ringwald void big_endian_store_32(uint8_t *buffer, uint16_t pos, uint32_t value); 112eb886013SMatthias Ringwald 113caed94dfSMatthias Ringwald /** 114caed94dfSMatthias Ringwald * @brief Copy from source to destination and reverse byte order 115caed94dfSMatthias Ringwald */ 116eb886013SMatthias Ringwald void swapX (const uint8_t *src, uint8_t * dst, int len); 117bf1b35bfSMatthias Ringwald void swap24 (const uint8_t *src, uint8_t * dst); 118bf1b35bfSMatthias Ringwald void swap48 (const uint8_t *src, uint8_t * dst); 119bf1b35bfSMatthias Ringwald void swap56 (const uint8_t *src, uint8_t * dst); 120bf1b35bfSMatthias Ringwald void swap64 (const uint8_t *src, uint8_t * dst); 121bf1b35bfSMatthias Ringwald void swap128(const uint8_t *src, uint8_t * dst); 122caed94dfSMatthias Ringwald void bt_flip_addr(bd_addr_t dest, bd_addr_t src); 123caed94dfSMatthias Ringwald 124caed94dfSMatthias Ringwald /** 125caed94dfSMatthias Ringwald * @brief 4-bit nibble 126caed94dfSMatthias Ringwald * @return ASCII character for 4-bit nibble 127caed94dfSMatthias Ringwald */ 128eb886013SMatthias Ringwald char char_for_nibble(int nibble); 129eb886013SMatthias Ringwald 130caed94dfSMatthias Ringwald /** 131caed94dfSMatthias Ringwald * @brief Compare two Bluetooth addresses 132caed94dfSMatthias Ringwald * @param a 133caed94dfSMatthias Ringwald * @param b 134caed94dfSMatthias Ringwald * @return true if equal 135caed94dfSMatthias Ringwald */ 136*73988a59SMatthias Ringwald int bd_addr_cmp(bd_addr_t a, bd_addr_t b); 137caed94dfSMatthias Ringwald 138caed94dfSMatthias Ringwald /** 139caed94dfSMatthias Ringwald * @brief Copy Bluetooth address 140*73988a59SMatthias Ringwald * @param dest 141caed94dfSMatthias Ringwald * @param src 142caed94dfSMatthias Ringwald */ 143*73988a59SMatthias Ringwald void bd_addr_copy(bd_addr_t dest, bd_addr_t src); 144caed94dfSMatthias Ringwald 145caed94dfSMatthias Ringwald /** 146caed94dfSMatthias Ringwald * @brief Use printf to write hexdump as single line of data 147caed94dfSMatthias Ringwald */ 148caed94dfSMatthias Ringwald void printf_hexdump(const void *data, int size); 149caed94dfSMatthias Ringwald 150caed94dfSMatthias Ringwald // move to btstack_debug.h 151caed94dfSMatthias Ringwald // void log_info_hexdump(..) either log or hci_dump or off 152caed94dfSMatthias Ringwald void log_key(const char * name, sm_key_t key); 153caed94dfSMatthias Ringwald 154caed94dfSMatthias Ringwald // 155caed94dfSMatthias Ringwald void hexdump(const void *data, int size); 156caed94dfSMatthias Ringwald void hexdumpf(const void *data, int size); 157caed94dfSMatthias Ringwald 158caed94dfSMatthias Ringwald /** 159caed94dfSMatthias Ringwald * @brief Create human readable representation for UUID128 160caed94dfSMatthias Ringwald * @note uses fixed global buffer 161caed94dfSMatthias Ringwald * @return pointer to UUID128 string 162caed94dfSMatthias Ringwald */ 163caed94dfSMatthias Ringwald char * uuid128_to_str(uint8_t * uuid); 164caed94dfSMatthias Ringwald 165caed94dfSMatthias Ringwald /** 166caed94dfSMatthias Ringwald * @brief Create human readable represenationt of Bluetooth address 167caed94dfSMatthias Ringwald * @note uses fixed global buffer 168caed94dfSMatthias Ringwald * @return pointer to Bluetooth address string 169caed94dfSMatthias Ringwald */ 170eb886013SMatthias Ringwald char * bd_addr_to_str(bd_addr_t addr); 171caed94dfSMatthias Ringwald 172caed94dfSMatthias Ringwald /** 173caed94dfSMatthias Ringwald * @brief Parse Bluetooth address 174caed94dfSMatthias Ringwald * @param address_string 175caed94dfSMatthias Ringwald * @param buffer for parsed address 176caed94dfSMatthias Ringwald * @return 1 if string was parsed successfully 177caed94dfSMatthias Ringwald */ 178*73988a59SMatthias Ringwald int sscanf_bd_addr(uint8_t * addr_string, bd_addr_t addr); 179caed94dfSMatthias Ringwald 180*73988a59SMatthias Ringwald /** 181*73988a59SMatthias Ringwald * @brief Constructs UUID128 from 16 or 32 bit UUID using Bluetooth base UUID 182*73988a59SMatthias Ringwald * @param uuid128 output buffer 183*73988a59SMatthias Ringwald * @param short_uuid 184*73988a59SMatthias Ringwald */ 185*73988a59SMatthias Ringwald void uuid_add_bluetooth_prefix(uint8_t * uuid128, uint32_t short_uuid); 186eb886013SMatthias Ringwald 187*73988a59SMatthias Ringwald /** 188*73988a59SMatthias Ringwald * @brief Checks if UUID128 has Bluetooth base UUID prefix 189*73988a59SMatthias Ringwald * @param uui128 to test 190*73988a59SMatthias Ringwald * @return 1 if it can be expressed as UUID32 191*73988a59SMatthias Ringwald */ 192e1a125dfSMatthias Ringwald int uuid_has_bluetooth_prefix(uint8_t * uuid128); 193eb886013SMatthias Ringwald 194eb886013SMatthias Ringwald #if defined __cplusplus 195eb886013SMatthias Ringwald } 196eb886013SMatthias Ringwald #endif 197eb886013SMatthias Ringwald 198bf1b35bfSMatthias Ringwald #endif // __BTSTACK_UTIL_H 199