AM65x MCU+ SDK  09.01.00
DebugP.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2018-2021 Texas Instruments Incorporated
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *
11  * Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the
14  * distribution.
15  *
16  * Neither the name of Texas Instruments Incorporated nor the names of
17  * its contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef DEBUGP_H
34 #define DEBUGP_H
35 
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39 
40 #include <stdint.h>
41 
59 #define DebugP_LOG_ZONE_ALWAYS_ON (0x0001U)
60 
63 #define DebugP_LOG_ZONE_ERROR (0x0002U)
64 
67 #define DebugP_LOG_ZONE_WARN (0x0004U)
68 
71 #define DebugP_LOG_ZONE_INFO (0x0008U)
72 
79 #define DebugP_SHM_LOG_SIZE ((2U*1024U) - 16U)
80 
84 #define DebugP_MEM_LOG_SIZE ( 4*1024U )
85 
86 
93 #define DebugP_SHM_LOG_IS_VALID (0x12345678U)
94 
99 #define UNSIGNED_INTEGERVAL_TWO (2U)
100 
105 #define UNSIGNED_INTEGERVAL_THREE (3U)
106 
110 #define CARRIAGE_RETURN_ASCII (13U)
111 
115 typedef struct {
116 
117  uint32_t isValid;
118  uint32_t rdIndex;
119  uint32_t wrIndex;
120  uint32_t rsv;
121  uint8_t buffer[DebugP_SHM_LOG_SIZE];
122 
123 } DebugP_ShmLog;
124 
130 #ifndef DebugP_ASSERT_ENABLED
131 
136 #define DebugP_ASSERT_ENABLED 1
137 #endif
138 
139 #ifndef DebugP_LOG_ENABLED
140 
145 #define DebugP_LOG_ENABLED 1
146 #endif
147 
150 #if DebugP_ASSERT_ENABLED
151 
154 void _DebugP_assert(int32_t expression, const char *file, const char *function, int32_t line, const char *expressionString);
155 
159 void _DebugP_assertNoLog(int32_t expression);
160 
177 #define DebugP_assert(expression) _DebugP_assert(expression, __FILE__, __FUNCTION__, __LINE__, #expression)
178 
189 #define DebugP_assertNoLog(expression) (_DebugP_assertNoLog(expression))
190 
193 #else
194 #define DebugP_assert(expression)
195 #define DebugP_assertNoLog(expression)
196 #endif
197 
198 #if DebugP_LOG_ENABLED
199 
210 void _DebugP_logZone(uint32_t logZone, char *format, ...);
211 
225 #define DebugP_log(format, ...) _DebugP_logZone(DebugP_LOG_ZONE_ALWAYS_ON, (char *)format, ##__VA_ARGS__)
226 
234 #define DebugP_logError(format, ...) _DebugP_logZone(DebugP_LOG_ZONE_ERROR, "ERROR: %s:%d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__)
235 
243 #define DebugP_logWarn(format, ...) _DebugP_logZone(DebugP_LOG_ZONE_WARN, "WARNING: %s:%d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__)
244 
252 #define DebugP_logInfo(format, ...) _DebugP_logZone(DebugP_LOG_ZONE_INFO, "INFO: %s:%d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__)
253 
256 #else
257 #define DebugP_log(format, ...)
258 #define DebugP_logError(format, ...)
259 #define DebugP_logWarn(format, ...)
260 #define DebugP_logInfo(format, ...)
261 #endif
262 
270 uint32_t DebugP_logZoneEnable(uint32_t logZoneMask);
271 
279 uint32_t DebugP_logZoneDisable(uint32_t logZoneMask);
280 
286 void DebugP_logZoneRestore(uint32_t logZoneMask);
287 
295 void DebugP_shmLogWriterInit(DebugP_ShmLog *shmLog, uint16_t selfCoreId);
296 
308 void DebugP_shmLogWriterPutChar(char character);
309 
310 
319 void DebugP_uartLogWriterPutChar(char character);
320 
329 void DebugP_shmLogReaderInit(DebugP_ShmLog *shmLog, uint16_t numCores);
330 
337 void DebugP_shmLogRead(void);
338 
349 void DebugP_memLogWriterInit(uint16_t selfCoreId);
350 
364 void DebugP_memLogWriterPutChar(char character);
365 
374 void DebugP_uartSetDrvIndex(uint32_t uartDrvIndex);
375 
387 int32_t DebugP_scanf(char *format, ...);
388 
405 int32_t DebugP_readLine(char *lineBuf, uint32_t bufSize);
406 
409 #ifdef __cplusplus
410 }
411 #endif
412 
413 #endif /* DEBUGP_H */
DebugP_ShmLog::wrIndex
uint32_t wrIndex
Definition: DebugP.h:119
_DebugP_assertNoLog
void _DebugP_assertNoLog(int32_t expression)
Actual function that is called for assert's by DebugP_assertNoLog.
DebugP_shmLogWriterPutChar
void DebugP_shmLogWriterPutChar(char character)
Write a character to shared memory log.
DebugP_logZoneDisable
uint32_t DebugP_logZoneDisable(uint32_t logZoneMask)
Disable log zones.
DebugP_logZoneEnable
uint32_t DebugP_logZoneEnable(uint32_t logZoneMask)
Enable log zones.
DebugP_memLogWriterInit
void DebugP_memLogWriterInit(uint16_t selfCoreId)
Initialize log write to write to memory trace buffer.
DebugP_shmLogWriterInit
void DebugP_shmLogWriterInit(DebugP_ShmLog *shmLog, uint16_t selfCoreId)
Initialize shared memory log writer for this core.
DebugP_shmLogReaderInit
void DebugP_shmLogReaderInit(DebugP_ShmLog *shmLog, uint16_t numCores)
Initialize log reader to read from shared memory and log to console via DebugP_log.
DebugP_ShmLog::isValid
uint32_t isValid
Definition: DebugP.h:117
_DebugP_assert
void _DebugP_assert(int32_t expression, const char *file, const char *function, int32_t line, const char *expressionString)
Actual function that is called for assert's by DebugP_assert.
DebugP_scanf
int32_t DebugP_scanf(char *format,...)
Read a formatted string from the selected UART driver.
DebugP_ShmLog::rsv
uint32_t rsv
Definition: DebugP.h:120
DebugP_readLine
int32_t DebugP_readLine(char *lineBuf, uint32_t bufSize)
Read a string from the selected UART driver.
_DebugP_logZone
void _DebugP_logZone(uint32_t logZone, char *format,...)
Function to log a string to the enabled console for a given zone.
DebugP_memLogWriterPutChar
void DebugP_memLogWriterPutChar(char character)
Write a character to trace buffer.
DebugP_uartSetDrvIndex
void DebugP_uartSetDrvIndex(uint32_t uartDrvIndex)
Set UART driver index to use for character read and write form UART.
DebugP_uartLogWriterPutChar
void DebugP_uartLogWriterPutChar(char character)
Write a character to UART terminal.
DebugP_shmLogRead
void DebugP_shmLogRead(void)
Reads logs from shared memory.
DebugP_logZoneRestore
void DebugP_logZoneRestore(uint32_t logZoneMask)
Restire zone mask returned from DebugP_logZoneDisable or DebugP_logZoneEnable.
DebugP_ShmLog::rdIndex
uint32_t rdIndex
Definition: DebugP.h:118
DebugP_ShmLog
Data structure describing log in shared memory.
Definition: DebugP.h:115
DebugP_SHM_LOG_SIZE
#define DebugP_SHM_LOG_SIZE
size of shared memory log for a CPU
Definition: DebugP.h:79