[base16] Add generic base16 encoding and decoding routines
[gpxe.git] / src / include / gpxe / base16.h
1 #ifndef _IPXE_BASE16_H
2 #define _IPXE_BASE16_H
3
4 /** @file
5  *
6  * Base16 encoding
7  *
8  */
9
10 FILE_LICENCE ( GPL2_OR_LATER );
11
12 #include <stdint.h>
13 #include <string.h>
14
15 /**
16  * Calculate length of base16-encoded data
17  *
18  * @v raw_len           Raw data length
19  * @ret encoded_len     Encoded string length (excluding NUL)
20  */
21 static inline size_t base16_encoded_len ( size_t raw_len ) {
22         return ( 2 * raw_len );
23 }
24
25 /**
26  * Calculate maximum length of base16-decoded string
27  *
28  * @v encoded           Encoded string
29  * @v max_raw_len       Maximum length of raw data
30  */
31 static inline size_t base16_decoded_max_len ( const char *encoded ) {
32         return ( ( strlen ( encoded ) + 1 ) / 2 );
33 }
34
35 extern void base16_encode ( const uint8_t *raw, size_t len, char *encoded );
36 extern int base16_decode ( const char *encoded, uint8_t *raw );
37
38 #endif /* _IPXE_BASE16_H */