PMI Instrumentation Library API Reference Guide
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator
Typedefs | Enumerations
PCMI_Common.h File Reference
#include "../../PMICMILib/src/PCMI_Omap4430.h"
#include <stdint.h>

Go to the source code of this file.

Typedefs

typedef void(* PCMI_CallBack )(const char *funcName, ePCMI_Error)
 

Enumerations

enum  ePCMI_Error {
  ePCMI_Success = 0, ePCMI_Error_Not_Compatible = -1, ePCMI_Error_Ownership_Not_Confirmed =-2, ePCMI_Error_Ownership_Not_Granted =-3,
  ePCMI_Error_Ownership_Not_Released =-4, ePCMI_Error_ResetDone_Not_Detected =-5, ePCMI_Error_Memory_Allocation =-6, ePCMI_Error_Module_Enabled = -7,
  ePCMI_Error_Invalid_Parameter = -8, ePCMI_Error_NULL_STMHandle = -9, ePCMI_Error_AlreadyOpen = -10, ePCMI_Error_MappingError = -11,
  ePCMI_Error_ModuleEnableFailed = -12, ePCMI_Error_ModuleDisableFailed = -13, ePCMI_Error_InvalidHandlePointer = -14, ePCMI_Error_VerboseDisabled = -15,
  ePCMI_Error_ModuleClkStateModifyFailed = -16, ePMI_Error_STM = -16, eCMI_Error_InUseForModuleActivity = -17, eCMI_Error_InUseForEventCapture = -18,
  eCMI_Error_STM = -18
}
 

Detailed Description

Common PMI and CMI Library Typedefs and definitions

Typedef Documentation

typedef void(* PCMI_CallBack)(const char *funcName, ePCMI_Error)
PCMI_CallBack
Parameters
[in]funcNameConstant char pointer to the function name. Normally provided by the compiler using the FUNCTION macro.
[in]ePCMI_ErrorError returned by calling routine

Enumeration Type Documentation

ePCMI_Error codes
PMI/CMI Common error codes
Enumerator
ePCMI_Success 

Function completed successfully, handle allocated

ePCMI_Error_Not_Compatible 

Library and device module not compatible

ePCMI_Error_Ownership_Not_Confirmed 

Device module ownership not confirmed, potential conflict with Debugger

ePCMI_Error_Ownership_Not_Granted 

Device module ownership not granted, potential conflict with Debugger

ePCMI_Error_Ownership_Not_Released 

Device module ownership not released

ePCMI_Error_ResetDone_Not_Detected 

Device module reset done not detected

ePCMI_Error_Memory_Allocation 

Memory allocation error

ePCMI_Error_Module_Enabled 

Can't change module state while module enabled

ePCMI_Error_Invalid_Parameter 

Invalid function parameter

ePCMI_Error_NULL_STMHandle 

Invalid function call because library opened with a NULL STM Handle

ePCMI_Error_AlreadyOpen 

Invalid function call because library is already opened, library must be closed first

ePCMI_Error_MappingError 

Attempt to map module's base address failed

ePCMI_Error_ModuleEnableFailed 

Module Enable Failed

ePCMI_Error_ModuleDisableFailed 

Module Disable Failed

ePCMI_Error_InvalidHandlePointer 

Invalid handle Pointer

ePCMI_Error_VerboseDisabled 

Verbose Disabled

ePCMI_Error_ModuleClkStateModifyFailed 

Attempt to modify the module's clock state failed

ePMI_Error_STM 

PMI Library specific error, STM Library returned an error

eCMI_Error_InUseForModuleActivity 

CMI Library specific error, Attempted an operation that's not legal when the module is enabled for module activity

eCMI_Error_InUseForEventCapture 

CMI Library specific error, Attempted an operation that's not legal when the module is enabled for event capture

eCMI_Error_STM 

CMI Library specific error, STM Library returned an error