1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
|
/** @file
High-level utility functions for decoders.
Copyright (C) 2018 Christian Zuckschwerdt
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
*/
#ifndef INCLUDE_DECODER_UTIL_H_
#define INCLUDE_DECODER_UTIL_H_
#include <stdarg.h>
#include "bitbuffer.h"
#include "data.h"
#include "r_device.h"
#if defined _MSC_VER || defined ESP32 // Microsoft Visual Studio or ESP32
// MSC and ESP32 have something like C99 restrict as __restrict
#ifndef restrict
#define restrict __restrict
#endif
#endif
// Defined in newer <sal.h> for MSVC.
#ifndef _Printf_format_string_
#define _Printf_format_string_
#endif
/// Create a new r_device, copy from dev_template if not NULL.
///
/// A user data memory of `user_data_size` bytes will be allocated if not `0`.
r_device *decoder_create(r_device const *dev_template, unsigned user_data_size);
/// Get the user data pointer, otherwise NULL.
///
/// The memory can be freely used by a decoder and is of the size given to `decoder_create()`.
void *decoder_user_data(r_device *decoder);
/// Output data.
void decoder_output_data(r_device *decoder, data_t *data);
/// Output log.
void decoder_output_log(r_device *decoder, int level, data_t *data);
// be terse, a maximum msg length of 60 characters is supported on the decoder_log_ functions
// e.g. "FoobarCorp-XY3000: unexpected type code %02x"
/// Get the current verbosity level for the decoder.
///
/// @deprecated Should not be used, consider using only `decoder_log_` functions.
int decoder_verbose(r_device *decoder);
/// Output a log message.
void decoder_log(r_device *decoder, int level, char const *func, char const *msg);
/// Output a formatted log message.
void decoder_logf(r_device *decoder, int level, char const *func, _Printf_format_string_ const char *format, ...)
#if defined(__GNUC__) || defined(__clang__)
__attribute__((format(printf, 4, 5)))
#endif
;
/// Output a log message with the content of the bitbuffer.
void decoder_log_bitbuffer(r_device *decoder, int level, char const *func, const bitbuffer_t *bitbuffer, char const *msg);
/// Output a formatted log message with the content of the bitbuffer.
void decoder_logf_bitbuffer(r_device *decoder, int level, char const *func, const bitbuffer_t *bitbuffer, _Printf_format_string_ const char *format, ...)
#if defined(__GNUC__) || defined(__clang__)
__attribute__((format(printf, 5, 6)))
#endif
;
/// Output a log message with the content of a bit row (byte buffer).
void decoder_log_bitrow(r_device *decoder, int level, char const *func, uint8_t const *bitrow, unsigned bit_len, char const *msg);
/// Output a formatted log message with the content of a bit row (byte buffer).
void decoder_logf_bitrow(r_device *decoder, int level, char const *func, uint8_t const *bitrow, unsigned bit_len, _Printf_format_string_ const char *format, ...)
#if defined(__GNUC__) || defined(__clang__)
__attribute__((format(printf, 6, 7)))
#endif
;
#endif /* INCLUDE_DECODER_UTIL_H_ */
|
