Header file of Debug Service Related APIs. More...
#include <clCommon.h>#include <clDebugErrors.h>#include <clHandleApi.h>#include <clLogApi.h>#include <clRmdIpi.h>#include <stdio.h>#include <unistd.h>#include <time.h>#include <clEoApi.h>#include <clDbg.h>#include <assert.h>Go to the source code of this file.
Classes | |
| struct | ClDebugFuncEntryT |
| The structure contains the entry for the debug CLI information that needs the component has to provide on a per command basis. More... | |
| struct | ClDebugModEntryT |
| This structure is used to register the module with the CLI library. More... | |
Macros | |
| #define | CL_ASSERT(expr) do { if (clDbgPauseOnCodeError&&(!(expr))) clDbgCodeError(0,("Assertion failed")); else assert((expr)); } while(0) |
| This macro is used to assert upon a critical failure. | |
| #define | CL_DEBUG |
The macro CL_DEBUG_PRINT is used to print messages to the user. | |
| #define | CL_DEBUG_COMP_NAME_LEN 128 |
| The maximum length of the name of a component in the debug CLI. | |
| #define | CL_DEBUG_COMP_PROMPT_LEN 15 |
| The maximum length of the prompt for the component to be displayed in the debug CLI. | |
| #define | CL_DEBUG_CRITICAL 3 |
| These defines are aligned with the logging defined in clLogApi.h and will ultimately be deprecated as logs are converted over to the new format. | |
| #define | CL_DEBUG_ERROR 4 |
This debug level in CL_DEBUG_PRINT is used to report a non-critical error. | |
| #define | CL_DEBUG_FUNC_HELP_LEN 201 |
| The maximum length of the help for a command of the component in the debug CLI. | |
| #define | CL_DEBUG_FUNC_NAME_LEN 41 |
| The maximum length of a command of the component in the debug CLI. | |
| #define | CL_DEBUG_INFO 7 |
This debug level in CL_DEBUG_PRINT is used to provide information. | |
| #define | CL_DEBUG_LEVEL_THRESHOLD CL_DEBUG_ERROR |
| The value of CL_DEBUG_LEVEL_THRESHOLD can be changed (either here, or by some file that includes this file) to make the debug output either more or less voluminous. | |
| #define | CL_DEBUG_TRACE 0xc |
This debug level in CL_DEBUG_PRINT is used to add trace information. | |
| #define | CL_DEBUG_WARN 5 |
This debug level in CL_DEBUG_PRINT is used to report a warning. | |
| #define | CL_FUNC_ENTER() |
| This macro is called while entering the function. | |
| #define | CL_FUNC_EXIT() |
| This macro is called while exiting the function. | |
Typedefs | |
| typedef ClRcT(* | ClDebugCallbackT )(ClUint32T argc, ClCharT **argv, ClCharT **ret) |
| This is the signature of the callback invoked by the debug CLI in response to a command entered. | |
| typedef struct ClDebugFuncEntryT | ClDebugFuncEntryT |
| The structure contains the entry for the debug CLI information that needs the component has to provide on a per command basis. | |
| typedef struct ClDebugModEntryT | ClDebugModEntryT |
| This structure is used to register the module with the CLI library. | |
| typedef ClPtrT | ClDebugPrintHandleT |
| The type of the handle clDebugPrint APIs. | |
Functions | |
| ClRcT | clDebugCli (CL_IN ClCharT *nprompt) |
| Invokes the library based local debug CLI. | |
| ClRcT | clDebugDeregister (CL_IN ClHandleT hReg) |
| De-registers the debug CLI information from the EO. | |
| ClRcT | clDebugLibFinalize (void) |
| Finalizes the Debug CLI library. | |
| ClRcT | clDebugLibInitialize (void) |
| Initializes the Debug CLI library. | |
| ClRcT | clDebugPrint (CL_INOUT ClDebugPrintHandleT msg, CL_IN const char *fmtStr,...) CL_PRINTF_FORMAT(2 |
| Prints a string into the handle. | |
| ClRcT | clDebugPrintDestroy (CL_INOUT ClDebugPrintHandleT *msg) |
| Frees the print handle. | |
| ClRcT ClRcT | clDebugPrintFinalize (CL_IN ClDebugPrintHandleT *msg, CL_OUT char **buf) |
| Cleans up the print handle. | |
| ClRcT | clDebugPrintInitialize (CL_OUT ClDebugPrintHandleT *msg) |
| Retrieve a handle for printing. | |
| ClRcT | clDebugPromptSet (CL_IN const ClCharT *pCompPrompt) |
| Sets the name and prompt of the component. | |
| ClRcT | clDebugRegister (CL_IN ClDebugFuncEntryT *funcArray, CL_IN ClUint32T funcArrayLen, CL_OUT ClHandleT *phDebugReg) |
| Registers the component name. | |
| ClRcT | clDebugVersionCheck (CL_INOUT ClVersionT *pVersion) |
| Check the given version is supported or not. | |
Header file of Debug Service Related APIs.