AM261x MCU+ SDK: Enet Trace API

| AM261x MCU+ SDK 26.00.00 |

Enumerations | Macros
Enet Trace API
APIs for Networking modules » APIs for Enet LLD

## Introduction

## Enumerations
enum | EnetTrace_TraceLevel { ENET_TRACE_NONE = 0U, ENET_TRACE_ERROR = 1U, ENET_TRACE_WARN = 2U, ENET_TRACE_INFO = 3U, ENET_TRACE_DEBUG = 4U, ENET_TRACE_VERBOSE = 5U }
| Enumerates the types of trace level. More...

## Macros
#define | ENET_CFG_TRACE_LEVEL_NONE (0U)
| All traces disabled at build-time. More...
#define | ENET_CFG_TRACE_LEVEL_ERROR (1U)
| Build-time error level. More...
#define | ENET_CFG_TRACE_LEVEL_WARN (2U)
| Build-time warning level. More...
#define | ENET_CFG_TRACE_LEVEL_INFO (3U)
| Build-time information level. More...
#define | ENET_CFG_TRACE_LEVEL_DEBUG (4U)
| Build-time debug level. More...
#define | ENET_CFG_TRACE_LEVEL_VERBOSE (5U)
| Build-time verbose level. More...
#define | ENET_CFG_TRACE_LEVEL (ENET_CFG_TRACE_LEVEL_INFO)
| Default trace level if none is set. More...
#define | ENET_CFG_TRACE_FORMAT_FUNC (0U)
| Trace prefix: "<func>: string". More...
#define | ENET_CFG_TRACE_FORMAT_FILE (1U)
| Trace prefix: "<func>: <line>: string". More...
#define | ENET_CFG_TRACE_FORMAT_FULL (2U)
| Trace prefix: "<file>: <line>: <func>: <line>: string". More...
#define | ENET_CFG_TRACE_TRACE_FORMAT (ENET_CFG_TRACE_FORMAT_FUNC)
| Default trace format if none is specified. More...

## Macro Definition Documentation

## ◆ ENET_CFG_TRACE_LEVEL_NONE

#define ENET_CFG_TRACE_LEVEL_NONE (0U)

All traces disabled at build-time.

## ◆ ENET_CFG_TRACE_LEVEL_ERROR

#define ENET_CFG_TRACE_LEVEL_ERROR (1U)

Build-time error level.

## ◆ ENET_CFG_TRACE_LEVEL_WARN

#define ENET_CFG_TRACE_LEVEL_WARN (2U)

Build-time warning level.

## ◆ ENET_CFG_TRACE_LEVEL_INFO

#define ENET_CFG_TRACE_LEVEL_INFO (3U)

Build-time information level.

## ◆ ENET_CFG_TRACE_LEVEL_DEBUG

#define ENET_CFG_TRACE_LEVEL_DEBUG (4U)

Build-time debug level.

## ◆ ENET_CFG_TRACE_LEVEL_VERBOSE

#define ENET_CFG_TRACE_LEVEL_VERBOSE (5U)

Build-time verbose level.

## ◆ ENET_CFG_TRACE_LEVEL

#define ENET_CFG_TRACE_LEVEL (ENET_CFG_TRACE_LEVEL_INFO)

Default trace level if none is set.

## ◆ ENET_CFG_TRACE_FORMAT_FUNC

#define ENET_CFG_TRACE_FORMAT_FUNC (0U)

Trace prefix: "<func>: string".

## ◆ ENET_CFG_TRACE_FORMAT_FILE

#define ENET_CFG_TRACE_FORMAT_FILE (1U)

Trace prefix: "<func>: <line>: string".

## ◆ ENET_CFG_TRACE_FORMAT_FULL

#define ENET_CFG_TRACE_FORMAT_FULL (2U)

Trace prefix: "<file>: <line>: <func>: <line>: string".

## ◆ ENET_CFG_TRACE_TRACE_FORMAT

#define ENET_CFG_TRACE_TRACE_FORMAT (ENET_CFG_TRACE_FORMAT_FUNC)

Default trace format if none is specified.

## Enumeration Type Documentation

## ◆ EnetTrace_TraceLevel

enum EnetTrace_TraceLevel

Enumerates the types of trace level.

Enumerator
ENET_TRACE_NONE | All traces are disabled at runtime
ENET_TRACE_ERROR | Error trace level
ENET_TRACE_WARN | Warning trace level
ENET_TRACE_INFO | Info trace level: enables only important informational messages for the user (i.e. PHY link is up or down, NIMU layer is ready, etc). The amount of info logs is not invasive in nature so this trace level may be enabled by applications at init time.
ENET_TRACE_DEBUG | Debug trace level: enables further information messages about operations taking place in the driver (i.e. a module is being opened, PHY auto-negotiation is started, etc). The debug level should be enabled by the user on a need basis (i.e. for debugging or tracing execution flow, etc) as the number of messages will increase considerably with respect to ENET_TRACE_INFO level. This trace level can be enabled at runtime only in 'debug' builds.
ENET_TRACE_VERBOSE | Verbose trace level: enables even further messages about operations taking place in the driver (i.e. PHY state transitions, DMA transfer completion, etc) that are periodic in nature or simply happen very often during normal execution. The amount of messages will increase drastically when the verbose level is enabled, so it's recommended to set it only if really needed. This trace level can be enabled at runtime only in 'debug' builds.