DebugP.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2020, Texas Instruments Incorporated
 * All rights reserved.
 *
 * 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 ti_drivers_ports_DebugP__include
#define ti_drivers_ports_DebugP__include
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdarg.h>
 
#define DebugP_ASSERT_ENABLED 1
#define DebugP_LOG_ENABLED    1
 
#ifndef DebugP_ASSERT_ENABLED
#define DebugP_ASSERT_ENABLED 0
#endif
 
#ifndef DebugP_LOG_ENABLED
#define DebugP_LOG_ENABLED    0
#endif
 
#if DebugP_LOG_ENABLED
 
typedef void (*DebugP_exptnLogFxn)(const char *format, ...);
 
#define DEBUGP_LOGFXN_REGISTER_SUCCESS   (0)
#define DEBUGP_LOGFXN_ALREADY_REGISTERD  (-1)
#endif
 
#if DebugP_ASSERT_ENABLED
/* Rename file to filename in function prototype to fix MISRA.CT.UNIQUE.ID and MISRA.VAR.HIDDEN KW issues */
extern void Osal_DebugP_assert_fcn(bool expression, const char *filename, int32_t line);
#define DebugP_assert(expression) (Osal_DebugP_assert_fcn(expression,         \
                                                         __FILE__, __LINE__))
#else
#define DebugP_assert(expression)
#endif
 
#if DebugP_LOG_ENABLED
extern void DebugP_exceptionLog(const char * format, uint32_t arg1, uint32_t arg2);
#else
#define DebugP_exceptionLog(const char * format, uint32_t arg1, uint32_t arg2)
#endif
 
#if DebugP_LOG_ENABLED
extern void DebugP_log0(const char *format);
#else
#define DebugP_log0(format)
#endif
 
#if DebugP_LOG_ENABLED
int32_t DebugP_registerExcptnLogFxn(DebugP_exptnLogFxn fxn);
#else
#define DebugP_registerExcptnLogFxn(DebugP_exptnLogFxn fxn)
#endif
 
#if DebugP_LOG_ENABLED
void DebugP_deRegisterExcptnLogFxn(void);
#else
#define DebugP_deRegisterExcptnLogFxn(void)
#endif
 
#if DebugP_LOG_ENABLED
extern void DebugP_log1(const char *format, uintptr_t p1);
#else
#define DebugP_log1(format, p1)
#endif
 
#if DebugP_LOG_ENABLED
extern void DebugP_log2(const char *format, uintptr_t p1, uintptr_t p2);
#else
#define DebugP_log2(format, p1, p2)
#endif
 
#if DebugP_LOG_ENABLED
extern void DebugP_log3(const char *format, uintptr_t p1, uintptr_t p2, uintptr_t p3);
#else
#define DebugP_log3(format, p1, p2, p3)
#endif
 
#if DebugP_LOG_ENABLED
extern void DebugP_log4(const char *format, uintptr_t p1, uintptr_t p2, uintptr_t p3, uintptr_t p4);
#else
#define DebugP_log4(format, p1, p2, p3, p4)
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif /* ti_drivers_ports_DebugP__include */
/* @} */