AM263Px MCU+ SDK: DebugP.h File Reference

| AM263Px MCU+ SDK 26.00.00 |

Data Structures | Macros | Functions
DebugP.h File Reference

Go to the source code of this file.

## Data Structures
struct | DebugP_ShmLog
| Data structure describing log in shared memory. More...

## Macros
#define | DebugP_SHM_LOG_SIZE ((2U*1024U) - 16U)
| size of shared memory log for a CPU More...
#define | DebugP_MEM_LOG_SIZE ( 4*1024U )
| size of memory log for a CPU More...
#define | DebugP_SHM_LOG_IS_VALID (0x12345678U)
| Flag to indicate shared memory buffer is valid. More...
#define | DebugP_SHM_LOG_READER_CHUNK_SIZE_INF UINT16_MAX
| Infinite read chunk size for the shared memory reader. More...
#define | UNSIGNED_INTEGERVAL_TWO (2U)
#define | UNSIGNED_INTEGERVAL_THREE (3U)
#define | CARRIAGE_RETURN_ASCII (13U)
Debug log zones
#define | DebugP_LOG_ZONE_ALWAYS_ON (0x0001U)
| Flag for always on zone, enabled by default and recommend to not switch off. More...
#define | DebugP_LOG_ZONE_ERROR (0x0002U)
| Flag for error zone. More...
#define | DebugP_LOG_ZONE_WARN (0x0004U)
| Flag for warning zone. More...
#define | DebugP_LOG_ZONE_INFO (0x0008U)
| Flag for info zone. More...
Compile time log and assert enable, disable
#define | DebugP_ASSERT_ENABLED 1
| Pre-processor define to enable or disable DebugP assert's. More...
#define | DebugP_LOG_ENABLED 1
| Pre-processor define to enable or disable DebugP log's. More...
Debug assert APIs
#define | DebugP_assert(expression) _DebugP_assert(expression, __FILE__, __FUNCTION__, __LINE__, #expression)
| Function to call for assert check. More...
#define | DebugP_assertNoLog(expression) (_DebugP_assertNoLog(expression))
| Function to call for assert check, no logs are printed. More...
Debug log APIs
#define | DebugP_log(format, ...) _DebugP_logZone(DebugP_LOG_ZONE_ALWAYS_ON, (char *)format, ##__VA_ARGS__)
| Function to log a string to the enabled console. More...
#define | DebugP_logError(format, ...) _DebugP_logZone(DebugP_LOG_ZONE_ERROR, "ERROR: %s:%d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__)
| Function to log a string to the enabled console, for error zone. More...
#define | DebugP_logWarn(format, ...) _DebugP_logZone(DebugP_LOG_ZONE_WARN, "WARNING: %s:%d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__)
| Function to log a string to the enabled console, for warning zone. More...
#define | DebugP_logInfo(format, ...) _DebugP_logZone(DebugP_LOG_ZONE_INFO, "INFO: %s:%d: " format, __FUNCTION__, __LINE__, ##__VA_ARGS__)
| Function to log a string to the enabled console, for info zone. More...

## Functions
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. More...
void | _DebugP_assertNoLog (int32_t expression)
| Actual function that is called for assert's by DebugP_assertNoLog. More...
void | _DebugP_logZone (uint32_t logZone, char *format,...)
| Function to log a string to the enabled console for a given zone. More...
uint32_t | DebugP_logZoneEnable (uint32_t logZoneMask)
| Enable log zones. More...
uint32_t | DebugP_logZoneDisable (uint32_t logZoneMask)
| Disable log zones. More...
void | DebugP_logZoneRestore (uint32_t logZoneMask)
| Restire zone mask returned from DebugP_logZoneDisable or DebugP_logZoneEnable. More...
void | DebugP_shmLogWriterInit (DebugP_ShmLog *shmLog, uint16_t selfCoreId)
| Initialize shared memory log writer for this core. More...
void | DebugP_shmLogWriterPreludeEnable ()
| Enable auto prelude for shared memory log writer. More...
void | DebugP_shmLogWriterPreludeDisable ()
| Disable auto prelude for shared memory log writer. More...
void | DebugP_shmLogWriterPutChar (char character)
| Write a character to shared memory log. More...
void | DebugP_uartLogWriterPutChar (char character)
| Write a character to UART terminal. More...
void | DebugP_shmLogReaderInit (DebugP_ShmLog *shmLog, uint16_t numCores)
| Initialize log reader to read from shared memory and log to console via DebugP_log. More...
void | DebugP_shmLogReaderSetChunkSize (uint16_t readChunkSize)
| Set the read chunk size for the shared memory reader. More...
uint16_t | DebugP_shmLogReaderGetChunkSize (void)
| Get the read chunk size for the shared memory reader. More...
void | DebugP_shmLogRead (void)
| Reads logs from shared memory. More...
void | DebugP_memLogWriterInit (uint16_t selfCoreId)
| Initialize log write to write to memory trace buffer. More...
void | DebugP_memLogWriterPutChar (char character)
| Write a character to trace buffer. More...
void | DebugP_uartSetDrvIndex (uint32_t uartDrvIndex)
| Set UART driver index to use for character read and write form UART. More...
int32_t | DebugP_scanf (char *format,...)
| Read a formatted string from the selected UART driver. More...
int32_t | DebugP_readLine (char *lineBuf, uint32_t bufSize)
| Read a string from the selected UART driver. More...