DebugP.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2018-2025 Texas Instruments Incorporated
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef DEBUGP_H
#define DEBUGP_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include <stdbool.h>
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define DebugP_LOG_ZONE_ALWAYS_ON       (0x0001U)
 
#define DebugP_LOG_ZONE_ERROR           (0x0002U)
 
#define DebugP_LOG_ZONE_WARN            (0x0004U)
 
#define DebugP_LOG_ZONE_INFO            (0x0008U)
 
#define DebugP_SHM_LOG_SIZE         ((2U*1024U) - 16U)
 
#define DebugP_MEM_LOG_SIZE         ( 4*1024U )
 
 
#define DebugP_SHM_LOG_IS_VALID     (0x12345678U)
 
#define UNSIGNED_INTEGERVAL_TWO    (2U)
 
#define UNSIGNED_INTEGERVAL_THREE    (3U)
 
#define CARRIAGE_RETURN_ASCII        (13U)
 
typedef struct {
 
    uint32_t isValid;
    uint32_t rdIndex;
    uint32_t wrIndex;
    uint32_t rsv;
    uint8_t  buffer[DebugP_SHM_LOG_SIZE];
 
} DebugP_ShmLog;
 
#ifndef DebugP_ASSERT_ENABLED
 
#define DebugP_ASSERT_ENABLED 1
#endif
 
#ifndef DebugP_LOG_ENABLED
 
#define DebugP_LOG_ENABLED    1
#endif
 
#if DebugP_ASSERT_ENABLED
 
void _DebugP_assert(int32_t expression, const char *file, const char *function, int32_t line, const char *expressionString);
 
void _DebugP_assertNoLog(int32_t expression);
 
#define DebugP_assert(expression)  \
    do { \
        _DebugP_assert(expression, \
            __FILE__, __FUNCTION__, __LINE__, #expression); \
    } while((bool)0)
 
#define DebugP_assertNoLog(expression) (_DebugP_assertNoLog(expression))
 
#else
#define DebugP_assert(expression)
#define DebugP_assertNoLog(expression)
#endif
 
#if DebugP_LOG_ENABLED
 
void _DebugP_logZone(uint32_t logZone, char *format, ...);
 
#define DebugP_log(format, ...)     \
    do { \
        _DebugP_logZone(DebugP_LOG_ZONE_ALWAYS_ON, format, ##__VA_ARGS__); \
    } while((bool)0)
 
#define DebugP_logError(format, ...)     \
    do { \
        _DebugP_logZone(DebugP_LOG_ZONE_ERROR, "ERROR: %s:%d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__); \
    } while((bool)0)
 
#define DebugP_logWarn(format, ...)     \
    do { \
        _DebugP_logZone(DebugP_LOG_ZONE_WARN, "WARNING: %s:%d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__); \
    } while((bool)0)
 
#define DebugP_logInfo(format, ...)     \
    do { \
        _DebugP_logZone(DebugP_LOG_ZONE_INFO, "INFO: %s:%d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__); \
    } while((bool)0)
 
#else
#define DebugP_log(format, ...)
#define DebugP_logError(format, ...)
#define DebugP_logWarn(format, ...)
#define DebugP_logInfo(format, ...)
#endif
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
uint32_t DebugP_logZoneEnable(uint32_t logZoneMask);
 
uint32_t DebugP_logZoneDisable(uint32_t logZoneMask);
 
void DebugP_logZoneRestore(uint32_t logZoneMask);
 
void DebugP_shmLogWriterInit(DebugP_ShmLog *shmLog, uint16_t selfCoreId);
 
void DebugP_shmLogWriterPause(void);
 
void DebugP_shmLogWriterResume(void);
 
void DebugP_shmLogWriterPutChar(char character);
 
 
void DebugP_uartLogWriterPutChar(char character);
 
void DebugP_shmLogReaderInit(DebugP_ShmLog *shmLog, uint16_t numCores);
 
void DebugP_shmLogRead(void);
 
void DebugP_memLogWriterInit(uint16_t selfCoreId);
 
void DebugP_memLogWriterPause(void);
 
void DebugP_memLogWriterResume(void);
 
void DebugP_memLogWriterPutChar(char character);
 
void DebugP_uartSetDrvIndex(uint32_t uartDrvIndex);
 
int32_t DebugP_scanf(char *format, ...);
 
int32_t DebugP_readLine(char *lineBuf, uint32_t bufSize);
 
#ifdef __cplusplus
}
#endif
 
#endif /* DEBUGP_H */