AFBR-S50 API Reference Manual v1.5.6
AFBR-S50 Time-of-Flight Sensor SDK for Embedded Software
Loading...
Searching...
No Matches
argus_print.h
Go to the documentation of this file.
1/*************************************************************************/
37#ifndef ARGUS_PRINT_H
38#define ARGUS_PRINT_H
39#ifdef __cplusplus
40extern "C" {
41#endif
42
43/*!***************************************************************************
44 * @defgroup argus_log Debug: Logging Interface
45 * @ingroup argus_hal
46 *
47 * @brief Logging interface for the AFBR-S50 API.
48 *
49 * @details This interface provides logging utility functions.
50 * Defines a printf-like function that is used to print error and
51 * log messages.
52 *
53 * @addtogroup argus_log
54 * @{
55 *****************************************************************************/
56
57#include "api/argus_def.h"
58
59/*!***************************************************************************
60 * @brief A printf-like function to print formatted data to an debugging interface.
61 *
62 * @details Writes the C string pointed by fmt_t to an output. If format
63 * includes format specifiers (subsequences beginning with %), the
64 * additional arguments following fmt_t are formatted and inserted in
65 * the resulting string replacing their respective specifiers.
66 *
67 * To enable the print functionality, an implementation of the function
68 * must be provided that maps the output to an interface like UART or
69 * a debugging console, e.g. by forwarding to standard printf() method.
70 *
71 * @note The implementation of this function is optional for the correct
72 * execution of the API. If not implemented, a weak implementation
73 * within the API will be used that does nothing. This will improve
74 * the performance but no error messages are logged.
75 *
76 * @note The naming is different from the standard printf() on purpose to
77 * prevent builtin compiler optimizations.
78 *
79 * @param fmt_s The usual print() format string.
80 * @param ... The usual print() parameters.
81 *
82 * @return Returns the \link #status_t status\endlink (#STATUS_OK on success).
83 *****************************************************************************/
84status_t print(const char *fmt_s, ...);
85
87#ifdef __cplusplus
88} // extern "C"
89#endif
90#endif /* ARGUS_PRINT_H */
argus_def.h
This file is part of the AFBR-S50 hardware API.
print
status_t print(const char *fmt_s,...)
A printf-like function to print formatted data to an debugging interface.
Definition sci_log.c:106
status_t
int32_t status_t
Type used for all status and error return values.
Definition argus_status.h:70