Logging enumerated types

General Description

Documentation of the enums provided by logging utility.

Enumerations
enum	CY_LOG_LEVEL_T {   CY_LOG_OFF = 0 ,   CY_LOG_ERR ,   CY_LOG_WARNING ,   CY_LOG_NOTICE ,   CY_LOG_INFO ,   CY_LOG_DEBUG ,   CY_LOG_DEBUG1 ,   CY_LOG_DEBUG2 ,   CY_LOG_DEBUG3 ,   CY_LOG_DEBUG4 ,   CY_LOG_PRINTF ,   CY_LOG_MAX }
	Logging levels. More...
enum	CY_LOG_FACILITY_T {   CYLF_DEF = 0 ,   CYLF_TEST ,   CYLF_DRIVER ,   CYLF_LP ,   CYLF_MIDDLEWARE ,   CYLF_AUDIO ,   CYLF_MAX }
	Log Facility type Log facilities allow for separate subsystems to have different run-time log levels for output. More...

Enumeration Type Documentation

CY_LOG_LEVEL_T

enum CY_LOG_LEVEL_T

Logging levels.

NOTE: Default value for all facilities is passed in to init call

Enumerator
CY_LOG_OFF	Do not print log messages.
CY_LOG_ERR	Print log message if run-time level is <= CY_LOG_ERR
CY_LOG_WARNING	Print log message if run-time level is <= CY_LOG_WARNING
CY_LOG_NOTICE	Print log message if run-time level is <= CY_LOG_NOTICE
CY_LOG_INFO	Print log message if run-time level is <= CY_LOG_INFO
CY_LOG_DEBUG	Print log message if run-time level is <= CY_LOG_DEBUG
CY_LOG_DEBUG1	Print log message if run-time level is <= CY_LOG_DEBUG1
CY_LOG_DEBUG2	Print log message if run-time level is <= CY_LOG_DEBUG2
CY_LOG_DEBUG3	Print log message if run-time level is <= CY_LOG_DEBUG3
CY_LOG_DEBUG4	Print log message if run-time level is <= CY_LOG_DEBUG4

CY_LOG_FACILITY_T

enum CY_LOG_FACILITY_T

Log Facility type Log facilities allow for separate subsystems to have different run-time log levels for output.

This allows for someone working in the Driver subsystem to turn on DEBUG level without turning DEBUG level for middleware - makes for less unwanted output during debugging / testing.

Enumerator
CYLF_DEF	General log message not associated with any specific Facility.
CYLF_TEST	Test Facility.
CYLF_DRIVER	Driver Facility.
CYLF_LP	Low Power Facility.
CYLF_MIDDLEWARE	Middleware Facility.
CYLF_AUDIO	Audio Facility.
CYLF_MAX	Must be last, not an actual index.