AM64x MCU+ SDK  07.03.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 
78 #define DebugP_SHM_LOG_SIZE ( (2*1024U) - 16U)
79 
80 
87 #define DebugP_SHM_LOG_IS_VALID (0x12345678U)
88 
92 typedef struct {
93 
94  uint32_t isValid;
95  uint32_t rdIndex;
96  uint32_t wrIndex;
97  uint32_t rsv;
98  uint8_t buffer[DebugP_SHM_LOG_SIZE];
99 
100 } DebugP_ShmLog;
101 
107 #ifndef DebugP_ASSERT_ENABLED
108 
113 #define DebugP_ASSERT_ENABLED 1
114 #endif
115 
116 #ifndef DebugP_LOG_ENABLED
117 
122 #define DebugP_LOG_ENABLED 1
123 #endif
124 
127 #if DebugP_ASSERT_ENABLED
128 
131 void _DebugP_assert(int expression, const char *file, const char *function, int line, const char *expressionString);
132 
136 void _DebugP_assertNoLog(int expression);
137 
154 #define DebugP_assert(expression) \
155  do { \
156  _DebugP_assert(expression, \
157  __FILE__, __FUNCTION__, __LINE__, #expression); \
158  } while(0)
159 
170 #define DebugP_assertNoLog(expression) (_DebugP_assertNoLog(expression))
171 
174 #else
175 #define DebugP_assert(expression)
176 #define DebugP_assertNoLog(expression)
177 #endif
178 
179 #if DebugP_LOG_ENABLED
180 
191 void _DebugP_logZone(uint32_t logZone, char *format, ...);
192 
206 #define DebugP_log(format, ...) \
207  do { \
208  _DebugP_logZone(DebugP_LOG_ZONE_ALWAYS_ON, format, ##__VA_ARGS__); \
209  } while(0)
210 
218 #define DebugP_logError(format, ...) \
219  do { \
220  _DebugP_logZone(DebugP_LOG_ZONE_ERROR, "ERROR: %s:%d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__); \
221  } while(0)
222 
230 #define DebugP_logWarn(format, ...) \
231  do { \
232  _DebugP_logZone(DebugP_LOG_ZONE_WARN, "WARNING: %s:%d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__); \
233  } while(0)
234 
242 #define DebugP_logInfo(format, ...) \
243  do { \
244  _DebugP_logZone(DebugP_LOG_ZONE_INFO, "INFO: %s:%d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__); \
245  } while(0)
246 
249 #else
250 #define DebugP_log(format, ...)
251 #define DebugP_logError(format, ...)
252 #define DebugP_logWarn(format, ...)
253 #define DebugP_logInfo(format, ...)
254 #endif
255 
263 uint32_t DebugP_logZoneEnable(uint32_t logZoneMask);
264 
272 uint32_t DebugP_logZoneDisable(uint32_t logZoneMask);
273 
279 void DebugP_logZoneRestore(uint32_t logZoneMask);
280 
288 void DebugP_shmLogWriterInit(DebugP_ShmLog *shmLog, uint16_t selfCoreId);
289 
301 void DebugP_shmLogWriterPutChar(char character);
302 
303 
312 void DebugP_uartLogWriterPutChar(char character);
313 
322 void DebugP_shmLogReaderInit(DebugP_ShmLog *shmLog, uint16_t numCores);
323 
324 
331 void DebugP_linuxTraceLogWriterInit(uint16_t selfCoreId);
332 
345 
354 void DebugP_uartSetDrvIndex(uint32_t uartDrvIndex);
355 
367 int32_t DebugP_scanf(char *format, ...);
368 
385 int32_t DebugP_readLine(char *lineBuf, uint32_t bufSize);
386 
389 #ifdef __cplusplus
390 }
391 #endif
392 
393 #endif /* DEBUGP_H */
DebugP_ShmLog::wrIndex
uint32_t wrIndex
Definition: DebugP.h:96
DebugP_linuxTraceLogWriterInit
void DebugP_linuxTraceLogWriterInit(uint16_t selfCoreId)
Initialize log write to write to linux trace buffer with IPC with Linux is enabled via DebugP_log.
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_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:94
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:97
_DebugP_assert
void _DebugP_assert(int expression, const char *file, const char *function, int line, const char *expressionString)
Actual function that is called for assert's by DebugP_assert.
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_assertNoLog
void _DebugP_assertNoLog(int expression)
Actual function that is called for assert's by DebugP_assertNoLog.
DebugP_uartSetDrvIndex
void DebugP_uartSetDrvIndex(uint32_t uartDrvIndex)
Set UART driver index to use for character read and write form UART.
DebugP_linuxTraceLogWriterPutChar
void DebugP_linuxTraceLogWriterPutChar(char character)
Write a character to trace buffer used by linux kernel.
DebugP_uartLogWriterPutChar
void DebugP_uartLogWriterPutChar(char character)
Write a character to UART terminal.
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:95
DebugP_ShmLog
Data structure describing log in shared memory.
Definition: DebugP.h:92
DebugP_SHM_LOG_SIZE
#define DebugP_SHM_LOG_SIZE
size of shared memory log for a CPU
Definition: DebugP.h:78