xref: /aosp_15_r20/external/coreboot/src/drivers/vpd/vpd_decode.h (revision b9411a12aaaa7e1e6a6fb7c5e057f44ee179a49c)
1 /* SPDX-License-Identifier: BSD-3-Clause */
2 
3 /*
4  * This is a copy from upstream:
5  * https://chromium.googlesource.com/chromiumos/platform/vpd/+/master/include/lib/vpd_decode.h
6  */
7 
8 #ifndef __VPD_DECODE_H
9 #define __VPD_DECODE_H
10 
11 #include <stdint.h>
12 
13 enum {
14 	VPD_DECODE_OK = 0,
15 	VPD_DECODE_FAIL = 1,
16 };
17 
18 enum {
19 	VPD_TYPE_TERMINATOR = 0,
20 	VPD_TYPE_STRING,
21 	VPD_TYPE_INFO = 0xfe,
22 	VPD_TYPE_IMPLICIT_TERMINATOR = 0xff,
23 };
24 
25 /* Callback for vpd_decode_string to invoke. */
26 typedef int vpd_decode_callback(
27 		const u8 *key, u32 key_len, const u8 *value, u32 value_len,
28 		void *arg);
29 
30 /*
31  * vpd_decode_string
32  *
33  * Given the encoded string, this function invokes callback with extracted
34  * (key, value). The *consumed will be incremented by the number of bytes
35  * consumed in this function.
36  *
37  * The input_buf points to the first byte of the input buffer.
38  *
39  * The *consumed starts from 0, which is actually the next byte to be decoded.
40  * It can be non-zero to be used in multiple calls.
41  *
42  * If one entry is successfully decoded, sends it to callback and returns the
43  * result.
44  */
45 int vpd_decode_string(
46 		const u32 max_len, const u8 *input_buf, u32 *consumed,
47 		vpd_decode_callback callback, void *callback_arg);
48 
49 #endif  /* __VPD_DECODE_H */
50