Jacob Garber | 10999ea6 | 2020-05-18 13:36:58 -0600 | [diff] [blame] | 1 | /* SPDX-License-Identifier: BSD-3-Clause */ |
| 2 | |
Hung-Te Lin | c345570 | 2019-05-27 11:02:00 +0800 | [diff] [blame] | 3 | /* |
Hung-Te Lin | c345570 | 2019-05-27 11:02:00 +0800 | [diff] [blame] | 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 | /* |
Hung-Te Lin | c345570 | 2019-05-27 11:02:00 +0800 | [diff] [blame] | 31 | * vpd_decode_string |
| 32 | * |
| 33 | * Given the encoded string, this function invokes callback with extracted |
Hung-Te Lin | f6317b4 | 2019-06-12 16:59:24 +0800 | [diff] [blame] | 34 | * (key, value). The *consumed will be incremented by the number of bytes |
| 35 | * consumed in this function. |
Hung-Te Lin | c345570 | 2019-05-27 11:02:00 +0800 | [diff] [blame] | 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 */ |