xref: /btstack/src/btstack_util.c (revision 7f535380ac9b3f2a4bef0c23ad133caacf42b257)
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.c
40  *
41  *  General utility functions
42  *
43  *  Created by Matthias Ringwald on 7/23/09.
44  */
45 
46 #include "btstack_config.h"
47 #include "btstack_debug.h"
48 #include "btstack_util.h"
49 
50 #include <stdio.h>
51 #include <string.h>
52 
53 /**
54  * @brief Compare two Bluetooth addresses
55  * @param a
56  * @param b
57  * @return 0 if equal
58  */
59 int bd_addr_cmp(bd_addr_t a, bd_addr_t b){
60     return memcmp(a,b, BD_ADDR_LEN);
61 }
62 
63 /**
64  * @brief Copy Bluetooth address
65  * @param dest
66  * @param src
67  */
68 void bd_addr_copy(bd_addr_t dest, bd_addr_t src){
69     memcpy(dest,src,BD_ADDR_LEN);
70 }
71 
72 uint16_t little_endian_read_16(const uint8_t * buffer, int pos){
73     return ((uint16_t) buffer[pos]) | (((uint16_t)buffer[(pos)+1]) << 8);
74 }
75 uint32_t little_endian_read_24(const uint8_t * buffer, int pos){
76     return ((uint32_t) buffer[pos]) | (((uint32_t)buffer[(pos)+1]) << 8) | (((uint32_t)buffer[(pos)+2]) << 16);
77 }
78 uint32_t little_endian_read_32(const uint8_t * buffer, int pos){
79     return ((uint32_t) buffer[pos]) | (((uint32_t)buffer[(pos)+1]) << 8) | (((uint32_t)buffer[(pos)+2]) << 16) | (((uint32_t) buffer[(pos)+3]) << 24);
80 }
81 
82 void little_endian_store_16(uint8_t *buffer, uint16_t pos, uint16_t value){
83     buffer[pos++] = value;
84     buffer[pos++] = value >> 8;
85 }
86 
87 void little_endian_store_32(uint8_t *buffer, uint16_t pos, uint32_t value){
88     buffer[pos++] = value;
89     buffer[pos++] = value >> 8;
90     buffer[pos++] = value >> 16;
91     buffer[pos++] = value >> 24;
92 }
93 
94 uint32_t big_endian_read_16( const uint8_t * buffer, int pos) {
95     return ((uint16_t) buffer[(pos)+1]) | (((uint16_t)buffer[ pos   ]) << 8);
96 }
97 
98 uint32_t big_endian_read_32( const uint8_t * buffer, int pos) {
99     return ((uint32_t) buffer[(pos)+3]) | (((uint32_t)buffer[(pos)+2]) << 8) | (((uint32_t)buffer[(pos)+1]) << 16) | (((uint32_t) buffer[pos]) << 24);
100 }
101 
102 void big_endian_store_16(uint8_t *buffer, uint16_t pos, uint16_t value){
103     buffer[pos++] = value >> 8;
104     buffer[pos++] = value;
105 }
106 
107 void big_endian_store_24(uint8_t *buffer, uint16_t pos, uint32_t value){
108     buffer[pos++] = value >> 16;
109     buffer[pos++] = value >> 8;
110     buffer[pos++] = value;
111 }
112 
113 void big_endian_store_32(uint8_t *buffer, uint16_t pos, uint32_t value){
114     buffer[pos++] = value >> 24;
115     buffer[pos++] = value >> 16;
116     buffer[pos++] = value >> 8;
117     buffer[pos++] = value;
118 }
119 
120 // general swap/endianess utils
121 void reverse_bytes(const uint8_t *src, uint8_t *dst, int len){
122     int i;
123     for (i = 0; i < len; i++)
124         dst[len - 1 - i] = src[i];
125 }
126 void reverse_24(const uint8_t * src, uint8_t * dst){
127     reverse_bytes(src, dst, 3);
128 }
129 void reverse_48(const uint8_t * src, uint8_t * dst){
130     reverse_bytes(src, dst, 6);
131 }
132 void reverse_56(const uint8_t * src, uint8_t * dst){
133     reverse_bytes(src, dst, 7);
134 }
135 void reverse_64(const uint8_t * src, uint8_t * dst){
136     reverse_bytes(src, dst, 8);
137 }
138 void reverse_128(const uint8_t * src, uint8_t * dst){
139     reverse_bytes(src, dst, 16);
140 }
141 void reverse_256(const uint8_t * src, uint8_t * dst){
142     reverse_bytes(src, dst, 32);
143 }
144 
145 void reverse_bd_addr(const bd_addr_t src, bd_addr_t dest){
146     reverse_bytes(src, dest, 6);
147 }
148 
149 uint32_t btstack_min(uint32_t a, uint32_t b){
150     return a < b ? a : b;
151 }
152 
153 uint32_t btstack_max(uint32_t a, uint32_t b){
154     return a > b ? a : b;
155 }
156 
157 char char_for_nibble(int nibble){
158     if (nibble < 10) return '0' + nibble;
159     nibble -= 10;
160     if (nibble < 6) return 'A' + nibble;
161     return '?';
162 }
163 
164 static inline char char_for_high_nibble(int value){
165     return char_for_nibble((value >> 4) & 0x0f);
166 }
167 
168 static inline char char_for_low_nibble(int value){
169     return char_for_nibble(value & 0x0f);
170 }
171 
172 int nibble_for_char(char c){
173     if (c >= '0' && c <= '9') return c - '0';
174     if (c >= 'a' && c <= 'f') return c - 'a' + 10;
175     if (c >= 'A' && c <= 'F') return c - 'A' + 10;
176     return -1;
177 }
178 
179 void printf_hexdump(const void *data, int size){
180     if (size <= 0) return;
181     int i;
182     for (i=0; i<size;i++){
183         printf("%02X ", ((uint8_t *)data)[i]);
184     }
185     printf("\n");
186 }
187 
188 void log_info_hexdump(const void *data, int size){
189 #ifdef ENABLE_LOG_INFO
190 
191 #define ITEMS_PER_LINE 16
192 // template '0x12, '
193 #define BYTES_PER_BYTE  6
194 
195     char buffer[BYTES_PER_BYTE*ITEMS_PER_LINE+1];
196     int i, j;
197     j = 0;
198     for (i=0; i<size;i++){
199 
200         // help static analyzer proof that j stays within bounds
201         if (j > BYTES_PER_BYTE * (ITEMS_PER_LINE-1)){
202             j = 0;
203         }
204 
205         uint8_t byte = ((uint8_t *)data)[i];
206         buffer[j++] = '0';
207         buffer[j++] = 'x';
208         buffer[j++] = char_for_high_nibble(byte);
209         buffer[j++] = char_for_low_nibble(byte);
210         buffer[j++] = ',';
211         buffer[j++] = ' ';
212 
213         if (j >= BYTES_PER_BYTE * ITEMS_PER_LINE ){
214             buffer[j] = 0;
215             log_info("%s", buffer);
216             j = 0;
217         }
218     }
219     if (j != 0){
220         buffer[j] = 0;
221         log_info("%s", buffer);
222     }
223 #else
224     UNUSED(data);
225     UNUSED(size);
226 #endif
227 }
228 
229 void log_info_key(const char * name, sm_key_t key){
230 #ifdef ENABLE_LOG_INFO
231     char buffer[16*2+1];
232     int i;
233     int j = 0;
234     for (i=0; i<16;i++){
235         uint8_t byte = key[i];
236         buffer[j++] = char_for_high_nibble(byte);
237         buffer[j++] = char_for_low_nibble(byte);
238     }
239     buffer[j] = 0;
240     log_info("%-6s %s", name, buffer);
241 #else
242     UNUSED(name);
243     UNUSED(key);
244 #endif
245 }
246 
247 // UUIDs are stored in big endian, similar to bd_addr_t
248 
249 // Bluetooth Base UUID: 00000000-0000-1000-8000- 00805F9B34FB
250 const uint8_t bluetooth_base_uuid[] = { 0x00, 0x00, 0x00, 0x00, /* - */ 0x00, 0x00, /* - */ 0x10, 0x00, /* - */
251     0x80, 0x00, /* - */ 0x00, 0x80, 0x5F, 0x9B, 0x34, 0xFB };
252 
253 void uuid_add_bluetooth_prefix(uint8_t *uuid, uint32_t shortUUID){
254     memcpy(uuid, bluetooth_base_uuid, 16);
255     big_endian_store_32(uuid, 0, shortUUID);
256 }
257 
258 int uuid_has_bluetooth_prefix(uint8_t * uuid128){
259     return memcmp(&uuid128[4], &bluetooth_base_uuid[4], 12) == 0;
260 }
261 
262 static char uuid128_to_str_buffer[32+4+1];
263 char * uuid128_to_str(uint8_t * uuid){
264     int i;
265     int j = 0;
266     // after 4, 6, 8, and 10 bytes = XYXYXYXY-XYXY-XYXY-XYXY-XYXYXYXYXYXY, there's a dash
267     const int dash_locations = (1<<3) | (1<<5) | (1<<7) | (1<<9);
268     for (i=0;i<16;i++){
269         uint8_t byte = uuid[i];
270         uuid128_to_str_buffer[j++] = char_for_high_nibble(byte);
271         uuid128_to_str_buffer[j++] = char_for_low_nibble(byte);
272         if (dash_locations & (1<<i)){
273             uuid128_to_str_buffer[j++] = '-';
274         }
275     }
276     return uuid128_to_str_buffer;
277 }
278 
279 static char bd_addr_to_str_buffer[6*3];  // 12:45:78:01:34:67\0
280 char * bd_addr_to_str(bd_addr_t addr){
281     // orig code
282     // sprintf(bd_addr_to_str_buffer, "%02x:%02x:%02x:%02x:%02x:%02x", addr[0], addr[1], addr[2], addr[3], addr[4], addr[5]);
283     // sprintf-free code
284     char * p = bd_addr_to_str_buffer;
285     int i;
286     for (i = 0; i < 6 ; i++) {
287         uint8_t byte = addr[i];
288         *p++ = char_for_high_nibble(byte);
289         *p++ = char_for_low_nibble(byte);
290         *p++ = ':';
291     }
292     *--p = 0;
293     return (char *) bd_addr_to_str_buffer;
294 }
295 
296 static int scan_hex_byte(const char * byte_string){
297     int upper_nibble = nibble_for_char(*byte_string++);
298     if (upper_nibble < 0) return -1;
299     int lower_nibble = nibble_for_char(*byte_string);
300     if (lower_nibble < 0) return -1;
301     return (upper_nibble << 4) | lower_nibble;
302 }
303 
304 int sscanf_bd_addr(const char * addr_string, bd_addr_t addr){
305     uint8_t buffer[BD_ADDR_LEN];
306     int result = 0;
307     int i;
308     for (i = 0; i < BD_ADDR_LEN; i++) {
309         int single_byte = scan_hex_byte(addr_string);
310         if (single_byte < 0) break;
311         addr_string += 2;
312         buffer[i] = single_byte;
313         // don't check seperator after last byte
314         if (i == BD_ADDR_LEN - 1) {
315             result = 1;
316             break;
317         }
318         char separator = *addr_string++;
319         if (separator != ':' && separator != '-' && separator != ' ') break;
320     }
321 
322     if (result){
323         bd_addr_copy(addr, buffer);
324     }
325 	return result;
326 }
327 
328 uint32_t btstack_atoi(const char *str){
329     uint32_t val = 0;
330     while (1){
331         char chr = *str;
332         if (!chr || chr < '0' || chr > '9')
333             return val;
334         val = (val * 10) + (chr - '0');
335         str++;
336     }
337 }