fsl_debug_console.h

Go to the documentation of this file.

/*
 * Copyright (c) 2013 - 2015, Freescale Semiconductor, Inc.
 * Copyright 2016-2018 NXP
 * All rights reserved.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 * Debug console shall provide input and output functions to scan and print formatted data.
 * o Support a format specifier for PRINTF follows this prototype "%[flags][width][.precision][length]specifier"
 *   - [flags] :'-', '+', '#', ' ', '0'
 *   - [width]:  number (0,1...)
 *   - [.precision]: number (0,1...)
 *   - [length]: do not support
 *   - [specifier]: 'd', 'i', 'f', 'F', 'x', 'X', 'o', 'p', 'u', 'c', 's', 'n'
 * o Support a format specifier for SCANF follows this prototype " %[*][width][length]specifier"
 *   - [*]: is supported.
 *   - [width]: number (0,1...)
 *   - [length]: 'h', 'hh', 'l','ll','L'. ignore ('j','z','t')
 *   - [specifier]: 'd', 'i', 'u', 'f', 'F', 'e', 'E', 'g', 'G', 'a', 'A', 'o', 'c', 's'
 */
 
#ifndef _FSL_DEBUGCONSOLE_H_
#define _FSL_DEBUGCONSOLE_H_
 
#include "fsl_common.h"
#include "serial_manager.h"
 
/*******************************************************************************
 * Definitions
 ******************************************************************************/
 
extern serial_handle_t g_serialHandle; 
#define DEBUGCONSOLE_REDIRECT_TO_TOOLCHAIN 0U 
#define DEBUGCONSOLE_REDIRECT_TO_SDK       1U 
#define DEBUGCONSOLE_DISABLE               2U 
#ifndef SDK_DEBUGCONSOLE
#define SDK_DEBUGCONSOLE 1U
#endif
 
#if defined(SDK_DEBUGCONSOLE) && !(SDK_DEBUGCONSOLE)
#include <stdio.h>
#endif
 
#if SDK_DEBUGCONSOLE == DEBUGCONSOLE_DISABLE /* Disable debug console */
#define PRINTF(...) \
    do              \
    {               \
    } while (0)
#define SCANF(...) \
    do             \
    {              \
    } while (0)
#define PUTCHAR(...) \
    do               \
    {                \
    } while (0)
#define GETCHAR() -1
#elif SDK_DEBUGCONSOLE == DEBUGCONSOLE_REDIRECT_TO_SDK /* Select printf, scanf, putchar, getchar of SDK version. */
#define PRINTF  DbgConsole_Printf
#define SCANF   DbgConsole_Scanf
#define PUTCHAR DbgConsole_Putchar
#define GETCHAR DbgConsole_Getchar
#elif SDK_DEBUGCONSOLE == DEBUGCONSOLE_REDIRECT_TO_TOOLCHAIN /* Select printf, scanf, putchar, getchar of toolchain. \ \
                                                              */
#define PRINTF  printf
#define SCANF   scanf
#define PUTCHAR putchar
#define GETCHAR getchar
#endif /* SDK_DEBUGCONSOLE */
 
/*******************************************************************************
 * Prototypes
 ******************************************************************************/
 
#if defined(__cplusplus)
extern "C" {
#endif /* __cplusplus */
 
/* @{ */
 
#if ((SDK_DEBUGCONSOLE == DEBUGCONSOLE_REDIRECT_TO_SDK) || defined(SDK_DEBUGCONSOLE_UART))
 
status_t DbgConsole_Init(uint8_t instance, uint32_t baudRate, serial_port_type_t device, uint32_t clkSrcFreq);
 
status_t DbgConsole_Deinit(void);
#else
 
static inline status_t DbgConsole_Init(uint8_t instance,
                                       uint32_t baudRate,
                                       serial_port_type_t device,
                                       uint32_t clkSrcFreq)
{
    (void)instance;
    (void)baudRate;
    (void)device;
    (void)clkSrcFreq;
    return (status_t)kStatus_Fail;
}
static inline status_t DbgConsole_Deinit(void)
{
    return (status_t)kStatus_Fail;
}
#endif /* ((SDK_DEBUGCONSOLE == DEBUGCONSOLE_REDIRECT_TO_SDK) || defined(SDK_DEBUGCONSOLE_UART)) */
 
#if SDK_DEBUGCONSOLE
 
int DbgConsole_Printf(const char *formatString, ...);
 
int DbgConsole_Putchar(int ch);
 
int DbgConsole_Scanf(char *formatString, ...);
 
int DbgConsole_Getchar(void);
 
int DbgConsole_BlockingPrintf(const char *formatString, ...);
 
status_t DbgConsole_Flush(void);
 
#ifdef DEBUG_CONSOLE_TRANSFER_NON_BLOCKING
 
status_t DbgConsole_TryGetchar(char *ch);
#endif
 
#endif /* SDK_DEBUGCONSOLE */
 
#if defined(__cplusplus)
}
#endif /* __cplusplus */
 
#endif /* _FSL_DEBUGCONSOLE_H_ */