xref: /btstack/src/btstack_util.h (revision 877f40f3bc3cc56add4f71c80e633a4ab4106756)
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 
619c80e4ccSMatthias Ringwald // hack: compilation with the android ndk causes an error as there's a reverse_64 macro
629c80e4ccSMatthias Ringwald #ifdef reverse_64
639c80e4ccSMatthias Ringwald #undef reverse_64
6473988a59SMatthias Ringwald #endif
6573988a59SMatthias 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 
7673988a59SMatthias Ringwald /**
7773988a59SMatthias Ringwald  * @brief Read 16/24/32 bit little endian value from buffer
7873988a59SMatthias Ringwald  * @param buffer
7973988a59SMatthias Ringwald  * @param position in buffer
8073988a59SMatthias Ringwald  * @return value
8173988a59SMatthias Ringwald  */
8273988a59SMatthias Ringwald uint16_t little_endian_read_16(const uint8_t * buffer, int position);
8373988a59SMatthias Ringwald uint32_t little_endian_read_24(const uint8_t * buffer, int position);
8473988a59SMatthias Ringwald uint32_t little_endian_read_32(const uint8_t * buffer, int position);
85eb886013SMatthias Ringwald 
8673988a59SMatthias Ringwald /**
8773988a59SMatthias Ringwald  * @brief Write 16/32 bit little endian value into buffer
8873988a59SMatthias Ringwald  * @param buffer
8973988a59SMatthias Ringwald  * @param position in buffer
9073988a59SMatthias Ringwald  * @param value
9173988a59SMatthias Ringwald  */
9273988a59SMatthias Ringwald void little_endian_store_16(uint8_t *buffer, uint16_t position, uint16_t value);
9373988a59SMatthias Ringwald void little_endian_store_32(uint8_t *buffer, uint16_t position, uint32_t value);
9473988a59SMatthias Ringwald 
9573988a59SMatthias Ringwald /**
9673988a59SMatthias Ringwald  * @brief Read 16/24/32 bit big endian value from buffer
9773988a59SMatthias Ringwald  * @param buffer
9873988a59SMatthias Ringwald  * @param position in buffer
9973988a59SMatthias Ringwald  * @return value
10073988a59SMatthias Ringwald  */
10173988a59SMatthias Ringwald uint32_t big_endian_read_16( const uint8_t * buffer, int pos);
10273988a59SMatthias Ringwald uint32_t big_endian_read_32( const uint8_t * buffer, int pos);
10373988a59SMatthias Ringwald 
10473988a59SMatthias Ringwald /**
10573988a59SMatthias Ringwald  * @brief Write 16/32 bit big endian value into buffer
10673988a59SMatthias Ringwald  * @param buffer
10773988a59SMatthias Ringwald  * @param position in buffer
10873988a59SMatthias Ringwald  * @param value
10973988a59SMatthias 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
1159c80e4ccSMatthias Ringwald  * @param src
1169c80e4ccSMatthias Ringwald  * @param dest
1179c80e4ccSMatthias Ringwald  * @param len
118caed94dfSMatthias Ringwald  */
1199c80e4ccSMatthias Ringwald void reverse_bytes  (const uint8_t *src, uint8_t * dest, int len);
1209c80e4ccSMatthias Ringwald 
1219c80e4ccSMatthias Ringwald /**
1229c80e4ccSMatthias Ringwald  * @brief Wrapper around reverse_bytes for common buffer sizes
1239c80e4ccSMatthias Ringwald  * @param src
1249c80e4ccSMatthias Ringwald  * @param dest
1259c80e4ccSMatthias Ringwald  */
1269c80e4ccSMatthias Ringwald void reverse_24 (const uint8_t *src, uint8_t * dest);
1279c80e4ccSMatthias Ringwald void reverse_48 (const uint8_t *src, uint8_t * dest);
1289c80e4ccSMatthias Ringwald void reverse_56 (const uint8_t *src, uint8_t * dest);
1299c80e4ccSMatthias Ringwald void reverse_64 (const uint8_t *src, uint8_t * dest);
1309c80e4ccSMatthias Ringwald void reverse_128(const uint8_t *src, uint8_t * dest);
1319c80e4ccSMatthias Ringwald 
132724d70a2SMatthias Ringwald void reverse_bd_addr(const bd_addr_t src, bd_addr_t dest);
133caed94dfSMatthias Ringwald 
134caed94dfSMatthias Ringwald /**
135*877f40f3SMatthias Ringwald  * @brief ASCII character for 4-bit nibble
136*877f40f3SMatthias Ringwald  * @return character
137caed94dfSMatthias Ringwald  */
138eb886013SMatthias Ringwald char char_for_nibble(int nibble);
139eb886013SMatthias Ringwald 
140caed94dfSMatthias Ringwald /**
141*877f40f3SMatthias Ringwald  * @brif 4-bit nibble from ASCII character
142*877f40f3SMatthias Ringwald  * @return value
143*877f40f3SMatthias Ringwald  */
144*877f40f3SMatthias Ringwald int nibble_for_char(char c);
145*877f40f3SMatthias Ringwald 
146*877f40f3SMatthias Ringwald /**
147caed94dfSMatthias Ringwald  * @brief Compare two Bluetooth addresses
148caed94dfSMatthias Ringwald  * @param a
149caed94dfSMatthias Ringwald  * @param b
150caed94dfSMatthias Ringwald  * @return true if equal
151caed94dfSMatthias Ringwald  */
15273988a59SMatthias Ringwald int bd_addr_cmp(bd_addr_t a, bd_addr_t b);
153caed94dfSMatthias Ringwald 
154caed94dfSMatthias Ringwald /**
155caed94dfSMatthias Ringwald  * @brief Copy Bluetooth address
15673988a59SMatthias Ringwald  * @param dest
157caed94dfSMatthias Ringwald  * @param src
158caed94dfSMatthias Ringwald  */
15973988a59SMatthias Ringwald void bd_addr_copy(bd_addr_t dest, bd_addr_t src);
160caed94dfSMatthias Ringwald 
161caed94dfSMatthias Ringwald /**
162caed94dfSMatthias Ringwald  * @brief Use printf to write hexdump as single line of data
163caed94dfSMatthias Ringwald  */
164caed94dfSMatthias Ringwald void printf_hexdump(const void *data, int size);
165caed94dfSMatthias Ringwald 
166caed94dfSMatthias Ringwald /**
167caed94dfSMatthias Ringwald  * @brief Create human readable representation for UUID128
168caed94dfSMatthias Ringwald  * @note uses fixed global buffer
169caed94dfSMatthias Ringwald  * @return pointer to UUID128 string
170caed94dfSMatthias Ringwald  */
171caed94dfSMatthias Ringwald char * uuid128_to_str(uint8_t * uuid);
172caed94dfSMatthias Ringwald 
173caed94dfSMatthias Ringwald /**
174caed94dfSMatthias Ringwald  * @brief Create human readable represenationt of Bluetooth address
175caed94dfSMatthias Ringwald  * @note uses fixed global buffer
176caed94dfSMatthias Ringwald  * @return pointer to Bluetooth address string
177caed94dfSMatthias Ringwald  */
178eb886013SMatthias Ringwald char * bd_addr_to_str(bd_addr_t addr);
179caed94dfSMatthias Ringwald 
180caed94dfSMatthias Ringwald /**
181caed94dfSMatthias Ringwald  * @brief Parse Bluetooth address
182caed94dfSMatthias Ringwald  * @param address_string
183caed94dfSMatthias Ringwald  * @param buffer for parsed address
184caed94dfSMatthias Ringwald  * @return 1 if string was parsed successfully
185caed94dfSMatthias Ringwald  */
186a6efb919SMatthias Ringwald int sscanf_bd_addr(const char * addr_string, bd_addr_t addr);
187caed94dfSMatthias Ringwald 
18873988a59SMatthias Ringwald /**
18973988a59SMatthias Ringwald  * @brief Constructs UUID128 from 16 or 32 bit UUID using Bluetooth base UUID
19073988a59SMatthias Ringwald  * @param uuid128 output buffer
19173988a59SMatthias Ringwald  * @param short_uuid
19273988a59SMatthias Ringwald  */
19373988a59SMatthias Ringwald void uuid_add_bluetooth_prefix(uint8_t * uuid128, uint32_t short_uuid);
194eb886013SMatthias Ringwald 
19573988a59SMatthias Ringwald /**
19673988a59SMatthias Ringwald  * @brief Checks if UUID128 has Bluetooth base UUID prefix
19773988a59SMatthias Ringwald  * @param uui128 to test
19873988a59SMatthias Ringwald  * @return 1 if it can be expressed as UUID32
19973988a59SMatthias Ringwald  */
200e1a125dfSMatthias Ringwald int  uuid_has_bluetooth_prefix(uint8_t * uuid128);
201eb886013SMatthias Ringwald 
202eb886013SMatthias Ringwald #if defined __cplusplus
203eb886013SMatthias Ringwald }
204eb886013SMatthias Ringwald #endif
205eb886013SMatthias Ringwald 
206bf1b35bfSMatthias Ringwald #endif // __BTSTACK_UTIL_H
207