AM263Px MCU+ SDK: DebugP.h Source File

| AM263Px MCU+ SDK 26.00.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
95
102 #define DebugP_SHM_LOG_READER_CHUNK_SIZE_INF UINT16_MAX
103
104
109 #define UNSIGNED_INTEGERVAL_TWO (2U)
110
115 #define UNSIGNED_INTEGERVAL_THREE (3U)
116
120 #define CARRIAGE_RETURN_ASCII (13U)
121
125 typedef struct {
126
127 uint32_t isValid;
128 uint32_t rdIndex;
129 uint32_t wrIndex;
130 uint32_t rsv;
131 uint8_t buffer[DebugP_SHM_LOG_SIZE];
132
133 } DebugP_ShmLog;
134
140 #ifndef DebugP_ASSERT_ENABLED
141
146 #define DebugP_ASSERT_ENABLED 1
147 #endif
148
149 #ifndef DebugP_LOG_ENABLED
150
155 #define DebugP_LOG_ENABLED 1
156 #endif
157
160 #if DebugP_ASSERT_ENABLED
161
164 void _DebugP_assert(int32_t expression, const char *file, const char *function, int32_t line, const char *expressionString);
165
169 void _DebugP_assertNoLog(int32_t expression);
170
187 #define DebugP_assert(expression) _DebugP_assert(expression, __FILE__, __FUNCTION__, __LINE__, #expression)
188
199 #define DebugP_assertNoLog(expression) (_DebugP_assertNoLog(expression))
200
203 #else
204 #define DebugP_assert(expression)
205 #define DebugP_assertNoLog(expression)
206 #endif
207
208 #if DebugP_LOG_ENABLED
209
220 void _DebugP_logZone(uint32_t logZone, char *format, ...);
221
235 #define DebugP_log(format, ...) _DebugP_logZone(DebugP_LOG_ZONE_ALWAYS_ON, (char *)format, ##__VA_ARGS__)
236
244 #define DebugP_logError(format, ...) _DebugP_logZone(DebugP_LOG_ZONE_ERROR, "ERROR: %s:%d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__)
245
253 #define DebugP_logWarn(format, ...) _DebugP_logZone(DebugP_LOG_ZONE_WARN, "WARNING: %s:%d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__)
254
262 #define DebugP_logInfo(format, ...) _DebugP_logZone(DebugP_LOG_ZONE_INFO, "INFO: %s:%d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__)
263
266 #else
267 #define DebugP_log(format, ...)
268 #define DebugP_logError(format, ...)
269 #define DebugP_logWarn(format, ...)
270 #define DebugP_logInfo(format, ...)
271 #endif
272
280 uint32_t DebugP_logZoneEnable(uint32_t logZoneMask);
281
289 uint32_t DebugP_logZoneDisable(uint32_t logZoneMask);
290
296 void DebugP_logZoneRestore(uint32_t logZoneMask);
297
305 void DebugP_shmLogWriterInit(DebugP_ShmLog *shmLog, uint16_t selfCoreId);
306
310 void DebugP_shmLogWriterPreludeEnable();
311
317 void DebugP_shmLogWriterPreludeDisable();
318
330 void DebugP_shmLogWriterPutChar(char character);
331
332
341 void DebugP_uartLogWriterPutChar(char character);
342
353 void DebugP_shmLogReaderInit(DebugP_ShmLog *shmLog, uint16_t numCores);
354
359 void DebugP_shmLogReaderSetChunkSize(uint16_t readChunkSize);
360
361
366 uint16_t DebugP_shmLogReaderGetChunkSize(void);
367
374 void DebugP_shmLogRead(void);
375
386 void DebugP_memLogWriterInit(uint16_t selfCoreId);
387
401 void DebugP_memLogWriterPutChar(char character);
402
411 void DebugP_uartSetDrvIndex(uint32_t uartDrvIndex);
412
424 int32_t DebugP_scanf(char *format, ...);
425
442 int32_t DebugP_readLine(char *lineBuf, uint32_t bufSize);
443
446 #ifdef __cplusplus
447 }
448 #endif
449
450 #endif /* DEBUGP_H */
DebugP_ShmLog::wrIndex
uint32_t wrIndex
Definition: DebugP.h:129
_DebugP_assertNoLog
void _DebugP_assertNoLog(int32_t expression)
Actual function that is called for assert's by DebugP_assertNoLog.
DebugP_shmLogWriterPreludeDisable
void DebugP_shmLogWriterPreludeDisable()
Disable auto prelude for shared memory log writer.
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:127
_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_shmLogWriterPreludeEnable
void DebugP_shmLogWriterPreludeEnable()
Enable auto prelude for shared memory log writer.
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:130
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_shmLogReaderGetChunkSize
uint16_t DebugP_shmLogReaderGetChunkSize(void)
Get the read chunk size for the shared memory reader.
DebugP_shmLogReaderSetChunkSize
void DebugP_shmLogReaderSetChunkSize(uint16_t readChunkSize)
Set the read chunk size for the shared memory reader.
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:128
DebugP_ShmLog
Data structure describing log in shared memory.
Definition: DebugP.h:125
DebugP_SHM_LOG_SIZE
#define DebugP_SHM_LOG_SIZE
size of shared memory log for a CPU
Definition: DebugP.h:79