console.h

Go to the documentation of this file.

 
#ifndef CONSOLE_H_
#define CONSOLE_H_
 
#if dg_configUSE_CONSOLE
 
#include "ad_uart.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#if !dg_configUSE_CONSOLE_STUBS
 
/*
 * The console utilities service provides support for serial input and output (even from
 * an interrupt context) by employing the UART adapter for reading and writing, and through
 * one of the UART peripheral HW instances.
 *
 * When attempting to capture serial input or print a string from within an application task
 * or interrupt, the libC standard _read()/_write() are redirected to console_read()/write().
 * To allow these reads/writes, console uses it's own task (console_task_func()) that does
 * the actual UART hardware access through the UART adapter (ad_uart_read/write_async()).
 * Synchronization between the console task and the main execution domain is achieved via an
 * OS-based set of events and notifications.
 *
 * Notes:
 * - Console does not use additional RAM for printing. RAM that is used is allocated during
 *   initialization only.
 * - If data flow is too fast for UART, calls from task will wait, while calls from interrupt
 *   may lose some data.
 * - When the console service and CONFIG_RETARGET are both enabled, the serial input and output
 *   activity will be automatically handled by console instead of standard retarget implementation.
 * - In case of printing, it must be assured that the HW UART CTS line/pin of the USB/UART IC
 *   converter is properly connected to the relevant M33 GPIO pin. Additionally, that an IRQ handler
 *   is defined to be triggered upon a CTS event. See the console_wkup_handler() description for more.
 */
 
#ifndef CONSOLE_TASK_PRIORITY
#define CONSOLE_TASK_PRIORITY       (OS_TASK_PRIORITY_NORMAL)
#endif
 
void console_init(const ad_uart_controller_conf_t *ad_uart_ctrl_conf);
 
int console_write(const char *buf, int len);
 
int console_read(char *buf, int len);
 
void console_wkup_handler(void);
 
#else /* !dg_configUSE_CONSOLE_STUBS */
 
__STATIC_INLINE void console_init(void)
{
 
}
 
__STATIC_INLINE int console_write(const char *buf, int len)
{
        return len;
}
 
__STATIC_INLINE int console_read(char *buf, int len)
{
        return 0;
}
 
#endif /* !dg_configUSE_CONSOLE_STUBS */
 
#ifdef __cplusplus
}
#endif
 
#endif /* dg_configUSE_CONSOLE */
 
#endif /* CONSOLE_H_ */