xref: /btstack/src/btstack_util.c (revision ddaf35c7579ab4463891f4e60cea40b4398b142c)
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_32(uint8_t *buffer, uint16_t pos, uint32_t value){
108     buffer[pos++] = value >> 24;
109     buffer[pos++] = value >> 16;
110     buffer[pos++] = value >> 8;
111     buffer[pos++] = value;
112 }
113 
114 // general swap/endianess utils
115 void reverse_bytes(const uint8_t *src, uint8_t *dst, int len){
116     int i;
117     for (i = 0; i < len; i++)
118         dst[len - 1 - i] = src[i];
119 }
120 void reverse_24(const uint8_t * src, uint8_t * dst){
121     reverse_bytes(src, dst, 3);
122 }
123 void reverse_48(const uint8_t * src, uint8_t * dst){
124     reverse_bytes(src, dst, 6);
125 }
126 void reverse_56(const uint8_t * src, uint8_t * dst){
127     reverse_bytes(src, dst, 7);
128 }
129 void reverse_64(const uint8_t * src, uint8_t * dst){
130     reverse_bytes(src, dst, 8);
131 }
132 void reverse_128(const uint8_t * src, uint8_t * dst){
133     reverse_bytes(src, dst, 16);
134 }
135 void reverse_256(const uint8_t * src, uint8_t * dst){
136     reverse_bytes(src, dst, 32);
137 }
138 
139 void reverse_bd_addr(const bd_addr_t src, bd_addr_t dest){
140     reverse_bytes(src, dest, 6);
141 }
142 
143 uint32_t btstack_min(uint32_t a, uint32_t b){
144     return a < b ? a : b;
145 }
146 
147 uint32_t btstack_max(uint32_t a, uint32_t b){
148     return a > b ? a : b;
149 }
150 
151 char char_for_nibble(int nibble){
152     if (nibble < 10) return '0' + nibble;
153     nibble -= 10;
154     if (nibble < 6) return 'A' + nibble;
155     return '?';
156 }
157 
158 static inline char char_for_high_nibble(int value){
159     return char_for_nibble((value >> 4) & 0x0f);
160 }
161 
162 static inline char char_for_low_nibble(int value){
163     return char_for_nibble(value & 0x0f);
164 }
165 
166 int nibble_for_char(char c){
167     if (c >= '0' && c <= '9') return c - '0';
168     if (c >= 'a' && c <= 'f') return c - 'a' + 10;
169     if (c >= 'A' && c <= 'F') return c - 'A' + 10;
170     return -1;
171 }
172 
173 void printf_hexdump(const void *data, int size){
174     if (size <= 0) return;
175     int i;
176     for (i=0; i<size;i++){
177         printf("%02X ", ((uint8_t *)data)[i]);
178     }
179     printf("\n");
180 }
181 
182 void log_info_hexdump(const void *data, int size){
183 #ifdef ENABLE_LOG_INFO
184 
185 #define ITEMS_PER_LINE 16
186 // template '0x12, '
187 #define BYTES_PER_BYTE  6
188 
189     char buffer[BYTES_PER_BYTE*ITEMS_PER_LINE+1];
190     int i, j;
191     j = 0;
192     for (i=0; i<size;i++){
193 
194         // help static analyzer proof that j stays within bounds
195         if (j > BYTES_PER_BYTE * (ITEMS_PER_LINE-1)){
196             j = 0;
197         }
198 
199         uint8_t byte = ((uint8_t *)data)[i];
200         buffer[j++] = '0';
201         buffer[j++] = 'x';
202         buffer[j++] = char_for_high_nibble(byte);
203         buffer[j++] = char_for_low_nibble(byte);
204         buffer[j++] = ',';
205         buffer[j++] = ' ';
206 
207         if (j >= BYTES_PER_BYTE * ITEMS_PER_LINE ){
208             buffer[j] = 0;
209             log_info("%s", buffer);
210             j = 0;
211         }
212     }
213     if (j != 0){
214         buffer[j] = 0;
215         log_info("%s", buffer);
216     }
217 #endif
218 }
219 
220 void log_info_key(const char * name, sm_key_t key){
221 #ifdef ENABLE_LOG_INFO
222     char buffer[16*2+1];
223     int i;
224     int j = 0;
225     for (i=0; i<16;i++){
226         uint8_t byte = key[i];
227         buffer[j++] = char_for_high_nibble(byte);
228         buffer[j++] = char_for_low_nibble(byte);
229     }
230     buffer[j] = 0;
231     log_info("%-6s %s", name, buffer);
232 #endif
233 }
234 
235 // UUIDs are stored in big endian, similar to bd_addr_t
236 
237 // Bluetooth Base UUID: 00000000-0000-1000-8000- 00805F9B34FB
238 const uint8_t bluetooth_base_uuid[] = { 0x00, 0x00, 0x00, 0x00, /* - */ 0x00, 0x00, /* - */ 0x10, 0x00, /* - */
239     0x80, 0x00, /* - */ 0x00, 0x80, 0x5F, 0x9B, 0x34, 0xFB };
240 
241 void uuid_add_bluetooth_prefix(uint8_t *uuid, uint32_t shortUUID){
242     memcpy(uuid, bluetooth_base_uuid, 16);
243     big_endian_store_32(uuid, 0, shortUUID);
244 }
245 
246 int uuid_has_bluetooth_prefix(uint8_t * uuid128){
247     return memcmp(&uuid128[4], &bluetooth_base_uuid[4], 12) == 0;
248 }
249 
250 static char uuid128_to_str_buffer[32+4+1];
251 char * uuid128_to_str(uint8_t * uuid){
252     int i;
253     int j = 0;
254     // after 4, 6, 8, and 10 bytes = XYXYXYXY-XYXY-XYXY-XYXY-XYXYXYXYXYXY, there's a dash
255     const int dash_locations = (1<<3) | (1<<5) | (1<<7) | (1<<9);
256     for (i=0;i<16;i++){
257         uint8_t byte = uuid[i];
258         uuid128_to_str_buffer[j++] = char_for_high_nibble(byte);
259         uuid128_to_str_buffer[j++] = char_for_low_nibble(byte);
260         if (dash_locations & (1<<i)){
261             uuid128_to_str_buffer[j++] = '-';
262         }
263     }
264     return uuid128_to_str_buffer;
265 }
266 
267 static char bd_addr_to_str_buffer[6*3];  // 12:45:78:01:34:67\0
268 char * bd_addr_to_str(bd_addr_t addr){
269     // orig code
270     // sprintf(bd_addr_to_str_buffer, "%02x:%02x:%02x:%02x:%02x:%02x", addr[0], addr[1], addr[2], addr[3], addr[4], addr[5]);
271     // sprintf-free code
272     char * p = bd_addr_to_str_buffer;
273     int i;
274     for (i = 0; i < 6 ; i++) {
275         uint8_t byte = addr[i];
276         *p++ = char_for_high_nibble(byte);
277         *p++ = char_for_low_nibble(byte);
278         *p++ = ':';
279     }
280     *--p = 0;
281     return (char *) bd_addr_to_str_buffer;
282 }
283 
284 static int scan_hex_byte(const char * byte_string){
285     int upper_nibble = nibble_for_char(*byte_string++);
286     if (upper_nibble < 0) return -1;
287     int lower_nibble = nibble_for_char(*byte_string);
288     if (lower_nibble < 0) return -1;
289     return (upper_nibble << 4) | lower_nibble;
290 }
291 
292 int sscanf_bd_addr(const char * addr_string, bd_addr_t addr){
293     uint8_t buffer[BD_ADDR_LEN];
294     int result = 0;
295     int i;
296     for (i = 0; i < BD_ADDR_LEN; i++) {
297         int single_byte = scan_hex_byte(addr_string);
298         if (single_byte < 0) break;
299         addr_string += 2;
300         buffer[i] = single_byte;
301         // don't check seperator after last byte
302         if (i == BD_ADDR_LEN - 1) {
303             result = 1;
304             break;
305         }
306         char separator = *addr_string++;
307         if (separator != ':' && separator != '-' && separator != ' ') break;
308     }
309 
310     if (result){
311         bd_addr_copy(addr, buffer);
312     }
313 	return result;
314 }
315